feat(agora): migrate Agora to spec-first development workflow (#2767)

undefined
Sage-Bionetworks · Aug 22, 2024 · 2199038 · 2199038
1 parent 0313887
commit 2199038
Show file tree

Hide file tree

Showing 143 changed files with 3,324 additions and 1,222 deletions.
diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json
@@ -118,7 +118,7 @@
       "onAutoForward": "silent"
     },
     "3333": {
-      "label": "agora-server",
+      "label": "agora-api",
       "onAutoForward": "silent"
     },
     "4200": {

diff --git a/apps/agora/apex/.env.example b/apps/agora/apex/.env.example
@@ -0,0 +1,6 @@
+API_DOCS_HOST=agora-api-docs
+API_DOCS_PORT=8010
+API_HOST=agora-api
+API_PORT=3333
+APP_HOST=agora-app
+APP_PORT=4200
diff --git a/apps/agora/apex/Caddyfile b/apps/agora/apex/Caddyfile
@@ -0,0 +1,14 @@
+:80 {
+  handle_path /api-docs* {
+    reverse_proxy {env.API_DOCS_HOST}:{env.API_DOCS_PORT}
+  }
+
+  # Serve the API, stripping the /api prefix
+  handle_path /api/* {
+    reverse_proxy {env.API_HOST}:{env.API_PORT}
+  }
+
+  handle {
+    reverse_proxy {env.APP_HOST}:{env.APP_PORT}
+  }
+}
diff --git a/apps/agora/apex/Dockerfile b/apps/agora/apex/Dockerfile
@@ -0,0 +1 @@
+FROM caddy:2.8.4
diff --git a/apps/agora/apex/project.json b/apps/agora/apex/project.json
@@ -0,0 +1,68 @@
+{
+  "name": "agora-apex",
+  "$schema": "../../../node_modules/nx/schemas/project-schema.json",
+  "projectType": "application",
+  "targets": {
+    "create-config": {
+      "executor": "nx:run-commands",
+      "options": {
+        "command": "cp -n .env.example .env",
+        "cwd": "{projectRoot}"
+      }
+    },
+    "serve-detach": {
+      "executor": "nx:run-commands",
+      "options": {
+        "command": "docker/agora/serve-detach.sh agora-apex"
+      }
+    },
+    "build-image": {
+      "executor": "@nx-tools/nx-container:build",
+      "options": {
+        "context": "apps/agora/apex",
+        "metadata": {
+          "images": [
+            "ghcr.io/sage-bionetworks/agora-apex"
+          ],
+          "tags": [
+            "type=edge,branch=main",
+            "type=raw,value=local",
+            "type=sha"
+          ]
+        },
+        "push": false
+      }
+    },
+    "publish-image": {
+      "executor": "@nx-tools/nx-container:build",
+      "options": {
+        "context": "apps/agora/apex",
+        "metadata": {
+          "images": [
+            "ghcr.io/sage-bionetworks/agora-apex"
+          ],
+          "tags": [
+            "type=edge,branch=main",
+            "type=sha"
+          ]
+        },
+        "push": true
+      },
+      "dependsOn": [
+        "build-image"
+      ]
+    },
+    "scan-image": {
+      "executor": "nx:run-commands",
+      "options": {
+        "command": "trivy image ghcr.io/sage-bionetworks/agora-apex:local --quiet",
+        "color": true
+      }
+    }
+  },
+  "tags": [
+    "type:service",
+    "scope:backend"
+  ],
+  "implicitDependencies": []
+}
diff --git a/apps/agora/server/.env.example → apps/agora/api/.env.example b/apps/agora/server/.env.example → apps/agora/api/.env.example
diff --git a/apps/agora/server/.eslintrc.json → apps/agora/api/.eslintrc.json b/apps/agora/server/.eslintrc.json → apps/agora/api/.eslintrc.json
diff --git a/apps/agora/server/Dockerfile → apps/agora/api/Dockerfile b/apps/agora/server/Dockerfile → apps/agora/api/Dockerfile
@@ -5,11 +5,11 @@ ENV APP_DIR=/app
 RUN apk add --no-cache curl jq su-exec
 
 WORKDIR /
-COPY apps/agora/server/docker-entrypoint.sh .
-RUN chmod +x docker-entrypoint.sh 
+COPY apps/agora/api/docker-entrypoint.sh .
+RUN chmod +x docker-entrypoint.sh
 
 WORKDIR ${APP_DIR}
-COPY dist/apps/agora/server ${APP_DIR}
+COPY dist/apps/agora/api ${APP_DIR}
 RUN npm install
 
 HEALTHCHECK --interval=2s --timeout=3s --retries=20 --start-period=5s \

diff --git a/apps/agora/server/docker-entrypoint.sh → apps/agora/api/docker-entrypoint.sh b/apps/agora/server/docker-entrypoint.sh → apps/agora/api/docker-entrypoint.sh
diff --git a/apps/agora/server/jest.config.ts → apps/agora/api/jest.config.ts b/apps/agora/server/jest.config.ts → apps/agora/api/jest.config.ts
@@ -1,11 +1,11 @@
 /* eslint-disable */
 export default {
-  displayName: 'agora-server',
+  displayName: 'agora-api',
   preset: '../../../jest.preset.js',
   testEnvironment: 'node',
   transform: {
     '^.+\\.[tj]s$': ['ts-jest', { tsconfig: '<rootDir>/tsconfig.spec.json' }],
   },
   moduleFileExtensions: ['ts', 'js', 'html'],
-  coverageDirectory: '../../../coverage/apps/agora/server',
+  coverageDirectory: '../../../coverage/apps/agora/api',
 };
diff --git a/apps/agora/server/project.json → apps/agora/api/project.json b/apps/agora/server/project.json → apps/agora/api/project.json
@@ -1,7 +1,7 @@
 {
-  "name": "agora-server",
+  "name": "agora-api",
   "$schema": "../../../node_modules/nx/schemas/project-schema.json",
-  "sourceRoot": "apps/agora/server/src",
+  "sourceRoot": "apps/agora/api/src",
   "projectType": "application",
   "targets": {
     "create-config": {
@@ -13,16 +13,20 @@
     },
     "build": {
       "executor": "@nx/webpack:webpack",
-      "outputs": ["{options.outputPath}"],
+      "outputs": [
+        "{options.outputPath}"
+      ],
       "defaultConfiguration": "production",
       "options": {
         "target": "node",
         "compiler": "tsc",
-        "outputPath": "dist/apps/agora/server",
-        "main": "apps/agora/server/src/main.ts",
-        "tsConfig": "apps/agora/server/tsconfig.app.json",
-        "assets": ["apps/agora/server/src/assets"],
-        "webpackConfig": "apps/agora/server/webpack.config.js",
+        "outputPath": "dist/apps/agora/api",
+        "main": "apps/agora/api/src/main.ts",
+        "tsConfig": "apps/agora/api/tsconfig.app.json",
+        "assets": [
+          "apps/agora/api/src/assets"
+        ],
+        "webpackConfig": "apps/agora/api/webpack.config.js",
         "generatePackageJson": true
       },
       "configurations": {
@@ -34,21 +38,21 @@
       "executor": "@nx/js:node",
       "defaultConfiguration": "development",
       "options": {
-        "buildTarget": "agora-server:build"
+        "buildTarget": "agora-api:build"
       },
       "configurations": {
         "development": {
-          "buildTarget": "agora-server:build:development"
+          "buildTarget": "agora-api:build:development"
         },
         "production": {
-          "buildTarget": "agora-server:build:production"
+          "buildTarget": "agora-api:build:production"
         }
       }
     },
     "serve-detach": {
       "executor": "nx:run-commands",
       "options": {
-        "command": "docker/agora/serve-detach.sh agora-server"
+        "command": "docker/agora/serve-detach.sh agora-api"
       }
     },
     "lint": {
@@ -65,39 +69,56 @@
       "options": {
         "context": ".",
         "metadata": {
-          "images": ["ghcr.io/sage-bionetworks/agora-server"],
-          "tags": ["type=edge,branch=main", "type=raw,value=local", "type=sha"]
+          "images": [
+            "ghcr.io/sage-bionetworks/agora-api"
+          ],
+          "tags": [
+            "type=edge,branch=main",
+            "type=raw,value=local",
+            "type=sha"
+          ]
         },
         "push": false
       },
-      "dependsOn": ["build"]
+      "dependsOn": [
+        "build"
+      ]
     },
     "publish-image": {
       "executor": "@nx-tools/nx-container:build",
       "options": {
         "context": ".",
         "metadata": {
-          "images": ["ghcr.io/sage-bionetworks/agora-server"],
-          "tags": ["type=edge,branch=main", "type=sha"]
+          "images": [
+            "ghcr.io/sage-bionetworks/agora-api"
+          ],
+          "tags": [
+            "type=edge,branch=main",
+            "type=sha"
+          ]
         },
         "push": true
       },
-      "dependsOn": ["build-image"]
+      "dependsOn": [
+        "build-image"
+      ]
     },
     "scan-image": {
       "executor": "nx:run-commands",
       "options": {
-        "command": "trivy image ghcr.io/sage-bionetworks/agora-server:local --quiet",
+        "command": "trivy image ghcr.io/sage-bionetworks/agora-api:local --quiet",
         "color": true
       }
     },
     "test": {
       "executor": "@nx/jest:jest",
-      "outputs": ["{workspaceRoot}/coverage/{projectRoot}"],
+      "outputs": [
+        "{workspaceRoot}/coverage/{projectRoot}"
+      ],
       "options": {
-        "jestConfig": "apps/agora/server/jest.config.ts"
+        "jestConfig": "apps/agora/api/jest.config.ts"
       }
     }
   },
   "tags": []
-}
+}
diff --git a/apps/agora/server/src/api.ts → apps/agora/api/src/api.ts b/apps/agora/server/src/api.ts → apps/agora/api/src/api.ts
diff --git a/apps/agora/server/src/assets/.gitkeep → apps/agora/api/src/assets/.gitkeep b/apps/agora/server/src/assets/.gitkeep → apps/agora/api/src/assets/.gitkeep
diff --git a/...gora/server/src/components/dataversion.ts → apps/agora/api/src/components/dataversion.ts b/...gora/server/src/components/dataversion.ts → apps/agora/api/src/components/dataversion.ts
diff --git a/apps/agora/server/src/helpers.ts → apps/agora/api/src/helpers.ts b/apps/agora/server/src/helpers.ts → apps/agora/api/src/helpers.ts
diff --git a/apps/agora/server/src/main.ts → apps/agora/api/src/main.ts b/apps/agora/server/src/main.ts → apps/agora/api/src/main.ts
@@ -10,13 +10,13 @@ import api from './api';
 const app = express();
 
 app.use('/assets', express.static(path.join(__dirname, 'assets')));
-app.use('/api', api);
+app.use('/v1', api);
 
 // Health endpoint used by the container
 app.get('/health', (_req, res) => res.status(200).json({ status: 'UP' }));
 
 const port = process.env.PORT ?? 3333;
 const server = app.listen(port, () => {
-  console.log(`Listening at http://localhost:${port}/api`);
+  console.log(`Listening at http://localhost:${port}`);
 });
 server.on('error', console.error);
diff --git a/apps/agora/server/src/models/dataversion.ts → apps/agora/api/src/models/dataversion.ts b/apps/agora/server/src/models/dataversion.ts → apps/agora/api/src/models/dataversion.ts
@@ -1,7 +1,7 @@
-import { DataVersion } from '@sagebionetworks/agora/api-client-angular';
+import { Dataversion } from '@sagebionetworks/agora/api-client-angular';
 import { Schema, model } from 'mongoose';
 
-const DataVersionSchema = new Schema<DataVersion>(
+const DataVersionSchema = new Schema<Dataversion>(
   {
     data_file: { type: String, required: true },
     data_version: { type: String, required: true },
@@ -12,7 +12,7 @@ const DataVersionSchema = new Schema<DataVersion>(
   },
 );
 
-export const DataVersionCollection = model<DataVersion>(
+export const DataVersionCollection = model<Dataversion>(
   'DataVersionCollection',
   DataVersionSchema,
 );
diff --git a/apps/agora/server/tsconfig.app.json → apps/agora/api/tsconfig.app.json b/apps/agora/server/tsconfig.app.json → apps/agora/api/tsconfig.app.json
diff --git a/apps/agora/server/tsconfig.json → apps/agora/api/tsconfig.json b/apps/agora/server/tsconfig.json → apps/agora/api/tsconfig.json
@@ -13,4 +13,4 @@
   "compilerOptions": {
     "esModuleInterop": true
   }
-}
+}
diff --git a/apps/agora/server/tsconfig.spec.json → apps/agora/api/tsconfig.spec.json b/apps/agora/server/tsconfig.spec.json → apps/agora/api/tsconfig.spec.json
diff --git a/apps/agora/server/webpack.config.js → apps/agora/api/webpack.config.js b/apps/agora/server/webpack.config.js → apps/agora/api/webpack.config.js
diff --git a/apps/agora/app/.env.example b/apps/agora/app/.env.example
@@ -0,0 +1,7 @@
+API_DOCS_URL="http://localhost:8000/api-docs"
+APP_VERSION="1.0.0-alpha"
+CSR_API_URL="http://localhost:8000/api/v1"
+DATA_UPDATED_ON="2023-09-26"
+ENVIRONMENT="production"
+GOOGLE_TAG_MANAGER_ID=""
+SSR_API_URL="http://agora-api:8000/api/v1"
diff --git a/apps/agora/app/.eslintrc.json b/apps/agora/app/.eslintrc.json
@@ -19,15 +19,15 @@
           "error",
           {
             "type": "attribute",
-            "prefix": "agora",
+            "prefix": "app",
             "style": "camelCase"
           }
         ],
         "@angular-eslint/component-selector": [
           "error",
           {
             "type": "element",
-            "prefix": "agora",
+            "prefix": "app",
             "style": "kebab-case"
           }
         ]

diff --git a/apps/agora/app/Dockerfile b/apps/agora/app/Dockerfile
@@ -15,9 +15,9 @@ COPY dist/apps/agora/app/browser/server ${APP_DIR}
 COPY dist/apps/agora/app/browser/browser ${APP_DIR}/dist/apps/agora/app/browser/browser
 
 HEALTHCHECK --interval=2s --timeout=3s --retries=20 --start-period=5s \
-  CMD curl --fail --silent "localhost:5200/health" | jq '.status' | grep UP || exit 1
+  CMD curl --fail --silent "localhost:4200/health" | jq '.status' | grep UP || exit 1
 
-EXPOSE 5200
+EXPOSE 4200
 
 ENTRYPOINT ["/docker-entrypoint.sh"]
 

diff --git a/apps/agora/app/docker-entrypoint.d/10-envsubst-on-app-config-template.sh b/apps/agora/app/docker-entrypoint.d/10-envsubst-on-app-config-template.sh
@@ -1,4 +1,4 @@
 #!/usr/bin/env sh
 
-# cd "${APP_DIR}/dist/apps/agora/app/browser/browser/config"
-# envsubst < config.json.template > config.json
+cd "${APP_DIR}/dist/apps/agora/app/browser/browser/config"
+envsubst < config.json.template > config.json
diff --git a/apps/agora/app/docker-entrypoint.sh b/apps/agora/app/docker-entrypoint.sh
@@ -1,7 +1,7 @@
 #!/usr/bin/env sh
 set -e
 
-# /docker-entrypoint.d/10-envsubst-on-app-config-template.sh
+/docker-entrypoint.d/10-envsubst-on-app-config-template.sh
 
 if [ "$1" = 'node' ]; then
     cd ${APP_DIR}
-Original file line number
+Diff line change
@@ Expand Up / @@ -13,4 +13,4 @@ @@
       "compilerOptions": {
         "esModuleInterop": true
       }
-    }
+    }