feat(smoke): simple smoke tests after deploy (#2802)

Author: blacha

.github/workflows/push.yml

@@ -60,6 +60,12 @@ jobs:
           GOOGLE_ANALYTICS: ${{secrets.GOOGLE_ANALYTICS_NON_PROD}}
           NODE_ENV: "dev"
 
+      - name: (NonProd) After Deploy Smoke Test
+        if: github.ref == 'refs/heads/master' && github.repository == 'linz/basemaps'
+        run: |
+            cd packages/smoke
+            node --test
+        
       - name: (Prod) Configure AWS Credentials
         if: github.ref == 'refs/heads/master' && startsWith(github.event.head_commit.message, 'release:')
         uses: aws-actions/configure-aws-credentials@v2.0.0

packages/smoke/README.md

@@ -0,0 +1,11 @@
+# @basemaps/smoke
+
+Utility to smoke test deployments
+
+to run
+
+```bash
+BASEMAPS_HOST=https://dev.basemaps.linz.govt.nz node --test
+```
+
+*Requires Node >= 18*

packages/smoke/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@basemaps/smoke",
+  "version": "6.32.1",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/linz/basemaps.git",
+    "directory": "packages/smoke"
+  },
+  "author": {
+    "name": "Land Information New Zealand",
+    "url": "https://linz.govt.nz",
+    "organization": true
+  },
+  "type": "module",
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "license": "MIT",
+  "scripts": {},
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "build/",
+    "bin/"
+  ],
+  "dependencies": {
+    "@basemaps/shared": "^6.40.0"
+  },
+  "devDependencies": {}
+}

packages/smoke/src/base.ts

@@ -0,0 +1,45 @@
+import { LogConfig } from '@basemaps/shared';
+import assert from 'node:assert';
+import ulid from 'ulid';
+
+const logger = LogConfig.get();
+/** Fresh API Key to use */
+const apiKey = 'c' + ulid.ulid().toLowerCase();
+
+/** Http headers required to trigger CORS */
+const Cors = { origin: 'https://example.com' };
+
+/** Host that is being tested */
+let host = process.env['BASEMAPS_HOST'] || 'https://dev.basemaps.linz.govt.nz';
+
+if (!host.startsWith('http')) throw new Error(`Invalid host: ${host}`);
+if (host.endsWith('/')) host = host.slice(0, host.length - 1);
+
+/** Request a url with options
+ *
+ * @example
+ * ```typescript
+ * await req('/v1/version')
+ * await req('/v1/version', { method: 'OPTIONS' })
+ * ````
+ */
+async function req(path: string, opts?: RequestInit): Promise<Response> {
+  const target = new URL(path, host);
+  logger.trace({ path, url: target.href }, 'Fetch');
+  const startTime = performance.now();
+  const res = await fetch(target, opts);
+  logger.info(
+    { path, url: target.href, status: res.status, ...opts, duration: performance.now() - startTime },
+    'Fetch:Done',
+  );
+  return res;
+}
+
+export const ctx = { logger, host, Cors, apiKey, req };
+
+/** Validate that the response was not a cached response */
+export function assertCacheMiss(res: Response): void {
+  const cacheHeader = res.headers.get('x-cache');
+  if (cacheHeader == null) return; // No header is a miss
+  assert.equal(cacheHeader.startsWith('Miss'), true, `Should be a cache Miss ${res.headers.get('x-cache')}`);
+}

packages/smoke/src/health.test.ts

@@ -0,0 +1,31 @@
+import assert from 'node:assert';
+import { describe, it } from 'node:test';
+import { assertCacheMiss, ctx } from './base.js';
+
+describe('health', () => {
+  it('should 200 when GET /v1/ping', async () => {
+    const res = await ctx.req('/v1/ping');
+    assert.equal(res.status, 200);
+    assertCacheMiss(res);
+  });
+
+  it('should 200 when GET /v1/health', async () => {
+    const res = await ctx.req('/v1/health');
+    assert.equal(res.status, 200);
+    assertCacheMiss(res);
+  });
+
+  it('should 200 when GET /v1/version', async () => {
+    const res = await ctx.req('/v1/version');
+    assert.equal(res.status, 200);
+    assertCacheMiss(res);
+
+    const data = await res.json();
+
+    assert.equal(typeof data.version, 'string');
+    assert.ok(data.version);
+
+    assert.equal(typeof data.hash, 'string');
+    assert.ok(data.hash);
+  });
+});

packages/smoke/tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "lib": ["DOM"],
+    "rootDir": "./src",
+    "outDir": "./build"
+  },
+  "include": ["src"],
+  "references": [{ "path": "../shared" }]
+}

tsconfig.json

@@ -19,6 +19,7 @@
     { "path": "./packages/lambda-analytics" },
     { "path": "./packages/attribution" },
     { "path": "./packages/landing" },
-    { "path": "./packages/server" }
+    { "path": "./packages/server" },
+    { "path": "./packages/smoke" }
   ]
 }