skuba 0.0.0-master-20230318044948

package/template/lambda-sqs-worker-cdk/infra/appStack.test.ts

@@ -0,0 +1,34 @@
+import { SynthUtils } from '@aws-cdk/assert';
+import { App } from 'aws-cdk-lib';
+
+import cdkJson from '../cdk.json';
+
+import { AppStack } from './appStack';
+
+const contexts = [
+  {
+    stage: 'dev',
+    ...cdkJson.context,
+  },
+
+  {
+    stage: 'prod',
+    ...cdkJson.context,
+  },
+];
+
+it.each(contexts)(
+  'returns expected CloudFormation stack for $stage',
+  (context) => {
+    const app = new App({ context });
+
+    const stack = new AppStack(app, 'appStack');
+
+    const json = JSON.stringify(SynthUtils.toCloudFormation(stack)).replace(
+      /"S3Key":"([0-9a-f]+)\.zip"/g,
+      (_, hash) => `"S3Key":"${'x'.repeat(hash.length)}.zip"`,
+    );
+
+    expect(JSON.parse(json)).toMatchSnapshot();
+  },
+);

package/template/lambda-sqs-worker-cdk/infra/appStack.ts

@@ -0,0 +1,74 @@
+import {
+  Stack,
+  StackProps,
+  aws_iam,
+  aws_kms,
+  aws_lambda,
+  aws_lambda_event_sources,
+  aws_sns,
+  aws_sns_subscriptions,
+  aws_sqs,
+} from 'aws-cdk-lib';
+import type { Construct } from 'constructs';
+
+import { EnvContextSchema, StageContextSchema } from '../shared/context-types';
+
+export class AppStack extends Stack {
+  constructor(scope: Construct, id: string, props?: StackProps) {
+    super(scope, id, props);
+
+    const stage = StageContextSchema.parse(this.node.tryGetContext('stage'));
+    const context = EnvContextSchema.parse(this.node.tryGetContext(stage));
+
+    const accountPrincipal = new aws_iam.AccountPrincipal(this.account);
+
+    const kmsKey = new aws_kms.Key(this, 'kms-key', {
+      description: '<%- serviceName %>',
+      enableKeyRotation: true,
+      admins: [accountPrincipal],
+      alias: 'seek/self/<%- serviceName %>',
+    });
+
+    kmsKey.grantEncrypt(accountPrincipal);
+
+    const topic = new aws_sns.Topic(this, 'topic', {
+      topicName: '<%- serviceName %>',
+      masterKey: kmsKey,
+    });
+
+    const deadLetterQueue = new aws_sqs.Queue(this, 'worker-queue-dlq', {
+      queueName: '<%- serviceName %>-dlq',
+      encryptionMasterKey: kmsKey,
+    });
+
+    const queue = new aws_sqs.Queue(this, 'worker-queue', {
+      queueName: '<%- serviceName %>',
+      deadLetterQueue: {
+        maxReceiveCount: 3,
+        queue: deadLetterQueue,
+      },
+      encryptionMasterKey: kmsKey,
+    });
+
+    const architecture = '<%- lambdaCdkArchitecture %>';
+
+    const worker = new aws_lambda.Function(this, 'worker', {
+      architecture: aws_lambda.Architecture[architecture],
+      code: new aws_lambda.AssetCode('./lib'),
+      runtime: aws_lambda.Runtime.NODEJS_18_X,
+      handler: 'app.handler',
+      functionName: '<%- serviceName %>',
+      environmentEncryption: kmsKey,
+      environment: {
+        NODE_ENV: 'production',
+        // https://nodejs.org/api/cli.html#cli_node_options_options
+        NODE_OPTIONS: '--enable-source-maps',
+        ...context.workerLambda.environment,
+      },
+    });
+
+    worker.addEventSource(new aws_lambda_event_sources.SqsEventSource(queue));
+
+    topic.addSubscription(new aws_sns_subscriptions.SqsSubscription(queue));
+  }
+}

package/template/lambda-sqs-worker-cdk/infra/index.ts

@@ -0,0 +1,14 @@
+import { App } from 'aws-cdk-lib';
+
+import { GlobalContextSchema } from '../shared/context-types';
+
+import { AppStack } from './appStack';
+
+const app = new App();
+
+const context = GlobalContextSchema.parse(app.node.tryGetContext('global'));
+
+// eslint-disable-next-line no-new
+new AppStack(app, 'appStack', {
+  stackName: context.appName,
+});

package/template/lambda-sqs-worker-cdk/package.json

@@ -0,0 +1,30 @@
+{
+  "private": true,
+  "license": "UNLICENSED",
+  "scripts": {
+    "build": "skuba build",
+    "deploy": "cdk deploy appStack --require-approval never --context stage=${ENVIRONMENT}",
+    "format": "skuba format",
+    "lint": "skuba lint",
+    "package": "yarn install --ignore-optional --ignore-scripts --modules-folder ./lib/node_modules --non-interactive --offline --production",
+    "test": "skuba test",
+    "test:ci": "skuba test --coverage",
+    "test:watch": "skuba test --watch"
+  },
+  "dependencies": {
+    "@seek/logger": "^5.0.1",
+    "zod": "^3.19.1"
+  },
+  "devDependencies": {
+    "@aws-cdk/assert": "^2.24.0",
+    "@types/aws-lambda": "^8.10.82",
+    "@types/node": "^18.11.9",
+    "aws-cdk": "^2.51.1",
+    "aws-cdk-lib": "^2.51.1",
+    "constructs": "^10.0.17",
+    "skuba": "*"
+  },
+  "engines": {
+    "node": ">=18"
+  }
+}

package/template/lambda-sqs-worker-cdk/shared/context-types.ts

@@ -0,0 +1,21 @@
+import { z } from 'zod';
+
+export const StageContextSchema = z.enum(['dev', 'prod']);
+export type StageContext = z.infer<typeof StageContextSchema>;
+
+export const EnvContextSchema = z.object({
+  workerLambda: z.object({
+    reservedConcurrency: z.number(),
+    environment: z.object({
+      SOMETHING: z.string(),
+    }),
+  }),
+});
+
+export type EnvContext = z.infer<typeof EnvContextSchema>;
+
+export const GlobalContextSchema = z.object({
+  appName: z.string(),
+});
+
+export type GlobalContext = z.infer<typeof GlobalContextSchema>;

package/template/lambda-sqs-worker-cdk/skuba.template.js

@@ -0,0 +1,27 @@
+/**
+ * Run `skuba configure` to finish templating and remove this file.
+ */
+
+module.exports = {
+  entryPoint: 'src/app.ts#handler',
+  fields: [
+    {
+      name: 'serviceName',
+      message: 'Service slug',
+      initial: 'my-project',
+    },
+    {
+      name: 'devBuildkiteQueueName',
+      message: 'Dev Buildkite queue',
+      initial: 'my-team-aws-account-dev:cicd',
+      validate: (value) => /^.+:.+$/.test(value),
+    },
+    {
+      name: 'prodBuildkiteQueueName',
+      message: 'Prod Buildkite queue',
+      initial: 'my-team-aws-account-prod:cicd',
+      validate: (value) => /^.+:.+$/.test(value),
+    },
+  ],
+  type: 'application',
+};

package/template/lambda-sqs-worker-cdk/src/app.ts

@@ -0,0 +1,10 @@
+import createLogger from '@seek/logger';
+import { SQSEvent, SQSHandler } from 'aws-lambda';
+
+const logger = createLogger({
+  name: '<%- serviceName %>',
+});
+
+export const handler: SQSHandler = (_: SQSEvent) => {
+  logger.info('Hello World!');
+};

package/template/lambda-sqs-worker-cdk/tsconfig.json

@@ -0,0 +1,13 @@
+{
+  "compilerOptions": {
+    "baseUrl": ".",
+    "lib": ["ES2022"],
+    "outDir": "lib",
+    "paths": {
+      "src": ["src"]
+    },
+    "target": "ES2022"
+  },
+  "exclude": ["lib*/**/*"],
+  "extends": "skuba/config/tsconfig.json"
+}

package/template/oss-npm-package/.github/workflows/release.yml

@@ -0,0 +1,35 @@
+name: Release
+
+on:
+  push:
+    branches:
+      - beta
+      - master
+
+permissions: {}
+
+jobs:
+  release:
+    name: Publish & Deploy
+    permissions:
+      contents: write
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repo
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Set up Node.js 16.x
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16.x
+
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+
+      - name: Publish to npm
+        run: yarn release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.SEEK_OSS_CI_NPM_TOKEN }}

package/template/oss-npm-package/.github/workflows/validate.yml

@@ -0,0 +1,31 @@
+name: Validate
+
+on:
+  - pull_request
+  - push
+
+permissions: {}
+
+jobs:
+  validate:
+    name: Lint & Test
+    permissions:
+      checks: write
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repo
+        uses: actions/checkout@v3
+
+      - name: Set up Node.js 16.x
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16.x
+
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+
+      - name: Test
+        run: yarn test:ci
+
+      - name: Lint
+        run: yarn lint

package/template/oss-npm-package/.nvmrc

@@ -0,0 +1 @@
+18

package/template/oss-npm-package/LICENSE

@@ -0,0 +1,21 @@
+### MIT License
+
+Copyright (c) 2020 SEEK
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/template/oss-npm-package/README.md

@@ -0,0 +1,128 @@
+# <%- moduleName %>
+
+[![Powered by skuba](https://img.shields.io/badge/🤿%20skuba-powered-009DC4)](https://github.com/seek-oss/skuba)
+
+This package is intended to be public on [seek-oss].
+To create an internal package,
+run `skuba init` and select the `private-npm-package` template.
+
+Next steps:
+
+1. [ ] Read [SEEK's Open Source RFC].
+2. [ ] Create a new repository in the [seek-oss] GitHub organisation.
+3. [ ] Push local commits to the upstream GitHub branch.
+4. [ ] Configure [GitHub repository settings].
+5. [ ] Keep dependencies up to date with [Renovate];
+       request installation in [#open-source].
+6. [ ] Delete this checklist 😌.
+
+[#open-source]: https://slack.com/app_redirect?channel=C39P1H2SU
+[github repository settings]: https://github.com/<%-orgName%>/<%-repoName%>/settings
+[renovate]: https://github.com/apps/renovate
+[seek's open source rfc]: https://rfc.skinfra.xyz/RFC016-Open-Source.html
+
+## API
+
+### `log`
+
+Writes the module name to stdout.
+Thrilling stuff.
+
+```typescript
+import { log } from '<%- moduleName %>';
+
+log();
+```
+
+## Development
+
+### Prerequisites
+
+- Node.js LTS
+- Yarn 1.x
+
+```shell
+yarn install
+```
+
+### Test
+
+```shell
+yarn test
+```
+
+### Lint
+
+```shell
+# Fix issues
+yarn format
+
+# Check for issues
+yarn lint
+```
+
+### Package
+
+```shell
+# Compile source
+yarn build
+
+# Review bundle
+npm pack
+```
+
+## Release
+
+This package is published to the public npm registry with a GitHub Actions [release workflow].
+
+The workflow runs on select branches:
+
+```yaml
+on:
+  push:
+    branches:
+      # add others as necessary
+      - beta
+      - master
+      # - alpha
+```
+
+It depends on this repo being hosted on [seek-oss] with appropriate access.
+
+To set up this repo for publishing, follow the instructions in our [OSS npm package guidance].
+
+### Commit messages
+
+This package is published with **[semantic-release]**, which requires a particular commit format to manage semantic versioning.
+You can run the interactive `yarn commit` command in place of `git commit` to generate a compliant commit title and message.
+If you use the `Squash and merge` option on pull requests, take extra care to format the squashed commit in the GitHub UI before merging.
+
+### Releasing latest
+
+Commits to the `master` branch will be released with the `latest` tag,
+which is the default used when running `npm install` or `yarn install`.
+
+### Releasing other dist-tags
+
+**[semantic-release]** prescribes a branch-based workflow for managing [distribution tags].
+
+You can push to other branches to manage betas, maintenance updates to prior major versions, and more.
+
+Here are some branches that **semantic-release** supports by default:
+
+| Git branch | npm dist-tag |
+| :--------- | :----------- |
+| master     | latest       |
+| alpha      | alpha        |
+| beta       | beta         |
+| next       | next         |
+| 1.x        | release-1.x  |
+
+For more information, see the **semantic-release** docs on [triggering a release].
+
+[distribution tags]: https://docs.npmjs.com/adding-dist-tags-to-packages
+[oss npm package guidance]: https://github.com/SEEK-Jobs/seek-oss-ci/blob/master/NPM_PACKAGES.md#access-to-publish-to-npm
+[release workflow]: .github/workflows/release.yml
+[seek-oss]: https://github.com/seek-oss
+[semantic-release]: https://github.com/semantic-release/semantic-release
+[triggering a release]: https://github.com/semantic-release/semantic-release/#triggering-a-release

package/template/oss-npm-package/_package.json

@@ -0,0 +1,41 @@
+{
+  "dependencies": {},
+  "description": "<%- description %>",
+  "devDependencies": {
+    "@types/node": "^16.18.3",
+    "commitizen": "^4.2.4",
+    "skuba": "*"
+  },
+  "files": [
+    "lib*/**/*.d.ts",
+    "lib*/**/*.js",
+    "lib*/**/*.js.map",
+    "lib*/**/*.json"
+  ],
+  "license": "MIT",
+  "main": "./lib-commonjs/index.js",
+  "module": "./lib-es2015/index.js",
+  "name": "<%- moduleName %>",
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com/<%- orgName %>/<%- repoName %>.git"
+  },
+  "scripts": {
+    "build": "skuba build-package",
+    "commit": "cz",
+    "format": "skuba format",
+    "lint": "skuba lint",
+    "release": "yarn build && skuba release",
+    "test": "skuba test",
+    "test:ci": "skuba test --coverage",
+    "test:watch": "skuba test --watch"
+  },
+  "config": {
+    "commitizen": {
+      "path": "cz-conventional-changelog"
+    }
+  },
+  "sideEffects": false,
+  "types": "./lib-types/index.d.ts",
+  "version": "0.0.0-semantically-released"
+}

package/template/oss-npm-package/skuba.template.js

@@ -0,0 +1,22 @@
+/**
+ * Run `skuba configure` to finish templating and remove this file.
+ */
+
+module.exports = {
+  entryPoint: 'src/index.ts',
+  fields: [
+    {
+      name: 'moduleName',
+      message: 'Module name',
+      initial: 'my-first-module',
+    },
+    {
+      name: 'description',
+      message: 'Description',
+      initial: 'This is my first module',
+    },
+  ],
+  // `moduleName` is required for a valid `package.json`
+  noSkip: true,
+  type: 'package',
+};

package/template/oss-npm-package/src/index.test.ts

@@ -0,0 +1,5 @@
+import { log } from './index';
+
+describe('app', () => {
+  it('defines a log function', () => expect(log).toBeDefined());
+});

package/template/oss-npm-package/src/index.ts

@@ -0,0 +1,7 @@
+/**
+ * Writes the module name to stdout.
+ * Thrilling stuff.
+ */
+export const log = () =>
+  /* eslint-disable-next-line no-console */
+  console.log('<%- moduleName %>');

package/template/oss-npm-package/tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "compilerOptions": {
+    "lib": ["ES2020"],
+    "outDir": "lib",
+    "removeComments": false,
+    "target": "ES2020"
+  },
+  "exclude": ["lib*/**/*"],
+  "extends": "skuba/config/tsconfig.json"
+}

package/template/private-npm-package/.buildkite/pipeline.yml

@@ -0,0 +1,5 @@
+agents:
+  queue: artefacts:npm2
+
+steps:
+  - command: aws s3 cp s3://seek-npm-package-buildkite-pipeline/pipeline-latest.sh - | bash | buildkite-agent pipeline upload

package/template/private-npm-package/.nvmrc

@@ -0,0 +1 @@
+18

package/template/private-npm-package/README.md

@@ -0,0 +1,109 @@
+# <%- moduleName %>
+
+[![Powered by skuba](https://img.shields.io/badge/🤿%20skuba-powered-009DC4)](https://github.com/seek-oss/skuba)
+
+This package is intended to be private on [SEEK-Jobs] under the `@seek` npm org.
+To create a public package,
+run `skuba init` and select the `oss-npm-package` template.
+
+Next steps:
+
+1. [ ] Create a new repository in the [SEEK-Jobs] GitHub organisation.
+2. [ ] Follow [Gutenberg] instructions for [installing on your repository].
+3. [ ] Push local commits to the upstream GitHub branch.
+4. [ ] Configure [GitHub repository settings].
+5. [ ] Delete this checklist 😌.
+
+[github repository settings]: https://github.com/<%-orgName%>/<%-repoName%>/settings
+[installing on your repository]: https://github.com/SEEK-Jobs/gutenberg#installing-on-your-repository
+
+## API
+
+### `log`
+
+Writes the module name to stdout.
+Thrilling stuff.
+
+```typescript
+import { log } from '<%- moduleName %>';
+
+log();
+```
+
+## Development
+
+### Prerequisites
+
+- Node.js LTS
+- Yarn 1.x
+
+```shell
+yarn install
+```
+
+### Test
+
+```shell
+yarn test
+```
+
+### Lint
+
+```shell
+# Fix issues
+yarn format
+
+# Check for issues
+yarn lint
+```
+
+### Package
+
+```shell
+# Compile source
+yarn build
+
+# Review bundle
+npm pack
+```
+
+## Release
+
+This package is published to the npm registry under the private `@seek` npm org with [Gutenberg], SEEK's central npm publishing pipeline.
+
+It depends on this repo being hosted on [SEEK-Jobs] with appropriate access.
+
+### Commit messages
+
+This package is published with **[semantic-release]**, which requires a particular commit format to manage semantic versioning.
+You can run the interactive `yarn commit` command in place of `git commit` to generate a compliant commit title and message.
+If you use the `Squash and merge` option on pull requests, take extra care to format the squashed commit in the GitHub UI before merging.
+
+### Releasing latest
+
+Commits to the `master` branch will be released with the `latest` tag,
+which is the default used when running `npm install` or `yarn install`.
+
+### Releasing other dist-tags
+
+**[semantic-release]** prescribes a branch-based workflow for managing [distribution tags].
+
+You can push to other branches to manage betas, maintenance updates to prior major versions, and more.
+
+Here are some branches that **semantic-release** supports by default:
+
+| Git branch | npm dist-tag |
+| :--------- | :----------- |
+| master     | latest       |
+| alpha      | alpha        |
+| beta       | beta         |
+| next       | next         |
+| 1.x        | release-1.x  |
+
+For more information, see the **semantic-release** docs on [triggering a release].
+
+[distribution tags]: https://docs.npmjs.com/adding-dist-tags-to-packages
+[gutenberg]: https://github.com/SEEK-Jobs/gutenberg
+[seek-jobs]: https://github.com/orgs/seek-jobs/sso
+[semantic-release]: https://github.com/semantic-release/semantic-release
+[triggering a release]: https://github.com/semantic-release/semantic-release/#triggering-a-release