@stamhoofd/backend 1.0.0

package/.env.template.json

@@ -0,0 +1,63 @@
+{
+    "environment": "development",
+    "domains": {
+        "dashboard": "dashboard.stamhoofd",
+        "registration": {
+            "": "be.stamhoofd",
+            "BE": "be.stamhoofd",
+            "NL": "nl.stamhoofd"
+        },
+        "marketing": {
+            "": "www.be.stamhoofd",
+            "BE": "www.be.stamhoofd",
+            "NL": "www.nl.stamhoofd"
+        },
+        "webshop": {
+            "": "shop.be.stamhoofd",
+            "BE": "shop.be.stamhoofd",
+            "NL": "shop.nl.stamhoofd"
+        },
+        "legacyWebshop": "shop.stamhoofd",
+        "api": "api.stamhoofd",
+        "rendererApi": "renderer.stamhoofd"
+    },
+    "translationNamespace": "stamhoofd",
+    "userMode": "organization",
+    
+    "PORT": 9091,
+    "DB_HOST": "127.0.0.1",
+    "DB_USER": "",
+    "DB_PASS": "",
+    "DB_DATABASE": "",
+
+    "SMTP_HOST": "0.0.0.0",
+    "SMTP_USERNAME": "username",
+    "SMTP_PASSWORD": "password",
+    "SMTP_PORT": 1025,
+
+    "TRANSACTIONAL_SMTP_HOST": "0.0.0.0",
+    "TRANSACTIONAL_SMTP_USERNAME": "username",
+    "TRANSACTIONAL_SMTP_PASSWORD": "password",
+    "TRANSACTIONAL_SMTP_PORT": 1025,
+
+    "AWS_ACCESS_KEY_ID": "",
+    "AWS_SECRET_ACCESS_KEY": "",
+    "AWS_REGION": "",
+
+    "SPACES_ENDPOINT": "",
+    "SPACES_BUCKET": "",
+    "SPACES_KEY": "",
+    "SPACES_SECRET": "",
+
+    "MOLLIE_CLIENT_ID": "",
+    "MOLLIE_SECRET": "",
+    "MOLLIE_API_KEY": "",
+    "MOLLIE_ORGANIZATION_TOKEN": "",
+
+    "LATEST_IOS_VERSION": 0,
+    "LATEST_ANDROID_VERSION": 0,
+
+    "NOLT_SSO_SECRET_KEY": "",
+    "INTERNAL_SECRET_KEY": "",
+    "CRONS_DISABLED": false
+}

package/.eslintrc.js

@@ -0,0 +1,61 @@
+module.exports = {
+    root: true,
+    ignorePatterns: ["dist/", "node_modules/"],
+    parserOptions: {
+        "ecmaVersion": 2017
+    },
+    env: {
+        "es6": true,
+        "node": true,
+    },
+    extends: [
+        "eslint:recommended",
+    ],
+    plugins: [],
+    rules: {
+        "no-console": "off",
+        "no-debugger": process.env.NODE_ENV === "production" ? "error" : "off",
+        "sort-imports": "off",
+        "import/order": "off"
+    },
+    overrides: [
+        {
+            // Rules for TypeScript and vue
+            files: ["*.ts"],
+            parser: "@typescript-eslint/parser",
+            parserOptions: {
+                project: ["./tsconfig.json"]
+            },
+            plugins: ["@typescript-eslint", "jest"],
+            extends: [
+                "eslint:recommended",
+                "plugin:@typescript-eslint/eslint-recommended",
+                "plugin:@typescript-eslint/recommended",
+                "plugin:@typescript-eslint/recommended-requiring-type-checking",
+                "plugin:jest/recommended",
+            ],
+            rules: {
+                "no-console": "off",
+                "no-debugger": process.env.NODE_ENV === "production" ? "error" : "off",
+                "sort-imports": "off",
+                "import/order": "off",
+                "@typescript-eslint/explicit-function-return-type": "off",
+                "@typescript-eslint/no-explicit-any": "off",
+                "@typescript-eslint/no-unused-vars": ["warn", { argsIgnorePattern: "^_" }],
+                "@typescript-eslint/no-namespace": "off",
+                "@typescript-eslint/no-floating-promises": "error",
+                "@typescript-eslint/no-misused-promises": "error",
+                "@typescript-eslint/prefer-for-of": "warn",
+                "@typescript-eslint/no-empty-interface": "off", // It is convenient to have placeholder interfaces
+                "@typescript-eslint/no-this-alias": "off", // No idea why we need this. This breaks code that is just fine. Prohibit the use of function() instead of this rule
+                "@typescript-eslint/unbound-method": "off", // Methods are automatically bound in vue, it would break removeEventListeners if we bound it every time unless we save every method in variables again...
+                "@typescript-eslint/no-unsafe-assignment": "off", // This is impossible to use with dependencies that don't have types yet, such as tiptap
+                "@typescript-eslint/no-unsafe-return": "off", // This is impossible to use with dependencies that don't have types yet, such as tiptap
+                "@typescript-eslint/no-unsafe-call": "off", // This is impossible to use with dependencies that don't have types yet, such as tiptap
+                "@typescript-eslint/no-unsafe-member-access": "off", // This is impossible to use with dependencies that don't have types yet, such as tiptap
+                "@typescript-eslint/restrict-plus-operands": "off", // bullshit one
+                "@typescript-eslint/explicit-module-boundary-types": "off",
+            },
+        }
+    ]
+};

package/README.md

@@ -0,0 +1,40 @@
+# Stamhoofd backend application
+
+To run, make sure you set your environment variables.
+
+You can create a `.env` file:
+
+```
+# Database
+DB_HOST=localhost
+DB_USER=root
+DB_PASS=root
+DB_DATABASE=stamhoofd
+
+# SMTP server (for sending emails)
+SMTP_HOST=email-smtp.eu-west-1.amazonaws.com
+SMTP_USERNAME=xxxx
+SMTP_PASSWORD=xxxx
+SMTP_PORT=xxxx
+```
+
+## Setup
+
+Install dependencies and run the migrations to setup the database.
+
+```
+yarn install
+yarn migrations
+```
+
+## Running
+
+```
+yarn start
+```
+
+## Testing
+
+```
+yarn test
+```

package/index.ts

@@ -0,0 +1,172 @@
+require('@stamhoofd/backend-env').load()
+import { Column, Database, Migration } from "@simonbackx/simple-database";
+import { CORSPreflightEndpoint, Router, RouterServer } from "@simonbackx/simple-endpoints";
+import { I18n } from "@stamhoofd/backend-i18n";
+import { CORSMiddleware, LogMiddleware, VersionMiddleware } from "@stamhoofd/backend-middleware";
+import { Email } from "@stamhoofd/email";
+import { loadLogger } from "@stamhoofd/logging";
+import { Version } from '@stamhoofd/structures';
+import { sleep } from "@stamhoofd/utility";
+
+import { areCronsRunning, crons, stopCronScheduling } from './src/crons';
+import { ContextMiddleware } from "./src/middleware/ContextMiddleware";
+
+process.on("unhandledRejection", (error: Error) => {
+    console.error("unhandledRejection");
+    console.error(error.message, error.stack);
+    process.exit(1);
+});
+
+// Set version of saved structures
+Column.setJSONVersion(Version);
+
+// Set timezone!
+process.env.TZ = "UTC";
+
+// Quick check
+if (new Date().getTimezoneOffset() != 0) {
+    throw new Error("Process should always run in UTC timezone");
+}
+
+const seeds = async () => {
+    try {
+        // Internal
+        await Migration.runAll(__dirname + "/src/seeds");
+    } catch (e) {
+        console.error("Failed to run seeds:")
+        console.error(e)
+    }
+};
+
+const start = async () => {
+    console.log('Running server at v' + Version)
+    loadLogger();
+    await I18n.load()
+    const router = new Router();
+    await router.loadAllEndpoints(__dirname + "/src/endpoints/global/*");
+    await router.loadAllEndpoints(__dirname + "/src/endpoints/admin/*");
+    await router.loadAllEndpoints(__dirname + "/src/endpoints/auth");
+    await router.loadAllEndpoints(__dirname + "/src/endpoints/organization/dashboard/*");
+    await router.loadAllEndpoints(__dirname + "/src/endpoints/organization/registration");
+    await router.loadAllEndpoints(__dirname + "/src/endpoints/organization/webshops");
+    await router.loadAllEndpoints(__dirname + "/src/endpoints/organization/shared");
+    await router.loadAllEndpoints(__dirname + "/src/endpoints/organization/shared/*");
+
+    router.endpoints.push(new CORSPreflightEndpoint())
+
+    const routerServer = new RouterServer(router);
+    routerServer.verbose = false
+    
+    // Log requests and errors
+    routerServer.addRequestMiddleware(LogMiddleware)
+    routerServer.addResponseMiddleware(LogMiddleware)
+
+    // Contexts
+    routerServer.addRequestMiddleware(ContextMiddleware)
+
+    // Add version headers and minimum version
+    const versionMiddleware = new VersionMiddleware({
+        latestVersions: {
+            android: STAMHOOFD.LATEST_ANDROID_VERSION,
+            ios: STAMHOOFD.LATEST_IOS_VERSION,
+            web: Version
+        },
+        minimumVersion: 168
+    })
+    routerServer.addRequestMiddleware(versionMiddleware)
+    routerServer.addResponseMiddleware(versionMiddleware)
+
+    // Add CORS headers
+    routerServer.addResponseMiddleware(CORSMiddleware)
+
+    routerServer.listen(STAMHOOFD.PORT ?? 9090);
+
+    if (routerServer.server) {
+        // Default timeout is a bit too short
+        routerServer.server.timeout = 61000;
+    }
+
+    let shuttingDown = false;
+    const shutdown = async () => {
+        if (shuttingDown) {
+            return
+        }
+        shuttingDown = true
+        console.log("Shutting down...")
+        // Disable keep alive
+        routerServer.defaultHeaders = Object.assign(routerServer.defaultHeaders, { 'Connection': 'close' })
+        if (routerServer.server) {
+            routerServer.server.headersTimeout = 5000;
+            routerServer.server.keepAliveTimeout = 1;
+        }
+        
+        stopCronScheduling();
+        clearInterval(cronInterval)
+
+        try {
+            await routerServer.close()
+            console.log("HTTP server stopped");
+        } catch (err) {
+            console.error("Failed to stop HTTP server:");
+            console.error(err);
+        }
+
+        try {
+            while (areCronsRunning()) {
+                console.log("Crons are still running. Waiting 2 seconds...")
+                await sleep(2000)
+            }
+        } catch (err) {
+            console.error("Failed to wait for crons to finish:");
+            console.error(err);
+        }
+
+        try {
+            while (Email.currentQueue.length > 0) {
+                console.log("Emails still in queue. Waiting 2 seconds...")
+                await sleep(2000)
+            }
+        } catch (err) {
+            console.error("Failed to wait for emails to finish:");
+            console.error(err);
+        }
+
+        try {
+            await Database.end()
+            console.log("MySQL connections closed");
+        } catch (err) {
+            console.error("Failed to close MySQL connection:")
+            console.error(err);
+        }
+
+        // Should not be needed, but added for security as sometimes a promise hangs somewhere
+        process.exit(0);
+    };
+
+    process.on("SIGTERM", () => {
+        console.info("SIGTERM signal received.");
+        shutdown().catch((e) => {
+            console.error(e)
+            process.exit(1);
+        });
+    });
+
+    process.on("SIGINT", () => {
+        console.info("SIGINT signal received.");
+        shutdown().catch((e) => {
+            console.error(e)
+            process.exit(1);
+        });
+    });
+
+    const cronInterval = setInterval(() => {
+        crons().catch(console.error)
+    }, 5 * 60 * 1000);
+    crons().catch(console.error)
+    seeds().catch(console.error);
+};
+
+start().catch(error => {
+    console.error("unhandledRejection", error);
+    process.exit(1);
+});

package/jest.config.js

@@ -0,0 +1,11 @@
+
+module.exports = {
+    roots: ["<rootDir>/dist"],
+    testEnvironment: "node",
+    setupFilesAfterEnv: [
+        "jest-extended/all",
+        "./dist/tests/jest.setup.js",
+    ],
+    globalSetup:  "./dist/tests/jest.global.setup.js"
+    //verbose: true,
+};

package/migrations.ts

@@ -0,0 +1,33 @@
+require('@stamhoofd/backend-env').load()
+import { Column, Migration } from "@simonbackx/simple-database";
+import { Version } from "@stamhoofd/structures";
+import path from "path";
+
+Column.setJSONVersion(Version);
+process.env.TZ = "UTC";
+
+const emailPath = require.resolve("@stamhoofd/email")
+const modelsPath = require.resolve("@stamhoofd/models")
+
+// Validate UTC timezone
+if (new Date().getTimezoneOffset() != 0) {
+    throw new Error("Process should always run in UTC timezone");
+}
+
+const start = async () => {
+    // External migrations
+    await Migration.runAll(path.dirname(modelsPath) + "/migrations");
+    await Migration.runAll(path.dirname(emailPath) + "/migrations");
+
+    // Internal
+    await Migration.runAll(__dirname + "/src/migrations");
+};
+
+start()
+    .catch(error => {
+        console.error("unhandledRejection", error);
+        process.exit(1);
+    })
+    .finally(() => {
+        process.exit();
+    });

package/package.json

@@ -0,0 +1,48 @@
+{
+    "name": "@stamhoofd/backend",
+    "version": "1.0.0",
+    "main": "index.ts",
+    "license": "UNLICENCED",
+    "scripts": {
+        "dev": "concurrently -r \"rm -rf ./dist && wait-on ./dist/index.js && nodemon --quiet --inspect=5858 --watch dist --delay 200ms --exec node --enable-source-maps ./dist/index.js --signal SIGTERM\" 'yarn build --watch --preserveWatchOutput'",
+        "dev:backend": "yarn dev",
+        "build": "rm -rf ./dist/src/migrations && rm -rf ./dist/src/seeds && tsc -b",
+        "build:full": "yarn clear && yarn build",
+        "clear": "rm -rf ./dist",
+        "start": "yarn build && node --enable-source-maps ./dist/index.js",
+        "test": "jest --runInBand",
+        "test:reset": "yarn build:full && jest --runInBand",
+        "migrations": "yarn build:full && node ./dist/migrations.js",
+        "lint": "eslint . --ext .js,.jsx,.ts,.tsx"
+    },
+    "devDependencies": {
+        "@types/cookie": "^0.5.1",
+        "@types/luxon": "^2.0.8",
+        "@types/mailparser": "3.4.4",
+        "@types/mysql": "^2.15.20",
+        "@types/node": "^18.11.17",
+        "nock": "^13.5.1",
+        "qs": "^6.11.2",
+        "sinon": "^17.0.1"
+    },
+    "dependencies": {
+        "@mollie/api-client": "3.7.0",
+        "@simonbackx/simple-database": "1.24.0",
+        "@simonbackx/simple-endpoints": "1.13.0",
+        "@simonbackx/simple-logging": "^1.0.1",
+        "aws-sdk": "^2.885.0",
+        "axios": "1.6.8",
+        "cookie": "^0.5.0",
+        "formidable": "3.5.1",
+        "handlebars": "^4.7.7",
+        "jsonwebtoken": "9.0.0",
+        "luxon": "^2.2.0",
+        "mailparser": "3.7.0",
+        "mockdate": "^3.0.2",
+        "mysql": "^2.18.1",
+        "node-rsa": "1.1.1",
+        "openid-client": "^5.4.0",
+        "postmark": "4.0.2",
+        "stripe": "^11.5.0"
+    }
+}