fix: expose with the /api prefix (#2037)

Author: spaenleh

.devcontainer/docker-compose.yml

@@ -45,7 +45,7 @@ services:
     # Overrides default command so things don't shut down after the process ends.
     command: sleep infinity
     ports:
-      - 3000:3000
+      - 3001:3000
 
   db:
     hostname: db
@@ -185,5 +185,16 @@ services:
     ports:
       - "1080:1080"
 
+  nginx:
+    image: nginx:1.25-alpine
+    hostname: nginx
+    depends_on:
+      - core
+    ports:
+      - "3000:3000" # expose nginx on localhost:3000
+    volumes:
+      - ./nginx/nginx.conf:/etc/nginx/nginx.conf:ro
+    restart: unless-stopped
+
 volumes:
   postgres-data:

.devcontainer/nginx/nginx.conf

@@ -0,0 +1,67 @@
+# nginx.conf
+# This Nginx config listens on port 3000 and appends /api to the incoming request path,
+# then forwards it to the 'core' container on port 3000.
+# It also preserves important headers and supports WebSocket upgrades.
+
+events {
+  worker_connections 1024;
+}
+
+http {
+  # Basic proxy settings
+  proxy_redirect off;
+  proxy_buffering off;
+  client_max_body_size 50m;
+
+  # Timeouts
+  proxy_connect_timeout 5s;
+  proxy_send_timeout 60s;
+  proxy_read_timeout 60s;
+
+  # Forwarded headers
+  map $http_upgrade $connection_upgrade {
+    default upgrade;
+    ''      close;
+  }
+
+  upstream core_upstream {
+    server core:3000; # Docker DNS resolves the 'core' service name
+    keepalive 32;
+  }
+
+  server {
+    listen 3000;
+    server_name _;
+
+    # Health check endpoint
+    location = /health {
+      return 200 "ok (nginx)\n";
+      add_header Content-Type text/plain;
+    }
+
+    # Catch-all: append /api to request path and proxy to core
+    # Example: GET /users -> proxied as /api/users
+    location / {
+      # Rewrite the path by inserting /api right after the leading slash
+      # $request_uri includes path + args; we'll rewrite just the path and preserve query string
+      set $new_path /api$uri;
+
+      # Proxy to core using the rewritten path; args preserved
+      proxy_set_header Host $host;
+      proxy_set_header X-Forwarded-Host $host;
+      proxy_set_header X-Real-IP $remote_addr;
+      proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+      proxy_set_header X-Forwarded-Proto $scheme;
+
+      # WebSocket support
+      proxy_set_header Upgrade $http_upgrade;
+      proxy_set_header Connection $connection_upgrade;
+
+      proxy_http_version 1.1;
+
+      # Use proxy_pass with a URI to keep our rewritten $new_path
+      # We construct the full URI using the variable and keep query string via $is_args$args
+      proxy_pass http://core_upstream$new_path$is_args$args;
+    }
+  }
+}

.dockerignore

@@ -8,6 +8,7 @@ test
 tmp
 **/test
 **/*.test.ts
+**/*.spec.ts
 types
 docker
 API Collections

.github/workflows/test.yml

@@ -52,7 +52,7 @@ env:
   GEOLOCATION_API_HOST: http://localhost:12345
 
 jobs:
-  build-node:
+  build-unit:
     runs-on: ubuntu-latest
 
     # Service containers to run with `container-job`
@@ -127,8 +127,9 @@ jobs:
         run: yarn vitest
 
   test-node:
-    needs: build-node
     strategy:
+      # NOTE: switch this on if you want to have the result of all the shards to fix more tests at once.
+      # fail-fast: false
       matrix:
         shard: [1/4, 2/4, 3/4, 4/4]
     runs-on: ubuntu-latest

package.json

@@ -67,7 +67,7 @@
     "@fastify/type-provider-typebox": "5.1.0",
     "@fastify/websocket": "11.0.2",
     "@graasp/etherpad-api": "2.1.1",
-    "@graasp/sdk": "5.16.4",
+    "@graasp/sdk": "5.16.5",
     "@rapideditor/country-coder": "5.4.0",
     "@sentry/node": "7.119.2",
     "@sentry/tracing": "7.120.3",

setup.node.ts

@@ -1 +1,4 @@
+import { config } from 'dotenv';
 import 'reflect-metadata';
+
+config({ path: '.env.test', override: true });

src/app.ts

@@ -41,30 +41,30 @@ export default async function (instance: FastifyInstance): Promise<void> {
 
   // register some dependencies manually
   registerDependencies(instance.log);
-
-  await instance.register(fp(metaPlugin));
+  await instance.register(metaPlugin);
 
   await instance.register(fp(passportPlugin));
-  // need to be defined before member and item for auth check
-
-  await instance.register(maintenancePlugin);
-
-  await instance.register(fp(authPlugin));
 
-  await instance.register(async (instance) => {
-    // core API modules
-    await instance
-      // the websockets plugin must be registered before but in the same scope as the apis
-      // otherwise tests somehow bypass mocking the authentication through jest.spyOn(app, 'verifyAuthentication')
-      .register(fp(websocketsPlugin), {
-        prefix: '/ws',
-        redis: {
-          channelName: 'graasp-realtime-updates',
-          connection: REDIS_CONNECTION,
-        },
-      })
-      .register(fp(MemberServiceApi))
-      .register(fp(ItemServiceApi))
-      .register(tagPlugin);
-  });
+  await instance.register(
+    async (instance) => {
+      // need to be defined before member and item for auth check
+      await instance.register(fp(authPlugin));
+      // core API modules
+      await instance
+        // the websockets plugin must be registered before but in the same scope as the apis
+        // otherwise tests somehow bypass mocking the authentication through jest.spyOn(app, 'verifyAuthentication')
+        .register(fp(websocketsPlugin), {
+          prefix: '/ws',
+          redis: {
+            channelName: 'graasp-realtime-updates',
+            connection: REDIS_CONNECTION,
+          },
+        })
+        .register(fp(MemberServiceApi))
+        .register(fp(ItemServiceApi))
+        .register(tagPlugin)
+        .register(maintenancePlugin);
+    },
+    { prefix: '/api' },
+  );
 }

src/langs/fr.json

@@ -2,7 +2,7 @@
   "GREETINGS": "Merci de vous être inscrit-e sur notre plateforme.",
   "SIGN_UP_VERIFY_EMAIL": "Vérifiez votre e-mail en cliquant sur le bouton ci-dessous.",
   "SIGN_UP_TEXT": "Complétez l'inscription et connectez-vous.",
-  "IGNORE_EMAIL_IF_NOT_REQUESTED": "Si vous n'êtes pas l'auteur-e de cette action', vous pouvez ignorer cet e-mail.",
+  "IGNORE_EMAIL_IF_NOT_REQUESTED": "Si vous n'êtes pas l'auteur-e de cette action, vous pouvez ignorer cet e-mail.",
   "SIGN_IN_BUTTON_TEXT": "Se connecter",
   "SIGN_UP_BUTTON_TEXT": "S'inscrire",
   "SIGN_IN_TEXT": "Vous nous avez demandé un lien magique pour vous connecter rapidement. Le voici :",

src/plugins/mailer/builder.test.ts src/plugins/mailer/builder.spec.tssrc/plugins/mailer/builder.test.ts renamed to src/plugins/mailer/builder.spec.ts

@@ -1,4 +1,5 @@
 import { faker } from '@faker-js/faker';
+import { describe, expect, it } from 'vitest';
 
 import { TRANSLATIONS } from '../../langs/constants';
 import enTranslations from '../../langs/en.json';

src/plugins/meta.ts

@@ -90,7 +90,7 @@ const plugin: FastifyPluginAsyncTypebox = async (fastify) => {
     return 'OK' as const;
   });
 
-  fastify.get('/status', async (_, reply) => {
+  fastify.get('/api/status', async (_, reply) => {
     const searchService = resolveDependency(SearchService);
     const api = new HealthyStatus().format();
     const database = (await getDBStatusCheck(fastify.log)).format();
@@ -110,7 +110,7 @@ const plugin: FastifyPluginAsyncTypebox = async (fastify) => {
     };
   });
 
-  fastify.get('/version', async (_, reply) => {
+  fastify.get('/api/version', async (_, reply) => {
     // allow request cross origin
     reply.header('Access-Control-Allow-Origin', '*');
     return `${APP_VERSION} @ ${BUILD_TIMESTAMP}`;