#608: moved loading segments, health checks and middleware to their own packages

Author: petermasking

examples/construction/README.md renamed to examples/resources/README.md

@@ -1,5 +1,5 @@
 {
-    "name": "jitar-construction-example",
+    "name": "jitar-resources-example",
     "private": true,
     "type": "module",
     "scripts": {

examples/construction/jitar.json renamed to examples/resources/jitar.json

@@ -1,7 +1,7 @@
 
 import type { RuntimeConfiguration } from '@jitar/configuration';
 import { Logger, LogLevel } from '@jitar/logging';
-import { Files, FileManager } from '@jitar/sourcing';
+import { Files, LocalFileManager } from '@jitar/sourcing';
 
 import { ApplicationReader } from './source';
 import { ApplicationBuilder } from './target';
@@ -20,10 +20,10 @@ export default class BuildManager
     {
         this.#logger = new Logger(logLevel);
 
-        const sourceFileManager = new FileManager(configuration.source);
-        const targetFileManager = new FileManager(configuration.target);
-        const resourceFileManager = new FileManager(configuration.resources);
-        const segmentFileManager = new FileManager(configuration.segments);
+        const sourceFileManager = new LocalFileManager(configuration.source);
+        const targetFileManager = new LocalFileManager(configuration.target);
+        const resourceFileManager = new LocalFileManager(configuration.resources);
+        const segmentFileManager = new LocalFileManager(configuration.segments);
 
         this.#fileManager = new ProjectFileManager(sourceFileManager, targetFileManager, resourceFileManager, segmentFileManager);
 

examples/construction/package.json renamed to examples/resources/package.json

@@ -3,7 +3,7 @@ import { ConfigurationManager, RuntimeConfiguration, ServerConfiguration } from
 import { HttpRemoteBuilder, HttpServer } from '@jitar/http';
 import { LogLevel, LogLevelParser } from '@jitar/logging';
 import { ServerBuilder } from '@jitar/runtime';
-import { FileManager, SourcingManager } from '@jitar/sourcing';
+import { LocalSourcingManager } from '@jitar/sourcing';
 
 import ArgumentProcessor from '../ArgumentProcessor';
 import Command from '../Command';
@@ -49,8 +49,7 @@ export default class StartServer implements Command
     {
         const [, , port] = serverConfiguration.url.split(':');
 
-        const fileManager = new FileManager(runtimeConfiguration.target);
-        const sourcingManager = new SourcingManager(fileManager);
+        const sourcingManager = new LocalSourcingManager(runtimeConfiguration.target);
         const remoteBuilder = new HttpRemoteBuilder();
         const serverBuilder = new ServerBuilder(sourcingManager, remoteBuilder);
 

examples/construction/requests.http renamed to examples/resources/requests.http

@@ -1,6 +1,6 @@
 
 import { Validator } from '@jitar/validation';
-import { FileManager } from '@jitar/sourcing';
+import { LocalFileManager } from '@jitar/sourcing';
 
 import { EnvironmentConfigurator } from './environment';
 import { RuntimeConfiguration, RuntimeConfigurationBuilder } from './runtime';
@@ -18,7 +18,7 @@ export default class ConfigurationManager
 
     constructor(rootPath: string = DEFAULT_ROOT_PATH)
     {
-        const fileManager = new FileManager(rootPath);
+        const fileManager = new LocalFileManager(rootPath);
         const reader = new ConfigurationReader(fileManager);
         const validator = new Validator();
 

examples/construction/resources/database.json renamed to examples/resources/resources/database.json

@@ -16,6 +16,7 @@
     "clean": "rm -rf dist"
   },
   "dependencies": {
-    "@jitar/errors": "*"
+    "@jitar/errors": "*",
+    "@jitar/sourcing": "*"
   }
 }

examples/construction/segments/default.json renamed to examples/resources/segments/default.json

@@ -1,4 +1,6 @@
 
+import type { ModuleImporter } from '@jitar/sourcing';
+
 import StatusCodes from './definitions/StatusCodes';
 import RunModes from './definitions/RunModes';
 
@@ -22,10 +24,36 @@ import ErrorConverter from './utils/ErrorConverter';
 
 export default class ExecutionManager implements Runner
 {
+    readonly #moduleImporter: ModuleImporter;
+    readonly #segmentFiles: string[];
+
     readonly #argumentConstructor: ArgumentConstructor = new ArgumentConstructor();
     readonly #errorConverter: ErrorConverter = new ErrorConverter();
     readonly #application: Application = new Application();
 
+    constructor(moduleImporter: ModuleImporter, segmentFiles: string[] = [])
+    {
+        this.#moduleImporter = moduleImporter;
+        this.#segmentFiles = segmentFiles;
+    }
+
+    async start(): Promise<void>
+    {
+        return this.#loadSegments();
+    }
+
+    async stop(): Promise<void>
+    {
+        return this.#clearSegments();
+    }
+
+    async loadSegment(filename: string): Promise<void>
+    {
+        const module = await this.#moduleImporter.import(filename);
+
+        this.addSegment(module.default as Segment);
+    }
+
     async addSegment(segment: Segment): Promise<void>
     {
         if ((segment instanceof Segment) === false)
@@ -85,6 +113,16 @@ export default class ExecutionManager implements Runner
         return this.#runImplementation(request, implementation, args);
     }
 
+    async #loadSegments(): Promise<void>
+    {
+        await Promise.all(this.#segmentFiles.map(filename => this.loadSegment(filename)));
+    }
+
+    #clearSegments(): void
+    {
+        this.#application.clearSegments();
+    }
+
     #getImplementation(fqn: string, version: Version): Implementation
     {
         const procedure = this.#application.getProcedure(fqn);

examples/construction/services/standalone.json renamed to examples/resources/services/standalone.json

@@ -12,6 +12,11 @@ export default class Application
         this.#segments.set(segment.id, segment);
     }
 
+    clearSegments(): void
+    {
+        this.#segments.clear();
+    }
+
     getClassNames(): string[]
     {
         const names = new Set<string>();

examples/construction/src/database.ts renamed to examples/resources/src/database.ts

@@ -1,4 +1,6 @@
 
+import type { ModuleImporter } from '@jitar/sourcing';
+
 import InvalidHealthCheck from './errors/InvalidHealthCheck';
 import type HealthCheck from './interfaces/HealthCheck';
 
@@ -10,8 +12,34 @@ type HealthCheckResult =
 
 export default class HealthManager
 {
+    readonly #moduleImporter: ModuleImporter;
+    readonly #healthCheckFiles: string[];
+
     readonly #healthChecks = new Map<string, HealthCheck>();
 
+    constructor(moduleImporter: ModuleImporter, healthCheckFiles: string[] = [])
+    {
+        this.#moduleImporter = moduleImporter;
+        this.#healthCheckFiles = healthCheckFiles;
+    }
+
+    async start(): Promise<void>
+    {
+        return this.#loadHealthChecks();
+    }
+
+    async stop(): Promise<void>
+    {
+        return this.#clearHealthChecks();
+    }
+
+    async loadHealthCheck(filename: string): Promise<void>
+    {
+        const module = await this.#moduleImporter.import(filename);
+
+        this.addHealthCheck(module.default as HealthCheck);
+    }
+
     addHealthCheck(healthCheck: HealthCheck): void
     {
         if (healthCheck.isHealthy === undefined)
@@ -63,6 +91,16 @@ export default class HealthManager
             .then(() => healthChecks);
     }
 
+    async #loadHealthChecks(): Promise<void>
+    {
+        await Promise.all(this.#healthCheckFiles.map(filename => this.loadHealthCheck(filename)));
+    }
+
+    #clearHealthChecks(): void
+    {
+        this.#healthChecks.clear();
+    }
+
     #handleHealthCheckResult(result: PromiseSettledResult<HealthCheckResult>, healthChecks: Map<string, boolean>): void
     {
         if (result.status !== 'fulfilled')

examples/construction/src/getData.ts renamed to examples/resources/src/getData.ts

@@ -1,14 +1,41 @@
 
 import { Request, Response, StatusCodes } from '@jitar/execution';
+import type { ModuleImporter } from '@jitar/sourcing';
 
 import InvalidMiddleware from './errors/InvalidMiddleware';
 import type Middleware from './interfaces/Middleware';
 import type NextHandler from './types/NextHandler';
 
 export default class MiddlewareManager
 {
+    readonly #moduleImporter: ModuleImporter;
+    readonly #middlewareFiles: string[];
+
     #middlewares: Middleware[] = [];
 
+    constructor(moduleImporter: ModuleImporter, middlewareFiles: string[] = [])
+    {
+        this.#moduleImporter = moduleImporter;
+        this.#middlewareFiles = middlewareFiles;
+    }
+
+    async start(): Promise<void>
+    {
+        return this.#loadMiddlewares();
+    }
+
+    async stop(): Promise<void>
+    {
+        return this.#clearMiddlewares();
+    }
+
+    async loadMiddleware(filename:string): Promise<void>
+    {
+        const module = await this.#moduleImporter.import(filename);
+
+        this.addMiddleware(module.default as Middleware);
+    }
+
     addMiddleware(middleware: Middleware): void
     {
         if (middleware?.handle === undefined)
@@ -38,6 +65,16 @@ export default class MiddlewareManager
         return startHandler();
     }
 
+    async #loadMiddlewares(): Promise<void>
+    {
+        await Promise.all(this.#middlewareFiles.map(filename => this.loadMiddleware(filename)));
+    }
+
+    #clearMiddlewares(): void
+    {
+        this.#middlewares.slice();
+    }
+
     #getNextHandler(request: Request, index: number): NextHandler
     {
         const next = this.#middlewares[index];

examples/construction/src/setUpDatabase.ts renamed to examples/resources/src/setUpDatabase.ts

@@ -198,8 +198,9 @@ export default function viteJitar(pluginConfig: PluginConfig): PluginOption
 
             const remoteBuilder = 'const remoteBuilder = new HttpRemoteBuilder();';
             const clientBuilder = 'const clientBuilder = new ClientBuilder(remoteBuilder);';
-            const build = 'clientBuilder.build({remoteUrl, segments, middleware});';
-            const client = [remoteBuilder, clientBuilder, build].join('\n');
+            const build = 'const client = clientBuilder.build({remoteUrl, segments, middleware});';
+            const start = 'client.start();';
+            const client = [remoteBuilder, clientBuilder, build, start].join('\n');
 
             const exports = `export * from "${JITAR_CLIENT_ID}";`;
 

examples/construction/src/tearDownDatabase.ts renamed to examples/resources/src/tearDownDatabase.ts

@@ -33,21 +33,18 @@ export default class Client extends Runtime
         });
 
         this.#middlewareManager = configuration.middlewareManager;
-
-        const procedureRunner = new ProcedureRunner(this.#worker);
-        this.#middlewareManager.addMiddleware(procedureRunner);
     }
 
     get worker() { return this.#worker; }
 
     start(): Promise<void>
     {
-        return this.#worker.start();
+        return this.#setUp();
     }
 
     stop(): Promise<void>
     {
-        return this.#worker.stop();
+        return this.#tearDown();
     }
 
     getTrustKey(): string | undefined
@@ -64,4 +61,25 @@ export default class Client extends Runtime
     {
         return this.#middlewareManager.handle(request);
     }
+
+    async #setUp(): Promise<void>
+    {
+        await Promise.all(
+        [
+            this.#worker.start(),
+            this.#middlewareManager.start()
+        ]);
+
+        const procedureRunner = new ProcedureRunner(this.#worker);
+        this.#middlewareManager.addMiddleware(procedureRunner);
+    }
+
+    async #tearDown(): Promise<void>
+    {
+        await Promise.all(
+        [
+            this.#middlewareManager.stop(),
+            this.#worker.stop()
+        ]);
+    }
 }

examples/construction/tsconfig.json renamed to examples/resources/tsconfig.json

@@ -2,6 +2,7 @@
 import { Segment, ExecutionManager } from '@jitar/execution';
 import { RemoteBuilder } from '@jitar/services';
 import { Middleware, MiddlewareManager } from '@jitar/middleware';
+import { RemoteSourcingManager } from '@jitar/sourcing';
 
 import Client from './Client';
 
@@ -24,25 +25,29 @@ export default class ClientBuilder
     build(configuration: ClientConfiguration): Client
     {
         const remoteUrl = configuration.remoteUrl;
+        const middleware = configuration.middleware;
+        const segments = configuration.segments;
+
         const remote = this.#remoteBuilder.build(remoteUrl);
-        const middlewareManager = this.#buildMiddlewareManager(configuration.middleware ?? []);
-        const executionManager = this.#buildExecutionManager(configuration.segments ?? []);
+        const sourcingManager = new RemoteSourcingManager(remoteUrl);
+        const middlewareManager = this.#buildMiddlewareManager(sourcingManager, middleware);
+        const executionManager = this.#buildExecutionManager(sourcingManager, segments);
 
         return new Client({ remoteUrl, remote, middlewareManager, executionManager });
     }
 
-    #buildMiddlewareManager(middleware: Middleware[]): MiddlewareManager
+    #buildMiddlewareManager(sourcingManager: RemoteSourcingManager, middleware: Middleware[] = []): MiddlewareManager
     {
-        const manager = new MiddlewareManager();
+        const manager = new MiddlewareManager(sourcingManager);
 
         middleware.forEach(middleware => manager.addMiddleware(middleware));
 
         return manager;
     }
 
-    #buildExecutionManager(segments: Segment[]): ExecutionManager
+    #buildExecutionManager(sourcingManager: RemoteSourcingManager, segments: Segment[] = []): ExecutionManager
     {
-        const manager = new ExecutionManager();
+        const manager = new ExecutionManager(sourcingManager);
 
         segments.forEach(segment => manager.addSegment(segment));