Merge branch 'master' of github.com:orangecoding/fredy

* new chart system

.babelrc

@@ -3,9 +3,7 @@
     [
       "@babel/preset-env",
       {
-        "exclude": [
+        "exclude": ["transform-regenerator"]
-          "transform-regenerator"
-        ]
       }
     ],
     [
@@ -15,4 +13,4 @@
       }
     ]
   ]
-}
+}

.dockerignore

@@ -2,5 +2,6 @@ node_modules/
 npm-debug.log
 test/
 db/
+conf/
 .git/
 .github/

.eslintrc.cjs

@@ -1,282 +0,0 @@
-module.exports = {
-  env: {
-    es2021: true,
-    node: true,
-    browser: true,
-    mocha: true,
-  },
-  parser: '@babel/eslint-parser',
-  extends: ['eslint:recommended', 'prettier'],
-  plugins: ['react'],
-  globals: {
-    Promise: false,
-    describe: true,
-    after: true,
-    it: true,
-    fetch: true,
-  },
-  parserOptions: {
-    sourceType: 'module',
-  },
-  rules: {
-    eqeqeq: [2, 'allow-null'],
-
-    // ###########################################################
-    // ### Semantics / Performance impacting
-    // ###########################################################
-    // babel inserts `'use strict';` for us
-    strict: 0,
-
-    'no-redeclare': [2, { builtinGlobals: false }],
-
-    // If a class method does not use this, it can safely be made a static function.
-    // http://eslint.org/docs/rules/class-methods-use-this
-    'class-methods-use-this': ['off'],
-
-    // ###########################################################
-    // ### Style
-    // ###########################################################
-    indent: ['off', 2],
-    'linebreak-style': ['error', 'unix'],
-    quotes: ['error', 'single', { avoidEscape: true, allowTemplateLiterals: true }],
-    semi: ['error', 'always'],
-    'no-console': ['error', { allow: ['warn', 'error'] }],
-
-    // ###########################################################
-    // ### React
-    // ###########################################################
-    // Specify whether double or single quotes should be used in JSX attributes
-    // http://eslint.org/docs/rules/jsx-quotes
-    'jsx-quotes': ['error', 'prefer-double'],
-
-    // Prevent missing displayName in a React component definition
-    // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/display-name.md
-    'react/display-name': ['off'],
-
-    // Forbid certain propTypes (any, array, object)
-    // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/forbid-prop-types.md
-    'react/forbid-prop-types': 'off',
-
-    // Validate closing bracket location in JSX
-    // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-closing-bracket-location.md
-    'react/jsx-closing-bracket-location': ['off'],
-
-    // Enforce or disallow spaces inside of curly braces in JSX attributes
-    // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-curly-spacing.md
-    'react/jsx-curly-spacing': ['off'],
-
-    // Enforce event handler naming conventions in JSX
-    // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-handler-names.md
-    'react/jsx-handler-names': [
-      'off',
-      {
-        eventHandlerPrefix: 'handle',
-        eventHandlerPropPrefix: 'on',
-      },
-    ],
-
-    // Validate props indentation in JSX
-    // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-indent-props.md
-    'react/jsx-indent-props': 'off',
-
-    // Validate JSX has key prop when in array or iterator
-    // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-key.md
-    'react/jsx-key': 'off',
-
-    // Limit maximum of props on a single line in JSX
-    // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-max-props-per-line.md
-    'react/jsx-max-props-per-line': ['off'],
-
-    // Prevent usage of .bind() in JSX props
-    // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-no-bind.md
-    'react/jsx-no-bind': [
-      'error',
-      {
-        ignoreRefs: true,
-        allowArrowFunctions: true,
-        allowBind: false,
-      },
-    ],
-
-    // Prevent duplicate props in JSX
-    // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-no-duplicate-props.md
-    'react/jsx-no-duplicate-props': ['error', { ignoreCase: true }],
-
-    // Prevent usage of unwrapped JSX strings
-    // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-no-literals.md
-    'react/jsx-no-literals': 'off',
-
-    // Disallow undeclared variables in JSX
-    // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-no-undef.md
-    'react/jsx-no-undef': 'error',
-
-    // Enforce PascalCase for user-defined JSX components
-    // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-pascal-case.md
-    'react/jsx-pascal-case': [
-      'error',
-      {
-        allowAllCaps: true,
-        ignore: [],
-      },
-    ],
-
-    // Enforce propTypes declarations alphabetical sorting
-    // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/sort-prop-types.md
-    'react/sort-prop-types': [
-      'off',
-      {
-        ignoreCase: true,
-        callbacksLast: false,
-        requiredFirst: false,
-      },
-    ],
-
-    // Deprecated in favor of react/jsx-sort-props
-    'react/jsx-sort-prop-types': 'off',
-
-    // Enforce props alphabetical sorting
-    // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-sort-props.md
-    'react/jsx-sort-props': 'off',
-
-    // Prevent React to be incorrectly marked as unused
-    // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-uses-react.md
-    'react/jsx-uses-react': 'error',
-
-    // Prevent variables used in JSX to be incorrectly marked as unused
-    // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-uses-vars.md
-    'react/jsx-uses-vars': 'error',
-
-    // Prevent usage of dangerous JSX properties
-    // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-danger.md
-    'react/no-danger': 'warn',
-
-    // Prevent usage of deprecated methods
-    // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-deprecated.md
-    'react/no-deprecated': ['error'],
-
-    // Prevent usage of setState in componentDidMount
-    // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-did-mount-set-state.md
-    'react/no-did-mount-set-state': ['error'],
-
-    // Prevent usage of setState in componentDidUpdate
-    // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-did-update-set-state.md
-    'react/no-did-update-set-state': ['warn'],
-
-    // Prevent direct mutation of this.state
-    // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-direct-mutation-state.md
-    'react/no-direct-mutation-state': 'off',
-
-    // Prevent usage of isMounted
-    // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-is-mounted.md
-    'react/no-is-mounted': 'error',
-
-    // Prevent usage of setState
-    // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-set-state.md
-    'react/no-set-state': 'off',
-
-    // Prevent using string references
-    // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-string-refs.md
-    'react/no-string-refs': 'warn',
-
-    // Prevent usage of unknown DOM property
-    // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-unknown-property.md
-    'react/no-unknown-property': 'error',
-
-    // Prevent missing props validation in a React component definition
-    // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/prop-types.md
-    'react/prop-types': ['error', { ignore: [], customValidators: [], skipUndeclared: true }],
-
-    // Prevent missing React when using JSX
-    // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/react-in-jsx-scope.md
-    'react/react-in-jsx-scope': 'error',
-
-    // Restrict file extensions that may be required
-    // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/require-extension.md
-    // deprecated in favor of import/extensions
-    'react/require-extension': ['off', { extensions: ['.jsx', '.js'] }],
-
-    // Require render() methods to return something
-    // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/require-render-return.md
-    'react/require-render-return': 'error',
-
-    // Prevent extra closing tags for components without children
-    // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/self-closing-comp.md
-    'react/self-closing-comp': 'warn',
-
-    // Enforce component methods order
-    // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/sort-comp.md
-    'react/sort-comp': 'off',
-
-    // Prevent missing parentheses around multilines JSX
-    // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-wrap-multilines.md
-    'react/jsx-wrap-multilines': [
-      'warn',
-      {
-        declaration: true,
-        assignment: true,
-        return: true,
-      },
-    ],
-    'react/wrap-multilines': 'off', // deprecated version
-
-    // Require that the first prop in a JSX element be on a new line when the element is multiline
-    // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-first-prop-new-line.md
-    'react/jsx-first-prop-new-line': ['off'],
-
-    // Enforce spacing around jsx equals signs
-    // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-equals-spacing.md
-    'react/jsx-equals-spacing': ['warn', 'never'],
-
-    // Disallow target="_blank" on links
-    // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-no-target-blank.md
-    'react/jsx-no-target-blank': 'error',
-
-    // only .jsx files may have JSX
-    // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-filename-extension.md
-    'react/jsx-filename-extension': ['error', { extensions: ['.jsx'] }],
-
-    // prevent accidental JS comments from being injected into JSX as text
-    // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-no-comment-textnodes.md
-    'react/jsx-no-comment-textnodes': 'error',
-    'react/no-comment-textnodes': 'off', // deprecated version
-
-    // disallow using React.render/ReactDOM.render's return value
-    // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-render-return-value.md
-    'react/no-render-return-value': 'error',
-
-    // require a shouldComponentUpdate method, or PureRenderMixin
-    // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/require-optimization.md
-    'react/require-optimization': ['off', { allowDecorators: [] }],
-
-    // warn against using findDOMNode()
-    // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-find-dom-node.md
-    'react/no-find-dom-node': 'warn',
-
-    // Forbid certain props on Components
-    // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/forbid-component-props.md
-    'react/forbid-component-props': ['off', { forbid: [] }],
-
-    // Prevent problem with children and props.dangerouslySetInnerHTML
-    // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-danger-with-children.md
-    'react/no-danger-with-children': 'error',
-
-    // Prevent unused propType definitions
-    // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-unused-prop-types.md
-    'react/no-unused-prop-types': [
-      'warn',
-      {
-        customValidators: [],
-        skipShapeProps: true,
-      },
-    ],
-
-    // Require style prop value be an object or var
-    // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/style-prop-object.md
-    'react/style-prop-object': 'error',
-
-    // Prevent passing of children as props
-    // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-children-prop.md
-    'react/no-children-prop': 'warn',
-
-  },
-};

.github/ISSUE_TEMPLATE/bug.yml

@@ -0,0 +1,73 @@
+name: Bug Report
+description: Help us improve Fredy by reporting a bug
+title: "[Bug]: "
+labels: [bug]
+assignees: []
+
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: Bug Description
+      description: Provide a clear and concise description of the bug.
+      placeholder: e.g. "Fredy crashes when I click on Save."
+    validations:
+      required: true
+
+  - type: textarea
+    id: steps
+    attributes:
+      label: Steps to Reproduce
+      description: List the steps to reproduce the issue.
+      placeholder: |
+        1. Go to '...'
+        2. Click on '...'
+        3. Scroll down to '...'
+        4. See error
+    validations:
+      required: true
+
+  - type: textarea
+    id: expected
+    attributes:
+      label: Expected Behavior
+      description: What did you expect to happen?
+      placeholder: "It should save without errors."
+    validations:
+      required: true
+
+  - type: textarea
+    id: actual
+    attributes:
+      label: Actual Behavior
+      description: What actually happened?
+      placeholder: "Fredy crashed with error XYZ."
+    validations:
+      required: true
+
+  - type: textarea
+    id: screenshots
+    attributes:
+      label: Screenshots / Logs
+      description: Add screenshots or paste log output to help explain the problem.
+      placeholder: "Drag and drop screenshots here, or paste logs."
+    validations:
+      required: false
+
+  - type: input
+    id: environment
+    attributes:
+      label: Environment
+      description: Provide details about your environment.
+      placeholder: "OS: macOS 15, Browser: Chrome 124, App version: 1.2.3"
+    validations:
+      required: true
+
+  - type: textarea
+    id: context
+    attributes:
+      label: Additional Context
+      description: Add any other context about the problem here.
+      placeholder: "Any other information that might help..."
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,24 +0,0 @@
----
-name: Bug report
-about: Create a report to help us improve
-title: ''
-labels: ''
-assignees: ''
-
----
-
-**Describe the bug**
-A clear and concise description of what the bug is.
-
-**To Reproduce**
-Steps to reproduce the behavior:
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error
-
-**Expected behavior**
-A clear and concise description of what you expected to happen.
-
-**Screenshots**
-If applicable, add screenshots to help explain your problem.

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: false

.github/ISSUE_TEMPLATE/feature.yml

@@ -0,0 +1,51 @@
+name: Feature Request
+description: Suggest an improvement or new idea for Fredy
+title: "[Feature]: "
+labels: [enhancement]
+assignees: []
+
+body:
+  - type: textarea
+    id: problem
+    attributes:
+      label: Related Problem
+      description: Is your feature request related to a problem? Describe it clearly.
+      placeholder: "Example: It’s difficult to do X when Y happens..."
+    validations:
+      required: false
+
+  - type: textarea
+    id: solution
+    attributes:
+      label: Proposed Feature
+      description: Describe the feature you would like to see.
+      placeholder: "I would like Fredy to automatically..."
+    validations:
+      required: true
+
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Alternatives Considered
+      description: List any alternative solutions or workarounds you’ve tried or thought about.
+      placeholder: "Instead of this, I also considered..."
+    validations:
+      required: false
+
+  - type: textarea
+    id: benefits
+    attributes:
+      label: Benefits
+      description: Explain how this feature would improve Fredy or it's user experience.
+      placeholder: "This would save users time by..."
+    validations:
+      required: true
+
+  - type: textarea
+    id: context
+    attributes:
+      label: Additional Context
+      description: Add any other context, examples, or screenshots that might help clarify your idea.
+      placeholder: "Any other relevant information..."
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,20 +0,0 @@
----
-name: Feature request
-about: Suggest an idea for this project
-title: ''
-labels: ''
-assignees: ''
-
----
-
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
-
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
-
-**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
-
-**Additional context**
-Add any other context or screenshots about the feature request here.

.github/workflows/check_source.yml

@@ -0,0 +1,26 @@
+name: Check the source code
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+jobs:
+  check_source_code:
+    name: Check the source code
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: 'yarn'
+
+      - name: Install dependencies
+        run: yarn install
+
+      - name: Check formatting
+        run: yarn format:check
+
+      - name: Lint
+        run: yarn lint

.github/workflows/stales.yml

@@ -1,8 +1,8 @@
-name: "Close stale issues and PRs"
+name: Close stale issues and PRs
 
 on:
   schedule:
-    - cron: '0 0 * * *'  # Daily
+    - cron: '0 0 * * *' # Daily
 
 jobs:
   stale:
@@ -12,10 +12,10 @@ jobs:
         with:
           days-before-stale: 30
           days-before-close: 7
-          stale-issue-message: "This issue has been automatically marked as stale due to inactivity."
+          stale-issue-message: 'This issue has been automatically marked as stale due to inactivity.'
-          stale-pr-message: "This PR has been automatically marked as stale due to inactivity."
+          stale-pr-message: 'This PR has been automatically marked as stale due to inactivity.'
-          close-issue-message: "Closing this issue due to prolonged inactivity."
+          close-issue-message: 'Closing this issue due to prolonged inactivity.'
-          close-pr-message: "Closing this PR due to prolonged inactivity."
+          close-pr-message: 'Closing this PR due to prolonged inactivity.'
-          exempt-issue-labels: "keep-open"
+          exempt-issue-labels: 'keep-open'
-          exempt-pr-labels: "keep-open"
+          exempt-pr-labels: 'keep-open'
-          only: "pulls"
+          only: 'pulls'

.github/workflows/test.yml

@@ -13,8 +13,7 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
-      - name: Setup Node.js
+      - uses: actions/setup-node@v4
-        uses: actions/setup-node@v4
         with:
           node-version: 20
           cache: 'yarn'

.prettierignore

@@ -0,0 +1,6 @@
+/ui/public
+/db/
+/conf/
+
+# TODO re-write from scratch or fix all html structure issues
+/lib/notification/emailTemplate/template.hbs

.prettierrc

@@ -0,0 +1,4 @@
+{
+  "singleQuote": true,
+  "printWidth": 120
+}

CHANGELOG.md

@@ -1,34 +1,42 @@
 Newer release changelog see https://github.com/orangecoding/fredy/releases
 
-------------
+---
 
 ###### [V5.5.0]
+
 - Upgrading dependencies
 - fixing provider
-- allow multiple instances of 1 provider  
+- allow multiple instances of 1 provider
-- __BREAKING__: Minimum node version is now 16
+- **BREAKING**: Minimum node version is now 16
 
 ###### [V5.4.6]
+
 - Adding Instana node.js monitoring
-- 
+-
+
 ###### [V5.4.5]
-- Adding Instana node.js monitoring 
+
+- Adding Instana node.js monitoring
 
 ###### [V5.4.4]
+
 - Add support for Immo Südwest Presse (immo.swp.de)
 - Telegram: Use job name instead of ID and link in title
 - Fix race condition if user ID is in session but not in user store
 - Allow visiting the original provider URL
 
 ###### [V5.4.3]
+
 - re-writing readme
 - improving docker build
 - using github's actions to build docker and test automatically
 
 ###### [V5.4.2]
+
 - Fixing prod build
 
 ###### [V5.4.1]
+
 - Upgrading dependencies
 - Provider urls are now automagically been changed to include the correct sort order for search results
 
@@ -39,36 +47,44 @@ results, thus cannot report them. This release fixes it by adding the necessary
 ```
 
 ###### [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
 
 ###### [V4.0.0]
+
 Bringing back Immoscout :tada:
 
 ###### [V3.0.0]
+
 This is basically a re-write, your old config file will not be compatible anymore. Please re-created your search jobs
 on the new ui and use the values from your previous config file if needed.
+
 ```
 - We're getting rid of manual config changes, Fredy, now ships with a UI so that it's easy for you to create and edit jobs
 ```
 
 ###### [V2.0.0]
+
 ```
 - Fredy can now run multiple search job on one instance
 - Changed lot's of the structure of Fredy to make this happen

CONTRIBUTING.md

@@ -2,8 +2,8 @@
 
 If you want to contribute, please make sure you've executed the tests.
 
-
 ### How to write new provider?
+
 - create the provider filer under `/lib/provider`
 - create a test under /test and make sure it is running successfully
 
@@ -13,7 +13,7 @@ let appliedBlackList = [];
 //normalize incoming values
 function normalize(o) {
   const id = parseInt(o.id.substring(o.id.indexOf('_') + 1, o.id.length));
-  
+
   return Object.assign(o, { id });
 }
 
@@ -27,7 +27,7 @@ function applyBlacklist(o) {
 
 const config = {
   url: null,
-    //this is the container wrapping the search listings
+  //this is the container wrapping the search listings
   crawlContainer: '#result-list-stage .item',
   crawlFields: {
     id: '@id',
@@ -49,7 +49,7 @@ exports.init = (sourceConfig, blacklist) => {
   appliedBlackList = blacklist || [];
 };
 
-//ths 
+//ths
 exports.metaInformation = {
   name: 'your provider name',
   baseUrl: 'https://www.yourprovider.de/',
@@ -57,11 +57,10 @@ exports.metaInformation = {
 };
 
 exports.config = config;
-
 ```
- 
 
 ### How to write new notification adapter?
+
 - create the provider filer under `/lib/notification/adapter`
 - create a description of the provider under `/lib/notification/adapter/*.md`. Make sure the name of the md file is equal to the notification adapter
 
@@ -72,48 +71,48 @@ const Slack = require('slack');
 const msg = Slack.chat.postMessage;
 const { markdown2Html } = require('../../services/markdown');
 
-
 //as a parameter, you will always get the serviceName, newListings and all the values, that
 //you have defined exports.config.fields. (This is being used for rendering in the frontend)
 exports.send = ({ serviceName, newListings, notificationConfig, jobKey }) => {
-    const { token, channel } = notificationConfig.find((adapter) => adapter.id === 'slack').fields;
+  const { token, channel } = notificationConfig.find((adapter) => adapter.id === 'slack').fields;
-    return newListings.map((payload) => {
+  return newListings.map((payload) => {
-        //tho whatever needs to be done to send the data to the receiver, make sure the format is human readable
+    //tho whatever needs to be done to send the data to the receiver, make sure the format is human readable
-    });
+  });
 };
 
 exports.config = {
-    id: __filename.slice(__dirname.length + 1, -3),
+  id: __filename.slice(__dirname.length + 1, -3),
-    name: 'someUniqueName, used in the frontend',
+  name: 'someUniqueName, used in the frontend',
-    //this readme is rendered in the frontend to explain how to use this
+  //this readme is rendered in the frontend to explain how to use this
-    readme: markdown2Html('lib/notification/adapter/slack.md'),
+  readme: markdown2Html('lib/notification/adapter/slack.md'),
-    description: 'Some description text rendered on the notification page',
+  description: 'Some description text rendered on the notification page',
-    fields: {
+  fields: {
-        token: {
+    token: {
-            //type can be text/number/boolean
+      //type can be text/number/boolean
-            type: 'text',
+      type: 'text',
-            label: 'Token',
+      label: 'Token',
-            description: 'The token needed to send notifications to slack.',
+      description: 'The token needed to send notifications to slack.',
-        },
-        channel: {
-            type: 'channel',
-            label: 'Channel',
-            description: 'The channel where fredy should send notifications to.',
-        },
     },
+    channel: {
+      type: 'channel',
+      label: 'Channel',
+      description: 'The channel where fredy should send notifications to.',
+    },
+  },
 };
-
 ```
 
 #### Running Tests
-If you've written a new provider you are an awesome person. If you now write tests for it, you are even more awesome. And who doesn't want to be more awesome right?
+
+If you've written a new provider you are an awesome person. If you now write tests for it, you are even more awesome. And who doesn't want to be more awesome, right?
 
 #### Codestyle
-I'm using Eslint to maintain quote style and quality. Do not skip it...
 
-##### To do before merging:
+I'm using ESLint to maintain quote style and quality. Do not skip it...
 
-- executed tests? (`pnpm test`)
+##### To-do before merging:
-- sure the changes are useful for everybody? Or is it maybe a custom modification just for your case?
+
+- Have you executed the tests? (`yarn test`)
+- Are you sure the changes are useful for everybody? Or is it maybe a custom modification just for your case?
 
 _Thanks!_ :heart:

Dockerfile

@@ -11,16 +11,16 @@ ENV PUPPETEER_SKIP_CHROMIUM_DOWNLOAD=true \
     PUPPETEER_EXECUTABLE_PATH=/usr/bin/chromium
 
 # Copy lockfiles first to leverage cache for dependencies
-COPY package.json yarn.lock ./
+COPY package.json yarn.lock .
 
 # Set Yarn timeout, install dependencies and PM2 globally
 RUN yarn config set network-timeout 600000 \
-  && yarn install --frozen-lockfile \
+  && yarn --frozen-lockfile \
   && yarn global add pm2
 
 # Copy application source and build production assets
-COPY . ./
+COPY . .
-RUN yarn run prod
+RUN yarn build:frontend
 
 # Prepare runtime directories and symlinks for data and config
 RUN mkdir -p /db /conf \

README.md

@@ -1,131 +1,227 @@
-<img src="https://github.com/orangecoding/fredy/blob/master/doc/logo.png" width="400">  
-
-![Build Status](https://github.com/orangecoding/fredy/actions/workflows/test.yml/badge.svg)  [![Create and publish Docker image](https://github.com/orangecoding/fredy/actions/workflows/docker.yml/badge.svg)](https://github.com/orangecoding/fredy/actions/workflows/docker.yml)
-
-Searching an apartment in Germany can be a frustrating task. Not any longer though, as _Fredy_ will take over and will only notify you once new listings have been found that match your requirements.
-
-_Fredy_ scrapes multiple services (Immonet, Immowelt etc.) and send new listings to you once they become available. The list of available services can easily be extended. For your convenience, _Fredy_ has a UI to help you configure your search jobs.   
-
-If _Fredy_ finds matching results, it will send them to you via Slack, Email, Telegram etc. (More adapters can be configured.) As _Fredy_ stores the listings it has found, new results will not be sent to you 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 twice or more when posted on various platforms (which happens more often than one might think).
-
-<a href="https://www.producthunt.com/posts/fredy-find-real-estates-damn-easy?embed=true&utm_source=badge-featured&utm_medium=badge&utm_source=badge-fredy&#0045;find&#0045;real&#0045;estates&#0045;damn&#0045;easy" target="_blank"><img src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=965690&theme=light&t=1747292331626" alt="Fredy&#0032;&#0045;&#0032;Find&#0032;Real&#0032;Estates&#0032;Damn&#0032;EasY&#0032; - Your&#0032;personal&#0032;real&#0032;estate&#0032;search&#0032;bot | Product Hunt" style="width: 250px; height: 54px;" width="250" height="54" /></a>
-
-# Sponsorship [![](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub&color=%23fe8e86)](https://github.com/sponsors/orangecoding)    
-If you like my work, consider becoming a sponsor. I'm not expecting anybody to pay for _Fredy_ or any other Open Source Project I'm maintaining, however keep in mind, I'm doing all of this in my spare time :) Thanks.
-
-[![JetBrains logo.](https://resources.jetbrains.com/storage/products/company/brand/logos/jetbrains.svg)](https://jb.gg/OpenSourceSupport)
-
-_Fredy_ is supported by JetBrains under Open Source Support Program
-
-## Demo
-If you want to try out _Fredy_, you can access the demo version [here](https://fredy.orange-coding.net) 🤘
-
-## Usage  
-
-- Make sure to use Node.js 20 or above
-- Run the following commands:
-```ssh
-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 your browser at `http://localhost:9998`. The default login is `admin`, both for username and password. You should change the password as soon as possible when you plan to run Fredy on a server.
-
 <p align="center">
-  <img alt="Job Configuration" src="https://github.com/orangecoding/fredy/blob/master/doc/screenshot1.png" width="30%">
+
-&nbsp; &nbsp; &nbsp; &nbsp;
+<a href="https://fredy.orange-coding.net/">
-  <img alt="Job Analytics" src="https://github.com/orangecoding/fredy/blob/master/doc/screenshot_2.png" width="30%">
+<picture>
-&nbsp; &nbsp; &nbsp; &nbsp;  
+  <source media="(prefers-color-scheme: dark)" srcset="https://github.com/orangecoding/fredy/blob/master/doc/logo_white.png" width="400">
-  <img alt="Job Overview" width="30%" src="https://github.com/orangecoding/fredy/blob/master/doc/screenshot_3.png">
+  <source media="(prefers-color-scheme: light)" srcset="https://github.com/orangecoding/fredy/blob/master/doc/logo.png" width="400">
+  <img alt="Jetbrains Open Source" src="https://github.com/orangecoding/fredy/blob/master/doc/logo.png">
+</picture>
+</a>
 </p>
 
-## Understanding the fundamentals
+![Tests](https://github.com/orangecoding/fredy/actions/workflows/test.yml/badge.svg)
-There are 3 important parts in Fredy, that you need to understand to leverage the full power of _Fredy_.
+[![Docker](https://github.com/orangecoding/fredy/actions/workflows/docker.yml/badge.svg)](https://github.com/orangecoding/fredy/actions/workflows/docker.yml)
+![Source](https://github.com/orangecoding/fredy/actions/workflows/check_source.yml/badge.svg)
+![Docker Pulls](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fghcr-badge.elias.eu.org%2Fapi%2Forangecoding%2Ffredy%2Ffredy&query=%24.downloadCount&label=Docker%20Pulls)
 
-#### Provider
-_Fredy_ supports multiple services. Immonet, Immowelt and Ebay are just a few examples. Those services are called providers within _Fredy_. When creating a new job, you can choose one or more providers.
-A provider contains the URL that points to the search results for the respective service. If you go to immonet.de and search for something, the displayed URL in the browser is what the provider needs to do its magic.
-**It is important that you order the search results by date, so that _Fredy_ always picks the latest results first!**
 
-#### Adapter
+# Fredy 🏡 – Your Self-Hosted Real Estate Finder for Germany
-_Fredy_ supports multiple adapters, such as Slack, SendGrid, Telegram etc. A search job can have as many adapters as supported by _Fredy_. Each adapter needs different configuration values, which you have to provide when using them. A adapter dictactes how the frontend renders by telling the frontend what information it needs in order to send listings to the user.
 
-#### Jobs
+Finding an apartment or house in Germany can be stressful and
-A Job wraps adapters and providers. _Fredy_ runs the configured jobs in a specific interval (can be configured in `/conf/config.json`).
+time-consuming.\
+**Fredy** makes it easier: it automatically scrapes **ImmoScout24,
+Immowelt, Immonet, eBay Kleinanzeigen, and WG-Gesucht** and notifies you
+instantly via **Slack, Telegram, Email, ntfy, and more** when new
+listings appear.
 
-## Creating your first job
+With a modern architecture, Fredy provides a **clean Web UI**, removes
-To create your first job, click on the button "Create New Job" on the job table. The job creation dialog should be self-explanatory, however there is one important thing.
+duplicates across platforms, and stores results so you never see the
-When configuring providers, before copying the URL from your browser, make sure that you have sorted the results by date to make sure _Fredy_ always picks the latest results first.
+same listing twice.
 
-## User management
-As an administrator, you can create, edit and remove users from _Fredy_. Be careful, each job is connected to the user that has created the job. If you remove the user, their jobs will also be removed.
 
-# Development
 
-### Running Fredy in development mode
+------------------------------------------------------------------------
-To run _Fredy_ in development mode, you need to run the backend & frontend separately.
+
-Start the backend with:
+## ✨ Key Features
-```shell
+
-yarn run start
+-   🏠 Scrapes **ImmoScout24, Immowelt, Immonet, eBay Kleinanzeigen,
+    WG-Gesucht**
+-   ⚡ Instant notifications: Slack, Telegram, Email (SendGrid,
+    Mailjet), ntfy
+-   🔎 Uses the **ImmoScout Mobile API** (reverse engineered)
+-   🌍 Runs anywhere: Docker, Node.js, self-hosted
+-   🖥️ Intuitive **Web UI** to manage searches
+-   🎯 Easy to use thanks to a user-friendly Web UI
+-   🔄 Deduplication across platforms
+-   ⏱️ Customizable search intervals
+
+------------------------------------------------------------------------
+
+## 🤝 Sponsorship [![](https://img.shields.io/static/v1?label=Sponsor&message=❤&logo=GitHub&color=%23fe8e86)](https://github.com/sponsors/orangecoding)
+
+I maintain Fredy and other open-source projects in my free time.\
+If you find it useful, consider supporting the project 💙
+
+Fredy is proudly backed by the **JetBrains Open Source Support Program**.   
+
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="https://www.jetbrains.com/company/brand/img/logo_jb_dos_3.svg">
+  <source media="(prefers-color-scheme: light)" srcset="https://resources.jetbrains.com/storage/products/company/brand/logos/jetbrains.svg">
+  <img alt="Jetbrains Open Source" src="https://resources.jetbrains.com/storage/products/company/brand/logos/jetbrains.svg">
+</picture>
+
+------------------------------------------------------------------------
+
+## 👨‍🏫 Demo
+You can try out Fredy here: [Fredy Demo](https://fredy-demo.orange-coding.net/)
+
+------------------------------------------------------------------------
+
+## 🚀 Quick Start
+
+### With Docker
+
+> [!NOTE]
+> In order to start Fredy, you must provide a config.json. As a start, use the one in this repo: https://github.com/orangecoding/fredy/blob/master/conf/config.json
+
+``` bash
+docker run -d --name fredy \
+  -v fredy_conf:/conf \
+  -v fredy_db:/db \
+  -p 9998:9998 \
+  ghcr.io/orangecoding/fredy:master
 ```
-For the frontend, run:
+
-```shell
+Logs:
-yarn run dev
+
+``` bash
+docker logs fredy -f
+```
+
+### Manual (Node.js)
+
+-   Requirement: **Node.js 20 or higher**
+-   Install dependencies and start:
+
+``` bash
+yarn
+yarn run start:backend   # in one terminal
+yarn run start:frontend  # in another terminal
+```
+
+👉 Open <http://localhost:9998>
+
+**Default Login:**
+- Username: `admin`
+- Password: `admin`
+
+------------------------------------------------------------------------
+
+## 📸 Screenshots
+
+| Job Configuration | Job Analytics | Job Overview |
+|-------------------|--------------|--------------|
+| ![Screenshot showing job configuration in Fredy](doc/screenshot1.png) | ![Screenshot showing job analytics in Fredy](doc/screenshot_2.png) | ![Screenshot showing job overview in Fredy](doc/screenshot_3.png) |
+
+------------------------------------------------------------------------
+
+## 🧩 Core Concepts
+
+Fredy is built around three simple concepts:
+
+### Provider 🌐
+
+A **provider** is a real-estate platform (e.g. ImmoScout24, Immowelt,
+Immonet, eBay Kleinanzeigen, WG-Gesucht).\
+When you create a job, you paste the search URL from the platform into
+Fredy.\
+⚠️ Always make sure the search results are sorted by **date**, so Fredy
+picks up the newest listings first.
+
+### Adapter 📡
+
+An **adapter** is the channel through which Fredy notifies you (Slack,
+Telegram, Email, ntfy, ...).\
+Each adapter has its own configuration (e.g. API keys, webhook URLs).\
+You can use multiple adapters at once --- Fredy will send new listings
+through all of them.
+
+### Job 📅
+
+A **job** combines providers and adapters.\
+Example: "Search apartments on ImmoScout24 + Immowelt and send results
+to Slack + Telegram."\
+Jobs run automatically at the interval you configure (see
+`/conf/config.json`).
+
+------------------------------------------------------------------------
+
+## Immoscout
+
+Immoscout has implemented advanced bot detection. In order to work around this, we are using a reversed engineered version of their mobile api. See [Immoscout Reverse Engineering Documentation](https://github.com/orangecoding/fredy/blob/master/reverse-engineered-immoscout.md)
+
+## Analytics
+
+Fredy is completely free (and will always remain free). However, it would be a huge help if you’d allow me to collect some analytical data.
+Before you freak out, let me explain...  
+If you agree, Fredy will send a ping once every 6 hours to my internal tracking project (Will be open sourced soon).  
+The data includes: names of active adapters/providers, OS, architecture, Node version, and language. The information is entirely anonymous and helps me understand which adapters/providers are most frequently used.</p>
+
+**Thanks**🤘
+
+## 🛠️ Development
+
+### Development Mode
+
+``` bash
+yarn run start:backend:dev
+yarn run start:frontend:dev
 ```
 You should now be able to access _Fredy_ from your browser. Check your Terminal to see what port the frontend is running on.
 
-### Running Tests
+### Run Tests
-To run the tests, run
+
-```shell
+``` bash
 yarn run test
 ```
 
-# Architecture
+------------------------------------------------------------------------
-![Architecture](/doc/architecture.jpg "Architecture")
 
-### Immoscout
+## 📐 Architecture
-Immoscout has implemented advanced bot detection. In order to work around this, we are using a reversed engineered version of their mobile api. See See [Immoscout Reverse Engineering Documentation](https://github.com/orangecoding/fredy/blob/master/reverse-engineered-immoscout.md)
 
-# Analytics
+``` mermaid
-Fredy is completely free (and will always remain free). However, it would be a huge help if you’d allow me to collect some analytical data. 
+flowchart TD
-Before you freak out, let me explain...         
+ subgraph Jobs["Jobs"]
-If you agree, Fredy will send a ping to my Mixpanel project each time it runs.   
+        A1["Job 1"]
-The data includes: names of active adapters/providers, OS, architecture, Node version, and language. The information is entirely anonymous and helps me understand which adapters/providers are most frequently used.</p>
+        A2["Job 2"]
-**Thanks**🤘
+        A3["Job 3"]
+  end
+ subgraph Providers["Providers"]
+        C1["Provider 1"]
+        C2["Provider 2"]
+        C3["Provider 3"]
+  end
+ subgraph NotificationAdapters["Notification Adapters"]
+        F1["Adapter 1"]
+        F2["Adapter 2"]
+  end
 
-# Docker   
+    A1 --> B["FredyRuntime"]
-Use the Dockerfile in this repository to build an image.  
+    A2 --> B
+    A3 --> B
+    B --> C1 & C2 & C3
+    C1 --> D["Similarity Check"]
+    C2 --> D
+    C3 --> D
+    D --> E{"Duplicate?"}
+    E -- No --> F1
+    F1 --> F2
+```
 
-Example: `docker build -t fredy/fredy /path/to/your/Dockerfile`  
+------------------------------------------------------------------------
 
-Or use docker-compose:
+## 👐 Contributing
 
-Example `docker-compose build`
+Thanks to everyone who has contributed!
 
-Or use the container that will be built automatically.
+<a href="https://github.com/orangecoding/fredy/graphs/contributors"><img src="https://contrib.rocks/image?repo=orangecoding/fredy" /></a>
 
-`docker pull ghcr.io/orangecoding/fredy:master`
+See the [Contributing
+Guide](https://github.com/orangecoding/fredy/blob/master/CONTRIBUTING.md).
 
-## Create & run a container  
+------------------------------------------------------------------------
 
-Put your config.json into a path of your choice, such as `/path/to/your/conf/`.
+## ⭐ Star History
 
-Example: `docker create --name fredy -v /path/to/your/conf/:/conf -p 9998:9998 fredy/fredy`
+[![Star History
-
+Chart](https://api.star-history.com/svg?repos=orangecoding/fredy&type=Date)](https://www.star-history.com/#orangecoding/fredy&Date)
-## Logs  
-
-You can browse the logs with  `docker logs fredy -f`.
-
-### 👐 Contributing
-Thanks to all the people who already contributed!
-
-<a href="https://github.com/orangecoding/fredy/graphs/contributors">
-  <img src="https://contrib.rocks/image?repo=orangecoding/fredy" />
-</a>
-
-See [Contributing](https://github.com/orangecoding/fredy/blob/master/CONTRIBUTING.md)
-
-
-## Star History
-
-[![Star History Chart](https://api.star-history.com/svg?repos=orangecoding/fredy&type=Date)](https://www.star-history.com/#orangecoding/fredy&Date)

doc/Untitled Diagram.drawio

@@ -1,84 +0,0 @@
-<mxfile host="app.diagrams.net" modified="2022-01-29T18:34:51.211Z" agent="5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/97.0.4692.99 Safari/537.36" etag="W0jmvptvMSkuHq89hwUy" version="16.5.2" type="github">
-  <diagram id="C5RBs43oDa-KdzZeNtuy" name="Page-1">
-    <mxGraphModel dx="850" dy="907" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="827" pageHeight="1169" math="0" shadow="0">
-      <root>
-        <mxCell id="WIyWlLk6GJQsqaUBKTNV-0" />
-        <mxCell id="WIyWlLk6GJQsqaUBKTNV-1" parent="WIyWlLk6GJQsqaUBKTNV-0" />
-        <mxCell id="4kAlOAlRylSy7JMoHAEd-5" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;entryX=0.5;entryY=0;entryDx=0;entryDy=0;" edge="1" parent="WIyWlLk6GJQsqaUBKTNV-1" source="WIyWlLk6GJQsqaUBKTNV-3" target="WIyWlLk6GJQsqaUBKTNV-7">
-          <mxGeometry relative="1" as="geometry" />
-        </mxCell>
-        <mxCell id="WIyWlLk6GJQsqaUBKTNV-3" value="Job1" style="rounded=1;whiteSpace=wrap;html=1;fontSize=12;glass=0;strokeWidth=1;shadow=0;fillColor=#dae8fc;strokeColor=#6c8ebf;" parent="WIyWlLk6GJQsqaUBKTNV-1" vertex="1">
-          <mxGeometry x="100" y="50" width="120" height="30" as="geometry" />
-        </mxCell>
-        <mxCell id="4kAlOAlRylSy7JMoHAEd-8" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;entryX=0.5;entryY=0;entryDx=0;entryDy=0;" edge="1" parent="WIyWlLk6GJQsqaUBKTNV-1" source="WIyWlLk6GJQsqaUBKTNV-7" target="4kAlOAlRylSy7JMoHAEd-2">
-          <mxGeometry relative="1" as="geometry" />
-        </mxCell>
-        <mxCell id="4kAlOAlRylSy7JMoHAEd-10" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;entryX=0.5;entryY=0;entryDx=0;entryDy=0;" edge="1" parent="WIyWlLk6GJQsqaUBKTNV-1" source="WIyWlLk6GJQsqaUBKTNV-7" target="4kAlOAlRylSy7JMoHAEd-3">
-          <mxGeometry relative="1" as="geometry" />
-        </mxCell>
-        <mxCell id="4kAlOAlRylSy7JMoHAEd-11" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;entryX=0.5;entryY=0;entryDx=0;entryDy=0;" edge="1" parent="WIyWlLk6GJQsqaUBKTNV-1" source="WIyWlLk6GJQsqaUBKTNV-7" target="4kAlOAlRylSy7JMoHAEd-4">
-          <mxGeometry relative="1" as="geometry" />
-        </mxCell>
-        <mxCell id="WIyWlLk6GJQsqaUBKTNV-7" value="FredyRuntime" style="rounded=1;whiteSpace=wrap;html=1;fontSize=12;glass=0;strokeWidth=1;shadow=0;fillColor=#fff2cc;strokeColor=#d6b656;" parent="WIyWlLk6GJQsqaUBKTNV-1" vertex="1">
-          <mxGeometry x="110" y="120" width="360" height="40" as="geometry" />
-        </mxCell>
-        <mxCell id="4kAlOAlRylSy7JMoHAEd-6" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;entryX=0.5;entryY=0;entryDx=0;entryDy=0;" edge="1" parent="WIyWlLk6GJQsqaUBKTNV-1" source="4kAlOAlRylSy7JMoHAEd-0" target="WIyWlLk6GJQsqaUBKTNV-7">
-          <mxGeometry relative="1" as="geometry" />
-        </mxCell>
-        <mxCell id="4kAlOAlRylSy7JMoHAEd-0" value="Job2" style="rounded=1;whiteSpace=wrap;html=1;fontSize=12;glass=0;strokeWidth=1;shadow=0;fillColor=#dae8fc;strokeColor=#6c8ebf;" vertex="1" parent="WIyWlLk6GJQsqaUBKTNV-1">
-          <mxGeometry x="230" y="50" width="120" height="30" as="geometry" />
-        </mxCell>
-        <mxCell id="4kAlOAlRylSy7JMoHAEd-7" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;entryX=0.5;entryY=0;entryDx=0;entryDy=0;" edge="1" parent="WIyWlLk6GJQsqaUBKTNV-1" source="4kAlOAlRylSy7JMoHAEd-1" target="WIyWlLk6GJQsqaUBKTNV-7">
-          <mxGeometry relative="1" as="geometry" />
-        </mxCell>
-        <mxCell id="4kAlOAlRylSy7JMoHAEd-1" value="Job3" style="rounded=1;whiteSpace=wrap;html=1;fontSize=12;glass=0;strokeWidth=1;shadow=0;fillColor=#dae8fc;strokeColor=#6c8ebf;" vertex="1" parent="WIyWlLk6GJQsqaUBKTNV-1">
-          <mxGeometry x="360" y="50" width="120" height="30" as="geometry" />
-        </mxCell>
-        <mxCell id="4kAlOAlRylSy7JMoHAEd-13" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" edge="1" parent="WIyWlLk6GJQsqaUBKTNV-1" source="4kAlOAlRylSy7JMoHAEd-2" target="4kAlOAlRylSy7JMoHAEd-12">
-          <mxGeometry relative="1" as="geometry" />
-        </mxCell>
-        <mxCell id="4kAlOAlRylSy7JMoHAEd-2" value="Provider1" style="rounded=1;whiteSpace=wrap;html=1;fontSize=12;glass=0;strokeWidth=1;shadow=0;fillColor=#d5e8d4;strokeColor=#82b366;" vertex="1" parent="WIyWlLk6GJQsqaUBKTNV-1">
-          <mxGeometry x="100" y="210" width="120" height="40" as="geometry" />
-        </mxCell>
-        <mxCell id="4kAlOAlRylSy7JMoHAEd-14" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" edge="1" parent="WIyWlLk6GJQsqaUBKTNV-1" source="4kAlOAlRylSy7JMoHAEd-3">
-          <mxGeometry relative="1" as="geometry">
-            <mxPoint x="290" y="290" as="targetPoint" />
-          </mxGeometry>
-        </mxCell>
-        <mxCell id="4kAlOAlRylSy7JMoHAEd-3" value="Provider2" style="rounded=1;whiteSpace=wrap;html=1;fontSize=12;glass=0;strokeWidth=1;shadow=0;fillColor=#d5e8d4;strokeColor=#82b366;" vertex="1" parent="WIyWlLk6GJQsqaUBKTNV-1">
-          <mxGeometry x="230" y="210" width="120" height="40" as="geometry" />
-        </mxCell>
-        <mxCell id="4kAlOAlRylSy7JMoHAEd-15" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;entryX=0.5;entryY=0;entryDx=0;entryDy=0;" edge="1" parent="WIyWlLk6GJQsqaUBKTNV-1" source="4kAlOAlRylSy7JMoHAEd-4" target="4kAlOAlRylSy7JMoHAEd-12">
-          <mxGeometry relative="1" as="geometry" />
-        </mxCell>
-        <mxCell id="4kAlOAlRylSy7JMoHAEd-4" value="Provider3" style="rounded=1;whiteSpace=wrap;html=1;fontSize=12;glass=0;strokeWidth=1;shadow=0;fillColor=#d5e8d4;strokeColor=#82b366;" vertex="1" parent="WIyWlLk6GJQsqaUBKTNV-1">
-          <mxGeometry x="360" y="210" width="120" height="40" as="geometry" />
-        </mxCell>
-        <mxCell id="4kAlOAlRylSy7JMoHAEd-17" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" edge="1" parent="WIyWlLk6GJQsqaUBKTNV-1" source="4kAlOAlRylSy7JMoHAEd-12" target="4kAlOAlRylSy7JMoHAEd-16">
-          <mxGeometry relative="1" as="geometry" />
-        </mxCell>
-        <mxCell id="4kAlOAlRylSy7JMoHAEd-12" value="Similarity check" style="rounded=1;whiteSpace=wrap;html=1;fontSize=12;glass=0;strokeWidth=1;shadow=0;fillColor=#e1d5e7;strokeColor=#9673a6;" vertex="1" parent="WIyWlLk6GJQsqaUBKTNV-1">
-          <mxGeometry x="110" y="290" width="360" height="40" as="geometry" />
-        </mxCell>
-        <mxCell id="4kAlOAlRylSy7JMoHAEd-20" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;entryX=0.5;entryY=0;entryDx=0;entryDy=0;" edge="1" parent="WIyWlLk6GJQsqaUBKTNV-1" source="4kAlOAlRylSy7JMoHAEd-16" target="4kAlOAlRylSy7JMoHAEd-18">
-          <mxGeometry relative="1" as="geometry" />
-        </mxCell>
-        <mxCell id="4kAlOAlRylSy7JMoHAEd-16" value="Found similarity" style="rhombus;whiteSpace=wrap;html=1;" vertex="1" parent="WIyWlLk6GJQsqaUBKTNV-1">
-          <mxGeometry x="250" y="360" width="80" height="80" as="geometry" />
-        </mxCell>
-        <mxCell id="4kAlOAlRylSy7JMoHAEd-21" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" edge="1" parent="WIyWlLk6GJQsqaUBKTNV-1" source="4kAlOAlRylSy7JMoHAEd-18" target="4kAlOAlRylSy7JMoHAEd-19">
-          <mxGeometry relative="1" as="geometry" />
-        </mxCell>
-        <mxCell id="4kAlOAlRylSy7JMoHAEd-18" value="Notification Adapter1" style="rounded=1;whiteSpace=wrap;html=1;fontSize=12;glass=0;strokeWidth=1;shadow=0;fillColor=#f8cecc;strokeColor=#b85450;" vertex="1" parent="WIyWlLk6GJQsqaUBKTNV-1">
-          <mxGeometry x="230" y="460" width="120" height="40" as="geometry" />
-        </mxCell>
-        <mxCell id="4kAlOAlRylSy7JMoHAEd-19" value="Notification Adapter2" style="rounded=1;whiteSpace=wrap;html=1;fontSize=12;glass=0;strokeWidth=1;shadow=0;fillColor=#f8cecc;strokeColor=#b85450;" vertex="1" parent="WIyWlLk6GJQsqaUBKTNV-1">
-          <mxGeometry x="230" y="520" width="120" height="40" as="geometry" />
-        </mxCell>
-        <mxCell id="4kAlOAlRylSy7JMoHAEd-22" value="No" style="text;html=1;resizable=0;autosize=1;align=center;verticalAlign=middle;points=[];fillColor=none;strokeColor=none;rounded=0;" vertex="1" parent="WIyWlLk6GJQsqaUBKTNV-1">
-          <mxGeometry x="300" y="440" width="30" height="20" as="geometry" />
-        </mxCell>
-      </root>
-    </mxGraphModel>
-  </diagram>
-</mxfile>

docker-compose.yml

@@ -1,4 +1,3 @@
-version: '3.8'
 services:
   fredy:
     container_name: fredy
@@ -12,5 +11,5 @@ services:
       - ./conf:/conf
       - ./db:/db
     ports:
-        - 9998:9998
+      - 9998:9998
     restart: unless-stopped

eslint.config.js

@@ -0,0 +1,96 @@
+// eslint.config.js
+import js from '@eslint/js';
+import prettier from 'eslint-config-prettier';
+import globals from 'globals';
+import react from 'eslint-plugin-react';
+import babelParser from '@babel/eslint-parser';
+
+export default [
+  {
+    files: ['**/*.{js,jsx,ts,tsx}'],
+    ignores: ['**/node_modules/**', '**/dist/**', '**/build/**', '**/public/**', 'db/**', 'conf/**'],
+  },
+  js.configs.recommended,
+  prettier,
+  {
+    languageOptions: {
+      parser: babelParser,
+      sourceType: 'module',
+      ecmaVersion: 2021,
+      globals: {
+        ...globals.browser,
+        ...globals.node,
+        ...globals.mocha,
+        Promise: 'readonly',
+        fetch: 'readonly',
+        describe: 'readonly',
+        after: 'readonly',
+        it: 'readonly',
+      },
+      parserOptions: { requireConfigFile: false },
+    },
+    plugins: { react },
+    rules: {
+      eqeqeq: [2, 'allow-null'],
+      strict: 0,
+      'no-redeclare': [2, { builtinGlobals: false }],
+      'class-methods-use-this': 'off',
+      indent: ['off', 2],
+      'linebreak-style': ['error', 'unix'],
+      quotes: ['error', 'single', { avoidEscape: true, allowTemplateLiterals: true }],
+      semi: ['error', 'always'],
+      'no-console': ['error', { allow: ['warn', 'error'] }],
+      'jsx-quotes': ['error', 'prefer-double'],
+      'react/display-name': 'off',
+      'react/forbid-prop-types': 'off',
+      'react/jsx-closing-bracket-location': 'off',
+      'react/jsx-curly-spacing': 'off',
+      'react/jsx-handler-names': ['off', { eventHandlerPrefix: 'handle', eventHandlerPropPrefix: 'on' }],
+      'react/jsx-indent-props': 'off',
+      'react/jsx-key': 'off',
+      'react/jsx-max-props-per-line': 'off',
+      'react/jsx-no-bind': ['error', { ignoreRefs: true, allowArrowFunctions: true, allowBind: false }],
+      'react/jsx-no-duplicate-props': ['error', { ignoreCase: true }],
+      'react/jsx-no-literals': 'off',
+      'react/jsx-no-undef': 'error',
+      'react/jsx-pascal-case': ['error', { allowAllCaps: true, ignore: [] }],
+      'react/sort-prop-types': ['off', { ignoreCase: true, callbacksLast: false, requiredFirst: false }],
+      'react/jsx-sort-prop-types': 'off',
+      'react/jsx-sort-props': 'off',
+      'react/jsx-uses-react': 'error',
+      'react/jsx-uses-vars': 'error',
+      'react/no-danger': 'warn',
+      'react/no-deprecated': 'error',
+      'react/no-did-mount-set-state': 'error',
+      'react/no-did-update-set-state': 'warn',
+      'react/no-direct-mutation-state': 'off',
+      'react/no-is-mounted': 'error',
+      'react/no-set-state': 'off',
+      'react/no-string-refs': 'warn',
+      'react/no-unknown-property': 'error',
+      'react/prop-types': ['error', { ignore: [], customValidators: [], skipUndeclared: true }],
+      'react/react-in-jsx-scope': 'error',
+      'react/require-extension': 'off',
+      'react/require-render-return': 'error',
+      'react/self-closing-comp': 'warn',
+      'react/sort-comp': 'off',
+      'react/jsx-wrap-multilines': ['warn', { declaration: true, assignment: true, return: true }],
+      'react/wrap-multilines': 'off',
+      'react/jsx-first-prop-new-line': 'off',
+      'react/jsx-equals-spacing': ['warn', 'never'],
+      'react/jsx-no-target-blank': 'error',
+      'react/jsx-filename-extension': ['error', { extensions: ['.jsx'] }],
+      'react/jsx-no-comment-textnodes': 'error',
+      'react/no-comment-textnodes': 'off',
+      'react/no-render-return-value': 'error',
+      'react/require-optimization': ['off', { allowDecorators: [] }],
+      'react/no-find-dom-node': 'warn',
+      'react/forbid-component-props': ['off', { forbid: [] }],
+      'react/no-danger-with-children': 'error',
+      'react/no-unused-prop-types': ['warn', { customValidators: [], skipShapeProps: true }],
+      'react/style-prop-object': 'error',
+      'react/no-children-prop': 'warn',
+    },
+    settings: { react: { version: 'detect' } },
+  },
+];

index.html

@@ -1,16 +1,17 @@
-<!DOCTYPE html>
+<!doctype html>
 <html lang="en">
-<head>
+  <head>
-    <meta charset="UTF-8"
+    <meta
-          name="viewport"
+      charset="UTF-8"
-          content="user-scalable=no, width=device-width, initial-scale=1, maximum-scale=1">
+      name="viewport"
-    <meta name="google" content="notranslate">
+      content="user-scalable=no, width=device-width, initial-scale=1, maximum-scale=1"
+    />
+    <meta name="google" content="notranslate" />
 
     <title>Fredy</title>
-</head>
+  </head>
-<body theme-mode="dark">
+  <body theme-mode="dark">
-
+    <div id="fredy" style="position: absolute; top: 0; left: 0; right: 0; bottom: 0"></div>
-<div id="fredy" style="position: absolute;top: 0;left: 0;right: 0;bottom: 0;"></div>
+  </body>
-</body>
+  <script type="module" src="/ui/src/Index.jsx"></script>
-<script type="module" src="/ui/src/Index.jsx"></script>
+</html>
-</html>

index.js

@@ -1,14 +1,15 @@
 import fs from 'fs';
-import {config} from './lib/utils.js';
+import { config } from './lib/utils.js';
 import * as similarityCache from './lib/services/similarity-check/similarityCache.js';
 import { setLastJobExecution } from './lib/services/storage/listingsStorage.js';
 import * as jobStorage from './lib/services/storage/jobStorage.js';
 import FredyRuntime from './lib/FredyRuntime.js';
 import { duringWorkingHoursOrNotSet } from './lib/utils.js';
 import './lib/api/api.js';
-import {track} from './lib/services/tracking/Tracker.js';
+import { handleDemoUser } from './lib/services/storage/userStorage.js';
-import {handleDemoUser} from './lib/services/storage/userStorage.js';
+import { cleanupDemoAtMidnight } from './lib/services/demoCleanup.js';
-import {cleanupDemoAtMidnight} from './lib/services/demoCleanup.js';
+import { initTrackerCron } from './lib/services/tracking/Tracker-Cron.js';
+import logger from './lib/services/logger.js';
 //if db folder does not exist, ensure to create it before loading anything else
 if (!fs.existsSync('./db')) {
   fs.mkdirSync('./db');
@@ -17,46 +18,42 @@ const path = './lib/provider';
 const provider = fs.readdirSync(path).filter((file) => file.endsWith('.js'));
 //assuming interval is always in minutes
 const INTERVAL = config.interval * 60 * 1000;
-/* eslint-disable no-console */
+logger.info(`Started Fredy successfully. Ui can be accessed via http://localhost:${config.port}`);
-console.log(`Started Fredy successfully. Ui can be accessed via http://localhost:${config.port}`);
+if (config.demoMode) {
-if(config.demoMode){
+  logger.info('Running in demo mode');
-    console.info('Running in demo mode');
+  cleanupDemoAtMidnight();
-    cleanupDemoAtMidnight();
 }
-/* eslint-enable no-console */
 const fetchedProvider = await Promise.all(
-  provider.filter((provider) => provider.endsWith('.js')).map(async (pro) => import(`${path}/${pro}`))
+  provider.filter((provider) => provider.endsWith('.js')).map(async (pro) => import(`${path}/${pro}`)),
 );
 
 handleDemoUser();
+await initTrackerCron();
 
 setInterval(
   (function exec() {
     const isDuringWorkingHoursOrNotSet = duringWorkingHoursOrNotSet(config, Date.now());
-        if(!config.demoMode) {
+    if (!config.demoMode) {
-            if (isDuringWorkingHoursOrNotSet) {
+      if (isDuringWorkingHoursOrNotSet) {
-                track();
+        config.lastRun = Date.now();
-                config.lastRun = Date.now();
+        jobStorage
-                jobStorage
+          .getJobs()
-                    .getJobs()
+          .filter((job) => job.enabled)
-                    .filter((job) => job.enabled)
+          .forEach((job) => {
-                    .forEach((job) => {
+            job.provider
-                        job.provider
+              .filter((p) => fetchedProvider.find((fp) => fp.metaInformation.id === p.id) != null)
-                            .filter((p) => fetchedProvider.find((fp) => fp.metaInformation.id === p.id) != null)
+              .forEach(async (prov) => {
-                            .forEach(async (prov) => {
+                const pro = fetchedProvider.find((fp) => fp.metaInformation.id === prov.id);
-                                const pro = fetchedProvider.find((fp) => fp.metaInformation.id === prov.id);
+                pro.init(prov, job.blacklist);
-                                pro.init(prov, job.blacklist);
+                await new FredyRuntime(pro.config, job.notificationAdapter, prov.id, job.id, similarityCache).execute();
-                                await new FredyRuntime(pro.config, job.notificationAdapter, prov.id, job.id, similarityCache).execute();
+                setLastJobExecution(job.id);
-                                setLastJobExecution(job.id);
+              });
-                            });
+          });
-                    });
+      } else {
-            } else {
+        logger.debug('Working hours set. Skipping as outside of working hours.');
-                /* eslint-disable no-console */
+      }
-                console.debug('Working hours set. Skipping as outside of working hours.');
+    }
-                /* eslint-enable no-console */
-            }
-        }
     return exec;
   })(),
-  INTERVAL
+  INTERVAL,
 );

lib/FredyRuntime.js

@@ -3,6 +3,7 @@ import { setKnownListings, getKnownListings } from './services/storage/listingsS
 import * as notify from './notification/notify.js';
 import Extractor from './services/extractor/extractor.js';
 import urlModifier from './services/queryStringMutator.js';
+import logger from './services/logger.js';
 
 class FredyRuntime {
   /**
@@ -59,9 +60,7 @@ class FredyRuntime {
         })
         .catch((err) => {
           reject(err);
-          /* eslint-disable no-console */
+          logger.error(err);
-          console.error(err);
-          /* eslint-enable no-console */
         });
     });
   }
@@ -104,20 +103,18 @@ class FredyRuntime {
 
   _filterBySimilarListings(listings) {
     const filteredList = listings.filter((listing) => {
-      const similar = this._similarityCache.hasSimilarEntries(this._jobKey, listing.title);
+      const similar = this._similarityCache.hasSimilarEntries(listing.title, listing.address);
       if (similar) {
-        /* eslint-disable no-console */
+        logger.debug(`Filtering similar entry for title: ${listing.title} and address ${listing.address}`);
-        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));
+    filteredList.forEach((filter) => this._similarityCache.addCacheEntry(filter.title, listings.address));
     return filteredList;
   }
 
   _handleError(err) {
-    if (err.name !== 'NoNewListingsWarning') console.error(err);
+    if (err.name !== 'NoNewListingsWarning') logger.error(err);
   }
 }
 

lib/api/api.js

@@ -12,7 +12,8 @@ import restana from 'restana';
 import files from 'serve-static';
 import path from 'path';
 import { getDirName } from '../utils.js';
-import {demoRouter} from './routes/demoRouter.js';
+import { demoRouter } from './routes/demoRouter.js';
+import logger from '../services/logger.js';
 const service = restana();
 const staticService = files(path.join(getDirName(), '../ui/public'));
 const PORT = config.port || 9998;
@@ -34,7 +35,6 @@ service.use('/api/login', loginRouter);
 //this route is unsecured intentionally as it is being queried from the login page
 service.use('/api/demo', demoRouter);
 
-/* eslint-disable no-console */
 service.start(PORT).then(() => {
-  console.info(`Started API service on port ${PORT}`);
+  logger.debug(`Started API service on port ${PORT}`);
 });

lib/api/routes/demoRouter.js

@@ -1,10 +1,10 @@
 import restana from 'restana';
-import {config} from '../../utils.js';
+import { config } from '../../utils.js';
 const service = restana();
 const demoRouter = service.newRouter();
 
 demoRouter.get('/', async (req, res) => {
-  res.body = Object.assign({}, {demoMode: config.demoMode});
+  res.body = Object.assign({}, { demoMode: config.demoMode });
   res.send();
 });
 

lib/api/routes/generalSettingsRoute.js

@@ -1,7 +1,8 @@
 import restana from 'restana';
-import {config, getDirName, readConfigFromStorage, refreshConfig} from '../../utils.js';
+import { config, getDirName, readConfigFromStorage, refreshConfig } from '../../utils.js';
 import fs from 'fs';
-import {handleDemoUser} from '../../services/storage/userStorage.js';
+import { handleDemoUser } from '../../services/storage/userStorage.js';
+import logger from '../../services/logger.js';
 const service = restana();
 const generalSettingsRouter = service.newRouter();
 generalSettingsRouter.get('/', async (req, res) => {
@@ -11,16 +12,16 @@ generalSettingsRouter.get('/', async (req, res) => {
 generalSettingsRouter.post('/', async (req, res) => {
   const settings = req.body;
   try {
-    if(config.demoMode){
+    if (config.demoMode) {
       res.send(new Error('In demo mode, it is not allowed to change these settings.'));
       return;
     }
     const currentConfig = await readConfigFromStorage();
-    fs.writeFileSync(`${getDirName()}/../conf/config.json`, JSON.stringify({...currentConfig, ...settings}));
+    fs.writeFileSync(`${getDirName()}/../conf/config.json`, JSON.stringify({ ...currentConfig, ...settings }));
     await refreshConfig();
     handleDemoUser();
   } catch (err) {
-    console.error(err);
+    logger.error(err);
     res.send(new Error('Error while trying to write settings.'));
     return;
   }

lib/api/routes/jobRouter.js

@@ -3,7 +3,7 @@ import * as jobStorage from '../../services/storage/jobStorage.js';
 import * as userStorage from '../../services/storage/userStorage.js';
 import { config } from '../../utils.js';
 import { isAdmin } from '../security.js';
-import { trackDemoJobCreated } from '../../services/tracking/Tracker.js';
+import logger from '../../services/logger.js';
 const service = restana();
 const jobRouter = service.newRouter();
 function doesJobBelongsToUser(job, req) {
@@ -15,7 +15,7 @@ function doesJobBelongsToUser(job, req) {
   if (user == null) {
     return false;
   }
-  return user.isAdmin || job.userId === job.userId;
+  return user.isAdmin || job.userId === user.id;
 }
 jobRouter.get('/', async (req, res) => {
   const isUserAdmin = isAdmin(req);
@@ -44,13 +44,8 @@ jobRouter.post('/', async (req, res) => {
     });
   } catch (error) {
     res.send(new Error(error));
-    console.error(error);
+    logger.error(error);
   }
-  trackDemoJobCreated({
-    name,
-    provider,
-    adapter: notificationAdapter,
-  });
   res.send();
 });
 jobRouter.delete('', async (req, res) => {
@@ -64,7 +59,7 @@ jobRouter.delete('', async (req, res) => {
     }
   } catch (error) {
     res.send(new Error(error));
-    console.error(error);
+    logger.error(error);
   }
   res.send();
 });
@@ -83,7 +78,7 @@ jobRouter.put('/:jobId/status', async (req, res) => {
     }
   } catch (error) {
     res.send(new Error(error));
-    console.error(error);
+    logger.error(error);
   }
   res.send();
 });

lib/api/routes/loginRoute.js

@@ -1,8 +1,9 @@
 import restana from 'restana';
 import * as userStorage from '../../services/storage/userStorage.js';
 import * as hasher from '../../services/security/hash.js';
-import {config} from '../../utils.js';
+import { config } from '../../utils.js';
-import {trackDemoAccessed} from '../../services/tracking/Tracker.js';
+import { trackDemoAccessed } from '../../services/tracking/Tracker.js';
+import logger from '../../services/logger.js';
 const service = restana();
 const loginRouter = service.newRouter();
 loginRouter.get('/user', async (req, res) => {
@@ -26,9 +27,8 @@ loginRouter.post('/', async (req, res) => {
     return;
   }
   if (user.password === hasher.hash(password)) {
-
+    if (config.demoMode) {
-    if(config.demoMode){
+      await trackDemoAccessed();
-      trackDemoAccessed();
     }
 
     req.session.currentUser = user.id;
@@ -36,7 +36,7 @@ loginRouter.post('/', async (req, res) => {
     res.send(200);
     return;
   } else {
-    console.error(`User ${username} tried to login, but password was wrong.`);
+    logger.error(`User ${username} tried to login, but password was wrong.`);
   }
   res.send(401);
 });

lib/api/routes/notificationAdapterRouter.js

@@ -6,7 +6,7 @@ const notificationAdapterList = fs.readdirSync('./lib//notification/adapter').fi
 const notificationAdapter = await Promise.all(
   notificationAdapterList.map(async (pro) => {
     return await import(`../../notification/adapter/${pro}`);
-  })
+  }),
 );
 notificationAdapterRouter.post('/try', async (req, res) => {
   const { id, fields } = req.body;

lib/api/routes/providerRouter.js

@@ -6,7 +6,7 @@ const providerList = fs.readdirSync('./lib/provider').filter((file) => file.ends
 const provider = await Promise.all(
   providerList.map(async (pro) => {
     return await import(`../../provider/${pro}`);
-  })
+  }),
 );
 providerRouter.get('/', async (req, res) => {
   res.body = provider.map((p) => p.metaInformation);

lib/api/routes/userRoute.js

@@ -1,7 +1,7 @@
 import restana from 'restana';
 import * as userStorage from '../../services/storage/userStorage.js';
 import * as jobStorage from '../../services/storage/jobStorage.js';
-import {config} from '../../utils.js';
+import { config } from '../../utils.js';
 const service = restana();
 const userRouter = service.newRouter();
 function checkIfAnyAdminAfterRemovingUser(userIdToBeRemoved, allUser) {
@@ -21,7 +21,7 @@ userRouter.get('/:userId', async (req, res) => {
   res.send();
 });
 userRouter.delete('/', async (req, res) => {
-  if(config.demoMode){
+  if (config.demoMode) {
     res.send(new Error('In demo mode, it is not allowed to remove user.'));
     return;
   }
@@ -42,10 +42,9 @@ userRouter.delete('/', async (req, res) => {
   res.send();
 });
 userRouter.post('/', async (req, res) => {
-
+  if (config.demoMode) {
-  if(config.demoMode){
+    res.send(new Error('In demo mode, it is not allowed to change or add user.'));
-      res.send(new Error('In demo mode, it is not allowed to change or add user.'));
+    return;
-      return;
   }
 
   const { username, password, password2, isAdmin, userId } = req.body;
@@ -60,7 +59,7 @@ userRouter.post('/', async (req, res) => {
   const allUser = userStorage.getUsers(false);
   if (!isAdmin && !checkIfAnyAdminAfterRemovingUser(userId, allUser)) {
     res.send(
-      new Error('You cannot change the admin flag for this user as otherwise, there is no other user in the system')
+      new Error('You cannot change the admin flag for this user as otherwise, there is no other user in the system'),
     );
     return;
   }

lib/defaultConfig.js

@@ -1,7 +1,7 @@
 export const DEFAULT_CONFIG = {
-            'interval': '60',
+  interval: '60',
-            'port': 9998,
+  port: 9998,
-            'workingHours': {'from': '', 'to': ''},
+  workingHours: { from: '', to: '' },
-            'demoMode': false,
+  demoMode: false,
-            'analyticsEnabled': null
+  analyticsEnabled: null,
-    };
+};

lib/notification/adapter/apprise.js

@@ -18,7 +18,6 @@ export const send = ({ serviceName, newListings, notificationConfig, jobKey }) =
       }),
     });
   });
-
   return Promise.all(promises);
 };
 export const config = {

lib/notification/adapter/console.md

@@ -1,4 +1,4 @@
 ### Console Adapter
 
 The console adapter prints everything found by Fredy into the console (not sending any notifications to you). This can be useful when you want to check if your search
-criteria meet the expectations.
+criteria meet the expectations.

lib/notification/adapter/mailJet.js

@@ -2,42 +2,112 @@ import mailjet from 'node-mailjet';
 import path from 'path';
 import fs from 'fs';
 import Handlebars from 'handlebars';
+import fetch from 'node-fetch';
 import { markdown2Html } from '../../services/markdown.js';
-import { getDirName } from '../../utils.js';
+import { getDirName, normalizeImageUrl } from '../../utils.js';
+import logger from '../../services/logger.js';
+
 const __dirname = getDirName();
 const template = fs.readFileSync(path.resolve(__dirname + '/notification/emailTemplate/template.hbs'), 'utf8');
 const emailTemplate = Handlebars.compile(template);
-export const send = ({ serviceName, newListings, notificationConfig, jobKey }) => {
+
+const guessMime = (url) => {
+  const lower = url.split('?')[0].toLowerCase();
+  if (lower.endsWith('.png')) return 'image/png';
+  if (lower.endsWith('.gif')) return 'image/gif';
+  return 'image/jpeg';
+};
+
+const toBase64 = async (url) => {
+  try {
+    const res = await fetch(url);
+    if (!res.ok) throw new Error(`Fetch failed with status ${res.status} for URL: ${url}`);
+    const ab = await res.arrayBuffer();
+    return Buffer.from(ab).toString('base64');
+  } catch (error) {
+    logger.error(`Error fetching image from ${url}:`, error.message);
+    throw error;
+  }
+};
+
+const mapListingsWithCid = async (serviceName, jobKey, listings) => {
+  const out = [];
+  const attachments = [];
+
+  for (let i = 0; i < listings.length; i++) {
+    const l = listings[i] || {};
+    const imgUrl = normalizeImageUrl(l.image);
+
+    const item = {
+      title: l.title || '',
+      link: l.link || '',
+      address: l.address || '',
+      size: l.size || '',
+      price: l.price || '',
+      serviceName,
+      jobKey,
+      hasImage: false,
+      imageCid: '',
+    };
+
+    if (imgUrl) {
+      try {
+        const base64 = await toBase64(imgUrl);
+        const cid = `listing-${i}`;
+        attachments.push({
+          ContentType: guessMime(imgUrl),
+          Filename: `listing-${i}.${imgUrl.split('.').pop().split('?')[0] || 'jpg'}`,
+          Base64Content: base64,
+          ContentID: cid,
+        });
+        item.hasImage = true;
+        item.imageCid = cid;
+      } catch (error) {
+        logger.warn(`Skipping image for listing ${i} due to error: ${error.message}`);
+      }
+    }
+
+    out.push(item);
+  }
+
+  return { listings: out, attachments };
+};
+
+export const send = async ({ serviceName, newListings, notificationConfig, jobKey }) => {
   const { apiPublicKey, apiPrivateKey, receiver, from } = notificationConfig.find(
     (adapter) => adapter.id === config.id,
   ).fields;
+
   const to = receiver
     .trim()
     .split(',')
-    .map((r) => ({
+    .map((r) => ({ Email: r.trim() }))
-      Email: r.trim(),
+    .filter((r) => r.Email.length > 0);
-    }));
+
+  const { listings, attachments } = await mapListingsWithCid(serviceName, jobKey, newListings);
+
+  const html = emailTemplate({
+    serviceName: `Job: (${jobKey}) | Service: ${serviceName}`,
+    numberOfListings: listings.length,
+    listings,
+  });
+
   return mailjet
     .apiConnect(apiPublicKey, apiPrivateKey)
     .post('send', { version: 'v3.1' })
     .request({
       Messages: [
         {
-          From: {
+          From: { Email: from, Name: 'Fredy' },
-            Email: from,
-            Name: 'Fredy',
-          },
           To: to,
-          Subject: `Fredy found ${newListings.length} new listings for ${serviceName}`,
+          Subject: `Fredy found ${listings.length} new listing(s) for ${serviceName}`,
-          HTMLPart: emailTemplate({
+          HTMLPart: html,
-            serviceName: `Job: (${jobKey}) | Service: ${serviceName}`,
+          InlinedAttachments: attachments,
-            numberOfListings: newListings.length,
-            listings: newListings,
-          }),
         },
       ],
     });
 };
+
 export const config = {
   id: 'mailjet',
   name: 'MailJet',

lib/notification/adapter/mailJet.md

@@ -1,8 +1,8 @@
 ### MailJet Adapter
- 
+
-To use [MailJet](https://mailjet.com), you need to create an account. You'll need to decided from which email address you want Fredy to send from.  
+To use [MailJet](https://mailjet.com), you need to create an account. You'll need to decide from which email address you want Fredy to send from.
- 
+
-E.g. if you use yourGmailAccount@gmail.com, you have to add this to MailJet and verify it as well.     
+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). 
+If this email should be sent to multiple receiver, use a comma separator (some@email.com, someOther@email.com).

lib/notification/adapter/mattermost.md

@@ -1,5 +1,5 @@
 ### Mattermost Adapter
 
-For Mattermost, you need to create a incoming webhook. This is pretty easy. Please visit the steps in the  [developer docs](https://docs.mattermost.com/developer/webhooks-incoming.html) and follow the instructions.
+For Mattermost, you need to create a incoming webhook. This is pretty easy. Please visit the steps in the [developer docs](https://docs.mattermost.com/developer/webhooks-incoming.html) and follow the instructions.
 
-As a result, you get the webhook URL for configuration in fredy. In addition, the target channel must be defined.
+As a result, you get the webhook URL for configuration in fredy. In addition, the target channel must be defined.

lib/notification/adapter/ntfy.js

@@ -1,32 +1,41 @@
 import { markdown2Html } from '../../services/markdown.js';
 import { getJob } from '../../services/storage/jobStorage.js';
 import fetch from 'node-fetch';
+import { normalizeImageUrl } from '../../utils.js';
 
 export const send = ({ serviceName, newListings, notificationConfig, jobKey }) => {
   const { priority, server, topic } = notificationConfig.find((adapter) => adapter.id === config.id).fields;
   const job = getJob(jobKey);
   const jobName = job == null ? jobKey : job.name;
+
   const promises = newListings.map((newListing) => {
     const message = `
-    Address: ${newListing.address} 
+Address: ${newListing.address}
-    Size: ${newListing.size.replace(/2m/g, '$m^2$')} 
+Size: ${newListing.size == null ? 'N/A' : newListing.size.replace(/2m/g, '$m^2$')}
-    Price: ${newListing.price}
+Price: ${newListing.price}
-    Link: ${newListing.link}`;
+Link: ${newListing.link}`;
-    return fetch(server, {
+
+    const headers = {
+      Title: newListing.title,
+      Priority: String(priority),
+      Tags: `${serviceName},${jobName}`,
+      Click: newListing.link,
+    };
+
+    if (newListing.image && typeof newListing.image === 'string') {
+      headers.Attach = normalizeImageUrl(newListing.image);
+    }
+
+    return fetch(`${server}/${topic}`, {
       method: 'POST',
-      body: JSON.stringify({
+      headers,
-        topic: topic,
+      body: message,
-        message: message,
-        title: newListing.title,
-        tags: [serviceName, jobName],
-        priority: parseInt(priority),
-        click: newListing.link,
-      }),
     });
   });
 
   return Promise.all(promises);
 };
+
 export const config = {
   id: 'ntfy',
   name: 'ntfy',

lib/notification/adapter/ntfy.md

@@ -1,5 +1,5 @@
 ### ntfy Adapter
 
-For ntfy, you need to create a topic on your preferred ntfy instance. This is pretty easy. Please visit the steps in the  [docs](https://docs.ntfy.sh/publish/) and follow the instructions.
+For ntfy, you need to create a topic on your preferred ntfy instance. This is pretty easy. Please visit the steps in the [docs](https://docs.ntfy.sh/publish/) and follow the instructions.
 
-As a result, you get the URL for configuration in fredy. In addition, the priority must be defined.
+As a result, you get the URL for configuration in fredy. In addition, the priority must be defined.

lib/notification/adapter/pushover.js

@@ -1,73 +1,79 @@
-import {markdown2Html} from '../../services/markdown.js';
+import { markdown2Html } from '../../services/markdown.js';
-import {getJob} from '../../services/storage/jobStorage.js';
+import { getJob } from '../../services/storage/jobStorage.js';
 import fetch from 'node-fetch';
 
-export const send = ({serviceName, newListings, notificationConfig, jobKey}) => {
+export const send = async ({ serviceName, newListings, notificationConfig, jobKey }) => {
-    const {token, user, device} = notificationConfig.find((adapter) => adapter.id === config.id).fields;
+  const { token, user, device } = notificationConfig.find((adapter) => adapter.id === config.id).fields;
-    const job = getJob(jobKey);
+  const job = getJob(jobKey);
-    const jobName = job == null ? jobKey : job.name;
+  const jobName = job == null ? jobKey : job.name;
-    const promises = newListings.map((newListing) => {
-        const title = `${jobName} at ${serviceName}: ${newListing.title}`;
-        const message = `Address: ${newListing.address}\nSize: ${newListing.size}\nPrice: ${newListing.price}\nLink: ${newListing.link}`;
-        return fetch('https://api.pushover.net/1/messages.json', {
-            method: 'POST',
-            headers: {'Content-Type': 'application/json'},
-            body: JSON.stringify({
-                token: token,
-                user: user,
-                message: message,
-                device: device,
-                title: title,
-            }),
-        });
-    });
 
-    return Promise.all(promises)
+  const results = await Promise.all(
-        .then((responses) => {
+    newListings.map(async (newListing) => {
-            // Convert all responses to JSON
+      const title = `${jobName} at ${serviceName}: ${newListing.title}`;
-            return Promise.all(responses.map((response) => response.json()));
+      const message = `Address: ${newListing.address}\nSize: ${newListing.size}\nPrice: ${newListing.price}\nLink: ${newListing.link}`;
-        })
-        .then((data) => {
-            // Check for errors in the data
-            const error = data
-                .map((item) => (item.errors != null && item.errors.length > 0 ? item.errors.join(', ') : null))
-                .filter((err) => err !== null);
 
-            if (error.length > 0) {
+      const form = new FormData();
-                // Reject with the combined error messages
+      form.append('token', token);
-                return Promise.reject(error.join('; '));
+      form.append('user', user);
-            }
+      form.append('title', title);
+      form.append('message', message);
+      if (device) form.append('device', device);
 
-            return data;
+      // Try to attach image if available
-        })
+      if (newListing.image && typeof newListing.image === 'string') {
-        .then(() => {
+        try {
-            return Promise.resolve();
+          const imgRes = await fetch(newListing.image);
-        })
+          if (imgRes.ok) {
-        .catch((error) => {
+            const ab = await imgRes.arrayBuffer();
-            return Promise.reject(error);
+            form.append('attachment', new Blob([ab]), 'image.jpg');
-        });
+          }
+        } catch {
+          // fail silently, just skip the image
+        }
+      }
+
+      const res = await fetch('https://api.pushover.net/1/messages.json', {
+        method: 'POST',
+        body: form,
+      });
+
+      return res.json();
+    }),
+  );
+
+  // Collect errors
+  const errors = results
+    .map((r) => (r.errors && r.errors.length > 0 ? r.errors.join(', ') : null))
+    .filter((e) => e !== null);
+
+  if (errors.length > 0) {
+    return Promise.reject(errors.join('; '));
+  }
+
+  return results;
 };
 
 export const config = {
-    id: 'pushover',
+  id: 'pushover',
-    name: 'Pushover',
+  name: 'Pushover',
-    readme: markdown2Html('lib/notification/adapter/pushover.md'),
+  readme: markdown2Html('lib/notification/adapter/pushover.md'),
-    description: 'Fredy will send new listings to your mobile using Pushover.',
+  description: 'Fredy will send new listings to your mobile using Pushover.',
-    fields: {
+  fields: {
-        token: {
+    token: {
-            type: 'text',
+      type: 'text',
-            label: 'API token',
+      label: 'API token',
-            description: 'Your application\'s API token.',
+      description: "Your application's API token.",
-        },
-        user: {
-            type: 'text',
-            label: 'User key',
-            description: 'Your user/group key.',
-        },
-        device: {
-            type: 'text',
-            label: 'Device name',
-            description: 'The device name to send your notification to. Messages may be addressed to multiple specific devices by joining them with a comma.',
-        },
     },
+    user: {
+      type: 'text',
+      label: 'User key',
+      description: 'Your user/group key.',
+    },
+    device: {
+      type: 'text',
+      label: 'Device name',
+      description:
+        'The device name to send your notification to. Messages may be addressed to multiple specific devices by joining them with a comma.',
+    },
+  },
 };

lib/notification/adapter/pushover.md

@@ -2,4 +2,4 @@
 
 Refer to the [instructions](https://support.pushover.net/i7-what-is-pushover-and-how-do-i-use-it) to set up your Pushover application.
 
-After setting up the application, please enter both your newly created User key and API token.
+After setting up the application, please enter both your newly created User key and API token.

lib/notification/adapter/sendGrid.js

@@ -1,24 +1,53 @@
 import sgMail from '@sendgrid/mail';
 import { markdown2Html } from '../../services/markdown.js';
+import { normalizeImageUrl } from '../../utils.js';
+
+const mapListings = (serviceName, jobKey, listings) =>
+  listings.map((l) => {
+    const image = normalizeImageUrl(l.image);
+    return {
+      title: l.title || '',
+      link: l.link || '',
+      address: l.address || '',
+      size: l.size || '',
+      price: l.price || '',
+      image,
+      hasImage: Boolean(image),
+      // optional plain text snippet
+      snippet: [l.address, l.price, l.size].filter(Boolean).join(' | '),
+      serviceName,
+      jobKey,
+    };
+  });
+
 export const send = ({ serviceName, newListings, notificationConfig, jobKey }) => {
   const { apiKey, receiver, from, templateId } = notificationConfig.find((adapter) => adapter.id === config.id).fields;
+
   sgMail.setApiKey(apiKey);
+
+  const to = receiver
+    .trim()
+    .split(',')
+    .map((r) => r.trim())
+    .filter(Boolean);
+
+  const listings = mapListings(serviceName, jobKey, newListings);
+
   const msg = {
     templateId,
-    to: receiver
+    to,
-      .trim()
-      .split(',')
-      .map((r) => r.trim()),
     from,
     subject: `Job ${jobKey} | Service ${serviceName} found ${newListings.length} new listing(s)`,
     dynamic_template_data: {
       serviceName: `Job: (${jobKey}) | Service: ${serviceName}`,
       numberOfListings: newListings.length,
-      listings: newListings,
+      listings,
     },
   };
+
   return sgMail.send(msg);
 };
+
 export const config = {
   id: 'sendgrid',
   name: 'SendGrid',

lib/notification/adapter/sendGrid.md

@@ -1,9 +1,8 @@
 ### SendGrid Adapter
 
- 
 SendGrid is a free email service (free as in "you cannot send more than 100(Sendgrid) and 200(Mailjet) emails a day"), which is more than enough for Fredy.
-   
+
-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.     
+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`.
 

lib/notification/adapter/slack.js

@@ -1,43 +1,61 @@
 import Slack from 'slack';
 import { markdown2Html } from '../../services/markdown.js';
-const msg = Slack.chat.postMessage;
+import { normalizeImageUrl } from '../../utils.js';
-export const send = ({ serviceName, newListings, notificationConfig, jobKey }) => {
+
-  const { token, channel } = notificationConfig.find((adapter) => adapter.id === config.id).fields;
+const buildBlocks = (serviceName, jobKey, p) => {
-  return newListings.map((payload) =>
+  const blocks = [
-    msg({
+    {
-      token,
+      type: 'header',
-      channel,
+      text: { type: 'plain_text', text: `New Listing from ${serviceName} (${jobKey})`, emoji: false },
-      text: `*(${serviceName} - ${jobKey})* - ${payload.title}`,
+    },
-      attachments: [
+    {
-        {
+      type: 'section',
-          fallback: payload.title,
+      text: { type: 'mrkdwn', text: `*<${p.link}|${p.title}>*` },
-          color: '#36a64f',
+    },
-          title: 'Link to Exposé',
+    {
-          title_link: payload.link,
+      type: 'section',
-          fields: [
+      fields: [
-            {
+        { type: 'mrkdwn', text: `*Price*\n${p.price ?? 'n/a'}` },
-              title: 'Price',
+        { type: 'mrkdwn', text: `*Size*\n${p.size ?? 'n/a'}` },
-              value: payload.price,
+        { type: 'mrkdwn', text: `*Address*\n${p.address ?? 'n/a'}` },
-              short: false,
-            },
-            {
-              title: 'Size',
-              value: payload.size,
-              short: false,
-            },
-            {
-              title: 'Address',
-              value: payload.address,
-              short: false,
-            },
-          ],
-          footer: 'Powered by Fredy',
-          ts: new Date().getTime() / 1000,
-        },
       ],
-    }),
+    },
+  ];
+
+  const img = normalizeImageUrl(p.image);
+  if (img) {
+    blocks.push({
+      type: 'image',
+      image_url: img,
+      alt_text: p.title || 'listing image',
+    });
+  }
+
+  blocks.push({
+    type: 'context',
+    elements: [{ type: 'mrkdwn', text: 'Powered by Fredy' }],
+  });
+
+  return blocks;
+};
+
+export const send = ({ serviceName, newListings, notificationConfig, jobKey }) => {
+  const { token, channel } = notificationConfig.find((a) => a.id === config.id).fields;
+
+  return Promise.allSettled(
+    newListings.map((p) =>
+      Slack.chat.postMessage({
+        token,
+        channel,
+        text: `${serviceName} ${jobKey}: ${p.title}`,
+        blocks: buildBlocks(serviceName, jobKey, p),
+        unfurl_links: false,
+        unfurl_media: false,
+      }),
+    ),
   );
 };
+
 export const config = {
   id: 'slack',
   name: 'Slack',

lib/notification/adapter/slack.md

@@ -1,6 +1,4 @@
 ### Slack Adapter
+IMPORTANT:
+Don't use this adapter anymore, it is outdated and only here for backwards compatability reasons. Use the new Slack Adapter with webhooks!
 
- 
-In order to use [Slack](https://slack.com), you need to create an account. When done, you need to create a new App in your workspace. Give it the permission `chat:write:bot` and `chat:write:user`.  
- 
-Now you need to create a user token and a channel. Make sure the bot is installed to this channel. 

lib/notification/adapter/slack_with_webhooks.js

@@ -0,0 +1,79 @@
+import fetch from 'node-fetch';
+import { markdown2Html } from '../../services/markdown.js';
+import { normalizeImageUrl } from '../../utils.js';
+
+const buildBlocks = (serviceName, jobKey, p) => {
+  const blocks = [
+    {
+      type: 'header',
+      text: { type: 'plain_text', text: `New Listing from ${serviceName} (${jobKey})`, emoji: false },
+    },
+    {
+      type: 'section',
+      text: { type: 'mrkdwn', text: `*<${p.link}|${p.title}>*` },
+    },
+    {
+      type: 'section',
+      fields: [
+        { type: 'mrkdwn', text: `*Price*\n${p.price ?? 'n/a'}` },
+        { type: 'mrkdwn', text: `*Size*\n${p.size ?? 'n/a'}` },
+        { type: 'mrkdwn', text: `*Address*\n${p.address ?? 'n/a'}` },
+      ],
+    },
+  ];
+
+  const img = normalizeImageUrl(p.image);
+  if (img) {
+    blocks.push({
+      type: 'image',
+      image_url: img,
+      alt_text: p.title || 'listing image',
+    });
+  }
+
+  blocks.push({
+    type: 'context',
+    elements: [{ type: 'mrkdwn', text: 'Powered by Fredy' }],
+  });
+
+  return blocks;
+};
+
+const postJson = (url, body) =>
+  fetch(url, {
+    method: 'POST',
+    headers: { 'Content-Type': 'application/json' },
+    body,
+  });
+
+export const send = ({ serviceName, newListings, notificationConfig, jobKey }) => {
+  const adapter = notificationConfig.find((a) => a.id === config.id);
+  const webhookUrl = adapter?.fields?.webhookUrl;
+  if (!webhookUrl) return Promise.resolve([]);
+
+  const promises = newListings.map((p) => {
+    const body = JSON.stringify({
+      text: `${serviceName} ${jobKey}: ${p.title}`,
+      blocks: buildBlocks(serviceName, jobKey, p),
+      unfurl_links: false,
+      unfurl_media: false,
+    });
+    return postJson(webhookUrl, body);
+  });
+
+  return Promise.allSettled(promises);
+};
+
+export const config = {
+  id: 'slack_with_webhooks',
+  name: 'Slack with Webhooks',
+  readme: markdown2Html('lib/notification/adapter/slack_with_webhooks.md'),
+  description: 'Fredy will send new listings to the slack channel of your choice..',
+  fields: {
+    webhookUrl: {
+      type: 'text',
+      label: 'Webhook-Url',
+      description: 'The Url of the Webhook to send messages to.',
+    },
+  },
+};

lib/notification/adapter/slack_with_webhooks.md

@@ -0,0 +1,6 @@
+### Slack Adapter
+
+IMPORTANT:
+This is the new version of the Slack adapter. I strongly encourage you to use it, the old version is now unmaintained and only kept due to backwards compatability reasons.
+
+In order to use [Slack](https://slack.com), you need to create an account. When done, create a new channel and add the Webhook integration to that channel. Copy the webhook url. That's it.

lib/notification/adapter/sqlite.js

@@ -2,7 +2,19 @@ import { markdown2Html } from '../../services/markdown.js';
 import Database from 'better-sqlite3';
 export const send = ({ serviceName, newListings, jobKey }) => {
   const db = new Database('db/listings.db');
-  const fields = ['serviceName', 'jobKey', 'id', 'size', 'rooms', 'price', 'address', 'title', 'link', 'description'];
+  const fields = [
+    'serviceName',
+    'jobKey',
+    'id',
+    'size',
+    'rooms',
+    'price',
+    'address',
+    'title',
+    'link',
+    'description',
+    'image',
+  ];
   db.prepare(`CREATE TABLE IF NOT EXISTS listing (${fields.join(' TEXT, ')} TEXT);`).run();
   const insert = db.prepare(`INSERT INTO listing (${fields.join(', ')}) VALUES (@${fields.join(', @')})`);
   newListings.map((listing) => {

lib/notification/adapter/sqlite.md

@@ -1,7 +1,9 @@
 ### Sqlite Adapter
-This adapter stores search results in a sqlite database located in db/listings.db. This file can be used for further analysis later on.   
+
+This adapter stores search results in a sqlite database located in db/listings.db. This file can be used for further analysis later on.
 
 Fields are:
+
 ```
 ['serviceName', 'jobKey', 'id', 'size', 'rooms', 'price', 'address', 'title', 'link', 'description']
-```
+```

lib/notification/adapter/telegram.js

@@ -1,63 +1,108 @@
 import { markdown2Html } from '../../services/markdown.js';
 import { getJob } from '../../services/storage/jobStorage.js';
 import fetch from 'node-fetch';
-const MAX_ENTITIES_PER_CHUNK = 8;
+import pThrottle from 'p-throttle';
-const RATE_LIMIT_INTERVAL = 1010;
+import { normalizeImageUrl } from '../../utils.js';
-/**
+
- * splitting an array into chunks because Telegram only allows for messages up to
+const RATE_LIMIT_INTERVAL = 1000;
- * 4096 chars, thus we have to split messages into chunks
+const chatThrottleMap = new Map();
- * @param inputArray
+
- * @param perChunk
+function cleanupOldThrottles() {
- */
+  const now = Date.now();
-const arrayChunks = (inputArray, perChunk) =>
+  const maxAge = RATE_LIMIT_INTERVAL + 1000;
-  inputArray.reduce((all, one, i) => {
+  const toBeDeleted = [];
-    const ch = Math.floor(i / perChunk);
+  for (const [chatId, chatThrottle] of chatThrottleMap.entries()) {
-    all[ch] = [].concat(all[ch] || [], one);
+    if (now - chatThrottle.lastUsedAt > maxAge) toBeDeleted.push(chatId);
-    return all;
+  }
-  }, []);
+  for (const chatId of toBeDeleted) chatThrottleMap.delete(chatId);
-function shorten(str, len = 30) {
-  return str.length > len ? str.substring(0, len) + '...' : str;
 }
+
+function getThrottled(chatId, call) {
+  cleanupOldThrottles();
+  const now = Date.now();
+  const chatThrottle = chatThrottleMap.get(chatId);
+  if (chatThrottle) {
+    chatThrottle.lastUsedAt = now;
+    return chatThrottle.throttled;
+  }
+  const throttled = pThrottle({ limit: 1, interval: RATE_LIMIT_INTERVAL })(call);
+  chatThrottleMap.set(chatId, { lastUsedAt: now, throttled });
+  return throttled;
+}
+
+function shorten(str, len = 90) {
+  if (!str) return '';
+  return str.length > len ? str.substring(0, len).trim() + '...' : str;
+}
+
+function escapeHtml(s = '') {
+  return s.replace(/&/g, '&amp;').replace(/</g, '&lt;').replace(/>/g, '&gt;');
+}
+
+function buildCaption(jobName, serviceName, o) {
+  const title = shorten((o.title || '').replace(/\*/g, ''), 90);
+  const meta = [o.address, o.price, o.size].filter(Boolean).join(' | ');
+  return `<i>${escapeHtml(jobName)}</i> (${escapeHtml(serviceName)})\n<a href='${escapeHtml(
+    o.link || '',
+  )}'><b>${escapeHtml(title)}</b></a>\n${escapeHtml(meta)}`.slice(0, 1024);
+}
+
+function buildText(jobName, serviceName, o) {
+  const title = shorten((o.title || '').replace(/\*/g, ''), 90);
+  const meta = [o.address, o.price, o.size].filter(Boolean).join(' | ');
+  return (
+    `<i>${escapeHtml(jobName)}</i> (${escapeHtml(serviceName)})\n` +
+    `<a href='${escapeHtml(o.link || '')}'><b>${escapeHtml(title)}</b></a>\n` +
+    `${escapeHtml(meta)}`
+  );
+}
+
 export const send = ({ serviceName, newListings, notificationConfig, jobKey }) => {
   const { token, chatId } = notificationConfig.find((adapter) => adapter.id === config.id).fields;
   const job = getJob(jobKey);
   const jobName = job == null ? jobKey : job.name;
-  //we have to split messages into chunk, because otherwise messages are going to become too big and will fail
+
-  const chunks = arrayChunks(newListings, MAX_ENTITIES_PER_CHUNK);
+  const throttledCall = getThrottled(chatId, async function (endpoint, body) {
-  const promises = chunks.map((chunk) => {
+    const res = await fetch(`https://api.telegram.org/bot${token}/${endpoint}`, {
-    let message = `<i>${jobName}</i> (${serviceName}) found <b>${newListings.length}</b> new listings:\n\n`;
+      method: 'post',
-    message += chunk.map(
+      body: JSON.stringify(body),
-      (o) =>
+      headers: { 'Content-Type': 'application/json' },
-        `<a href='${o.link}'><b>${shorten(o.title.replace(/\*/g, ''), 45).trim()}</b></a>\n` +
-        [o.address, o.price, o.size].join(' | ') +
-        '\n\n',
-    );
-    /**
-     * This is to not break the rate limit. It is to only send 1 message per second
-     */
-    return new Promise((resolve, reject) => {
-      setTimeout(() => {
-        fetch(`https://api.telegram.org/bot${token}/sendMessage`, {
-          method: 'post',
-          body: JSON.stringify({
-            chat_id: chatId,
-            text: message,
-            parse_mode: 'HTML',
-            disable_web_page_preview: true,
-          }),
-          headers: { 'Content-Type': 'application/json' },
-        })
-          .then(() => {
-            resolve();
-          })
-          .catch(() => {
-            reject();
-          });
-      }, RATE_LIMIT_INTERVAL);
     });
+    return res;
   });
+
+  const promises = newListings.map(async (o) => {
+    const img = normalizeImageUrl(o.image);
+    const textPayload = {
+      chat_id: chatId,
+      text: buildText(jobName, serviceName, o),
+      parse_mode: 'HTML',
+      disable_web_page_preview: true,
+    };
+
+    if (!img) {
+      return throttledCall('sendMessage', textPayload);
+    }
+
+    try {
+      return await throttledCall('sendPhoto', {
+        chat_id: chatId,
+        photo: img,
+        caption: buildCaption(jobName, serviceName, o),
+        parse_mode: 'HTML',
+      });
+    } catch (e) {
+      // If we see a timeout due to sending an image, try sending it without
+      if (e && (e.code === 'ETIMEDOUT' || e.errno === 'ETIMEDOUT')) {
+        return throttledCall('sendMessage', textPayload);
+      }
+      throw e;
+    }
+  });
+
   return Promise.all(promises);
 };
+
 export const config = {
   id: 'telegram',
   name: 'Telegram',

lib/notification/adapter/telegram.md

@@ -1,13 +1,12 @@
 ### Telegram Adapter
 
- 
 For Telegram, you need to create a Bot. This is pretty easy. Open [this](https://telegram.me/BotFather) url on your smartphone and follow the instructions.
-  
-A telegram bot is not allowed to send messages directly to a user, you as a user need to first contact the bot to get a chatId.        
-After the user has send a message to your bot the first time, you can gather the chatId like this:   
 
-```  
+A telegram bot is not allowed to send messages directly to a user, you as a user need to first contact the bot to get a chatId.  
-curl -X GET https://api.telegram.org/bot{YOUR_TELEGRAM_TOKEN}/getUpdates  
+After the user has send a message to your bot the first time, you can gather the chatId like this:
-```  
+
-  
+```
+curl -X GET https://api.telegram.org/bot{YOUR_TELEGRAM_TOKEN}/getUpdates
+```
+
 A more detailed list of instructions can be found here [https://core.telegram.org/bots#botfather](https://core.telegram.org/bots#botfather)

lib/notification/emailTemplate/mailjet.hbs

@@ -0,0 +1,123 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
+<head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+    <title>Listings</title>
+    <style type="text/css">
+        body { margin:0; padding:0; background:#000000; }
+        table { border-collapse:collapse; }
+        img { border:0; outline:none; text-decoration:none; display:block; }
+        a { text-decoration:none; }
+        .container { width:100%; max-width:640px; margin:0 auto; }
+        .card { background:#111111; border:1px solid #222222; border-radius:8px; overflow:hidden; }
+        .divider { height:2px; line-height:2px; font-size:0; background:#00dc73; }
+        .h1 { font:700 18px/1.4 Arial, Helvetica, sans-serif; color:#ffffff; margin:0; }
+        .h2 { font:700 16px/1.4 Arial, Helvetica, sans-serif; color:#ffffff; margin:0; }
+        .p { font:400 14px/1.6 Arial, Helvetica, sans-serif; color:#d9d9d9; margin:0; }
+        .meta { font:400 13px/1.5 Arial, Helvetica, sans-serif; color:#bfbfbf; }
+        .btn { background:#00dc73; color:#0b0b0b; font:700 14px/1 Arial, Helvetica, sans-serif; padding:12px 18px; border-radius:6px; display:inline-block; }
+        .sp-8 { height:8px; line-height:8px; font-size:0; }
+        .sp-12 { height:12px; line-height:12px; font-size:0; }
+        .sp-16 { height:16px; line-height:16px; font-size:0; }
+        .sp-20 { height:20px; line-height:20px; font-size:0; }
+        .sp-24 { height:24px; line-height:24px; font-size:0; }
+        @media screen and (max-width:480px){
+            .container { width:100% !important; }
+            .stack { display:block !important; width:100% !important; }
+        }
+    </style>
+</head>
+<body style="background:#000000;">
+<table role="presentation" width="100%" bgcolor="#000000">
+    <tr>
+        <td align="center">
+            <table role="presentation" class="container" width="640">
+                <tr><td class="sp-20"></td></tr>
+
+                <tr>
+                    <td align="center">
+                        <h1 class="h1" style="text-align:center;">
+                            Service {{serviceName}} found {{numberOfListings}} new listings
+                        </h1>
+                    </td>
+                </tr>
+
+                <tr><td class="sp-12"></td></tr>
+                <tr><td class="divider"></td></tr>
+                <tr><td class="sp-16"></td></tr>
+
+                {{#each listings}}
+                    <tr>
+                        <td>
+                            <table role="presentation" class="card" width="100%">
+                                {{#if this.hasImage}}
+                                    <tr>
+                                        <td>
+                                            <a href="{{this.link}}" target="_blank">
+                                                <img src="cid:{{this.imageCid}}" alt="{{this.title}}" width="640"
+                                                     style="width:100%; height:auto; background:#1a1a1a;" />
+                                            </a>
+                                        </td>
+                                    </tr>
+                                {{/if}}
+
+                                <tr>
+                                    <td style="padding:16px 18px 0 18px;">
+                                        <a href="{{this.link}}" target="_blank" style="color:#ffffff;">
+                                            <h2 class="h2">{{this.title}}</h2>
+                                        </a>
+                                    </td>
+                                </tr>
+
+                                <tr><td class="sp-8"></td></tr>
+
+                                <tr>
+                                    <td style="padding:0 18px;">
+                                        <table role="presentation" width="100%">
+                                            <tr>
+                                                <td class="stack" style="vertical-align:top; width:50%; padding-right:8px;">
+                                                    <p class="meta"><strong>Price</strong><br/>{{#if this.price}}{{this.price}}{{else}}unknown{{/if}}</p>
+                                                </td>
+                                                <td class="stack" style="vertical-align:top; width:50%; padding-left:8px;">
+                                                    <p class="meta"><strong>Size</strong><br/>{{#if this.size}}{{this.size}}{{else}}unknown{{/if}}</p>
+                                                </td>
+                                            </tr>
+                                            <tr><td class="sp-8"></td><td class="sp-8"></td></tr>
+                                            <tr>
+                                                <td colspan="2">
+                                                    <p class="meta"><strong>Address</strong><br/>{{#if this.address}}{{this.address}}{{else}}unknown{{/if}}</p>
+                                                </td>
+                                            </tr>
+                                        </table>
+                                    </td>
+                                </tr>
+
+                                <tr><td class="sp-16"></td></tr>
+
+                                <tr>
+                                    <td align="left" style="padding:0 18px 18px 18px;">
+                                        <a href="{{this.link}}" class="btn" target="_blank">View Listing</a>
+                                    </td>
+                                </tr>
+                            </table>
+                        </td>
+                    </tr>
+                    <tr><td class="sp-24"></td></tr>
+                {{/each}}
+
+                <tr><td class="divider"></td></tr>
+                <tr><td class="sp-16"></td></tr>
+                <tr>
+                    <td align="center">
+                        <p class="p" style="color:#9f9f9f;">Powered by Fredy</p>
+                    </td>
+                </tr>
+                <tr><td class="sp-20"></td></tr>
+            </table>
+        </td>
+    </tr>
+</table>
+</body>
+</html>

lib/notification/emailTemplate/template.hbs

@@ -1,237 +1,131 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html data-editor-version="2" class="sg-campaigns" xmlns="http://www.w3.org/1999/xhtml"><head>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
-    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
-    <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1, maximum-scale=1">
+<head>
-    <!--[if !mso]><!-->
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <meta http-equiv="X-UA-Compatible" content="IE=Edge">
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
-    <!--<![endif]-->
+    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
-    <!--[if (gte mso 9)|(IE)]>
+    <title>Fredy found some new listings</title>
-    <xml>
-        <o:OfficeDocumentSettings>
-            <o:AllowPNG/>
-            <o:PixelsPerInch>96</o:PixelsPerInch>
-        </o:OfficeDocumentSettings>
-    </xml>
-    <![endif]-->
-    <!--[if (gte mso 9)|(IE)]>
     <style type="text/css">
-        body {width: 600px;margin: 0 auto;}
+        body { margin:0; padding:0; background:#000000; }
-        table {border-collapse: collapse;}
+        table { border-collapse:collapse; }
-        table, td {mso-table-lspace: 0pt;mso-table-rspace: 0pt;}
+        img { border:0; outline:none; text-decoration:none; display:block; }
-        img {-ms-interpolation-mode: bicubic;}
+        a { text-decoration:none; }
-    </style>
+        .container { width:100%; max-width:640px; margin:0 auto; }
-    <![endif]-->
+        .card { background:#111111; border:1px solid #222222; border-radius:8px; overflow:hidden; }
-    <style type="text/css">
+        .divider { height:2px; line-height:2px; font-size:0; background:#00dc73; }
-        body, p, div {
+        .h1 { font:700 18px/1.4 Arial, Helvetica, sans-serif; color:#ffffff; margin:0; }
-            font-family: arial,helvetica,sans-serif;
+        .h2 { font:700 16px/1.4 Arial, Helvetica, sans-serif; color:#ffffff; margin:0; }
-            font-size: 14px;
+        .p { font:400 14px/1.6 Arial, Helvetica, sans-serif; color:#d9d9d9; margin:0; }
-        }
+        .meta { font:400 13px/1.5 Arial, Helvetica, sans-serif; color:#bfbfbf; }
-        body {
+        .btn { background:#00dc73; color:#0b0b0b; font:700 14px/1 Arial, Helvetica, sans-serif; padding:12px 18px; border-radius:6px; display:inline-block; }
-            color: #000000;
+        .sp-8 { height:8px; line-height:8px; font-size:0; }
-        }
+        .sp-12 { height:12px; line-height:12px; font-size:0; }
-        body a {
+        .sp-16 { height:16px; line-height:16px; font-size:0; }
-            color: #42ee99;
+        .sp-20 { height:20px; line-height:20px; font-size:0; }
-            text-decoration: none;
+        .sp-24 { height:24px; line-height:24px; font-size:0; }
-        }
+        @media screen and (max-width:480px){
-        p { margin: 0; padding: 0; }
+            .container { width:100% !important; }
-        table.wrapper {
+            .stack { display:block !important; width:100% !important; }
-            width:100% !important;
-            table-layout: fixed;
-            -webkit-font-smoothing: antialiased;
-            -webkit-text-size-adjust: 100%;
-            -moz-text-size-adjust: 100%;
-            -ms-text-size-adjust: 100%;
-        }
-        img.max-width {
-            max-width: 100% !important;
-        }
-        .column.of-2 {
-            width: 50%;
-        }
-        .column.of-3 {
-            width: 33.333%;
-        }
-        .column.of-4 {
-            width: 25%;
-        }
-        @media screen and (max-width:480px) {
-            .preheader .rightColumnContent,
-            .footer .rightColumnContent {
-                text-align: left !important;
-            }
-            .preheader .rightColumnContent div,
-            .preheader .rightColumnContent span,
-            .footer .rightColumnContent div,
-            .footer .rightColumnContent span {
-                text-align: left !important;
-            }
-            .preheader .rightColumnContent,
-            .preheader .leftColumnContent {
-                font-size: 80% !important;
-                padding: 5px 0;
-            }
-            table.wrapper-mobile {
-                width: 100% !important;
-                table-layout: fixed;
-            }
-            img.max-width {
-                height: auto !important;
-                max-width: 100% !important;
-            }
-            a.bulletproof-button {
-                display: block !important;
-                width: auto !important;
-                font-size: 80%;
-                padding-left: 0 !important;
-                padding-right: 0 !important;
-            }
-            .columns {
-                width: 100% !important;
-            }
-            .column {
-                display: block !important;
-                width: 100% !important;
-                padding-left: 0 !important;
-                padding-right: 0 !important;
-                margin-left: 0 !important;
-                margin-right: 0 !important;
-            }
         }
     </style>
-    <!--user entered Head Start-->
-
-    <!--End Head user entered-->
 </head>
-<body>
+<body style="background:#000000;">
-<center class="wrapper" data-link-color="#42ee99" data-body-style="font-size:14px; font-family:arial,helvetica,sans-serif; color:#000000; background-color:#000000;">
+<table role="presentation" width="100%" bgcolor="#000000">
-    <div class="webkit">
+    <tr>
-        <table cellpadding="0" cellspacing="0" border="0" width="100%" class="wrapper" bgcolor="#000000">
+        <td align="center">
-            <tbody><tr>
+            <table role="presentation" class="container" width="640">
-                <td valign="top" bgcolor="#000000" width="100%">
+                <tr><td class="sp-20"></td></tr>
-                    <table width="100%" role="content-container" class="outer" align="center" cellpadding="0" cellspacing="0" border="0">
+                <tr>
-                        <tbody><tr>
+                    <td align="center">
-                            <td width="100%">
+                        <table role="presentation" width="100%">
-                                <table width="100%" cellpadding="0" cellspacing="0" border="0">
+                            <tr>
-                                    <tbody><tr>
+                                <td align="center">
+                                    <h1 class="h1" style="text-align:center;">
+                                        Service {{serviceName}} found {{numberOfListings}} new listings
+                                    </h1>
+                                </td>
+                            </tr>
+                            <tr><td class="sp-12"></td></tr>
+                            <tr><td class="divider"></td></tr>
+                            <tr><td class="sp-16"></td></tr>
+                        </table>
+                    </td>
+                </tr>
+
+                {{#each listings}}
+                    <tr>
+                        <td>
+                            <table role="presentation" class="card" width="100%">
+                                {{#if this.hasImage}}
+                                    <tr>
                                         <td>
-                                            <!--[if mso]>
+                                            <a href="{{this.link}}" target="_blank">
-                                            <center>
+                                                <img src="{{this.image}}" alt="{{this.title}}" width="640" style="width:100%;height:auto;background:#1a1a1a;" />
-                                                <table><tr><td width="600">
+                                            </a>
-                                            <![endif]-->
+                                        </td>
-                                            <table width="100%" cellpadding="0" cellspacing="0" border="0" style="width:100%; max-width:600px;" align="center">
+                                    </tr>
-                                                <tbody><tr>
+                                {{/if}}
-                                                    <td role="modules-container" style="padding:0px 0px 0px 0px; color:#000000; text-align:left;" bgcolor="#FFFFFF" width="100%" align="left"><table class="module preheader preheader-hide" role="module" data-type="preheader" border="0" cellpadding="0" cellspacing="0" width="100%" style="display: none !important; mso-hide: all; visibility: hidden; opacity: 0; color: transparent; height: 0; width: 0;">
+                                <tr>
-                                                    </table><table class="module" role="module" data-type="spacer" border="0" cellpadding="0" cellspacing="0" width="100%" style="table-layout: fixed;" data-muid="vB9TDziyvx65CC2nx3oyRH">
+                                    <td style="padding:16px 18px 0 18px;">
-                                                        <tbody><tr>
+                                        <a href="{{this.link}}" target="_blank" style="color:#ffffff;">
-                                                            <td style="padding:0px 0px 20px 0px;" role="module-content" bgcolor="#000000">
+                                            <h2 class="h2">{{this.title}}</h2>
-                                                            </td>
+                                        </a>
-                                                        </tr>
-                                                        </tbody></table><table class="wrapper" role="module" data-type="image" border="0" cellpadding="0" cellspacing="0" width="100%" style="table-layout: fixed;" data-muid="uXsDxMnn1bRMmDcX8NB6rW">
-                                                    </table><table class="module" role="module" data-type="text" border="0" cellpadding="0" cellspacing="0" width="100%" style="table-layout: fixed;" data-muid="hL6wjQ2qknNd5qDwT1p7Up">
-                                                        <tbody><tr>
-                                                            <td style="background-color:#000000; padding:10px 20px 10px 20px; line-height:40px; text-align:justify;" height="100%" valign="top" bgcolor="#000000"><div><h1 style="text-align: center"><span style="color: #ffffff; font-size: 14px; font-family: verdana,geneva,sans-serif"><strong>Service {{serviceName}} found {{numberOfListings}} new listing(s)!</strong></span></h1><div></div></div></td>
-                                                        </tr>
-                                                        </tbody></table>
-
-                                                        <table border="0" cellpadding="0" cellspacing="0" align="center" width="100%" height="1px" style="line-height:3px; font-size:3px;">
-                                                            <tbody><tr>
-                                                                <td style="padding:0px 0px 1px 0px;" bgcolor="#42ee99"></td>
-                                                            </tr>
-                                                            </tbody></table>
-                                                    </td>
-                                                </tr>
-                                                </tbody>
-                                            </table>
-
-                                            <table class="module" role="module" data-type="text" border="0" cellpadding="0" cellspacing="0" width="100%" style="table-layout: fixed;" data-muid="qk51Jjn4bm3rn2Yb31Dxzb">
-                                                <tbody>
-                                                {{#each listings}}
-                                                    <tr>
-                                                        <td style="padding:50px 50px 10px 50px; line-height:22px; text-align:center; color:white" bgcolor="#000000" height="100%" valign="top">
-                                                            <div>
-                                                                <span style="font-size: 12px; font-family: verdana,geneva,sans-serif; color: white;"><b>{{this.title}}</b></span>
-                                                                <br/>
-                                                                <span style="font-size: 12px; font-family: verdana,geneva,sans-serif; color: white;">Size: {{#if this.size}}{{this.size}}{{else}}unknown{{/if}}</span>
-                                                                <br/>
-                                                                <span style="font-size: 12px; font-family: verdana,geneva,sans-serif; color: white;">Price: {{#if this.price}}{{this.price}}{{else}}unknown{{/if}}</span>
-                                                                <br/>
-                                                                <span style="font-size: 12px; font-family: verdana,geneva,sans-serif; color: white;">{{#if this.address}}{{this.address}}{{else}}unknown{{/if}}</span>
-                                                                <br/>
-                                                                <a href="{{this.link}}" target="_blank" style="color:#00dc73; font-size:13px">{{this.link}}</a>
-                                                                <br/>
-                                                                <span style="color: white;">---------------------------</span>
-                                                            </div>
-                                                        </td>
-                                                    </tr>
-                                                {{/each}}
-                                                </tbody>
-                                            </table>
-
-                                            <table class="module" role="module" data-type="spacer" border="0" cellpadding="0" cellspacing="0" width="100%" style="table-layout: fixed;" data-muid="2ga5f7koD5ApvUfnqUK6aT">
-                                                <tbody><tr>
-                                                    <td style="padding:0px 0px 30px 0px;" role="module-content" bgcolor="#000000">
-                                                    </td>
-                                                </tr>
-                                                </tbody></table>
-                                            <table class="module" role="module" data-type="divider" border="0" cellpadding="0" cellspacing="0" width="100%" style="table-layout: fixed;" data-muid="c3nRrjMndqXf1snYDFPSF9">
-                                                <tbody><tr>
-                                                    <td style="padding:0px 0px 0px 0px;" role="module-content" height="100%" valign="top" bgcolor="#000000">
-                                                        <table border="0" cellpadding="0" cellspacing="0" align="center" width="100%" height="2px" style="line-height:1px; font-size:2px;">
-                                                            <tbody><tr>
-                                                                <td style="padding:0px 0px 2px 0px;" bgcolor="#42ee99"></td>
-                                                            </tr>
-                                                            </tbody></table>
-                                                    </td>
-                                                </tr>
-                                                </tbody>
-                                            </table>
-                                            <table class="module" role="module" data-type="spacer" border="0" cellpadding="0" cellspacing="0" width="100%" style="table-layout: fixed;" data-muid="pa9PeYjCEFyByuP5878Sd2">
-                                                <tbody><tr>
-                                                    <td style="padding:0px 0px 30px 0px;" role="module-content" bgcolor="#000000">
-                                                    </td>
-                                                </tr>
-                                                </tbody></table>
-
-                                            <table class="module" role="module" data-type="social" align="center" border="0" cellpadding="0" cellspacing="0" width="100%" style="table-layout: fixed;" data-muid="n7FceQWVnLmounEt32B1gj">
-                                                <tbody>
-                                                <tr>
-                                                    <td valign="top" style="padding:0px 0px 0px 0px; font-size:6px; line-height:10px; background-color:#000000;" align="center">
-                                                        <table align="center">
-                                                            <tbody>
-                                                            <tr><td style="padding: 0px 5px;">
-                                                                <a href="https://github.com/orangecoding/fredy" target="_blank" alt="Fredy" title="Powered by Fredy" style="color:#00dc73; font-size:17px">
-                                                                    Powered by Fredy
-                                                                </a>
-                                                            </td></tr>
-                                                            </tbody>
-                                                        </table>
-                                                    </td>
-                                                </tr>
-                                                </tbody>
-                                            </table></table><table class="module" role="module" data-type="spacer" border="0" cellpadding="0" cellspacing="0" width="100%" style="table-layout: fixed;" data-muid="35xFa9abxGTBYt9yR9BeQ2">
-                                <tbody><tr>
-                                    <td style="padding:0px 0px 30px 0px;" role="module-content" bgcolor="#000000">
                                     </td>
                                 </tr>
-                                </tbody></table></td>
+                                <tr><td class="sp-8"></td></tr>
-                        </tr>
+                                <tr>
-                        </tbody></table>
+                                    <td style="padding:0 18px;">
-                    <!--[if mso]>
+                                        <table role="presentation" width="100%">
-                    </td>
+                                            <tr>
-                    </tr>
+                                                <td class="stack" style="vertical-align:top; width:50%; padding-right:8px;">
-                    </table>
+                                                    <p class="meta"><strong>Price</strong><br/>{{#if this.price}}{{this.price}}{{else}}unknown{{/if}}</p>
-                    </center>
+                                                </td>
+                                                <td class="stack" style="vertical-align:top; width:50%; padding-left:8px;">
+                                                    <p class="meta"><strong>Size</strong><br/>{{#if this.size}}{{this.size}}{{else}}unknown{{/if}}</p>
+                                                </td>
+                                            </tr>
+                                            <tr><td class="sp-8"></td><td class="sp-8"></td></tr>
+                                            <tr>
+                                                <td colspan="2">
+                                                    <p class="meta"><strong>Address</strong><br/>{{#if this.address}}{{this.address}}{{else}}unknown{{/if}}</p>
+                                                </td>
+                                            </tr>
+                                        </table>
+                                    </td>
+                                </tr>
+                                <tr><td class="sp-16"></td></tr>
+                                <tr>
+                                    <td align="left" style="padding:0 18px 18px 18px;">
+                                        <!--[if mso]>
+                    <v:roundrect xmlns:v="urn:schemas-microsoft-com:vml" href="{{this.link}}" arcsize="8%" strokecolor="#00dc73" strokeweight="0" fillcolor="#00dc73" style="height:40px;v-text-anchor:middle;width:180px;">
+                      <w:anchorlock/>
+                      <center style="color:#0b0b0b;font-family:Arial;font-size:14px;font-weight:bold;">
+                        View Listing
+                      </center>
+                    </v:roundrect>
                     <![endif]-->
-                </td>
+                                        <!--[if !mso]><!-- -->
-            </tr>
+                                        <a href="{{this.link}}" class="btn" target="_blank">View Listing</a>
-            </tbody></table>
+                                        <!--<![endif]-->
-        </td>
+                                    </td>
-        </tr>
+                                </tr>
-        </tbody></table>
+                            </table>
-        </td>
+                        </td>
-        </tr>
+                    </tr>
-        </tbody></table>
+                    <tr><td class="sp-24"></td></tr>
-    </div>
+                {{/each}}
-</center>
 
-
+                <tr><td class="divider"></td></tr>
-</body></html>
+                <tr><td class="sp-16"></td></tr>
+                <tr>
+                    <td align="center">
+                        <p class="p" style="color:#9f9f9f;">Powered by Fredy</p>
+                    </td>
+                </tr>
+                <tr><td class="sp-20"></td></tr>
+            </table>
+        </td>
+    </tr>
+</table>
+</body>
+</html>

lib/notification/notify.js

@@ -6,7 +6,7 @@ const adapter = await Promise.all(
   fs
     .readdirSync('./lib/notification/adapter')
     .filter((file) => file.endsWith('.js'))
-    .map(async (integPath) => await import(`${path}/${integPath}`))
+    .map(async (integPath) => await import(`${path}/${integPath}`)),
 );
 
 if (adapter.length === 0) {

lib/provider/einsAImmobilien.js

@@ -2,10 +2,12 @@ import utils, { buildHash } from '../utils.js';
 let appliedBlackList = [];
 
 function normalize(o) {
-  const link = `https://www.1a-immobilienmarkt.de/expose/${o.id}.html`;
+  const baseUrl = 'https://www.1a-immobilienmarkt.de';
+  const link = `${baseUrl}/expose/${o.id}.html`;
   const price = normalizePrice(o.price);
   const id = buildHash(o.id, price);
-  return Object.assign(o, { id, price, link });
+  const image = baseUrl + o.image;
+  return Object.assign(o, { id, price, link, image });
 }
 
 /**
@@ -41,6 +43,7 @@ const config = {
     price: '.inner_object_data .single_data_price | removeNewline | trim',
     size: '.tabelle .tabelle_inhalt_infos .single_data_box  | removeNewline | trim',
     title: '.inner_object_data .tabelle_inhalt_titel_black | removeNewline | trim',
+    image: '.inner_object_pic img@src',
   },
   normalize: normalize,
   filter: applyBlacklist,

lib/provider/immobilienDe.js

@@ -1,26 +1,34 @@
-import utils, {buildHash} from '../utils.js';
+import utils, { buildHash } from '../utils.js';
+
 let appliedBlackList = [];
+
 function shortenLink(link) {
   return link.substring(0, link.indexOf('?'));
 }
+
 function parseId(shortenedLink) {
   return shortenedLink.substring(shortenedLink.lastIndexOf('/') + 1);
 }
+
 function normalize(o) {
+  const baseUrl = 'https://www.immobilien.de';
   const size = o.size || 'N/A m²';
   const price = o.price || 'N/A €';
   const title = o.title || 'No title available';
   const address = o.address || 'No address available';
   const shortLink = shortenLink(o.link);
-  const link = `https://www.immobilien.de/${shortLink}`;
+  const link = `${baseUrl}/${shortLink}`;
+  const image = baseUrl + o.image;
   const id = buildHash(parseId(shortLink), o.price);
-  return Object.assign(o, { id, price, size, title, address, link });
+  return Object.assign(o, { id, price, size, title, address, link, image });
 }
+
 function applyBlacklist(o) {
   const titleNotBlacklisted = !utils.isOneOf(o.title, appliedBlackList);
   const descNotBlacklisted = !utils.isOneOf(o.description, appliedBlackList);
   return titleNotBlacklisted && descNotBlacklisted;
 }
+
 const config = {
   url: null,
   crawlContainer: '._ref',
@@ -34,6 +42,7 @@ const config = {
     description: '.list_entry .description | trim',
     link: '@href',
     address: '.list_entry .place',
+    image: '.list_entry img@src',
   },
   normalize: normalize,
   filter: applyBlacklist,

lib/provider/immonet.js

@@ -11,7 +11,7 @@ let appliedBlackList = [];
 function normalize(o) {
   const size = o.size != null ? o.size.replace('Wohnfläche ', '') : 'N/A m²';
   const price = o.price.replace('Kaufpreis ', '');
-  const address = o.address.split(' • ')[o.address.split(' • ').length - 1];
+  const address = o.address?.split(' • ')?.pop() ?? null;
   const title = o.title || 'No title available';
   const link = config.url;
   const id = buildHash(title, price);
@@ -33,6 +33,7 @@ const config = {
     price: 'div[data-testid="cardmfe-price-testid"] | trim',
     size: 'div[data-testid="cardmfe-keyfacts-testid"] | trim',
     address: 'div[data-testid="cardmfe-description-box-address"] | trim',
+    image: 'div[data-testid="cardmfe-picture-box-test-id"] img@src',
   },
   normalize: normalize,
   filter: applyBlacklist,

lib/provider/immoscout.js

@@ -36,7 +36,8 @@
  */
 
 import utils, { buildHash } from '../utils.js';
-import { convertWebToMobile } from '../services/immoscout/immoscout-web-translater.js';
+import { convertWebToMobile } from '../services/immoscout/immoscout-web-translator.js';
+import logger from '../services/logger.js';
 let appliedBlackList = [];
 
 async function getListings(url) {
@@ -52,7 +53,7 @@ async function getListings(url) {
     }),
   });
   if (!response.ok) {
-    console.error('Error fetching data from ImmoScout Mobile API:', response.statusText);
+    logger.error('Error fetching data from ImmoScout Mobile API:', response.statusText);
     return [];
   }
 
@@ -62,6 +63,7 @@ async function getListings(url) {
     .map((expose) => {
       const item = expose.item;
       const [price, size] = item.attributes;
+      const image = item?.titlePicture?.preview ?? null;
       return {
         id: item.id,
         price: price?.value,
@@ -69,6 +71,7 @@ async function getListings(url) {
         title: item.title,
         link: `${metaInformation.baseUrl}expose/${item.id}`,
         address: item.address?.line,
+        image,
       };
     });
 }

lib/provider/immoswp.js

@@ -31,6 +31,7 @@ const config = {
     title: '.js-item-title-link@title | trim',
     link: '.ci-search-result__link@href',
     description: '.js-show-more-item-sm | removeNewline | trim',
+    image: 'img@src',
   },
   normalize: normalize,
   filter: applyBlacklist,

lib/provider/immowelt.js

@@ -26,6 +26,7 @@ const config = {
     title: 'div[data-testid="cardmfe-description-box-text-test-id"] > div:nth-of-type(2)',
     link: 'a@href',
     address: 'div[data-testid="cardmfe-description-box-address"] | removeNewline | trim',
+    image: 'div[data-testid="cardMfe-card-pictureBox-opacity"] img@src',
   },
   normalize: normalize,
   filter: applyBlacklist,

lib/provider/kleinanzeigen.js

@@ -1,50 +1,51 @@
-import utils, {buildHash} from '../utils.js';
+import utils, { buildHash } from '../utils.js';
 
 let appliedBlackList = [];
 let appliedBlacklistedDistricts = [];
 
 function normalize(o) {
-    const size = o.size || '--- m²';
+  const size = o.size || '--- m²';
-    const id = buildHash(o.id, o.price);
+  const id = buildHash(o.id, o.price);
-    const link = `https://www.kleinanzeigen.de${o.link}`;
+  const link = `https://www.kleinanzeigen.de${o.link}`;
-    return Object.assign(o, {id, size, link});
+  return Object.assign(o, { id, size, link });
 }
 
 function applyBlacklist(o) {
-    const titleNotBlacklisted = !utils.isOneOf(o.title, appliedBlackList);
+  const titleNotBlacklisted = !utils.isOneOf(o.title, appliedBlackList);
-    const descNotBlacklisted = !utils.isOneOf(o.description, appliedBlackList);
+  const descNotBlacklisted = !utils.isOneOf(o.description, appliedBlackList);
-    const isBlacklistedDistrict =
+  const isBlacklistedDistrict =
-        appliedBlacklistedDistricts.length === 0 ? false : utils.isOneOf(o.description, appliedBlacklistedDistricts);
+    appliedBlacklistedDistricts.length === 0 ? false : utils.isOneOf(o.description, appliedBlacklistedDistricts);
-    return o.title != null && !isBlacklistedDistrict && titleNotBlacklisted && descNotBlacklisted;
+  return o.title != null && !isBlacklistedDistrict && titleNotBlacklisted && descNotBlacklisted;
 }
 
 const config = {
-    url: null,
+  url: null,
-    crawlContainer: '#srchrslt-adtable .ad-listitem ',
+  crawlContainer: '#srchrslt-adtable .ad-listitem ',
-    //sort by date is standard oO
+  //sort by date is standard oO
-    sortByDateParam: null,
+  sortByDateParam: null,
-    waitForSelector: 'body',
+  waitForSelector: 'body',
-    crawlFields: {
+  crawlFields: {
-        id: '.aditem@data-adid | int',
+    id: '.aditem@data-adid | int',
-        price: '.aditem-main--middle--price-shipping--price | removeNewline | trim',
+    price: '.aditem-main--middle--price-shipping--price | removeNewline | trim',
-        size: '.aditem-main .text-module-end | removeNewline | trim',
+    size: '.aditem-main .text-module-end | removeNewline | trim',
-        title: '.aditem-main .text-module-begin a | removeNewline | trim',
+    title: '.aditem-main .text-module-begin a | removeNewline | trim',
-        link: '.aditem-main .text-module-begin a@href | removeNewline | trim',
+    link: '.aditem-main .text-module-begin a@href | removeNewline | trim',
-        description: '.aditem-main .aditem-main--middle--description | removeNewline | trim',
+    description: '.aditem-main .aditem-main--middle--description | removeNewline | trim',
-        address: '.aditem-main--top--left | trim | removeNewline',
+    address: '.aditem-main--top--left | trim | removeNewline',
-    },
+    image: 'img@src',
-    normalize: normalize,
+  },
-    filter: applyBlacklist,
+  normalize: normalize,
+  filter: applyBlacklist,
 };
 export const metaInformation = {
-    name: 'Ebay Kleinanzeigen',
+  name: 'Ebay Kleinanzeigen',
-    baseUrl: 'https://www.kleinanzeigen.de/',
+  baseUrl: 'https://www.kleinanzeigen.de/',
-    id: 'kleinanzeigen',
+  id: 'kleinanzeigen',
 };
 export const init = (sourceConfig, blacklist, blacklistedDistricts) => {
-    config.enabled = sourceConfig.enabled;
+  config.enabled = sourceConfig.enabled;
-    config.url = sourceConfig.url;
+  config.url = sourceConfig.url;
-    appliedBlacklistedDistricts = blacklistedDistricts || [];
+  appliedBlacklistedDistricts = blacklistedDistricts || [];
-    appliedBlackList = blacklist || [];
+  appliedBlackList = blacklist || [];
 };
-export {config};
+export { config };

lib/provider/neubauKompass.js

@@ -1,44 +1,47 @@
-import utils, {buildHash} from '../utils.js';
+import utils, { buildHash } from '../utils.js';
 
 let appliedBlackList = [];
 
 function nullOrEmpty(val) {
-    return val == null || val.length === 0;
+  return val == null || val.length === 0;
 }
 
 function normalize(o) {
-    const link = nullOrEmpty(o.link) ? 'NO LINK' : `https://www.neubaukompass.de${o.link.substring(o.link.indexOf('/neubau'))}`;
+  const link = nullOrEmpty(o.link)
-    const id = buildHash(o.link, o.price);
+    ? 'NO LINK'
-    return Object.assign(o, {id, link});
+    : `https://www.neubaukompass.de${o.link.substring(o.link.indexOf('/neubau'))}`;
+  const id = buildHash(o.link, o.price);
+  return Object.assign(o, { id, link });
 }
 
 function applyBlacklist(o) {
-    return !utils.isOneOf(o.title, appliedBlackList);
+  return !utils.isOneOf(o.title, appliedBlackList);
 }
 
 const config = {
-    url: null,
+  url: null,
-    crawlContainer: '.col-12.mb-4',
+  crawlContainer: '.col-12.mb-4',
-    sortByDateParam: 'Sortierung=Id&Richtung=DESC',
+  sortByDateParam: 'Sortierung=Id&Richtung=DESC',
-    waitForSelector: '.nbk-section',
+  waitForSelector: '.nbk-section',
-    crawlFields: {
+  crawlFields: {
-        id: 'a@href',
+    id: 'a@href',
-        title: 'a@title | removeNewline | trim',
+    title: 'a@title | removeNewline | trim',
-        link: 'a@href',
+    link: 'a@href',
-        address: '.nbk-project-card__description | removeNewline | trim',
+    address: '.nbk-project-card__description | removeNewline | trim',
-        price: '.nbk-project-card__spec-item .nbk-project-card__spec-value | removeNewline | trim',
+    price: '.nbk-project-card__spec-item .nbk-project-card__spec-value | removeNewline | trim',
-    },
+    image: '.nbk-project-card__image@src',
-    normalize: normalize,
+  },
-    filter: applyBlacklist,
+  normalize: normalize,
+  filter: applyBlacklist,
 };
 export const init = (sourceConfig, blacklist) => {
-    config.enabled = sourceConfig.enabled;
+  config.enabled = sourceConfig.enabled;
-    config.url = sourceConfig.url;
+  config.url = sourceConfig.url;
-    appliedBlackList = blacklist || [];
+  appliedBlackList = blacklist || [];
 };
 export const metaInformation = {
-    name: 'Neubau Kompass',
+  name: 'Neubau Kompass',
-    baseUrl: 'https://www.neubaukompass.de/',
+  baseUrl: 'https://www.neubaukompass.de/',
-    id: 'neubauKompass',
+  id: 'neubauKompass',
 };
-export {config};
+export { config };

lib/provider/wgGesucht.js

@@ -1,43 +1,45 @@
-import utils, {buildHash} from '../utils.js';
+import utils, { buildHash } from '../utils.js';
 
 let appliedBlackList = [];
 
 function normalize(o) {
-    const id = buildHash(o.id, o.price);
+  const id = buildHash(o.id, o.price);
-    const link = `https://www.wg-gesucht.de${o.link}`;
+  const link = `https://www.wg-gesucht.de${o.link}`;
-    return Object.assign(o, { id, link });
+  const image = o.image != null ? o.image.replace('small', 'large') : null;
+  return Object.assign(o, { id, link, image });
 }
 
 function applyBlacklist(o) {
-    const titleNotBlacklisted = !utils.isOneOf(o.title, appliedBlackList);
+  const titleNotBlacklisted = !utils.isOneOf(o.title, appliedBlackList);
-    const descNotBlacklisted = !utils.isOneOf(o.description, appliedBlackList);
+  const descNotBlacklisted = !utils.isOneOf(o.description, appliedBlackList);
-    return o.id != null && titleNotBlacklisted && descNotBlacklisted;
+  return o.id != null && titleNotBlacklisted && descNotBlacklisted;
 }
 
 const config = {
-    url: null,
+  url: null,
-    crawlContainer: '#main_column .wgg_card',
+  crawlContainer: '#main_column .wgg_card',
-    sortByDateParam: 'sort_column=0&sort_order=0',
+  sortByDateParam: 'sort_column=0&sort_order=0',
-    waitForSelector: 'body',
+  waitForSelector: 'body',
-    crawlFields: {
+  crawlFields: {
-        id: '@data-id',
+    id: '@data-id',
-        details: '.row .noprint .col-xs-11 |removeNewline |trim',
+    details: '.row .noprint .col-xs-11 |removeNewline |trim',
-        price: '.middle .col-xs-3 |removeNewline |trim',
+    price: '.middle .col-xs-3 |removeNewline |trim',
-        size: '.middle .text-right |removeNewline |trim',
+    size: '.middle .text-right |removeNewline |trim',
-        title: '.truncate_title a |removeNewline |trim',
+    title: '.truncate_title a |removeNewline |trim',
-        link: '.truncate_title a@href',
+    link: '.truncate_title a@href',
-    },
+    image: '.img-responsive@src',
-    normalize: normalize,
+  },
-    filter: applyBlacklist,
+  normalize: normalize,
+  filter: applyBlacklist,
 };
 export const init = (sourceConfig, blacklist) => {
-    config.enabled = sourceConfig.enabled;
+  config.enabled = sourceConfig.enabled;
-    config.url = sourceConfig.url;
+  config.url = sourceConfig.url;
-    appliedBlackList = blacklist || [];
+  appliedBlackList = blacklist || [];
 };
 export const metaInformation = {
-    name: 'Wg gesucht',
+  name: 'Wg gesucht',
-    baseUrl: 'https://www.wg-gesucht.de/',
+  baseUrl: 'https://www.wg-gesucht.de/',
-    id: 'wgGesucht',
+  id: 'wgGesucht',
 };
-export {config};
+export { config };

lib/services/demoCleanup.js

@@ -2,6 +2,7 @@ import { setInterval } from 'node:timers';
 import { removeJobsByUserName } from './storage/jobStorage.js';
 import { config } from '../utils.js';
 import { getUsers } from './storage/userStorage.js';
+import logger from './logger.js';
 
 /**
  * if we are running in demo environment, we have to cleanup the db files (specifically the jobs table)
@@ -29,7 +30,7 @@ function cleanup() {
   if (config.demoMode) {
     const demoUser = getUsers(false).find((user) => user.username === 'demo');
     if (demoUser == null) {
-      console.error('Demo user not found, cannot remove Jobs');
+      logger.error('Demo user not found, cannot remove Jobs');
       return;
     }
     removeJobsByUserName(demoUser.id);

lib/services/extractor/extractor.js

@@ -1,6 +1,7 @@
 import { setDebug } from './utils.js';
 import puppeteerExtractor from './puppeteerExtractor.js';
 import { loadParser, parse } from './parser/parser.js';
+import logger from '../logger.js';
 
 const DEFAULT_OPTIONS = {
   debug: false,
@@ -32,7 +33,7 @@ export default class Extractor {
         loadParser(this.responseText);
       }
     } catch (error) {
-      console.error('Error trying to load page.', error);
+      logger.error('Error trying to load page.', error);
     }
     return this;
   };

lib/services/extractor/parser/parser.js

@@ -1,4 +1,5 @@
 import * as cheerio from 'cheerio';
+import logger from '../../logger.js';
 
 let $ = null;
 
@@ -8,19 +9,19 @@ export function loadParser(text) {
 
 export function parse(crawlContainer, crawlFields, text, url) {
   if (!text) {
-    console.warn('Cannot parse, text was empty for url ', url);
+    logger.warn('No content found for ', url);
     return null;
   }
 
   if (!crawlContainer || !crawlFields) {
-    console.warn('Cannot parse, selector was empty for url ', url);
+    logger.warn('Cannot parse, selector was empty for url ', url);
     return null;
   }
 
   const result = [];
 
   if ($(crawlContainer).length === 0) {
-    console.warn('No elements in crawl container found for url ', url);
+    logger.warn('No elements in crawl container found for url ', url);
     return null;
   }
 
@@ -52,13 +53,13 @@ export function parse(crawlContainer, crawlFields, text, url) {
         if (fieldSelector.includes('|')) {
           /* eslint-disable no-unused-vars */
           const [_, ...modifiers] = fieldSelector.split('|').map((s) => s.trim());
-          /* eslint-disable no-unused-vars */
+          /* eslint-enable no-unused-vars */
           value = applyModifiers(value, modifiers);
         }
 
         parsedObject[key] = value || null;
       } catch (error) {
-        console.error(`Error parsing field '${key}' with selector '${fieldSelector}':`, error);
+        logger.error(`Error parsing field '${key}' with selector '${fieldSelector}':`, error);
         parsedObject[key] = null;
       }
     }
@@ -66,7 +67,7 @@ export function parse(crawlContainer, crawlFields, text, url) {
     if (parsedObject.id != null) {
       result.push(parsedObject);
     } else {
-      console.warn('ID not found. Not relaying object.');
+      logger.debug('ID not found. Not relaying object.');
     }
   });
 
@@ -89,7 +90,7 @@ function applyModifiers(value, modifiers) {
         value = value.replace(/\n/g, ' ');
         break;
       default:
-        console.warn(`Unknown modifier: ${modifier}`);
+        logger.warn(`Unknown modifier: ${modifier}`);
     }
   });
 

lib/services/extractor/puppeteerExtractor.js

@@ -1,6 +1,7 @@
 import puppeteer from 'puppeteer-extra';
 import StealthPlugin from 'puppeteer-extra-plugin-stealth';
 import { debug, DEFAULT_HEADER, botDetected } from './utils.js';
+import logger from '../logger.js';
 
 puppeteer.use(StealthPlugin());
 
@@ -33,13 +34,13 @@ export default async function execute(url, waitForSelector, options) {
     const statusCode = response.status();
 
     if (botDetected(pageSource, statusCode)) {
-      console.warn('We have been detected as a bot :-/ Tried url: => ', url);
+      logger.warn('We have been detected as a bot :-/ Tried url: => ', url);
       return null;
     }
 
     return await page.content();
   } catch (error) {
-    console.error('Error executing with puppeteer executor', error);
+    logger.error('Error executing with puppeteer executor', error);
     return null;
   } finally {
     if (browser != null) {

lib/services/extractor/utils.js

@@ -1,3 +1,5 @@
+import logger from '../logger.js';
+
 let debuggingOn = false;
 
 export const DEFAULT_HEADER = {
@@ -15,9 +17,7 @@ export const setDebug = (options) => {
 
 export const debug = (message) => {
   if (debuggingOn) {
-    /* eslint-disable no-console */
+    logger.debug(message);
-    console.debug(message);
-    /* eslint-enable no-console */
   }
 };
 

lib/services/logger.js

@@ -0,0 +1,61 @@
+const COLORS = {
+  debug: '\x1b[36m',
+  info: '\x1b[32m',
+  warn: '\x1b[33m',
+  error: '\x1b[31m',
+  reset: '\x1b[0m',
+};
+
+const useColor = process.stdout.isTTY || process.stderr.isTTY;
+
+function ts() {
+  const d = new Date();
+  const yyyy = d.getFullYear();
+  const mm = String(d.getMonth() + 1).padStart(2, '0');
+  const dd = String(d.getDate()).padStart(2, '0');
+  const hh = String(d.getHours()).padStart(2, '0');
+  const mi = String(d.getMinutes()).padStart(2, '0');
+  const ss = String(d.getSeconds()).padStart(2, '0');
+  return `${yyyy}-${mm}-${dd} ${hh}:${mi}:${ss}`;
+}
+
+function lvl(level) {
+  const upper = level.toUpperCase();
+  if (!useColor) return upper;
+  return `${COLORS[level] || ''}${upper}${COLORS.reset}`;
+}
+
+/* eslint-disable no-console */
+function log(level, ...args) {
+  const prefix = `[${ts()}] ${lvl(level)}:`;
+  switch (level) {
+    case 'debug':
+      console.debug(prefix, ...args);
+      break;
+    case 'info':
+      console.info(prefix, ...args);
+      break;
+    case 'warn':
+      console.warn(prefix, ...args);
+      break;
+    case 'error':
+      console.error(prefix, ...args);
+      break;
+    default:
+      console.log(prefix, ...args);
+  }
+}
+
+export default {
+  debug: (...a) => log('debug', ...a),
+  info: (...a) => log('info', ...a),
+  warn: (...a) => log('warn', ...a),
+  error: (...a) => log('error', ...a),
+};
+
+// Beispiel:
+// import logger from './logger.js';
+// const a = 'fick';
+// const b = { tr: 'lolo' };
+// logger.info('hallo', a, b);
+// -> In IntelliJ siehst du das Objekt wie bei console.info, plus Prefix

lib/services/similarity-check/SimilarityCacheEntry.js

@@ -1,26 +0,0 @@
-import stringSimilarity from 'string-similarity';
-//if the score is higher than this, it will be considered a match
-const MAX_DICE_INDEX = 0.7;
-export default (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

@@ -1,40 +1,116 @@
-import SimilarityCacheEntry from './SimilarityCacheEntry.js';
+import crypto from 'crypto';
-import { config } from '../../utils.js';
+
-//5 minutes
+const retention = 60 * 60 * 1000;
-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;
 /**
- * cleanup
+ * Internal cache storage.
+ * Maps a SHA-256 hash (string) to its expiry timestamp (number in ms).
+ * @type {Map<string, number>}
  */
-intervalId = setInterval(() => {
+const entries = new Map();
-  const keysToBeRemoved = [];
+
+/**
+ * Reference to the currently scheduled cleanup timer.
+ * @type {NodeJS.Timeout | null}
+ */
+let timer = null;
+
+/**
+ * Generate a SHA-256 hash from a list of input strings.
+ * Null or undefined values are ignored.
+ *
+ * @param {...(string|null|undefined)} strings - Input values to hash
+ * @returns {string} Hexadecimal hash
+ */
+function toHash(...strings) {
+  return crypto.createHash('sha256').update(strings.filter(Boolean).join('|')).digest('hex');
+}
+
+/**
+ * Cleanup expired cache entries and schedule the next cleanup run.
+ * This function is invoked automatically by scheduled timers.
+ *
+ * @private
+ */
+function runCleanup() {
   const now = Date.now();
-  Object.keys(cache).forEach((key) => {
+  for (const [hash, expiry] of entries) {
-    if (cache[key].getTime() + retention < now) {
+    if (expiry <= now) entries.delete(hash);
-      keysToBeRemoved.push(key);
-    }
-  });
-  if (keysToBeRemoved.length > 0) {
-    keysToBeRemoved.forEach((key) => delete cache[key]);
   }
-}, 10000);
+  scheduleNext();
-export const addCacheEntry = (jobId, value) => {
+}
-  cache[jobId] = cache[jobId] || new SimilarityCacheEntry(Date.now());
+
-  cache[jobId].setCacheEntry(value);
+/**
-};
+ * Find the soonest expiry timestamp among all cache entries
-export const hasSimilarEntries = (jobId, value) => {
+ * and schedule a one-shot timer that will trigger at that time.
-  if (cache[jobId] == null) {
+ * Cancels any existing timer before scheduling a new one.
+ *
+ * @private
+ */
+function scheduleNext() {
+  if (timer) {
+    clearTimeout(timer);
+    timer = null;
+  }
+  let next = Infinity;
+  const now = Date.now();
+  for (const expiry of entries.values()) {
+    if (expiry > now && expiry < next) next = expiry;
+  }
+  if (next !== Infinity) {
+    timer = setTimeout(runCleanup, Math.max(0, next - now));
+  }
+}
+
+/**
+ * Add or refresh a cache entry for the given title and address.
+ * The entry will automatically expire after the configured retention window.
+ *
+ * @param {string} title - The title used to build the cache key
+ * @param {string} address - The address used to build the cache key
+ */
+export function addCacheEntry(title, address) {
+  const hash = toHash(title, address);
+  const expiry = Date.now() + retention;
+  entries.set(hash, expiry);
+  scheduleNext();
+}
+
+/**
+ * Check if a cache entry with the same title and address exists
+ * and is still valid (not expired).
+ *
+ * @param {string} title - The title used to build the cache key
+ * @param {string} address - The address used to build the cache key
+ * @returns {boolean} True if a valid cache entry exists, false otherwise
+ */
+export function hasSimilarEntries(title, address) {
+  const hash = toHash(title, address);
+  const expiry = entries.get(hash);
+  if (expiry == null) return false;
+  if (expiry <= Date.now()) {
+    entries.delete(hash);
+    scheduleNext();
     return false;
   }
-  return cache[jobId].hasSimilarEntries(value);
+  return true;
-};
+}
-export const stopCacheCleanup = () => {
+
-  clearInterval(intervalId);
+/**
-};
+ * Stop any scheduled cleanup timers and prevent further automatic cleanup.
+ * Entries that are already in the cache will remain until removed manually
+ * or until cleanup is started again by adding new entries.
+ */
+export function stopCacheCleanup() {
+  if (timer) clearTimeout(timer);
+  timer = null;
+}
+
+/**
+ * this is only for test purposes
+ */
+export function invalidateAllForTest() {
+  for (const key of entries.keys()) {
+    entries.set(key, 0);
+  }
+  runCleanup();
+}

lib/services/storage/jobStorage.js

@@ -4,6 +4,7 @@ import * as listingStorage from './listingsStorage.js';
 import { getDirName } from '../../utils.js';
 import path from 'path';
 import LowdashAdapter from './LowDashAdapter.js';
+import logger from '../logger.js';
 
 const file = path.join(getDirName(), '../', 'db/jobs.json');
 const adapter = new JSONFileSync(file);
@@ -91,9 +92,7 @@ export const removeJobsByUserName = (userId) => {
     .value();
   db.write();
   if (removedDemoJobs > 0) {
-    /* eslint-disable no-console */
+    logger.info(`Removed ${removedDemoJobs} demo jobs`);
-    console.log(`Removed ${removedDemoJobs} demo jobs`);
-    /* eslint-enable no-console */
   }
 };
 export const getJobs = () => {

lib/services/storage/userStorage.js

@@ -1,5 +1,5 @@
 import { JSONFileSync } from 'lowdb/node';
-import {config, getDirName} from '../../utils.js';
+import { config, getDirName } from '../../utils.js';
 import * as hasher from '../security/hash.js';
 import { nanoid } from 'nanoid';
 import * as jobStorage from './jobStorage.js';
@@ -7,23 +7,23 @@ import path from 'path';
 import LowdashAdapter from './LowDashAdapter.js';
 
 const defaultData = {
-    user: [
+  user: [
-        //you probably want to change the default password ;)
+    //you probably want to change the default password ;)
-        {
+    {
-            id: nanoid(),
+      id: nanoid(),
-            lastLogin: Date.now(),
+      lastLogin: Date.now(),
-            username: 'admin',
+      username: 'admin',
-            password: hasher.hash('admin'),
+      password: hasher.hash('admin'),
-            isAdmin: true,
+      isAdmin: true,
-        },
+    },
-        {
+    {
-            id: nanoid(),
+      id: nanoid(),
-            lastLogin: Date.now(),
+      lastLogin: Date.now(),
-            username: 'demo',
+      username: 'demo',
-            password: hasher.hash('demo'),
+      password: hasher.hash('demo'),
-            isAdmin: true,
+      isAdmin: true,
-        },
+    },
-    ],
+  ],
 };
 
 const file = path.join(getDirName(), '../', 'db/users.json');
@@ -86,34 +86,38 @@ export const removeUser = (userId) => {
   db.chain
     .set(
       'user',
-      user.filter((u) => u.id !== userId)
+      user.filter((u) => u.id !== userId),
     )
     .value();
   db.write();
 };
 
 export const handleDemoUser = () => {
-    if(!config.demoMode){
+  if (!config.demoMode) {
-        const user = db.chain.get('user').value();
+    const user = db.chain.get('user').value();
-        db.chain.get('user').value();
+    db.chain
-        db.chain.set('user', user.filter((u) => u.username !== 'demo')).value();
+      .set(
-        db.write();
+        'user',
-    }else {
+        user.filter((u) => u.username !== 'demo'),
-        const demoUser = db.chain
+      )
-            .get('user')
+      .value();
-            .filter((u) => u.username === 'demo')
+    db.write();
-            .value();
+  } else {
-        if (demoUser == null || demoUser.length === 0) {
+    const demoUser = db.chain
-            db.chain.get('user')
+      .get('user')
-                .value()
+      .filter((u) => u.username === 'demo')
-                .push({
+      .value();
-                    id: nanoid(),
+    if (demoUser == null || demoUser.length === 0) {
-                    username: 'demo',
+      db.chain
-                    password: hasher.hash('demo'),
+        .get('user')
-                    isAdmin: true,
+        .value()
-                });
+        .push({
-            db.write();
+          id: nanoid(),
-        }
+          username: 'demo',
+          password: hasher.hash('demo'),
+          isAdmin: true,
+        });
+      db.write();
     }
+  }
 };
-

lib/services/tracking/Tracker-Cron.js

@@ -0,0 +1,17 @@
+import cron from 'node-cron';
+import { config, inDevMode } from '../../utils.js';
+import { trackMainEvent } from './Tracker.js';
+
+async function runTask() {
+  //make sure to only send tracking events if the user gave us the green light and we are not in dev mode
+  if (config.analyticsEnabled && !inDevMode()) {
+    await trackMainEvent();
+  }
+}
+
+export async function initTrackerCron() {
+  //run directly on start
+  await runTask();
+  // then every 6 hours
+  cron.schedule('0 */6 * * *', runTask);
+}

lib/services/tracking/Tracker.js

@@ -1,90 +1,91 @@
-import Mixpanel from 'mixpanel';
+import { getJobs } from '../storage/jobStorage.js';
-import {getJobs} from '../storage/jobStorage.js';
+import { getUniqueId } from './uniqueId.js';
-import {getUniqueId} from './uniqueId.js';
+import { config, inDevMode } from '../../utils.js';
-import {config, inDevMode} from '../../utils.js';
 import os from 'os';
-import {readFileSync} from 'fs';
+import { readFileSync } from 'fs';
-import {packageUp} from 'package-up';
+import { packageUp } from 'package-up';
+import fetch from 'node-fetch';
+import logger from '../logger.js';
 
-const mixpanelTracker = Mixpanel.init('718670ef1c58c0208256c1e408a3d75e');
+const deviceId = getUniqueId() || 'N/A';
-const distinct_id = getUniqueId() || 'N/A';
 const version = await getPackageVersion();
+const FREDY_TRACKING_URL = 'https://fredy.orange-coding.net/tracking';
 
-export const track = function () {
+export const trackMainEvent = async () => {
-    //only send tracking information if the user allowed to do so.
+  try {
     if (config.analyticsEnabled && !inDevMode()) {
-        const activeProvider = new Set();
+      const activeProvider = new Set();
-        const activeAdapter = new Set();
+      const activeAdapter = new Set();
 
-        const jobs = getJobs();
+      const jobs = getJobs();
 
-        if (jobs != null && jobs.length > 0) {
+      if (jobs != null && jobs.length > 0) {
-            jobs.forEach((job) => {
+        jobs.forEach((job) => {
-                job.provider.forEach((provider) => {
+          job.provider.forEach((provider) => activeProvider.add(provider.id));
-                    activeProvider.add(provider.id);
+          job.notificationAdapter.forEach((adapter) => activeAdapter.add(adapter.id));
-                });
+        });
-                job.notificationAdapter.forEach((adapter) => {
-                    activeAdapter.add(adapter.id);
-                });
-            });
 
-            mixpanelTracker.track(
+        const trackingObj = enrichTrackingObject({
-                'fredy_tracking',
+          adapter: Array.from(activeAdapter),
-                enrichTrackingObject({
+          provider: Array.from(activeProvider),
-                    adapter: Array.from(activeAdapter),
+        });
-                    provider: Array.from(activeProvider),
+
-                }),
+        await fetch(`${FREDY_TRACKING_URL}/main`, {
-            );
+          method: 'POST',
-        }
+          headers: { 'Content-Type': 'application/json' },
+          body: JSON.stringify(trackingObj),
+        });
+      }
     }
+  } catch (error) {
+    logger.warn('Error sending tracking data', error);
+  }
 };
 
 /**
  * Note, this will only be used when Fredy runs in demo mode
  */
-export function trackDemoJobCreated(jobData) {
+export async function trackDemoAccessed() {
-    if (config.analyticsEnabled && !inDevMode() && config.demoMode) {
+  if (config.analyticsEnabled && !inDevMode() && config.demoMode) {
-        mixpanelTracker.track('demoJobCreated', enrichTrackingObject(jobData));
+    try {
-    }
+      await fetch(`${FREDY_TRACKING_URL}/demo/accessed`, {
-}
+        method: 'POST',
-
+        headers: { 'Content-Type': 'application/json' },
-/**
+      });
- * Note, this will only be used when Fredy runs in demo mode
+    } catch (error) {
- */
+      logger.warn('Error sending tracking data', error);
-export function trackDemoAccessed() {
-    if (config.analyticsEnabled && !inDevMode() && config.demoMode) {
-        mixpanelTracker.track('demoAccessed', enrichTrackingObject({}));
     }
+  }
 }
 
 function enrichTrackingObject(trackingObject) {
-    const operating_system = os.platform();
+  const operatingSystem = os.platform();
-    const os_version = os.release();
+  const osVersion = os.release();
-    const arch = process.arch;
+  const arch = process.arch;
-    const language = process.env.LANG || 'en';
+  const language = process.env.LANG || 'en';
-    const nodeVersion = process.version || 'N/A';
+  const nodeVersion = process.version || 'N/A';
 
-    return {
+  return {
-        ...trackingObject,
+    ...trackingObject,
-        isDemo: config.demoMode,
+    isDemo: config.demoMode,
-        operating_system,
+    operatingSystem,
-        os_version,
+    osVersion,
-        arch,
+    arch,
-        nodeVersion,
+    nodeVersion,
-        language,
+    language,
-        distinct_id,
+    deviceId,
-        fredy_version: version
+    version,
-    };
+  };
 }
 
 async function getPackageVersion() {
-    try {
+  try {
-        const packagePath = await packageUp();
+    const packagePath = await packageUp();
-        const packageJson = readFileSync(packagePath, 'utf8');
+    const packageJson = readFileSync(packagePath, 'utf8');
-        const json = JSON.parse(packageJson);
+    const json = JSON.parse(packageJson);
-        return json.version;
+    return json.version;
-    } catch (error) {
+  } catch (error) {
-        console.error('Error reading version from package.json', error);
+    logger.error('Error reading version from package.json', error);
-    }
+  }
-    return 'N/A';
+  return 'N/A';
 }

lib/utils.js

@@ -1,91 +1,121 @@
-import {dirname} from 'node:path';
+import { dirname } from 'node:path';
-import {fileURLToPath} from 'node:url';
+import { fileURLToPath } from 'node:url';
-import {readFile} from 'fs/promises';
+import { readFile } from 'fs/promises';
-import {createHash} from 'crypto';
+import { createHash } from 'crypto';
-import {DEFAULT_CONFIG} from './defaultConfig.js';
+import { DEFAULT_CONFIG } from './defaultConfig.js';
+import fs from 'fs';
+import logger from './services/logger.js';
 
-function inDevMode(){
+const RE_GT = />/g;
-    return process.env.NODE_ENV == null || process.env.NODE_ENV !== 'production';
+const RE_WEBP = /\/format\/webp/gi;
+const RE_EXT = /\.(jpe?g|png|gif)(\?.*)?$/i;
+const HTTPS_PREFIX = 'https://';
+
+function inDevMode() {
+  return process.env.NODE_ENV == null || process.env.NODE_ENV !== 'production';
 }
 
 function isOneOf(word, arr) {
-    if (arr == null || arr.length === 0) {
+  if (!arr || arr.length === 0 || word == null) return false;
-        return false;
+  const lowerWord = word.toLowerCase();
-    }
+  return arr.some((item) => lowerWord.indexOf(item.toLowerCase()) !== -1);
-    const expression = String.raw`\b(${arr.join('|')})\b`;
-    const blacklist = new RegExp(expression, 'ig');
-    return blacklist.test(word);
 }
 
 function nullOrEmpty(val) {
-    return val == null || val.length === 0;
+  return val == null || val.length === 0;
 }
 
 function timeStringToMs(timeString, now) {
-    const d = new Date(now);
+  const d = new Date(now);
-    const parts = timeString.split(':');
+  const parts = timeString.split(':');
-    d.setHours(parts[0]);
+  d.setHours(parts[0]);
-    d.setMinutes(parts[1]);
+  d.setMinutes(parts[1]);
-    d.setSeconds(0);
+  d.setSeconds(0);
-    return d.getTime();
+  return d.getTime();
 }
 
 function duringWorkingHoursOrNotSet(config, now) {
-    const {workingHours} = config;
+  const { workingHours } = config;
-    if (workingHours == null || nullOrEmpty(workingHours.from) || nullOrEmpty(workingHours.to)) {
+  if (workingHours == null || nullOrEmpty(workingHours.from) || nullOrEmpty(workingHours.to)) {
-        return true;
+    return true;
-    }
+  }
-    const toDate = timeStringToMs(workingHours.to, now);
+  const toDate = timeStringToMs(workingHours.to, now);
-    const fromDate = timeStringToMs(workingHours.from, now);
+  const fromDate = timeStringToMs(workingHours.from, now);
-    return fromDate <= now && toDate >= now;
+  return fromDate <= now && toDate >= now;
 }
 
 function getDirName() {
-    return dirname(fileURLToPath(import.meta.url));
+  return dirname(fileURLToPath(import.meta.url));
 }
 
 function buildHash(...inputs) {
-    if (inputs == null) {
+  if (inputs == null) {
-        return null;
+    return null;
-    }
+  }
-    const cleaned = inputs.filter(i => i != null && i.length > 0);
+  const cleaned = inputs.filter((i) => i != null && i.length > 0);
-    if (cleaned.length === 0) {
+  if (cleaned.length === 0) {
-        return null;
+    return null;
-    }
+  }
-    return createHash('sha256')
+  return createHash('sha256').update(cleaned.join(',')).digest('hex');
-        .update(cleaned.join(','))
-        .digest('hex');
 }
 
 let config = {};
-export async function readConfigFromStorage(){
+
-    return JSON.parse(await readFile(new URL('../conf/config.json', import.meta.url)));
+export async function readConfigFromStorage() {
+  return JSON.parse(await readFile(new URL('../conf/config.json', import.meta.url)));
 }
 
-export async function refreshConfig(){
+export async function refreshConfig() {
-    try {
+  checkIfConfigExistsAndWriteIfNot();
-        config = await readConfigFromStorage();
+
-        //backwards compatability...
+  try {
-        config.analyticsEnabled ??= null;
+    config = await readConfigFromStorage();
-        config.demoMode ??= false;
+    //backwards compatability...
-    } catch (error) {
+    config.analyticsEnabled ??= null;
-        config = {...DEFAULT_CONFIG};
+    config.demoMode ??= false;
-        console.error('Error reading config file', error);
+  } catch (error) {
-    }
+    config = { ...DEFAULT_CONFIG };
+    logger.info('Error reading config file.', error);
+  }
 }
+
+/**
+ * If the config file does not exist, we will create it.
+ */
+const checkIfConfigExistsAndWriteIfNot = () => {
+  if (!fs.existsSync(`${getDirName()}/../conf/config.json`)) {
+    logger.info('Could not find config file. Will create one with default values now');
+    fs.writeFileSync(`${getDirName()}/../conf/config.json`, JSON.stringify({ ...DEFAULT_CONFIG }));
+  }
+};
+
+const normalizeImageUrl = (url) => {
+  if (typeof url !== 'string' || url.length === 0) return null;
+
+  let u = url.trim().replace(RE_GT, '');
+  if (RE_WEBP.test(u)) u = u.replace(RE_WEBP, '/format/jpg');
+  if (!u.startsWith(HTTPS_PREFIX)) return null;
+  if (!RE_EXT.test(u)) {
+    const jpgIdx = u.toLowerCase().lastIndexOf('.jpg');
+    if (jpgIdx > -1) u = u.slice(0, jpgIdx + 4);
+  }
+  return u;
+};
+
 await refreshConfig();
 
-export {isOneOf};
+export { isOneOf };
-export {inDevMode};
+export { normalizeImageUrl };
-export {nullOrEmpty};
+export { inDevMode };
-export {duringWorkingHoursOrNotSet};
+export { nullOrEmpty };
-export {getDirName};
+export { duringWorkingHoursOrNotSet };
-export {config};
+export { getDirName };
-export {buildHash};
+export { config };
+export { buildHash };
 export default {
-    isOneOf,
+  isOneOf,
-    nullOrEmpty,
+  nullOrEmpty,
-    duringWorkingHoursOrNotSet,
+  duringWorkingHoursOrNotSet,
-    getDirName,
+  getDirName,
-    config,
+  config,
 };

package.json

@@ -1,21 +1,25 @@
 {
   "name": "fredy",
-  "version": "11.2.2",
+  "version": "11.6.4",
   "description": "[F]ind [R]eal [E]states [d]amn eas[y].",
   "scripts": {
-    "start": "node prod.js",
+    "prepare": "husky",
-    "dev": "yarn && rm -rf ./ui/public/* && vite",
+    "start:backend": "x-var NODE_ENV=production node index.js",
-    "ui": "rm -rf ./ui/public/* && vite",
+    "start:backend:dev": "nodemon --watch index.js --watch lib",
-    "prod": "yarn && vite build --emptyOutDir",
+    "start:frontend": "vite -m production",
-    "format": "prettier --write lib/**/*.js ui/src/**/*.jsx test/**/*.js *.js --single-quote --print-width 120",
+    "start:frontend:dev": "vite",
-    "test": "mocha --loader=esmock --timeout 3000000 test/**/*.test.js",
+    "build:frontend": "vite build",
-    "lint": "eslint ./index.js ./lib/**/*.js ./test/**/*.js ./ui/src/**/*.jsx"
+    "format": "prettier --write \"**/*.js\"",
+    "format:check": "prettier --check \"**/*.js\"",
+    "test": "node --import ./test/esmock-loader.mjs ./node_modules/mocha/bin/mocha.js --timeout 60000 test/**/*.test.js",
+    "lint": "eslint .",
+    "lint:fix": "yarn lint --fix"
   },
   "type": "module",
   "lint-staged": {
-    "*.js": [
+    "*.{js,jsx}": [
-      "eslint ./index.js ./lib/**/*.js ./test/**/*.js",
+      "yarn lint",
-      "prettier --single-quote --print-width 120 --write"
+      "yarn format"
     ]
   },
   "main": "index.js",
@@ -50,59 +54,62 @@
     "Firefox ESR"
   ],
   "dependencies": {
-    "@douyinfe/semi-ui": "2.79.0",
+    "@douyinfe/semi-ui": "2.86.0",
     "@rematch/core": "2.2.0",
     "@rematch/loading": "2.1.2",
     "@sendgrid/mail": "8.1.5",
-    "@vitejs/plugin-react": "4.4.1",
+    "@visactor/react-vchart": "^2.0.4",
-    "better-sqlite3": "^11.10.0",
+    "@visactor/vchart": "^2.0.4",
+    "@visactor/vchart-semi-theme": "^1.12.2",
+    "@vitejs/plugin-react": "5.0.2",
+    "better-sqlite3": "^12.2.0",
     "body-parser": "2.2.0",
-    "cheerio": "^1.0.0",
+    "cheerio": "^1.1.2",
-    "cookie-session": "2.1.0",
+    "cookie-session": "2.1.1",
     "handlebars": "4.7.8",
-    "highcharts": "12.2.0",
-    "highcharts-react-official": "3.2.2",
     "lodash": "4.17.21",
-    "lowdb": "6.0.1",
+    "lowdb": "7.0.1",
     "markdown": "^0.5.0",
-    "mixpanel": "^0.18.1",
     "nanoid": "5.1.5",
+    "node-cron": "^4.2.1",
     "node-fetch": "3.3.2",
-    "node-mailjet": "6.0.8",
+    "node-mailjet": "6.0.9",
+    "p-throttle": "^8.0.0",
     "package-up": "^5.0.0",
-    "puppeteer": "^24.8.2",
+    "puppeteer": "^24.19.0",
     "puppeteer-extra": "^3.3.6",
     "puppeteer-extra-plugin-stealth": "^2.11.2",
-    "query-string": "9.1.2",
+    "query-string": "9.3.0",
     "react": "18.3.1",
     "react-dom": "18.3.1",
     "react-redux": "9.2.0",
-    "react-router": "5.2.1",
+    "react-router": "7.8.2",
-    "react-router-dom": "5.3.0",
+    "react-router-dom": "7.8.2",
     "redux": "5.0.1",
     "redux-thunk": "3.1.0",
-    "restana": "4.9.9",
+    "restana": "5.1.0",
-    "serve-static": "1.16.2",
+    "serve-static": "2.2.0",
     "slack": "11.0.2",
-    "string-similarity": "^4.0.4",
+    "vite": "7.1.5",
-    "vite": "5.4.11"
+    "x-var": "^2.1.0"
   },
   "devDependencies": {
-    "@babel/core": "7.27.1",
+    "@babel/core": "7.28.4",
-    "@babel/eslint-parser": "7.27.1",
+    "@babel/eslint-parser": "7.28.4",
-    "@babel/preset-env": "7.27.2",
+    "@babel/preset-env": "7.28.3",
     "@babel/preset-react": "7.27.1",
-    "chai": "5.2.0",
+    "chai": "6.0.1",
-    "eslint": "8.56.0",
+    "eslint": "9.35.0",
-    "eslint-config-prettier": "8.8.0",
+    "eslint-config-prettier": "10.1.8",
-    "eslint-plugin-react": "7.37.4",
+    "eslint-plugin-react": "7.37.5",
-    "esmock": "2.7.0",
+    "esmock": "2.7.2",
     "history": "5.3.0",
     "husky": "9.1.7",
-    "less": "4.3.0",
+    "less": "4.4.1",
-    "lint-staged": "15.5.2",
+    "lint-staged": "16.1.6",
-    "mocha": "10.8.2",
+    "mocha": "11.7.2",
-    "prettier": "3.5.3",
+    "nodemon": "^3.1.10",
+    "prettier": "3.6.2",
     "redux-logger": "3.0.6"
   }
 }

prod.js

@@ -1,2 +0,0 @@
-process.env.NODE_ENV = 'production';
-import('./index.js');

reverse-engineered-immoscout.md

@@ -22,22 +22,24 @@ These protections make it extremely difficult to reliably extract data from Immo
 
 To work around these limitations, we are in the progress of reverse-engineering Immoscout24's mobile API. The mobile applications need to communicate with Immoscout's servers to retrieve listing data, and these API endpoints typically have fewer anti-bot protections than the web interface.
 
-The mobile API provides several key endpoints:    
+The mobile API provides several key endpoints:
+
 - Search total endpoint: Returns the total number of listings for a given query
 - Search list endpoint: Retrieves the actual listings with details
 - Expose endpoint: Returns detailed information about a specific listing
 
-Challenges:    
+Challenges:
+
 1. Identifying the necessary endpoints and parameters required to perform searches
 2. Mapping the mobile API parameters to their web counterparts to maintain compatibility with existing search URLs
 
-
 ## Api Specs
 
 #### Search for Listings
 
-`GET /search/total?{search parameters}`    
+`GET /search/total?{search parameters}`  
-*Returns the total number of listings for the given query.*
+_Returns the total number of listings for the given query._
+
 ```
 curl -H "User-Agent: ImmoScout24_1410_30_._" \
      -H "Accept: application/json" \
@@ -47,14 +49,17 @@ curl -H "User-Agent: ImmoScout24_1410_30_._" \
 ---
 
 #### Retrieve the listings
-`POST /search/list?{search parameters}`   
+
-*The body is json encoded and contains data specifying additional results (advertisements) to return. The format is as follows (It is not necessary to provide data for the specified keys.)*
+`POST /search/list?{search parameters}`  
-  ```
+_The body is json encoded and contains data specifying additional results (advertisements) to return. The format is as follows (It is not necessary to provide data for the specified keys.)_
-  {
+
-  "supportedResultListTypes": [],
+```
-  "userData": {}
+{
-  }
+"supportedResultListTypes": [],
-  ```
+"userData": {}
+}
+```
+
 ```
 curl -X POST 'https://api.mobile.immobilienscout24.de/search/list?pricetype=calculatedtotalrent&realestatetype=apartmentrent&searchType=region&geocodes=%2Fde%2Fberlin%2Fberlin&pagenumber=1' \
   -H "Connection: keep-alive" \
@@ -66,15 +71,18 @@ curl -X POST 'https://api.mobile.immobilienscout24.de/search/list?pricetype=calc
 ```
 
 ---
+
 #### Get details of listings
+
 `GET /expose/{id}`
 The response contains additional details not included in the listing response.
+
 ```
 curl -H "User-Agent: ImmoScout24_1410_30_._" \
      -H "Accept: application/json" \
      "https://api.mobile.immobilienscout24.de/expose/158382494"
 ```
 
+## Parameters
 
-## Parameters 
+The parameters between web and mobile are very different which is why we have to translate them. Please see [/lib/services/immoscout/immoscout-web-translator.js](https://github.com/orangecoding/fredy/blob/master/lib/services/immoscout/immoscout-web-translator.js).
-The parameters between web and mobile are very different which is why we have to translate them. Please see `immoscout-web-translator.js`.

test/esmock-loader.mjs

@@ -0,0 +1,4 @@
+import { register } from 'node:module';
+import { pathToFileURL } from 'node:url';
+
+register('esmock', pathToFileURL('./'));

test/provider/immonet.test.js

@@ -1,38 +1,38 @@
 import * as similarityCache from '../../lib/services/similarity-check/similarityCache.js';
-import {get} from '../mocks/mockNotification.js';
+import { get } from '../mocks/mockNotification.js';
-import {mockFredy, providerConfig} from '../utils.js';
+import { mockFredy, providerConfig } from '../utils.js';
-import {expect} from 'chai';
+import { expect } from 'chai';
 import * as provider from '../../lib/provider/immonet.js';
 
 describe('#immonet testsuite()', () => {
-    after(() => {
+  after(() => {
-        similarityCache.stopCacheCleanup();
+    similarityCache.stopCacheCleanup();
-    });
+  });
-    provider.init(providerConfig.immonet, [], []);
+  provider.init(providerConfig.immonet, [], []);
-    it('should test immonet provider', async () => {
+  it('should test immonet provider', async () => {
-        const Fredy = await mockFredy();
+    const Fredy = await mockFredy();
-        return await new Promise((resolve) => {
+    return await new Promise((resolve) => {
-            const fredy = new Fredy(provider.config, null, provider.metaInformation.id, 'immonet', similarityCache);
+      const fredy = new Fredy(provider.config, null, provider.metaInformation.id, 'immonet', similarityCache);
-            fredy.execute().then((listing) => {
+      fredy.execute().then((listing) => {
-                expect(listing).to.be.a('array');
+        expect(listing).to.be.a('array');
-                const notificationObj = get();
+        const notificationObj = get();
-                expect(notificationObj).to.be.a('object');
+        expect(notificationObj).to.be.a('object');
-                expect(notificationObj.serviceName).to.equal('immonet');
+        expect(notificationObj.serviceName).to.equal('immonet');
-                notificationObj.payload.forEach((notify) => {
+        notificationObj.payload.forEach((notify) => {
-                    /** check the actual structure **/
+          /** check the actual structure **/
-                    expect(notify.id).to.be.a('string');
+          expect(notify.id).to.be.a('string');
-                    expect(notify.price).to.be.a('string');
+          expect(notify.price).to.be.a('string');
-                    expect(notify.size).to.be.a('string');
+          expect(notify.size).to.be.a('string');
-                    expect(notify.title).to.be.a('string');
+          expect(notify.title).to.be.a('string');
-                    expect(notify.link).to.be.a('string');
+          expect(notify.link).to.be.a('string');
-                    expect(notify.address).to.be.a('string');
+          expect(notify.address).to.be.a('string');
 
-                    expect(notify.size).that.does.include('m²');
+          expect(notify.size).that.does.include('m²');
-                    expect(notify.title).to.be.not.empty;
+          expect(notify.title).to.be.not.empty;
-                    expect(notify.address).to.be.not.empty;
+          expect(notify.address).to.be.not.empty;
-                });
-                resolve();
-            });
         });
+        resolve();
+      });
     });
+  });
 });

test/provider/neubauKompass.test.js

@@ -1,36 +1,36 @@
 import * as similarityCache from '../../lib/services/similarity-check/similarityCache.js';
-import {get} from '../mocks/mockNotification.js';
+import { get } from '../mocks/mockNotification.js';
-import {mockFredy, providerConfig} from '../utils.js';
+import { mockFredy, providerConfig } from '../utils.js';
-import {expect} from 'chai';
+import { expect } from 'chai';
 import * as provider from '../../lib/provider/neubauKompass.js';
 
 describe('#neubauKompass testsuite()', () => {
-    after(() => {
+  after(() => {
-        similarityCache.stopCacheCleanup();
+    similarityCache.stopCacheCleanup();
-    });
+  });
-    provider.init(providerConfig.neubauKompass, [], []);
+  provider.init(providerConfig.neubauKompass, [], []);
-    it('should test neubauKompass provider', async () => {
+  it('should test neubauKompass provider', async () => {
-        const Fredy = await mockFredy();
+    const Fredy = await mockFredy();
-        return await new Promise((resolve) => {
+    return await new Promise((resolve) => {
-            const fredy = new Fredy(provider.config, null, provider.metaInformation.id, 'neubauKompass', similarityCache);
+      const fredy = new Fredy(provider.config, null, provider.metaInformation.id, 'neubauKompass', similarityCache);
-            fredy.execute().then((listing) => {
+      fredy.execute().then((listing) => {
-                expect(listing).to.be.a('array');
+        expect(listing).to.be.a('array');
-                const notificationObj = get();
+        const notificationObj = get();
-                expect(notificationObj.serviceName).to.equal('neubauKompass');
+        expect(notificationObj.serviceName).to.equal('neubauKompass');
-                notificationObj.payload.forEach((notify) => {
+        notificationObj.payload.forEach((notify) => {
-                    expect(notify).to.be.a('object');
+          expect(notify).to.be.a('object');
-                    /** check the actual structure **/
+          /** check the actual structure **/
-                    expect(notify.id).to.be.a('string');
+          expect(notify.id).to.be.a('string');
-                    expect(notify.title).to.be.a('string');
+          expect(notify.title).to.be.a('string');
-                    expect(notify.link).to.be.a('string');
+          expect(notify.link).to.be.a('string');
-                    expect(notify.address).to.be.a('string');
+          expect(notify.address).to.be.a('string');
-                    /** check the values if possible **/
+          /** check the values if possible **/
-                    expect(notify.title).to.be.not.empty;
+          expect(notify.title).to.be.not.empty;
-                    expect(notify.link).that.does.include('https://www.neubaukompass.de');
+          expect(notify.link).that.does.include('https://www.neubaukompass.de');
-                    expect(notify.address).to.be.not.empty;
+          expect(notify.address).to.be.not.empty;
-                });
-                resolve();
-            });
         });
+        resolve();
+      });
     });
+  });
 });

test/provider/testProvider.json

@@ -24,10 +24,6 @@
     "url": "https://immo.swp.de/suchergebnisse?l=M%C3%BCnchen&r=0km&_multiselect_r=0km&ut=private&t=apartment%3Arental&a=de.muenchen&pf=&pt=&rf=0&rt=0&sf=50&st=&yf=&yt=&ff=&ft=&s=most_recently_updated_first&pa=&o=&ad=&u=",
     "enabled": true
   },
-  "kalaydo": {
-    "url": "https://www.kalaydo.de/immobilien/eigentumswohnung-kaufen/o/duesseldorf/4/?attr_gt_estate_size_living_area=90.0&attr_gt_no_of_rooms=3.5&maxPrice=420000.00&radius=5&resultsPerPage=50&sorting=-date",
-    "enabled": true
-  },
   "kleinanzeigen": {
     "url": "https://www.kleinanzeigen.de/s-immobilien/duesseldorf/anzeige:angebote/wohnung/k0c195l2068r5",
     "enabled": true

test/queryStringMutator/testData.json

@@ -30,4 +30,4 @@
     "shouldBecome": "https://www.immobilienscout24.de/Suche/de/nordrhein-westfalen/duesseldorf/wohnung-mieten?numberofrooms=1.5-&price=1.0-1000000.0&livingspace=1.0-10000.0&pricetype=rentpermonth&enteredFrom=result_list&sorting=-firstactivation",
     "id": "immoscout"
   }
-]
+]

test/services/immoscout/immoscout-web-translator.test.js

@@ -1,4 +1,4 @@
-import { convertWebToMobile } from '../../../lib/services/immoscout/immoscout-web-translater.js';
+import { convertWebToMobile } from '../../../lib/services/immoscout/immoscout-web-translator.js';
 import { expect } from 'chai';
 import { readFile } from 'fs/promises';
 

test/services/immoscout/testdata.json

@@ -19,4 +19,4 @@
     "url": "https://www.immobilienscout24.de/Suche/de/nordrhein-westfalen/duesseldorf/haus-mieten?enteredFrom=one_step_search",
     "type": "houserent"
   }
-}
+}

test/similarity/similarity.test.js

@@ -1,39 +1,30 @@
-import SimilarityCacheEntry from '../../lib/services/similarity-check/SimilarityCacheEntry.js';
 import { expect } from 'chai';
+import * as similarityCache from '../../lib/services/similarity-check/similarityCache.js';
 
 describe('similarityCheck', () => {
-  describe('#similarityCheck()', () => {
+  it('should return true on duplicate', () => {
-    it('should be false', () => {
+    similarityCache.addCacheEntry('Hello World', 'Test');
-      const check = new SimilarityCacheEntry(0);
+    expect(similarityCache.hasSimilarEntries('Hello World', 'Test')).to.be.true;
-      check.setCacheEntry('Hallo');
+  });
-      expect(check.hasSimilarEntries('Welt')).to.be.false;
+
-    });
+  it('should return true even if one value is null', () => {
-    it('should be true', () => {
+    similarityCache.addCacheEntry('Hello World', null);
-      const check = new SimilarityCacheEntry(0);
+    expect(similarityCache.hasSimilarEntries('Hello World', null)).to.be.true;
-      check.setCacheEntry('Hallo');
+  });
-      expect(check.hasSimilarEntries('hallo')).to.be.true;
+
-    });
+  it('should return true even if one value is an obj', () => {
-    it('should be true', () => {
+    similarityCache.addCacheEntry('Hello World', [{ TR: 'OLOLO' }]);
-      const check = new SimilarityCacheEntry(0);
+    expect(similarityCache.hasSimilarEntries('Hello World', [{ TR: 'OLOLO' }])).to.be.true;
-      check.setCacheEntry('Selling an incredible house in san francisco');
+  });
-      expect(check.hasSimilarEntries('incredible house in san francisco for sale')).to.be.true;
+
-    });
+  it('should return false when no duplicate', () => {
-    it('should be true', () => {
+    similarityCache.addCacheEntry('Hello World__', 'Test');
-      const check = new SimilarityCacheEntry(0);
+    expect(similarityCache.hasSimilarEntries('Hello World___', 'Test')).to.be.false;
-      check.setCacheEntry('a');
+  });
-      check.setCacheEntry('b');
+
-      check.setCacheEntry('c');
+  it('should return false when no duplicate', () => {
-      check.setCacheEntry('d');
+    expect(similarityCache.hasSimilarEntries('Hello World', 'Test')).to.be.true;
-      expect(check.hasSimilarEntries('b')).to.be.true;
+    similarityCache.invalidateAllForTest();
-    });
+    expect(similarityCache.hasSimilarEntries('Hello World', 'Test')).to.be.false;
-    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.',
-      );
-    });
   });
 });

test/utils/utils.test.js

@@ -1,16 +1,16 @@
 import { expect } from 'chai';
-import {buildHash} from '../../lib/utils.js';
+import { buildHash } from '../../lib/utils.js';
 
 describe('utilsCheck', () => {
   describe('#utilsCheck()', () => {
-      it('should be null when null input', () => {
+    it('should be null when null input', () => {
-          expect(buildHash(null)).to.be.null;
+      expect(buildHash(null)).to.be.null;
-      });
+    });
-      it('should be null when null empty', () => {
+    it('should be null when null empty', () => {
-          expect(buildHash('')).to.be.null;
+      expect(buildHash('')).to.be.null;
-      });
+    });
-      it('should return a value', () => {
+    it('should return a value', () => {
-          expect(buildHash('bla', '', null)).to.be.a.string;
+      expect(buildHash('bla', '', null)).to.be.a.string;
-      });
+    });
   });
 });

ui/src/App.jsx

@@ -1,4 +1,4 @@
-import React, {useEffect} from 'react';
+import React, { useEffect } from 'react';
 
 import InsufficientPermission from './components/permission/InsufficientPermission';
 import PermissionAwareRoute from './components/permission/PermissionAwareRoute';
@@ -6,106 +6,122 @@ import GeneralSettings from './views/generalSettings/GeneralSettings';
 import JobMutation from './views/jobs/mutation/JobMutation';
 import UserMutator from './views/user/mutation/UserMutator';
 import JobInsight from './views/jobs/insights/JobInsight.jsx';
-import {useDispatch, useSelector} from 'react-redux';
+import { useDispatch, useSelector } from 'react-redux';
-import {Switch, Redirect} from 'react-router-dom';
+import { Routes, Route, Navigate } from 'react-router-dom';
 import Logout from './components/logout/Logout';
 import Logo from './components/logo/Logo';
 import Menu from './components/menu/Menu';
 import Login from './views/login/Login';
 import Users from './views/user/Users';
 import Jobs from './views/jobs/Jobs';
-import {Route} from 'react-router';
 
 import './App.less';
 import TrackingModal from './components/tracking/TrackingModal.jsx';
-import {Banner} from '@douyinfe/semi-ui';
+import { Banner } from '@douyinfe/semi-ui';
 
 export default function FredyApp() {
-    const dispatch = useDispatch();
+  const dispatch = useDispatch();
-    const [loading, setLoading] = React.useState(true);
+  const [loading, setLoading] = React.useState(true);
-    const currentUser = useSelector((state) => state.user.currentUser);
+  const currentUser = useSelector((state) => state.user.currentUser);
-    const settings = useSelector((state) => state.generalSettings.settings);
+  const settings = useSelector((state) => state.generalSettings.settings);
 
-    useEffect(() => {
+  useEffect(() => {
-        async function init() {
+    async function init() {
-            await dispatch.user.getCurrentUser();
+      await dispatch.user.getCurrentUser();
-            if (!needsLogin()) {
+      if (!needsLogin()) {
-                await dispatch.provider.getProvider();
+        await dispatch.provider.getProvider();
-                await dispatch.jobs.getJobs();
+        await dispatch.jobs.getJobs();
-                await dispatch.jobs.getProcessingTimes();
+        await dispatch.jobs.getProcessingTimes();
-                await dispatch.notificationAdapter.getAdapter();
+        await dispatch.notificationAdapter.getAdapter();
-                await dispatch.generalSettings.getGeneralSettings();
+        await dispatch.generalSettings.getGeneralSettings();
+      }
+      setLoading(false);
+    }
+
+    init();
+  }, [currentUser?.userId]);
+
+  const needsLogin = () => {
+    return currentUser == null || Object.keys(currentUser).length === 0;
+  };
+
+  const isAdmin = () => currentUser != null && currentUser.isAdmin;
+
+  const login = () => (
+    <Routes>
+      <Route path="/login" element={<Login />} />
+      <Route path="*" element={<Navigate to="/login" replace />} />
+    </Routes>
+  );
+
+  return loading ? null : needsLogin() ? (
+    login()
+  ) : (
+    <div className="app">
+      <div className="app__container">
+        <Logout />
+        <Logo width={190} white />
+        <Menu isAdmin={isAdmin()} />
+
+        {settings.demoMode && (
+          <>
+            <Banner
+              fullMode={true}
+              type="info"
+              bordered
+              closeIcon={null}
+              description="You're currently viewing the demo version of Fredy. Jobs won't scrape websites, and any changes you make will be reverted at midnight."
+            />
+            <br />
+          </>
+        )}
+        {settings.analyticsEnabled === null && !settings.demoMode && <TrackingModal />}
+        <Routes>
+          <Route path="/403" element={<InsufficientPermission />} />
+          <Route path="/jobs/new" element={<JobMutation />} />
+          <Route path="/jobs/edit/:jobId" element={<JobMutation />} />
+          <Route path="/jobs/insights/:jobId" element={<JobInsight />} />
+          <Route path="/jobs" element={<Jobs />} />
+
+          {/* Permission-aware routes */}
+          <Route
+            path="/users/new"
+            element={
+              <PermissionAwareRoute currentUser={currentUser}>
+                <UserMutator />
+              </PermissionAwareRoute>
             }
-            setLoading(false);
+          />
-        }
+          <Route
+            path="/users/edit/:userId"
+            element={
+              <PermissionAwareRoute currentUser={currentUser}>
+                <UserMutator />
+              </PermissionAwareRoute>
+            }
+          />
+          <Route
+            path="/users"
+            element={
+              <PermissionAwareRoute currentUser={currentUser}>
+                <Users />
+              </PermissionAwareRoute>
+            }
+          />
+          <Route
+            path="/generalSettings"
+            element={
+              <PermissionAwareRoute currentUser={currentUser}>
+                <GeneralSettings />
+              </PermissionAwareRoute>
+            }
+          />
 
-        init();
+          <Route path="/" element={<Navigate to="/jobs" replace />} />
-    }, [currentUser?.userId]);
+        </Routes>
-
+      </div>
-    const needsLogin = () => {
+    </div>
-        return currentUser == null || Object.keys(currentUser).length === 0;
+  );
-    };
-
-    const isAdmin = () => currentUser != null && currentUser.isAdmin;
-
-    const login = () => (
-        <Switch>
-            <Route name="Login" path={'/login'} component={Login}/>
-            <Redirect from="*" to={'/login'}/>
-        </Switch>
-    );
-
-    return loading ? null : needsLogin() ? (
-        login()
-    ) : (
-        <div className="app">
-            <div className="app__container">
-                <Logout/>
-                <Logo width={190} white/>
-                <Menu isAdmin={isAdmin()}/>
-
-                {settings.demoMode && (
-                <>
-                    <Banner fullMode={true}
-                            type="info"
-                            bordered
-                            closeIcon={null}
-                            description="You're currently viewing the demo version of Fredy. Jobs won't scrape websites, and any changes you make will be reverted at midnight."
-                    />
-                    <br/>
-                </>)}
-                {(settings.analyticsEnabled === null && !settings.demoMode) && <TrackingModal/>}
-                <Switch>
-                    <Route name="Insufficient Permission" path={'/403'} component={InsufficientPermission}/>
-                    <Route name="Create new Job" path={'/jobs/new'} component={JobMutation}/>
-                    <Route name="Edit a Job" path={'/jobs/edit/:jobId'} component={JobMutation}/>
-                    <Route name="Insights into a Job" path={'/jobs/insights/:jobId'} component={JobInsight}/>
-                    <Route name="Job overview" path={'/jobs'} component={Jobs}/>
-                    <PermissionAwareRoute
-                        name="Create new User"
-                        path="/users/new"
-                        component={<UserMutator/>}
-                        currentUser={currentUser}
-                    />
-                    <PermissionAwareRoute
-                        name="Edit a user"
-                        path="/users/edit/:userId"
-                        component={<UserMutator/>}
-                        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>
-            </div>
-        </div>
-    );
 }
 
 FredyApp.displayName = 'FredyApp';

ui/src/App.less

@@ -1,7 +1,7 @@
 .app {
-  display:flex;
+  display: flex;
   flex-direction: column;
-  width:100%;
+  width: 100%;
 
   &__container {
     padding: 1rem 1rem;
@@ -10,12 +10,13 @@
   }
 }
 
-.ui.inverted.segment{
+.ui.inverted.segment {
-  background: #31303078!important;
+  background: #31303078 !important;
 }
 
-.ui.black.label, .ui.black.labels .label {
+.ui.black.label,
-  background-color: #31303078!important;
+.ui.black.labels .label {
+  background-color: #31303078 !important;
 }
 
 a:link {
@@ -40,4 +41,8 @@ a:active {
   color: #54a9ff;
   background-color: transparent;
   text-decoration: underline;
-}
+}
+
+.semi-icon:not(.semi-tabs-bar .semi-tabs-tab .semi-icon) {
+  vertical-align: middle;
+}

ui/src/Index.jsx

@@ -2,26 +2,27 @@ import React from 'react';
 
 import { reduxStore } from './services/rematch/store';
 import { HashRouter } from 'react-router-dom';
-import { createHashHistory } from 'history';
 import { Provider } from 'react-redux';
 import { createRoot } from 'react-dom/client';
 import en_US from '@douyinfe/semi-ui/lib/es/locale/source/en_US';
 import { LocaleProvider } from '@douyinfe/semi-ui';
+import { initVChartSemiTheme } from '@visactor/vchart-semi-theme';
+import App from './App';
+import './Index.less';
 
 const container = document.getElementById('fredy');
 const root = createRoot(container);
-const history = createHashHistory();
 
-import App from './App';
+initVChartSemiTheme({
-
+  defaultMode: 'dark',
-import './Index.less';
+});
 
 root.render(
   <Provider store={reduxStore}>
-    <HashRouter history={history}>
+    <HashRouter>
       <LocaleProvider locale={en_US}>
         <App />
       </LocaleProvider>
     </HashRouter>
-  </Provider>
+  </Provider>,
 );

ui/src/Index.less

@@ -1,15 +1,16 @@
-body, html {
+body,
+html {
   margin: 0;
   height: 100%;
   width: 100%;
   background-color: #232429;
 }
 
-.semi-table-row-head{
+.semi-table-row-head {
   background-color: #2b2b2b !important;
   color: #fff !important;
 }
 
 .semi-table-row-cell {
   background-color: #333333 !important;
-}
+}

ui/src/components/logo/Logo.less

@@ -1,5 +1,5 @@
 .logo {
   position: absolute;
-  top: .1rem;
+  top: 0.1rem;
   right: 2rem;
-}
+}

ui/src/components/menu/Menu.jsx

@@ -1,9 +1,10 @@
 import React from 'react';
-import { useHistory } from 'react-router-dom';
+import { useNavigate } from 'react-router-dom';
 import { Tabs, TabPane } from '@douyinfe/semi-ui';
 
-import { useLocation } from 'react-router';
+import { useLocation } from 'react-router-dom';
 import { IconUser, IconTerminal, IconSetting } from '@douyinfe/semi-icons';
+import './Menu.less';
 
 function parsePathName(name) {
   const split = name.split('/').filter((s) => s.length !== 0);
@@ -11,10 +12,10 @@ function parsePathName(name) {
 }
 
 const TopMenu = function TopMenu({ isAdmin }) {
-  const history = useHistory();
+  const navigate = useNavigate();
   const location = useLocation();
   return (
-    <Tabs type="line" activeKey={parsePathName(location.pathname)} onTabClick={(key) => history.push(key)}>
+    <Tabs className="menu" type="line" activeKey={parsePathName(location.pathname)} onTabClick={(key) => navigate(key)}>
       <TabPane
         itemKey="/jobs"
         tab={

ui/src/components/menu/Menu.less

@@ -0,0 +1,3 @@
+.menu {
+  margin-top: 3rem;
+}

ui/src/components/permission/PermissionAwareRoute.jsx

@@ -1,21 +1,8 @@
 import React from 'react';
 
-import { Redirect } from 'react-router-dom';
+import { Navigate } from 'react-router-dom';
-import { Route } from 'react-router';
 
-export default function PermissionAwareRoute({ currentUser, name, path, component }) {
+export default function PermissionAwareRoute({ currentUser, children }) {
-  /**
+  const isAdmin = currentUser != null && currentUser.isAdmin;
-   * Checks if given component should be rendered if current user has given permission enabled. If that's not the case,
+  return isAdmin ? children : <Navigate to="/403" replace />;
-   * user is redirected to '/403'.
-   *
-   * @param permission
-   * @param component
-   * @param path
-   * @returns {*}
-   */
-  const checkIfAdmin = (component, path) => {
-    return currentUser != null && currentUser.isAdmin ? component : <Redirect from={path} to="/403" />;
-  };
-
-  return <Route name={name} path={path} render={() => checkIfAdmin(component, path)} />;
 }

ui/src/components/placeholder/Placeholder.less

@@ -1,10 +1,10 @@
 .place {
   height: 100%;
   width: 100%;
-  display:flex;
+  display: flex;
 
-  &__place_lines_wrapper{
+  &__place_lines_wrapper {
-    width:100%;
+    width: 100%;
   }
 
   &__line {
@@ -20,17 +20,16 @@
     border-radius: 360px;
     animation: pulse 1s infinite ease-in-out;
   }
-
 }
 
 @keyframes pulse {
   0% {
-    background-color: rgba(165, 165, 165, 0.1)
+    background-color: rgba(165, 165, 165, 0.1);
   }
   50% {
-    background-color: rgba(165, 165, 165, 0.3)
+    background-color: rgba(165, 165, 165, 0.3);
   }
   100% {
-    background-color: rgba(165, 165, 165, 0.1)
+    background-color: rgba(165, 165, 165, 0.1);
   }
 }