@3sixty/api-service 0.0.0-stage → 0.20.0-next.1

package/dist/es/healthService.js

@@ -0,0 +1,308 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { HealthStatus } from "@3sixty/api-models";
+import { TaskStatus } from "@3sixty/background-task-models";
+import { BaseError, ComponentFactory, Factory, Is } from "@3sixty/core";
+import { ModuleHelper } from "@3sixty/modules";
+/**
+ * The health service for the server.
+ */
+export class HealthService {
+    /**
+     * Runtime name for the class.
+     */
+    static CLASS_NAME = "HealthService";
+    /**
+     * Task type identifier for the application health background task.
+     * @internal
+     */
+    static _APPLICATION_HEALTH_TASK_TYPE = "health-application-check";
+    /**
+     * The server health.
+     * @internal
+     */
+    _healthInfo;
+    /**
+     * The interval for checking the health of the components.
+     * @internal
+     */
+    _healthCheckInterval;
+    /**
+     * The interval for running the application health lifecycle (init, application, teardown).
+     * @internal
+     */
+    _healthApplicationCheckInterval;
+    /**
+     * The initial interval for checking the health of the components.
+     * This is used to check the health of the components immediately after the service is started.
+     * @internal
+     */
+    _initialInterval;
+    /**
+     * Timer for the regular health check.
+     * @internal
+     */
+    _healthTimer;
+    /**
+     * Timer for the application health lifecycle.
+     * @internal
+     */
+    _healthApplicationTimer;
+    /**
+     * Whether the service has been started.
+     * @internal
+     */
+    _started;
+    /**
+     * Health entries from the most recently completed regular health check.
+     * @internal
+     */
+    _regularComponents;
+    /**
+     * Health entries from the most recently completed application health cycle.
+     * @internal
+     */
+    _applicationComponents;
+    /**
+     * Whether to include stack traces in health check error details.
+     * @internal
+     */
+    _includeErrorStack;
+    /**
+     * The background task component for running application health checks.
+     * @internal
+     */
+    _backgroundTaskComponent;
+    /**
+     * The URL of the module to use for the application health background task.
+     * @internal
+     */
+    _applicationHealthTaskHandler;
+    /**
+     * Regular expression patterns for component types to exclude from the health engine clone,
+     * verified when the service is started.
+     * @internal
+     */
+    _excludeCloneComponents;
+    /**
+     * Create a new instance of HealthService.
+     * @param options The constructor options.
+     */
+    constructor(options) {
+        this._healthInfo = { status: HealthStatus.Ok, components: [] };
+        this._healthCheckInterval = options?.config?.healthCheckInterval ?? 60000;
+        this._healthApplicationCheckInterval =
+            options?.config?.healthCheckApplicationInterval ?? 300000;
+        this._initialInterval = options?.config?.initialInterval ?? 2000;
+        this._includeErrorStack = options?.config?.includeErrorStack;
+        this._backgroundTaskComponent = ComponentFactory.get(options?.backgroundTaskComponentType ?? "background-task");
+        this._applicationHealthTaskHandler =
+            options?.config?.overrideApplicationHealthTaskHandler ??
+                new URL("./healthApplicationTask.js", import.meta.url).href;
+        this._excludeCloneComponents = options?.config?.excludeCloneComponents;
+        this._started = false;
+        this._regularComponents = [];
+        this._applicationComponents = [];
+    }
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className() {
+        return HealthService.CLASS_NAME;
+    }
+    /**
+     * The component needs to be started when the node is initialized.
+     * @param nodeLoggingComponentType The node logging component type.
+     * @returns A promise that resolves when the initial health check timers have been scheduled.
+     * @throws GeneralError if an exclude clone component is not a valid regular expression.
+     */
+    async start(nodeLoggingComponentType) {
+        if (!this._started) {
+            // Only load the engine models module when there is something to verify, so a node
+            // with no configured exclusions never has to resolve it.
+            if (Is.arrayValue(this._excludeCloneComponents)) {
+                this._excludeCloneComponents = await ModuleHelper.execModuleMethod("@3sixty/engine-models", "EngineCloneHelper.verifyExcludeCloneComponents", [this._excludeCloneComponents]);
+            }
+            this._started = true;
+            await this._backgroundTaskComponent.registerHandler(HealthService._APPLICATION_HEALTH_TASK_TYPE, this._applicationHealthTaskHandler, "healthApplicationTask", async (task) => {
+                if (task.status === TaskStatus.Success ||
+                    task.status === TaskStatus.Failed ||
+                    task.status === TaskStatus.Cancelled) {
+                    if (task.status === TaskStatus.Success && Is.array(task.result)) {
+                        this._applicationComponents = task.result;
+                        this.groupHealthByName([...this._regularComponents, ...this._applicationComponents]);
+                    }
+                    else if (task.status === TaskStatus.Failed) {
+                        const nodeLogging = ComponentFactory.getIfExists(nodeLoggingComponentType);
+                        await nodeLogging?.log({
+                            level: "error",
+                            source: HealthService.CLASS_NAME,
+                            message: "applicationHealthCheckTaskFailed",
+                            error: Is.object(task.error) ? BaseError.fromError(task.error) : undefined
+                        });
+                    }
+                    this.startApplicationTimer(this._healthApplicationCheckInterval);
+                }
+            }, {
+                idleShutdownTimeout: -1,
+                initialiseMethod: "healthApplicationTaskStart",
+                initialiseMethodParams: async () => [this._excludeCloneComponents],
+                shutdownMethod: "healthApplicationTaskEnd"
+            });
+            // Immediately check health after a startup settling period.
+            // The interval for the next checks are triggered on success of the current
+            // check to prevent overlapping checks in case of long running health checks.
+            this.startTimer(nodeLoggingComponentType, this._initialInterval);
+            this.startApplicationTimer(this._initialInterval);
+        }
+    }
+    /**
+     * The component needs to be stopped when the node is closed.
+     * @param nodeLoggingComponentType The node logging component type.
+     * @returns A promise that resolves when the health check timers have been cancelled.
+     */
+    async stop(nodeLoggingComponentType) {
+        if (this._started) {
+            this._started = false;
+            this.stopTimer();
+            this.stopApplicationTimer();
+            await this._backgroundTaskComponent.unregisterHandler(HealthService._APPLICATION_HEALTH_TASK_TYPE);
+        }
+    }
+    /**
+     * Get the server health.
+     * @returns The service health.
+     */
+    async healthStatus() {
+        return this._healthInfo;
+    }
+    /**
+     * Check the health of all registered components by calling health() on each.
+     * @param nodeLoggingComponentType The node logging component type to log any errors that occur during health checks.
+     * @returns A promise that resolves when all component health checks are complete and the next check is scheduled.
+     * @internal
+     */
+    async checkHealth(nodeLoggingComponentType) {
+        this.stopTimer();
+        const engineCoreFactory = Factory.getFactory("engine-core");
+        if (engineCoreFactory) {
+            // Use a replica of the IEngineCore interface to avoid a circular dependency on the engine-core package.
+            const engineCore = engineCoreFactory.getIfExists("engine");
+            if (engineCore) {
+                const registeredInstances = await engineCore.getRegisteredComponents();
+                const allHealth = [];
+                for (const registeredInstance of registeredInstances) {
+                    if (Is.object(registeredInstance.component)) {
+                        const healthMethod = registeredInstance.component.health?.bind(registeredInstance.component);
+                        if (Is.function(healthMethod)) {
+                            try {
+                                allHealth.push(...(await healthMethod()));
+                            }
+                            catch (error) {
+                                const nodeLogging = ComponentFactory.getIfExists(nodeLoggingComponentType);
+                                await nodeLogging?.log({
+                                    level: "error",
+                                    source: HealthService.CLASS_NAME,
+                                    message: "componentHealthCheckFailed",
+                                    data: { className: registeredInstance.component.className() },
+                                    error: BaseError.fromError(error)
+                                });
+                            }
+                        }
+                    }
+                }
+                this._regularComponents = allHealth;
+                this.groupHealthByName([...this._regularComponents, ...this._applicationComponents]);
+                this.startTimer(nodeLoggingComponentType, this._healthCheckInterval);
+            }
+        }
+    }
+    /**
+     * Group raw health entries by name, collapsing duplicates into a parent with a grouped array.
+     * @param entries The flat list of health entries from all components.
+     * @internal
+     */
+    groupHealthByName(entries) {
+        const bySource = new Map();
+        for (const entry of entries) {
+            const existing = bySource.get(entry.source) ?? [];
+            existing.push({
+                ...entry,
+                error: !Is.empty(entry.error)
+                    ? BaseError.fromError(entry.error).toJsonObject(this._includeErrorStack)
+                    : undefined
+            });
+            bySource.set(entry.source, existing);
+        }
+        const result = [];
+        for (const [source, group] of bySource) {
+            if (group.length > 1) {
+                let parentStatus = HealthStatus.Ok;
+                if (group.some(e => e.status === HealthStatus.Error)) {
+                    parentStatus = HealthStatus.Error;
+                }
+                else if (group.some(e => e.status === HealthStatus.Warning)) {
+                    parentStatus = HealthStatus.Warning;
+                }
+                result.push({ source, status: parentStatus, grouped: group });
+            }
+            else {
+                result.push(group[0]);
+            }
+        }
+        let finalStatus = HealthStatus.Ok;
+        if (result.some(e => e.status === HealthStatus.Error)) {
+            finalStatus = HealthStatus.Error;
+        }
+        else if (result.some(e => e.status === HealthStatus.Warning)) {
+            finalStatus = HealthStatus.Warning;
+        }
+        this._healthInfo = { status: finalStatus, components: result };
+    }
+    /**
+     * Start the regular health check timer.
+     * @param nodeLoggingComponentType The node logging component type.
+     * @param interval The interval for the timer.
+     * @internal
+     */
+    startTimer(nodeLoggingComponentType, interval) {
+        if (this._started) {
+            this._healthTimer = globalThis.setTimeout(async () => this.checkHealth(nodeLoggingComponentType), interval);
+        }
+    }
+    /**
+     * Stop the regular health check timer.
+     * @internal
+     */
+    stopTimer() {
+        if (this._healthTimer) {
+            globalThis.clearTimeout(this._healthTimer);
+            this._healthTimer = undefined;
+        }
+    }
+    /**
+     * Start the application health lifecycle timer.
+     * @param interval The interval for the timer.
+     * @internal
+     */
+    startApplicationTimer(interval) {
+        if (this._started) {
+            this._healthApplicationTimer = globalThis.setTimeout(async () => {
+                this.stopApplicationTimer();
+                await this._backgroundTaskComponent.create(HealthService._APPLICATION_HEALTH_TASK_TYPE);
+            }, interval);
+        }
+    }
+    /**
+     * Stop the application health lifecycle timer.
+     * @internal
+     */
+    stopApplicationTimer() {
+        if (this._healthApplicationTimer) {
+            globalThis.clearTimeout(this._healthApplicationTimer);
+            this._healthApplicationTimer = undefined;
+        }
+    }
+}
+//# sourceMappingURL=healthService.js.map

package/dist/es/healthService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"healthService.js","sources":["../../src/healthService.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAGN,YAAY,EAEZ,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAAE,UAAU,EAAE,MAAM,gCAAgC,CAAC;AAE5D,OAAO,EAAE,SAAS,EAAE,gBAAgB,EAAE,OAAO,EAAmB,EAAE,EAAE,MAAM,cAAc,CAAC;AAEzF,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAI/C;;GAEG;AACH,MAAM,OAAO,aAAa;IACzB;;OAEG;IACI,MAAM,CAAU,UAAU,GAAW,eAAe,CAAC;IAE5D;;;OAGG;IACK,MAAM,CAAU,6BAA6B,GAAW,0BAA0B,CAAC;IAE3F;;;OAGG;IACK,WAAW,CAGjB;IAEF;;;OAGG;IACc,oBAAoB,CAAS;IAE9C;;;OAGG;IACc,+BAA+B,CAAS;IAEzD;;;;OAIG;IACc,gBAAgB,CAAS;IAE1C;;;OAGG;IACK,YAAY,CAAuD;IAE3E;;;OAGG;IACK,uBAAuB,CAAuD;IAEtF;;;OAGG;IACK,QAAQ,CAAU;IAE1B;;;OAGG;IACK,kBAAkB,CAAY;IAEtC;;;OAGG;IACK,sBAAsB,CAAY;IAE1C;;;OAGG;IACc,kBAAkB,CAAW;IAE9C;;;OAGG;IACc,wBAAwB,CAA2B;IAEpE;;;OAGG;IACc,6BAA6B,CAAS;IAEvD;;;;OAIG;IACK,uBAAuB,CAAuB;IAEtD;;;OAGG;IACH,YAAY,OAA0C;QACrD,IAAI,CAAC,WAAW,GAAG,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC;QAC/D,IAAI,CAAC,oBAAoB,GAAG,OAAO,EAAE,MAAM,EAAE,mBAAmB,IAAI,KAAK,CAAC;QAC1E,IAAI,CAAC,+BAA+B;YACnC,OAAO,EAAE,MAAM,EAAE,8BAA8B,IAAI,MAAM,CAAC;QAC3D,IAAI,CAAC,gBAAgB,GAAG,OAAO,EAAE,MAAM,EAAE,eAAe,IAAI,IAAI,CAAC;QACjE,IAAI,CAAC,kBAAkB,GAAG,OAAO,EAAE,MAAM,EAAE,iBAAiB,CAAC;QAC7D,IAAI,CAAC,wBAAwB,GAAG,gBAAgB,CAAC,GAAG,CACnD,OAAO,EAAE,2BAA2B,IAAI,iBAAiB,CACzD,CAAC;QACF,IAAI,CAAC,6BAA6B;YACjC,OAAO,EAAE,MAAM,EAAE,oCAAoC;gBACrD,IAAI,GAAG,CAAC,4BAA4B,EAAE,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;QAC7D,IAAI,CAAC,uBAAuB,GAAG,OAAO,EAAE,MAAM,EAAE,sBAAsB,CAAC;QACvE,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;QACtB,IAAI,CAAC,kBAAkB,GAAG,EAAE,CAAC;QAC7B,IAAI,CAAC,sBAAsB,GAAG,EAAE,CAAC;IAClC,CAAC;IAED;;;OAGG;IACI,SAAS;QACf,OAAO,aAAa,CAAC,UAAU,CAAC;IACjC,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,KAAK,CAAC,wBAAiC;QACnD,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACpB,kFAAkF;YAClF,yDAAyD;YACzD,IAAI,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,uBAAuB,CAAC,EAAE,CAAC;gBACjD,IAAI,CAAC,uBAAuB,GAAG,MAAM,YAAY,CAAC,gBAAgB,CACjE,uBAAuB,EACvB,gDAAgD,EAChD,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAC9B,CAAC;YACH,CAAC;YAED,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;YAErB,MAAM,IAAI,CAAC,wBAAwB,CAAC,eAAe,CAClD,aAAa,CAAC,6BAA6B,EAC3C,IAAI,CAAC,6BAA6B,EAClC,uBAAuB,EACvB,KAAK,EAAE,IAA2C,EAAE,EAAE;gBACrD,IACC,IAAI,CAAC,MAAM,KAAK,UAAU,CAAC,OAAO;oBAClC,IAAI,CAAC,MAAM,KAAK,UAAU,CAAC,MAAM;oBACjC,IAAI,CAAC,MAAM,KAAK,UAAU,CAAC,SAAS,EACnC,CAAC;oBACF,IAAI,IAAI,CAAC,MAAM,KAAK,UAAU,CAAC,OAAO,IAAI,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;wBACjE,IAAI,CAAC,sBAAsB,GAAG,IAAI,CAAC,MAAM,CAAC;wBAC1C,IAAI,CAAC,iBAAiB,CAAC,CAAC,GAAG,IAAI,CAAC,kBAAkB,EAAE,GAAG,IAAI,CAAC,sBAAsB,CAAC,CAAC,CAAC;oBACtF,CAAC;yBAAM,IAAI,IAAI,CAAC,MAAM,KAAK,UAAU,CAAC,MAAM,EAAE,CAAC;wBAC9C,MAAM,WAAW,GAChB,gBAAgB,CAAC,WAAW,CAAoB,wBAAwB,CAAC,CAAC;wBAC3E,MAAM,WAAW,EAAE,GAAG,CAAC;4BACtB,KAAK,EAAE,OAAO;4BACd,MAAM,EAAE,aAAa,CAAC,UAAU;4BAChC,OAAO,EAAE,kCAAkC;4BAC3C,KAAK,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS;yBAC1E,CAAC,CAAC;oBACJ,CAAC;oBACD,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,+BAA+B,CAAC,CAAC;gBAClE,CAAC;YACF,CAAC,EACD;gBACC,mBAAmB,EAAE,CAAC,CAAC;gBACvB,gBAAgB,EAAE,4BAA4B;gBAC9C,sBAAsB,EAAE,KAAK,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,uBAAuB,CAAC;gBAClE,cAAc,EAAE,0BAA0B;aAC1C,CACD,CAAC;YAEF,4DAA4D;YAC5D,2EAA2E;YAC3E,6EAA6E;YAC7E,IAAI,CAAC,UAAU,CAAC,wBAAwB,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;YACjE,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QACnD,CAAC;IACF,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,IAAI,CAAC,wBAAiC;QAClD,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YACnB,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;YACtB,IAAI,CAAC,SAAS,EAAE,CAAC;YACjB,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAE5B,MAAM,IAAI,CAAC,wBAAwB,CAAC,iBAAiB,CACpD,aAAa,CAAC,6BAA6B,CAC3C,CAAC;QACH,CAAC;IACF,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,YAAY;QACxB,OAAO,IAAI,CAAC,WAAW,CAAC;IACzB,CAAC;IAED;;;;;OAKG;IACK,KAAK,CAAC,WAAW,CAAC,wBAAiC;QAC1D,IAAI,CAAC,SAAS,EAAE,CAAC;QAEjB,MAAM,iBAAiB,GAAG,OAAO,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;QAE5D,IAAI,iBAAiB,EAAE,CAAC;YACvB,wGAAwG;YACxG,MAAM,UAAU,GAAG,iBAAiB,CAAC,WAAW,CAQ7C,QAAQ,CAAC,CAAC;YAEb,IAAI,UAAU,EAAE,CAAC;gBAChB,MAAM,mBAAmB,GAAG,MAAM,UAAU,CAAC,uBAAuB,EAAE,CAAC;gBACvE,MAAM,SAAS,GAAc,EAAE,CAAC;gBAEhC,KAAK,MAAM,kBAAkB,IAAI,mBAAmB,EAAE,CAAC;oBACtD,IAAI,EAAE,CAAC,MAAM,CAA2B,kBAAkB,CAAC,SAAS,CAAC,EAAE,CAAC;wBACvE,MAAM,YAAY,GAAG,kBAAkB,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,CAC7D,kBAAkB,CAAC,SAAS,CAC5B,CAAC;wBACF,IAAI,EAAE,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC;4BAC/B,IAAI,CAAC;gCACJ,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,YAAY,EAAE,CAAC,CAAC,CAAC;4BAC3C,CAAC;4BAAC,OAAO,KAAK,EAAE,CAAC;gCAChB,MAAM,WAAW,GAChB,gBAAgB,CAAC,WAAW,CAAoB,wBAAwB,CAAC,CAAC;gCAC3E,MAAM,WAAW,EAAE,GAAG,CAAC;oCACtB,KAAK,EAAE,OAAO;oCACd,MAAM,EAAE,aAAa,CAAC,UAAU;oCAChC,OAAO,EAAE,4BAA4B;oCACrC,IAAI,EAAE,EAAE,SAAS,EAAE,kBAAkB,CAAC,SAAS,CAAC,SAAS,EAAE,EAAE;oCAC7D,KAAK,EAAE,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC;iCACjC,CAAC,CAAC;4BACJ,CAAC;wBACF,CAAC;oBACF,CAAC;gBACF,CAAC;gBAED,IAAI,CAAC,kBAAkB,GAAG,SAAS,CAAC;gBACpC,IAAI,CAAC,iBAAiB,CAAC,CAAC,GAAG,IAAI,CAAC,kBAAkB,EAAE,GAAG,IAAI,CAAC,sBAAsB,CAAC,CAAC,CAAC;gBACrF,IAAI,CAAC,UAAU,CAAC,wBAAwB,EAAE,IAAI,CAAC,oBAAoB,CAAC,CAAC;YACtE,CAAC;QACF,CAAC;IACF,CAAC;IAED;;;;OAIG;IACK,iBAAiB,CAAC,OAAkB;QAC3C,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAqB,CAAC;QAC9C,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;YAC7B,MAAM,QAAQ,GAAG,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;YAClD,QAAQ,CAAC,IAAI,CAAC;gBACb,GAAG,KAAK;gBACR,KAAK,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC;oBAC5B,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,kBAAkB,CAAC;oBACxE,CAAC,CAAC,SAAS;aACZ,CAAC,CAAC;YACH,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;QACtC,CAAC;QAED,MAAM,MAAM,GAAc,EAAE,CAAC;QAC7B,KAAK,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,IAAI,QAAQ,EAAE,CAAC;YACxC,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACtB,IAAI,YAAY,GAAiB,YAAY,CAAC,EAAE,CAAC;gBAEjD,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC;oBACtD,YAAY,GAAG,YAAY,CAAC,KAAK,CAAC;gBACnC,CAAC;qBAAM,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,YAAY,CAAC,OAAO,CAAC,EAAE,CAAC;oBAC/D,YAAY,GAAG,YAAY,CAAC,OAAO,CAAC;gBACrC,CAAC;gBAED,MAAM,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;YAC/D,CAAC;iBAAM,CAAC;gBACP,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;YACvB,CAAC;QACF,CAAC;QAED,IAAI,WAAW,GAAiB,YAAY,CAAC,EAAE,CAAC;QAChD,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC;YACvD,WAAW,GAAG,YAAY,CAAC,KAAK,CAAC;QAClC,CAAC;aAAM,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,YAAY,CAAC,OAAO,CAAC,EAAE,CAAC;YAChE,WAAW,GAAG,YAAY,CAAC,OAAO,CAAC;QACpC,CAAC;QAED,IAAI,CAAC,WAAW,GAAG,EAAE,MAAM,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,EAAE,CAAC;IAChE,CAAC;IAED;;;;;OAKG;IACK,UAAU,CAAC,wBAA4C,EAAE,QAAgB;QAChF,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YACnB,IAAI,CAAC,YAAY,GAAG,UAAU,CAAC,UAAU,CACxC,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,wBAAwB,CAAC,EACtD,QAAQ,CACR,CAAC;QACH,CAAC;IACF,CAAC;IAED;;;OAGG;IACK,SAAS;QAChB,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YACvB,UAAU,CAAC,YAAY,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YAC3C,IAAI,CAAC,YAAY,GAAG,SAAS,CAAC;QAC/B,CAAC;IACF,CAAC;IAED;;;;OAIG;IACK,qBAAqB,CAAC,QAAgB;QAC7C,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YACnB,IAAI,CAAC,uBAAuB,GAAG,UAAU,CAAC,UAAU,CAAC,KAAK,IAAI,EAAE;gBAC/D,IAAI,CAAC,oBAAoB,EAAE,CAAC;gBAE5B,MAAM,IAAI,CAAC,wBAAwB,CAAC,MAAM,CAAC,aAAa,CAAC,6BAA6B,CAAC,CAAC;YACzF,CAAC,EAAE,QAAQ,CAAC,CAAC;QACd,CAAC;IACF,CAAC;IAED;;;OAGG;IACK,oBAAoB;QAC3B,IAAI,IAAI,CAAC,uBAAuB,EAAE,CAAC;YAClC,UAAU,CAAC,YAAY,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC;YACtD,IAAI,CAAC,uBAAuB,GAAG,SAAS,CAAC;QAC1C,CAAC;IACF,CAAC;CACD","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport {\n\ttype IHealth,\n\ttype IHealthComponent,\n\tHealthStatus,\n\ttype IHealthProviderComponent\n} from \"@3sixty/api-models\";\nimport type { IBackgroundTask, IBackgroundTaskComponent } from \"@3sixty/background-task-models\";\nimport { TaskStatus } from \"@3sixty/background-task-models\";\nimport type { IContextIds } from \"@3sixty/context\";\nimport { BaseError, ComponentFactory, Factory, type IComponent, Is } from \"@3sixty/core\";\nimport type { ILoggingComponent } from \"@3sixty/logging-models\";\nimport { ModuleHelper } from \"@3sixty/modules\";\n\nimport type { IHealthServiceConstructorOptions } from \"./models/IHealthServiceConstructorOptions.js\";\n\n/**\n * The health service for the server.\n */\nexport class HealthService implements IHealthComponent {\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = \"HealthService\";\n\n\t/**\n\t * Task type identifier for the application health background task.\n\t * @internal\n\t */\n\tprivate static readonly _APPLICATION_HEALTH_TASK_TYPE: string = \"health-application-check\";\n\n\t/**\n\t * The server health.\n\t * @internal\n\t */\n\tprivate _healthInfo: {\n\t\tstatus: HealthStatus;\n\t\tcomponents: IHealth[];\n\t};\n\n\t/**\n\t * The interval for checking the health of the components.\n\t * @internal\n\t */\n\tprivate readonly _healthCheckInterval: number;\n\n\t/**\n\t * The interval for running the application health lifecycle (init, application, teardown).\n\t * @internal\n\t */\n\tprivate readonly _healthApplicationCheckInterval: number;\n\n\t/**\n\t * The initial interval for checking the health of the components.\n\t * This is used to check the health of the components immediately after the service is started.\n\t * @internal\n\t */\n\tprivate readonly _initialInterval: number;\n\n\t/**\n\t * Timer for the regular health check.\n\t * @internal\n\t */\n\tprivate _healthTimer: ReturnType<typeof globalThis.setTimeout> | undefined;\n\n\t/**\n\t * Timer for the application health lifecycle.\n\t * @internal\n\t */\n\tprivate _healthApplicationTimer: ReturnType<typeof globalThis.setTimeout> | undefined;\n\n\t/**\n\t * Whether the service has been started.\n\t * @internal\n\t */\n\tprivate _started: boolean;\n\n\t/**\n\t * Health entries from the most recently completed regular health check.\n\t * @internal\n\t */\n\tprivate _regularComponents: IHealth[];\n\n\t/**\n\t * Health entries from the most recently completed application health cycle.\n\t * @internal\n\t */\n\tprivate _applicationComponents: IHealth[];\n\n\t/**\n\t * Whether to include stack traces in health check error details.\n\t * @internal\n\t */\n\tprivate readonly _includeErrorStack?: boolean;\n\n\t/**\n\t * The background task component for running application health checks.\n\t * @internal\n\t */\n\tprivate readonly _backgroundTaskComponent: IBackgroundTaskComponent;\n\n\t/**\n\t * The URL of the module to use for the application health background task.\n\t * @internal\n\t */\n\tprivate readonly _applicationHealthTaskHandler: string;\n\n\t/**\n\t * Regular expression patterns for component types to exclude from the health engine clone,\n\t * verified when the service is started.\n\t * @internal\n\t */\n\tprivate _excludeCloneComponents: string[] | undefined;\n\n\t/**\n\t * Create a new instance of HealthService.\n\t * @param options The constructor options.\n\t */\n\tconstructor(options?: IHealthServiceConstructorOptions) {\n\t\tthis._healthInfo = { status: HealthStatus.Ok, components: [] };\n\t\tthis._healthCheckInterval = options?.config?.healthCheckInterval ?? 60000;\n\t\tthis._healthApplicationCheckInterval =\n\t\t\toptions?.config?.healthCheckApplicationInterval ?? 300000;\n\t\tthis._initialInterval = options?.config?.initialInterval ?? 2000;\n\t\tthis._includeErrorStack = options?.config?.includeErrorStack;\n\t\tthis._backgroundTaskComponent = ComponentFactory.get<IBackgroundTaskComponent>(\n\t\t\toptions?.backgroundTaskComponentType ?? \"background-task\"\n\t\t);\n\t\tthis._applicationHealthTaskHandler =\n\t\t\toptions?.config?.overrideApplicationHealthTaskHandler ??\n\t\t\tnew URL(\"./healthApplicationTask.js\", import.meta.url).href;\n\t\tthis._excludeCloneComponents = options?.config?.excludeCloneComponents;\n\t\tthis._started = false;\n\t\tthis._regularComponents = [];\n\t\tthis._applicationComponents = [];\n\t}\n\n\t/**\n\t * Returns the class name of the component.\n\t * @returns The class name of the component.\n\t */\n\tpublic className(): string {\n\t\treturn HealthService.CLASS_NAME;\n\t}\n\n\t/**\n\t * The component needs to be started when the node is initialized.\n\t * @param nodeLoggingComponentType The node logging component type.\n\t * @returns A promise that resolves when the initial health check timers have been scheduled.\n\t * @throws GeneralError if an exclude clone component is not a valid regular expression.\n\t */\n\tpublic async start(nodeLoggingComponentType?: string): Promise<void> {\n\t\tif (!this._started) {\n\t\t\t// Only load the engine models module when there is something to verify, so a node\n\t\t\t// with no configured exclusions never has to resolve it.\n\t\t\tif (Is.arrayValue(this._excludeCloneComponents)) {\n\t\t\t\tthis._excludeCloneComponents = await ModuleHelper.execModuleMethod<string[] | undefined>(\n\t\t\t\t\t\"@3sixty/engine-models\",\n\t\t\t\t\t\"EngineCloneHelper.verifyExcludeCloneComponents\",\n\t\t\t\t\t[this._excludeCloneComponents]\n\t\t\t\t);\n\t\t\t}\n\n\t\t\tthis._started = true;\n\n\t\t\tawait this._backgroundTaskComponent.registerHandler<undefined, IHealth[]>(\n\t\t\t\tHealthService._APPLICATION_HEALTH_TASK_TYPE,\n\t\t\t\tthis._applicationHealthTaskHandler,\n\t\t\t\t\"healthApplicationTask\",\n\t\t\t\tasync (task: IBackgroundTask<undefined, IHealth[]>) => {\n\t\t\t\t\tif (\n\t\t\t\t\t\ttask.status === TaskStatus.Success ||\n\t\t\t\t\t\ttask.status === TaskStatus.Failed ||\n\t\t\t\t\t\ttask.status === TaskStatus.Cancelled\n\t\t\t\t\t) {\n\t\t\t\t\t\tif (task.status === TaskStatus.Success && Is.array(task.result)) {\n\t\t\t\t\t\t\tthis._applicationComponents = task.result;\n\t\t\t\t\t\t\tthis.groupHealthByName([...this._regularComponents, ...this._applicationComponents]);\n\t\t\t\t\t\t} else if (task.status === TaskStatus.Failed) {\n\t\t\t\t\t\t\tconst nodeLogging =\n\t\t\t\t\t\t\t\tComponentFactory.getIfExists<ILoggingComponent>(nodeLoggingComponentType);\n\t\t\t\t\t\t\tawait nodeLogging?.log({\n\t\t\t\t\t\t\t\tlevel: \"error\",\n\t\t\t\t\t\t\t\tsource: HealthService.CLASS_NAME,\n\t\t\t\t\t\t\t\tmessage: \"applicationHealthCheckTaskFailed\",\n\t\t\t\t\t\t\t\terror: Is.object(task.error) ? BaseError.fromError(task.error) : undefined\n\t\t\t\t\t\t\t});\n\t\t\t\t\t\t}\n\t\t\t\t\t\tthis.startApplicationTimer(this._healthApplicationCheckInterval);\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\tidleShutdownTimeout: -1,\n\t\t\t\t\tinitialiseMethod: \"healthApplicationTaskStart\",\n\t\t\t\t\tinitialiseMethodParams: async () => [this._excludeCloneComponents],\n\t\t\t\t\tshutdownMethod: \"healthApplicationTaskEnd\"\n\t\t\t\t}\n\t\t\t);\n\n\t\t\t// Immediately check health after a startup settling period.\n\t\t\t// The interval for the next checks are triggered on success of the current\n\t\t\t// check to prevent overlapping checks in case of long running health checks.\n\t\t\tthis.startTimer(nodeLoggingComponentType, this._initialInterval);\n\t\t\tthis.startApplicationTimer(this._initialInterval);\n\t\t}\n\t}\n\n\t/**\n\t * The component needs to be stopped when the node is closed.\n\t * @param nodeLoggingComponentType The node logging component type.\n\t * @returns A promise that resolves when the health check timers have been cancelled.\n\t */\n\tpublic async stop(nodeLoggingComponentType?: string): Promise<void> {\n\t\tif (this._started) {\n\t\t\tthis._started = false;\n\t\t\tthis.stopTimer();\n\t\t\tthis.stopApplicationTimer();\n\n\t\t\tawait this._backgroundTaskComponent.unregisterHandler(\n\t\t\t\tHealthService._APPLICATION_HEALTH_TASK_TYPE\n\t\t\t);\n\t\t}\n\t}\n\n\t/**\n\t * Get the server health.\n\t * @returns The service health.\n\t */\n\tpublic async healthStatus(): Promise<{ status: HealthStatus; components: IHealth[] }> {\n\t\treturn this._healthInfo;\n\t}\n\n\t/**\n\t * Check the health of all registered components by calling health() on each.\n\t * @param nodeLoggingComponentType The node logging component type to log any errors that occur during health checks.\n\t * @returns A promise that resolves when all component health checks are complete and the next check is scheduled.\n\t * @internal\n\t */\n\tprivate async checkHealth(nodeLoggingComponentType?: string): Promise<void> {\n\t\tthis.stopTimer();\n\n\t\tconst engineCoreFactory = Factory.getFactory(\"engine-core\");\n\n\t\tif (engineCoreFactory) {\n\t\t\t// Use a replica of the IEngineCore interface to avoid a circular dependency on the engine-core package.\n\t\t\tconst engineCore = engineCoreFactory.getIfExists<{\n\t\t\t\tgetContextIds: () => IContextIds | undefined;\n\t\t\t\tgetRegisteredComponents: () => Promise<\n\t\t\t\t\t{\n\t\t\t\t\t\tinstanceType: string;\n\t\t\t\t\t\tcomponent: IComponent;\n\t\t\t\t\t}[]\n\t\t\t\t>;\n\t\t\t}>(\"engine\");\n\n\t\t\tif (engineCore) {\n\t\t\t\tconst registeredInstances = await engineCore.getRegisteredComponents();\n\t\t\t\tconst allHealth: IHealth[] = [];\n\n\t\t\t\tfor (const registeredInstance of registeredInstances) {\n\t\t\t\t\tif (Is.object<IHealthProviderComponent>(registeredInstance.component)) {\n\t\t\t\t\t\tconst healthMethod = registeredInstance.component.health?.bind(\n\t\t\t\t\t\t\tregisteredInstance.component\n\t\t\t\t\t\t);\n\t\t\t\t\t\tif (Is.function(healthMethod)) {\n\t\t\t\t\t\t\ttry {\n\t\t\t\t\t\t\t\tallHealth.push(...(await healthMethod()));\n\t\t\t\t\t\t\t} catch (error) {\n\t\t\t\t\t\t\t\tconst nodeLogging =\n\t\t\t\t\t\t\t\t\tComponentFactory.getIfExists<ILoggingComponent>(nodeLoggingComponentType);\n\t\t\t\t\t\t\t\tawait nodeLogging?.log({\n\t\t\t\t\t\t\t\t\tlevel: \"error\",\n\t\t\t\t\t\t\t\t\tsource: HealthService.CLASS_NAME,\n\t\t\t\t\t\t\t\t\tmessage: \"componentHealthCheckFailed\",\n\t\t\t\t\t\t\t\t\tdata: { className: registeredInstance.component.className() },\n\t\t\t\t\t\t\t\t\terror: BaseError.fromError(error)\n\t\t\t\t\t\t\t\t});\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\n\t\t\t\tthis._regularComponents = allHealth;\n\t\t\t\tthis.groupHealthByName([...this._regularComponents, ...this._applicationComponents]);\n\t\t\t\tthis.startTimer(nodeLoggingComponentType, this._healthCheckInterval);\n\t\t\t}\n\t\t}\n\t}\n\n\t/**\n\t * Group raw health entries by name, collapsing duplicates into a parent with a grouped array.\n\t * @param entries The flat list of health entries from all components.\n\t * @internal\n\t */\n\tprivate groupHealthByName(entries: IHealth[]): void {\n\t\tconst bySource = new Map<string, IHealth[]>();\n\t\tfor (const entry of entries) {\n\t\t\tconst existing = bySource.get(entry.source) ?? [];\n\t\t\texisting.push({\n\t\t\t\t...entry,\n\t\t\t\terror: !Is.empty(entry.error)\n\t\t\t\t\t? BaseError.fromError(entry.error).toJsonObject(this._includeErrorStack)\n\t\t\t\t\t: undefined\n\t\t\t});\n\t\t\tbySource.set(entry.source, existing);\n\t\t}\n\n\t\tconst result: IHealth[] = [];\n\t\tfor (const [source, group] of bySource) {\n\t\t\tif (group.length > 1) {\n\t\t\t\tlet parentStatus: HealthStatus = HealthStatus.Ok;\n\n\t\t\t\tif (group.some(e => e.status === HealthStatus.Error)) {\n\t\t\t\t\tparentStatus = HealthStatus.Error;\n\t\t\t\t} else if (group.some(e => e.status === HealthStatus.Warning)) {\n\t\t\t\t\tparentStatus = HealthStatus.Warning;\n\t\t\t\t}\n\n\t\t\t\tresult.push({ source, status: parentStatus, grouped: group });\n\t\t\t} else {\n\t\t\t\tresult.push(group[0]);\n\t\t\t}\n\t\t}\n\n\t\tlet finalStatus: HealthStatus = HealthStatus.Ok;\n\t\tif (result.some(e => e.status === HealthStatus.Error)) {\n\t\t\tfinalStatus = HealthStatus.Error;\n\t\t} else if (result.some(e => e.status === HealthStatus.Warning)) {\n\t\t\tfinalStatus = HealthStatus.Warning;\n\t\t}\n\n\t\tthis._healthInfo = { status: finalStatus, components: result };\n\t}\n\n\t/**\n\t * Start the regular health check timer.\n\t * @param nodeLoggingComponentType The node logging component type.\n\t * @param interval The interval for the timer.\n\t * @internal\n\t */\n\tprivate startTimer(nodeLoggingComponentType: string | undefined, interval: number): void {\n\t\tif (this._started) {\n\t\t\tthis._healthTimer = globalThis.setTimeout(\n\t\t\t\tasync () => this.checkHealth(nodeLoggingComponentType),\n\t\t\t\tinterval\n\t\t\t);\n\t\t}\n\t}\n\n\t/**\n\t * Stop the regular health check timer.\n\t * @internal\n\t */\n\tprivate stopTimer(): void {\n\t\tif (this._healthTimer) {\n\t\t\tglobalThis.clearTimeout(this._healthTimer);\n\t\t\tthis._healthTimer = undefined;\n\t\t}\n\t}\n\n\t/**\n\t * Start the application health lifecycle timer.\n\t * @param interval The interval for the timer.\n\t * @internal\n\t */\n\tprivate startApplicationTimer(interval: number): void {\n\t\tif (this._started) {\n\t\t\tthis._healthApplicationTimer = globalThis.setTimeout(async () => {\n\t\t\t\tthis.stopApplicationTimer();\n\n\t\t\t\tawait this._backgroundTaskComponent.create(HealthService._APPLICATION_HEALTH_TASK_TYPE);\n\t\t\t}, interval);\n\t\t}\n\t}\n\n\t/**\n\t * Stop the application health lifecycle timer.\n\t * @internal\n\t */\n\tprivate stopApplicationTimer(): void {\n\t\tif (this._healthApplicationTimer) {\n\t\t\tglobalThis.clearTimeout(this._healthApplicationTimer);\n\t\t\tthis._healthApplicationTimer = undefined;\n\t\t}\n\t}\n}\n"]}

package/dist/es/index.js

@@ -0,0 +1,15 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export * from "./healthRoutes.js";
+export * from "./healthService.js";
+export * from "./informationRoutes.js";
+export * from "./informationService.js";
+export * from "./models/IHealthServiceConfig.js";
+export * from "./models/IHealthServiceConstructorOptions.js";
+export * from "./models/IInformationServiceConfig.js";
+export * from "./models/IInformationServiceConstructorOptions.js";
+export * from "./models/IPlatformServiceConfig.js";
+export * from "./models/IPlatformServiceConstructorOptions.js";
+export * from "./platformService.js";
+export * from "./restEntryPoints.js";
+//# sourceMappingURL=index.js.map

package/dist/es/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,wBAAwB,CAAC;AACvC,cAAc,yBAAyB,CAAC;AACxC,cAAc,kCAAkC,CAAC;AACjD,cAAc,8CAA8C,CAAC;AAC7D,cAAc,uCAAuC,CAAC;AACtD,cAAc,mDAAmD,CAAC;AAClE,cAAc,oCAAoC,CAAC;AACnD,cAAc,gDAAgD,CAAC;AAC/D,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./healthRoutes.js\";\nexport * from \"./healthService.js\";\nexport * from \"./informationRoutes.js\";\nexport * from \"./informationService.js\";\nexport * from \"./models/IHealthServiceConfig.js\";\nexport * from \"./models/IHealthServiceConstructorOptions.js\";\nexport * from \"./models/IInformationServiceConfig.js\";\nexport * from \"./models/IInformationServiceConstructorOptions.js\";\nexport * from \"./models/IPlatformServiceConfig.js\";\nexport * from \"./models/IPlatformServiceConstructorOptions.js\";\nexport * from \"./platformService.js\";\nexport * from \"./restEntryPoints.js\";\n"]}

package/dist/es/informationRoutes.js

@@ -0,0 +1,298 @@
+import { ComponentFactory, Is } from "@3sixty/core";
+import { HeaderTypes, HttpStatusCode, MimeTypes } from "@3sixty/web";
+/**
+ * The tag to associate with the routes.
+ */
+export const tagsInformation = [
+    {
+        name: "Info",
+        description: "Information endpoints for the REST server."
+    }
+];
+/**
+ * The REST routes for server information.
+ * @param baseRouteName Prefix to prepend to the paths.
+ * @param componentName The name of the component to use in the routes stored in the ComponentFactory.
+ * @returns The generated routes.
+ */
+export function generateRestRoutesInformation(baseRouteName, componentName) {
+    const rootRoute = {
+        operationId: "serverRoot",
+        summary: "Get the root text page",
+        tag: tagsInformation[0].name,
+        method: "GET",
+        path: `${baseRouteName}/`,
+        handler: async (httpRequestContext, request) => serverRoot(httpRequestContext, componentName, request),
+        responseType: [
+            {
+                type: "IServerRootResponse",
+                mimeType: MimeTypes.PlainText,
+                examples: [
+                    {
+                        id: "serverRootResponse",
+                        description: "The response for the root request.",
+                        response: {
+                            headers: {
+                                [HeaderTypes.ContentType]: MimeTypes.PlainText
+                            },
+                            body: "API Server - 1.0.0"
+                        }
+                    }
+                ]
+            }
+        ],
+        skipAuth: true,
+        skipTenant: true
+    };
+    const informationRoute = {
+        operationId: "serverInformation",
+        summary: "Get the information for the server",
+        tag: tagsInformation[0].name,
+        method: "GET",
+        path: `${baseRouteName}/info`,
+        handler: async (httpRequestContext, request) => serverInfo(httpRequestContext, componentName, request),
+        responseType: [
+            {
+                type: "IServerInfoResponse",
+                examples: [
+                    {
+                        id: "informationResponse",
+                        description: "The response for the information request.",
+                        response: {
+                            body: {
+                                name: "API Server",
+                                version: "1.0.0"
+                            }
+                        }
+                    }
+                ]
+            }
+        ],
+        skipAuth: true,
+        skipTenant: true
+    };
+    const favIconRoute = {
+        operationId: "serverFavIcon",
+        summary: "Get the favicon for the server",
+        tag: tagsInformation[0].name,
+        method: "GET",
+        path: `${baseRouteName}/favicon.ico`,
+        handler: async (httpRequestContext, request) => serverFavIcon(httpRequestContext, componentName, request),
+        responseType: [
+            {
+                type: "IServerFavIconResponse",
+                mimeType: "image/x-icon"
+            }
+        ],
+        skipAuth: true,
+        skipTenant: true
+    };
+    const livezRoute = {
+        operationId: "serverLivez",
+        summary: "Get the livez status for the server",
+        tag: tagsInformation[0].name,
+        method: "GET",
+        path: `${baseRouteName}/livez`,
+        handler: async (httpRequestContext, request) => serverLivez(httpRequestContext, componentName, request),
+        responseType: [
+            {
+                type: "IServerLivezResponse",
+                mimeType: MimeTypes.PlainText,
+                examples: [
+                    {
+                        id: "livezResponseOK",
+                        description: "The response for the liveness request.",
+                        response: {
+                            headers: {
+                                [HeaderTypes.ContentType]: MimeTypes.PlainText
+                            },
+                            body: "alive"
+                        }
+                    },
+                    {
+                        id: "livezResponseFailure",
+                        description: "The response for the liveness request with errors.",
+                        response: {
+                            headers: {
+                                [HeaderTypes.ContentType]: MimeTypes.PlainText
+                            },
+                            body: "dead"
+                        }
+                    }
+                ]
+            }
+        ],
+        skipAuth: true,
+        skipTenant: true
+    };
+    const readyzRoute = {
+        operationId: "serverReadyz",
+        summary: "Get the readyz status for the server",
+        tag: tagsInformation[0].name,
+        method: "GET",
+        path: `${baseRouteName}/readyz`,
+        handler: async (httpRequestContext, request) => serverReadyz(httpRequestContext, componentName, request),
+        responseType: [
+            {
+                type: "IServerReadyzResponse",
+                mimeType: MimeTypes.PlainText,
+                examples: [
+                    {
+                        id: "readyzResponseOK",
+                        description: "The response for the readiness request.",
+                        response: {
+                            headers: {
+                                [HeaderTypes.ContentType]: MimeTypes.PlainText
+                            },
+                            body: "ready"
+                        }
+                    },
+                    {
+                        id: "readyzResponseFailure",
+                        description: "The response for the readiness request with errors.",
+                        response: {
+                            headers: {
+                                [HeaderTypes.ContentType]: MimeTypes.PlainText
+                            },
+                            body: "not ready"
+                        }
+                    }
+                ]
+            }
+        ],
+        skipAuth: true,
+        skipTenant: true
+    };
+    const specRoute = {
+        operationId: "serverSpec",
+        summary: "Get the OpenAPI specification for the endpoints",
+        tag: tagsInformation[0].name,
+        method: "GET",
+        path: `${baseRouteName}/spec`,
+        handler: async (httpRequestContext, request) => serverSpec(httpRequestContext, componentName, request),
+        responseType: [
+            {
+                type: "IServerSpecResponse",
+                examples: [
+                    {
+                        id: "specResponse",
+                        description: "The response for the spec request.",
+                        response: {
+                            body: {
+                                openapi: "3.1.0",
+                                info: {},
+                                paths: {}
+                            }
+                        }
+                    }
+                ]
+            }
+        ],
+        skipAuth: true,
+        skipTenant: true
+    };
+    return [rootRoute, favIconRoute, informationRoute, livezRoute, readyzRoute, specRoute];
+}
+/**
+ * Get the root for the server.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export async function serverRoot(httpRequestContext, componentName, request) {
+    const component = ComponentFactory.get(componentName);
+    return {
+        headers: {
+            [HeaderTypes.ContentType]: MimeTypes.PlainText
+        },
+        body: await component.root()
+    };
+}
+/**
+ * Get the information for the server.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export async function serverInfo(httpRequestContext, componentName, request) {
+    const component = ComponentFactory.get(componentName);
+    return {
+        body: await component.info()
+    };
+}
+/**
+ * Get the livez for the server.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export async function serverLivez(httpRequestContext, componentName, request) {
+    const component = ComponentFactory.get(componentName);
+    return {
+        headers: {
+            [HeaderTypes.ContentType]: MimeTypes.PlainText
+        },
+        body: (await component.livez()).status
+    };
+}
+/**
+ * Get the readyz for the server.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export async function serverReadyz(httpRequestContext, componentName, request) {
+    const component = ComponentFactory.get(componentName);
+    return {
+        headers: {
+            [HeaderTypes.ContentType]: MimeTypes.PlainText
+        },
+        body: (await component.readyz()).status
+    };
+}
+/**
+ * Get the favicon for the server.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export async function serverFavIcon(httpRequestContext, componentName, request) {
+    const component = ComponentFactory.get(componentName);
+    const favIcon = await component.favicon();
+    if (Is.uint8Array(favIcon)) {
+        return {
+            headers: {
+                [HeaderTypes.ContentType]: "image/x-icon"
+            },
+            body: favIcon
+        };
+    }
+    return {
+        statusCode: HttpStatusCode.notFound
+    };
+}
+/**
+ * Get the spec for the server.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export async function serverSpec(httpRequestContext, componentName, request) {
+    const component = ComponentFactory.get(componentName);
+    const spec = await component.spec();
+    if (Is.objectValue(spec)) {
+        return {
+            body: spec
+        };
+    }
+    return {
+        statusCode: HttpStatusCode.notFound
+    };
+}
+//# sourceMappingURL=informationRoutes.js.map