@abgov/nx-adsp 12.2.1 → 12.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@abgov/nx-adsp",
-  "version": "12.2.1",
+  "version": "12.3.0",
   "license": "Apache-2.0",
   "main": "src/index.js",
   "description": "Government of Alberta - Nx plugin for ADSP apps.",

package/src/generators/express-service/express-service.js

@@ -26,12 +26,18 @@ function default_1(host, options) {
         const { applicationGenerator: initExpress } = yield Promise.resolve().then(() => require('@nx/express'));
         yield initExpress(host, Object.assign(Object.assign({}, options), { skipFormat: true, skipPackageJson: false, linter: eslint_1.Linter.EsLint, unitTestRunner: 'jest', js: false, directory: `apps/${options.name}` }));
         (0, devkit_1.addDependenciesToPackageJson)(host, {
-            '@abgov/adsp-service-sdk': '^2.0.0',
-            dotenv: '^16.0.0',
-            passport: '^0.6.0',
+            '@abgov/adsp-service-sdk': '^2.5.0',
+            compression: '^1.8.1',
+            cors: '^2.8.5',
+            dotenv: '^16.4.7',
+            envalid: '^8.0.0',
+            helmet: '^8.0.0',
+            passport: '^0.7.0',
             'passport-anonymous': '^1.0.1',
         }, {
-            '@types/passport': '^1.0.9',
+            '@types/compression': '^1.7.5',
+            '@types/cors': '^2.8.17',
+            '@types/passport': '^1.0.16',
             '@types/passport-anonymous': '^1.0.3',
         });
         addFiles(host, normalizedOptions);

package/src/generators/express-service/express-service.js.map

@@ -1 +1 @@
-{"version":3,"file":"express-service.js","sourceRoot":"","sources":["../../../../../../packages/nx-adsp/src/generators/express-service/express-service.ts"],"names":[],"mappings":";;AA6CA,4BAwCC;;AArFD,wCAAyE;AACzE,uCAQoB;AACpB,uCAAoC;AACpC,6BAA6B;AAG7B,SAAe,gBAAgB,CAC7B,IAAU,EACV,OAAe;;QAEf,MAAM,WAAW,GAAG,IAAA,cAAK,EAAC,OAAO,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC;QACjD,MAAM,WAAW,GAAG,GAAG,IAAA,2BAAkB,EAAC,IAAI,CAAC,CAAC,OAAO,IAAI,WAAW,EAAE,CAAC;QAEzE,MAAM,IAAI,GAAG,MAAM,IAAA,4BAAoB,EAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAEvD,uCACK,OAAO,KACV,WAAW;YACX,WAAW;YACX,IAAI,IACJ;IACJ,CAAC;CAAA;AAED,SAAS,QAAQ,CAAC,IAAU,EAAE,OAAyB;IACrD,MAAM,eAAe,iDAChB,OAAO,GACP,OAAO,CAAC,IAAI,KACf,IAAI,EAAE,EAAE,GACT,CAAC;IACF,IAAA,sBAAa,EACX,IAAI,EACJ,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,EAC7B,OAAO,CAAC,WAAW,EACnB,eAAe,CAChB,CAAC;AACJ,CAAC;AAED,mBAA+B,IAAU,EAAE,OAAe;;QACxD,MAAM,iBAAiB,GAAG,MAAM,gBAAgB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAEhE,MAAM,EAAE,oBAAoB,EAAE,WAAW,EAAE,GAAG,2CAAa,aAAa,EAAC,CAAC;QAC1E,MAAM,WAAW,CAAC,IAAI,kCACjB,OAAO,KACV,UAAU,EAAE,IAAI,EAChB,eAAe,EAAE,KAAK,EACtB,MAAM,EAAE,eAAM,CAAC,MAAM,EACrB,cAAc,EAAE,MAAM,EACtB,EAAE,EAAE,KAAK,EACT,SAAS,EAAE,QAAQ,OAAO,CAAC,IAAI,EAAE,IACjC,CAAC;QAEH,IAAA,qCAA4B,EAC1B,IAAI,EACJ;YACE,yBAAyB,EAAE,QAAQ;YACnC,MAAM,EAAE,SAAS;YACjB,QAAQ,EAAE,QAAQ;YAClB,oBAAoB,EAAE,QAAQ;SAC/B,EACD;YACE,iBAAiB,EAAE,QAAQ;YAC3B,2BAA2B,EAAE,QAAQ;SACtC,CACF,CAAC;QAEF,QAAQ,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAAC;QAClC,MAAM,IAAA,oBAAW,EAAC,IAAI,CAAC,CAAC;QAExB,MAAM,IAAA,2BAAmB,EAAC,IAAI,kCACzB,iBAAiB,KACpB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,iBAAiB,CAAC,WAAW,IACtC,CAAC;QAEH,OAAO,GAAG,EAAE;YACV,IAAA,4BAAmB,EAAC,IAAI,CAAC,CAAC;QAC5B,CAAC,CAAC;IACJ,CAAC;CAAA"}
+{"version":3,"file":"express-service.js","sourceRoot":"","sources":["../../../../../../packages/nx-adsp/src/generators/express-service/express-service.ts"],"names":[],"mappings":";;AA6CA,4BA8CC;;AA3FD,wCAAyE;AACzE,uCAQoB;AACpB,uCAAoC;AACpC,6BAA6B;AAG7B,SAAe,gBAAgB,CAC7B,IAAU,EACV,OAAe;;QAEf,MAAM,WAAW,GAAG,IAAA,cAAK,EAAC,OAAO,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC;QACjD,MAAM,WAAW,GAAG,GAAG,IAAA,2BAAkB,EAAC,IAAI,CAAC,CAAC,OAAO,IAAI,WAAW,EAAE,CAAC;QAEzE,MAAM,IAAI,GAAG,MAAM,IAAA,4BAAoB,EAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAEvD,uCACK,OAAO,KACV,WAAW;YACX,WAAW;YACX,IAAI,IACJ;IACJ,CAAC;CAAA;AAED,SAAS,QAAQ,CAAC,IAAU,EAAE,OAAyB;IACrD,MAAM,eAAe,iDAChB,OAAO,GACP,OAAO,CAAC,IAAI,KACf,IAAI,EAAE,EAAE,GACT,CAAC;IACF,IAAA,sBAAa,EACX,IAAI,EACJ,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,EAC7B,OAAO,CAAC,WAAW,EACnB,eAAe,CAChB,CAAC;AACJ,CAAC;AAED,mBAA+B,IAAU,EAAE,OAAe;;QACxD,MAAM,iBAAiB,GAAG,MAAM,gBAAgB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAEhE,MAAM,EAAE,oBAAoB,EAAE,WAAW,EAAE,GAAG,2CAAa,aAAa,EAAC,CAAC;QAC1E,MAAM,WAAW,CAAC,IAAI,kCACjB,OAAO,KACV,UAAU,EAAE,IAAI,EAChB,eAAe,EAAE,KAAK,EACtB,MAAM,EAAE,eAAM,CAAC,MAAM,EACrB,cAAc,EAAE,MAAM,EACtB,EAAE,EAAE,KAAK,EACT,SAAS,EAAE,QAAQ,OAAO,CAAC,IAAI,EAAE,IACjC,CAAC;QAEH,IAAA,qCAA4B,EAC1B,IAAI,EACJ;YACE,yBAAyB,EAAE,QAAQ;YACnC,WAAW,EAAE,QAAQ;YACrB,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,SAAS;YACjB,OAAO,EAAE,QAAQ;YACjB,MAAM,EAAE,QAAQ;YAChB,QAAQ,EAAE,QAAQ;YAClB,oBAAoB,EAAE,QAAQ;SAC/B,EACD;YACE,oBAAoB,EAAE,QAAQ;YAC9B,aAAa,EAAE,SAAS;YACxB,iBAAiB,EAAE,SAAS;YAC5B,2BAA2B,EAAE,QAAQ;SACtC,CACF,CAAC;QAEF,QAAQ,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAAC;QAClC,MAAM,IAAA,oBAAW,EAAC,IAAI,CAAC,CAAC;QAExB,MAAM,IAAA,2BAAmB,EAAC,IAAI,kCACzB,iBAAiB,KACpB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,iBAAiB,CAAC,WAAW,IACtC,CAAC;QAEH,OAAO,GAAG,EAAE;YACV,IAAA,4BAAmB,EAAC,IAAI,CAAC,CAAC;QAC5B,CAAC,CAAC;IACJ,CAAC;CAAA"}

package/src/generators/express-service/express-service.spec.ts

@@ -29,5 +29,7 @@ describe('Express Service Generator', () => {
     expect(config.root).toBe('apps/test');
 
     expect(host.exists('apps/test/src/main.ts')).toBeTruthy();
+    expect(host.exists('apps/test/src/environment.ts')).toBeTruthy();
+    expect(host.exists('apps/test/src/environments/environment.ts')).toBeFalsy();
   }, 60000);
 });

package/src/generators/express-service/files/src/environment.ts__tmpl__

@@ -0,0 +1,19 @@
+import { config } from 'dotenv';
+import { cleanEnv, num, str } from 'envalid';
+import { resolve } from 'path';
+
+config({
+  path: resolve(process.cwd(), 'apps/<%= projectName %>/.env'),
+  override: true,
+});
+
+export const environment = cleanEnv(process.env, {
+  KEYCLOAK_ROOT_URL: str({ default: '<%= accessServiceUrl %>' }),
+  DIRECTORY_URL: str({ default: '<%= directoryServiceUrl %>' }),
+  TENANT_REALM: str({ default: '<%= tenantRealm %>' }),
+  CLIENT_ID: str({ default: 'urn:ads:<%= tenant %>:<%= projectName %>' }),
+  CLIENT_SECRET: str({ default: '' }),
+  TRUSTED_PROXY: str({ default: 'uniquelocal' }),
+  LOG_LEVEL: str({ default: 'debug' }),
+  PORT: num({ default: 3000 }),
+});

package/src/generators/express-service/files/src/main.ts__tmpl__

@@ -1,63 +1,84 @@
-/**
- * This is not a production server yet!
- * This is only a minimal backend to get started.
- */
 import { AdspId, initializeService } from '@abgov/adsp-service-sdk';
+import compression from 'compression';
+import cors from 'cors';
 import express from 'express';
+import helmet from 'helmet';
 import passport from 'passport';
 import { Strategy as AnonymousStrategy } from 'passport-anonymous';
 
-import { environment } from './environments/environment';
-
-async function initializeApp(): Promise<express.Application> {
-  const app = express();
-  app.use(passport.initialize());
+import { environment } from './environment';
 
+async function initializeApp() {
   const serviceId = AdspId.parse(environment.CLIENT_ID);
-  const { tenantStrategy } = await initializeService(
+  const capabilities = await initializeService(
     {
       displayName: '<%= projectName %>',
       description: 'Put your service description here.',
-      realm: environment.TENANT_REALM,
       serviceId,
+      realm: environment.TENANT_REALM,
       clientSecret: environment.CLIENT_SECRET,
-      accessServiceUrl: new URL(environment.ACCESS_SERVICE_URL),
-      directoryUrl: new URL(environment.DIRECTORY_SERVICE_URL),
+      accessServiceUrl: new URL(environment.KEYCLOAK_ROOT_URL),
+      directoryUrl: new URL(environment.DIRECTORY_URL),
     },
     { logLevel: environment.LOG_LEVEL }
   );
 
-  passport.use('tenant', tenantStrategy);
+  const { logger, tenantStrategy, traceHandler, configurationHandler, healthCheck } = capabilities;
+
+  const app = express();
+
+  app.use(compression());
+  app.use(helmet());
+  app.use(express.json());
+  app.use(cors());
+
+  if (environment.TRUSTED_PROXY) {
+    app.set('trust proxy', environment.TRUSTED_PROXY);
+  }
+
+  app.use(traceHandler);
+
   passport.use('anonymous', new AnonymousStrategy());
+  passport.use('tenant', tenantStrategy);
+  app.use(passport.initialize());
 
-  app.use(passport.authenticate(['tenant', 'anonymous'], { session: false }));
+  app.use(
+    '/<%= projectName %>/v1',
+    passport.authenticate(['tenant', 'anonymous'], { session: false }),
+    configurationHandler
+  );
 
-  app.get('/<%= projectName %>/v1/public', (_req, res) => {
-    res.send({ message: `Welcome to public API resource!` });
+  app.get('/health', async (_req, res) => {
+    const platform = await healthCheck();
+    res.json({ ...platform });
   });
 
-  app.get(
-    '/<%= projectName %>/v1/private',
-    (req, res, next) => {
-      if (!req.user) {
-        res.sendStatus(401);
-      } else {
-        next();
-      }
-    },
-    (req, res) => {
-      const user = req.user;
-      res.send({ message: `Welcome to private API resource! ${user.name}` });
-    }
-  );
-  return app;
-}
+  app.get('/', (req, res) => {
+    const rootUrl = new URL(`${req.protocol}://${req.get('host')}`);
+    res.json({
+      _links: {
+        self: { href: new URL(req.originalUrl, rootUrl).href },
+        health: { href: new URL('/health', rootUrl).href },
+        api: { href: new URL('/<%= projectName %>/v1', rootUrl).href },
+      },
+    });
+  });
 
-initializeApp().then((app) => {
-  const port = environment.port || 3333;
+  app.get('/<%= projectName %>/v1', (_req, res) => {
+    res.json({
+      _links: {
+        self: { href: '/<%= projectName %>/v1' },
+      },
+    });
+  });
+
+  return { app, logger };
+}
 
+initializeApp().then(({ app, logger }) => {
+  const port = environment.PORT;
   const server = app.listen(port, () => {
-    console.log(`Listening at http://localhost:${port}/<%= projectName %>/v1`);
+    logger.info(`Listening at http://localhost:${port}/<%= projectName %>/v1`);
   });
-  server.on('error', console.error);
+  server.on('error', (err) => logger.error(`Error encountered in server: ${err}`));
 });

package/src/generators/mern/mern.spec.ts

@@ -15,7 +15,7 @@ utilsMock.getAdspConfiguration.mockResolvedValue({
   directoryServiceUrl: environments.test.directoryServiceUrl,
 });
 
-describe.skip('React App Generator', () => {
+describe('MERN Generator', () => {
   const options: Schema = {
     name: 'test',
     env: 'dev',

package/src/generators/react-app/react-app.spec.ts

@@ -15,7 +15,7 @@ utilsMock.getAdspConfiguration.mockResolvedValue({
   directoryServiceUrl: environments.test.directoryServiceUrl,
 });
 
-describe.skip('React App Generator', () => {
+describe('React App Generator', () => {
   const options: Schema = {
     name: 'test',
     env: 'dev',

package/src/generators/express-service/files/src/environments/environment.prod.ts__tmpl__

@@ -1,13 +0,0 @@
-import * as dotenv from 'dotenv';
-dotenv.config();
-
-export const environment = {
-  production: true,
-  TENANT_REALM: '<%= tenantRealm %>',
-  ACCESS_SERVICE_URL: '<%= accessServiceUrl %>',
-  DIRECTORY_SERVICE_URL: '<%= directoryServiceUrl %>',
-  CLIENT_ID: 'urn:ads:<%= tenant %>:<%= projectName %>',
-  CLIENT_SECRET: '',
-  LOG_LEVEL: 'info',
-  ...process.env,
-};

package/src/generators/express-service/files/src/environments/environment.ts__tmpl__

@@ -1,14 +0,0 @@
-import * as dotenv from 'dotenv';
-dotenv.config();
-
-export const environment = {
-  production: false,
-  port: '3333',
-  TENANT_REALM: '<%= tenantRealm %>',
-  ACCESS_SERVICE_URL: '<%= accessServiceUrl %>',
-  DIRECTORY_SERVICE_URL: '<%= directoryServiceUrl %>',
-  CLIENT_ID: 'urn:ads:<%= tenant %>:<%= projectName %>',
-  CLIENT_SECRET: '',
-  LOG_LEVEL: 'debug',
-  ...process.env
-};