@yopdev/dev-server 2.0.3 → 2.0.4

package/dist/src/cloudformation-dynamodb-table.d.ts

@@ -0,0 +1,13 @@
+import { Callback, Service } from './services';
+export declare const newDynamoDbTableFromCloudFormationTemplate: (name: string, config: DynamoDbTableCloudFormationConfig, callback?: Callback<string>) => Service<string>;
+type DynamoDbTableCloudFormationConfig = {
+    template: (name: string) => string;
+    resource: string;
+    tableName: (name: string) => string;
+    throughput: Throughput;
+};
+type Throughput = {
+    ReadCapacityUnits: number;
+    WriteCapacityUnits: number;
+};
+export {};

package/dist/src/cloudformation-dynamodb-table.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.newDynamoDbTableFromCloudFormationTemplate = void 0;
+const services_1 = require("./services");
+const client_dynamodb_1 = require("@aws-sdk/client-dynamodb");
+const js_yaml_cloudformation_schema_1 = require("js-yaml-cloudformation-schema");
+const js_yaml_1 = require("js-yaml");
+const fs_1 = require("fs");
+const logging_1 = require("@yopdev/logging");
+const dynamodb_1 = require("./dynamodb");
+const newDynamoDbTableFromCloudFormationTemplate = (name, config, callback) => new services_1.Service(new DynamoDbTableCloudFormation(name, config.template, config.resource, config.tableName, config.throughput), callback);
+exports.newDynamoDbTableFromCloudFormationTemplate = newDynamoDbTableFromCloudFormationTemplate;
+class DynamoDbTableCloudFormation {
+    constructor(name, template, resource, tableName, throughput) {
+        this.name = name;
+        this.template = template;
+        this.resource = resource;
+        this.throughput = throughput;
+        this.start = (config) => Promise.resolve(this.parseTableDefinition(this.template(this.name))
+            .then((definition) => definition[this.resource].Properties)
+            .then((resource) => this.createTableCommand(resource, this.throughput)
+            .then((command) => (0, dynamodb_1.newDynamoDbTable)(this.name, {
+            command: command,
+            ttlAttribute: resource.TimeToLiveSpecification?.AttributeName,
+        }))))
+            .tap(() => this.LOGGER.info('configured'))
+            .then((service) => service.start(config));
+        this.stop = () => Promise.resolve();
+        this.createTableCommand = async (definition, throughput) => new client_dynamodb_1.CreateTableCommand({
+            TableName: definition.TableName ?? this.tableName(this.name),
+            KeySchema: definition.KeySchema,
+            AttributeDefinitions: definition.AttributeDefinitions,
+            GlobalSecondaryIndexes: definition.GlobalSecondaryIndexes?.map((gsi) => ({
+                ...gsi,
+                ProvisionedThroughput: throughput,
+            })),
+            ProvisionedThroughput: throughput,
+        });
+        this.parseTableDefinition = async (path) => (0, js_yaml_1.load)((0, fs_1.readFileSync)(path).toString(), {
+            schema: js_yaml_cloudformation_schema_1.CLOUDFORMATION_SCHEMA,
+        }).Resources;
+        this.LOGGER = logging_1.LoggerFactory.create(`CFN:DYNAMO[${name}]`);
+        this.tableName = tableName ? tableName : (name) => { throw new Error(`table name not specified on ${name}`); };
+    }
+}

package/dist/src/dynamodb.d.ts

@@ -3,9 +3,14 @@ import { AwsConfig } from "./config";
 import { Service, Callback } from "./services";
 export declare const newDynamoDbTable: (name: string, config: {
     command: CreateTableCommand;
+    ttlAttribute?: string;
 }, callback?: Callback<string>) => Service<string>;
 export declare class DynamoDb {
     readonly client: DynamoDBClient;
     constructor(config: AwsConfig);
-    createTable: (factory: CreateTableCommand) => Promise<import("@aws-sdk/client-dynamodb").CreateTableCommandOutput>;
+    createTable: (factory: CreateTableCommand) => Promise<import("@aws-sdk/client-dynamodb").CreateTableCommandOutput | {
+        TableDescription: {
+            TableName: string;
+        };
+    }>;
 }

package/dist/src/dynamodb.js

@@ -5,15 +5,27 @@ const client_dynamodb_1 = require("@aws-sdk/client-dynamodb");
 const logging_1 = require("@yopdev/logging");
 const services_1 = require("./services");
 const assert_1 = require("./assert");
-const newDynamoDbTable = (name, config, callback) => new services_1.Service(new DynamoDbTableCreator(name, config.command), callback);
+const newDynamoDbTable = (name, config, callback) => new services_1.Service(new DynamoDbTableCreator(name, config.command, config.ttlAttribute), callback);
 exports.newDynamoDbTable = newDynamoDbTable;
 class DynamoDbTableCreator {
-    constructor(name, command) {
+    constructor(name, command, ttlAttribute) {
         this.name = name;
         this.command = command;
+        this.ttlAttribute = ttlAttribute;
         this.start = async (config) => config.dynamo.createTable(this.command)
             .tap((output) => this.LOGGER.debug(output))
+            .then(() => this.ttlAttribute)
+            .then((ttl) => ttl !== undefined ? this.setupTimeToLive(config.dynamo, ttl) : Promise.resolve())
             .then(() => this.name);
+        this.setupTimeToLive = async (dynamodb, attributeName) => dynamodb.client.send(new client_dynamodb_1.UpdateTimeToLiveCommand({
+            TableName: this.command.input.TableName,
+            TimeToLiveSpecification: {
+                Enabled: true,
+                AttributeName: attributeName,
+            }
+        }))
+            .tap((out) => this.LOGGER.info('set ttl attribute %s? %s', attributeName, out.$metadata.httpStatusCode === 200))
+            .then(() => undefined);
         this.stop = () => Promise.resolve();
         this.LOGGER = logging_1.LoggerFactory.create(`TABLE[${name}]`);
     }
@@ -28,6 +40,7 @@ class DynamoDb {
             LOGGER.error('failed to create table');
             if (reason.name !== 'ResourceInUseException')
                 return Promise.reject(reason);
+            return { TableDescription: { TableName: factory.input.TableName } };
         });
         this.client = new client_dynamodb_1.DynamoDBClient(config);
     }

package/dist/src/index.d.ts

@@ -3,6 +3,7 @@ export { newHttpServer as httpServer, HttpSettings } from './http-server';
 export { newLambdaHttpProxy as lambdaHttpProxy, UNAUTHORIZED } from './lambda-http-proxy';
 export { v1 as v1LambdaProxyPayload, v2 as v2LambdaProxyPayload } from './mappers';
 export { newLambdaProxyFromCloudFormationTemplate as cloudFormationLambdaProxy } from './cloudformation-lambda-http-proxy';
+export { newDynamoDbTableFromCloudFormationTemplate as cloudFormationDynamoDbTable } from './cloudformation-dynamodb-table';
 export { newSnsHttpProxy as snsHttpProxy } from './sns-http-proxy';
 export { newInternalQueue as internalQueue } from './internal-queue';
 export { newEventsProxy as eventsProxy } from './event-proxy';

package/dist/src/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Service = exports.promised = exports.lazy = exports.oneThenOther = exports.allOf = exports.tunnel = exports.container = exports.dynamoDbTable = exports.preTrafficHooks = exports.scheduledTasks = exports.cloudFormationSnsEventHandlers = exports.eventsProxy = exports.internalQueue = exports.snsHttpProxy = exports.cloudFormationLambdaProxy = exports.v2LambdaProxyPayload = exports.v1LambdaProxyPayload = exports.UNAUTHORIZED = exports.lambdaHttpProxy = exports.httpServer = exports.DevServer = void 0;
+exports.Service = exports.promised = exports.lazy = exports.oneThenOther = exports.allOf = exports.tunnel = exports.container = exports.dynamoDbTable = exports.preTrafficHooks = exports.scheduledTasks = exports.cloudFormationSnsEventHandlers = exports.eventsProxy = exports.internalQueue = exports.snsHttpProxy = exports.cloudFormationDynamoDbTable = exports.cloudFormationLambdaProxy = exports.v2LambdaProxyPayload = exports.v1LambdaProxyPayload = exports.UNAUTHORIZED = exports.lambdaHttpProxy = exports.httpServer = exports.DevServer = void 0;
 var dev_server_1 = require("./dev-server");
 Object.defineProperty(exports, "DevServer", { enumerable: true, get: function () { return dev_server_1.DevServer; } });
 var http_server_1 = require("./http-server");
@@ -13,6 +13,8 @@ Object.defineProperty(exports, "v1LambdaProxyPayload", { enumerable: true, get:
 Object.defineProperty(exports, "v2LambdaProxyPayload", { enumerable: true, get: function () { return mappers_1.v2; } });
 var cloudformation_lambda_http_proxy_1 = require("./cloudformation-lambda-http-proxy");
 Object.defineProperty(exports, "cloudFormationLambdaProxy", { enumerable: true, get: function () { return cloudformation_lambda_http_proxy_1.newLambdaProxyFromCloudFormationTemplate; } });
+var cloudformation_dynamodb_table_1 = require("./cloudformation-dynamodb-table");
+Object.defineProperty(exports, "cloudFormationDynamoDbTable", { enumerable: true, get: function () { return cloudformation_dynamodb_table_1.newDynamoDbTableFromCloudFormationTemplate; } });
 var sns_http_proxy_1 = require("./sns-http-proxy");
 Object.defineProperty(exports, "snsHttpProxy", { enumerable: true, get: function () { return sns_http_proxy_1.newSnsHttpProxy; } });
 var internal_queue_1 = require("./internal-queue");

package/dist/src/localstack.js

@@ -28,7 +28,10 @@ class LocalStack {
         const localStatePath = concreteConfig.localStateBindMount;
         const withLocalState = localStatePath !== undefined ?
             container
-                .withEnvironment({ PERSISTENCE: '1' })
+                .withEnvironment({
+                PERSISTENCE: '1',
+                DYNAMODB_REMOVE_EXPIRED_ITEMS: '1',
+            })
                 .withBindMounts([{
                     source: localStatePath,
                     target: '/var/lib/localstack',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yopdev/dev-server",
-  "version": "2.0.3",
+  "version": "2.0.4",
   "scripts": {
     "compile": "tsc",
     "pretest": "npm run compile",