@dotcom-tool-kit/serverless 1.0.0

package/lib/index.d.ts

@@ -0,0 +1,3 @@
+import ServerlessDeploy from './tasks/deploy';
+export declare const tasks: (typeof ServerlessDeploy)[];
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,gBAAgB,MAAM,gBAAgB,CAAA;AAI7C,eAAO,MAAM,KAAK,6BAAyD,CAAA"}

package/lib/index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.tasks = void 0;
+const tslib_1 = require("tslib");
+const deploy_1 = tslib_1.__importDefault(require("./tasks/deploy"));
+const provision_1 = tslib_1.__importDefault(require("./tasks/provision"));
+const run_1 = tslib_1.__importDefault(require("./tasks/run"));
+exports.tasks = [run_1.default, deploy_1.default, provision_1.default];

package/lib/tasks/deploy.d.ts

@@ -0,0 +1,7 @@
+import { Task } from '@dotcom-tool-kit/types';
+import { ServerlessSchema } from '@dotcom-tool-kit/types/lib/schema/serverless';
+export default class ServerlessDeploy extends Task<typeof ServerlessSchema> {
+    static description: string;
+    run(): Promise<void>;
+}
+//# sourceMappingURL=deploy.d.ts.map

package/lib/tasks/deploy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deploy.d.ts","sourceRoot":"","sources":["../../src/tasks/deploy.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,IAAI,EAAE,MAAM,wBAAwB,CAAA;AAC7C,OAAO,EAAE,gBAAgB,EAAE,MAAM,8CAA8C,CAAA;AAI/E,MAAM,CAAC,OAAO,OAAO,gBAAiB,SAAQ,IAAI,CAAC,OAAO,gBAAgB,CAAC;IACzE,MAAM,CAAC,WAAW,SAAmB;IAE/B,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC;CAsC3B"}

package/lib/tasks/deploy.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const error_1 = require("@dotcom-tool-kit/error");
+const logger_1 = require("@dotcom-tool-kit/logger");
+const types_1 = require("@dotcom-tool-kit/types");
+const vault_1 = require("@dotcom-tool-kit/vault");
+const child_process_1 = require("child_process");
+class ServerlessDeploy extends types_1.Task {
+    async run() {
+        const { useVault, configPath, buildNumVariable, regions } = this.options;
+        const buildNum = process.env[buildNumVariable];
+        if (buildNum === undefined) {
+            throw new error_1.ToolKitError(`the ${logger_1.styles.task('ServerlessDeploy')} task requires the ${logger_1.styles.code(`$${buildNumVariable}`)} environment variable to be defined`);
+        }
+        let vaultEnv = {};
+        if (useVault) {
+            const vault = new vault_1.VaultEnvVars(this.logger, {
+                environment: 'production'
+            });
+            vaultEnv = await vault.get();
+        }
+        regions.forEach((region) => {
+            this.logger.verbose('starting the child serverless process...');
+            const args = ['deploy', '--region', region, '--stage', 'prod'];
+            if (configPath) {
+                args.push('--config', configPath);
+            }
+            const child = (0, child_process_1.spawn)('serverless', args, {
+                env: {
+                    ...vaultEnv,
+                    ...process.env
+                }
+            });
+            (0, logger_1.hookFork)(this.logger, 'serverless', child);
+        });
+    }
+}
+exports.default = ServerlessDeploy;
+ServerlessDeploy.description = 'Deploys on AWS';

package/lib/tasks/provision.d.ts

@@ -0,0 +1,7 @@
+import { Task } from '@dotcom-tool-kit/types';
+import { ServerlessSchema } from '@dotcom-tool-kit/types/lib/schema/serverless';
+export default class ServerlessProvision extends Task<typeof ServerlessSchema> {
+    static description: string;
+    run(): Promise<void>;
+}
+//# sourceMappingURL=provision.d.ts.map

package/lib/tasks/provision.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"provision.d.ts","sourceRoot":"","sources":["../../src/tasks/provision.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,IAAI,EAAE,MAAM,wBAAwB,CAAA;AAC7C,OAAO,EAAE,gBAAgB,EAAE,MAAM,8CAA8C,CAAA;AAI/E,MAAM,CAAC,OAAO,OAAO,mBAAoB,SAAQ,IAAI,CAAC,OAAO,gBAAgB,CAAC;IAC5E,MAAM,CAAC,WAAW,SAA4B;IAExC,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC;CA4C3B"}

package/lib/tasks/provision.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const error_1 = require("@dotcom-tool-kit/error");
+const logger_1 = require("@dotcom-tool-kit/logger");
+const types_1 = require("@dotcom-tool-kit/types");
+const vault_1 = require("@dotcom-tool-kit/vault");
+const child_process_1 = require("child_process");
+class ServerlessProvision extends types_1.Task {
+    async run() {
+        const { useVault, configPath, buildNumVariable, systemCode, regions } = this.options;
+        const buildNum = process.env[buildNumVariable];
+        if (buildNum === undefined) {
+            throw new error_1.ToolKitError(`the ${logger_1.styles.task('ServerlessProvision')} task requires the ${logger_1.styles.code(`$${buildNumVariable}`)} environment variable to be defined`);
+        }
+        let vaultEnv = {};
+        if (useVault) {
+            const vault = new vault_1.VaultEnvVars(this.logger, {
+                environment: 'development'
+            });
+            vaultEnv = await vault.get();
+        }
+        this.logger.verbose('starting the child serverless process...');
+        const args = [
+            'deploy',
+            '--region',
+            regions[0],
+            '--stage',
+            `ci${buildNum}`,
+            '--aws-profile',
+            `CircleCI-role-${systemCode}`
+        ];
+        if (configPath) {
+            args.push('--config', './serverless.yml');
+        }
+        const child = (0, child_process_1.spawn)('serverless', args, {
+            env: {
+                ...vaultEnv,
+                ...process.env
+            }
+        });
+        (0, logger_1.hookFork)(this.logger, 'serverless', child);
+    }
+}
+exports.default = ServerlessProvision;
+ServerlessProvision.description = 'Provisions a job on AWS';

package/lib/tasks/run.d.ts

@@ -0,0 +1,7 @@
+import { Task } from '@dotcom-tool-kit/types';
+import { ServerlessSchema } from '@dotcom-tool-kit/types/lib/schema/serverless';
+export default class ServerlessRun extends Task<typeof ServerlessSchema> {
+    static description: string;
+    run(): Promise<void>;
+}
+//# sourceMappingURL=run.d.ts.map

package/lib/tasks/run.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"run.d.ts","sourceRoot":"","sources":["../../src/tasks/run.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,wBAAwB,CAAA;AAC7C,OAAO,EAAE,gBAAgB,EAAE,MAAM,8CAA8C,CAAA;AAO/E,MAAM,CAAC,OAAO,OAAO,aAAc,SAAQ,IAAI,CAAC,OAAO,gBAAgB,CAAC;IACtE,MAAM,CAAC,WAAW,SAAqC;IAEjD,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC;CA6C3B"}

package/lib/tasks/run.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const types_1 = require("@dotcom-tool-kit/types");
+const child_process_1 = require("child_process");
+const vault_1 = require("@dotcom-tool-kit/vault");
+const logger_1 = require("@dotcom-tool-kit/logger");
+const get_port_1 = tslib_1.__importDefault(require("get-port"));
+const wait_port_1 = tslib_1.__importDefault(require("wait-port"));
+class ServerlessRun extends types_1.Task {
+    async run() {
+        const { useVault, ports, configPath } = this.options;
+        let vaultEnv = {};
+        if (useVault) {
+            const vault = new vault_1.VaultEnvVars(this.logger, {
+                environment: 'development'
+            });
+            vaultEnv = await vault.get();
+        }
+        const port = Number(process.env.PORT) ||
+            (await (0, get_port_1.default)({
+                port: ports
+            }));
+        this.logger.verbose('starting the child serverless process...');
+        const args = ['offline', 'start', '--host', 'local.ft.com', '--httpPort', `${port}`];
+        if (configPath) {
+            args.push('--config', './serverless.yml');
+        }
+        const child = (0, child_process_1.spawn)('serverless', args, {
+            env: {
+                ...vaultEnv,
+                PORT: port.toString(),
+                ...process.env
+            }
+        });
+        (0, logger_1.hookFork)(this.logger, 'serverless', child);
+        const unhook = (0, logger_1.hookConsole)(this.logger, 'wait-port');
+        try {
+            await (0, wait_port_1.default)({
+                host: 'localhost',
+                port: port
+            });
+        }
+        finally {
+            unhook();
+        }
+    }
+}
+exports.default = ServerlessRun;
+ServerlessRun.description = 'Run serverless functions locally';

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@dotcom-tool-kit/serverless",
+  "version": "1.0.0",
+  "description": "a plugin to manage and deploy apps using AWS Serverless",
+  "main": "lib",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [],
+  "author": "FT.com Platforms Team <platforms-team.customer-products@ft.com>",
+  "license": "ISC",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/financial-times/dotcom-tool-kit.git",
+    "directory": "plugins/serverless"
+  },
+  "bugs": "https://github.com/financial-times/dotcom-tool-kit/issues",
+  "homepage": "https://github.com/financial-times/dotcom-tool-kit/tree/main/plugins/serverless",
+  "files": [
+    "/lib",
+    ".toolkitrc.yml"
+  ],
+  "peerDependencies": {
+    "dotcom-tool-kit": "^2.6.0",
+    "serverless-offline": "^12.0.4"
+  },
+  "dependencies": {
+    "@dotcom-tool-kit/error": "^2.0.1",
+    "@dotcom-tool-kit/state": "^2.0.1",
+    "@dotcom-tool-kit/types": "^2.10.0",
+    "@dotcom-tool-kit/vault": "^2.0.16",
+    "get-port": "^5.1.1",
+    "tslib": "^2.3.1",
+    "wait-port": "^0.2.9"
+  }
+}

package/readme.md

@@ -0,0 +1,40 @@
+# @dotcom-tool-kit/serverless
+
+Tool Kit plugin to manage Lambdas with [AWS serverless](https://www.serverless.com/framework/docs/getting-started/).
+
+This plugin will be installed as a dependency of the [backend-serverless-app](https://github.com/Financial-Times/dotcom-tool-kit/tree/main/plugins/backend-serverless-app) plugin, which we recommend using instead of installing this plugin directly. That plugin will install additional plugins that will be useful or most Customer Products projects at the FT.
+
+## Installation & usage
+
+With Tool Kit [already set up](https://github.com/financial-times/dotcom-tool-kit#installing-and-using-tool-kit), install this plugin as a dev dependency:
+
+```sh
+npm install --save-dev @dotcom-tool-kit/serverless
+```
+
+And add it to your repo's `.toolkitrc.yml`:
+
+```yml
+plugins:
+  - '@dotcom-tool-kit/serverless'
+```
+
+## Options
+
+| Key | Description | Default value |
+|-|-|-|
+| `awsAccountId` | [required] the ID of the AWS account you wish to deploy to (account IDs can be found at the [FT login page](https://awslogin.in.ft.com/)) | none |
+| `systemCode` | [required] the system code for your app | none |
+| `region` | [require] what AWS region you want to deploy to (usually `eu-west-1`) | none |
+| `configPath` | [optional] path to your serverless config file. If this is not provided aws defaults to `./serverless.yml` but [other config fomats are accepted](https://www.serverless.com/framework/docs/providers/aws/guide/intro#alternative-configuration-format)| |
+| `useVault` | option to run the application with environment variables from Vault | `true` |
+| `ports` | ports to try to bind to for this application | `[3001, 3002, 3003]` |
+| `buildNumVariable` | an environment variable used to get a unique ID to use in the provisioning stage | `CIRCLE_BUILD_NUM` |
+
+## Tasks
+
+| Task | Description | Default hooks |
+|-|-|-|
+| `ServerlessRun` | Run application with `serverless` | `run:local` |
+| `ServerlessProvision` | Deploy review app with `serverless` | `deploy:review` |
+| `ServerlessDeploy` | Deploy production app with `serverless` | `deploy:production` |