feat: initial boilerplate and tooling to start matching server.ts to known variants

Author: pieh

.prettierignore

@@ -17,4 +17,5 @@ node_modules
 
 # Tests
 test
-tests/fixtures
+tests/fixtures
+tools/known-server-ts-signatures

src/helpers/knownServerTsSignatures.json

@@ -0,0 +1,4 @@
+{
+  "5678601ed12556305074503967b44ae42c45c268579db057c25cbf4b21a7212e": "CommonEngine",
+  "76419eb94b4b8672ba3bd79d34c5a66c7c30ff173995ecc6e0adc5808b86822d": "AppEngine"
+}

src/helpers/serverTsSignature.js

@@ -0,0 +1,22 @@
+const { createHash } = require('node:crypto')
+
+const knownSignatures = require('./knownServerTsSignatures.json')
+
+/**
+ * Takes a string and generates a signature for it
+ * @param {string} content Text of module to generate signature for
+ * @returns {string} Signature
+ */
+const generateServerTsSignature = (content) => createHash('sha256').update(content).digest('hex')
+
+module.exports.generateServerTsSignature = generateServerTsSignature
+
+/**
+ * Tries to compare current content of server.ts with known signatures to decide which engine to use
+ * @param {string} content Current content of server.ts
+ * @returns {'AppEngine' | 'CommonEngine' | undefined}
+ */
+const getEngineBasedOnKnownSignatures = (content) => {
+  const signature = generateServerTsSignature(content)
+  return knownSignatures[signature]
+}

tools/generate-known-server-ts-signature.mjs

@@ -0,0 +1,25 @@
+import { readdir, readFile, writeFile } from 'node:fs/promises'
+import { join } from 'node:path'
+import { fileURLToPath } from 'node:url'
+
+import { generateServerTsSignature } from '../src/helpers/serverTsSignature.js'
+
+const hashToEngine = {}
+
+for (const engine of ['CommonEngine', 'AppEngine']) {
+  const knownFilesUsingEngineDirectory = fileURLToPath(
+    new URL(join('known-server-ts-signatures', engine), import.meta.url),
+  )
+  const files = await readdir(knownFilesUsingEngineDirectory)
+  for (const file of files) {
+    const content = await readFile(join(knownFilesUsingEngineDirectory, file), 'utf-8')
+    const signature = generateServerTsSignature(content)
+    hashToEngine[signature] = engine
+  }
+}
+
+// write out source file matching current formatting rules
+await writeFile(
+  fileURLToPath(new URL('../src/helpers/knownServerTsSignatures.json', import.meta.url)),
+  `${JSON.stringify(hashToEngine, null, 2)}\n`,
+)

tools/known-server-ts-signatures/AppEngine/19.0.0-rc.1.ts

@@ -0,0 +1,66 @@
+import {
+  AngularNodeAppEngine,
+  createNodeRequestHandler,
+  isMainModule,
+  writeResponseToNodeResponse,
+} from '@angular/ssr/node';
+import express from 'express';
+import { dirname, resolve } from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+const serverDistFolder = dirname(fileURLToPath(import.meta.url));
+const browserDistFolder = resolve(serverDistFolder, '../browser');
+
+const app = express();
+const angularApp = new AngularNodeAppEngine();
+
+/**
+ * Example Express Rest API endpoints can be defined here.
+ * Uncomment and define endpoints as necessary.
+ *
+ * Example:
+ * ```ts
+ * app.get('/api/**', (req, res) => {
+ *   // Handle API request
+ * });
+ * ```
+ */
+
+/**
+ * Serve static files from /browser
+ */
+app.use(
+  express.static(browserDistFolder, {
+    maxAge: '1y',
+    index: false,
+    redirect: false,
+  }),
+);
+
+/**
+ * Handle all other requests by rendering the Angular application.
+ */
+app.use('/**', (req, res, next) => {
+  angularApp
+    .handle(req)
+    .then((response) =>
+      response ? writeResponseToNodeResponse(response, res) : next(),
+    )
+    .catch(next);
+});
+
+/**
+ * Start the server if this module is the main entry point.
+ * The server listens on the port defined by the `PORT` environment variable, or defaults to 4000.
+ */
+if (isMainModule(import.meta.url)) {
+  const port = process.env['PORT'] || 4000;
+  app.listen(port, () => {
+    console.log(`Node Express server listening on http://localhost:${port}`);
+  });
+}
+
+/**
+ * The request handler used by the Angular CLI (dev-server and during build).
+ */
+export const reqHandler = createNodeRequestHandler(app);

tools/known-server-ts-signatures/CommonEngine/19.0.0-rc.1.ts

@@ -0,0 +1,65 @@
+import { APP_BASE_HREF } from '@angular/common';
+import { CommonEngine, isMainModule } from '@angular/ssr/node';
+import express from 'express';
+import { dirname, join, resolve } from 'node:path';
+import { fileURLToPath } from 'node:url';
+import bootstrap from './main.server';
+
+const serverDistFolder = dirname(fileURLToPath(import.meta.url));
+const browserDistFolder = resolve(serverDistFolder, '../browser');
+const indexHtml = join(serverDistFolder, 'index.server.html');
+
+const app = express();
+const commonEngine = new CommonEngine();
+
+/**
+ * Example Express Rest API endpoints can be defined here.
+ * Uncomment and define endpoints as necessary.
+ *
+ * Example:
+ * ```ts
+ * app.get('/api/**', (req, res) => {
+ *   // Handle API request
+ * });
+ * ```
+ */
+
+/**
+ * Serve static files from /browser
+ */
+app.get(
+  '**',
+  express.static(browserDistFolder, {
+    maxAge: '1y',
+    index: 'index.html'
+  }),
+);
+
+/**
+ * Handle all other requests by rendering the Angular application.
+ */
+app.get('**', (req, res, next) => {
+  const { protocol, originalUrl, baseUrl, headers } = req;
+
+  commonEngine
+    .render({
+      bootstrap,
+      documentFilePath: indexHtml,
+      url: `${protocol}://${headers.host}${originalUrl}`,
+      publicPath: browserDistFolder,
+      providers: [{ provide: APP_BASE_HREF, useValue: baseUrl }],
+    })
+    .then((html) => res.send(html))
+    .catch((err) => next(err));
+});
+
+/**
+ * Start the server if this module is the main entry point.
+ * The server listens on the port defined by the `PORT` environment variable, or defaults to 4000.
+ */
+if (isMainModule(import.meta.url)) {
+  const port = process.env['PORT'] || 4000;
+  app.listen(port, () => {
+    console.log(`Node Express server listening on http://localhost:${port}`);
+  });
+}