feat(logger): add esmodule support (#1734)

antstanley · dreamorosi · commit da523b85db60 · 2024-02-05T12:38:38.000+01:00
* feat(logger): add esm build output

* fix(Logger): Remove barrel files update references

* test(Logger): update jest/ts-jest to use ESM

* chore(Logger): remove unused lodash.merge

* fix(logger): reinstate lodash.merge

* chore(logger): revert TS assertion

* chore(logger): revert format changes

* chore(logger): update postbuild to remove incremental tsbuildinfo files

* fix(logger): correct reference to types output

* feat(logging): add middleware export

* chore(logger): replace postbuild script with echo statement

* feat(logger): add typesVersions property and barrel files to /types

* chore(logger): file not used, can be added back if needed

* chore(logger): add space back to README

* chore(logger): revert space in README
diff --git a/.gitignore b/.gitignore
@@ -50,4 +50,8 @@ tmp
 
 # TS build files
 tsconfig.tsbuildinfo
-.tsbuildinfo
+<<<<<<< HEAD
+.tsbuildinfo
+=======
+tsconfig.esm.tsbuildinfo
+>>>>>>> 0bc7960c (feat(logger): add esmodule support (#1734))
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/logger/README.md b/packages/logger/README.md
@@ -117,4 +117,4 @@ Credits for the Powertools for AWS Lambda (TypeScript) idea go to [DAZN](https:/
 
 ## License
 
-This library is licensed under the MIT-0 License. See the LICENSE file.
+This library is licensed under the MIT-0 License. See the LICENSE file.
diff --git a/packages/logger/jest.config.cjs b/packages/logger/jest.config.cjs
@@ -4,9 +4,17 @@ module.exports = {
     color: 'cyan',
   },
   runner: 'groups',
-  preset: 'ts-jest',
+  extensionsToTreatAsEsm: ['.ts'],
+  moduleNameMapper: {
+    '^(\\.{1,2}/.*)\\.js$': '$1',
+  },
   transform: {
-    '^.+\\.ts?$': 'ts-jest',
+    '^.+\\.[tj]sx?$': [
+      'ts-jest',
+      {
+        useESM: true,
+      },
+    ],
   },
   moduleFileExtensions: ['js', 'ts'],
   collectCoverageFrom: ['**/src/**/*.ts', '!**/node_modules/**'],
diff --git a/packages/logger/package.json b/packages/logger/package.json
@@ -18,19 +18,55 @@
     "test:e2e:nodejs20x": "RUNTIME=nodejs20x jest --group=e2e",
     "test:e2e": "jest --group=e2e",
     "watch": "jest --watch --group=unit",
-    "build": "tsc --build --force",
+    "build:cjs": "tsc --build --force && echo '{ \"type\": \"commonjs\" }' > lib/cjs/package.json",
+    "build:esm": "tsc --project tsconfig.esm.json && echo '{ \"type\": \"module\" }' > lib/esm/package.json",
+    "build": "npm run build:esm & npm run build:cjs",
     "lint": "eslint --ext .ts,.js --no-error-on-unmatched-pattern .",
     "lint-fix": "eslint --fix --ext .ts,.js --no-error-on-unmatched-pattern .",
     "prebuild": "rimraf ./lib",
+    "postbuild": "rimraf ./lib/*.tsbuildinfo",
     "prepack": "node ../../.github/scripts/release_patch_package_json.js ."
   },
   "lint-staged": {
     "*.{js,ts}": "npm run lint-fix"
   },
   "homepage": "https://github.com/aws-powertools/powertools-lambda-typescript/tree/main/packages/logger#readme",
   "license": "MIT-0",
-  "main": "./lib/index.js",
-  "types": "./lib/index.d.ts",
+  "type": "module",
+  "exports": {
+    ".": {
+      "require": {
+        "types": "./lib/cjs/index.d.ts",
+        "default": "./lib/cjs/index.js"
+      },
+      "import": {
+        "types": "./lib/esm/index.d.ts",
+        "default": "./lib/esm/index.js"
+      }
+    },
+    "./middleware": {
+      "import": "./lib/esm/middleware/middy.js",
+      "require": "./lib/cjs/middleware/middy.js"
+    },
+    "./types": {
+      "import": "./lib/esm/types/index.js",
+      "require": "./lib/cjs/types/index.js"
+    }
+  },
+  "typesVersions": {
+    "*": {
+      "middleware": [
+        "lib/cjs/middleware/middy.d.ts",
+        "lib/esm/middleware/middy.d.ts"
+      ],
+      "types": [
+        "lib/cjs/types/index.d.ts",
+        "lib/esm/types/index.d.ts"
+      ]
+    }
+  },
+  "types": "./lib/cjs/index.d.ts",
+  "main": "./lib/cjs/index.js",
   "devDependencies": {
     "@aws-lambda-powertools/testing-utils": "file:../testing",
     "@types/lodash.merge": "^4.6.9"
@@ -66,4 +102,4 @@
     "serverless",
     "nodejs"
   ]
-}
+}
diff --git a/packages/logger/src/Logger.ts b/packages/logger/src/Logger.ts
@@ -3,26 +3,29 @@ import { Console } from 'node:console';
 import { format } from 'node:util';
 import type { Context, Handler } from 'aws-lambda';
 import { Utility } from '@aws-lambda-powertools/commons';
-import { LogFormatterInterface, PowertoolsLogFormatter } from './formatter';
-import { LogItem } from './log';
+import { PowertoolsLogFormatter } from './formatter/PowertoolsLogFormatter.js';
+import { LogFormatterInterface } from './formatter/LogFormatterInterface.js';
+import { LogItem } from './log/LogItem.js';
 import merge from 'lodash.merge';
-import { ConfigServiceInterface, EnvironmentVariablesService } from './config';
-import { LogJsonIndent } from './types';
+import { ConfigServiceInterface } from './config/ConfigServiceInterface.js';
+import { EnvironmentVariablesService } from './config/EnvironmentVariablesService.js';
+import { LogJsonIndent } from './types/Logger.js';
 import type {
-  ClassThatLogs,
   Environment,
+  LogAttributes,
+  LogLevel,
+  LogLevelThresholds,
+} from './types/Log.js';
+import type {
+  ClassThatLogs,
   HandlerMethodDecorator,
   LambdaFunctionContext,
-  LogAttributes,
   ConstructorOptions,
   LogItemExtraInput,
   LogItemMessage,
-  LogLevel,
-  LogLevelThresholds,
   PowertoolLogData,
   HandlerOptions,
-} from './types';
-
+} from './types/Logger.js';
 /**
  * ## Intro
  * The Logger utility provides an opinionated logger with output structured as JSON.
diff --git a/packages/logger/src/config/EnvironmentVariablesService.ts b/packages/logger/src/config/EnvironmentVariablesService.ts
@@ -1,4 +1,4 @@
-import { ConfigServiceInterface } from './ConfigServiceInterface';
+import { ConfigServiceInterface } from './ConfigServiceInterface.js';
 import { EnvironmentVariablesService as CommonEnvironmentVariablesService } from '@aws-lambda-powertools/commons';
 
 /**
diff --git a/packages/logger/src/config/index.ts b/packages/logger/src/config/index.ts
diff --git a/packages/logger/src/formatter/LogFormatter.ts b/packages/logger/src/formatter/LogFormatter.ts
@@ -1,6 +1,7 @@
-import { LogFormatterInterface } from '.';
-import { LogAttributes, UnformattedAttributes } from '../types';
-import { LogItem } from '../log';
+import { LogFormatterInterface } from './LogFormatterInterface.js';
+import { LogAttributes } from '../types/Log.js';
+import { UnformattedAttributes } from '../types/Logger.js';
+import { LogItem } from '../log/LogItem.js';
 
 /**
  * Typeguard to monkey patch Error to add a cause property.
diff --git a/packages/logger/src/formatter/LogFormatterInterface.ts b/packages/logger/src/formatter/LogFormatterInterface.ts
@@ -1,5 +1,6 @@
-import { LogAttributes, UnformattedAttributes } from '../types';
-import { LogItem } from '../log';
+import { LogAttributes } from '../types/Log.js';
+import { UnformattedAttributes } from '../types/Logger.js';
+import { LogItem } from '../log/LogItem.js';
 
 /**
  * @interface
diff --git a/packages/logger/src/formatter/PowertoolsLogFormatter.ts b/packages/logger/src/formatter/PowertoolsLogFormatter.ts
@@ -1,7 +1,8 @@
-import { LogFormatter } from '.';
-import { LogAttributes, UnformattedAttributes } from '../types';
-import { PowertoolsLog } from '../types/formats';
-import { LogItem } from '../log';
+import { LogFormatter } from './LogFormatter.js';
+import { LogAttributes } from '../types/Log.js';
+import { UnformattedAttributes } from '../types/Logger.js';
+import { PowertoolsLog } from '../types/formats/PowertoolsLog.js';
+import { LogItem } from '../log/LogItem.js';
 
 /**
  * This class is used to transform a set of log key-value pairs
diff --git a/packages/logger/src/formatter/index.ts b/packages/logger/src/formatter/index.ts
diff --git a/packages/logger/src/index.ts b/packages/logger/src/index.ts
@@ -1,3 +1,5 @@
-export * from './Logger';
-export * from './middleware';
-export * from './formatter';
+export { Logger } from './Logger.js';
+export { injectLambdaContext } from './middleware/middy.js';
+export { PowertoolsLogFormatter } from './formatter/PowertoolsLogFormatter.js';
+export { LogFormatter } from './formatter/LogFormatter.js';
+export { LogFormatterInterface } from './formatter/LogFormatterInterface.js';
diff --git a/packages/logger/src/log/LogItem.ts b/packages/logger/src/log/LogItem.ts
@@ -1,6 +1,6 @@
 import merge from 'lodash.merge';
-import { LogItemInterface } from '.';
-import { LogAttributes } from '../types';
+import { LogItemInterface } from './LogItemInterface.js';
+import { LogAttributes } from '../types/Log.js';
 
 class LogItem implements LogItemInterface {
   private attributes: LogAttributes = {};
diff --git a/packages/logger/src/log/LogItemInterface.ts b/packages/logger/src/log/LogItemInterface.ts
@@ -1,4 +1,4 @@
-import { LogAttributes } from '../types';
+import { LogAttributes } from '../types/Log.js';
 
 interface LogItemInterface {
   addAttributes(attributes: LogAttributes): void;
diff --git a/packages/logger/src/log/index.ts b/packages/logger/src/log/index.ts
diff --git a/packages/logger/src/middleware/index.ts b/packages/logger/src/middleware/index.ts
diff --git a/packages/logger/src/middleware/middy.ts b/packages/logger/src/middleware/middy.ts
@@ -1,5 +1,6 @@
-import { Logger } from '../Logger';
-import { HandlerOptions, LogAttributes } from '../types';
+import { Logger } from '../Logger.js';
+import { LogAttributes } from '../types/Log.js';
+import { HandlerOptions } from '../types/Logger.js';
 import { LOGGER_KEY } from '@aws-lambda-powertools/commons/lib/middleware';
 import type {
   MiddlewareLikeObj,
diff --git a/packages/logger/src/types/Logger.ts b/packages/logger/src/types/Logger.ts
@@ -4,14 +4,14 @@ import {
   SyncHandler,
 } from '@aws-lambda-powertools/commons';
 import { Handler } from 'aws-lambda';
-import { ConfigServiceInterface } from '../config';
-import { LogFormatterInterface } from '../formatter';
+import { ConfigServiceInterface } from '../config/ConfigServiceInterface.js';
+import { LogFormatterInterface } from '../formatter/LogFormatterInterface.js';
 import {
   Environment,
   LogAttributes,
   LogAttributesWithMessage,
   LogLevel,
-} from './Log';
+} from './Log.js';
 
 type ClassThatLogs = {
   [key in Exclude<Lowercase<LogLevel>, 'silent'>]: (
diff --git a/packages/logger/src/types/formats/PowertoolsLog.ts b/packages/logger/src/types/formats/PowertoolsLog.ts
@@ -1,4 +1,4 @@
-import type { LogAttributes, LogLevel } from '..';
+import type { LogAttributes, LogLevel } from '../Log.js';
 
 type PowertoolsLog = LogAttributes & {
   /**
diff --git a/packages/logger/src/types/formats/index.ts b/packages/logger/src/types/formats/index.ts
@@ -1 +1 @@
-export * from './PowertoolsLog';
+export type { PowertoolsLog } from './PowertoolsLog.js';
diff --git a/packages/logger/src/types/index.ts b/packages/logger/src/types/index.ts
@@ -1,2 +1,20 @@
-export * from './Log';
-export * from './Logger';
+export type {
+  LogAttributesWithMessage,
+  LogAttributeValue,
+  Environment,
+  LogLevelThresholds,
+  LogAttributes,
+  LogLevel,
+} from './Log.js';
+
+export type {
+  ClassThatLogs,
+  LogItemMessage,
+  LogItemExtraInput,
+  HandlerMethodDecorator,
+  LambdaFunctionContext,
+  UnformattedAttributes,
+  PowertoolLogData,
+  ConstructorOptions,
+  HandlerOptions,
+} from './Logger.js';
diff --git a/packages/logger/tests/tsconfig.json b/packages/logger/tests/tsconfig.json
@@ -1,11 +1,8 @@
 {
-    "extends": "../tsconfig.json",
-    "compilerOptions": {
-        "rootDir": "../",
-        "noEmit": true
-    },
-    "include": [
-        "../src/**/*",
-        "./**/*",
-    ]
-}
+  "extends": "../tsconfig.json",
+  "compilerOptions": {
+    "rootDir": "../",
+    "noEmit": true
+  },
+  "include": ["../src/**/*", "./**/*"]
+}
diff --git a/packages/logger/tests/unit/Logger.test.ts b/packages/logger/tests/unit/Logger.test.ts
@@ -8,19 +8,17 @@ import {
   Events as dummyEvent,
   LambdaInterface,
 } from '@aws-lambda-powertools/commons';
-import { Logger } from '../../src';
-import {
-  ConfigServiceInterface,
-  EnvironmentVariablesService,
-} from '../../src/config';
-import { PowertoolsLogFormatter, LogFormatter } from '../../src/formatter';
+import { Logger } from '../../src/Logger.js';
+import { ConfigServiceInterface } from '../../src/config/ConfigServiceInterface.js';
+import { EnvironmentVariablesService } from '../../src/config/EnvironmentVariablesService.js';
+import { PowertoolsLogFormatter } from '../../src/formatter/PowertoolsLogFormatter.js';
+import { LogFormatter } from '../../src/formatter/LogFormatter.js';
+import { LogLevelThresholds, LogLevel } from '../../src/types/Log.js';
 import {
   ClassThatLogs,
   LogJsonIndent,
   ConstructorOptions,
-  LogLevelThresholds,
-  LogLevel,
-} from '../../src/types';
+} from '../../src/types/Logger.js';
 import type { Context } from 'aws-lambda';
 import { Console } from 'console';
 
diff --git a/packages/logger/tests/unit/config/EnvironmentVariablesService.test.ts b/packages/logger/tests/unit/config/EnvironmentVariablesService.test.ts
@@ -3,7 +3,7 @@
  *
  * @group unit/logger/all
  */
-import { EnvironmentVariablesService } from '../../../src/config';
+import { EnvironmentVariablesService } from '../../../src/config/EnvironmentVariablesService.js';
 
 describe('Class: EnvironmentVariablesService', () => {
   const ENVIRONMENT_VARIABLES = process.env;
diff --git a/packages/logger/tests/unit/middleware/middy.test.ts b/packages/logger/tests/unit/middleware/middy.test.ts
@@ -8,15 +8,13 @@ import {
   Events as dummyEvent,
 } from '@aws-lambda-powertools/commons';
 import { cleanupMiddlewares } from '@aws-lambda-powertools/commons/lib/middleware';
-import {
-  ConfigServiceInterface,
-  EnvironmentVariablesService,
-} from '../../../src/config';
-import { injectLambdaContext } from '../../../src/middleware/middy';
-import { Logger } from './../../../src';
+import { ConfigServiceInterface } from '../../../src/config/ConfigServiceInterface.js';
+import { EnvironmentVariablesService } from '../../../src/config/EnvironmentVariablesService.js';
+import { injectLambdaContext } from '../../../src/middleware/middy.js';
+import { Logger } from './../../../src/Logger.js';
 import middy from '@middy/core';
-import { PowertoolsLogFormatter } from '../../../src/formatter';
-import { Console } from 'console';
+import { PowertoolsLogFormatter } from '../../../src/formatter/PowertoolsLogFormatter.js';
+import { Console } from 'node:console';
 import { Context } from 'aws-lambda';
 
 const mockDate = new Date(1466424490000);
diff --git a/packages/logger/tsconfig.esm.json b/packages/logger/tsconfig.esm.json
@@ -0,0 +1,9 @@
+{
+  "extends": "../../tsconfig.esm.json",
+  "compilerOptions": {
+    "baseUrl": ".",
+    "outDir": "./lib/esm",
+    "rootDir": "./src"
+  },
+  "include": ["./src/**/*"]
+}
diff --git a/packages/logger/tsconfig.json b/packages/logger/tsconfig.json
@@ -1,10 +1,8 @@
 {
-    "extends": "../../tsconfig.json",
-    "compilerOptions": {
-        "outDir": "./lib",
-        "rootDir": "./src",
-    },
-    "include": [
-        "./src/**/*"
-    ],
-}
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "outDir": "./lib/cjs/",
+    "rootDir": "./src"
+  },
+  "include": ["./src/**/*"]
+}
diff --git a/packages/logger/typedoc.json b/packages/logger/typedoc.json
@@ -1,8 +1,5 @@
 {
   "extends": ["../../typedoc.base.json"],
-  "entryPoints": [
-    "./src/index.ts",
-    "./src/types"
-  ],
+  "entryPoints": ["./src/index.ts", "./src/types"],
   "readme": "README.md"
-}
+}
diff --git a/tsconfig.esm.json b/tsconfig.esm.json

Original file line number	Diff line number	Diff line change
`@@ -117,4 +117,4 @@ Credits for the Powertools for AWS Lambda (TypeScript) idea go to [DAZN](https:/`
`117`	`117`
`118`	`118`	`## License`
`119`	`119`
`120`		`-This library is licensed under the MIT-0 License. See the LICENSE file.`
	`120`	`+This library is licensed under the MIT-0 License. See the LICENSE file.`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { ConfigServiceInterface } from './ConfigServiceInterface';`
	`1`	`+import { ConfigServiceInterface } from './ConfigServiceInterface.js';`
`2`	`2`	`import { EnvironmentVariablesService as CommonEnvironmentVariablesService } from '@aws-lambda-powertools/commons';`
`3`	`3`
`4`	`4`	`/**`