@whook/gcp-functions 8.5.1 → 10.0.0

package/package.json

@@ -1,19 +1,17 @@
 {
   "name": "@whook/gcp-functions",
-  "version": "8.5.1",
+  "version": "10.0.0",
   "description": "Build and deploy to GCP Cloud Functions with Whook.",
-  "main": "dist/index",
-  "module": "dist/index.mjs",
+  "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "metapak": {
     "configs": [
       "main",
       "readme",
+      "tsesm",
       "eslint",
-      "babel",
       "jest",
-      "jsdocs",
-      "typescript"
+      "jsdocs"
     ],
     "data": {
       "childPackage": true,
@@ -50,51 +48,42 @@
   },
   "homepage": "https://github.com/nfroidure/whook",
   "dependencies": {
-    "@types/bytes": "^3.1.0",
-    "@whook/cli": "^8.5.1",
-    "@whook/cors": "^8.5.1",
-    "@whook/http-router": "^8.5.0",
-    "@whook/whook": "^8.5.1",
-    "ajv": "^8.6.3",
-    "ajv-formats": "^2.1.0",
-    "camelcase": "^6.2.0",
-    "common-services": "^9.0.1",
+    "@whook/cli": "^10.0.0",
+    "@whook/cors": "^10.0.0",
+    "@whook/http-router": "^10.0.0",
+    "@whook/whook": "^10.0.0",
+    "ajv": "^8.11.0",
+    "ajv-formats": "^2.1.1",
+    "camelcase": "^7.0.0",
+    "common-services": "^11.0.1",
     "cpr": "3.0.1",
-    "knifecycle": "^11.1.1",
+    "knifecycle": "^14.0.0",
     "mkdirp": "^1.0.4",
-    "openapi-types": "^9.3.0",
-    "qs": "^6.10.1",
-    "strict-qs": "^6.1.4",
-    "yerror": "^6.0.1"
+    "openapi-types": "^12.0.0",
+    "qs": "^6.10.3",
+    "strict-qs": "^7.0.0",
+    "yerror": "^6.1.1"
   },
   "devDependencies": {
-    "@babel/cli": "^7.13.14",
-    "@babel/core": "^7.13.15",
-    "@babel/eslint-parser": "^7.13.14",
-    "@babel/plugin-proposal-class-properties": "^7.13.0",
-    "@babel/plugin-proposal-object-rest-spread": "^7.13.8",
-    "@babel/plugin-syntax-dynamic-import": "^7.8.3",
-    "@babel/plugin-syntax-import-meta": "^7.10.4",
-    "@babel/preset-env": "^7.13.15",
-    "@babel/preset-typescript": "^7.13.0",
-    "@babel/register": "^7.13.14",
-    "@types/jest": "^26.0.22",
-    "@typescript-eslint/eslint-plugin": "^4.21.0",
-    "@typescript-eslint/parser": "^4.21.0",
-    "babel-plugin-knifecycle": "^5.0.1",
-    "eslint": "^7.23.0",
-    "eslint-plugin-prettier": "^3.3.1",
-    "jest": "^26.6.3",
-    "jsdoc-to-markdown": "^7.0.1",
-    "metapak": "^4.0.2",
-    "metapak-nfroidure": "11.0.7",
-    "prettier": "^2.2.1",
+    "@types/jest": "^28.1.1",
+    "@typescript-eslint/eslint-plugin": "^5.27.0",
+    "@typescript-eslint/parser": "^5.27.0",
+    "esbuild": "^0.14.46",
+    "esbuild-jest": "^0.5.0",
+    "eslint": "^8.17.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-plugin-prettier": "^4.0.0",
+    "jest": "^28.1.0",
+    "jsdoc-to-markdown": "^7.1.1",
+    "metapak": "^4.0.4",
+    "metapak-nfroidure": "12.1.0",
+    "prettier": "^2.6.2",
     "rimraf": "^3.0.2",
-    "typescript": "^4.2.4"
+    "typescript": "^4.7.3"
   },
   "contributors": [],
   "engines": {
-    "node": ">=12.19.0"
+    "node": ">=16.15.0"
   },
   "files": [
     "dist",
@@ -106,12 +95,13 @@
   "eslintConfig": {
     "extends": [
       "eslint:recommended",
+      "plugin:prettier/recommended",
       "plugin:@typescript-eslint/eslint-recommended",
       "plugin:@typescript-eslint/recommended"
     ],
     "parserOptions": {
       "ecmaVersion": 2018,
-      "sourceType": "module",
+      "sourceType": "script",
       "modules": true
     },
     "env": {
@@ -138,53 +128,6 @@
     "trailingComma": "all",
     "proseWrap": "always"
   },
-  "babel": {
-    "presets": [
-      "@babel/typescript",
-      [
-        "@babel/env",
-        {
-          "targets": {
-            "node": "12.19.0"
-          }
-        }
-      ]
-    ],
-    "plugins": [
-      "@babel/proposal-class-properties",
-      "@babel/plugin-proposal-object-rest-spread",
-      "babel-plugin-knifecycle"
-    ],
-    "env": {
-      "cjs": {
-        "presets": [
-          [
-            "@babel/env",
-            {
-              "targets": {
-                "node": "10"
-              },
-              "modules": "commonjs"
-            }
-          ]
-        ]
-      },
-      "mjs": {
-        "presets": [
-          [
-            "@babel/env",
-            {
-              "targets": {
-                "node": "12"
-              },
-              "modules": false
-            }
-          ]
-        ]
-      }
-    },
-    "sourceMaps": true
-  },
   "jest": {
     "coverageReporters": [
       "lcov",
@@ -195,22 +138,36 @@
     ],
     "roots": [
       "<rootDir>/src"
+    ],
+    "testEnvironment": "node",
+    "transform": {
+      "^.+\\.tsx?$": [
+        "esbuild-jest",
+        {
+          "sourcemap": true,
+          "format": "esm"
+        }
+      ]
+    },
+    "moduleNameMapper": {
+      "(.+)\\.js": "$1"
+    },
+    "extensionsToTreatAsEsm": [
+      ".ts"
     ]
   },
   "scripts": {
+    "build": "rimraf -f 'dist' && tsc --outDir dist",
     "cli": "env NODE_ENV=${NODE_ENV:-cli}",
-    "compile": "rimraf -f 'dist' && npm run compile:cjs && npm run compile:mjs",
-    "compile:cjs": "babel --env-name=cjs --out-dir=dist --extensions '.ts,.js' --source-maps=true src",
-    "compile:mjs": "babel --env-name=mjs --out-file-extension=.mjs --out-dir=dist --extensions '.ts,.js' --source-maps=true src",
     "cover": "npm run jest -- --coverage",
     "doc": "echo \"# API\" > API.md; jsdoc2md 'dist/**/*.js' >> API.md && git add API.md",
     "genPackagelock": "npm i --package-lock-only",
-    "jest": "NODE_ENV=test jest",
+    "jest": "NODE_OPTIONS=--experimental-vm-modules NODE_ENV=test jest",
     "lint": "eslint 'src/**/*.ts'",
     "metapak": "metapak",
     "prettier": "prettier --write 'src/**/*.ts'",
-    "test": "npm run jest",
-    "types": "rimraf -f 'dist/**/*.d.ts' && tsc --project . --declaration --emitDeclarationOnly --outDir dist"
+    "test": "npm run jest"
   },
-  "gitHead": "0dcba31dc8a35d209dd0129675b527502dc9895c"
+  "type": "module",
+  "gitHead": "5f8f3fc82c4a95176a5ce730b416bcee59316678"
 }

package/src/commands/testHTTPFunction.ts

@@ -1,18 +1,14 @@
-import { loadLambda } from '../libs/utils';
+import { loadLambda } from '../libs/utils.js';
 import { extra, autoService } from 'knifecycle';
 import { readArgs } from '@whook/cli';
-import YError from 'yerror';
+import { YError } from 'yerror';
 import {
   dereferenceOpenAPIOperations,
   getOpenAPIOperations,
 } from '@whook/http-router';
 import stream from 'stream';
 import camelCase from 'camelcase';
-import type {
-  WhookCommandArgs,
-  WhookCommandDefinition,
-  WhookCommandNamedArgs,
-} from '@whook/cli';
+import type { WhookCommandArgs, WhookCommandDefinition } from '@whook/cli';
 import type { LogService } from 'common-services';
 import type { OpenAPIV3 } from 'openapi-types';
 
@@ -68,16 +64,13 @@ async function initTestHTTPLambdaCommand({
 }) {
   return async () => {
     const {
-      name,
-      type,
-      contentType,
-      parameters: rawParameters,
-    }: WhookCommandNamedArgs = readArgs(definition.arguments, args) as {
+      namedArguments: { name, type, contentType, parameters: rawParameters },
+    } = readArgs<{
       name: string;
       type: string;
       contentType: string;
       parameters: string;
-    };
+    }>(definition.arguments, args);
     const handler = await loadLambda(
       { PROJECT_DIR, log },
       NODE_ENV,
@@ -143,7 +136,7 @@ async function initTestHTTPLambdaCommand({
     if (hasBody) {
       gcpfRequest.headers['content-type'] = `${contentType};charset=UTF-8`;
     }
-    log('info', 'GCPF_REQUEST:', gcpfRequest);
+    log('info', 'GCPF_REQUEST:', gcpfRequest as unknown as string);
 
     const response = {
       status: 0,
@@ -151,18 +144,18 @@ async function initTestHTTPLambdaCommand({
       data: '',
     };
     await new Promise<void>((resolve, reject) => {
-      const gcpfResponse: any = new stream.PassThrough();
+      const gcpfResponse = new stream.PassThrough();
 
-      gcpfResponse.set = (name: string, value: string) => {
+      (gcpfResponse as any).set = (name: string, value: string): void => {
         response.headers[name] = value;
       };
-      gcpfResponse.status = (code: number) => {
+      (gcpfResponse as any).status = (code: number): void => {
         response.status = code;
       };
 
       handler(gcpfRequest, gcpfResponse).catch(reject);
 
-      const chunks = [];
+      const chunks = [] as Buffer[];
 
       gcpfResponse.once('end', () => {
         response.data = Buffer.concat(chunks).toString();
@@ -170,7 +163,7 @@ async function initTestHTTPLambdaCommand({
       });
       gcpfResponse.once('error', reject);
       gcpfResponse.on('readable', () => {
-        let data;
+        let data: Buffer;
         while ((data = gcpfResponse.read())) {
           chunks.push(data);
         }

package/src/index.ts

@@ -4,19 +4,27 @@ import util from 'util';
 import path from 'path';
 import mkdirp from 'mkdirp';
 import cpr from 'cpr';
-import YError from 'yerror';
-import Knifecycle, {
+import { YError } from 'yerror';
+import { createRequire } from 'module';
+import {
+  Knifecycle,
   SPECIAL_PROPS,
   constant,
   initInitializerBuilder,
 } from 'knifecycle';
-import { DEFAULT_BUILD_OPTIONS, initCompiler } from '@whook/whook';
-import initBuildAutoloader from './services/_autoload';
+import { initCompiler } from '@whook/whook';
+import initBuildAutoloader from './services/_autoload.js';
 import {
   dereferenceOpenAPIOperations,
   getOpenAPIOperations,
 } from '@whook/http-router';
-import type { Autoloader, Dependencies, BuildInitializer } from 'knifecycle';
+import type {
+  Autoloader,
+  Dependencies,
+  BuildInitializer,
+  Initializer,
+  Service,
+} from 'knifecycle';
 import type {
   WhookOperation,
   WhookCompilerOptions,
@@ -25,12 +33,10 @@ import type {
 import type { OpenAPIV3 } from 'openapi-types';
 import type { LogService } from 'common-services';
 import type { CprOptions } from 'cpr';
-import type { BuildOptions } from 'knifecycle/dist/build';
 
 export const DEFAULT_BUILD_PARALLELISM = 10;
 
-export type WhookBuildConfig = {
-  BUILD_OPTIONS?: BuildOptions;
+export type WhookGCPBuildConfig = {
   BUILD_PARALLELISM?: number;
 };
 export type WhookAPIOperationGCPFunctionConfig = {
@@ -56,8 +62,11 @@ const cprAsync = util.promisify(cpr) as (
   options: CprOptions,
 ) => Promise<string[]>;
 
+// TODO: Use import.meta when Jest will support it
+const require = createRequire(path.join(process.cwd(), 'src', 'index.ts'));
+
 const BUILD_DEFINITIONS: Record<
-  WhookAPIOperationGCPFunctionConfig['type'],
+  NonNullable<WhookAPIOperationGCPFunctionConfig['type']>,
   {
     type: string;
     wrapper: { name: string; path: string };
@@ -68,19 +77,22 @@ const BUILD_DEFINITIONS: Record<
     type: 'HTTP',
     wrapper: {
       name: 'wrapHandlerForGoogleHTTPFunction',
-      path: path.join(__dirname, 'wrappers', 'googleHTTPFunction'),
+      path: path.join(
+        path.dirname(require.resolve('@whook/gcp-function')),
+        'wrappers/googleHTTPFunction.js',
+      ),
     },
     suffix: 'Wrapped',
   },
 };
 
-export async function prepareBuildEnvironment<
-  T extends Knifecycle<Dependencies>,
->($: T = new Knifecycle() as T): Promise<T> {
+export async function prepareBuildEnvironment<T extends Knifecycle>(
+  $: T = new Knifecycle() as T,
+): Promise<T> {
   $.register(
     constant('INITIALIZER_PATH_MAP', {
       ENV: '@whook/whook/dist/services/ProxyedENV',
-      log: __dirname + '/services/log',
+      log: '@whook/gcp-functions/dist/services/log',
       time: 'common-services/dist/time',
       delay: 'common-services/dist/delay',
     }),
@@ -103,25 +115,23 @@ export async function runBuild(
     const {
       NODE_ENV,
       BUILD_PARALLELISM,
-      BUILD_OPTIONS,
       PROJECT_DIR,
       compiler,
       log,
       $autoload,
       API,
       buildInitializer,
-    }: WhookBuildConfig & {
+    }: WhookGCPBuildConfig & {
       NODE_ENV: string;
       PROJECT_DIR: string;
       compiler: WhookCompilerService;
       log: LogService;
-      $autoload: Autoloader;
+      $autoload: Autoloader<Initializer<Dependencies, Service>>;
       API: OpenAPIV3.Document;
       buildInitializer: BuildInitializer;
     } = await $.run([
       'NODE_ENV',
       '?BUILD_PARALLELISM',
-      '?BUILD_OPTIONS',
       'PROJECT_DIR',
       'process',
       'compiler',
@@ -131,7 +141,7 @@ export async function runBuild(
       'buildInitializer',
     ]);
 
-    log('info', 'Environment initialized 🚀🌕');
+    log('info', 'GCP Functions build Environment initialized 🚀🌕');
 
     const operations = (
       await dereferenceOpenAPIOperations(
@@ -155,7 +165,6 @@ export async function runBuild(
     await processOperations(
       {
         NODE_ENV,
-        BUILD_OPTIONS: BUILD_OPTIONS || DEFAULT_BUILD_OPTIONS,
         BUILD_PARALLELISM: BUILD_PARALLELISM || DEFAULT_BUILD_PARALLELISM,
         PROJECT_DIR,
         compiler,
@@ -170,8 +179,8 @@ export async function runBuild(
     // eslint-disable-next-line
     console.error(
       '💀 - Cannot launch the build:',
-      err.stack,
-      JSON.stringify(err.params, null, 2),
+      (err as YError).stack,
+      JSON.stringify((err as YError).params, null, 2),
     );
     process.exit(1);
   }
@@ -181,20 +190,17 @@ async function processOperations(
   {
     NODE_ENV,
     BUILD_PARALLELISM,
-    BUILD_OPTIONS,
     PROJECT_DIR,
     compiler,
     log,
     $autoload,
     buildInitializer,
-  }: {
+  }: WhookGCPBuildConfig & {
     NODE_ENV: string;
-    BUILD_PARALLELISM: number;
-    BUILD_OPTIONS: BuildOptions;
     PROJECT_DIR: string;
     compiler: WhookCompilerService;
     log: LogService;
-    $autoload: Autoloader;
+    $autoload: Autoloader<Initializer<Dependencies, Service>>;
     buildInitializer: BuildInitializer;
   },
   operations: WhookOperation<WhookAPIOperationGCPFunctionConfig>[],
@@ -207,7 +213,6 @@ async function processOperations(
         {
           NODE_ENV,
           PROJECT_DIR,
-          BUILD_OPTIONS,
           compiler,
           log,
           $autoload,
@@ -224,7 +229,6 @@ async function processOperations(
       {
         NODE_ENV,
         BUILD_PARALLELISM,
-        BUILD_OPTIONS,
         PROJECT_DIR,
         compiler,
         log,
@@ -241,7 +245,6 @@ async function buildAnyLambda(
   {
     NODE_ENV,
     PROJECT_DIR,
-    BUILD_OPTIONS,
     compiler,
     log,
     $autoload,
@@ -249,10 +252,9 @@ async function buildAnyLambda(
   }: {
     NODE_ENV: string;
     PROJECT_DIR: string;
-    BUILD_OPTIONS: BuildOptions;
     compiler: WhookCompilerService;
     log: LogService;
-    $autoload: Autoloader;
+    $autoload: Autoloader<Initializer<Dependencies, Service>>;
     buildInitializer: BuildInitializer;
   },
   operation: WhookOperation<WhookAPIOperationGCPFunctionConfig>,
@@ -260,8 +262,9 @@ async function buildAnyLambda(
   const { operationId } = operation;
 
   try {
-    const whookConfig: WhookAPIOperationGCPFunctionConfig =
-      operation['x-whook'] || {};
+    const whookConfig: WhookAPIOperationGCPFunctionConfig = operation[
+      'x-whook'
+    ] || { type: 'http' };
     const operationType = whookConfig.type || 'http';
     const sourceOperationId = whookConfig.sourceOperationId;
     const entryPoint = operationId;
@@ -271,7 +274,7 @@ async function buildAnyLambda(
     log('warning', `Building ${operationType} "${finalEntryPoint}"...`);
     const buildDefinition = BUILD_DEFINITIONS[operationType];
     // eslint-disable-next-line
-    const applyWrapper = require(buildDefinition.wrapper.path).default;
+    const applyWrapper = (await import(buildDefinition.wrapper.path)).default;
     const rootNode = await $autoload(
       entryPoint + (buildDefinition.suffix || ''),
     );
@@ -289,16 +292,11 @@ async function buildAnyLambda(
           ? `OPERATION_API>OPERATION_API_${finalEntryPoint}`
           : name,
       ),
-      BUILD_OPTIONS,
-    );
-    const indexContent = await buildLambdaIndex(
-      rootNode,
-      {
-        name: buildDefinition.wrapper.name,
-        path: buildDefinition.wrapper.path,
-      },
-      BUILD_OPTIONS,
     );
+    const indexContent = await buildLambdaIndex(rootNode, {
+      name: buildDefinition.wrapper.name,
+      path: buildDefinition.wrapper.path,
+    });
 
     await mkdirp(lambdaPath);
     await Promise.all([
@@ -317,27 +315,19 @@ async function buildAnyLambda(
     await buildFinalLambda({ compiler, log }, lambdaPath, whookConfig);
   } catch (err) {
     log('error', `Error building "${operationId}"...`);
-    log('stack', err.stack);
-    log('debug', JSON.stringify(err.params, null, 2));
-    throw YError.wrap(err, 'E_LAMBDA_BUILD', operationId);
+    log('error-stack', (err as Error).stack || 'no_stack_trace');
+    log('debug', JSON.stringify((err as YError).params, null, 2));
+    throw YError.wrap(err as Error, 'E_LAMBDA_BUILD', operationId);
   }
 }
 
 async function buildLambdaIndex(
   rootNode: { path: string },
   buildWrapper: { name: string; path: string },
-  options: BuildOptions,
 ): Promise<string> {
-  return `${
-    options.modules === 'commonjs'
-      ? `const pickModule = (m) => { return m && m.default || m; }
-const initHandler = pickModule(require('${rootNode.path}'));
-const ${buildWrapper.name} = pickModule(require('${buildWrapper.path}'));
-const { initialize } = require('./initialize');`
-      : `import initHandler from '${rootNode.path}';
+  return `import initHandler from '${rootNode.path}';
 import ${buildWrapper.name} from '${buildWrapper.path}';
-import { initialize } from './initialize';`
-  }
+import { initialize } from './initialize.js';
 
 const handlerInitializer = ${buildWrapper.name}(
     initHandler
@@ -346,11 +336,7 @@ const handlerInitializer = ${buildWrapper.name}(
 const handlerPromise = initialize()
   .then(handlerInitializer);
 
-${
-  options.modules === 'commonjs'
-    ? 'module.exports = {}; module.exports.default = '
-    : 'export default '
-}function handler (req, res) {
+  export default function handler (req, res) {
   return handlerPromise
   .then(handler => handler(req, res));
 };

package/src/libs/utils.ts

@@ -1,4 +1,4 @@
-import YError from 'yerror';
+import { YError } from 'yerror';
 import path from 'path';
 import type { LogService } from 'common-services';
 
@@ -19,14 +19,13 @@ export async function loadLambda(
     'builds',
     target,
     operationId,
-    type,
+    type + '.js',
   );
 
   log('debug', `⛏️ - Loading lambda module at path "${modulePath}".`);
 
   try {
-    // eslint-disable-next-line
-    const module = require(modulePath);
+    const module = await import(modulePath);
 
     if (!module) {
       throw new YError('E_MODULE_NOT_FOUND', module);
@@ -38,6 +37,6 @@ export async function loadLambda(
 
     return module.default;
   } catch (err) {
-    throw YError.wrap(err, 'E_LAMBDA_LOAD');
+    throw YError.wrap(err as Error, 'E_LAMBDA_LOAD');
   }
 }