@bitblit/ratchet-aws 4.0.115-alpha → 4.0.119-alpha

package/lib/environment/ssm-environment-service-provider.js

@@ -1,59 +0,0 @@
-import { ErrorRatchet } from '@bitblit/ratchet-common/lib/lang/error-ratchet.js';
-import { Logger } from '@bitblit/ratchet-common/lib/logger/logger.js';
-import { RequireRatchet } from '@bitblit/ratchet-common/lib/lang/require-ratchet.js';
-import { StringRatchet } from '@bitblit/ratchet-common/lib/lang/string-ratchet.js';
-import { PromiseRatchet } from '@bitblit/ratchet-common/lib/lang/promise-ratchet.js';
-import { GetParameterCommand, SSMClient } from '@aws-sdk/client-ssm';
-export class SsmEnvironmentServiceProvider {
-    region;
-    ssmEncrypted;
-    ssm;
-    constructor(region = 'us-east-1', ssmEncrypted = true) {
-        this.region = region;
-        this.ssmEncrypted = ssmEncrypted;
-        RequireRatchet.notNullOrUndefined(region);
-        RequireRatchet.notNullOrUndefined(ssmEncrypted);
-        this.ssm = new SSMClient({ region: this.region });
-    }
-    async fetchConfig(name) {
-        Logger.silly('SsmEnvironmentServiceProvider fetch for %s', name);
-        const params = {
-            Name: name,
-            WithDecryption: this.ssmEncrypted,
-        };
-        let rval = null;
-        let toParse = null;
-        try {
-            const value = await this.ssm.send(new GetParameterCommand(params));
-            toParse = StringRatchet.trimToNull(value?.Parameter?.Value);
-        }
-        catch (err) {
-            const errCode = err['code'] || '';
-            if (errCode.toLowerCase().indexOf('throttlingexception') !== -1) {
-                Logger.warn('Throttled while trying to read parameters - waiting 1 second before allowing retry');
-                await PromiseRatchet.wait(1_000);
-            }
-            else if (errCode.toLowerCase().indexOf('parameternotfound') !== -1) {
-                const errMsg = Logger.warn('AWS could not find parameter %s - are you using the right AWS key?', name);
-                throw new Error(errMsg);
-            }
-            else {
-                Logger.error('Final environment fetch error (cannot retry) : %s', err, err);
-                throw err;
-            }
-        }
-        if (toParse) {
-            try {
-                rval = JSON.parse(toParse);
-            }
-            catch (err) {
-                Logger.error('Failed to read env - null or invalid JSON : %s : %s', err, toParse, err);
-                throw err;
-            }
-        }
-        else {
-            ErrorRatchet.throwFormattedErr('Could not find system parameter with name : %s in this account', name);
-        }
-        return rval;
-    }
-}

package/lib/expiring-code/dynamo-expiring-code-provider.js

@@ -1,24 +0,0 @@
-export class DynamoExpiringCodeProvider {
-    tableName;
-    dynamoRatchet;
-    constructor(tableName, dynamoRatchet) {
-        this.tableName = tableName;
-        this.dynamoRatchet = dynamoRatchet;
-    }
-    async checkCode(code, context, deleteOnMatch) {
-        const keys = { code: code, context: context };
-        const expCode = await this.dynamoRatchet.simpleGet(this.tableName, keys);
-        const rval = expCode && expCode.expiresEpochMS > Date.now();
-        if (rval && deleteOnMatch) {
-            await this.dynamoRatchet.simpleDelete(this.tableName, keys);
-        }
-        return rval;
-    }
-    async storeCode(code) {
-        const output = await this.dynamoRatchet.simplePut(this.tableName, code);
-        return output && output.ConsumedCapacity.CapacityUnits > 0;
-    }
-    async createTableIfMissing(dtr) {
-        return null;
-    }
-}

package/lib/expiring-code/expiring-code-params.js

@@ -1 +0,0 @@
-export {};

package/lib/expiring-code/expiring-code-provider.js

@@ -1 +0,0 @@
-export {};

package/lib/expiring-code/expiring-code-ratchet.js

@@ -1,34 +0,0 @@
-import { RequireRatchet } from '@bitblit/ratchet-common/lib/lang/require-ratchet.js';
-import { StringRatchet } from '@bitblit/ratchet-common/lib/lang/string-ratchet.js';
-export class ExpiringCodeRatchet {
-    provider;
-    constructor(provider) {
-        this.provider = provider;
-    }
-    static generateCode(params) {
-        RequireRatchet.notNullOrUndefined(params, 'params');
-        RequireRatchet.notNullOrUndefined(params.context, 'params.context');
-        RequireRatchet.notNullOrUndefined(params.length, 'params.length');
-        RequireRatchet.notNullOrUndefined(params.alphabet, 'params.alphabet');
-        let code = '';
-        for (let i = 0; i < params.length; i++) {
-            code += params.alphabet.charAt(Math.floor(params.alphabet.length * Math.random()));
-        }
-        const rval = {
-            code: code,
-            context: params.context,
-            tags: params.tags,
-            expiresEpochMS: Date.now() + params.timeToLiveSeconds * 1000,
-        };
-        return rval;
-    }
-    async createNewCode(params) {
-        const value = ExpiringCodeRatchet.generateCode(params);
-        const rval = await this.provider.storeCode(value);
-        return rval ? value : null;
-    }
-    async checkCode(code, context, deleteOnMatch) {
-        const rval = await this.provider.checkCode(StringRatchet.trimToEmpty(code), StringRatchet.trimToEmpty(context), deleteOnMatch);
-        return rval;
-    }
-}

package/lib/expiring-code/expiring-code-ratchet.spec.js

@@ -1,7 +0,0 @@
-import { ExpiringCodeRatchet } from './expiring-code-ratchet.js';
-describe('#ExpiringCodeRatchet', () => {
-    it('Should generate valid codes', async () => {
-        const output = ExpiringCodeRatchet.generateCode({ context: 'test', length: 5, timeToLiveSeconds: 10, alphabet: 'A' });
-        expect(output.code).toEqual('AAAAA');
-    });
-});

package/lib/expiring-code/expiring-code.js

@@ -1 +0,0 @@
-export {};

package/lib/expiring-code/s3-expiring-code-provider.js

@@ -1,48 +0,0 @@
-import { Logger } from '@bitblit/ratchet-common/lib/logger/logger.js';
-import { RequireRatchet } from '@bitblit/ratchet-common/lib/lang/require-ratchet.js';
-export class S3ExpiringCodeProvider {
-    s3CacheRatchet;
-    keyName;
-    constructor(s3CacheRatchet, keyName) {
-        this.s3CacheRatchet = s3CacheRatchet;
-        this.keyName = keyName;
-        RequireRatchet.notNullOrUndefined(s3CacheRatchet, 's3CacheRatchet');
-        RequireRatchet.notNullUndefinedOrOnlyWhitespaceString(s3CacheRatchet.getDefaultBucket(), 's3CacheRatchet.defaultBucket');
-        RequireRatchet.notNullUndefinedOrOnlyWhitespaceString(keyName, 'keyName');
-    }
-    async fetchFile() {
-        const rval = (await this.s3CacheRatchet.fetchCacheFileAsObject(this.keyName)) || {
-            data: [],
-            lastModifiedEpochMS: Date.now(),
-        };
-        return rval;
-    }
-    async updateFile(vals) {
-        const next = {
-            data: vals || [],
-            lastModifiedEpochMS: Date.now(),
-        };
-        next.data = next.data.filter((d) => d.expiresEpochMS > Date.now());
-        Logger.info('Updating code file to %s codes', next.data.length);
-        const rval = await this.s3CacheRatchet.writeObjectToCacheFile(this.keyName, next);
-        return rval;
-    }
-    async checkCode(code, context, deleteOnMatch) {
-        const val = await this.fetchFile();
-        const rval = val.data.find((d) => d?.code?.toUpperCase() === code?.toUpperCase() && d?.context?.toUpperCase() === context?.toUpperCase());
-        if (rval) {
-            if (deleteOnMatch || rval.expiresEpochMS < Date.now()) {
-                Logger.info('Stripping used/expired code from the database');
-                const newData = val.data.filter((d) => d != rval);
-                await this.updateFile(newData);
-            }
-        }
-        return !!rval && rval.expiresEpochMS > Date.now();
-    }
-    async storeCode(code) {
-        const old = await this.fetchFile();
-        old.data.push(code);
-        const wrote = await this.updateFile(old.data);
-        return !!wrote;
-    }
-}

package/lib/expiring-code/s3-expiring-code-provider.spec.js

@@ -1,46 +0,0 @@
-import { JestRatchet } from '@bitblit/ratchet-jest/lib/jest/jest-ratchet.js';
-import { S3ExpiringCodeProvider } from './s3-expiring-code-provider.js';
-import { jest } from '@jest/globals';
-let mockS3Ratchet;
-const testCode = { code: '12345', context: 'ctx', expiresEpochMS: Date.now() + 100_000, tags: ['tag1'] };
-const testCode2 = { code: '45678', context: 'ctx', expiresEpochMS: Date.now() + 100_000, tags: ['tag1'] };
-describe('#S3ExpiringCodeProvider', () => {
-    beforeEach(() => {
-        mockS3Ratchet = JestRatchet.mock(jest.fn);
-        mockS3Ratchet.getDefaultBucket.mockReturnValue('TEST-BUCKET');
-    });
-    it('Should fetch file', async () => {
-        const val = new S3ExpiringCodeProvider(mockS3Ratchet, 'test.json');
-        const output = await val.fetchFile();
-        expect(output).not.toBeFalsy();
-        expect(output.data).not.toBeFalsy();
-        expect(output.lastModifiedEpochMS).not.toBeFalsy();
-    });
-    it('Should update file', async () => {
-        const val = new S3ExpiringCodeProvider(mockS3Ratchet, 'test.json');
-        mockS3Ratchet.writeObjectToCacheFile.mockResolvedValue({});
-        const wrote = await val.updateFile([testCode]);
-        expect(wrote).not.toBeFalsy();
-    });
-    it('Should check code', async () => {
-        mockS3Ratchet.fetchCacheFileAsObject.mockResolvedValue({
-            data: [testCode],
-            lastModifiedEpochMS: 1234,
-        });
-        const val = new S3ExpiringCodeProvider(mockS3Ratchet, 'test.json');
-        const testValidCode = await val.checkCode('12345', 'ctx', false);
-        const testInvalidCode = await val.checkCode('09876', 'ctx', false);
-        expect(testValidCode).toBeTruthy();
-        expect(testInvalidCode).toBeFalsy();
-    });
-    it('Should store code', async () => {
-        mockS3Ratchet.fetchCacheFileAsObject.mockResolvedValue({
-            data: [testCode],
-            lastModifiedEpochMS: 1234,
-        });
-        mockS3Ratchet.writeObjectToCacheFile.mockResolvedValue({});
-        const val = new S3ExpiringCodeProvider(mockS3Ratchet, 'test.json');
-        const output = await val.storeCode(testCode2);
-        expect(output).toBeTruthy();
-    });
-});

package/lib/iam/aws-credentials-ratchet.js

@@ -1,18 +0,0 @@
-import { ErrorRatchet } from '@bitblit/ratchet-common/lib/lang/error-ratchet.js';
-import { StringRatchet } from '@bitblit/ratchet-common/lib/lang/string-ratchet.js';
-export class AwsCredentialsRatchet {
-    constructor() { }
-    static applySetProfileEnvironmentalVariable(newProfile) {
-        if (!!process.env) {
-            if (StringRatchet.trimToNull(newProfile)) {
-                process.env['AWS_PROFILE'] = newProfile;
-            }
-            else {
-                ErrorRatchet.throwFormattedErr('Cannot set profile to null/empty string');
-            }
-        }
-        else {
-            ErrorRatchet.throwFormattedErr('Cannot set profile - not in a node environment - process missing');
-        }
-    }
-}

package/lib/index.js

@@ -1 +0,0 @@
-export {};

package/lib/lambda/lambda-event-detector.js

@@ -1,38 +0,0 @@
-export class LambdaEventDetector {
-    static isValidCronEvent(event) {
-        return event && event.source == 'aws.events' && event.resources && event.resources.length > 0;
-    }
-    static isValidSnsEvent(event) {
-        return event && event.Records && event.Records.length > 0 && event.Records[0].EventSource == 'aws:sns';
-    }
-    static isValidDynamoDBEvent(event) {
-        return event && event.Records && event.Records.length > 0 && event.Records[0].eventSource == 'aws:dynamodb';
-    }
-    static isValidS3Event(event) {
-        return event && event.Records && event.Records.length > 0 && event.Records[0].eventSource == 'aws:s3';
-    }
-    static isValidApiGatewayV2WithRequestContextEvent(event) {
-        return event && event.rawPath && event.requestContext && event.routeKey;
-    }
-    static isValidApiGatewayEvent(event) {
-        return event && event.httpMethod && event.path && event.requestContext;
-    }
-    static isValidApiGatewayAuthorizerEvent(event) {
-        return event && event.authorizationToken && event.methodArn;
-    }
-    static isSingleCronEvent(event) {
-        return this.isValidCronEvent(event) && LambdaEventDetector.isSingleEntryEvent(event, 'resources');
-    }
-    static isSingleSnsEvent(event) {
-        return this.isValidSnsEvent(event) && LambdaEventDetector.isSingleEntryEvent(event);
-    }
-    static isSingleDynamoDBEvent(event) {
-        return this.isValidDynamoDBEvent(event) && LambdaEventDetector.isSingleEntryEvent(event);
-    }
-    static isSingleS3Event(event) {
-        return this.isValidS3Event(event) && LambdaEventDetector.isSingleEntryEvent(event);
-    }
-    static isSingleEntryEvent(event, entryName = 'Records') {
-        return event && event[entryName] && event[entryName] instanceof Array && event[entryName].length === 1;
-    }
-}

package/lib/lambda/lambda-event-type-guards.js

@@ -1,24 +0,0 @@
-import { LambdaEventDetector } from './lambda-event-detector.js';
-export class LambdaEventTypeGuards {
-    static isValidCronEvent(event) {
-        return LambdaEventDetector.isValidCronEvent(event);
-    }
-    static isValidSnsEvent(event) {
-        return LambdaEventDetector.isValidSnsEvent(event);
-    }
-    static isValidDynamoDBEvent(event) {
-        return LambdaEventDetector.isValidDynamoDBEvent(event);
-    }
-    static isValidS3Event(event) {
-        return LambdaEventDetector.isValidS3Event(event);
-    }
-    static isValidApiGatewayV2WithRequestContextEvent(event) {
-        return LambdaEventDetector.isValidApiGatewayV2WithRequestContextEvent(event);
-    }
-    static isValidApiGatewayEvent(event) {
-        return LambdaEventDetector.isValidApiGatewayEvent(event);
-    }
-    static isValidApiGatewayAuthorizerEvent(event) {
-        return LambdaEventDetector.isValidApiGatewayAuthorizerEvent(event);
-    }
-}

package/lib/model/cloud-watch-metrics-minute-level-dynamo-count-request.js

@@ -1 +0,0 @@
-export {};

package/lib/model/cloud-watch-metrics-unit.js

@@ -1,30 +0,0 @@
-export var CloudWatchMetricsUnit;
-(function (CloudWatchMetricsUnit) {
-    CloudWatchMetricsUnit["Seconds"] = "Seconds";
-    CloudWatchMetricsUnit["Microseconds"] = "Microseconds";
-    CloudWatchMetricsUnit["Milliseconds"] = "Milliseconds";
-    CloudWatchMetricsUnit["Bytes"] = "Bytes";
-    CloudWatchMetricsUnit["Kilobytes"] = "Kilobytes";
-    CloudWatchMetricsUnit["Megabytes"] = "Megabytes";
-    CloudWatchMetricsUnit["Gigabytes"] = "Gigabytes";
-    CloudWatchMetricsUnit["Terabytes"] = "Terabytes";
-    CloudWatchMetricsUnit["Bits"] = "Bits";
-    CloudWatchMetricsUnit["Kilobits"] = "Kilobits";
-    CloudWatchMetricsUnit["Megabits"] = "Megabits";
-    CloudWatchMetricsUnit["Gigabits"] = "Gigabits";
-    CloudWatchMetricsUnit["Terabits"] = "Terabits";
-    CloudWatchMetricsUnit["Percent"] = "Percent";
-    CloudWatchMetricsUnit["Count"] = "Count";
-    CloudWatchMetricsUnit["BytesPerSecond"] = "Bytes/Second";
-    CloudWatchMetricsUnit["KilobytesPerSecond"] = "Kilobytes/Second";
-    CloudWatchMetricsUnit["MegabytesPerSecond"] = "Megabytes/Second";
-    CloudWatchMetricsUnit["GigabytesPerSecond"] = "Gigabytes/Second";
-    CloudWatchMetricsUnit["TerabytesPerSecond"] = "Terabytes/Second";
-    CloudWatchMetricsUnit["BitsPerSecond"] = "Terabytes/Second";
-    CloudWatchMetricsUnit["KilobitsPerSecond"] = "Kilobits/Second";
-    CloudWatchMetricsUnit["MegabitsPerSecond"] = "Megabits/Second";
-    CloudWatchMetricsUnit["GigabitsPerSecond"] = "Gigabits/Second";
-    CloudWatchMetricsUnit["TerabitsPerSecond"] = "Terabits/Second";
-    CloudWatchMetricsUnit["CountPerSecond"] = "Count/Second";
-    CloudWatchMetricsUnit["None"] = "None";
-})(CloudWatchMetricsUnit || (CloudWatchMetricsUnit = {}));

package/lib/model/dynamo/doc-put-item-command-input.js

@@ -1 +0,0 @@
-export {};

package/lib/model/dynamo/doc-query-command-input.js

@@ -1 +0,0 @@
-export {};

package/lib/model/dynamo/doc-scan-command-input.js

@@ -1 +0,0 @@
-export {};

package/lib/model/dynamo/doc-update-item-command-input.js

@@ -1 +0,0 @@
-export {};

package/lib/model/dynamo-count-result.js

@@ -1 +0,0 @@
-export {};

package/lib/route53/route-53-ratchet.js

@@ -1,55 +0,0 @@
-import { Logger } from '@bitblit/ratchet-common/lib/logger/logger.js';
-import { ChangeResourceRecordSetsCommand, waitUntilResourceRecordSetsChanged, } from '@aws-sdk/client-route-53';
-import { WaiterState } from '@aws-sdk/util-waiter';
-export class Route53Ratchet {
-    route53;
-    hostedZoneId;
-    constructor(route53, hostedZoneId) {
-        this.route53 = route53;
-        this.hostedZoneId = hostedZoneId;
-        if (!this.route53) {
-            throw 'route53 may not be null';
-        }
-    }
-    async changeCnameRecordTarget(domainName, target, hostedZoneId = this.hostedZoneId, ttlSeconds = 600) {
-        Logger.info('Updating %s to point to %s', domainName, target);
-        try {
-            const params = {
-                ChangeBatch: {
-                    Changes: [
-                        {
-                            Action: 'UPSERT',
-                            ResourceRecordSet: {
-                                Name: domainName,
-                                ResourceRecords: [
-                                    {
-                                        Value: target,
-                                    },
-                                ],
-                                TTL: ttlSeconds,
-                                Type: 'CNAME',
-                            },
-                        },
-                    ],
-                },
-                HostedZoneId: hostedZoneId,
-            };
-            const result = await this.route53.send(new ChangeResourceRecordSetsCommand(params));
-            Logger.debug('Updated domain result: %j', result);
-            const waitParams = {
-                Id: result.ChangeInfo.Id,
-            };
-            const waitResult = await waitUntilResourceRecordSetsChanged({ client: this.route53, maxWaitTime: 300 }, waitParams);
-            Logger.debug('Wait responsed: %j', waitResult);
-            if (waitResult.state === WaiterState.SUCCESS) {
-                Logger.info('Updated %s to point to %s', domainName, hostedZoneId);
-                return true;
-            }
-        }
-        catch (err) {
-            Logger.warn('Error update CName for %s with value %s: %j', domainName, target, err);
-        }
-        Logger.info('Cannot update %s to point to %s', domainName, target);
-        return false;
-    }
-}

package/lib/runtime-parameter/cached-stored-runtime-parameter.js

@@ -1 +0,0 @@
-export {};

package/lib/runtime-parameter/dynamo-runtime-parameter-provider.js

@@ -1,36 +0,0 @@
-import { RequireRatchet } from '@bitblit/ratchet-common/lib/lang/require-ratchet.js';
-import { Logger } from '@bitblit/ratchet-common/lib/logger/logger.js';
-export class DynamoRuntimeParameterProvider {
-    dynamo;
-    tableName;
-    constructor(dynamo, tableName) {
-        this.dynamo = dynamo;
-        this.tableName = tableName;
-        RequireRatchet.notNullOrUndefined(this.dynamo);
-        RequireRatchet.notNullOrUndefined(this.tableName);
-    }
-    async readParameter(groupId, paramKey) {
-        Logger.silly('Reading %s / %s from underlying db', groupId, paramKey);
-        const req = {
-            groupId: groupId,
-            paramKey: paramKey,
-        };
-        const rval = await this.dynamo.simpleGet(this.tableName, req);
-        return rval;
-    }
-    async readAllParametersForGroup(groupId) {
-        const qry = {
-            TableName: this.tableName,
-            KeyConditionExpression: 'groupId = :groupId',
-            ExpressionAttributeValues: {
-                ':groupId': groupId,
-            },
-        };
-        const all = await this.dynamo.fullyExecuteQuery(qry);
-        return all;
-    }
-    async writeParameter(toStore) {
-        const rval = await this.dynamo.simplePut(this.tableName, toStore);
-        return !!rval;
-    }
-}

package/lib/runtime-parameter/dynamo-runtime-parameter-provider.spec.js

@@ -1,49 +0,0 @@
-import { DynamoRuntimeParameterProvider } from './dynamo-runtime-parameter-provider.js';
-import { JestRatchet } from '@bitblit/ratchet-jest/lib/jest/jest-ratchet.js';
-import { RuntimeParameterRatchet } from './runtime-parameter-ratchet.js';
-import { Logger } from '@bitblit/ratchet-common/lib/logger/logger.js';
-import { LoggerLevelName } from '@bitblit/ratchet-common/lib/logger/logger-level-name.js';
-import { PromiseRatchet } from '@bitblit/ratchet-common/lib/lang/promise-ratchet.js';
-import { jest } from '@jest/globals';
-let mockDynamoRatchet;
-const testEntry = { groupId: 'test', paramKey: 'test', paramValue: '15', ttlSeconds: 0.5 };
-const testEntry2 = { groupId: 'test', paramKey: 'test1', paramValue: '20', ttlSeconds: 0.5 };
-describe('#runtimeParameterRatchet', function () {
-    beforeEach(() => {
-        mockDynamoRatchet = JestRatchet.mock(jest.fn);
-    });
-    it('fetch and cache a runtime parameter', async () => {
-        Logger.setLevel(LoggerLevelName.silly);
-        const tableName = 'default-table';
-        mockDynamoRatchet.simpleGet.mockResolvedValue(testEntry);
-        mockDynamoRatchet.simplePut.mockResolvedValue({});
-        const drpp = new DynamoRuntimeParameterProvider(mockDynamoRatchet, tableName);
-        const rpr = new RuntimeParameterRatchet(drpp);
-        const stored = await rpr.storeParameter('test', 'test1', 15, 0.5);
-        Logger.info('Stored : %j', stored);
-        const cache1 = await rpr.fetchParameter('test', 'test1');
-        const cache1a = await rpr.fetchParameter('test', 'test1');
-        const cache1b = await rpr.fetchParameter('test', 'test1');
-        expect(cache1).toEqual(15);
-        expect(cache1a).toEqual(15);
-        expect(cache1b).toEqual(15);
-        await PromiseRatchet.wait(1000);
-        const cache2 = await rpr.fetchParameter('test', 'test1');
-        expect(cache2).toEqual(15);
-        mockDynamoRatchet.simpleGet.mockResolvedValue(null);
-        const cacheMiss = await rpr.fetchParameter('test', 'test-miss');
-        expect(cacheMiss).toBeNull();
-        const cacheDefault = await rpr.fetchParameter('test', 'test-miss', 27);
-        expect(cacheDefault).toEqual(27);
-    }, 30_000);
-    it('reads underlying entries', async () => {
-        Logger.setLevel(LoggerLevelName.silly);
-        const tableName = 'default-table';
-        mockDynamoRatchet.fullyExecuteQuery.mockResolvedValue([testEntry, testEntry2]);
-        const drpp = new DynamoRuntimeParameterProvider(mockDynamoRatchet, tableName);
-        const rpr = new RuntimeParameterRatchet(drpp);
-        const vals = await rpr.readUnderlyingEntries('test');
-        expect(vals).not.toBeFalsy();
-        expect(vals.length).toEqual(2);
-    }, 30_000);
-});

package/lib/runtime-parameter/global-variable-override-runtime-parameter-provider.js

@@ -1,51 +0,0 @@
-import { RequireRatchet } from '@bitblit/ratchet-common/lib/lang/require-ratchet.js';
-import { ErrorRatchet } from '@bitblit/ratchet-common/lib/lang/error-ratchet.js';
-import { StringRatchet } from '@bitblit/ratchet-common/lib/lang/string-ratchet.js';
-export class GlobalVariableOverrideRuntimeParameterProvider {
-    wrapped;
-    options = {
-        globalTTL: 1,
-        separator: '.',
-        prefix: 'RuntimeEnv-',
-        suffix: '',
-    };
-    constructor(wrapped, opts) {
-        this.wrapped = wrapped;
-        RequireRatchet.notNullOrUndefined(this.wrapped, 'wrapped');
-        RequireRatchet.notNullOrUndefined(global?.process?.env, '"process" not found - this only runs in Node, not the browser');
-        if (opts) {
-            this.options = opts;
-        }
-        RequireRatchet.notNullOrUndefined(this.options.globalTTL, 'this.options.globalTTL');
-        RequireRatchet.notNullOrUndefined(this.options.separator, 'this.options.separator');
-        RequireRatchet.true(this.options.globalTTL > 0, 'this.options.globalTTL must be larger than 0');
-    }
-    generateName(groupId, paramKey) {
-        return (StringRatchet.trimToEmpty(this.options.prefix) +
-            groupId +
-            StringRatchet.trimToEmpty(this.options.separator) +
-            paramKey +
-            StringRatchet.trimToEmpty(this.options.suffix));
-    }
-    async readParameter(groupId, paramKey) {
-        const asString = StringRatchet.trimToNull(process.env[this.generateName(groupId, paramKey)]);
-        if (asString && !StringRatchet.canParseAsJson(asString)) {
-            ErrorRatchet.throwFormattedErr('Cannot parse ENV override (%s / %s) as JSON - did you forget the quotes on a string?', groupId, paramKey);
-        }
-        const rval = asString
-            ? {
-                groupId: groupId,
-                paramKey: paramKey,
-                paramValue: asString,
-                ttlSeconds: this.options.globalTTL,
-            }
-            : await this.wrapped.readParameter(groupId, paramKey);
-        return rval;
-    }
-    async readAllParametersForGroup(groupId) {
-        return this.wrapped.readAllParametersForGroup(groupId);
-    }
-    async writeParameter(toStore) {
-        return this.wrapped.writeParameter(toStore);
-    }
-}

package/lib/runtime-parameter/global-variable-override-runtime-parameter-provider.spec.js

@@ -1,37 +0,0 @@
-import { DynamoRuntimeParameterProvider } from './dynamo-runtime-parameter-provider.js';
-import { JestRatchet } from '@bitblit/ratchet-jest/lib/jest/jest-ratchet.js';
-import { Logger } from '@bitblit/ratchet-common/lib/logger/logger.js';
-import { LoggerLevelName } from '@bitblit/ratchet-common/lib/logger/logger-level-name.js';
-import { RuntimeParameterRatchet } from './runtime-parameter-ratchet.js';
-import { GlobalVariableOverrideRuntimeParameterProvider } from './global-variable-override-runtime-parameter-provider.js';
-import { jest } from '@jest/globals';
-let mockDynamoRatchet;
-const testEntry = { groupId: 'test', paramKey: 'test', paramValue: '15', ttlSeconds: 0.5 };
-const testEntry2 = { groupId: 'test', paramKey: 'test1', paramValue: '"not-overridden"', ttlSeconds: 0.5 };
-describe('#globalVariableOverrideRuntimeParameterProvider', function () {
-    beforeEach(() => {
-        mockDynamoRatchet = JestRatchet.mock(jest.fn);
-    });
-    it('reads underlying entries', async () => {
-        Logger.setLevel(LoggerLevelName.silly);
-        mockDynamoRatchet.simpleGet.mockResolvedValue(testEntry2);
-        const drpp = new DynamoRuntimeParameterProvider(mockDynamoRatchet, 'test-table');
-        const er = new GlobalVariableOverrideRuntimeParameterProvider(drpp, {
-            globalTTL: 1,
-            separator: '.',
-            prefix: 'p-',
-            suffix: null,
-        });
-        process.env[er.generateName('test', 'test1')] = '"override"';
-        const rpr = new RuntimeParameterRatchet(er);
-        const root = await drpp.readParameter('test', 'test1');
-        const override = await er.readParameter('test', 'test1');
-        const fetched = await rpr.fetchParameter('test', 'test1');
-        expect(root).not.toBeNull();
-        expect(override).not.toBeNull();
-        expect(fetched).not.toBeNull();
-        expect(root.paramValue).toEqual('"not-overridden"');
-        expect(override.paramValue).toEqual('"override"');
-        expect(fetched).toEqual('override');
-    }, 30_000);
-});

package/lib/runtime-parameter/memory-runtime-parameter-provider.js

@@ -1,27 +0,0 @@
-import { Logger } from '@bitblit/ratchet-common/lib/logger/logger.js';
-export class MemoryRuntimeParameterProvider {
-    data;
-    constructor(data = Promise.resolve({})) {
-        this.data = data;
-    }
-    async readParameter(groupId, paramKey) {
-        Logger.silly('Reading %s / %s from underlying db', groupId, paramKey);
-        const d = await this.data;
-        return d[groupId + '::' + paramKey];
-    }
-    async readAllParametersForGroup(groupId) {
-        const d = await this.data;
-        const out = [];
-        Object.keys(d).forEach((k) => {
-            if (k.startsWith(groupId)) {
-                out.push(d[k]);
-            }
-        });
-        return out;
-    }
-    async writeParameter(toStore) {
-        const d = await this.data;
-        d[toStore.groupId + '::' + toStore.paramKey] = toStore;
-        return true;
-    }
-}

package/lib/runtime-parameter/runtime-parameter-provider.js

@@ -1 +0,0 @@
-export {};