declapract-typescript-ehmpathy 0.17.0 → 0.17.2

package/dist/practices/artifact/best-practice/.declapract.readme.md

@@ -0,0 +1,6 @@
+using an artifact file ensures that our builds are easily reproducible and contain only the minimum required data
+
+benefits
+- maximizes lambda performance
+- guarantees reproducibility
+- speeds up serverless framework deployments

package/dist/practices/artifact/best-practice/artifact.yml

@@ -0,0 +1,7 @@
+trace:
+  - 'dist/contract/handlers/**/*.js' # include all dependencies of the handlers
+
+pick:
+  - 'dist/**/*.js.map' # include all of the source maps # TODO: update simple-artifact-builder to do this automatically for all files it includes
+  - 'config/*'
+  - 'package.json'

package/dist/practices/artifact/best-practice/package.json

@@ -0,0 +1,8 @@
+{
+  "devDependencies": {
+    "simple-artifact-builder": "@declapract{check.minVersion('1.1.6')}"
+  },
+  "scripts": {
+    "build:artifact": "npx simple-artifact-builder zip"
+  }
+}

package/dist/practices/artifact/best-practice/package.json.declapract.ts

@@ -0,0 +1,3 @@
+import { FileCheckType } from 'declapract';
+
+export const check = FileCheckType.CONTAINS;

package/dist/practices/cicd-deploy-package/best-practice/.github/workflows/publish-on-tag.yml

@@ -22,6 +22,7 @@ jobs:
         uses: actions/setup-node@v2
         with:
           node-version: ${{ steps.nvmrc.outputs.NODE_VERSION }}
+          registry-url: 'https://registry.npmjs.org'
           cache: 'npm'
 
       - name: install

package/dist/practices/git/best-practice/.gitignore.declapract.ts

@@ -3,6 +3,7 @@ import expect from 'expect';
 import uniq from 'lodash.uniq';
 
 const expectedIgnores = [
+  '.artifact', // deployment artifacts from `simple-artifact-builder` are produced here
   '.env',
   '.serverless',
   '.terraform',

package/dist/practices/linting/best-practice/.eslintrc.js

@@ -2,8 +2,8 @@ module.exports = {
   parser: '@typescript-eslint/parser', // Specifies the ESLint parser
   extends: [
     'plugin:@typescript-eslint/recommended', // Uses the recommended rules from the @typescript-eslint/eslint-plugin
+    'plugin:import/recommended', // specifies good import rules
     'airbnb-typescript/base', // uses the airbnb recommended rules
-    'prettier/@typescript-eslint', // disables ESLint rules from @typescript-eslint/eslint-plugin that would conflict with prettier
     'plugin:prettier/recommended', // Enables eslint-plugin-prettier and displays prettier errors as ESLint errors. Make sure this is always the last configuration in the extends array.
   ],
   parserOptions: {

package/dist/practices/persist-with-dynamodb/best-practice/package.json

@@ -1,5 +1,11 @@
 {
   "dependencies": {
-    "simple-dynamodb-client": "@declapract{check.minVersion('7.0.0')}"
+    "simple-dynamodb-client": "@declapract{check.minVersion('0.10.0')}"
+  },
+  "scripts": {
+    "provision:docker:up": "docker-compose -f ./provision/docker/integration_test_db/docker-compose.yml up -d --force-recreate --build --renew-anon-volumes",
+    "provision:docker:down": "docker-compose -f ./provision/docker/integration_test_db/docker-compose.yml down",
+    "provision:dynamodb:schema": "terraform -chdir=provision/aws/environments/test apply -auto-approve",
+    "provision:integration-test-db": "npm run provision:docker:up && npm run provision:dynamodb:schema"
   }
 }

package/dist/practices/persist-with-dynamodb/best-practice/provision/docker/integration-test-db/docker-compose.yml

@@ -0,0 +1,9 @@
+version: '3.8'
+services:
+  dynamodb-local:
+    command: '-jar DynamoDBLocal.jar -sharedDb -inMemory'
+    image: 'amazon/dynamodb-local:latest'
+    container_name: dynamodb-local
+    ports:
+      - '7337:8000'
+    working_dir: /home/dynamodblocal

package/dist/practices/serverless/best-practice/serverless.yml

@@ -1,5 +1,8 @@
 service: @declapract{variable.projectName}
 
+package:
+  artifact: .artifact/contents.zip
+
 provider:
   name: aws
   runtime: nodejs16.x

package/dist/practices/terraform/best-practice/provision/aws/environments/test/main.tf

@@ -1,6 +1,10 @@
 provider "aws" {
   region              = "us-east-1"
   allowed_account_ids = ["@declapract{variable.awsAccountId.dev}"] # `test` environment resources are provisioned in the `dev` aws account
+
+  endpoints {
+    dynamodb = "http://localhost:7337/"
+  }
 }
 
 terraform {

package/dist/practices/testing/best-practice/jest.acceptance.config.ts

@@ -0,0 +1,17 @@
+import type { Config } from 'jest';
+
+// https://jestjs.io/docs/configuration
+const config: Config = {
+  verbose: true,
+  testEnvironment: 'node',
+  moduleFileExtensions: ['js', 'ts'],
+  transform: {
+    '^.+\\.[tj]sx?$': 'ts-jest', // https://kulshekhar.github.io/ts-jest/docs/getting-started/presets
+  },
+  testMatch: ['**/*.acceptance.test.ts'],
+  setupFiles: ['core-js'],
+  setupFilesAfterEnv: ['./jest.acceptance.env.ts'],
+};
+
+// eslint-disable-next-line import/no-default-export
+export default config;

package/dist/practices/testing/best-practice/jest.config.ts

@@ -0,0 +1,4 @@
+import config from './jest.unit.config';
+
+// eslint-disable-next-line import/no-default-export
+export default config;

package/dist/practices/testing/best-practice/jest.integration.config.ts

@@ -0,0 +1,17 @@
+import type { Config } from 'jest';
+
+// https://jestjs.io/docs/configuration
+const config: Config = {
+  verbose: true,
+  testEnvironment: 'node',
+  moduleFileExtensions: ['js', 'ts'],
+  transform: {
+    '^.+\\.[tj]sx?$': 'ts-jest', // https://kulshekhar.github.io/ts-jest/docs/getting-started/presets
+  },
+  testMatch: ['**/*.integration.test.ts'],
+  setupFiles: ['core-js'],
+  setupFilesAfterEnv: ['./jest.integration.env.ts'],
+};
+
+// eslint-disable-next-line import/no-default-export
+export default config;

package/dist/practices/testing/best-practice/{jest.integration.env.js → jest.integration.env.ts}

@@ -1,5 +1,8 @@
-// eslint-disable-next-line @typescript-eslint/no-var-requires
-const { stage, Stage } = require('./src/utils/environment');
+import { stage, Stage } from './src/utils/environment';
+
+// set a longer timeout
+// eslint-disable-next-line no-undef
+jest.setTimeout(90000); // since we're calling downstream apis
 
 /**
  * sanity check that integration tests are only run in 'test' environment
@@ -8,6 +11,8 @@ const { stage, Stage } = require('./src/utils/environment');
 if (stage !== Stage.TEST && process.env.I_KNOW_WHAT_IM_DOING !== 'true')
   throw new Error(`integration-test is not targeting stage 'test'`);
 
-// set a longer timeout
-// eslint-disable-next-line no-undef
-jest.setTimeout(90000); // since we're calling downstream apis
+/**
+ * specify that dynamodb should use the local dynamodb database, if running in test env
+ */
+if (stage === Stage.TEST)
+  process.env.USE_CUSTOM_DYNAMODB_ENDPOINT = 'http://localhost:7337';

package/dist/practices/testing/best-practice/jest.unit.config.ts

@@ -0,0 +1,22 @@
+import type { Config } from 'jest';
+
+// https://jestjs.io/docs/configuration
+const config: Config = {
+  verbose: true,
+  testEnvironment: 'node',
+  moduleFileExtensions: ['js', 'ts'],
+  transform: {
+    '^.+\\.[tj]sx?$': 'ts-jest', // https://kulshekhar.github.io/ts-jest/docs/getting-started/presets
+  },
+  testMatch: [
+    // note: order matters
+    '**/*.test.ts',
+    '!**/*.acceptance.test.ts',
+    '!**/*.integration.test.ts',
+  ],
+  setupFiles: ['core-js'],
+  setupFilesAfterEnv: ['./jest.unit.env.ts'],
+};
+
+// eslint-disable-next-line import/no-default-export
+export default config;

package/dist/practices/testing/best-practice/{jest.unit.env.js → jest.unit.env.ts}

@@ -1,10 +1,6 @@
-/* eslint-disable global-require */
-// eslint-disable-next-line @typescript-eslint/no-var-requires
-const { stage, Stage } = require('./src/utils/environment');
+import { stage, Stage } from './src/utils/environment';
 
-// eslint-disable-next-line no-undef
 jest.mock('./src/utils/config/getConfig', () => ({
-  // eslint-disable-next-line no-undef
   getConfig: jest.fn().mockImplementation(() => require('./config/test.json')), // mock that getConfig just returns plaintext test env config in unit tests
 }));
 

package/dist/practices/testing/best-practice/package.json

@@ -7,10 +7,10 @@
     "simple-lambda-testing-methods": "@declapract{check.minVersion('0.2.1')}"
   },
   "scripts": {
-    "test:unit": "jest -c ./jest.unit.config.js --forceExit --coverage --verbose --passWithNoTests",
-    "test:integration": "jest -c ./jest.integration.config.js --forceExit --coverage --verbose --passWithNoTests",
-    "test:acceptance:locally": "npm run build && LOCALLY=true jest -c ./jest.acceptance.config.js --forceExit --verbose --runInBand",
+    "test:unit": "jest -c ./jest.unit.config.ts --forceExit --coverage --verbose --passWithNoTests",
+    "test:integration": "jest -c ./jest.integration.config.ts --forceExit --coverage --verbose --passWithNoTests",
+    "test:acceptance:locally": "npm run build && LOCALLY=true jest -c ./jest.acceptance.config.ts --forceExit --verbose --runInBand",
     "test": "npm run test:commits && npm run test:types && npm run test:format && npm run test:lint && npm run test:unit && npm run test:integration && npm run test:acceptance:locally",
-    "test:acceptance": "npm run build && jest -c ./jest.acceptance.config.js --forceExit --verbose --runInBand"
+    "test:acceptance": "npm run build && jest -c ./jest.acceptance.config.ts --forceExit --verbose --runInBand"
   }
 }

package/dist/practices/typescript/best-practice/package.json

@@ -6,7 +6,7 @@
   "scripts": {
     "build:clean": "rm dist/ -rf",
     "build:compile": "tsc -p ./tsconfig.build.json",
-    "build": "npm run build:clean && npm run build:compile",
+    "build": "npm run build:clean && npm run build:compile && npm run build:artifact",
     "test:types": "tsc -p ./tsconfig.build.json --noEmit"
   }
 }

package/dist/practices/typescript/best-practice/tsconfig.json

@@ -3,12 +3,14 @@
   "compilerOptions": {
     "importsNotUsedAsValues": "remove",
     "noPropertyAccessFromIndexSignature": false,
+    "noImplicitOverride": false,
     "resolveJsonModule": true,
     "sourceMap": true,
     "outDir": "dist",
+    "target": "es6",
   },
   "include": [
-    "src/**/*.ts"
+    "**/*.ts"
   ],
   "exclude": [
     "dist",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "declapract-typescript-ehmpathy",
-  "version": "0.17.0",
+  "version": "0.17.2",
   "description": "declapract best practices declarations for typescript",
   "main": "src/index.js",
   "repository": "ehmpathy/declapract-typescript-ehmpathy",

package/dist/practices/testing/best-practice/jest.acceptance.config.js

@@ -1,15 +0,0 @@
-// https://jestjs.io/docs/en/configuration.html
-module.exports = {
-  preset: 'ts-jest',
-  globals: {
-    'ts-jest': {
-      tsconfig: 'tsconfig.json',
-    },
-  },
-  verbose: true,
-  testEnvironment: 'node',
-  moduleFileExtensions: ['js', 'ts'],
-  testMatch: ['**/*.acceptance.test.ts'],
-  setupFiles: ['core-js'],
-  setupFilesAfterEnv: ['./jest.acceptance.env.js'],
-};

package/dist/practices/testing/best-practice/jest.config.js

@@ -1 +0,0 @@
-module.exports = require('./jest.unit.config'); // default to unit tests

package/dist/practices/testing/best-practice/jest.integration.config.js

@@ -1,10 +0,0 @@
-// https://jestjs.io/docs/en/configuration.html
-module.exports = {
-  preset: 'ts-jest',
-  verbose: true,
-  testEnvironment: 'node',
-  moduleFileExtensions: ['js', 'ts'],
-  testMatch: ['**/*.integration.test.ts'],
-  setupFiles: ['core-js'],
-  setupFilesAfterEnv: ['./jest.integration.env.js'],
-};

package/dist/practices/testing/best-practice/jest.unit.config.js

@@ -1,15 +0,0 @@
-// https://jestjs.io/docs/en/configuration.html
-module.exports = {
-  preset: 'ts-jest',
-  verbose: true,
-  testEnvironment: 'node',
-  moduleFileExtensions: ['js', 'ts'],
-  testMatch: [
-    // note: order matters
-    '**/*.test.ts',
-    '!**/*.acceptance.test.ts',
-    '!**/*.integration.test.ts',
-  ],
-  setupFiles: ['core-js'],
-  setupFilesAfterEnv: ['./jest.unit.env.js'],
-};