adding or replacing sort params for provider urls when necessary

upgrading ui dependencies

.eslintrc.js

@@ -4,6 +4,7 @@ module.exports = {
     es6: true,
     node: true,
     browser: true,
+    mocha: true,
   },
   parser: 'babel-eslint',
   extends: ['eslint:recommended', 'prettier'],
@@ -11,6 +12,7 @@ module.exports = {
   globals: {
     Promise: false,
     describe: true,
+    after: true,
     it: true,
     fetch: true,
   },

.gitignore

@@ -3,3 +3,4 @@ ui/public/
 db/
 npm-debug.log
 .DS_Store
+.idea

CHANGELOG.md

@@ -1,3 +1,29 @@
+###### [V5.4.0]
+- Upgrading dependencies
+- Provider urls are now automagically been changed to include the correct sort order for search results
+
+```
+Note: It has been an point of confusion since the very beginning of Fredy, that people simply copied the url, but
+did not take care of sorting the search results by date. If this is not done, Fredy will most likely not see the latest
+results, thus cannot report them. This release fixes it by adding the necessary params (or replaces them).
+```
+
+###### [V5.3.0]
+- Upgrading dependencies
+- It's now possible to send mails to multiple receiver using comma separation for MailJet & Sendgrid
+- Fixing Immowelt scraping
+
+###### [V5.2.0]
+- Upgrading dependencies
+- Adding new similarity check layer (Duplicates are being removed now)
+- Adding paging for search results
+
+###### [V5.1.0]
+- Upgrading dependencies
+- NodeJS 12.13 is now the minimum supported version
+- Adding general settings as new configuration page to ui
+- Adding new feature working hours
+
 ###### [V5.0.0]
 - Upgrading dependencies
 - NodeJS 12 is now the minimum supported version

README.md

@@ -2,9 +2,11 @@
 
 [![Build Status](https://travis-ci.org/orangecoding/fredy.svg?branch=master)](https://travis-ci.org/orangecoding/fredy)
 
-_Fredy_ scrapes multiple services (Immonet, Immowelt etc.) as often as you want and send new listings to you once they appear. The list of available services can easily be extended. For your convenience, a ui helps you to configure your search jobs.   
+Searching an apartment in Germany can be quite frustrating. Not any longer as Fredy will take over and only notifies you once new listings have been found that matches your requirements.
 
-If _Fredy_ found matching results, it will send them to you via Slack, Email, Telegram etc. (More adapter possible.) As _Fredy_ will store the listings it found, new results will not be sent twice (and as a side-effect, _Fredy_ can show some statistics..)  
+_Fredy_ scrapes multiple services (Immonet, Immowelt etc.) and send new listings to you once they appear. The list of available services can easily be extended. For your convenience, a ui helps you to configure your search jobs.   
+
+If _Fredy_ found matching results, it will send them to you via Slack, Email, Telegram etc. (More adapter possible.) As _Fredy_ will store the listings it has found, new results will not be sent twice (and as a side-effect, _Fredy_ can show some statistics..). Furthermore, _Fredy_ checks duplicates per scraping so that the same listings are not being sent when posted on various platforms. (Happens more often than one might think)
 
 ## Usage  
 
@@ -15,10 +17,10 @@ yarn (or npm install)
 yarn run prod
 yarn run start
 ```
-_Fredy_ will start with the default port, set to `9998`. You can access _Fredy_ by opening a browser `http://localhost:9998`. The default login is `admin` for username and password. (You should change the password asap when you plan to run Fredy on your server.)
+_Fredy_ will start with the default port, set to `9998`. You can access _Fredy_ by opening a browser `http://localhost:9998`. The default login is `admin` both for username and password. (You should change the password asap when you plan to run Fredy on your server.)
 
 <p align="center">
-  <img alt="Job Configuration" src="https://github.com/orangecoding/fredy/blob/master/doc/screenshot_1.png" width="30%">
+  <img alt="Job Configuration" src="https://github.com/orangecoding/fredy/blob/master/doc/screenshot__1.png" width="30%">
 &nbsp; &nbsp; &nbsp; &nbsp;
   <img alt="Job Analytics" src="https://github.com/orangecoding/fredy/blob/master/doc/screenshot2.png" width="30%">
 &nbsp; &nbsp; &nbsp; &nbsp;  
@@ -29,9 +31,9 @@ _Fredy_ will start with the default port, set to `9998`. You can access _Fredy_
 </p>
 
 ## Immoscout
-I have added **EXPERIMENTAL** support for Immoscout. Immoscout is somewhat special, coz they have decided to secure their service from bots using Re-Capture. Finding a way around this is barely possible. For _Fredy_ to be able to bypass the check, I'm using a service called [ScrapingAnt](https://scrapingant.com/). The trick is to use a headless browser, rotating proxies and (once successful validated) re-send the cookies each time.
+I have added **experimental** support for Immoscout. Immoscout is somewhat special, coz they have decided to secure their service from bots using Re-Capture. Finding a way around this is barely possible. For _Fredy_ to be able to bypass the check, I'm using a service called [ScrapingAnt](https://scrapingant.com/). The trick is to use a headless browser, rotating proxies and (once successful validated) re-send the cookies each time.
 
-To be able to use Immoscout, you need to create an account and copy the apiKey into the config file under /conf/config.json.
+To be able to use Immoscout, you need to create an account at ScrapingAnt. Configure the ApiKey in the "General Settings" tab (visible when logged in as administrator).
 The rest should be done by _Fredy_. Keep in mind, the support is experimental. There might be bugs and you might not always get pass the re-capture check, but most of the time it works pretty good :)
 
 If you need more that the 1000 api calls you can do per month, I'd suggest opting for a paid account... ScrapingAnt loves OpenSource, therefor they've decided to give all _Fredy_ users a 10% discount by using the code **FREDY10** (No I don't get any money for recommending good services...)

conf/config.json

@@ -1,7 +1 @@
-{
-  "interval": 30,
-  "port": 9998,
-  "scrapingAnt": {
-    "apiKey": ""
-  }
-}
+{"interval":"60","port":9998,"scrapingAnt":{"apiKey":""},"workingHours":{"from":"","to":""}}

index.js

@@ -9,10 +9,13 @@ const path = './lib/provider';
 const provider = fs.readdirSync(path).filter((file) => file.endsWith('.js'));
 const config = require('./conf/config.json');
 
-const jobStorage = require('./lib/services/storage/jobStorage');
+const similarityCache = require('./lib/services/similarity-check/similarityCache');
 const { setLastJobExecution } = require('./lib/services/storage/listingsStorage');
+const jobStorage = require('./lib/services/storage/jobStorage');
 const FredyRuntime = require('./lib/FredyRuntime');
 
+const { duringWorkingHoursOrNotSet } = require('./lib/utils');
+
 //starting the api service
 require('./lib/api/api');
 
@@ -24,31 +27,45 @@ console.log(`Started Fredy successfully. Ui can be accessed via http://localhost
 /* eslint-enable no-console */
 setInterval(
   (function exec() {
-    config.lastRun = Date.now();
-    jobStorage
-      .getJobs()
-      .filter((job) => job.enabled)
-      .forEach((job) => {
-        const providerIds = job.provider.map((provider) => provider.id);
+    const isDuringWorkingHoursOrNotSet = duringWorkingHoursOrNotSet(config, Date.now());
 
-        provider
-          .filter((provider) => provider.endsWith('.js'))
-          .map((pro) => require(`${path}/${pro}`))
-          .filter((provider) => providerIds.indexOf(provider.metaInformation.id) !== -1)
-          .forEach(async (pro) => {
-            const providerId = pro.metaInformation.id;
-            if (providerId == null || providerId.length === 0) {
-              throw new Error('Provider id must not be empty. => ' + pro);
-            }
-            const providerConfig = job.provider.find((jobProvider) => jobProvider.id === providerId);
-            if (providerConfig == null) {
-              throw new Error(`Provider Config for provider with id ${providerId} not found.`);
-            }
-            pro.init(providerConfig, job.blacklist);
-            await new FredyRuntime(pro.config, job.notificationAdapter, providerId, job.id).execute();
-            setLastJobExecution(job.id);
-          });
-      });
+    if (isDuringWorkingHoursOrNotSet) {
+      config.lastRun = Date.now();
+      jobStorage
+        .getJobs()
+        .filter((job) => job.enabled)
+        .forEach((job) => {
+          const providerIds = job.provider.map((provider) => provider.id);
+
+          provider
+            .filter((provider) => provider.endsWith('.js'))
+            .map((pro) => require(`${path}/${pro}`))
+            .filter((provider) => providerIds.indexOf(provider.metaInformation.id) !== -1)
+            .forEach(async (pro) => {
+              const providerId = pro.metaInformation.id;
+              if (providerId == null || providerId.length === 0) {
+                throw new Error('Provider id must not be empty. => ' + pro);
+              }
+              const providerConfig = job.provider.find((jobProvider) => jobProvider.id === providerId);
+              if (providerConfig == null) {
+                throw new Error(`Provider Config for provider with id ${providerId} not found.`);
+              }
+              pro.init(providerConfig, job.blacklist);
+              await new FredyRuntime(
+                pro.config,
+                job.notificationAdapter,
+                providerId,
+                job.id,
+                similarityCache
+              ).execute();
+              setLastJobExecution(job.id);
+            });
+        });
+    } else {
+      /* eslint-disable no-console */
+      console.debug('Working hours set. Skipping as outside of working hours.');
+      /* eslint-enable no-console */
+    }
     return exec;
   })(),
   INTERVAL

lib/FredyRuntime.js

@@ -1,9 +1,10 @@
-const { NoNewListingsError } = require('./errors');
+const { NoNewListingsWarning } = require('./errors');
 const { setKnownListings, getKnownListings } = require('./services/storage/listingsStorage');
 
 const notify = require('./notification/notify');
 const xray = require('./services/scraper');
 const scrapingAnt = require('./services/scrapingAnt');
+const urlModifier = require('./services/queryStringMutator');
 
 class FredyRuntime {
   /**
@@ -12,17 +13,20 @@ class FredyRuntime {
    * @param notificationConfig the config for all notifications
    * @param providerId the id of the provider currently in use
    * @param jobKey key of the job that is currently running (from within the config)
+   * @param similarityCache cache instance holding values to check for similarity of entries
    */
-  constructor(providerConfig, notificationConfig, providerId, jobKey) {
+  constructor(providerConfig, notificationConfig, providerId, jobKey, similarityCache) {
     this._providerConfig = providerConfig;
     this._notificationConfig = notificationConfig;
     this._providerId = providerId;
     this._jobKey = jobKey;
+    this._similarityCache = similarityCache;
   }
 
   execute() {
     return (
-      Promise.resolve(this._providerConfig.url)
+      //modify the url to make sure search order is correctly set
+      Promise.resolve(urlModifier(this._providerConfig.url, this._providerConfig.sortByDateParam))
         //scraping the site and try finding new listings
         .then(this._getListings.bind(this))
         //bring them in a proper form (dictated by the provider)
@@ -33,6 +37,8 @@ class FredyRuntime {
         .then(this._findNew.bind(this))
         //store everything in db
         .then(this._save.bind(this))
+        //check for similar listings. if found, remove them before notifying
+        .then(this._filterBySimilarListings.bind(this))
         //notify the user using the configured notification adapter
         .then(this._notify.bind(this))
         //if an error occurred on the way, handle it here.
@@ -53,14 +59,29 @@ class FredyRuntime {
       }
       const u = scrapingAnt.isImmoscout(id) ? scrapingAnt.transformUrlForScrapingAnt(url, id) : url;
       try {
-        xray(u, this._providerConfig.crawlContainer, [this._providerConfig.crawlFields])
-          .then((listings) => {
-            resolve(listings == null ? [] : listings);
-          })
-          .catch((err) => {
-            reject(err);
-            console.error(err);
-          });
+        if (this._providerConfig.paginate != null) {
+          xray(u, this._providerConfig.crawlContainer, [this._providerConfig.crawlFields])
+            //the first 2 pages should be enough here
+            //TODO: Think about automagically sort by date
+            .limit(2)
+            .paginate(this._providerConfig.paginate)
+            .then((listings) => {
+              resolve(listings == null ? [] : listings);
+            })
+            .catch((err) => {
+              reject(err);
+              console.error(err);
+            });
+        } else {
+          xray(u, this._providerConfig.crawlContainer, [this._providerConfig.crawlFields])
+            .then((listings) => {
+              resolve(listings == null ? [] : listings);
+            })
+            .catch((err) => {
+              reject(err);
+              console.error(err);
+            });
+        }
       } catch (error) {
         reject(error);
         console.error(error);
@@ -80,13 +101,16 @@ class FredyRuntime {
     const newListings = listings.filter((o) => getKnownListings(this._jobKey, this._providerId)[o.id] == null);
 
     if (newListings.length === 0) {
-      throw new NoNewListingsError();
+      throw new NoNewListingsWarning();
     }
 
     return newListings;
   }
 
   _notify(newListings) {
+    if (newListings.length === 0) {
+      throw new NoNewListingsWarning();
+    }
     const sendNotifications = notify.send(this._providerId, newListings, this._notificationConfig, this._jobKey);
     return Promise.all(sendNotifications).then(() => newListings);
   }
@@ -100,8 +124,22 @@ class FredyRuntime {
     return newListings;
   }
 
+  _filterBySimilarListings(listings) {
+    const filteredList = listings.filter((listing) => {
+      const similar = this._similarityCache.hasSimilarEntries(this._jobKey, listing.title);
+      if (similar) {
+        /* eslint-disable no-console */
+        console.debug(`Filtering similar entry for job with id ${this._jobKey} with title: `, listing.title);
+        /* eslint-enable no-console */
+      }
+      return !similar;
+    });
+    filteredList.forEach((filter) => this._similarityCache.addCacheEntry(this._jobKey, filter.title));
+    return filteredList;
+  }
+
   _handleError(err) {
-    if (err.name !== 'NoNewListingsError') console.error(err);
+    if (err.name !== 'NoNewListingsWarning') console.error(err);
   }
 }
 

lib/api/api.js

@@ -1,5 +1,6 @@
 const { notificationAdapterRouter } = require('./routes/notificationAdapterRouter');
 const { authInterceptor, cookieSession, adminInterceptor } = require('./security');
+const { generalSettingsRouter } = require('./routes/generalSettingsRoute');
 const { analyticsRouter } = require('./routes/analyticsRouter');
 const { providerRouter } = require('./routes/providerRouter');
 const { loginRouter } = require('./routes/loginRoute');
@@ -28,6 +29,7 @@ service.use('/api/jobs', authInterceptor());
 service.use('/api/admin', adminInterceptor());
 
 service.use('/api/jobs/notificationAdapter', notificationAdapterRouter);
+service.use('/api/admin/generalSettings', generalSettingsRouter);
 service.use('/api/jobs/provider', providerRouter);
 service.use('/api/jobs/insights', analyticsRouter);
 service.use('/api/admin/users', userRouter);

lib/api/routes/generalSettingsRoute.js

@@ -0,0 +1,24 @@
+const service = require('restana')();
+const generalSettingsRouter = service.newRouter();
+const config = require('../../../conf/config.json');
+const fs = require('fs');
+
+generalSettingsRouter.get('/', async (req, res) => {
+  res.body = Object.assign({}, config);
+  res.send();
+});
+
+generalSettingsRouter.post('/', async (req, res) => {
+  const settings = req.body;
+
+  try {
+    fs.writeFileSync(`${__dirname}/../../../conf/config.json`, JSON.stringify(settings));
+  } catch (err) {
+    console.error(err);
+    res.send(new Error('Error while trying to write settings.'));
+    return;
+  }
+  res.send();
+});
+
+exports.generalSettingsRouter = generalSettingsRouter;

lib/errors.js

@@ -10,6 +10,6 @@ class ExtendableError extends Error {
   }
 }
 
-class NoNewListingsError extends ExtendableError {}
+class NoNewListingsWarning extends ExtendableError {}
 
-module.exports = { NoNewListingsError };
+module.exports = { NoNewListingsWarning };

lib/notification/adapter/mailJet.js

@@ -21,6 +21,13 @@ exports.send = ({ serviceName, newListings, notificationConfig, jobKey }) => {
     (adapter) => adapter.id === 'mailJet'
   ).fields;
 
+  const to = receiver
+    .trim()
+    .split(',')
+    .map((r) => ({
+      Email: r.trim(),
+    }));
+
   return mailjet
     .connect(apiPublicKey, apiPrivateKey)
     .post('send', { version: 'v3.1' })
@@ -31,11 +38,7 @@ exports.send = ({ serviceName, newListings, notificationConfig, jobKey }) => {
             Email: from,
             Name: 'Fredy',
           },
-          To: [
-            {
-              Email: receiver,
-            },
-          ],
+          To: to,
           Subject: `Fredy found ${newListings.length} new listings for ${serviceName}`,
           HTMLPart: emailTemplate({
             serviceName: `Job: (${jobKey}) | Service: ${serviceName}`,

lib/notification/adapter/mailJet.md

@@ -4,3 +4,5 @@ To use [MailJet](https://mailjet.com), you need to create an account. You'll nee
  
 E.g. if you use yourGmailAccount@gmail.com, you have to add this to MailJet and verify it as well.     
 The given public/private api keys are needed in order to use MailJet with Fredy. Fredy will use the same template, it is using for SendGrid.
+
+If this email should be sent to multiple receiver use a comma separator (some@email.com, someOther@email.com). 

lib/notification/adapter/sendGrid.js

@@ -14,7 +14,10 @@ exports.send = ({ serviceName, newListings, notificationConfig, jobKey }) => {
   sgMail.setApiKey(apiKey);
   const msg = {
     templateId,
-    to: receiver,
+    to: receiver
+      .trim()
+      .split(',')
+      .map((r) => r.trim()),
     from,
     subject: `Job ${jobKey} | Service ${serviceName} found ${newListings.length} new listing(s)`,
     dynamic_template_data: {

lib/notification/adapter/sendGrid.md

@@ -6,3 +6,5 @@ SendGrid is a free email service (free as in "you cannot send more than 100(Send
 To use [SendGrid](https://sendgrid.com/), you need to create an account. You'll need to decided from which email address you want Fredy to send from. E.g. if you use yourGmailAccount@gmail.com, you have to add this to sendgrid and verify it as well.     
 
 Lastly you have to create an api-key and feed it into Fredy's config, as well as creating a new dynamic template. For this new template, I recommend copying and pasting the code from the one I have provided under `/lib/notification/emailTemplate/template.hbs`.
+
+If this email should be sent to multiple receiver use a comma separator (some@email.com, someOther@email.com).

lib/notification/adapter/telegram.js

@@ -1,6 +1,19 @@
 const { markdown2Html } = require('../../services/markdown');
 const axios = require('axios');
 
+/**
+ * splitting an array into chunks because Telegram only allows for messages up to
+ * 4096 chars, thus we have to split messages into chunks
+ * @param inputArray
+ * @param perChunk
+ */
+const arrayChunks = (inputArray, perChunk) =>
+  inputArray.reduce((all, one, i) => {
+    const ch = Math.floor(i / perChunk);
+    all[ch] = [].concat(all[ch] || [], one);
+    return all;
+  }, []);
+
 /**
  * sends new listings to telegram
  * @param serviceName e.g immowelt
@@ -12,22 +25,28 @@ const axios = require('axios');
 exports.send = ({ serviceName, newListings, notificationConfig, jobKey }) => {
   const { token, chatId } = notificationConfig.find((adapter) => adapter.id === 'telegram').fields;
 
-  let message = `Job: ${jobKey} | Service <b>${serviceName}</b> found <b>${newListings.length}</b> new listings:\n\n`;
+  //we have to split messages into chunk, because otherwise messages are going to become too big and will fail
+  const chunks = arrayChunks(newListings, 3);
 
-  message += newListings.map(
-    (o) =>
-      `<b>${shorten(o.title.replace(/\*/g, ''), 45)}</b>\n` +
-      [o.address, o.price, o.size].join(' | ') +
-      '\n' +
-      `<a href="${o.link}">${o.link}</a>\n\n`
-  );
+  const promises = chunks.map((chunk) => {
+    let message = `Job: ${jobKey} | Service <b>${serviceName}</b> found <b>${newListings.length}</b> new listings:\n\n`;
+    message += chunk.map(
+      (o) =>
+        `<b>${shorten(o.title.replace(/\*/g, ''), 45)}</b>\n` +
+        [o.address, o.price, o.size].join(' | ') +
+        '\n' +
+        `<a href="${o.link}">${o.link}</a>\n\n`
+    );
 
-  return axios.post(`https://api.telegram.org/bot${token}/sendMessage`, {
-    chat_id: chatId,
-    text: message,
-    parse_mode: 'HTML',
-    disable_web_page_preview: true,
+    return axios.post(`https://api.telegram.org/bot${token}/sendMessage`, {
+      chat_id: chatId,
+      text: message,
+      parse_mode: 'HTML',
+      disable_web_page_preview: true,
+    });
   });
+
+  return Promise.all(promises);
 };
 
 function shorten(str, len = 30) {

lib/provider/einsAImmobilien.js

@@ -22,6 +22,7 @@ function applyBlacklist(o) {
 const config = {
   url: null,
   crawlContainer: '.tabelle',
+  sortByDateParam: 'sort_type=newest',
   crawlFields: {
     id: '.inner_object_data input[name="marker_objekt_id"]@value | int',
     price: '.tabelle .inner_object_data .single_data_price | removeNewline | trim',
@@ -30,7 +31,6 @@ const config = {
     title: '.tabelle .inner_object_data .tabelle_inhalt_titel_black | removeNewline | trim',
     description: '.tabelle .inner_object_data .objekt_beschreibung | removeNewline | trim',
   },
-  paginate: '.pagination_blocks div:last a@href',
   normalize: normalize,
   filter: applyBlacklist,
 };

lib/provider/immonet.js

@@ -24,6 +24,7 @@ function applyBlacklist(o) {
 const config = {
   url: null,
   crawlContainer: '#result-list-stage .item',
+  sortByDateParam: 'sortby=19',
   crawlFields: {
     id: '@id',
     price: 'div[id*="selPrice_"] | trim',

lib/provider/immoscout.js

@@ -2,9 +2,13 @@ const utils = require('../utils');
 
 let appliedBlackList = [];
 
+function nullOrEmpty(val) {
+  return val == null || val.length === 0;
+}
+
 function normalize(o) {
-  const title = o.title.replace('NEU', '');
-  const address = (o.address || '').replace(/\(.*\),.*$/, '').trim();
+  const title = nullOrEmpty(o.title) ? 'NO TITLE FOUND' : o.title.replace('NEU', '');
+  const address = nullOrEmpty(o.address) ? 'NO ADDRESS FOUND' : (o.address || '').replace(/\(.*\),.*$/, '').trim();
   const link = `https://www.immobilienscout24.de${o.link.substring(o.link.indexOf('/expose'))}`;
   return Object.assign(o, { title, address, link });
 }
@@ -16,6 +20,7 @@ function applyBlacklist(o) {
 const config = {
   url: null,
   crawlContainer: '#resultListItems li.result-list__listing',
+  sortByDateParam: 'sorting=2',
   crawlFields: {
     id: '.result-list-entry@data-obid | int',
     price: '.result-list-entry .result-list-entry__criteria .grid-item:first-child dd | removeNewline | trim',

lib/provider/immowelt.js

@@ -3,10 +3,7 @@ const utils = require('../utils');
 let appliedBlackList = [];
 
 function normalize(o) {
-  const size = o.size == null ? '--- m²' : o.size.split('Wohnfläche')[1].replace(' (ca.) ', '');
-  const address = o.address;
-
-  return Object.assign(o, { size, address });
+  return o;
 }
 
 function applyBlacklist(o) {
@@ -18,14 +15,15 @@ function applyBlacklist(o) {
 
 const config = {
   url: null,
-  crawlContainer: '.immoliste .js-object.listitem_wrap ',
+  crawlContainer: "div[class^='EstateItem-']",
+  sortByDateParam: 'sd=DESC&sf=TIMESTAMP',
   crawlFields: {
-    id: '@data-estateid | int',
-    price: '.hardfacts_3 strong | removeNewline | trim',
-    size: '.js-object.listitem_wrap .hardfacts_3 div:nth-child(2)| removeNewline | trim',
-    title: '.listcontent.clear h2',
+    id: 'a@id',
+    price: "div[class^='KeyFacts-'] [data-test='price'] | removeNewline | trim",
+    size: "div[class^='KeyFacts-'] [data-test='area'] | removeNewline | trim",
+    title: "div[class^='FactsMain-'] h2",
     link: 'a@href',
-    address: '.listcontent .details .listlocation| removeNewline | trim',
+    address: "div[class^='estateFacts-'] span | removeNewline | trim",
   },
   paginate: '#pnlPaging #nlbPlus@href',
   normalize: normalize,

lib/provider/kleinanzeigen.js

@@ -20,7 +20,9 @@ function applyBlacklist(o) {
 
 const config = {
   url: null,
-  crawlContainer: '#srchrslt-adtable .ad-listitem',
+  crawlContainer: '#srchrslt-adtable .ad-listitem ',
+  //sort by date is standard oO
+  sortByDateParam: null,
   crawlFields: {
     id: '.aditem@data-adid | int',
     price: '.aditem-main--middle--price | removeNewline | trim',

lib/provider/neubauKompass.js

@@ -13,6 +13,7 @@ function applyBlacklist(o) {
 const config = {
   url: null,
   crawlContainer: '.nbk-container >div article',
+  sortByDateParam: 'Sortierung=Id&Richtung=DESC',
   crawlFields: {
     id: '@id',
     title: 'a.nbk-truncate@title | removeNewline | trim',

lib/provider/wgGesucht.js

@@ -16,6 +16,7 @@ function applyBlacklist(o) {
 const config = {
   url: null,
   crawlContainer: '#main_column .wgg_card',
+  sortByDateParam: 'sort_column=0&sort_order=0',
   crawlFields: {
     id: '@data-id',
     details: '.row .noprint .col-xs-11 |removeNewline |trim',
@@ -24,7 +25,6 @@ const config = {
     title: '.truncate_title a |removeNewline |trim',
     link: '.truncate_title a@href',
   },
-  paginate: '.pagination-sm:first a:last@href',
   normalize: normalize,
   filter: applyBlacklist,
 };

lib/services/queryStringMutator.js

@@ -0,0 +1,22 @@
+const queryString = require('query-string');
+
+/**
+ * for Fredy, it is important to sort search results by date, starting with the latest listing. if it is not sorted, we
+ * might never actually find the newest results, no matter how many pages we crawl.
+ * It has been written in the documentation, but obviously nobody reads docu theses days which is why it's been done
+ * automagically now.
+ *
+ * @param _url actual provider url containing the searchParams
+ * @param sortByDateParam param(s) indicating the correct sort order
+ * @returns {`${string}?${string}`} correctly formatted url
+ */
+module.exports = (_url, sortByDateParam) => {
+  //if no mutation is necessary, just return the original url
+  if (sortByDateParam == null) {
+    return _url;
+  }
+
+  const original = queryString.parseUrl(_url);
+  const mutate = queryString.parse(sortByDateParam);
+  return `${original.url}?${queryString.stringify({ ...original.query, ...mutate })}`;
+};

lib/services/requestDriver.js

@@ -1,4 +1,7 @@
 const axios = require('axios');
+const axiosRetry = require('axios-retry');
+
+axiosRetry(axios, { retryDelay: axiosRetry.exponentialDelay, retries: 3 });
 
 function makeDriver(headers = {}) {
   let cookies = '';
@@ -15,7 +18,8 @@ function makeDriver(headers = {}) {
         },
       });
     } catch (exception) {
-      callback(exception, null);
+      console.error(`Error while trying to scrape data. Received error: ${exception.message}`);
+      callback(null, []);
     }
 
     if (typeof result.data === 'object' && url.toLowerCase().indexOf('scrapingant') !== -1) {

lib/services/similarity-check/SimilarityCacheEntry.js

@@ -0,0 +1,36 @@
+const stringSimilarity = require('string-similarity');
+
+//if the score is higher than this, it will be considered a match
+const MAX_DICE_INDEX = 0.7;
+
+/**
+ * The similarity check is based on the dice coefficient. => https://en.wikipedia.org/wiki/S%C3%B8rensen%E2%80%93Dice_coefficient
+ *
+ * @type {module.SimilarityCacheEntry}
+ */
+module.exports = class SimilarityCacheEntry {
+  constructor(time) {
+    this.time = time;
+    this.values = [];
+  }
+
+  setCacheEntry = (entry) => {
+    this.values.push(entry);
+  };
+
+  getTime = () => {
+    return this.time;
+  };
+
+  hasSimilarEntries = (value) => {
+    if (this.values.length > 0) {
+      for (let i = 0; i < this.values.length; i++) {
+        const index = stringSimilarity.compareTwoStrings(value, this.values[i]);
+        if (index >= MAX_DICE_INDEX) {
+          return true;
+        }
+      }
+    }
+    return false;
+  };
+};

lib/services/similarity-check/similarityCache.js

@@ -0,0 +1,63 @@
+/**
+ * each job that runs scrapes all provider. This cache holds the titles of the found listing(s) and provides
+ * a similarity check. if this check returns true, it will not be forwarded to the notification adapter, thus
+ * the user won't see any duplicates
+ *
+ * The retention of this cache is per default 5 minutes, but can be smaller if the interval is > 5 mins.
+ *
+ * @type {module.SimilarityCacheEntry|{}}
+ */
+const SimilarityCacheEntry = require('./SimilarityCacheEntry');
+const config = require('../../../conf/config.json');
+
+//5 minutes
+let retention = 5 * 60 * 1000;
+
+const intervalInMs = config.interval * 60 * 1000;
+//an interval below 5 mins sounds crazy, but there are ppl out there doing crazy shit.
+if (intervalInMs <= retention) {
+  retention = Math.floor(intervalInMs / 2);
+}
+
+//jobid -> SimilarityCacheEntry
+const cache = {};
+
+let intervalId;
+
+exports.addCacheEntry = (jobId, value) => {
+  cache[jobId] = cache[jobId] || new SimilarityCacheEntry(Date.now());
+  cache[jobId].setCacheEntry(value);
+};
+
+exports.hasSimilarEntries = (jobId, value) => {
+  if (cache[jobId] == null) {
+    return false;
+  }
+
+  return cache[jobId].hasSimilarEntries(value);
+};
+
+/**
+ * cleanup
+ */
+intervalId = setInterval(() => {
+  const keysToBeRemoved = [];
+  const now = Date.now();
+
+  Object.keys(cache).forEach((key) => {
+    if (cache[key].getTime() + retention < now) {
+      keysToBeRemoved.push(key);
+    }
+  });
+
+  if (keysToBeRemoved.length > 0) {
+    keysToBeRemoved.forEach((key) => delete cache[key]);
+  }
+}, 10000);
+
+/**
+ * mostly used for tests
+ */
+exports.stopCacheCleanup = () => {
+  clearInterval(intervalId);
+};

lib/services/storage/jobStorage.js

@@ -61,12 +61,18 @@ exports.setJobStatus = ({ jobId, status }) => {
 };
 
 exports.removeJob = (jobId) => {
+  listingStorage.removeListings(jobId);
   db.get('jobs')
     .remove((job) => job.id === jobId)
     .write();
 };
 
 exports.removeJobsByUserId = (userId) => {
+  db.get('jobs')
+    .value()
+    .filter((job) => job.userId === userId)
+    .forEach((job) => listingStorage.removeListings(job.id));
+
   db.get('jobs')
     .remove((job) => job.userId === userId)
     .write();

lib/services/storage/listingsStorage.js

@@ -47,3 +47,7 @@ exports.setLastJobExecution = (jobId) => {
   const key = buildKey(jobId, null, 'lastExecution');
   return db.set(key, Date.now()).write();
 };
+
+exports.removeListings = (jobId) => {
+  db.unset(jobId).write();
+};

lib/utils.js

@@ -8,4 +8,29 @@ function isOneOf(word, arr) {
   return blacklist.test(word);
 }
 
-module.exports = { isOneOf };
+function nullOrEmpty(val) {
+  return val == null || val.length === 0;
+}
+
+function timeStringToMs(timeString, now) {
+  const d = new Date(now);
+  const parts = timeString.split(':');
+  d.setHours(parts[0]);
+  d.setMinutes(parts[1]);
+  d.setSeconds(0);
+  return d.getTime();
+}
+
+function duringWorkingHoursOrNotSet(config, now) {
+  const { workingHours } = config;
+  if (workingHours == null || nullOrEmpty(workingHours.from) || nullOrEmpty(workingHours.to)) {
+    return true;
+  }
+
+  const toDate = timeStringToMs(workingHours.to, now);
+  const fromDate = timeStringToMs(workingHours.from, now);
+
+  return fromDate <= now && toDate >= now;
+}
+
+module.exports = { isOneOf, nullOrEmpty, duringWorkingHoursOrNotSet };

package.json

@@ -1,13 +1,14 @@
 {
   "name": "fredy",
-  "version": "5.0.0",
+  "version": "5.4.ß",
   "description": "[F]ind [R]eal [E]states [d]amn eas[y].",
   "scripts": {
     "start": "node index.js",
     "dev": "yarn && export BUILD_DEV='true' && export NODE_ENV='development' && webpack-dev-server --progress --colors --watch --config ./webpack.dev.js",
     "prod": "export BUILD_DEV='false' && webpack --node-env=production --config ./webpack.prod.js",
     "format": "prettier --write lib/**/*.js ui/src/**/*.js test/**/*.js *.js --single-quote --print-width 120",
-    "test": "mocha --timeout 20000 test/**/*.test.js"
+    "test": "mocha --timeout 20000 test/**/*.test.js",
+    "lint": "eslint ./index.js ./lib/**/*.js ./test/**/*.js"
   },
   "husky": {
     "hooks": {
@@ -32,6 +33,7 @@
     "house",
     "rent",
     "immoscout",
+    "scraper",
     "immonet",
     "immowelt",
     "immobilienscout24"
@@ -41,7 +43,7 @@
   },
   "license": "MIT",
   "engines": {
-    "node": ">=12.0.0",
+    "node": ">=12.13.0",
     "npm": ">=6.0.0"
   },
   "browserslist": [
@@ -51,61 +53,64 @@
     "Firefox ESR"
   ],
   "dependencies": {
-    "@rematch/core": "2.0.1",
-    "@rematch/loading": "2.0.1",
-    "@sendgrid/mail": "7.4.4",
-    "axios": "0.21.1",
+    "@rematch/core": "2.2.0",
+    "@rematch/loading": "2.1.2",
+    "@sendgrid/mail": "7.6.0",
+    "axios": "0.24.0",
+    "axios-retry": "^3.2.4",
     "body-parser": "1.19.0",
     "cookie-session": "1.4.0",
     "handlebars": "4.7.7",
-    "highcharts": "9.1.0",
-    "highcharts-react-official": "3.0.0",
+    "highcharts": "9.3.1",
+    "highcharts-react-official": "3.1.0",
     "lowdb": "1.0.0",
     "markdown": "^0.5.0",
-    "nanoid": "3.1.23",
-    "node-mailjet": "3.3.1",
+    "nanoid": "3.1.30",
+    "node-mailjet": "3.3.4",
+    "query-string": "^7.0.1",
     "react": "17.0.2",
     "react-dom": "17.0.2",
-    "react-redux": "7.2.4",
-    "react-router": "5.2.0",
-    "react-router-dom": "5.2.0",
+    "react-redux": "7.2.6",
+    "react-router": "5.2.1",
+    "react-router-dom": "5.3.0",
     "react-switch": "^6.0.0",
-    "redux": "4.1.0",
-    "redux-thunk": "2.3.0",
-    "restana": "4.9.1",
-    "semantic-ui-react": "2.0.3",
+    "redux": "4.1.2",
+    "redux-thunk": "2.4.0",
+    "restana": "4.9.2",
+    "semantic-ui-react": "2.0.4",
     "serve-static": "^1.14.1",
     "slack": "11.0.2",
+    "string-similarity": "^4.0.4",
     "x-ray": "2.3.4"
   },
   "devDependencies": {
-    "@babel/core": "7.14.3",
-    "@babel/preset-env": "7.14.2",
-    "@babel/preset-react": "7.13.13",
+    "@babel/core": "7.16.0",
+    "@babel/preset-env": "7.16.4",
+    "@babel/preset-react": "7.16.0",
     "babel-eslint": "10.1.0",
-    "babel-loader": "8.2.2",
+    "babel-loader": "8.2.3",
     "chai": "4.3.4",
-    "clean-webpack-plugin": "3.0.0",
-    "copy-webpack-plugin": "8.1.1",
-    "css-loader": "5.2.4",
-    "eslint": "7.26.0",
+    "clean-webpack-plugin": "4.0.0",
+    "copy-webpack-plugin": "10.0.0",
+    "css-loader": "6.5.1",
+    "eslint": "7.32.0",
     "eslint-config-prettier": "8.3.0",
-    "eslint-plugin-react": "7.23.2",
+    "eslint-plugin-react": "7.27.1",
     "file-loader": "6.2.0",
-    "history": "5.0.0",
+    "history": "5.1.0",
     "husky": "4.3.8",
-    "less": "4.1.1",
-    "less-loader": "9.0.0",
-    "lint-staged": "11.0.0",
-    "mocha": "8.4.0",
-    "prettier": "2.3.0",
+    "less": "4.1.2",
+    "less-loader": "10.2.0",
+    "lint-staged": "12.1.2",
+    "mocha": "9.1.3",
+    "prettier": "2.5.0",
     "proxyquire": "2.1.3",
     "redux-logger": "3.0.6",
-    "style-loader": "2.0.0",
+    "style-loader": "3.3.1",
     "url-loader": "4.1.1",
-    "webpack": "5.37.1",
+    "webpack": "5.64.4",
     "webpack-cli": "3.3.12",
     "webpack-dev-server": "3.11.2",
-    "webpack-merge": "5.7.3"
+    "webpack-merge": "5.8.0"
   }
 }

test/provider/einsAImmobilien.test.js

@@ -1,3 +1,4 @@
+const similarityCache = require('../../lib/services/similarity-check/similarityCache');
 const mockNotification = require('../mocks/mockNotification');
 const providerConfig = require('./testProvider.json');
 const mockStore = require('../mocks/mockStore');
@@ -6,6 +7,10 @@ const expect = require('chai').expect;
 const provider = require('../../lib/provider/einsAImmobilien');
 
 describe('#einsAImmobilien testsuite()', () => {
+  after(() => {
+    similarityCache.stopCacheCleanup();
+  });
+
   provider.init(providerConfig.einsAImmobilien, [], []);
 
   const Fredy = proxyquire('../../lib/FredyRuntime', {
@@ -17,7 +22,7 @@ describe('#einsAImmobilien testsuite()', () => {
 
   it('should test einsAImmobilien provider', async () => {
     return await new Promise((resolve) => {
-      const fredy = new Fredy(provider.config, null, provider.metaInformation.id, 'test1');
+      const fredy = new Fredy(provider.config, null, provider.metaInformation.id, 'test1', similarityCache);
       fredy.execute().then((listings) => {
         expect(listings).to.be.a('array');
 

test/provider/immonet.test.js

@@ -1,3 +1,4 @@
+const similarityCache = require('../../lib/services/similarity-check/similarityCache');
 const mockNotification = require('../mocks/mockNotification');
 const providerConfig = require('./testProvider.json');
 const mockStore = require('../mocks/mockStore');
@@ -6,6 +7,10 @@ const expect = require('chai').expect;
 const provider = require('../../lib/provider/immonet');
 
 describe('#immonet testsuite()', () => {
+  after(() => {
+    similarityCache.stopCacheCleanup();
+  });
+
   provider.init(providerConfig.immonet, [], []);
   const Fredy = proxyquire('../../lib/FredyRuntime', {
     './services/storage/listingsStorage': {
@@ -16,7 +21,7 @@ describe('#immonet testsuite()', () => {
 
   it('should test immonet provider', async () => {
     return await new Promise((resolve) => {
-      const fredy = new Fredy(provider.config, null, provider.metaInformation.id, 'test1');
+      const fredy = new Fredy(provider.config, null, provider.metaInformation.id, 'test1', similarityCache);
       fredy.execute().then((listing) => {
         expect(listing).to.be.a('array');
 

test/provider/immoscout.test.js

@@ -1,3 +1,4 @@
+const similarityCache = require('../../lib/services/similarity-check/similarityCache');
 const mockNotification = require('../mocks/mockNotification');
 const providerConfig = require('./testProvider.json');
 const mockStore = require('../mocks/mockStore');
@@ -7,6 +8,9 @@ const provider = require('../../lib/provider/immoscout');
 const scrapingAnt = require('../../lib/services/scrapingAnt');
 
 describe('#immoscout testsuite()', () => {
+  after(() => {
+    similarityCache.stopCacheCleanup();
+  });
   provider.init(providerConfig.immoscout, [], []);
   const Fredy = proxyquire('../../lib/FredyRuntime', {
     './services/storage/listingsStorage': {
@@ -25,7 +29,7 @@ describe('#immoscout testsuite()', () => {
         return;
       }
 
-      const fredy = new Fredy(provider.config, null, provider.metaInformation.id, 'test1');
+      const fredy = new Fredy(provider.config, null, provider.metaInformation.id, 'test1', similarityCache);
       fredy.execute().then((listing) => {
         expect(listing).to.be.a('array');
 

test/provider/immowelt.test.js

@@ -1,3 +1,4 @@
+const similarityCache = require('../../lib/services/similarity-check/similarityCache');
 const mockNotification = require('../mocks/mockNotification');
 const providerConfig = require('./testProvider.json');
 const mockStore = require('../mocks/mockStore');
@@ -6,6 +7,9 @@ const expect = require('chai').expect;
 const provider = require('../../lib/provider/immowelt');
 
 describe('#immowelt testsuite()', () => {
+  after(() => {
+    similarityCache.stopCacheCleanup();
+  });
   it('should test immowelt provider', async () => {
     provider.init(providerConfig.immowelt, [], []);
     const Fredy = proxyquire('../../lib/FredyRuntime', {
@@ -16,7 +20,7 @@ describe('#immowelt testsuite()', () => {
     });
 
     return await new Promise((resolve) => {
-      const fredy = new Fredy(provider.config, null, provider.metaInformation.id, 'test1');
+      const fredy = new Fredy(provider.config, null, provider.metaInformation.id, 'test1', similarityCache);
       fredy.execute().then((listing) => {
         expect(listing).to.be.a('array');
 
@@ -26,7 +30,7 @@ describe('#immowelt testsuite()', () => {
 
         notificationObj.payload.forEach((notify) => {
           /** check the actual structure **/
-          expect(notify.id).to.be.a('number');
+          expect(notify.id).to.be.a('string');
           expect(notify.price).to.be.a('string');
           expect(notify.size).to.be.a('string');
           expect(notify.title).to.be.a('string');

test/provider/kleinanzeigen.test.js

@@ -1,3 +1,4 @@
+const similarityCache = require('../../lib/services/similarity-check/similarityCache');
 const mockNotification = require('../mocks/mockNotification');
 const providerConfig = require('./testProvider.json');
 const mockStore = require('../mocks/mockStore');
@@ -6,6 +7,9 @@ const expect = require('chai').expect;
 const provider = require('../../lib/provider/kleinanzeigen');
 
 describe('#kleinanzeigen testsuite()', () => {
+  after(() => {
+    similarityCache.stopCacheCleanup();
+  });
   it('should test kleinanzeigen provider', async () => {
     provider.init(providerConfig.kleinanzeigen, [], []);
     const Fredy = proxyquire('../../lib/FredyRuntime', {
@@ -16,7 +20,7 @@ describe('#kleinanzeigen testsuite()', () => {
     });
 
     return await new Promise((resolve) => {
-      const fredy = new Fredy(provider.config, null, provider.metaInformation.id, 'test1');
+      const fredy = new Fredy(provider.config, null, provider.metaInformation.id, 'test1', similarityCache);
       fredy.execute().then((listing) => {
         expect(listing).to.be.a('array');
 

test/provider/neubauKompass.test.js

@@ -1,3 +1,4 @@
+const similarityCache = require('../../lib/services/similarity-check/similarityCache');
 const mockNotification = require('../mocks/mockNotification');
 const providerConfig = require('./testProvider.json');
 const mockStore = require('../mocks/mockStore');
@@ -6,6 +7,9 @@ const expect = require('chai').expect;
 const provider = require('../../lib/provider/neubauKompass');
 
 describe('#neubauKompass testsuite()', () => {
+  after(() => {
+    similarityCache.stopCacheCleanup();
+  });
   provider.init(providerConfig.neubauKompass, [], []);
   const Fredy = proxyquire('../../lib/FredyRuntime', {
     './services/storage/listingsStorage': {
@@ -16,7 +20,7 @@ describe('#neubauKompass testsuite()', () => {
 
   it('should test neubauKompass provider', async () => {
     return await new Promise((resolve) => {
-      const fredy = new Fredy(provider.config, null, provider.metaInformation.id, 'test1');
+      const fredy = new Fredy(provider.config, null, provider.metaInformation.id, 'test1', similarityCache);
       fredy.execute().then((listing) => {
         expect(listing).to.be.a('array');
 

test/provider/testProvider.json

@@ -9,7 +9,7 @@
     "enabled": true
   },
   "immowelt": {
-    "url": "https://www.immowelt.de/liste/duesseldorf-benrath/wohnungen/kaufen?geoid=10805111000004%2C10805111000005%2C10805111000006%2C10805111000007%2C10805111000009%2C10805111000010%2C10805111000011%2C10805111000013%2C10805111000014%2C10805111000015%2C10805111000016%2C10805111000017%2C10805111000018%2C10805111000019%2C10805111000023%2C10805111000024%2C10805111000027%2C10805111000032%2C10805111000034%2C10805111000035%2C10805111000039%2C10805111000041%2C10805111000042%2C10805111000043%2C10805111000047%2C10805111000048%2C10805111000049%2C10805111000051%2C10805111000052%2C10805111000053&roomi=3&prima=420000&wflmi=90&sort=createdate%2Bdesc",
+    "url": "https://www.immowelt.de/liste/duesseldorf/wohnungen/kaufen?d=true&rmi=3&sd=DESC&sf=TIMESTAMP&sp=1",
     "enabled": true
   },
   "immoscout": {
@@ -21,7 +21,7 @@
     "enabled": true
   },
   "kleinanzeigen": {
-    "url": "https://www.ebay-kleinanzeigen.de/s-wohnung-kaufen/duesseldorf/anzeige:angebote/preis::420000/wohnung/k0c196l2068r5+wohnung_kaufen.qm_d:90,+wohnung_kaufen.zimmer_d:3.5,",
+    "url": "https://www.ebay-kleinanzeigen.de/s-immobilien/duesseldorf/anzeige:angebote/wohnung/k0c195l2068r5",
     "enabled": true
   },
   "neubauKompass": {

test/provider/utils.test.js

@@ -1,5 +1,13 @@
 const utils = require('../../lib/utils');
 const assert = require('assert');
+const expect = require('chai').expect;
+
+const fakeWorkingHoursConfig = (from, to) => ({
+  workingHours: {
+    to,
+    from,
+  },
+});
 
 describe('utils', () => {
   describe('#isOneOf()', () => {
@@ -10,4 +18,22 @@ describe('utils', () => {
       assert.equal(utils.isOneOf('bla blub blubber', ['bla']), true);
     });
   });
+
+  describe('#duringWorkingHoursOrNotSet()', () => {
+    it('should be false', () => {
+      expect(utils.duringWorkingHoursOrNotSet(fakeWorkingHoursConfig('12:00', '13:00'), 0)).to.be.false;
+    });
+    it('should be true', () => {
+      expect(utils.duringWorkingHoursOrNotSet(fakeWorkingHoursConfig('10:00', '16:00'), 1622026740000)).to.be.true;
+    });
+    it('should be true if nothing set', () => {
+      expect(utils.duringWorkingHoursOrNotSet(fakeWorkingHoursConfig(null, null), 1622026740000)).to.be.true;
+    });
+    it('should be true if only to is set', () => {
+      expect(utils.duringWorkingHoursOrNotSet(fakeWorkingHoursConfig(null, '13:00'), 1622026740000)).to.be.true;
+    });
+    it('should be true if only from is set', () => {
+      expect(utils.duringWorkingHoursOrNotSet(fakeWorkingHoursConfig('12:00', null), 1622026740000)).to.be.true;
+    });
+  });
 });

test/provider/wgGesucht.test.js

@@ -1,3 +1,4 @@
+const similarityCache = require('../../lib/services/similarity-check/similarityCache');
 const mockNotification = require('../mocks/mockNotification');
 const providerConfig = require('./testProvider.json');
 const mockStore = require('../mocks/mockStore');
@@ -6,6 +7,9 @@ const expect = require('chai').expect;
 const provider = require('../../lib/provider/wgGesucht');
 
 describe('#wgGesucht testsuite()', () => {
+  after(() => {
+    similarityCache.stopCacheCleanup();
+  });
   provider.init(providerConfig.wgGesucht, [], []);
   const Fredy = proxyquire('../../lib/FredyRuntime', {
     './services/storage/listingsStorage': {
@@ -16,7 +20,7 @@ describe('#wgGesucht testsuite()', () => {
 
   it('should test wgGesucht provider', async () => {
     return await new Promise((resolve) => {
-      const fredy = new Fredy(provider.config, null, provider.metaInformation.id, 'test1');
+      const fredy = new Fredy(provider.config, null, provider.metaInformation.id, 'test1', similarityCache);
       fredy.execute().then((listing) => {
         expect(listing).to.be.a('array');
         const notificationObj = mockNotification.get();

test/queryStringMutator/queryStringMutator.test.js

@@ -0,0 +1,32 @@
+const testData = require('./testData.json');
+const expect = require('chai').expect;
+const fs = require('fs');
+
+const mutator = require('../../lib/services/queryStringMutator.js');
+const queryString = require('query-string');
+
+/**
+ * Test test might look a bit weird at first, but listen stranger...
+ * It's not wise to compare 2 urls, as this means all url params must be in the expected order. This is however not
+ * guaranteed, as params (and their order) are totally variable.
+ */
+describe('queryStringMutator', () => {
+  it('should fix all urls', () => {
+    let _provider = fs.readdirSync('./lib/provider/').map((integPath) => require(`../../lib/provider/${integPath}`));
+
+    for (let test of testData) {
+      const provider = _provider.find((p) => p.metaInformation.id === test.id);
+      if (provider == null) {
+        throw new Error(`Cannot find provider for given id: ${test.id}`);
+      }
+
+      const fixedUrl = mutator(test.url, provider.config.sortByDateParam);
+      const expectedParams = queryString.parseUrl(test.shouldBecome);
+      const actualParams = queryString.parseUrl(fixedUrl);
+
+      //check if all new params are existing
+      expect(Object.keys(expectedParams.query)).to.include.members(Object.keys(actualParams.query));
+      expect(Object.values(expectedParams.query)).to.include.members(Object.values(actualParams.query));
+    }
+  });
+});

test/queryStringMutator/testData.json

@@ -0,0 +1,33 @@
+[
+  {
+    "url": "https://www.immowelt.de/liste/40589/wohnungen/mieten?d=true&sd=DESC&sf=PRIMARY_PRICE_AMOUNT&sp=1",
+    "shouldBecome": "https://www.immowelt.de/liste/40589/wohnungen/mieten?d=true&sd=DESC&sf=TIMESTAMP&sp=1",
+    "id": "immowelt"
+  },
+  {
+    "url": "https://www.1a-immobilienmarkt.de/suchen/duesseldorf/wohnung-mieten.html?search=yes",
+    "shouldBecome": "https://www.1a-immobilienmarkt.de/suchen/duesseldorf/wohnung-mieten.html?search=yes&sort_type=newest",
+    "id": "einsAImmobilien"
+  },
+  {
+    "url": "https://www.wg-gesucht.de/1-zimmer-wohnungen-in-Dusseldorf.30.1.1.0.html?sort_column=1&sort_order=0",
+    "shouldBecome": "https://www.wg-gesucht.de/1-zimmer-wohnungen-in-Dusseldorf.30.1.1.0.html?sort_column=0&sort_order=0",
+    "id": "wgGesucht"
+  },
+
+  {
+    "url": "https://www.immonet.de/immobiliensuche/sel.do?sortby=0&suchart=1&objecttype=1&marketingtype=2&parentcat=1&locationname=d%C3%BCsseldorf",
+    "shouldBecome": "https://www.immonet.de/immobiliensuche/sel.do?sortby=19&suchart=1&objecttype=1&marketingtype=2&parentcat=1&locationname=d%C3%BCsseldorf",
+    "id": "immonet"
+  },
+  {
+    "url": "https://www.immobilienscout24.de/Suche/de/nordrhein-westfalen/duesseldorf/wohnung-mieten",
+    "shouldBecome": "https://www.immobilienscout24.de/Suche/de/nordrhein-westfalen/duesseldorf/wohnung-mieten?sorting=2",
+    "id": "immoscout"
+  },
+  {
+    "url": "https://www.neubaukompass.de/neubau-immobilien/berlin-region/",
+    "shouldBecome": "https://www.neubaukompass.de/neubau-immobilien/berlin-region/?Sortierung=Id&Richtung=DESC",
+    "id": "neubauKompass"
+  }
+]

test/similarity/similarity.test.js

@@ -0,0 +1,39 @@
+const SimilarityCacheEntry = require('../../lib/services/similarity-check/SimilarityCacheEntry');
+const expect = require('chai').expect;
+
+describe('similarityCheck', () => {
+  describe('#similarityCheck()', () => {
+    it('should be false', () => {
+      const check = new SimilarityCacheEntry(0);
+      check.setCacheEntry('Hallo');
+      expect(check.hasSimilarEntries('Welt')).to.be.false;
+    });
+    it('should be true', () => {
+      const check = new SimilarityCacheEntry(0);
+      check.setCacheEntry('Hallo');
+      expect(check.hasSimilarEntries('hallo')).to.be.true;
+    });
+    it('should be true', () => {
+      const check = new SimilarityCacheEntry(0);
+      check.setCacheEntry('Selling an incredible house in san francisco');
+      expect(check.hasSimilarEntries('incredible house in san francisco for sale')).to.be.true;
+    });
+    it('should be true', () => {
+      const check = new SimilarityCacheEntry(0);
+      check.setCacheEntry('a');
+      check.setCacheEntry('b');
+      check.setCacheEntry('c');
+      check.setCacheEntry('d');
+      expect(check.hasSimilarEntries('b')).to.be.true;
+    });
+    it('should be false', () => {
+      const check = new SimilarityCacheEntry(0);
+      check.setCacheEntry(
+        'The index is known by several other names, especially Sørensen–Dice index,[3] Sørensen index and Dice\'s coefficient. Other variations include the "similarity coefficient" or "index", such as Dice similarity coefficient (DSC). Common alternate spellings for Sørensen are Sorenson, Soerenson and Sörenson, and all three can also be seen with the –sen ending.'
+      );
+      check.setCacheEntry(
+        'where |X| and |Y| are the cardinalities of the two sets (i.e. the number of elements in each set). The Sørensen index equals twice the number of elements common to both sets divided by the sum of the number of elements in each set.'
+      );
+    });
+  });
+});

ui/src/App.js

@@ -2,6 +2,7 @@ import React, { useEffect } from 'react';
 
 import InsufficientPermission from './components/permission/InsufficientPermission';
 import PermissionAwareRoute from './components/permission/PermissionAwareRoute';
+import GeneralSettings from './views/generalSettings/GeneralSettings';
 import ToastsContainer from './components/toasts/ToastContainer';
 import JobMutation from './views/jobs/mutation/JobMutation';
 import UserMutator from './views/user/mutation/UserMutator';
@@ -78,6 +79,12 @@ export default function FredyApp() {
               currentUser={currentUser}
             />
             <PermissionAwareRoute name="Users" path="/users" component={<Users />} currentUser={currentUser} />
+            <PermissionAwareRoute
+              name="General Settings"
+              path="/generalSettings"
+              component={<GeneralSettings />}
+              currentUser={currentUser}
+            />
 
             <Redirect from="/" to={'/jobs'} />
           </Switch>

ui/src/components/menu/Menu.js

@@ -1,6 +1,6 @@
 import React from 'react';
 import { useHistory } from 'react-router-dom';
-import { Menu } from 'semantic-ui-react';
+import { Icon, Menu } from 'semantic-ui-react';
 
 import './Menu.less';
 import { useLocation } from 'react-router';
@@ -19,7 +19,7 @@ const TopMenu = function TopMenu({ isAdmin }) {
         className={isActiveRoute('jobs') ? 'topMenu__active' : 'topMenu__item'}
         onClick={() => history.push('/jobs')}
       >
-        Job Configuration
+        <Icon name="search" /> Job Configuration
       </Menu.Item>
 
       {isAdmin && (
@@ -29,7 +29,18 @@ const TopMenu = function TopMenu({ isAdmin }) {
           className={isActiveRoute('users') ? 'topMenu__active' : 'topMenu__item'}
           onClick={() => history.push('/users')}
         >
-          User configuration
+          <Icon name="user" /> User configuration
+        </Menu.Item>
+      )}
+
+      {isAdmin && (
+        <Menu.Item
+          name="general"
+          active={isActiveRoute('general')}
+          className={isActiveRoute('general') ? 'topMenu__active' : 'topMenu__item'}
+          onClick={() => history.push('/generalSettings')}
+        >
+          <Icon name="cog" /> General Settings
         </Menu.Item>
       )}
     </Menu>

ui/src/services/rematch/models/generalSettings.js

@@ -0,0 +1,26 @@
+import { xhrGet } from '../../xhr';
+
+export const generalSettings = {
+  state: {
+    settings: {},
+  },
+  reducers: {
+    //only admins
+    setGeneralSettings: (state, payload) => {
+      return {
+        ...state,
+        settings: payload,
+      };
+    },
+  },
+  effects: {
+    async getGeneralSettings() {
+      try {
+        const response = await xhrGet('/api/admin/generalSettings');
+        this.setGeneralSettings(response.json);
+      } catch (Exception) {
+        console.error('Error while trying to get resource for api/admin/generalSettings. Error:', Exception);
+      }
+    },
+  },
+};

ui/src/services/rematch/store.js

@@ -1,4 +1,5 @@
 import { notificationAdapter } from './models/notificationAdapter';
+import { generalSettings } from './models/generalSettings';
 import createLoadingPlugin from '@rematch/loading';
 import { provider } from './models/provider';
 import { createLogger } from 'redux-logger';
@@ -17,6 +18,7 @@ const store = init({
   name: 'fredy',
   models: {
     notificationAdapter,
+    generalSettings,
     provider,
     jobs,
     user,

ui/src/views/generalSettings/GeneralSettings.js

@@ -0,0 +1,211 @@
+import React from 'react';
+
+import { useDispatch, useSelector } from 'react-redux';
+
+import { Button, Form, Header, Icon, Message, Popup, Segment } from 'semantic-ui-react';
+import ToastContext from '../../components/toasts/ToastContext';
+import Headline from '../../components/headline/Headline';
+import { xhrPost } from '../../services/xhr';
+
+import './GeneralSettings.less';
+
+const SegmentPart = ({ name, icon, children, helpText }) => (
+  <React.Fragment>
+    <Header as="h5" inverted attached="top" sub>
+      <Icon name={icon} inverted size="mini" />
+      <Header.Content>{name}</Header.Content>
+    </Header>
+
+    <Popup
+      content={helpText}
+      trigger={
+        <span className="generalSettings__help">
+          {' '}
+          <Icon name="help circle" inverted />
+          What is this?
+        </span>
+      }
+    />
+    <Segment inverted attached>
+      {children}
+    </Segment>
+  </React.Fragment>
+);
+
+const GeneralSettings = function Users() {
+  const dispatch = useDispatch();
+  const [loading, setLoading] = React.useState(true);
+
+  const settings = useSelector((state) => state.generalSettings.settings);
+
+  const [interval, setInterval] = React.useState('');
+  const [port, setPort] = React.useState('');
+  const [scrapingAntApiKey, setScrapingAntApiKey] = React.useState('');
+  const [workingHourFrom, setWorkingHourFrom] = React.useState(null);
+  const [workingHourTo, setWorkingHourTo] = React.useState(null);
+  const ctx = React.useContext(ToastContext);
+
+  React.useEffect(async () => {
+    await dispatch.generalSettings.getGeneralSettings();
+    setLoading(false);
+  }, []);
+
+  React.useEffect(async () => {
+    setInterval(settings?.interval);
+    setPort(settings?.port);
+    setScrapingAntApiKey(settings?.scrapingAnt?.apiKey);
+    setWorkingHourFrom(settings?.workingHours?.from);
+    setWorkingHourTo(settings?.workingHours?.to);
+  }, [settings]);
+
+  const nullOrEmpty = (val) => val == null || val.length === 0;
+
+  const throwMessage = (message, type) => {
+    ctx.showToast({
+      title: type === 'error' ? 'Error' : 'Success',
+      message: message,
+      delay: 5000,
+      backgroundColor: type === 'error' ? '#db2828' : '#87eb8f',
+      color: type === 'error' ? '#fff' : '#000',
+    });
+  };
+
+  const onStore = async () => {
+    if (nullOrEmpty(interval)) {
+      throwMessage('Interval may not be empty.', 'error');
+      return;
+    }
+    if (nullOrEmpty(port)) {
+      throwMessage('Port may not be empty.', 'error');
+      return;
+    }
+    if (
+      (!nullOrEmpty(workingHourFrom) && nullOrEmpty(workingHourTo)) ||
+      (nullOrEmpty(workingHourFrom) && !nullOrEmpty(workingHourTo))
+    ) {
+      throwMessage('Working hours to and from must be set if either to or from has been set before.', 'error');
+      return;
+    }
+    try {
+      await xhrPost('/api/admin/generalSettings', {
+        interval,
+        port,
+        scrapingAnt: {
+          apiKey: scrapingAntApiKey,
+        },
+        workingHours: {
+          from: workingHourFrom,
+          to: workingHourTo,
+        },
+      });
+    } catch (exception) {
+      console.error(exception);
+      throwMessage('Error while trying to store settings.', 'error');
+      return;
+    }
+    throwMessage('Settings stored successfully. You MUST restart Fredy.', 'success');
+  };
+
+  return (
+    <div>
+      {!loading && (
+        <React.Fragment>
+          <Headline text="General Settings" />
+          <Message info>
+            <h5>
+              <Icon name="info circle" />
+              Info
+            </h5>
+            <p>If you change any settings, you must restart Fredy afterwards.</p>
+          </Message>
+          <Form>
+            <SegmentPart
+              name="Interval"
+              helpText="Interval in minutes for running queries against the configured services."
+              icon="refresh"
+            >
+              <Form.Input
+                type="number"
+                min="0"
+                max="1440"
+                placeholder="Interval in minutes"
+                inverted
+                size="mini"
+                width={6}
+                defaultValue={interval}
+                onChange={(e) => setInterval(e.target.value)}
+              />
+            </SegmentPart>
+
+            <SegmentPart name="Port" helpText="Port on which Fredy is running." icon="connectdevelop">
+              <Form.Input
+                type="number"
+                min="0"
+                max="99999"
+                placeholder="Port"
+                inverted
+                size="mini"
+                width={6}
+                defaultValue={port}
+                onChange={(e) => setPort(e.target.value)}
+              />
+            </SegmentPart>
+
+            <SegmentPart
+              name="ScrapingAnt Api Key"
+              helpText="The api key for ScrapingAnt is used to be able to scrape Immoscout."
+              icon="key"
+            >
+              <Form.Input
+                type="text"
+                placeholder="ScrapingAnt Api Key"
+                inverted
+                size="mini"
+                width={6}
+                defaultValue={scrapingAntApiKey}
+                onChange={(e) => setScrapingAntApiKey(e.target.value)}
+              />
+            </SegmentPart>
+
+            <SegmentPart
+              name="Working hours"
+              helpText="During this hours, Fredy will search for new apartments. If nothing is configured, Fredy will search around the clock."
+              icon="calendar outline"
+            >
+              <div className="generalSettings__timePickerContainer">
+                <Form.Input
+                  className="generalSettings__time"
+                  type="time"
+                  placeholder="ScrapingAnt Api Key"
+                  inverted
+                  size="mini"
+                  width={2}
+                  defaultValue={workingHourFrom}
+                  onChange={(e) => setWorkingHourFrom(e.target.value)}
+                />
+                <div className="generalSettings__until">until</div>
+                <Form.Input
+                  type="time"
+                  placeholder="ScrapingAnt Api Key"
+                  inverted
+                  size="mini"
+                  width={2}
+                  defaultValue={workingHourTo}
+                  onChange={(e) => setWorkingHourTo(e.target.value)}
+                />
+              </div>
+            </SegmentPart>
+
+            <Segment inverted floated="right">
+              <Button color="teal" onClick={onStore}>
+                Save
+              </Button>
+            </Segment>
+          </Form>
+        </React.Fragment>
+      )}
+    </div>
+  );
+};
+
+export default GeneralSettings;

ui/src/views/generalSettings/GeneralSettings.less

@@ -0,0 +1,17 @@
+.generalSettings {
+  &__timePickerContainer {
+    display: flex;
+    align-items: baseline;
+  }
+
+  &__until {
+    margin-left: 1rem;
+    margin-right: 1rem;
+  }
+
+  &__help{
+    font-size: 11px;
+    margin-left: 1rem;
+  }
+
+}

ui/src/views/login/Login.js

@@ -40,9 +40,8 @@ export default function Login() {
 
   return (
     <div className="login">
+      <div className="login__bgImage" style={{ background: `url("${cityBackground}")` }} />
       <Logo />
-      <div className="login__bgImage" style={{ background: `url(${cityBackground})` }} />
-
       <form>
         <div className="login__loginWrapper">
           {error && <Message negative icon="error" content={error} />}

ui/src/views/login/login.less

@@ -2,18 +2,17 @@
   display: flex;
   justify-content: center;
   align-items: center;
-  width:100%;
+  width: 100%;
   height: 100%;
 
   &__bgImage {
     background-size: cover;
     filter: blur(8px);
     -webkit-filter: blur(8px);
-    background-size: cover;
     position: absolute;
     top: 0;
     left: 0;
-    z-index: -1;
+    z-index: 0;
     right: 0;
     bottom: 0;
   }
@@ -23,9 +22,14 @@
     border-radius: 30px;
     height: 25rem;
     width: 30rem;
+    z-index: 1;
     background-color: #151313ab;
     display: flex;
     flex-direction: column;
     padding: 2rem;
   }
+
+  form {
+    z-index: 1;
+  }
 }