@cumulusds/aws-apig-bypass 0.2.4-reusableworkflow.16.gbe881dc → 0.2.4

package/.github/dependabot.yml

@@ -0,0 +1,15 @@
+version: 2
+
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"
+      time: "07:00"
+      timezone: "America/New_York"
+    labels:
+      - "actions"
+    assignees:
+      - "jeffsays"
+    reviewers:
+      - "jeffsays"

package/.github/pull_request_template.md

@@ -0,0 +1,18 @@
+## Summary
+What does this PR do?
+
+## Dependencies
+- [Name of the change](https://link-to-PR-or-commit)
+
+## Changes
+### Interface 
+- Is there a change to the package's interface?
+
+### Developer
+- What are the other changes that are not directly visible to the user ?
+
+## Details
+Why did you make this change? What does it affect?
+
+## Testing
+How can the other reviewers check that your change works?

package/.github/workflows/ci-cd.yml

@@ -0,0 +1,88 @@
+name: ci-cd
+
+on:
+  push:
+    branches:
+      - '**/*'
+  pull_request:
+  release:
+    types: [released]
+
+jobs:
+  unit:
+    runs-on: ubuntu-18.04
+    strategy:
+      matrix:
+        node: [10, 12, 13, 14, 15]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Install Node ${{ matrix.node }}
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node }}
+      - name: Install NPM credentials
+        run: echo "//registry.npmjs.org/:_authToken=$NPM_TOKEN" >> ~/.npmrc
+        env:
+          NPM_TOKEN: ${{ secrets.NODE_AUTH_TOKEN }}
+      - name: Get yarn cache
+        id: yarn-cache
+        run: echo "::set-output name=dir::$(yarn cache dir)"
+      - name: Restore yarn cache
+        uses: actions/cache@v2
+        with:
+          path: ${{ steps.yarn-cache.outputs.dir }}
+          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-yarn-
+      - name: Install NPM Packages
+        run: yarn install --frozen-lockfile
+      - name: Check licenses
+        run: yarn build:license-checker
+      - name: Test
+        run: yarn test
+      - uses: 8398a7/action-slack@v2
+        with:
+          status: ${{ job.status }}
+          author_name: ${{ github.repository }} ${{ github.workflow }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK }}
+        if: always()
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v2
+        with:
+          name: var
+          path: var
+        if: always()
+  publish:
+    runs-on: ubuntu-18.04
+    needs: unit
+    if: github.event_name == 'release'
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Install Node 14
+        uses: actions/setup-node@v2
+        with:
+          node-version: 14
+      - name: Install NPM credentials
+        run: echo "//registry.npmjs.org/:_authToken=$NPM_TOKEN" >> ~/.npmrc
+        env:
+          NPM_TOKEN: ${{ secrets.NODE_AUTH_TOKEN }}
+      - name: Get yarn cache
+        id: yarn-cache
+        run: echo "::set-output name=dir::$(yarn cache dir)"
+      - name: Restore yarn cache
+        uses: actions/cache@v2
+        with:
+          path: ${{ steps.yarn-cache.outputs.dir }}
+          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-yarn-
+      - name: Install NPM Packages
+        run: yarn install --frozen-lockfile
+      - name: Build
+        run: yarn build
+      - name: Publish
+        run: npm publish

package/lib/create-api-gateway-event.js

@@ -0,0 +1,59 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = createAPIGatewayEvent;
+const defaultRequestContext = {
+  accountId: "",
+  apiId: "",
+  httpMethod: "",
+  identity: {
+    accessKey: null,
+    accountId: null,
+    apiKey: null,
+    caller: null,
+    cognitoAuthenticationProvider: null,
+    cognitoAuthenticationType: null,
+    cognitoIdentityId: null,
+    cognitoIdentityPoolId: null,
+    sourceIp: "",
+    user: null,
+    userAgent: null,
+    userArn: null
+  },
+  stage: "",
+  requestId: "",
+  resourceId: "",
+  resourcePath: ""
+};
+
+function createAPIGatewayEvent({
+  body = null,
+  headers = {},
+  multiValueHeaders = {},
+  httpMethod = "",
+  isBase64Encoded = false,
+  pathParameters = null,
+  path = "",
+  queryStringParameters = null,
+  multiValueQueryStringParameters = null,
+  stageVariables = null,
+  requestContext = defaultRequestContext,
+  resource = ""
+} = {}) {
+  return {
+    body,
+    headers,
+    multiValueHeaders,
+    httpMethod,
+    isBase64Encoded,
+    path,
+    pathParameters,
+    queryStringParameters,
+    multiValueQueryStringParameters,
+    stageVariables,
+    requestContext,
+    resource
+  };
+}

package/lib/create-api-gateway-event.js.flow

@@ -0,0 +1,75 @@
+// @flow
+
+import type { APIGatewayEvent } from "@cumulusds/flow-aws-lambda";
+
+export type PathParameters = { [name: string]: string } | null;
+export type QueryStringParameters = { [name: string]: string } | null;
+
+const defaultRequestContext = {
+  accountId: "",
+  apiId: "",
+  httpMethod: "",
+  identity: {
+    accessKey: null,
+    accountId: null,
+    apiKey: null,
+    caller: null,
+    cognitoAuthenticationProvider: null,
+    cognitoAuthenticationType: null,
+    cognitoIdentityId: null,
+    cognitoIdentityPoolId: null,
+    sourceIp: "",
+    user: null,
+    userAgent: null,
+    userArn: null
+  },
+  stage: "",
+  requestId: "",
+  resourceId: "",
+  resourcePath: ""
+};
+
+export type CreateAPIGatewayEventOptions = {
+  body?: string,
+  headers?: { [name: string]: string },
+  multiValueHeaders?: { [name: string]: string[] },
+  httpMethod?: string,
+  isBase64Encoded?: boolean,
+  path?: string,
+  pathParameters?: PathParameters,
+  queryStringParameters?: QueryStringParameters,
+  multiValueQueryStringParameters?: { [name: string]: string[] },
+  stageVariables?: { [name: string]: string },
+  requestContext?: typeof defaultRequestContext,
+  resource?: string
+};
+
+export default function createAPIGatewayEvent({
+  body = null,
+  headers = {},
+  multiValueHeaders = {},
+  httpMethod = "",
+  isBase64Encoded = false,
+  pathParameters = null,
+  path = "",
+  queryStringParameters = null,
+  multiValueQueryStringParameters = null,
+  stageVariables = null,
+  requestContext = defaultRequestContext,
+  resource = ""
+}: CreateAPIGatewayEventOptions = {}): APIGatewayEvent<string> {
+  return {
+    body,
+    headers,
+    multiValueHeaders,
+    httpMethod,
+    isBase64Encoded,
+    path,
+    pathParameters,
+    queryStringParameters,
+    multiValueQueryStringParameters,
+    stageVariables,
+    requestContext,
+    resource
+  };
+}

package/lib/create-client.js

@@ -0,0 +1,25 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = createClient;
+
+var _createLambdaClient = _interopRequireDefault(require("./create-lambda-client"));
+
+var _jsonStringify = _interopRequireDefault(require("./json-stringify"));
+
+var _parsePayload = _interopRequireDefault(require("./parse-payload"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+/**
+ * Create an APIGatewayHandlerClient. The client invokes an API Gateway handler, bypassing the gateway. It adapts the AWS SDK by packing and unpacking messages for invoking the handler.
+ *
+ * @param options
+ * @returns {APIGatewayHandlerClient<T>}
+ */
+function createClient(options) {
+  const client = (0, _createLambdaClient.default)(options);
+  return async event => (0, _parsePayload.default)((await client((0, _jsonStringify.default)(event))));
+}

package/lib/create-client.js.flow

@@ -0,0 +1,30 @@
+// @flow
+
+import type { APIGatewayEvent } from "@cumulusds/flow-aws-lambda";
+import createLambdaClient from "./create-lambda-client";
+import type { Response } from "./response";
+import jsonStringify from "./json-stringify";
+import parsePayload from "./parse-payload";
+import type { LambdaInvoke } from "./lambda-invoke";
+
+/**
+ * Client that directly invokes an API Gateway handler, bypassing the gateway. The client handles packing and unpacking messages for invoking the handler.
+ */
+export type APIGatewayHandlerClient<T> = (event: APIGatewayEvent<string>) => Promise<Response<T>>;
+
+export type CreateClientOptions<T> = {
+  Lambda: LambdaInvoke,
+  FunctionName: string,
+  Validate?: T => void
+};
+
+/**
+ * Create an APIGatewayHandlerClient. The client invokes an API Gateway handler, bypassing the gateway. It adapts the AWS SDK by packing and unpacking messages for invoking the handler.
+ *
+ * @param options
+ * @returns {APIGatewayHandlerClient<T>}
+ */
+export default function createClient<T>(options: CreateClientOptions<T>): APIGatewayHandlerClient<T> {
+  const client = createLambdaClient(options);
+  return async (event: APIGatewayEvent<string>) => parsePayload<T>(await client(jsonStringify(event)));
+}

package/lib/create-lambda-client.js

@@ -0,0 +1,45 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = createLambdaClient;
+exports.LambdaInvokeError = void 0;
+
+class LambdaInvokeError extends Error {
+  constructor(response) {
+    var _response$FunctionErr;
+
+    super(["Invocation Failed", response.ExecutedVersion, response.StatusCode, response.FunctionError, response.Payload, response.LogResult != null ? Buffer.from(response.LogResult, "base64").toString("utf-8") : null].filter(x => x != null).join(": "));
+    this.code = (_response$FunctionErr = response.FunctionError) !== null && _response$FunctionErr !== void 0 ? _response$FunctionErr : "";
+  }
+
+}
+/**
+ * AWS Lambda SDK adapter for createClient.
+ */
+
+
+exports.LambdaInvokeError = LambdaInvokeError;
+
+function createLambdaClient({
+  Lambda,
+  FunctionName
+}) {
+  return async Payload => {
+    const invocationResponse = await Lambda.invoke({
+      FunctionName,
+      Payload
+    }).promise();
+
+    if (invocationResponse.StatusCode !== 200 || invocationResponse.FunctionError != null) {
+      throw new LambdaInvokeError(invocationResponse);
+    }
+
+    if (typeof invocationResponse.Payload !== "string") {
+      throw new Error(`AWS Lambda invocation API returned the wrong payload type '${typeof invocationResponse.Payload}'; expected 'string'`);
+    }
+
+    return invocationResponse.Payload;
+  };
+}

package/lib/create-lambda-client.js.flow

@@ -0,0 +1,80 @@
+// @flow
+
+import type { LambdaInvoke } from "./lambda-invoke";
+
+interface Blob {}
+type _Blob = Buffer | Uint8Array | Blob | string;
+type LambdaClientType = (event: _Blob) => Promise<string>;
+
+export type CreateLambdaClientOptions = {
+  Lambda: LambdaInvoke,
+  FunctionName: string
+};
+
+export type Lambda$InvocationResponse = {
+  /**
+   * The HTTP status code is in the 200 range for a successful request. For the RequestResponse invocation type, this status code is 200. For the Event invocation type, this status code is 202. For the DryRun invocation type, the status code is 204.
+   */
+  StatusCode?: number,
+
+  /**
+   * If present, indicates that an error occurred during function execution. Details about the error are included in the response payload.
+   */
+  FunctionError?: string,
+
+  /**
+   * The last 4 KB of the execution log, which is base64 encoded.
+   */
+  LogResult?: string,
+
+  /**
+   * The response from the function, or an error object.
+   */
+  Payload?: Buffer | Uint8Array | Blob | string,
+
+  /**
+   * The version of the function that executed. When you invoke a function with an alias, this indicates which version the alias resolved to.
+   */
+  ExecutedVersion?: string
+};
+
+export class LambdaInvokeError extends Error {
+  code: string;
+
+  constructor(response: Lambda$InvocationResponse) {
+    super(
+      [
+        "Invocation Failed",
+        response.ExecutedVersion,
+        response.StatusCode,
+        response.FunctionError,
+        response.Payload,
+        response.LogResult != null ? Buffer.from(response.LogResult, "base64").toString("utf-8") : null
+      ]
+        .filter(x => x != null)
+        .join(": ")
+    );
+    this.code = response.FunctionError ?? "";
+  }
+}
+
+/**
+ * AWS Lambda SDK adapter for createClient.
+ */
+export default function createLambdaClient({ Lambda, FunctionName }: CreateLambdaClientOptions): LambdaClientType {
+  return async (Payload: _Blob) => {
+    const invocationResponse = await Lambda.invoke({
+      FunctionName,
+      Payload
+    }).promise();
+    if (invocationResponse.StatusCode !== 200 || invocationResponse.FunctionError != null) {
+      throw new LambdaInvokeError(invocationResponse);
+    }
+    if (typeof invocationResponse.Payload !== "string") {
+      throw new Error(
+        `AWS Lambda invocation API returned the wrong payload type '${typeof invocationResponse.Payload}'; expected 'string'`
+      );
+    }
+    return invocationResponse.Payload;
+  };
+}

package/lib/index.js

@@ -0,0 +1,23 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "createClient", {
+  enumerable: true,
+  get: function () {
+    return _createClient.default;
+  }
+});
+Object.defineProperty(exports, "createAPIGatewayEvent", {
+  enumerable: true,
+  get: function () {
+    return _createApiGatewayEvent.default;
+  }
+});
+
+var _createClient = _interopRequireDefault(require("./create-client"));
+
+var _createApiGatewayEvent = _interopRequireDefault(require("./create-api-gateway-event"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }

package/lib/index.js.flow

@@ -0,0 +1,4 @@
+// @flow
+
+export { default as createClient } from "./create-client";
+export { default as createAPIGatewayEvent } from "./create-api-gateway-event";

package/lib/json-stringify.js

@@ -0,0 +1,23 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = jsonStringify;
+
+/**
+ * Stringify to JSON, returning a string or else throwing an exception because of unserializable input.
+ *
+ * @param value
+ * @returns {string}
+ */
+// flowlint-next-line unclear-type:off
+function jsonStringify(value) {
+  const result = JSON.stringify(value);
+
+  if (result == null) {
+    throw new Error("Cannot stringify value");
+  }
+
+  return result;
+}

package/lib/json-stringify.js.flow

@@ -0,0 +1,16 @@
+// @flow
+
+/**
+ * Stringify to JSON, returning a string or else throwing an exception because of unserializable input.
+ *
+ * @param value
+ * @returns {string}
+ */
+// flowlint-next-line unclear-type:off
+export default function jsonStringify(value: any): string {
+  const result = JSON.stringify(value);
+  if (result == null) {
+    throw new Error("Cannot stringify value");
+  }
+  return result;
+}

package/lib/lambda-invoke.js

@@ -0,0 +1 @@
+"use strict";

package/lib/lambda-invoke.js.flow

@@ -0,0 +1,10 @@
+// @flow
+
+import type { Lambda } from "aws-sdk";
+
+/**
+ * This library only needs the invoke method from aws-sdk Lambda client.
+ */
+export type LambdaInvoke = {
+  +invoke: $PropertyType<Lambda, "invoke">
+};

package/lib/parse-payload.js

@@ -0,0 +1,31 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = parsePayload;
+
+/**
+ * Decode the handler response
+ *
+ * @param payload
+ * @param validate if given, the validate function is called on the parsed response body. The function should throw an exception if the response is invalid.
+ * @returns {{headers: {[p: string]: boolean|number|string}, data: *, status: number}}
+ */
+function parsePayload(payload, validate) {
+  var _proxyResult$headers;
+
+  const proxyResult = JSON.parse(payload);
+
+  if (proxyResult.isBase64Encoded === true) {
+    throw new Error("A base64 encoded response from API Gateway handler was received, but is not supported.");
+  }
+
+  const data = JSON.parse(proxyResult.body);
+  validate === null || validate === void 0 ? void 0 : validate(data);
+  return {
+    data,
+    status: proxyResult.statusCode,
+    headers: (_proxyResult$headers = proxyResult.headers) !== null && _proxyResult$headers !== void 0 ? _proxyResult$headers : {}
+  };
+}

package/lib/parse-payload.js.flow

@@ -0,0 +1,25 @@
+// @flow
+
+import type { ProxyResult } from "@cumulusds/flow-aws-lambda";
+import type { Response } from "./response";
+
+/**
+ * Decode the handler response
+ *
+ * @param payload
+ * @param validate if given, the validate function is called on the parsed response body. The function should throw an exception if the response is invalid.
+ * @returns {{headers: {[p: string]: boolean|number|string}, data: *, status: number}}
+ */
+export default function parsePayload<T>(payload: string, validate?: T => void): Response<T> {
+  const proxyResult: ProxyResult = JSON.parse(payload);
+  if (proxyResult.isBase64Encoded === true) {
+    throw new Error("A base64 encoded response from API Gateway handler was received, but is not supported.");
+  }
+  const data: T = JSON.parse(proxyResult.body);
+  validate?.(data);
+  return {
+    data,
+    status: proxyResult.statusCode,
+    headers: proxyResult.headers ?? {}
+  };
+}

package/lib/response.js

@@ -0,0 +1 @@
+"use strict";

package/lib/response.js.flow

@@ -0,0 +1,15 @@
+// @flow
+
+/**
+ * Decoded handler response
+ */
+export type Response<T> = {|
+  // the response provided by the handler
+  data: T,
+
+  // the HTTP status code
+  status: number,
+
+  // response headers
+  headers: { [header: string]: boolean | number | string }
+|};

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "@cumulusds/aws-apig-bypass",
-  "version": "0.2.4-reusableworkflow.16.gbe881dc",
+  "version": "0.2.4",
   "description": "Client for API Gateway handlers, bypassing API Gateway by directly invoking the Lambda",
   "repository": "https://github.com/CumulusDS/aws-apig-bypass",
   "author": "Cumulus Digital Systems",
   "license": "MIT",
+  "private": false,
   "engines": {
-    "node": "^14.15.0 || ^16.0.0 || ^18.0.0 || ^19.0.0"
+    "node": ">=10"
   },
   "main": "lib/index.js",
   "src": [
@@ -14,27 +15,17 @@
     "package.json"
   ],
   "scripts": {
-    "build": "yarn run build:babel && yarn run build:flow-copy-source && yarn run build:license-checker",
+    "build": "run-p build:babel build:flow-copy-source build:license-checker",
     "build:babel": "babel src --out-dir lib --ignore test.js",
     "build:flow-copy-source": "flow-copy-source --ignore test.js src lib",
     "build:license-checker": "license-checker --csv --out var/licenses.csv",
     "clean": "shx rm -rf lib",
-    "git:commit": "git add package.json .yarn/versions && git commit -m v${npm_package_version}",
-    "git:commit:publish": "git add package.json .yarn/versions/* && git commit -m v${npm_package_version}",
-    "git:commit:version": "git add .yarn/versions/* && git commit -m 'Deferred version bump'",
     "git:push": "git push --follow-tags",
-    "git:tag": "git tag -a v${npm_package_version} -m v${npm_package_version}",
-    "npm:tag:remove": "yarn npm tag remove ${npm_package_name} $0",
-    "prerelease": "yarn version apply && yarn run version:feature $0",
-    "publish:patch": "yarn version patch && yarn publish:sync",
-    "publish:minor": "yarn version minor && yarn publish:sync",
-    "publish:major": "yarn version major && yarn publish:sync",
-    "publish:prepatch": "yarn run version:prepatch && yarn run git:push",
-    "publish:prerelease": "yarn npm publish",
-    "publish:sync": "yarn run git:commit && yarn run git:tag && yarn git:push",
+    "publish:patch": "run-s version:patch git:push",
+    "publish:minor": "run-s version:minor git:push",
+    "publish:major": "run-s version:major git:push",
     "sites": "node bin/sites.js",
-    "test": "yarn run test:flow && yarn run test:jest && yarn run test:lint && yarn run test:prettier",
-    "test:flow": "yarn run test:flow:coverage-report && yarn run test:flow:status",
+    "test": "run-p --aggregate-output test:**",
     "test:flow:coverage-report": "flow-coverage-report -i '{src,test}/**/*.js' -t html -t text --threshold 99 --output-dir var/coverage/flow",
     "test:flow:status": "flow status",
     "test:jest": "jest --color",
@@ -42,10 +33,7 @@
     "test:prettier": "prettier --list-different \"{src,test}/**/*.{js,jsx,yml}\" \"*.{js,yml}\"",
     "version:patch": "yarn version --new-version patch",
     "version:minor": "yarn version --new-version minor",
-    "version:major": "yarn version --new-version major",
-    "version:feature": "yarn version ${npm_package_version}-$0.$(git describe | rev | cut -d '-' -f 2 | rev).g$(git rev-parse --short HEAD)",
-    "version:prepatch": "yarn version --new-version prepatch",
-    "version:prerelease": "yarn version ${npm_package_version}"
+    "version:major": "yarn version --new-version major"
   },
   "jest": {
     "verbose": true,
@@ -92,9 +80,8 @@
     "git-describe": "^4.0.4",
     "jest": "^26.0.0",
     "license-checker": "^25.0.1",
+    "npm-run-all": "^4.1.3",
     "prettier": "^1.14.0",
     "shx": "^0.3.2"
-  },
-  "packageManager": "yarn@3.5.0",
-  "stableVersion": "0.2.4"
-}
+  }
+}