Merge pull request #83 from beabee-communityrm/refactor/split-webhooks

refactor: move webhooks to separate app

.github/workflows/deploy.yml

@@ -63,7 +63,7 @@ jobs:
       - name: Build and push legacy app
         uses: docker/build-push-action@v5
         with:
-          file: ./apps/backend/Dockerfile
+          file: ./packages/docker/base.dockerfile
           push: true
           build-args: |
             REVISION=${{ github.sha }}
@@ -74,7 +74,7 @@ jobs:
       - name: Build and push API app
         uses: docker/build-push-action@v5
         with:
-          file: ./apps/backend/Dockerfile
+          file: ./packages/docker/base.dockerfile
           push: true
           build-args: |
             REVISION=${{ github.sha }}
@@ -85,7 +85,7 @@ jobs:
       - name: Build and push webhook app
         uses: docker/build-push-action@v5
         with:
-          file: ./apps/backend/Dockerfile
+          file: ./packages/docker/base.dockerfile
           push: true
           build-args: |
             REVISION=${{ github.sha }}
@@ -96,7 +96,7 @@ jobs:
       - name: Build and push cron app
         uses: docker/build-push-action@v5
         with:
-          file: ./apps/backend/Dockerfile
+          file: ./packages/docker/base.dockerfile
           push: true
           build-args: |
             REVISION=${{ github.sha }}

.vscode/beabee.code-workspace

@@ -16,6 +16,10 @@
       "name": "apps/router",
       "path": "../apps/router",
     },
+    {
+      "name": "apps/webhooks",
+      "path": "../apps/webhooks",
+    },
     {
       "name": "packages/common",
       "path": "../packages/common",

apps/backend/src/api/app.ts

@@ -24,7 +24,7 @@ import {
   requestLogger
 } from "@beabee/core/logging";
 import sessions from "@core/sessions";
-import { initApp, startServer } from "@core/server";
+import { initApp, startServer } from "@beabee/core/server";
 
 import { Contact } from "@beabee/core/models";
 

apps/backend/src/app.ts

@@ -12,7 +12,7 @@ import helmet from "helmet";
 import appLoader from "@core/app-loader";
 import { log, requestErrorLogger, requestLogger } from "@beabee/core/logging";
 import quickflash from "@core/quickflash";
-import { initApp, startServer } from "@core/server";
+import { initApp, startServer } from "@beabee/core/server";
 import sessions from "@core/sessions";
 import { isInvalidType } from "@beabee/core/utils/db";
 

apps/backend/src/tools/configure.ts

@@ -3,7 +3,7 @@ import "module-alias/register";
 import { checkbox, input } from "@inquirer/prompts";
 
 import { getRepository } from "@beabee/core/database";
-import { runApp } from "@core/server";
+import { runApp } from "@beabee/core/server";
 
 import OptionsService from "@beabee/core/services/OptionsService";
 

apps/backend/src/tools/database/export-demo.ts

@@ -3,7 +3,7 @@ import "module-alias/register";
 import { Brackets } from "typeorm";
 
 import { createQueryBuilder } from "@beabee/core/database";
-import { runApp } from "@core/server";
+import { runApp } from "@beabee/core/server";
 
 import { Contact, Callout, CalloutResponse } from "@beabee/core/models";
 

apps/backend/src/tools/database/export.ts

@@ -1,6 +1,6 @@
 import "module-alias/register";
 
-import { runApp } from "@core/server";
+import { runApp } from "@beabee/core/server";
 
 import * as models from "./anonymisers/models";
 import { anonymiseModel, clearModels } from "./anonymisers";

apps/backend/src/tools/database/import-callout-responses.ts

@@ -11,7 +11,7 @@ import {
 } from "@beabee/beabee-common";
 import { getRepository, runTransaction } from "@beabee/core/database";
 import { Callout, CalloutResponse, Contact } from "@beabee/core/models";
-import { runApp } from "@core/server";
+import { runApp } from "@beabee/core/server";
 import { parse } from "csv-parse";
 import { In } from "typeorm";
 

apps/backend/src/tools/database/import-steady.ts

@@ -10,7 +10,7 @@ import { parse } from "csv-parse";
 import { In } from "typeorm";
 
 import { getRepository } from "@beabee/core/database";
-import { runApp } from "@core/server";
+import { runApp } from "@beabee/core/server";
 import { normalizeEmailAddress } from "@beabee/core/utils/index";
 
 import ContactsService from "@beabee/core/services/ContactsService";

apps/backend/src/tools/database/import.ts

@@ -3,7 +3,7 @@ import "module-alias/register";
 import readline from "readline";
 
 import { dataSource } from "@beabee/core/database";
-import { runApp } from "@core/server";
+import { runApp } from "@beabee/core/server";
 
 import config from "@beabee/core/config";
 

apps/backend/src/tools/gocardless/migrate-to-stripe.ts

@@ -7,7 +7,7 @@ import Stripe from "stripe";
 import { Equal, In } from "typeorm";
 
 import { createQueryBuilder, getRepository } from "@beabee/core/database";
-import { runApp } from "@core/server";
+import { runApp } from "@beabee/core/server";
 import { stripe, stripeTypeToPaymentMethod } from "@beabee/core/lib/stripe";
 
 import PaymentService from "@beabee/core/services/PaymentService";

apps/backend/src/tools/mailchimp/sync.ts

@@ -6,7 +6,7 @@ import { Between } from "typeorm";
 
 import { getRepository } from "@beabee/core/database";
 import { log as mainLogger } from "@beabee/core/logging";
-import { runApp } from "@core/server";
+import { runApp } from "@beabee/core/server";
 
 import NewsletterService from "@beabee/core/services/NewsletterService";
 import OptionsService from "@beabee/core/services/OptionsService";

apps/backend/src/tools/new-user.ts

@@ -8,7 +8,7 @@ import { input, password, select } from "@inquirer/prompts";
 import moment from "moment";
 
 import { getRepository } from "@beabee/core/database";
-import { runApp } from "@core/server";
+import { runApp } from "@beabee/core/server";
 import { passwordRequirements } from "@core/utils/auth";
 import { generatePassword } from "@beabee/core/utils/auth";
 

apps/backend/src/tools/process-segments.ts

@@ -4,7 +4,7 @@ import { In } from "typeorm";
 
 import { getRepository } from "@beabee/core/database";
 import { log as mainLogger } from "@beabee/core/logging";
-import { runApp } from "@core/server";
+import { runApp } from "@beabee/core/server";
 
 import EmailService from "@beabee/core/services/EmailService";
 import NewsletterService from "@beabee/core/services/NewsletterService";

apps/backend/src/tools/start-gifts.ts

@@ -5,7 +5,7 @@ import { Between } from "typeorm";
 
 import { getRepository } from "@beabee/core/database";
 import { log as mainLogger } from "@beabee/core/logging";
-import { runApp } from "@core/server";
+import { runApp } from "@beabee/core/server";
 
 import GiftService from "@beabee/core/services/GiftService";
 

apps/backend/src/tools/test-users.ts

@@ -9,7 +9,7 @@ import moment from "moment";
 import { Brackets } from "typeorm";
 
 import { createQueryBuilder } from "@beabee/core/database";
-import { runApp } from "@core/server";
+import { runApp } from "@beabee/core/server";
 import { getActualAmount } from "@beabee/core/utils/payment";
 
 import config from "@beabee/core/config";

apps/webhooks/.prettierignore

@@ -0,0 +1 @@
+/dist/

apps/webhooks/.prettierrc.mjs

@@ -0,0 +1,2 @@
+import { baseConfig } from "@beabee/prettier-config";
+export default baseConfig;

apps/webhooks/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "@beabee/webhooks",
+  "version": "0.16.0",
+  "description": "A community engagement system for community newsrooms",
+  "private": true,
+  "main": "dist/app.js",
+  "type": "commonjs",
+  "imports": {
+    "#*": "./dist/*.js"
+  },
+  "scripts": {
+    "build": "rimraf built/ && tsc -p ./tsconfig.build.json",
+    "dev": "tsc-watch -p tsconfig.build.json --noClear --onSuccess 'docker compose restart webhook_app'",
+    "watch": "tsc-watch -p tsconfig.build.json --noClear",
+    "format": "prettier --write .",
+    "generate:index": "barrelsby -c barrelsby.json",
+    "test": "jest --setupFiles dotenv/config --passWithNoTests",
+    "check": "concurrently 'yarn:check:*'",
+    "check:tsc": "tsc --noEmit",
+    "check:prettier": "prettier -c .",
+    "check:dependencies": "dpdm -T --no-warning --no-tree --exit-code circular:1 src/app.ts"
+  },
+  "dependencies": {
+    "@beabee/beabee-common": "workspace:^",
+    "@beabee/core": "workspace:^",
+    "body-parser": "^1.20.2",
+    "date-fns": "^4.1.0",
+    "express": "^4.19.2",
+    "gocardless-nodejs": "^3.25.0",
+    "moment": "^2.30.1",
+    "stripe": "^15.9.0",
+    "typeorm": "^0.3.20"
+  },
+  "devDependencies": {
+    "@beabee/prettier-config": "workspace:^",
+    "@beabee/tsconfig": "workspace:^",
+    "@tsconfig/node20": "^20.1.4",
+    "@types/express": "^4.17.21",
+    "@types/node": "^20.14.1",
+    "barrelsby": "^2.8.1",
+    "concurrently": "^9.1.0",
+    "dotenv": "^16.4.5",
+    "dpdm": "^3.14.0",
+    "jest": "^29.7.0",
+    "prettier": "3.3.3",
+    "rimraf": "^6.0.1",
+    "ts-jest": "^29.2.5",
+    "ts-node": "^10.9.2",
+    "tsc-watch": "^6.3.0",
+    "typescript": "^5.6.3"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/beabee-communityrm/monorepo.git"
+  },
+  "author": "",
+  "license": "AGPL-3.0",
+  "bugs": {
+    "url": "https://github.com/beabee-communityrm/monorepo/issues"
+  },
+  "homepage": "https://github.com/beabee-communityrm/monorepo/blob/main/apps/webhooks/README.md"
+}

apps/backend/src/webhooks/app.ts → apps/webhooks/src/app.ts

@@ -1,17 +1,15 @@
-import "module-alias/register";
-
 import express, { Handler } from "express";
 
 import { log, requestErrorLogger, requestLogger } from "@beabee/core/logging";
-import { initApp, startServer } from "@core/server";
+import { initApp, startServer } from "@beabee/core/server";
 
 import OptionsService, {
   OptionKey
 } from "@beabee/core/services/OptionsService";
 
-import gocardlessApp from "./handlers/gocardless";
-import mailchimpApp from "./handlers/mailchimp";
-import stripeApp from "./handlers/stripe";
+import gocardlessApp from "#handlers/gocardless";
+import mailchimpApp from "#handlers/mailchimp";
+import stripeApp from "#handlers/stripe";
 
 function checkOpt(key: OptionKey): Handler {
   return (req, res, next) => {

apps/backend/src/webhooks/handlers/gocardless.ts → apps/webhooks/src/handlers/gocardless.ts

@@ -14,7 +14,7 @@ import {
   updatePayment,
   cancelSubscription,
   cancelMandate
-} from "../utils/gocardless";
+} from "#utils/gocardless";
 
 const log = mainLogger.child({ app: "webhook-gocardless" });
 

apps/backend/src/tools/stripe/resync.ts → apps/webhooks/src/tools/resync-stripe.ts

@@ -1,19 +1,14 @@
-import "module-alias/register";
-
 import { PaymentMethod } from "@beabee/beabee-common";
 import { In } from "typeorm";
 
 import { getRepository } from "@beabee/core/database";
-import { runApp } from "@core/server";
+import { runApp } from "@beabee/core/server";
 import { stripe } from "@beabee/core/lib/stripe";
 import ContactsService from "@beabee/core/services/ContactsService";
 
 import { ContactContribution } from "@beabee/core/models";
 
-import {
-  handleInvoicePaid,
-  handleInvoiceUpdated
-} from "../../webhooks/handlers/stripe";
+import { handleInvoicePaid, handleInvoiceUpdated } from "#handlers/stripe";
 
 const isDangerMode = process.argv.includes("--danger");
 

apps/webhooks/tsconfig.build.json

@@ -0,0 +1,13 @@
+{
+  "extends": "@beabee/tsconfig/tsconfig.server.json",
+  "include": ["./src/**/*", "./src/**/*.json"],
+  "exclude": ["./**/*.test.ts"],
+  "compilerOptions": {
+    "rootDir": "./src",
+    "outDir": "./dist",
+    "paths": {},
+
+    // Add additional type root for local typings
+    "typeRoots": ["./src/typings", "./node_modules/@types/"]
+  }
+}

apps/webhooks/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "extends": [
+    "./tsconfig.build.json",
+    "@beabee/tsconfig/tsconfig.options.json"
+  ],
+  "exclude": [], // Override tsconfig.build.json exclude
+  "references": [{ "path": "../../packages/core" }],
+  "compilerOptions": {
+    "noEmit": true
+  }
+}