Add configration of EXTERNAL_URL (#67)

* Add configration of EXTERNAL_URL

* Switch to origin/path_prefix

* Add routes logging

README.md

@@ -10,6 +10,8 @@ Inteli OpenAPI service for interacting with the DSCP (Digital Supply-Chain Platf
 | :--------------------------- | :------: | :--------------------: | :----------------------------------------------------------------------------------- |
 | SERVICE_TYPE                 |    N     |         `info`         | Logging level. Valid values are [`trace`, `debug`, `info`, `warn`, `error`, `fatal`] |
 | PORT                         |    N     |          `80`          | The port for the API to listen on                                                    |
+| EXTERNAL_ORIGIN              |    N     |                        | The origin from which the OpenAPI service is accessible. If not provided the value will default to `http://localhost:${PORT}` |
+| EXTERNAL_PATH_PREFIX         |    N     |                        | A path prefix from which this service is served |
 | LOG_LEVEL                    |    N     |         `info`         | Logging level. Valid values are [`trace`, `debug`, `info`, `warn`, `error`, `fatal`] |
 | API_VERSION                  |    N     | `package.json version` | API version                                                                          |
 | API_MAJOR_VERSION            |    N     |          `v1`          | API major version                                                                    |

app/api-v1/api-doc.js

@@ -1,4 +1,10 @@
-const { PORT, API_VERSION, API_MAJOR_VERSION, AUTH_TYPE } = require('../env')
+const { PORT, API_VERSION, API_MAJOR_VERSION, AUTH_TYPE, EXTERNAL_ORIGIN, EXTERNAL_PATH_PREFIX } = require('../env')
+
+let url = EXTERNAL_ORIGIN || `http://localhost:${PORT}`
+if (EXTERNAL_PATH_PREFIX) {
+  url = `${url}/${EXTERNAL_PATH_PREFIX}`
+}
+url = `${url}/${API_MAJOR_VERSION}`
 
 const securitySchemes =
   AUTH_TYPE === 'JWT'
@@ -21,7 +27,7 @@ const apiDoc = {
   },
   servers: [
     {
-      url: `http://localhost:${PORT}/${API_MAJOR_VERSION}`,
+      url,
     },
   ],
   components: {

app/env.js

@@ -41,6 +41,8 @@ const vars = envalid.cleanEnv(
     FILE_UPLOAD_SIZE_LIMIT_BYTES: envalid.num({ default: 1024 * 1024 * 100, devDefault: 1024 * 1024 * 10 }),
     IDENTITY_SERVICE_HOST: envalid.host({ devDefault: 'localhost' }),
     IDENTITY_SERVICE_PORT: envalid.port({ devDefault: 3002 }),
+    EXTERNAL_ORIGIN: envalid.str({ default: '' }),
+    EXTERNAL_PATH_PREFIX: envalid.str({ default: '' }),
   },
   {
     strict: true,

app/server.js

@@ -8,7 +8,14 @@ const multer = require('multer')
 const path = require('path')
 const bodyParser = require('body-parser')
 const compression = require('compression')
-const { PORT, API_VERSION, API_MAJOR_VERSION, FILE_UPLOAD_SIZE_LIMIT_BYTES, AUTH_TYPE } = require('./env')
+const {
+  PORT,
+  API_VERSION,
+  API_MAJOR_VERSION,
+  FILE_UPLOAD_SIZE_LIMIT_BYTES,
+  AUTH_TYPE,
+  EXTERNAL_PATH_PREFIX,
+} = require('./env')
 const logger = require('./utils/Logger')
 const v1ApiDoc = require('./api-v1/api-doc')
 const v1DscpApiService = require('./api-v1/services/dscpApiService')
@@ -68,16 +75,26 @@ async function createHttpServer() {
     swaggerOptions: {
       urls: [
         {
-          url: `http://localhost:${PORT}/${API_MAJOR_VERSION}/api-docs`,
+          url: `${v1ApiDoc.servers[0].url}/api-docs`,
           name: 'Inteli API Service',
         },
       ],
     },
   }
 
-  app.use(`/${API_MAJOR_VERSION}/swagger`, swaggerUi.serve, swaggerUi.setup(null, options))
+  app.use(
+    EXTERNAL_PATH_PREFIX ? `/${EXTERNAL_PATH_PREFIX}/${API_MAJOR_VERSION}/swagger` : `/${API_MAJOR_VERSION}/swagger`,
+    swaggerUi.serve,
+    swaggerUi.setup(null, options)
+  )
   app.use(handleErrors)
 
+  logger.trace('Registered Express routes: %s', {
+    toString: () => {
+      return JSON.stringify(app._router.stack.map(({ route }) => route && route.path).filter((p) => !!p))
+    },
+  })
+
   return { app }
 }
 

helm/inteli-api/Chart.yaml

@@ -1,8 +1,8 @@
 apiVersion: v2
 name: inteli-api
-appVersion: '1.29.0'
+appVersion: '1.29.1'
 description: A Helm chart for inteli-api
-version: '1.29.0'
+version: '1.29.1'
 type: application
 maintainers:
   - name: digicatapult

helm/inteli-api/templates/configmap.yaml

@@ -6,6 +6,12 @@ metadata:
     {{- include "inteli-api.labels" . | nindent 4 }}
 data:
   port: {{ .Values.config.port | quote }}
+  {{- if .Values.config.externalOrigin }}
+  externalOrigin: {{ .Values.config.externalOrigin }}
+  {{- end }}
+  {{- if .Values.config.externalPathPrefix }}
+  externalPathPrefix: {{ .Values.config.externalPathPrefix }}
+  {{- end }}
   dscpApiHost: {{ .Values.config.dscpApiHost }}
   dscpApiPort: {{ .Values.config.dscpApiPort | quote }}
   logLevel: {{ .Values.config.logLevel }}

helm/inteli-api/templates/deployment.yaml

@@ -71,6 +71,20 @@ spec:
                 configMapKeyRef:
                   name: {{ include "inteli-api.fullname" . }}-config
                   key: port
+            {{- if .Values.config.externalOrigin }}
+            - name: EXTERNAL_ORIGIN
+              valueFrom:
+                configMapKeyRef:
+                  name: {{ include "inteli-api.fullname" . }}-config
+                  key: externalOrigin
+            {{- end }}
+            {{- if .Values.config.externalPathPrefix }}
+            - name: EXTERNAL_PATH_PREFIX
+              valueFrom:
+                configMapKeyRef:
+                  name: {{ include "inteli-api.fullname" . }}-config
+                  key: externalPathPrefix
+            {{- end }}
             - name: LOG_LEVEL
               valueFrom:
                 configMapKeyRef:

helm/inteli-api/values.yaml

@@ -1,5 +1,7 @@
 config:
   port: 80
+  # externalOrigin: "http://localhost:3000" # Overrides the server url in the openapi spec
+  # externalPathPrefix: "alice/inteli-api" # Path prefix to be applied to served API routes
   dscpApiHost: dscp-api
   dscpApiPort: 80
   logLevel: info
@@ -39,7 +41,7 @@ service:
 image:
   repository: digicatapult/inteli-api
   pullPolicy: IfNotPresent
-  tag: 'v1.29.0'
+  tag: 'v1.29.1'
   pullSecrets: []
 
 postgresql:

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@digicatapult/inteli-api",
-  "version": "1.29.0",
+  "version": "1.29.1",
   "description": "Insert repo description",
   "main": "app/index.js",
   "scripts": {