v0.20.0 LTS node upgrade

.cspell.json

@@ -499,7 +499,10 @@
     "reactjs",
     "nextjs",
     "vanillajs",
+    "quckstart",
     "errmsg",
+    "devcontainer",
+    "INITDB",
     "springboot",
     "errmsg",
     "shelljs",

.devcontainer/Dockerfile

@@ -1,5 +1,5 @@
 # [Choice] Node.js version (use -bullseye variants on local arm64/Apple Silicon): 16, 14, 12, 16-bullseye, 14-bullseye, 12-bullseye, 16-buster, 14-buster, 12-buster
-ARG VARIANT=16-bullseye
+ARG VARIANT=18-bullseye
 FROM mcr.microsoft.com/vscode/devcontainers/javascript-node:0-${VARIANT}
 
 # Install MongoDB command line tools if on buster and x86_64 (arm64 not supported)
@@ -23,6 +23,3 @@ RUN . /etc/os-release \
 
 # [Optional] Uncomment if you want to install more global node modules
 RUN su node -c "npm install -g [email protected]"
-
-
-

.devcontainer/docker-compose.yml

@@ -9,7 +9,7 @@ services:
         # Update 'VARIANT' to pick an LTS version of Node.js: 16, 14, 12.
         # Append -bullseye or -buster to pin to an OS version.
         # Use -bullseye variants on local arm64/Apple Silicon.
-        VARIANT: 16-bullseye
+        VARIANT: 18-bullseye
     volumes:
       - ..:/workspace:cached
 

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -64,7 +64,7 @@ body:
     attributes:
       label: node version
       description: In case of self-hosting or local installation mention the node version. If using our cloud-managed solution, mention NA.
-      placeholder: 16.0.0
+      placeholder: 18.0.0
   - type: textarea
     id: additional-context
     validations:

.github/actions/docker/build-api/action.yml

@@ -101,7 +101,7 @@ runs:
         docker tag novu-api ghcr.io/$REGISTRY_OWNER/$DOCKER_NAME:$IMAGE_TAG
 
         docker run --network=host --name api -dit --env NODE_ENV=test ghcr.io/$REGISTRY_OWNER/$DOCKER_NAME:$IMAGE_TAG
-        docker run --network=host appropriate/curl --retry 10 --retry-delay 5 --retry-connrefused http://localhost:1337/v1/health-check | grep 'ok'
+        docker run --network=host appropriate/curl --retry 10 --retry-delay 5 --retry-connrefused http://127.0.0.1:1337/v1/health-check | grep 'ok'
 
         echo "IMAGE=ghcr.io/$REGISTRY_OWNER/$DOCKER_NAME:$IMAGE_TAG" >> $GITHUB_OUTPUT
 

.github/actions/docker/build-worker/action.yml

@@ -104,7 +104,7 @@ runs:
 
         echo "Run image"
         docker run --network=host --name worker -dit --env NODE_ENV=test ghcr.io/$REGISTRY_OWNER/$DOCKER_NAME:$IMAGE_TAG
-        docker run --network=host appropriate/curl --retry 10 --retry-delay 5 --retry-connrefused http://localhost:1342/v1/health-check | grep 'ok'
+        docker run --network=host appropriate/curl --retry 10 --retry-delay 5 --retry-connrefused http://127.0.0.1:1342/v1/health-check | grep 'ok'
 
         echo "IMAGE=ghcr.io/$REGISTRY_OWNER/$DOCKER_NAME:$IMAGE_TAG" >> $GITHUB_OUTPUT
 

.github/actions/run-api/action.yml

@@ -24,4 +24,4 @@ runs:
 
     - name: Wait on API
       shell: bash
-      run: wait-on --timeout=180000 http://localhost:1336/v1/health-check
+      run: wait-on --timeout=180000 http://127.0.0.1:1336/v1/health-check

.github/actions/run-backend/action.yml

@@ -26,7 +26,7 @@ runs:
         NODE_ENV: "test"
         PORT: "1336"
         TZ: "UTC"
-        GITHUB_OAUTH_REDIRECT: "http://localhost:1336/v1/auth/github/callback"
+        GITHUB_OAUTH_REDIRECT: "http://127.0.0.1:1336/v1/auth/github/callback"
         LAUNCH_DARKLY_SDK_KEY: ${{ inputs.launch_darkly_sdk_key }}
       run: cd apps/api && pnpm start:build &
 
@@ -41,4 +41,4 @@ runs:
 
     - name: Wait on API and Worker
       shell: bash
-      run: wait-on --timeout=180000 http://localhost:1336/v1/health-check http://localhost:1342/v1/health-check
+      run: wait-on --timeout=180000 http://127.0.0.1:1336/v1/health-check http://127.0.0.1:1342/v1/health-check

.github/actions/run-worker/action.yml

@@ -25,4 +25,4 @@ runs:
 
     - name: Wait on worker
       shell: bash
-      run: wait-on --timeout=180000 http://localhost:1342/v1/health-check
+      run: wait-on --timeout=180000 http://127.0.0.1:1342/v1/health-check

.github/actions/setup-project/action.yml

@@ -28,7 +28,7 @@ runs:
     - uses: actions/setup-node@v3
       name: ⚙️ Setup Node Version
       with:
-        node-version: '16.15.1'
+        node-version: '18.17.1'
         cache: 'pnpm'
 
     - name: 💵 Start Redis

.github/actions/start-localstack/action.yml

@@ -24,9 +24,9 @@ runs:
         do
           sleep 1
           [[ counter -eq $max_retry ]] && echo "Failed!" && exit 1
-          aws --endpoint-url=http://localhost:4566 s3 ls
+          aws --endpoint-url=http://127.0.0.1:4566 s3 ls
           echo "Trying again. Try #$counter"
           ((counter++))
         done
         docker-compose -f docker-compose.localstack.yml logs --tail="all"
-        aws --endpoint-url=http://localhost:4566 --cli-connect-timeout 600 s3 mb s3://novu-test
+        aws --endpoint-url=http://127.0.0.1:4566 --cli-connect-timeout 600 s3 mb s3://novu-test

.github/actions/validate-swagger/action.yml

@@ -9,7 +9,7 @@ runs:
     - name: Get swagger json as file
       shell: bash
       run: |
-        curl -o swagger.json http://localhost:1336/api-json  
+        curl -o swagger.json http://127.0.0.1:1336/api-json  
 
     - uses: char0n/swagger-editor-validate@v1
       with:

.github/workflows/community-label.yml

@@ -17,7 +17,7 @@ jobs:
 
       - uses: actions/setup-node@v3
         with:
-          node-version: 16
+          node-version: 18
       - name: Install Octokit
         run: npm --prefix .github/workflows/scripts install @octokit/action
 

.github/workflows/dev-deploy-webhook.yml

@@ -51,7 +51,7 @@ jobs:
           docker tag novu-webhook ghcr.io/$REGISTRY_OWNER/$DOCKER_NAME:$IMAGE_TAG
 
           docker run --network=host --name webhook -dit --env NODE_ENV=test ghcr.io/$REGISTRY_OWNER/$DOCKER_NAME:$IMAGE_TAG
-          docker run --network=host appropriate/curl --retry 10 --retry-delay 5 --retry-connrefused http://localhost:1341/v1/health-check | grep 'ok'
+          docker run --network=host appropriate/curl --retry 10 --retry-delay 5 --retry-connrefused http://127.0.0.1:1341/v1/health-check | grep 'ok'
 
           docker push ghcr.io/$REGISTRY_OWNER/$DOCKER_NAME:dev
           docker push ghcr.io/$REGISTRY_OWNER/$DOCKER_NAME:$IMAGE_TAG

.github/workflows/dev-deploy-ws.yml

@@ -99,7 +99,7 @@ jobs:
           echo $GH_PASSWORD | docker login ghcr.io -u $GH_ACTOR --password-stdin 
           docker build -t ghcr.io/$REGISTRY_OWNER/$DOCKER_NAME:$IMAGE_TAG --build-arg BULL_MQ_PRO_TOKEN=${BULL_MQ_PRO_NPM_TOKEN} -f apps/ws/Dockerfile . 
           docker run --network=host --name api -dit --env NODE_ENV=test ghcr.io/$REGISTRY_OWNER/$DOCKER_NAME:$IMAGE_TAG
-          docker run --network=host appropriate/curl --retry 10 --retry-delay 5 --retry-connrefused http://localhost:1340/v1/health-check | grep 'ok'
+          docker run --network=host appropriate/curl --retry 10 --retry-delay 5 --retry-connrefused http://127.0.0.1:1340/v1/health-check | grep 'ok'
           docker tag ghcr.io/$REGISTRY_OWNER/$DOCKER_NAME:$IMAGE_TAG ghcr.io/$REGISTRY_OWNER/$DOCKER_NAME:dev
           docker push ghcr.io/$REGISTRY_OWNER/$DOCKER_NAME:dev
           docker push ghcr.io/$REGISTRY_OWNER/$DOCKER_NAME:$IMAGE_TAG

.github/workflows/issue-label.yml

@@ -17,7 +17,7 @@ jobs:
 
       - uses: actions/setup-node@v3
         with:
-          node-version: 16
+          node-version: 18
       - name: Install Octokit
         run: npm --prefix .github/workflows/scripts install @octokit/action
 

.github/workflows/milestone-assign.yml

@@ -21,7 +21,7 @@ jobs:
 
       - uses: actions/setup-node@v3
         with:
-          node-version: 16
+          node-version: 18
       - name: Install Octokit
         run: npm --prefix .github/workflows/scripts install @octokit/action
 

.github/workflows/prod-deploy-api.yml

@@ -108,7 +108,7 @@ jobs:
           docker tag novu-api ghcr.io/$REGISTRY_OWNER/$DOCKER_NAME:$IMAGE_TAG
 
           docker run --network=host --name api -dit --env NODE_ENV=test ghcr.io/$REGISTRY_OWNER/$DOCKER_NAME:$IMAGE_TAG
-          docker run --network=host appropriate/curl --retry 10 --retry-delay 5 --retry-connrefused http://localhost:1337/v1/health-check | grep 'ok'
+          docker run --network=host appropriate/curl --retry 10 --retry-delay 5 --retry-connrefused http://127.0.0.1:1337/v1/health-check | grep 'ok'
 
           docker push ghcr.io/$REGISTRY_OWNER/$DOCKER_NAME:prod
           docker push ghcr.io/$REGISTRY_OWNER/$DOCKER_NAME:latest

.github/workflows/prod-deploy-webhook.yml

@@ -43,7 +43,7 @@ jobs:
           docker tag novu-webhook ghcr.io/$REGISTRY_OWNER/$DOCKER_NAME:$IMAGE_TAG
 
           docker run --network=host --name webhook -dit --env NODE_ENV=test ghcr.io/$REGISTRY_OWNER/$DOCKER_NAME:$IMAGE_TAG
-          docker run --network=host appropriate/curl --retry 10 --retry-delay 5 --retry-connrefused http://localhost:1341/v1/health-check | grep 'ok'
+          docker run --network=host appropriate/curl --retry 10 --retry-delay 5 --retry-connrefused http://127.0.0.1:1341/v1/health-check | grep 'ok'
 
           docker push ghcr.io/$REGISTRY_OWNER/$DOCKER_NAME:prod
           docker push ghcr.io/$REGISTRY_OWNER/$DOCKER_NAME:latest

.github/workflows/prod-deploy-worker.yml

@@ -71,7 +71,7 @@ jobs:
           docker tag novu-worker ghcr.io/$REGISTRY_OWNER/$DOCKER_NAME:$IMAGE_TAG
 
           docker run --network=host --name worker -dit --env NODE_ENV=test ghcr.io/$REGISTRY_OWNER/$DOCKER_NAME:$IMAGE_TAG
-          docker run --network=host appropriate/curl --retry 10 --retry-delay 5 --retry-connrefused http://localhost:1342/v1/health-check | grep 'ok'
+          docker run --network=host appropriate/curl --retry 10 --retry-delay 5 --retry-connrefused http://127.0.0.1:1342/v1/health-check | grep 'ok'
 
           docker push ghcr.io/$REGISTRY_OWNER/$DOCKER_NAME:prod
           docker push ghcr.io/$REGISTRY_OWNER/$DOCKER_NAME:latest

.github/workflows/prod-deploy-ws.yml

@@ -55,7 +55,7 @@ jobs:
           echo $GH_PASSWORD | docker login ghcr.io -u $GH_ACTOR --password-stdin 
           docker build --build-arg BULL_MQ_PRO_TOKEN=${BULL_MQ_PRO_NPM_TOKEN} -t ghcr.io/$REGISTRY_OWNER/$DOCKER_NAME:$IMAGE_TAG -f apps/ws/Dockerfile .
           docker run --network=host --name api -dit --env NODE_ENV=test ghcr.io/$REGISTRY_OWNER/$DOCKER_NAME:$IMAGE_TAG
-          docker run --network=host appropriate/curl --retry 10 --retry-delay 5 --retry-connrefused http://localhost:1340/v1/health-check | grep 'ok'
+          docker run --network=host appropriate/curl --retry 10 --retry-delay 5 --retry-connrefused http://127.0.0.1:1340/v1/health-check | grep 'ok'
           docker tag ghcr.io/$REGISTRY_OWNER/$DOCKER_NAME:$IMAGE_TAG ghcr.io/$REGISTRY_OWNER/$DOCKER_NAME:prod
           docker tag ghcr.io/$REGISTRY_OWNER/$DOCKER_NAME:$IMAGE_TAG ghcr.io/$REGISTRY_OWNER/$DOCKER_NAME:latest
           docker push ghcr.io/$REGISTRY_OWNER/$DOCKER_NAME:prod

.github/workflows/reusable-web-e2e.yml

@@ -74,9 +74,9 @@ jobs:
       - name: Start Client
         working-directory: apps/web
         env:
-          REACT_APP_API_URL: http://localhost:1336
-          REACT_APP_WS_URL: http://localhost:1340
-          REACT_APP_WEBHOOK_URL: http://localhost:1341
+          REACT_APP_API_URL: http://127.0.0.1:1336
+          REACT_APP_WS_URL: http://127.0.0.1:1340
+          REACT_APP_WEBHOOK_URL: http://127.0.0.1:1341
           REACT_APP_LAUNCH_DARKLY_CLIENT_SIDE_ID: ${{ secrets.TEST_LAUNCH_DARKLY_CLIENT_SIDE_ID }}
         run: pnpm start:static:build &
 
@@ -85,7 +85,7 @@ jobs:
           cd apps/ws && pnpm start:test &
 
       - name: Wait on Services
-        run: wait-on --timeout=180000 http://localhost:1340/v1/health-check http://localhost:4200
+        run: wait-on --timeout=180000 http://127.0.0.1:1340/v1/health-check http://0.0.0.0:4200/
 
       # run cypress install only when cache was not hit
       - name: Cypress install

.github/workflows/reusable-widget-e2e.yml

@@ -87,7 +87,7 @@ jobs:
           cd apps/ws && pnpm start:prod &
 
       - name: Wait on Widget and WS Services
-        run: wait-on --timeout=180000 http://localhost:1340/v1/health-check http://localhost:3500
+        run: wait-on --timeout=180000 http://127.0.0.1:1340/v1/health-check http://0.0.0.0:3500/
 
       - name: Cypress install
         if: steps.setup-project.outputs.cypress_cache_hit != 'true'
@@ -102,7 +102,7 @@ jobs:
           CYPRESS_RECORD_KEY: ${{ secrets.CYPRESS_WIDGET_KEY }}
         with:
           working-directory: apps/widget
-          wait-on: http://localhost:3500
+          wait-on: http://0.0.0.0:3500/
           browser: chrome
           install: false
           record: true

.github/workflows/tag-images.yml

@@ -26,7 +26,7 @@ jobs:
         run: echo fs.inotify.max_user_watches=524288 | sudo tee -a /etc/sysctl.conf && sudo sysctl -p
       - uses: actions/setup-node@v3
         with:
-          node-version: '16.15.1'
+          node-version: '18.17.1'
 
       - name: Login to docker
         env:
@@ -125,4 +125,3 @@ jobs:
           docker pull ghcr.io/$REGISTRY_OWNER/$DOCKER_NAME:prod
           docker tag ghcr.io/$REGISTRY_OWNER/$DOCKER_NAME:prod ghcr.io/$REGISTRY_OWNER/$DOCKER_NAME:$DOCKER_VERSION
           docker push ghcr.io/$REGISTRY_OWNER/$DOCKER_NAME:$DOCKER_VERSION
-

.nvmrc

@@ -1 +1 @@
-16.15.1
+18.17.1

CONTRIBUTING.md

@@ -20,7 +20,7 @@ You can open a new issue with this [issue form](https://github.com/novuhq/novu/i
 
 ### Requirements
 
-- Node.js version v16.15.1
+- Node.js version v18.17.1 (LTS)
 - MongoDB
 - Redis. To install Redis on your O.S, please follow the below guides
   - [To install Redis on Windows](https://redis.io/docs/getting-started/installation/install-redis-on-windows/)

apps/api/Dockerfile

@@ -1,4 +1,4 @@
-FROM nikolaik/python-nodejs:python3.10-nodejs16-alpine as dev_base
+FROM nikolaik/python-nodejs:python3.10-nodejs18-alpine as dev_base
 
 ARG BULL_MQ_PRO_TOKEN
 ENV BULL_MQ_PRO_NPM_TOKEN=$BULL_MQ_PRO_TOKEN

apps/api/src/.env.test

@@ -1,12 +1,12 @@
 GOOGLE_OAUTH_CLIENT_ID=11
 GOOGLE_OAUTH_CLIENT_SECRET=11
-GOOGLE_OAUTH_REDIRECT=http://localhost:3000/v1/auth/google/callback
+GOOGLE_OAUTH_REDIRECT=http://127.0.0.1:3000/v1/auth/google/callback
 STORE_ENCRYPTION_KEY="<ENCRYPTION_KEY_MUST_BE_32_LONG>"
 BLUEPRINT_CREATOR=645b648b36dd6d25f8650d37
 
-CLIENT_SUCCESS_AUTH_REDIRECT=http://localhost:4200/auth/login
+CLIENT_SUCCESS_AUTH_REDIRECT=http://127.0.0.1:4200/auth/login
 
-MONGO_URL=mongodb://localhost:27017/novu-test
+MONGO_URL=mongodb://127.0.0.1:27017/novu-test
 REDIS_PORT=6379
 REDIS_HOST=localhost
 REDIS_PREFIX=
@@ -21,7 +21,7 @@ REDIS_CACHE_CONNECTION_TIMEOUT=
 REDIS_CACHE_KEEP_ALIVE=
 REDIS_CACHE_FAMILY=
 REDIS_CACHE_KEY_PREFIX=
-REDIS_CACHE_ENABLE_AUTOPIPELINING=false 
+REDIS_CACHE_ENABLE_AUTOPIPELINING=false
 
 IS_IN_MEMORY_CLUSTER_MODE_ENABLED=false
 ELASTICACHE_CLUSTER_SERVICE_HOST=
@@ -36,8 +36,8 @@ REDIS_CLUSTER_KEEP_ALIVE=
 REDIS_CLUSTER_FAMILY=
 REDIS_CLUSTER_KEY_PREFIX=
 
-SYNC_PATH=http://localhost:3001
-API_ROOT_URL=http://localhost:3000
+SYNC_PATH=http://127.0.0.1:3001
+API_ROOT_URL=http://127.0.0.1:3000
 DISABLE_USER_REGISTRATION=false
 PORT=1337
 JWT_SECRET=ASD#asda23DFEFSFHG%fg
@@ -46,14 +46,14 @@ SENDGRID_API_KEY=SG.123123
 S3_ACCESS_KEY=
 S3_SECRET=
 REDIS_ARENA_PORT=4568
-FRONT_BASE_URL=http://localhost:4200
+FRONT_BASE_URL=http://127.0.0.1:4200
 [email protected]
-BACK_OFFICE_URL=http://localhost:5200
+BACK_OFFICE_URL=http://127.0.0.1:5200
 INTERCOM_API_KEY=
 GLOBAL_CONTEXT_PATH=
 API_CONTEXT_PATH=
 
-S3_LOCAL_STACK=http://localhost:4566
+S3_LOCAL_STACK=http://127.0.0.1:4566
 S3_BUCKET_NAME=novu-test
 S3_REGION=us-east-1
 GCS_BUCKET_NAME=novu-test
@@ -70,7 +70,7 @@ MAIL_SERVER_DOMAIN=
 
 VERCEL_CLIENT_ID=
 VERCEL_CLIENT_SECRET=
-VERCEL_REDIRECT_URI=http://localhost:4200/auth/login
+VERCEL_REDIRECT_URI=http://127.0.0.1:4200/auth/login
 VERCEL_BASE_URL=https://api.vercel.com
 
 FF_IS_TOPIC_NOTIFICATION_ENABLED=true

apps/api/src/.example.env

@@ -1,11 +1,11 @@
 NODE_ENV=local
 PORT=3000
-API_ROOT_URL=http://localhost:3000
-FRONT_BASE_URL=http://localhost:4200
+API_ROOT_URL=http://127.0.0.1:3000
+FRONT_BASE_URL=http://127.0.0.1:4200
 STORE_ENCRYPTION_KEY="<ENCRYPTION_KEY_MUST_BE_32_LONG>"
 DISABLE_USER_REGISTRATION=false
 
-MONGO_URL=mongodb://localhost:27017/novu-db
+MONGO_URL=mongodb://127.0.0.1:27017/novu-db
 MONGO_MAX_POOL_SIZE=500
 REDIS_PORT=6379
 REDIS_PREFIX=
@@ -37,7 +37,7 @@ REDIS_CLUSTER_KEY_PREFIX=
 
 JWT_SECRET=%LOCAL_TEST&@Ub4&9s
 
-S3_LOCAL_STACK=http://localhost:4566
+S3_LOCAL_STACK=http://127.0.0.1:4566
 S3_BUCKET_NAME=novu-local
 S3_REGION=us-east-1
 AWS_ACCESS_KEY_ID=test
@@ -51,7 +51,7 @@ GLOBAL_CONTEXT_PATH=
 API_CONTEXT_PATH=
 VERCEL_CLIENT_ID=
 VERCEL_CLIENT_SECRET=
-VERCEL_REDIRECT_URI=http://localhost:4200/auth/login
+VERCEL_REDIRECT_URI=http://127.0.0.1:4200/auth/login
 VERCEL_BASE_URL=https://api.vercel.com
 
 FF_IS_TOPIC_NOTIFICATION_ENABLED=true

apps/api/src/app/events/e2e/process-subscriber.e2e.ts

@@ -260,7 +260,7 @@ async function updateSubscriberPreference(
   subscriberToken: string,
   templateId: string
 ) {
-  return await axios.patch(`http://localhost:${process.env.PORT}/v1/widgets/preferences/${templateId}`, data, {
+  return await axios.patch(`http://127.0.0.1:${process.env.PORT}/v1/widgets/preferences/${templateId}`, data, {
     headers: {
       Authorization: `Bearer ${subscriberToken}`,
     },

apps/api/src/app/subscribers/e2e/get-notifications-feed.e2e.ts

@@ -93,7 +93,7 @@ describe('Get Notifications feed - /:subscriberId/notifications/feed (GET)', fun
 
 async function getNotificationsFeed(subscriberId: string, apiKey: string, query = {}) {
   const response = await axios.get(
-    `http://localhost:${process.env.PORT}/v1/subscribers/${subscriberId}/notifications/feed`,
+    `http://127.0.0.1:${process.env.PORT}/v1/subscribers/${subscriberId}/notifications/feed`,
     {
       params: {
         ...query,

apps/api/src/app/subscribers/e2e/get-unseen-count.e2e.ts

@@ -38,7 +38,7 @@ describe('Get Unseen Count - /:subscriberId/notifications/unseen (GET)', functio
 
 async function getUnSeenCount(subscriberId: string, apiKey: string, query = {}) {
   const response = await axios.get(
-    `http://localhost:${process.env.PORT}/v1/subscribers/${subscriberId}/notifications/unseen`,
+    `http://127.0.0.1:${process.env.PORT}/v1/subscribers/${subscriberId}/notifications/unseen`,
     {
       params: {
         ...query,