update file struct, readme, and ci/cd; add info api

Author: DylanBulmer

.github/workflows/docker-image.yml

@@ -46,9 +46,9 @@ jobs:
           tags: |
             type=ref,event=branch
             type=ref,event=pr
-            type=semver,pattern=v{{version}}
-            type=semver,pattern=v{{major}}.{{minor}}
-            type=semver,pattern=v{{major}}
+            type=semver,pattern={{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
             type=sha
             type=raw,value=latest,enable={{is_default_branch}}
 
@@ -73,9 +73,17 @@ jobs:
         uses: docker/build-push-action@v4
         with:
           context: .
+          platforms: linux/amd64,linux/arm64
           push: ${{ github.event_name != 'pull_request' }}
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}
+          build-args: |
+            VERSION=${{ github.event.release.tag_name }}
+            GIT_REPO=${{ github.repository }}
+            GIT_COMMIT=${{ github.sha }}
+            GIT_BRANCH=${{ github.ref_name }}
+          cache-from: type=registry,ref=${{ github.ref_name }}
+          cache-to: type=inline
 
       - name: Image digest
         run: echo ${{ steps.docker_build.outputs.digest }}

Dockerfile

@@ -16,13 +16,33 @@ RUN yarn build
 FROM node:16-alpine
 WORKDIR /usr/src
 
-COPY --from=builder /usr/src/dist ./dist
-COPY --from=builder /usr/src/node_modules ./node_modules
-COPY --from=builder /usr/src/package.json ./package.json
+# Set up env vars
+ARG VERSION
+ARG GIT_BRANCH
+ARG GIT_COMMIT
+ARG GIT_REPO
 
+ENV NODE_ENV="production"
+ENV VERSION=${VERSION}
+ENV GIT_BRANCH=${GIT_BRANCH}
+ENV GIT_COMMIT=${GIT_COMMIT}
+ENV GIT_REPO=${GIT_REPO}
+
+# Set up user and group
 RUN addgroup -g 1001 -S nodejs
 RUN adduser -S service -u 1001
-RUN chown -R service:nodejs /usr/src/dist
+
+# update owner
+RUN chown -R service:nodejs ./
+
+# copy files
+COPY --chown=service:nodejs --from=builder /usr/src/dist ./dist
+COPY --from=builder /usr/src/node_modules ./node_modules
+COPY --from=builder /usr/src/package.json ./package.json
+
+# use user and create logs dir
 USER service
+RUN mkdir /usr/src/logs
 
-CMD ["yarn", "start"]
+EXPOSE 8000
+CMD ["yarn", "start"]

README.md

@@ -23,6 +23,37 @@ docker pull ghcr.io/codrjs/codr-user-user:latest
 
 - [ ] None
 
+## Environment
+
+Necessary variables needed to run:
+
+| Env var                | Location               | Required | Description                                                                             |
+| ---------------------- | ---------------------- | -------- | --------------------------------------------------------------------------------------- |
+| `ENV`                  | `env`                  | `true`   | Deployment envionment - `dev`, `qa`, `stage`, `prod`                                    |
+| `EXPRESS_HOST`         | `express.host`         | `false`  | Express server - listener host                                                          |
+| `EXPRESS_PORT`         | `express.port`         | `false`  | Express server - listener port                                                          |
+| `MONGO_URI`            | `mongo.uri`            | `true`   | MongoDB - server URL, please include username and password to this string               |
+| `KAFKA_BROKERS`        | `kafka.brokers`        | `true`   | Kafka server - comma seperated locations of the kafka brokers                           |
+| `KAFKA_CLIENT_ID`      | `kafka.clientId`       | `true`   | Kafka server - name of the kafka cluster                                                |
+| `KAFKA_CONSUMER_GROUP` | `kafka.consumer.group` | `true`   | Kafka server - consumer group                                                           |
+| `JWT_SECRET`           | `jwt.secret`           | `false`  | JWT - secret, key to decode jwt, must be the same across all services in an environment |
+| `JWT_ISSUER`           | `jwt.issuer`           | `false`  | JWT - issuer, default `codrjs.com`                                                      |
+
+Environment variables provided by CI/CD
+
+| Env var           | Location           | Description                                               |
+| ----------------- | ------------------ | --------------------------------------------------------- |
+| `HOSTNAME`        | `hostname`         | Deployment docker hostname                                |
+| Provided via npm  | `name`             | Deployment service name - example: codr-user-user         |
+| Provided via npm  | `version`          | Deployment version - example: `1.0.0`                     |
+| `GIT_BRANCH`      | `git.brach`        | Git - branch                                              |
+| `GIT_COMMIT`      | `git.commit`       | Git - commit sha                                          |
+| `GIT_REPO`        | `git.repo`         | Git - repository                                          |
+| `NODE_ENV`        | `node.env`         | Node environment - `development`, `production`, `testing` |
+| Provided via npm  | `node.verison`     | Node version - example: `16.19.1`                         |
+| Provided via npm  | `node.modules`     | Node modules - string array of all dependencies           |
+| Provided via yarn | `node.yarnVersion` | Node - package manager version                            |
+
 ## Contributing
 
 ```bash

package.json

@@ -1,7 +1,7 @@
 {
   "name": "codr-user-user",
   "private": true,
-  "version": "1.0.1",
+  "version": "1.0.2",
   "scripts": {
     "start": "node dist/serve.js",
     "build": "swc ./src -d dist",
@@ -27,11 +27,11 @@
   "dependencies": {
     "@casl/ability": "^6.3.3",
     "@casl/mongoose": "^7.1.2",
-    "@codrjs/config": "^1.0.0",
+    "@codrjs/config": "^1.0.4",
     "@codrjs/health": "^1.0.3",
     "@codrjs/kafka": "^1.0.2",
     "@codrjs/logger": "^1.0.0",
-    "@codrjs/models": "^1.0.3",
+    "@codrjs/models": "^1.0.6",
     "@dylanbulmer/openapi": "^1.0.7",
     "body-parser": "^1.20.1",
     "cors": "^2.8.5",

src/serve.ts

@@ -1,4 +1,5 @@
 import { Kafka, Express, Mongo } from "./server";
+import "@codrjs/config";
 
 Mongo.start();
 // Kafka.start();

src/server/express/api/api-doc.ts src/server/express/api/v1/api-doc.ts

@@ -17,24 +17,25 @@ import {
   GenericSchema,
   HealthSchema,
   UserEntitySchema,
+  MetadataSchema,
 } from "./schemas";
 import { BearerScheme } from "./schemes";
+import { OpenAPI } from "@codrjs/models";
+import Config from "@codrjs/config";
+
+const OpenAPIConfig = new OpenAPI();
+console.log(Config.openapi);
 
 const settings: OpenAPIV3_1.Document = {
   openapi: "3.1.0",
 
   // The servers property breaks all apis for some reason
-  servers: [
-    {
-      url: `http://localhost:8000/api/`,
-      description: "Dev Server",
-    },
-  ],
+  servers: OpenAPIConfig.servers,
 
   info: {
-    version: "1.0.0",
-    title: "User Entity API",
-    description: "Preform CRUD operations on the user collection in Mongo.",
+    version: Config.version ?? "Unknown",
+    title: OpenAPIConfig.info.title,
+    description: OpenAPIConfig.info.description,
     contact: {
       name: "Dylan Bulmer",
       url: "https://codrjs.com",
@@ -68,6 +69,7 @@ const settings: OpenAPIV3_1.Document = {
       GenericSchema,
       HealthSchema,
       UserEntitySchema,
+      MetadataSchema,
     },
     securitySchemes: {
       Bearer: BearerScheme,

src/server/express/api/index.ts src/server/express/api/v1/index.ts

@@ -0,0 +1,27 @@
+import { Operation } from "@dylanbulmer/openapi/types/Route";
+import { R200 } from "@dylanbulmer/openapi/classes/responses";
+import { Metadata } from "@codrjs/models";
+
+export const GET: Operation =
+  /* business middleware not expressible by OpenAPI documentation goes here */
+  (_req, res) => {
+    res.status(200).json(new Metadata());
+  };
+
+// 3.0 specification
+GET.apiDoc = {
+  description: "Get the server deployment info",
+  tags: ["System"],
+  responses: {
+    "200": {
+      description: R200.description,
+      content: {
+        "application/json": {
+          schema: {
+            $ref: "#/components/schemas/MetadataSchema",
+          },
+        },
+      },
+    },
+  },
+};

src/server/express/api/routes/health.ts src/server/express/api/v1/routes/health.ts

@@ -1,6 +1,6 @@
 import { Error } from "@codrjs/models";
 import { Operation } from "@dylanbulmer/openapi/types/Route";
-import verifyJWT from "../../../middlewares/verifyJWT";
+import verifyJWT from "../../../../middlewares/verifyJWT";
 import { UserUtility } from "@/utils/UserUtility";
 import { R200, R401, R403, R500 } from "@dylanbulmer/openapi/classes/responses";
 

src/server/express/api/v1/routes/info.ts

@@ -1,7 +1,7 @@
 import { Error } from "@codrjs/models";
 import { Operation } from "@dylanbulmer/openapi/types/Route";
-import verifyJWT from "../../../middlewares/verifyJWT";
-import { UserUtility } from "../../../../../utils/UserUtility";
+import verifyJWT from "../../../../middlewares/verifyJWT";
+import { UserUtility } from "../../../../../../utils/UserUtility";
 import { R201, R401, R403, R500 } from "@dylanbulmer/openapi/classes/responses";
 
 export const POST: Operation = [

src/server/express/api/routes/internal/user.ts src/server/express/api/v1/routes/internal/user.ts

@@ -0,0 +1,45 @@
+import type { OpenAPIV3_1 } from "openapi-types";
+
+const HealthSchema: OpenAPIV3_1.SchemaObject = {
+  title: "Metadata Schema",
+  properties: {
+    env: {
+      type: "string",
+      examples: ["dev", "qa", "stage", "prod"],
+      default: "dev",
+    },
+    version: {
+      type: "string",
+    },
+    name: {
+      type: "string",
+    },
+    node: {
+      type: "object",
+      properties: {
+        env: {
+          type: "string",
+          examples: ["development", "production", "testing"],
+          default: "production",
+        },
+        version: {
+          type: "string",
+        },
+        modules: {
+          type: "object",
+        },
+        yarnVersion: {
+          type: "string",
+        },
+      },
+    },
+    docker: {
+      type: "object",
+      properties: {
+        hostname: { type: "string" },
+      },
+    },
+  },
+};
+
+export default HealthSchema;

src/server/express/api/routes/user/[userId].ts src/server/express/api/v1/routes/user/[userId].ts

@@ -3,3 +3,4 @@ export { default as ErrorSchema } from "./Error";
 export { default as GenericSchema } from "./Generic";
 export { default as HealthSchema } from "./Health";
 export { default as UserEntitySchema } from "./User";
+export { default as MetadataSchema } from "./Metadata";

src/server/express/api/routes/user/index.ts src/server/express/api/v1/routes/user/index.ts

@@ -2,7 +2,7 @@ import express, { Express } from "express";
 import bodyParser from "body-parser";
 import cors from "cors";
 import config from "@codrjs/config";
-import v1 from "./api";
+import v1 from "./api/v1";
 import morgan from "./middlewares/morgan.middleware";
 import { Error } from "@codrjs/models";
 import ExpressLogger from "./utils/logger";
@@ -17,7 +17,7 @@ app.use(cors());
 app.use(bodyParser.json());
 app.use(morgan);
 
-app.use("/api", v1);
+app.use("/v1", v1);
 
 app.use(((err, req, res, next) => {
   // if headers are already sent, let express handler the error
@@ -26,7 +26,7 @@ app.use(((err, req, res, next) => {
   }
 
   // if the path is for the API, have it handle the error
-  if (req.path.startsWith("/api")) {
+  if (req.path.startsWith("/v1")) {
     return v1.get("errorHandler")(err, req, res, next);
   }
 
@@ -38,7 +38,7 @@ app.use((req, res, next) => {
   // catch 404 errors?
 
   // if the path is for API v1, have v1 handler the error
-  if (req.path.startsWith("/api")) {
+  if (req.path.startsWith("/v1")) {
     const err = new Error({ status: 404, message: `not found: ${req.path}` });
     return v1.get("errorHandler")(err, req, res, next);
   }

src/server/express/api/schemas/BaseEntity.ts src/server/express/api/v1/schemas/BaseEntity.ts

@@ -311,10 +311,10 @@
   resolved "https://registry.yarnpkg.com/@casl/mongoose/-/mongoose-7.1.2.tgz#61e86839ee19df8443158f44b10cbbe5137ed1fb"
   integrity sha512-YiY5gQlr5J0jsn0ZbjtDJEhqKviPyPj0ErZ2bnOh7li+ENvFMnfp5ZeF2wN7ZVcqK9mn4MCqWH56EzafRF3i+g==
 
-"@codrjs/config@^1.0.0":
-  version "1.0.0"
-  resolved "https://registry.yarnpkg.com/@codrjs/config/-/config-1.0.0.tgz#90dd9367da77976cc685cf82c344823115753ed5"
-  integrity sha512-KWN7lzW7D7+ysyYYTh+TXf8RZVVMF46umyf19k/ytH3vInDSWSBDiLZ7UaUIIiT1kqAkILYd8FFYUNHBzgZOSg==
+"@codrjs/config@^1.0.4":
+  version "1.0.4"
+  resolved "https://registry.yarnpkg.com/@codrjs/config/-/config-1.0.4.tgz#1547da95a2e2f694687b42338f30b6a46f7951c2"
+  integrity sha512-nMW36MvOES84lTjfWTmOCqRnXL+YQFH8fXCNCSjupKkC+3nonVL5GbTctuEHB/NPKiXQR093LEab/OEp2JVLtA==
   dependencies:
     dotenv "^16.0.3"
 
@@ -340,12 +340,13 @@
   dependencies:
     winston "^3.8.2"
 
-"@codrjs/models@^1.0.3":
-  version "1.0.3"
-  resolved "https://registry.yarnpkg.com/@codrjs/models/-/models-1.0.3.tgz#7be6a70c6f6b44e047d0afb32300d8340588dc23"
-  integrity sha512-hD5yWR2GY1gXdHMMdzwt7xfnqPVr7IPNxrdUo0CArxGabXgeFRPkSboWd2Jyit9erU4BlMl6Gi/lhhgLgeLFCA==
+"@codrjs/models@^1.0.6":
+  version "1.0.6"
+  resolved "https://registry.yarnpkg.com/@codrjs/models/-/models-1.0.6.tgz#68d2a78b1a680fcecf21128570ebc0fa863100fa"
+  integrity sha512-qqDwa6t//VM+p+j8x3XlKdnTGMN3JZrFmJnrT9jUjIRtV/kh6MTBee99LB31R+FWYimVULSAtXbOc5LF0bA7+Q==
   dependencies:
     "@casl/ability" "^6.3.3"
+    "@codrjs/config" "^1.0.4"
     uuid "^9.0.0"
 
 "@colors/[email protected]":