feat: adding route generation and moved build to script

Author: cskiwi

README.md

@@ -72,6 +72,10 @@ To build the Angular application for production:
 bun run build
 ```
 
+This will run all the required build steps.
+I've included a routes.txt generator, so you can add the routes you want to pre-render in the `routes.txt` file.
+You can remove that library and build steps if you don't want to pre-render the routes.
+
 To run the Application:
 
 ```bash

libs/backend/root/src/app.module.ts

@@ -1,8 +1,9 @@
 import { Module } from '@nestjs/common';
-import { BackendTestModule } from '@backend/test';
+import { BackendTestModule } from '@app/backend-test';
+import { RoutesGeneratorModule } from '@app/backend-routes-generator';
 
 @Module({
-  imports: [BackendTestModule],
+  imports: [BackendTestModule, RoutesGeneratorModule],
   controllers: [],
 })
 export class AppModule {}

libs/backend/routes-generator/.eslintrc.json

@@ -0,0 +1,18 @@
+{
+  "extends": ["../../../.eslintrc.json"],
+  "ignorePatterns": ["!**/*"],
+  "overrides": [
+    {
+      "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.ts", "*.tsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.js", "*.jsx"],
+      "rules": {}
+    }
+  ]
+}

libs/backend/routes-generator/README.md

@@ -0,0 +1,7 @@
+# backend-routes-generator
+
+This library was generated with [Nx](https://nx.dev).
+
+## Running unit tests
+
+Run `nx test backend-routes-generator` to execute the unit tests via [Jest](https://jestjs.io).

libs/backend/routes-generator/jest.config.ts

@@ -0,0 +1,11 @@
+/* eslint-disable */
+export default {
+  displayName: 'backend-routes-generator',
+  preset: '../../../jest.preset.js',
+  testEnvironment: 'node',
+  transform: {
+    '^.+\\.[tj]s$': ['ts-jest', { tsconfig: '<rootDir>/tsconfig.spec.json' }],
+  },
+  moduleFileExtensions: ['ts', 'js', 'html'],
+  coverageDirectory: '../../../coverage/libs/backend/routes-generator',
+};

libs/backend/routes-generator/project.json

@@ -0,0 +1,16 @@
+{
+  "name": "backend-routes-generator",
+  "$schema": "../../../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "libs/backend/routes-generator/src",
+  "projectType": "library",
+  "tags": [],
+  "targets": {
+    "test": {
+      "executor": "@nx/jest:jest",
+      "outputs": ["{workspaceRoot}/coverage/{projectRoot}"],
+      "options": {
+        "jestConfig": "libs/backend/routes-generator/jest.config.ts"
+      }
+    }
+  }
+}

libs/backend/routes-generator/src/controllers/routes-generator.controller.spec.ts

@@ -0,0 +1,20 @@
+import { Test } from '@nestjs/testing';
+import { RoutesGeneratorController } from './routes-generator.controller';
+import { RoutesGeneratorService } from '../services/routes-generator.service';
+
+describe('RoutesGeneratorController', () => {
+  let controller: RoutesGeneratorController;
+
+  beforeEach(async () => {
+    const module = await Test.createTestingModule({
+      providers: [RoutesGeneratorService],
+      controllers: [RoutesGeneratorController],
+    }).compile();
+
+    controller = module.get(RoutesGeneratorController);
+  });
+
+  it('should be defined', () => {
+    expect(controller).toBeTruthy();
+  });
+});

libs/backend/routes-generator/src/controllers/routes-generator.controller.ts

@@ -0,0 +1,12 @@
+import { Controller, Get } from '@nestjs/common';
+import { RoutesGeneratorService } from '../services/routes-generator.service';
+
+@Controller('routes')
+export class RoutesGeneratorController {
+  constructor(private routeGenerator: RoutesGeneratorService) {}
+
+  @Get()
+  generateRoutes() {
+    return this.routeGenerator.generateRoutesTxt();
+  }
+}

libs/backend/routes-generator/src/index.ts

@@ -0,0 +1 @@
+export * from './routes-generator.module';

libs/backend/routes-generator/src/routes-generator.module.ts

@@ -0,0 +1,10 @@
+import { Module } from '@nestjs/common';
+import { RoutesGeneratorController } from './controllers/routes-generator.controller';
+import { RoutesGeneratorService } from './services/routes-generator.service';
+
+@Module({
+  controllers: [RoutesGeneratorController],
+  providers: [RoutesGeneratorService],
+  exports: [RoutesGeneratorService],
+})
+export class RoutesGeneratorModule {}

libs/backend/routes-generator/src/services/routes-generator.service.spec.ts

@@ -0,0 +1,18 @@
+import { Test } from '@nestjs/testing';
+import { RoutesGeneratorService } from './routes-generator.service';
+
+describe('RoutesGeneratorService', () => {
+  let service: RoutesGeneratorService;
+
+  beforeEach(async () => {
+    const module = await Test.createTestingModule({
+      providers: [RoutesGeneratorService],
+    }).compile();
+
+    service = module.get(RoutesGeneratorService);
+  });
+
+  it('should be defined', () => {
+    expect(service).toBeTruthy();
+  });
+});

libs/backend/routes-generator/src/services/routes-generator.service.ts

@@ -0,0 +1,8 @@
+import { Injectable } from '@nestjs/common';
+
+@Injectable()
+export class RoutesGeneratorService {
+  generateRoutesTxt() {
+    return `/home`;
+  }
+}

libs/backend/routes-generator/tsconfig.json

@@ -0,0 +1,22 @@
+{
+  "extends": "../../../tsconfig.base.json",
+  "compilerOptions": {
+    "module": "commonjs",
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "noImplicitOverride": true,
+    "noPropertyAccessFromIndexSignature": true,
+    "noImplicitReturns": true,
+    "noFallthroughCasesInSwitch": true
+  },
+  "files": [],
+  "include": [],
+  "references": [
+    {
+      "path": "./tsconfig.lib.json"
+    },
+    {
+      "path": "./tsconfig.spec.json"
+    }
+  ]
+}

libs/backend/routes-generator/tsconfig.lib.json

@@ -0,0 +1,16 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../../dist/out-tsc",
+    "declaration": true,
+    "types": ["node"],
+    "target": "es2021",
+    "strictNullChecks": true,
+    "noImplicitAny": true,
+    "strictBindCallApply": true,
+    "forceConsistentCasingInFileNames": true,
+    "noFallthroughCasesInSwitch": true
+  },
+  "include": ["src/**/*.ts"],
+  "exclude": ["jest.config.ts", "src/**/*.spec.ts", "src/**/*.test.ts"]
+}

libs/backend/routes-generator/tsconfig.spec.json

@@ -0,0 +1,14 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../../dist/out-tsc",
+    "module": "commonjs",
+    "types": ["jest", "node"]
+  },
+  "include": [
+    "jest.config.ts",
+    "src/**/*.test.ts",
+    "src/**/*.spec.ts",
+    "src/**/*.d.ts"
+  ]
+}

libs/backend/test/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "@backend/test",
+  "name": "@app/backend-test",
   "version": "0.0.1",
   "dependencies": {
     "tslib": "^2.3.0",

package.json

@@ -4,8 +4,7 @@
   "license": "MIT",
   "scripts": {
     "start": "nx run-many -t serve -p tag:scope:app",
-    "build": "concurrently \"nx serve api\" \"bun run wait-and-build\" --kill-others --success last --kill-signal SIGINT",
-    "wait-and-build": "wait-on tcp:3000 && nx build app"
+    "build": "node scripts/build.js"
   },
   "private": true,
   "dependencies": {

routes.txt

@@ -0,0 +1 @@
+/home

scripts/build.js

@@ -0,0 +1,91 @@
+const { exec } = require('child_process');
+const fs = require('fs');
+
+// Function to run a shell command
+function runCommand(command) {
+  return new Promise((resolve, reject) => {
+    const process = exec(command);
+
+    process.stdout.on('data', (data) => {
+      console.log(data);
+    });
+
+    process.stderr.on('data', (data) => {
+      console.error(data);
+    });
+
+    process.on('close', (code) => {
+      if (code === 0) {
+        resolve();
+      } else {
+        reject(`Command failed with code ${code}`);
+      }
+    });
+  });
+}
+
+// Function to wait for the server to be ready
+function waitForServer(port) {
+  return new Promise((resolve) => {
+    const interval = setInterval(async () => {
+      try {
+        console.log('Checking server status...');
+        const response = await fetch(`http://localhost:${port}/api/routes`);
+        if (response.ok) {
+          clearInterval(interval);
+          resolve();
+        }
+      } catch (error) {
+        // Server is not ready yet
+      }
+    }, 1000);
+  });
+}
+
+// Function to make a GET request and save the response to a file
+async function getAndSaveRoutes(port, filePath) {
+  try {
+    const response = await fetch(`http://localhost:${port}/api/routes`);
+    if (!response.ok) {
+      throw new Error(`Failed to fetch routes: ${response.statusText}`);
+    }
+    const data = await response.text();
+    fs.writeFileSync(filePath, data);
+  } catch (error) {
+    throw new Error(`GET request failed: ${error}`);
+  }
+}
+
+// Main function to run the tasks
+async function main() {
+  const port = process.env.PORT || 3000;
+  if (!port) {
+    console.error('Environment variable PORT is not set');
+    process.exit(1);
+  }
+
+  try {
+    console.log('Starting server...');
+    runCommand('nx serve api');
+
+    console.log(`Waiting for server to be ready on port ${port}...`);
+    await waitForServer(port);
+
+    console.log('Server is ready. Fetching routes...');
+    await getAndSaveRoutes(port, 'routes.txt');
+
+    console.log('Routes saved to routes.txt');
+
+    console.log('Building app...');
+    await runCommand('nx build app');
+
+    console.log('App build completed');
+
+    process.exit(0);
+  } catch (error) {
+    console.error(`Error: ${error}`);
+    process.exit(1);
+  }
+}
+
+main();

tsconfig.base.json

@@ -15,7 +15,10 @@
     "skipDefaultLibCheck": true,
     "baseUrl": ".",
     "paths": {
-      "@backend/test": ["libs/backend/test/src/index.ts"],
+      "@app/backend-test": ["libs/backend/test/src/index.ts"],
+      "@app/backend-routes-generator": [
+        "libs/backend/routes-generator/src/index.ts"
+      ],
       "@app/backend-root": ["libs/backend/root/src/index.ts"],
       "@app/frontend-root": ["libs/frontend/root/src/index.ts"]
     }