@whook/gcp-functions 9.0.1 → 10.0.0

package/package.json

@@ -1,19 +1,17 @@
 {
   "name": "@whook/gcp-functions",
-  "version": "9.0.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,50 +48,42 @@
   },
   "homepage": "https://github.com/nfroidure/whook",
   "dependencies": {
-    "@whook/cli": "^9.0.1",
-    "@whook/cors": "^9.0.1",
-    "@whook/http-router": "^9.0.1",
-    "@whook/whook": "^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": "^6.3.0",
-    "common-services": "^10.0.2",
+    "camelcase": "^7.0.0",
+    "common-services": "^11.0.1",
     "cpr": "3.0.1",
-    "knifecycle": "^12.0.4",
+    "knifecycle": "^14.0.0",
     "mkdirp": "^1.0.4",
-    "openapi-types": "^11.0.1",
+    "openapi-types": "^12.0.0",
     "qs": "^6.10.3",
-    "strict-qs": "^6.1.5",
-    "yerror": "^6.0.2"
+    "strict-qs": "^7.0.0",
+    "yerror": "^6.1.1"
   },
   "devDependencies": {
-    "@babel/cli": "^7.17.10",
-    "@babel/core": "^7.18.2",
-    "@babel/eslint-parser": "^7.18.2",
-    "@babel/plugin-proposal-class-properties": "^7.17.12",
-    "@babel/plugin-proposal-object-rest-spread": "^7.18.0",
-    "@babel/plugin-syntax-dynamic-import": "^7.8.3",
-    "@babel/plugin-syntax-import-meta": "^7.10.4",
-    "@babel/preset-env": "^7.18.2",
-    "@babel/preset-typescript": "^7.17.12",
-    "@babel/register": "^7.17.7",
-    "@types/jest": "^27.0.2",
-    "@typescript-eslint/eslint-plugin": "^5.26.0",
-    "@typescript-eslint/parser": "^5.26.0",
-    "babel-plugin-knifecycle": "^5.0.3",
-    "eslint": "^8.16.0",
+    "@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": "11.2.1",
+    "metapak-nfroidure": "12.1.0",
     "prettier": "^2.6.2",
     "rimraf": "^3.0.2",
-    "typescript": "^4.7.2"
+    "typescript": "^4.7.3"
   },
   "contributors": [],
   "engines": {
-    "node": ">=12.19.0"
+    "node": ">=16.15.0"
   },
   "files": [
     "dist",
@@ -105,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": {
@@ -137,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",
@@ -194,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": "a5620b3eacf3b500a5db59db9997bf7ed60668d5"
+  "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,

package/src/index.ts

@@ -4,14 +4,16 @@ 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,
@@ -25,7 +27,6 @@ import type {
 } from 'knifecycle';
 import type {
   WhookOperation,
-  WhookCompilerConfig,
   WhookCompilerOptions,
   WhookCompilerService,
 } from '@whook/whook';
@@ -61,6 +62,9 @@ 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<
   NonNullable<WhookAPIOperationGCPFunctionConfig['type']>,
   {
@@ -73,7 +77,10 @@ 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',
   },
@@ -85,7 +92,7 @@ export async function prepareBuildEnvironment<T extends Knifecycle>(
   $.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',
     }),
@@ -108,26 +115,23 @@ export async function runBuild(
     const {
       NODE_ENV,
       BUILD_PARALLELISM,
-      BUILD_OPTIONS,
       PROJECT_DIR,
       compiler,
       log,
       $autoload,
       API,
       buildInitializer,
-    }: WhookGCPBuildConfig &
-      Pick<WhookCompilerConfig, 'BUILD_OPTIONS'> & {
-        NODE_ENV: string;
-        PROJECT_DIR: string;
-        compiler: WhookCompilerService;
-        log: LogService;
-        $autoload: Autoloader<Initializer<Dependencies, Service>>;
-        API: OpenAPIV3.Document;
-        buildInitializer: BuildInitializer;
-      } = await $.run([
+    }: WhookGCPBuildConfig & {
+      NODE_ENV: string;
+      PROJECT_DIR: string;
+      compiler: WhookCompilerService;
+      log: LogService;
+      $autoload: Autoloader<Initializer<Dependencies, Service>>;
+      API: OpenAPIV3.Document;
+      buildInitializer: BuildInitializer;
+    } = await $.run([
       'NODE_ENV',
       '?BUILD_PARALLELISM',
-      '?BUILD_OPTIONS',
       'PROJECT_DIR',
       'process',
       'compiler',
@@ -161,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,
@@ -187,15 +190,13 @@ async function processOperations(
   {
     NODE_ENV,
     BUILD_PARALLELISM,
-    BUILD_OPTIONS,
     PROJECT_DIR,
     compiler,
     log,
     $autoload,
     buildInitializer,
-  }: Required<Pick<WhookCompilerConfig, 'BUILD_OPTIONS'>> & {
+  }: WhookGCPBuildConfig & {
     NODE_ENV: string;
-    BUILD_PARALLELISM: number;
     PROJECT_DIR: string;
     compiler: WhookCompilerService;
     log: LogService;
@@ -212,7 +213,6 @@ async function processOperations(
         {
           NODE_ENV,
           PROJECT_DIR,
-          BUILD_OPTIONS,
           compiler,
           log,
           $autoload,
@@ -229,7 +229,6 @@ async function processOperations(
       {
         NODE_ENV,
         BUILD_PARALLELISM,
-        BUILD_OPTIONS,
         PROJECT_DIR,
         compiler,
         log,
@@ -246,12 +245,11 @@ async function buildAnyLambda(
   {
     NODE_ENV,
     PROJECT_DIR,
-    BUILD_OPTIONS,
     compiler,
     log,
     $autoload,
     buildInitializer,
-  }: Required<Pick<WhookCompilerConfig, 'BUILD_OPTIONS'>> & {
+  }: {
     NODE_ENV: string;
     PROJECT_DIR: string;
     compiler: WhookCompilerService;
@@ -264,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;
@@ -275,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 || ''),
     );
@@ -293,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([
@@ -330,18 +324,10 @@ async function buildAnyLambda(
 async function buildLambdaIndex(
   rootNode: { path: string },
   buildWrapper: { name: string; path: string },
-  options: NonNullable<WhookCompilerConfig['BUILD_OPTIONS']>,
 ): 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
@@ -350,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);

package/src/services/_autoload.ts

@@ -1,11 +1,12 @@
 import { initAutoload, noop, cleanupOpenAPI } from '@whook/whook';
-import Knifecycle, {
+import {
+  Knifecycle,
   SPECIAL_PROPS,
   wrapInitializer,
   constant,
   alsoInject,
 } from 'knifecycle';
-import YError from 'yerror';
+import { YError } from 'yerror';
 import {
   dereferenceOpenAPIOperations,
   getOpenAPIOperations,
@@ -22,7 +23,7 @@ import type { WhookBuildConstantsService } from '@whook/whook';
 import type { WhookRawOperation } from '@whook/http-router';
 import type { LogService } from 'common-services';
 import type { OpenAPIV3 } from 'openapi-types';
-import type { WhookAPIOperationGCPFunctionConfig } from '..';
+import type { WhookAPIOperationGCPFunctionConfig } from '../index.js';
 
 const initializerWrapper: ServiceInitializerWrapper<
   Autoloader<Initializer<Dependencies, Service>>,

package/src/services/log.test.ts

@@ -1,4 +1,4 @@
-import initLogService from './log';
+import initLogService from './log.js';
 
 describe('initLogService', () => {
   it('should work', async () => {

package/src/wrappers/googleHTTPFunction.ts

@@ -9,10 +9,10 @@ import {
   castParameters,
 } from '@whook/http-router';
 import { reuseSpecialProps, alsoInject } from 'knifecycle';
-import Ajv from 'ajv';
-import addAJVFormats from 'ajv-formats';
+import { default as Ajv } from 'ajv';
+import { default as addAJVFormats } from 'ajv-formats';
 import bytes from 'bytes';
-import HTTPError from 'yhttperror';
+import { YHTTPError } from 'yhttperror';
 import {
   prepareParametersValidators,
   prepareBodyValidator,
@@ -328,7 +328,7 @@ async function handleForAWSHTTPFunction(
         ...('undefined' !== typeof body ? { body } : {}),
       };
     } catch (err) {
-      throw HTTPError.cast(err as Error, 400);
+      throw YHTTPError.cast(err as Error, 400);
     }
 
     response = await executeHandler(operation, handler, parameters);
@@ -354,7 +354,7 @@ async function handleForAWSHTTPFunction(
       (responseSchema.type !== 'string' || responseSchema.format !== 'binary');
 
     if (responseHasSchema && !STRINGIFYERS[response.headers['content-type']]) {
-      throw new HTTPError(
+      throw new YHTTPError(
         500,
         'E_STRINGIFYER_LACK',
         response.headers['content-type'],
@@ -370,7 +370,7 @@ async function handleForAWSHTTPFunction(
     };
     log?.('debug', JSON.stringify(responseLog));
   } catch (err) {
-    const castedError = HTTPError.cast(err as Error);
+    const castedError = YHTTPError.cast(err as Error);
 
     responseLog = {
       type: 'error',