@bitblit/ratchet-epsilon-common 4.0.115-alpha → 4.0.119-alpha

package/lib/util/aws-util.js

@@ -1,65 +0,0 @@
-export class AwsUtil {
-    static apiGatewayV2ToApiGatewayV1(srcEvt) {
-        const rval = {
-            requestContext: AwsUtil.apiGatewayV2RequestContextToApiGatewayV1RequestContext(srcEvt.requestContext),
-            httpMethod: srcEvt.requestContext.http.method,
-            path: srcEvt.requestContext.http.path,
-            queryStringParameters: srcEvt.queryStringParameters,
-            headers: srcEvt.headers,
-            body: srcEvt.body,
-            isBase64Encoded: srcEvt.isBase64Encoded,
-            multiValueHeaders: null,
-            multiValueQueryStringParameters: null,
-            pathParameters: srcEvt.pathParameters,
-            stageVariables: srcEvt.stageVariables,
-            resource: null,
-        };
-        return rval;
-    }
-    static apiGatewayV2RequestContextToApiGatewayV1RequestContext(srcEvt) {
-        const rval = {
-            accountId: srcEvt.accountId,
-            apiId: srcEvt.apiId,
-            authorizer: null,
-            domainName: srcEvt.domainName,
-            domainPrefix: srcEvt.domainPrefix,
-            requestId: srcEvt.requestId,
-            routeKey: srcEvt.routeKey,
-            stage: srcEvt.stage,
-            requestTime: srcEvt.time,
-            requestTimeEpoch: srcEvt.timeEpoch,
-            protocol: srcEvt.http.protocol,
-            httpMethod: srcEvt.http.method,
-            identity: null,
-            path: srcEvt.http.path,
-            resourceId: null,
-            resourcePath: null,
-        };
-        return rval;
-    }
-    static findInMap(toFind, map) {
-        let rval = null;
-        map.forEach((val, key) => {
-            if (AwsUtil.matchExact(key, toFind)) {
-                rval = val;
-            }
-        });
-        return rval;
-    }
-    static matchExact(r, str) {
-        const match = str.match(r);
-        return match != null && str == match[0];
-    }
-    static resolvePotentialFunctionToResult(src, def) {
-        let rval = def;
-        if (src) {
-            if (typeof src === 'function') {
-                rval = src();
-            }
-            else {
-                rval = src;
-            }
-        }
-        return rval;
-    }
-}

package/lib/util/context-util.js

@@ -1,101 +0,0 @@
-import { StringRatchet } from '@bitblit/ratchet-common/lib/lang/string-ratchet.js';
-import { ErrorRatchet } from '@bitblit/ratchet-common/lib/lang/error-ratchet.js';
-import { NumberRatchet } from '@bitblit/ratchet-common/lib/lang/number-ratchet.js';
-import { BuiltInTraceIdGenerators } from '../built-in/built-in-trace-id-generators.js';
-export class ContextUtil {
-    static CURRENT_EPSILON_REFERENCE;
-    static CURRENT_CONTEXT;
-    static CURRENT_EVENT;
-    static CURRENT_LOG_VARS = {};
-    static CURRENT_PROCESS_LABEL;
-    static CURRENT_OVERRIDE_TRACE_ID;
-    static CURRENT_OVERRIDE_TRACE_DEPTH;
-    constructor() { }
-    static initContext(epsilon, evt, ctx, processLabel) {
-        ContextUtil.CURRENT_EPSILON_REFERENCE = epsilon;
-        ContextUtil.CURRENT_CONTEXT = ctx;
-        ContextUtil.CURRENT_EVENT = evt;
-        ContextUtil.CURRENT_LOG_VARS = {};
-        ContextUtil.CURRENT_PROCESS_LABEL = processLabel;
-    }
-    static clearContext() {
-        ContextUtil.CURRENT_EPSILON_REFERENCE = null;
-        ContextUtil.CURRENT_CONTEXT = null;
-        ContextUtil.CURRENT_EVENT = null;
-        ContextUtil.CURRENT_LOG_VARS = {};
-        ContextUtil.CURRENT_PROCESS_LABEL = null;
-        ContextUtil.CURRENT_OVERRIDE_TRACE_ID = null;
-        ContextUtil.CURRENT_OVERRIDE_TRACE_DEPTH = null;
-    }
-    static setOverrideTrace(traceId, traceDepth) {
-        ContextUtil.CURRENT_OVERRIDE_TRACE_ID = traceId || ContextUtil.CURRENT_OVERRIDE_TRACE_ID;
-        ContextUtil.CURRENT_OVERRIDE_TRACE_DEPTH = traceDepth || ContextUtil.CURRENT_OVERRIDE_TRACE_DEPTH;
-    }
-    static setOverrideTraceFromInternalBackgroundEntry(entry) {
-        ContextUtil.setOverrideTrace(entry.traceId, entry.traceDepth);
-    }
-    static setOverrideTraceFromInterApiEntry(interApiEntry) {
-        ContextUtil.setOverrideTrace(interApiEntry.traceId, interApiEntry.traceDepth);
-    }
-    static addHeadersToRecord(input, depthOffset = 0) {
-        if (input) {
-            input[ContextUtil.traceHeaderName()] = ContextUtil.currentTraceId();
-            input[ContextUtil.traceDepthHeaderName()] = StringRatchet.safeString(ContextUtil.currentTraceDepth() + depthOffset);
-        }
-        else {
-            ErrorRatchet.throwFormattedErr('Cannot add headers to null/undefined input');
-        }
-    }
-    static addTraceToProxyResult(pr) {
-        pr.headers = pr.headers || {};
-        ContextUtil.addHeadersToRecord(pr.headers);
-    }
-    static addTraceToHttpRequestInit(ri) {
-        ri.headers = ri.headers || {};
-        ContextUtil.addHeadersToRecord(ri.headers, 1);
-    }
-    static setProcessLabel(processLabel) {
-        ContextUtil.CURRENT_PROCESS_LABEL = processLabel;
-    }
-    static currentRequestId() {
-        const ctx = ContextUtil.CURRENT_CONTEXT;
-        return ctx ? ctx.awsRequestId : null;
-    }
-    static remainingTimeMS() {
-        const ctx = ContextUtil.CURRENT_CONTEXT;
-        return ctx ? ctx.getRemainingTimeInMillis() : null;
-    }
-    static currentProcessLabel() {
-        return ContextUtil.CURRENT_PROCESS_LABEL || 'unset';
-    }
-    static traceHeaderName() {
-        const headerName = ContextUtil?.CURRENT_EPSILON_REFERENCE?.config?.loggerConfig?.traceHeaderName || 'X-TRACE-ID';
-        return headerName;
-    }
-    static traceDepthHeaderName() {
-        const headerName = ContextUtil?.CURRENT_EPSILON_REFERENCE?.config?.loggerConfig?.traceDepthHeaderName || 'X-TRACE-DEPTH';
-        return headerName;
-    }
-    static currentTraceId() {
-        const traceFn = ContextUtil?.CURRENT_EPSILON_REFERENCE?.config?.loggerConfig?.traceIdGenerator || BuiltInTraceIdGenerators.fullAwsRequestId;
-        const traceId = ContextUtil.CURRENT_OVERRIDE_TRACE_ID ||
-            ContextUtil.CURRENT_EVENT?.headers?.[ContextUtil.traceHeaderName()] ||
-            traceFn(ContextUtil.CURRENT_EVENT, ContextUtil.CURRENT_CONTEXT);
-        return traceId;
-    }
-    static currentTraceDepth() {
-        const caller = ContextUtil.CURRENT_OVERRIDE_TRACE_DEPTH ||
-            NumberRatchet.safeNumber(ContextUtil.CURRENT_EVENT?.headers?.[ContextUtil.traceDepthHeaderName()]) ||
-            1;
-        return caller;
-    }
-    static addLogVariable(name, val) {
-        ContextUtil.CURRENT_LOG_VARS[name] = val;
-    }
-    static fetchLogVariable(name) {
-        return ContextUtil.CURRENT_LOG_VARS?.[name];
-    }
-    static fetchLogVariables() {
-        return Object.assign({}, ContextUtil.CURRENT_LOG_VARS || {});
-    }
-}

package/lib/util/cron-util.js

@@ -1,68 +0,0 @@
-import { RequireRatchet } from '@bitblit/ratchet-common/lib/lang/require-ratchet.js';
-import { StringRatchet } from '@bitblit/ratchet-common/lib/lang/string-ratchet.js';
-import { ErrorRatchet } from '@bitblit/ratchet-common/lib/lang/error-ratchet.js';
-import { DateTime } from 'luxon';
-export class CronUtil {
-    static everyNMinuteFilter(n) {
-        return CronUtil.everyNElementFilter(n, 60);
-    }
-    static everyNDaysOfYearFilter(n) {
-        return CronUtil.everyNElementFilter(n, 365);
-    }
-    static everyNElementFilter(n, m) {
-        RequireRatchet.notNullOrUndefined(n);
-        RequireRatchet.notNullOrUndefined(m);
-        const half = Math.floor(m / 2);
-        if (!n || n < 2 || n > half || m % n !== 0) {
-            ErrorRatchet.throwFormattedErr('Invalid config - this function only makes sense for 2 < N < %d and %d evenly divisible by N', half, m);
-            throw new Error('Invalid config - this function only makes sense for 2 < N < 31 and 60 evenly divisible by N');
-        }
-        const rval = [];
-        for (let i = 0; i < 60; i += n) {
-            rval.push(i);
-        }
-        return rval;
-    }
-    static numberMatchesFilter(num, filter) {
-        return !filter || filter.length === 0 || filter.includes(num);
-    }
-    static eventMatchesEntry(event, entry, cfg, testTimeEpochMS = new Date().getTime()) {
-        let rval = false;
-        if (!!event && !!entry && !!cfg.timezone) {
-            if (!!event.resources && event.resources.length > 0) {
-                const eventSourceName = event.resources[0];
-                const targetTZ = StringRatchet.trimToNull(entry.overrideTimezone) || cfg.timezone;
-                const nowInTZ = DateTime.fromMillis(testTimeEpochMS).setZone(targetTZ);
-                rval = !entry.eventFilter || entry.eventFilter.test(eventSourceName);
-                rval = rval && CronUtil.numberMatchesFilter(nowInTZ.minute, entry.minuteFilter);
-                rval = rval && CronUtil.numberMatchesFilter(nowInTZ.hour, entry.hourFilter);
-                rval = rval && CronUtil.numberMatchesFilter(nowInTZ.weekday, entry.dayOfWeekFilter);
-                rval = rval && CronUtil.numberMatchesFilter(nowInTZ.day, entry.dayOfMonthFilter);
-                rval = rval && CronUtil.numberMatchesFilter(nowInTZ.month, entry.monthOfYearFilter);
-                rval = rval && (!entry.contextMatchFilter || entry.contextMatchFilter.test(StringRatchet.trimToEmpty(cfg.context)));
-                rval = rval && (!entry.contextNoMatchFilter || !entry.contextNoMatchFilter.test(StringRatchet.trimToEmpty(cfg.context)));
-            }
-        }
-        return rval;
-    }
-    static cronEntryName(entry, idx = null) {
-        RequireRatchet.notNullOrUndefined(entry);
-        let rval = null;
-        if (!!entry) {
-            rval = entry.name;
-            rval = rval || entry['backgroundTaskType'];
-            if (!rval && !!entry['directHandler']) {
-                if (!!idx) {
-                    rval = 'Direct Entry ' + idx;
-                }
-                else {
-                    rval = 'Direct Entry (No idx specified)';
-                }
-            }
-        }
-        else {
-            rval = 'ERROR: no entry passed';
-        }
-        return rval;
-    }
-}

package/lib/util/cron-util.spec.js

@@ -1,124 +0,0 @@
-import fs from 'fs';
-import path from 'path';
-import { CronUtil } from './cron-util.js';
-import { EsmRatchet } from '@bitblit/ratchet-common/lib/lang/esm-ratchet.js';
-describe('#cronUtil', function () {
-    it('should test matching event to entry', async () => {
-        const sEvent = JSON.parse(fs
-            .readFileSync(path.join(EsmRatchet.fetchDirName(import.meta.url), '../../../../test-data/epsilon/sample-json/sample-schedule-event-1.json'))
-            .toString());
-        const cfg = {
-            context: 'prod',
-            timezone: 'America/Los_Angeles',
-            entries: [],
-        };
-        const cron1 = {
-            contextMatchFilter: new RegExp('prod'),
-        };
-        const match1 = CronUtil.eventMatchesEntry(sEvent, cron1, cfg);
-        expect(match1).toBeTruthy();
-        const cron2 = {
-            contextMatchFilter: new RegExp('dev'),
-        };
-        const match2 = CronUtil.eventMatchesEntry(sEvent, cron2, cfg);
-        expect(match2).toBeFalsy();
-        const cron3 = {
-            eventFilter: new RegExp('.*MyScheduledRule.*'),
-        };
-        const match3 = CronUtil.eventMatchesEntry(sEvent, cron3, cfg);
-        expect(match3).toBeTruthy();
-        const cron4 = {
-            eventFilter: new RegExp('.*NotMyRule.*'),
-        };
-        const match4 = CronUtil.eventMatchesEntry(sEvent, cron4, cfg);
-        expect(match4).toBeFalsy();
-    });
-    it('should match times', async () => {
-        const sEvent = JSON.parse(fs
-            .readFileSync(path.join(EsmRatchet.fetchDirName(import.meta.url), '../../../../test-data/epsilon/sample-json/sample-schedule-event-1.json'))
-            .toString());
-        const cfg = {
-            context: 'prod',
-            timezone: 'America/Los_Angeles',
-            entries: [],
-        };
-        const entry1 = {};
-        const cron1 = {
-            contextMatchFilter: new RegExp('prod'),
-        };
-        const match1 = CronUtil.eventMatchesEntry(sEvent, cron1, cfg);
-        expect(match1).toBeTruthy();
-        const cron2 = {
-            contextMatchFilter: new RegExp('dev'),
-        };
-        const match2 = CronUtil.eventMatchesEntry(sEvent, cron2, cfg);
-        expect(match2).toBeFalsy();
-        const cron3 = {
-            eventFilter: new RegExp('.*MyScheduledRule.*'),
-        };
-        const match3 = CronUtil.eventMatchesEntry(sEvent, cron3, cfg);
-        expect(match3).toBeTruthy();
-        const cron4 = {
-            eventFilter: new RegExp('.*NotMyRule.*'),
-        };
-        const match4 = CronUtil.eventMatchesEntry(sEvent, cron4, cfg);
-        expect(match4).toBeFalsy();
-    });
-    it('should match time with override', async () => {
-        const sEvent = JSON.parse(fs
-            .readFileSync(path.join(EsmRatchet.fetchDirName(import.meta.url), '../../../../test-data/epsilon/sample-json/sample-schedule-event-1.json'))
-            .toString());
-        const cfg = {
-            context: 'prod',
-            timezone: 'America/Los_Angeles',
-            entries: [],
-        };
-        const entry1 = {};
-        const cron1 = {
-            hourFilter: [3],
-        };
-        const cron2 = {
-            overrideTimezone: 'etc/utc',
-            hourFilter: [3],
-        };
-        const testTimestampEpochMS = 1652931000000;
-        const match1 = CronUtil.eventMatchesEntry(sEvent, cron1, cfg, testTimestampEpochMS);
-        const match2 = CronUtil.eventMatchesEntry(sEvent, cron2, cfg, testTimestampEpochMS);
-        expect(match1).toBeFalsy();
-        expect(match2).toBeTruthy();
-    });
-    it('should match day of month filters', async () => {
-        const sEvent = JSON.parse(fs
-            .readFileSync(path.join(EsmRatchet.fetchDirName(import.meta.url), '../../../../test-data/epsilon/sample-json/sample-schedule-event-1.json'))
-            .toString());
-        const cfg = {
-            context: 'prod',
-            timezone: 'etc/utc',
-            entries: [],
-        };
-        const entry1 = {};
-        const testTimestampEpochMS = 1652931000000;
-        const dayOfMonth = {
-            dayOfMonthFilter: [19],
-        };
-        const matchDay = CronUtil.eventMatchesEntry(sEvent, dayOfMonth, cfg, testTimestampEpochMS);
-        expect(matchDay).toBeTruthy();
-    });
-    it('should match month of year filter', async () => {
-        const sEvent = JSON.parse(fs
-            .readFileSync(path.join(EsmRatchet.fetchDirName(import.meta.url), '../../../../test-data/epsilon/sample-json/sample-schedule-event-1.json'))
-            .toString());
-        const cfg = {
-            context: 'prod',
-            timezone: 'etc/utc',
-            entries: [],
-        };
-        const entry1 = {};
-        const testTimestampEpochMS = 1652931000000;
-        const monthOfYear = {
-            monthOfYearFilter: [5],
-        };
-        const matchMonth = CronUtil.eventMatchesEntry(sEvent, monthOfYear, cfg, testTimestampEpochMS);
-        expect(matchMonth).toBeTruthy();
-    });
-});

package/lib/util/epsilon-config-parser.js

@@ -1,65 +0,0 @@
-import { Logger } from '@bitblit/ratchet-common/lib/logger/logger.js';
-import { ErrorRatchet } from '@bitblit/ratchet-common/lib/lang/error-ratchet.js';
-import yaml from 'js-yaml';
-import { ModelValidator } from '@bitblit/ratchet-misc/lib/model-validator/model-validator.js';
-import { BackgroundHttpAdapterHandler } from '../background/background-http-adapter-handler.js';
-import { BackgroundHandler } from '../background/background-handler.js';
-import { RouterUtil } from '../http/route/router-util.js';
-import { WebHandler } from '../http/web-handler.js';
-import { MisconfiguredError } from '../http/error/misconfigured-error.js';
-import { EpsilonGlobalHandler } from '../epsilon-global-handler.js';
-export class EpsilonConfigParser {
-    constructor() { }
-    static epsilonConfigToEpsilonGlobalHandler(config, backgroundManager) {
-        return new EpsilonGlobalHandler(EpsilonConfigParser.epsilonConfigToEpsilonInstance(config, backgroundManager));
-    }
-    static epsilonConfigToEpsilonInstance(config, backgroundManager) {
-        this.validateGlobalConfig(config);
-        const label = config?.label || 'NO EPSILON CONFIG LABEL SET';
-        Logger.info('Creating epsilon : %s : BM : %j', label, backgroundManager);
-        const parsed = EpsilonConfigParser.parseOpenApiDocument(config.openApiYamlString);
-        const modelValidator = EpsilonConfigParser.openApiDocToValidator(parsed);
-        const backgroundHttpAdapter = new BackgroundHttpAdapterHandler(config.backgroundConfig, modelValidator, backgroundManager);
-        const backgroundHandler = config.backgroundConfig
-            ? new BackgroundHandler(config.backgroundConfig, backgroundManager, modelValidator)
-            : null;
-        const epsilonRouter = config.httpConfig
-            ? RouterUtil.openApiYamlToRouterConfig(config.httpConfig, parsed, modelValidator, backgroundHttpAdapter)
-            : null;
-        const webHandler = epsilonRouter ? new WebHandler(epsilonRouter) : null;
-        const inst = {
-            config: config,
-            parsedOpenApiDoc: parsed,
-            modelValidator: modelValidator,
-            webHandler: webHandler,
-            backgroundHandler: backgroundHandler,
-            backgroundManager: backgroundManager,
-        };
-        return inst;
-    }
-    static parseOpenApiDocument(yamlString) {
-        if (!yamlString) {
-            throw new MisconfiguredError('Cannot configure, missing either yaml or cfg');
-        }
-        const doc = yaml.load(yamlString);
-        return doc;
-    }
-    static openApiDocToValidator(doc) {
-        let rval = null;
-        if (doc?.components?.schemas) {
-            rval = ModelValidator.createFromParsedObject(doc.components.schemas);
-        }
-        return rval;
-    }
-    static validateGlobalConfig(config) {
-        if (!config) {
-            ErrorRatchet.throwFormattedErr('Config may not be null');
-        }
-        if (!config.openApiYamlString) {
-            ErrorRatchet.throwFormattedErr('Config must define an open api document');
-        }
-        if (!!config.cron && !config.cron.timezone) {
-            ErrorRatchet.throwFormattedErr('Cron is defined, but timezone is not set');
-        }
-    }
-}