@dotcom-tool-kit/serverless 4.0.1 → 4.0.2-beta.2

package/lib/schema.js

@@ -27,3 +27,4 @@ exports.default = z
     .passthrough()
     .refine(...movedPluginOptions('useVault', 'ServerlessRun', 'useDoppler'))
     .refine(...movedPluginOptions('ports', 'ServerlessRun'));
+//# sourceMappingURL=schema.js.map

package/lib/schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.js","sourceRoot":"","sources":["../src/schema.ts"],"names":[],"mappings":";;;AAAA,+CAAwB;AAExB,oDAAgD;AAEhD,MAAM,kBAAkB,GAAG,CACzB,MAAc,EACd,IAAY,EACZ,OAAO,GAAG,MAAM,EAChB,EAAE,CACF;IACE,CAAC,OAAU,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,IAAI,OAAO,CAAC;IACpC;QACE,OAAO,EAAE,cAAc,eAAM,CAAC,IAAI,CAAC,MAAM,CAAC,iBAAiB,eAAM,CAAC,IAAI,CACpE,iBAAiB,eAAM,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,OAAO,EAAE,CAChD,EAAE;KACJ;CACO,CAAA;AAEZ,kBAAe,CAAC;KACb,MAAM,CAAC;IACN,YAAY,EAAE,CAAC;SACZ,MAAM,EAAE;SACR,QAAQ,CACP,gIAAgI,CACjI;IACH,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,8BAA8B,CAAC;IAC/D,OAAO,EAAE,CAAC;SACP,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;SACjB,OAAO,CAAC,CAAC,WAAW,CAAC,CAAC;SACtB,QAAQ,CAAC,+CAA+C,CAAC;IAC5D,UAAU,EAAE,CAAC;SACV,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CACP,sPAAsP,CACvP;CACJ,CAAC;KACD,WAAW,EAAE;KACb,MAAM,CAAC,GAAG,kBAAkB,CAAC,UAAU,EAAE,eAAe,EAAE,YAAY,CAAC,CAAC;KACxE,MAAM,CAAC,GAAG,kBAAkB,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC,CAAA"}

package/lib/tasks/deploy.js

@@ -31,3 +31,4 @@ class ServerlessDeploy extends base_1.Task {
     }
 }
 exports.default = ServerlessDeploy;
+//# sourceMappingURL=deploy.js.map

package/lib/tasks/deploy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"deploy.js","sourceRoot":"","sources":["../../src/tasks/deploy.ts"],"names":[],"mappings":";;AAAA,oDAA8D;AAC9D,gDAA4D;AAC5D,iDAAqC;AAGrC,MAAqB,gBAAiB,SAAQ,WAAyC;IACrF,MAAM,CAAC,WAAW,GAAG,8BAA8B,CAAA;IAEnD,KAAK,CAAC,GAAG,CAAC,EAAE,GAAG,EAAkB;QAC/B,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,aAAa,CAAA;QAE9D,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;YAC7B,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,0CAA0C,CAAC,CAAA;YAC/D,MAAM,IAAI,GAAG;gBACX,QAAQ;gBACR,UAAU;gBACV,MAAM;gBACN,SAAS;gBACT,MAAM;gBACN,eAAe;gBACf,iBAAiB,UAAU,EAAE;aAC9B,CAAA;YACD,IAAI,UAAU,EAAE,CAAC;gBACf,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,UAAU,CAAC,CAAA;YACnC,CAAC;YAED,MAAM,KAAK,GAAG,IAAA,qBAAK,EAAC,YAAY,EAAE,IAAI,EAAE;gBACtC,GAAG,EAAE,OAAO,CAAC,GAAG;gBAChB,GAAG;aACJ,CAAC,CAAA;YAEF,IAAA,iBAAQ,EAAC,IAAI,CAAC,MAAM,EAAE,YAAY,EAAE,KAAK,CAAC,CAAA;YAC1C,MAAM,IAAA,mBAAU,EAAC,YAAY,EAAE,KAAK,CAAC,CAAA;QACvC,CAAC;IACH,CAAC;;AA7BH,mCA8BC"}

package/lib/tasks/provision.d.ts

@@ -6,4 +6,5 @@ export default class ServerlessProvision extends Task<{
     static description: string;
     run({ cwd }: TaskRunContext): Promise<void>;
 }
+export declare function stageName(ciBranch: string): string;
 //# sourceMappingURL=provision.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"provision.d.ts","sourceRoot":"","sources":["../../src/tasks/provision.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,IAAI,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAA;AAG5D,OAAO,KAAK,gBAAgB,MAAM,WAAW,CAAA;AAE7C,MAAM,CAAC,OAAO,OAAO,mBAAoB,SAAQ,IAAI,CAAC;IAAE,MAAM,EAAE,OAAO,gBAAgB,CAAA;CAAE,CAAC;IACxF,MAAM,CAAC,WAAW,SAA2C;IAEvD,GAAG,CAAC,EAAE,GAAG,EAAE,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;CAmDlD"}
+{"version":3,"file":"provision.d.ts","sourceRoot":"","sources":["../../src/tasks/provision.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,IAAI,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAA;AAG5D,OAAO,KAAK,gBAAgB,MAAM,WAAW,CAAA;AAG7C,MAAM,CAAC,OAAO,OAAO,mBAAoB,SAAQ,IAAI,CAAC;IAAE,MAAM,EAAE,OAAO,gBAAgB,CAAA;CAAE,CAAC;IACxF,MAAM,CAAC,WAAW,SAA2C;IAEvD,GAAG,CAAC,EAAE,GAAG,EAAE,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;CA8ClD;AAED,wBAAgB,SAAS,CAAC,QAAQ,EAAE,MAAM,UAEzC"}

package/lib/tasks/provision.js

@@ -1,10 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.stageName = stageName;
 const error_1 = require("@dotcom-tool-kit/error");
 const logger_1 = require("@dotcom-tool-kit/logger");
 const base_1 = require("@dotcom-tool-kit/base");
 const child_process_1 = require("child_process");
 const state_1 = require("@dotcom-tool-kit/state");
+const crypto_1 = require("crypto");
 class ServerlessProvision extends base_1.Task {
     static description = 'Provision a review serverless function';
     async run({ cwd }) {
@@ -13,19 +15,18 @@ class ServerlessProvision extends base_1.Task {
         if (!ciState) {
             throw new error_1.ToolKitError(`the ${logger_1.styles.task('ServerlessDeploy')} should be run in CI, but no CI state was found. check you have a plugin installed that initialises the CI state.`);
         }
-        const buildNum = ciState?.buildNumber;
-        if (!buildNum) {
-            const error = new error_1.ToolKitError(`the ${logger_1.styles.task('ServerlessDeploy')} requires a CI build number in the CI state.`);
-            error.details = `this is provided by plugins such as ${logger_1.styles.plugin('circleci')}, which populates it from the CIRCLE_BUILD_NUM environment variable.`;
+        const ciBranch = ciState?.branch;
+        if (!ciBranch) {
+            const error = new error_1.ToolKitError(`the ${logger_1.styles.task('ServerlessDeploy')} requires a CI branch in the CI state.`);
+            error.details = `this is provided by plugins such as ${logger_1.styles.plugin('circleci')}, which populates it from the CIRCLE_BRANCH environment variable.`;
         }
-        const stageName = `ci${buildNum}`;
         this.logger.verbose('starting the child serverless process...');
         const args = [
             'deploy',
             '--region',
             regions[0],
             '--stage',
-            stageName,
+            stageName(ciBranch),
             '--aws-profile',
             `CircleCI-role-${systemCode}`
         ];
@@ -38,9 +39,10 @@ class ServerlessProvision extends base_1.Task {
         });
         (0, logger_1.hookFork)(this.logger, 'serverless', child);
         await (0, logger_1.waitOnExit)('serverless', child);
-        (0, state_1.writeState)('review', {
-            stageName
-        });
     }
 }
 exports.default = ServerlessProvision;
+function stageName(ciBranch) {
+    return (0, crypto_1.createHash)('sha256').update(ciBranch).digest('hex').slice(0, 6);
+}
+//# sourceMappingURL=provision.js.map

package/lib/tasks/provision.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"provision.js","sourceRoot":"","sources":["../../src/tasks/provision.ts"],"names":[],"mappings":";;AA2DA,8BAEC;AA7DD,kDAAqD;AACrD,oDAAsE;AACtE,gDAA4D;AAC5D,iDAAqC;AACrC,kDAAkD;AAElD,mCAAmC;AAEnC,MAAqB,mBAAoB,SAAQ,WAAyC;IACxF,MAAM,CAAC,WAAW,GAAG,wCAAwC,CAAA;IAE7D,KAAK,CAAC,GAAG,CAAC,EAAE,GAAG,EAAkB;QAC/B,MAAM,EAAE,UAAU,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,aAAa,CAAA;QAC9D,MAAM,OAAO,GAAG,IAAA,iBAAS,EAAC,IAAI,CAAC,CAAA;QAE/B,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,MAAM,IAAI,oBAAY,CACpB,OAAO,eAAM,CAAC,IAAI,CAChB,kBAAkB,CACnB,mHAAmH,CACrH,CAAA;QACH,CAAC;QAED,MAAM,QAAQ,GAAG,OAAO,EAAE,MAAM,CAAA;QAEhC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,MAAM,KAAK,GAAG,IAAI,oBAAY,CAC5B,OAAO,eAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,wCAAwC,CAC/E,CAAA;YAED,KAAK,CAAC,OAAO,GAAG,uCAAuC,eAAM,CAAC,MAAM,CAClE,UAAU,CACX,mEAAmE,CAAA;QACtE,CAAC;QAED,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,0CAA0C,CAAC,CAAA;QAC/D,MAAM,IAAI,GAAG;YACX,QAAQ;YACR,UAAU;YACV,OAAO,CAAC,CAAC,CAAC;YACV,SAAS;YACT,SAAS,CAAC,QAAQ,CAAC;YACnB,eAAe;YACf,iBAAiB,UAAU,EAAE;SAC9B,CAAA;QACD,IAAI,UAAU,EAAE,CAAC;YACf,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,kBAAkB,CAAC,CAAA;QAC3C,CAAC;QAED,MAAM,KAAK,GAAG,IAAA,qBAAK,EAAC,YAAY,EAAE,IAAI,EAAE;YACtC,GAAG,EAAE,OAAO,CAAC,GAAG;YAChB,GAAG;SACJ,CAAC,CAAA;QAEF,IAAA,iBAAQ,EAAC,IAAI,CAAC,MAAM,EAAE,YAAY,EAAE,KAAK,CAAC,CAAA;QAC1C,MAAM,IAAA,mBAAU,EAAC,YAAY,EAAE,KAAK,CAAC,CAAA;IACvC,CAAC;;AAhDH,sCAiDC;AAED,SAAgB,SAAS,CAAC,QAAgB;IACxC,OAAO,IAAA,mBAAU,EAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;AACxE,CAAC"}

package/lib/tasks/run.js

@@ -70,3 +70,4 @@ class ServerlessRun extends base_1.Task {
     }
 }
 exports.default = ServerlessRun;
+//# sourceMappingURL=run.js.map

package/lib/tasks/run.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"run.js","sourceRoot":"","sources":["../../src/tasks/run.ts"],"names":[],"mappings":";;;;AAAA,gDAA4D;AAE5D,iDAAmD;AACnD,sDAAyD;AACzD,oDAA+D;AAC/D,gEAA8B;AAC9B,kEAAgC;AAChC,+CAAwB;AAExB,MAAM,mBAAmB,GAAG,CAAC;KAC1B,MAAM,CAAC;IACN,KAAK,EAAE,CAAC;SACL,MAAM,EAAE;SACR,KAAK,EAAE;SACP,OAAO,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;SAC3B,QAAQ,CAAC,8CAA8C,CAAC;IAC3D,UAAU,EAAE,CAAC;SACV,OAAO,EAAE;SACT,OAAO,CAAC,IAAI,CAAC;SACb,QAAQ,CAAC,6DAA6D,CAAC;CAC3E,CAAC;KACD,QAAQ,CAAC,kCAAkC,CAAC,CAAA;AACf,qCAAM;AAEtC,MAAqB,aAAc,SAAQ,WAGzC;IACA,KAAK,CAAe;IAEpB,KAAK,CAAC,GAAG,CAAC,EAAE,GAAG,EAAE,MAAM,EAAkB;QACvC,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC,OAAO,CAAA;QAC1C,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,aAAa,CAAA;QAEzC,IAAI,UAAU,GAAG,EAAE,CAAA;QAEnB,IAAI,UAAU,EAAE,CAAC;YACf,MAAM,OAAO,GAAG,IAAI,wBAAc,CAChC,IAAI,CAAC,MAAM,EACX,KAAK,EACL,MAAM,CAAC,aAAa,CAAC,0BAA0B,CAAC,EAAE,OAAO,CAC1D,CAAA;YAED,UAAU,GAAG,MAAM,OAAO,CAAC,GAAG,EAAE,CAAA;QAClC,CAAC;QAED,MAAM,IAAI,GACR,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC;YACxB,CAAC,MAAM,IAAA,kBAAO,EAAC;gBACb,IAAI,EAAE,KAAK;aACZ,CAAC,CAAC,CAAA;QAEL,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,0CAA0C,CAAC,CAAA;QAC/D,MAAM,IAAI,GAAG,CAAC,SAAS,EAAE,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,YAAY,EAAE,GAAG,IAAI,EAAE,CAAC,CAAA;QACpF,IAAI,UAAU,EAAE,CAAC;YACf,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,kBAAkB,CAAC,CAAA;QAC3C,CAAC;QAED,IAAI,CAAC,KAAK,GAAG,IAAA,qBAAK,EAAC,YAAY,EAAE,IAAI,EAAE;YACrC,GAAG,EAAE;gBACH,GAAG,UAAU;gBACb,IAAI,EAAE,IAAI,CAAC,QAAQ,EAAE;gBACrB,GAAG,OAAO,CAAC,GAAG;aACf;YACD,GAAG;SACJ,CAAC,CAAA;QAEF,IAAA,iBAAQ,EAAC,IAAI,CAAC,MAAM,EAAE,YAAY,EAAE,IAAI,CAAC,KAAK,CAAC,CAAA;QAE/C,MAAM,MAAM,GAAG,IAAA,oBAAW,EAAC,IAAI,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;QACpD,IAAI,CAAC;YACH,MAAM,IAAA,mBAAQ,EAAC;gBACb,IAAI,EAAE,WAAW;gBACjB,IAAI,EAAE,IAAI;aACX,CAAC,CAAA;QACJ,CAAC;gBAAS,CAAC;YACT,MAAM,EAAE,CAAA;QACV,CAAC;IACH,CAAC;IAED,KAAK,CAAC,IAAI;QACR,IAAI,IAAI,CAAC,KAAK,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,KAAK,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;YACvE,0EAA0E;YAC1E,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;QAC3B,CAAC;IACH,CAAC;CACF;AA9DD,gCA8DC"}

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

@@ -1 +1 @@
-{"version":3,"file":"teardown.d.ts","sourceRoot":"","sources":["../../src/tasks/teardown.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,IAAI,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAA;AAG5D,OAAO,KAAK,gBAAgB,MAAM,WAAW,CAAA;AAE7C,MAAM,CAAC,OAAO,OAAO,kBAAmB,SAAQ,IAAI,CAAC;IAAE,MAAM,EAAE,OAAO,gBAAgB,CAAA;CAAE,CAAC;IACvF,MAAM,CAAC,WAAW,SAA4C;IAExD,GAAG,CAAC,EAAE,GAAG,EAAE,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;CAmClD"}
+{"version":3,"file":"teardown.d.ts","sourceRoot":"","sources":["../../src/tasks/teardown.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,IAAI,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAA;AAG5D,OAAO,KAAK,gBAAgB,MAAM,WAAW,CAAA;AAG7C,MAAM,CAAC,OAAO,OAAO,kBAAmB,SAAQ,IAAI,CAAC;IAAE,MAAM,EAAE,OAAO,gBAAgB,CAAA;CAAE,CAAC;IACvF,MAAM,CAAC,WAAW,SAA4C;IAExD,GAAG,CAAC,EAAE,GAAG,EAAE,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;CAuClD"}

package/lib/tasks/teardown.js

@@ -1,25 +1,26 @@
 "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 base_1 = require("@dotcom-tool-kit/base");
 const state_1 = require("@dotcom-tool-kit/state");
 const child_process_1 = require("child_process");
+const provision_1 = require("./provision");
 class ServerlessTeardown extends base_1.Task {
     static description = 'Tear down existing serverless functions';
     async run({ cwd }) {
         const { configPath, regions, systemCode } = this.pluginOptions;
-        const reviewState = (0, state_1.readState)('review');
-        if (!reviewState || !reviewState.stageName) {
-            throw new error_1.ToolKitError(`Could not find state for review, check that ${logger_1.styles.hook('deploy:review')} ran successfully`);
+        const ciState = (0, state_1.readState)('ci');
+        if (!ciState || !ciState.branch) {
+            throw new Error(`Couldn't get CI state to generate the hashed branch name. Make sure this task is running in CI and you have a Tool Kit plugin that provides CI state, such as ${logger_1.styles.plugin('@dotcom-tool-kit/circleci')}, installed.`);
         }
+        const ciBranch = ciState.branch;
         this.logger.verbose('starting the child serverless process...');
         const args = [
             'remove',
             '--region',
             regions[0],
             '--stage',
-            reviewState.stageName,
+            (0, provision_1.stageName)(ciBranch),
             '--aws-profile',
             `CircleCI-role-${systemCode}`
         ];
@@ -35,3 +36,4 @@ class ServerlessTeardown extends base_1.Task {
     }
 }
 exports.default = ServerlessTeardown;
+//# sourceMappingURL=teardown.js.map

package/lib/tasks/teardown.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"teardown.js","sourceRoot":"","sources":["../../src/tasks/teardown.ts"],"names":[],"mappings":";;AAAA,oDAAsE;AACtE,gDAA4D;AAC5D,kDAAkD;AAClD,iDAAqC;AAErC,2CAAuC;AAEvC,MAAqB,kBAAmB,SAAQ,WAAyC;IACvF,MAAM,CAAC,WAAW,GAAG,yCAAyC,CAAA;IAE9D,KAAK,CAAC,GAAG,CAAC,EAAE,GAAG,EAAkB;QAC/B,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,aAAa,CAAA;QAE9D,MAAM,OAAO,GAAG,IAAA,iBAAS,EAAC,IAAI,CAAC,CAAA;QAE/B,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;YAChC,MAAM,IAAI,KAAK,CACb,iKAAiK,eAAM,CAAC,MAAM,CAC5K,2BAA2B,CAC5B,cAAc,CAChB,CAAA;QACH,CAAC;QAED,MAAM,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAA;QAE/B,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,0CAA0C,CAAC,CAAA;QAE/D,MAAM,IAAI,GAAG;YACX,QAAQ;YACR,UAAU;YACV,OAAO,CAAC,CAAC,CAAC;YACV,SAAS;YACT,IAAA,qBAAS,EAAC,QAAQ,CAAC;YACnB,eAAe;YACf,iBAAiB,UAAU,EAAE;SAC9B,CAAA;QACD,IAAI,UAAU,EAAE,CAAC;YACf,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,kBAAkB,CAAC,CAAA;QAC3C,CAAC;QAED,MAAM,KAAK,GAAG,IAAA,qBAAK,EAAC,YAAY,EAAE,IAAI,EAAE;YACtC,GAAG,EAAE,OAAO,CAAC,GAAG;YAChB,GAAG;SACJ,CAAC,CAAA;QAEF,IAAA,iBAAQ,EAAC,IAAI,CAAC,MAAM,EAAE,YAAY,EAAE,KAAK,CAAC,CAAA;QAE1C,MAAM,IAAA,mBAAU,EAAC,YAAY,EAAE,KAAK,CAAC,CAAA;IACvC,CAAC;;AAzCH,qCA0CC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dotcom-tool-kit/serverless",
-  "version": "4.0.1",
+  "version": "4.0.2-beta.2",
   "description": "a plugin to manage and deploy apps using AWS Serverless",
   "main": "lib",
   "scripts": {
@@ -18,6 +18,7 @@
   "homepage": "https://github.com/financial-times/dotcom-tool-kit/tree/main/plugins/serverless",
   "files": [
     "/lib",
+    "/src",
     ".toolkitrc.yml"
   ],
   "peerDependencies": {
@@ -38,4 +39,4 @@
   "engines": {
     "node": ">=20.x"
   }
-}
+}

package/src/schema.ts

@@ -0,0 +1,40 @@
+import * as z from 'zod'
+
+import { styles } from '@dotcom-tool-kit/logger'
+
+const movedPluginOptions = <T extends Record<string, unknown>>(
+  option: string,
+  task: string,
+  newName = option
+) =>
+  [
+    (options: T) => !(option in options),
+    {
+      message: `the option ${styles.code(option)} has moved to ${styles.code(
+        `options.tasks.${styles.task(task)}.${newName}`
+      )}`
+    }
+  ] as const
+
+export default z
+  .object({
+    awsAccountId: z
+      .string()
+      .describe(
+        '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/))'
+      ),
+    systemCode: z.string().describe('the system code for your app'),
+    regions: z
+      .array(z.string())
+      .default(['eu-west-1'])
+      .describe('an array of AWS regions you want to deploy to'),
+    configPath: z
+      .string()
+      .optional()
+      .describe(
+        'path to your serverless config file. If this is not provided, Serverless defaults to `./serverless.yml` but [other config fomats are accepted](https://www.serverless.com/framework/docs/providers/aws/guide/intro#alternative-configuration-format)'
+      )
+  })
+  .passthrough()
+  .refine(...movedPluginOptions('useVault', 'ServerlessRun', 'useDoppler'))
+  .refine(...movedPluginOptions('ports', 'ServerlessRun'))

package/src/tasks/deploy.ts

@@ -0,0 +1,36 @@
+import { hookFork, waitOnExit } from '@dotcom-tool-kit/logger'
+import { Task, TaskRunContext } from '@dotcom-tool-kit/base'
+import { spawn } from 'child_process'
+import type ServerlessSchema from '../schema'
+
+export default class ServerlessDeploy extends Task<{ plugin: typeof ServerlessSchema }> {
+  static description = 'Deploy a serverless function'
+
+  async run({ cwd }: TaskRunContext): Promise<void> {
+    const { configPath, regions, systemCode } = this.pluginOptions
+
+    for (const region of regions) {
+      this.logger.verbose('starting the child serverless process...')
+      const args = [
+        'deploy',
+        '--region',
+        region,
+        '--stage',
+        'prod',
+        '--aws-profile',
+        `CircleCI-role-${systemCode}`
+      ]
+      if (configPath) {
+        args.push('--config', configPath)
+      }
+
+      const child = spawn('serverless', args, {
+        env: process.env,
+        cwd
+      })
+
+      hookFork(this.logger, 'serverless', child)
+      await waitOnExit('serverless', child)
+    }
+  }
+}

package/src/tasks/provision.ts

@@ -0,0 +1,62 @@
+import { ToolKitError } from '@dotcom-tool-kit/error'
+import { hookFork, styles, waitOnExit } from '@dotcom-tool-kit/logger'
+import { Task, TaskRunContext } from '@dotcom-tool-kit/base'
+import { spawn } from 'child_process'
+import { readState } from '@dotcom-tool-kit/state'
+import type ServerlessSchema from '../schema'
+import { createHash } from 'crypto'
+
+export default class ServerlessProvision extends Task<{ plugin: typeof ServerlessSchema }> {
+  static description = 'Provision a review serverless function'
+
+  async run({ cwd }: TaskRunContext): Promise<void> {
+    const { configPath, systemCode, regions } = this.pluginOptions
+    const ciState = readState('ci')
+
+    if (!ciState) {
+      throw new ToolKitError(
+        `the ${styles.task(
+          'ServerlessDeploy'
+        )} should be run in CI, but no CI state was found. check you have a plugin installed that initialises the CI state.`
+      )
+    }
+
+    const ciBranch = ciState?.branch
+
+    if (!ciBranch) {
+      const error = new ToolKitError(
+        `the ${styles.task('ServerlessDeploy')} requires a CI branch in the CI state.`
+      )
+
+      error.details = `this is provided by plugins such as ${styles.plugin(
+        'circleci'
+      )}, which populates it from the CIRCLE_BRANCH environment variable.`
+    }
+
+    this.logger.verbose('starting the child serverless process...')
+    const args = [
+      'deploy',
+      '--region',
+      regions[0],
+      '--stage',
+      stageName(ciBranch),
+      '--aws-profile',
+      `CircleCI-role-${systemCode}`
+    ]
+    if (configPath) {
+      args.push('--config', './serverless.yml')
+    }
+
+    const child = spawn('serverless', args, {
+      env: process.env,
+      cwd
+    })
+
+    hookFork(this.logger, 'serverless', child)
+    await waitOnExit('serverless', child)
+  }
+}
+
+export function stageName(ciBranch: string) {
+  return createHash('sha256').update(ciBranch).digest('hex').slice(0, 6)
+}

package/src/tasks/run.ts

@@ -0,0 +1,87 @@
+import { Task, TaskRunContext } from '@dotcom-tool-kit/base'
+import type ServerlessSchema from '../schema'
+import { ChildProcess, spawn } from 'child_process'
+import { DopplerEnvVars } from '@dotcom-tool-kit/doppler'
+import { hookConsole, hookFork } from '@dotcom-tool-kit/logger'
+import getPort from 'get-port'
+import waitPort from 'wait-port'
+import * as z from 'zod'
+
+const ServerlessRunSchema = z
+  .object({
+    ports: z
+      .number()
+      .array()
+      .default([3001, 3002, 3003])
+      .describe('ports to try to bind to for this application'),
+    useDoppler: z
+      .boolean()
+      .default(true)
+      .describe('run the application with environment variables from Doppler')
+  })
+  .describe('Run serverless functions locally')
+export { ServerlessRunSchema as schema }
+
+export default class ServerlessRun extends Task<{
+  task: typeof ServerlessRunSchema
+  plugin: typeof ServerlessSchema
+}> {
+  child?: ChildProcess
+
+  async run({ cwd, config }: TaskRunContext): Promise<void> {
+    const { useDoppler, ports } = this.options
+    const { configPath } = this.pluginOptions
+
+    let dopplerEnv = {}
+
+    if (useDoppler) {
+      const doppler = new DopplerEnvVars(
+        this.logger,
+        'dev',
+        config.pluginOptions['@dotcom-tool-kit/doppler']?.options
+      )
+
+      dopplerEnv = await doppler.get()
+    }
+
+    const port =
+      Number(process.env.PORT) ||
+      (await getPort({
+        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')
+    }
+
+    this.child = spawn('serverless', args, {
+      env: {
+        ...dopplerEnv,
+        PORT: port.toString(),
+        ...process.env
+      },
+      cwd
+    })
+
+    hookFork(this.logger, 'serverless', this.child)
+
+    const unhook = hookConsole(this.logger, 'wait-port')
+    try {
+      await waitPort({
+        host: 'localhost',
+        port: port
+      })
+    } finally {
+      unhook()
+    }
+  }
+
+  async stop() {
+    if (this.child && (this.child.exitCode === null || !this.child.killed)) {
+      // SIGINT instead of SIGKILL so the process gets chance to exit gracefully
+      this.child.kill('SIGINT')
+    }
+  }
+}

package/src/tasks/teardown.ts

@@ -0,0 +1,50 @@
+import { hookFork, styles, waitOnExit } from '@dotcom-tool-kit/logger'
+import { Task, TaskRunContext } from '@dotcom-tool-kit/base'
+import { readState } from '@dotcom-tool-kit/state'
+import { spawn } from 'child_process'
+import type ServerlessSchema from '../schema'
+import { stageName } from './provision'
+
+export default class ServerlessTeardown extends Task<{ plugin: typeof ServerlessSchema }> {
+  static description = 'Tear down existing serverless functions'
+
+  async run({ cwd }: TaskRunContext): Promise<void> {
+    const { configPath, regions, systemCode } = this.pluginOptions
+
+    const ciState = readState('ci')
+
+    if (!ciState || !ciState.branch) {
+      throw new Error(
+        `Couldn't get CI state to generate the hashed branch name. Make sure this task is running in CI and you have a Tool Kit plugin that provides CI state, such as ${styles.plugin(
+          '@dotcom-tool-kit/circleci'
+        )}, installed.`
+      )
+    }
+
+    const ciBranch = ciState.branch
+
+    this.logger.verbose('starting the child serverless process...')
+
+    const args = [
+      'remove',
+      '--region',
+      regions[0],
+      '--stage',
+      stageName(ciBranch),
+      '--aws-profile',
+      `CircleCI-role-${systemCode}`
+    ]
+    if (configPath) {
+      args.push('--config', './serverless.yml')
+    }
+
+    const child = spawn('serverless', args, {
+      env: process.env,
+      cwd
+    })
+
+    hookFork(this.logger, 'serverless', child)
+
+    await waitOnExit('serverless', child)
+  }
+}