feat(tracer): add esmodule support

examples/cdk/functions/get-all-items.ts

@@ -1,6 +1,6 @@
 import { injectLambdaContext } from '@aws-lambda-powertools/logger/middleware';
 import { logMetrics } from '@aws-lambda-powertools/metrics/middleware';
-import { captureLambdaHandler } from '@aws-lambda-powertools/tracer';
+import { captureLambdaHandler } from '@aws-lambda-powertools/tracer/middleware';
 import { ScanCommand } from '@aws-sdk/lib-dynamodb';
 import middy from '@middy/core';
 import {

examples/sam/src/get-all-items.ts

@@ -8,7 +8,7 @@ import { tableName } from './common/constants';
 import { logger, tracer, metrics } from './common/powertools';
 import { logMetrics } from '@aws-lambda-powertools/metrics/middleware';
 import { injectLambdaContext } from '@aws-lambda-powertools/logger/middleware';
-import { captureLambdaHandler } from '@aws-lambda-powertools/tracer';
+import { captureLambdaHandler } from '@aws-lambda-powertools/tracer/middleware';
 import { docClient } from './common/dynamodb-client';
 import { ScanCommand } from '@aws-sdk/lib-dynamodb';
 import { getUuid } from './common/getUuid';

packages/tracer/jest.config.js → packages/tracer/jest.config.cjs

@@ -5,6 +5,9 @@ module.exports = {
   },
   runner: 'groups',
   preset: 'ts-jest',
+  moduleNameMapper: {
+    '^(\\.{1,2}/.*)\\.js$': '$1',
+  },
   transform: {
     '^.+\\.ts?$': 'ts-jest',
   },

packages/tracer/package.json

@@ -16,19 +16,19 @@
     "test:e2e:nodejs18x": "RUNTIME=nodejs18x jest --group=e2e",
     "test:e2e": "jest --group=e2e",
     "watch": "jest --watch",
-    "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",
-    "prepack": "node ../../.github/scripts/release_patch_package_json.js ."
+    "prepack": "rimraf ./lib/*.tsbuildinfo && 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/tracer#readme",
   "license": "MIT-0",
-  "main": "./lib/index.js",
-  "types": "./lib/index.d.ts",
   "devDependencies": {
     "@aws-lambda-powertools/testing-utils": "file:../testing",
     "@aws-sdk/client-dynamodb": "^3.413.0",
@@ -46,6 +46,41 @@
       "optional": true
     }
   },
+  "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",
   "files": [
     "lib"
   ],

packages/tracer/src/Tracer.ts

@@ -3,20 +3,20 @@ import { Utility } from '@aws-lambda-powertools/commons';
 import type {
   AsyncHandler,
   SyncHandler,
+  HandlerMethodDecorator,
 } from '@aws-lambda-powertools/commons/types';
-import type { TracerInterface } from '.';
-import {
-  type ConfigServiceInterface,
-  EnvironmentVariablesService,
-} from './config';
+import { EnvironmentVariablesService } from './config/EnvironmentVariablesService.js';
+import type { ConfigServiceInterface } from './types/ConfigServiceInterface.js';
 import type {
-  HandlerMethodDecorator,
+  TracerInterface,
   TracerOptions,
+  AnyClass,
   MethodDecorator,
   CaptureLambdaHandlerOptions,
   CaptureMethodOptions,
-} from './types';
-import { ProviderService, type ProviderServiceInterface } from './provider';
+} from './types/Tracer.js';
+import { ProviderService } from './provider/ProviderService.js';
+import type { ProviderServiceInterface } from './types/ProviderServiceInterface.js';
 import { type Segment, Subsegment } from 'aws-xray-sdk-core';
 
 /**
@@ -461,7 +461,9 @@ class Tracer extends Utility implements TracerInterface {
    * @decorator Class
    * @param options - (_optional_) Options for the decorator
    */
-  public captureMethod(options?: CaptureMethodOptions): MethodDecorator {
+  public captureMethod<T extends AnyClass>(
+    options?: CaptureMethodOptions
+  ): MethodDecorator<T> {
     return (_target, propertyKey, descriptor) => {
       // The descriptor.value is the method this decorator decorates, it cannot be undefined.
       // eslint-disable-next-line @typescript-eslint/no-non-null-assertion

packages/tracer/src/config/EnvironmentVariablesService.ts

@@ -1,4 +1,4 @@
-import { ConfigServiceInterface } from './ConfigServiceInterface';
+import { ConfigServiceInterface } from '../types/ConfigServiceInterface.js';
 import { EnvironmentVariablesService as CommonEnvironmentVariablesService } from '@aws-lambda-powertools/commons';
 
 class EnvironmentVariablesService

packages/tracer/src/index.ts

@@ -1,3 +1 @@
-export * from './Tracer';
-export * from './TracerInterface';
-export * from './middleware/middy';
+export { Tracer } from './Tracer.js';

packages/tracer/src/middleware/middy.ts

@@ -1,7 +1,7 @@
 import { TRACER_KEY } from '@aws-lambda-powertools/commons';
-import type { Tracer } from '../Tracer';
+import type { Tracer } from '../Tracer.js';
 import type { Segment, Subsegment } from 'aws-xray-sdk-core';
-import type { CaptureLambdaHandlerOptions } from '../types';
+import type { CaptureLambdaHandlerOptions } from '../types/Tracer.js';
 import type {
   MiddlewareLikeObj,
   MiddyLikeRequest,

packages/tracer/src/provider/ProviderService.ts

@@ -1,6 +1,8 @@
-import { ContextMissingStrategy } from 'aws-xray-sdk-core/dist/lib/context_utils';
 import { Namespace } from 'cls-hooked';
-import { ProviderServiceInterface } from '.';
+import type {
+  ProviderServiceInterface,
+  ContextMissingStrategy,
+} from '../types/ProviderServiceInterface.js';
 import {
   captureAWS,
   captureAWSClient,
@@ -107,8 +109,8 @@ class ProviderService implements ProviderServiceInterface {
     segment.addMetadata(key, value, namespace);
   }
 
-  public setContextMissingStrategy(strategy: unknown): void {
-    setContextMissingStrategy(strategy as ContextMissingStrategy);
+  public setContextMissingStrategy(strategy: ContextMissingStrategy): void {
+    setContextMissingStrategy(strategy);
   }
 
   public setDaemonAddress(address: string): void {

packages/tracer/src/provider/ProviderServiceInterface.ts → packages/tracer/src/types/ProviderServiceInterface.ts

@@ -1,5 +1,11 @@
-import { Namespace } from 'cls-hooked';
-import { Segment, Subsegment } from 'aws-xray-sdk-core';
+import type { Namespace } from 'cls-hooked';
+import type { Segment, Subsegment } from 'aws-xray-sdk-core';
+
+type ContextMissingStrategy =
+  | 'LOG_ERROR'
+  | 'RUNTIME_ERROR'
+  | 'IGNORE_ERROR'
+  | ((msg: string) => void);
 
 interface ProviderServiceInterface {
   getNamespace(): Namespace;
@@ -12,7 +18,7 @@ interface ProviderServiceInterface {
 
   setDaemonAddress(address: string): void;
 
-  setContextMissingStrategy(strategy: unknown): void;
+  setContextMissingStrategy(strategy: ContextMissingStrategy): void;
 
   captureAWS<T>(awsservice: T): T;
 
@@ -39,4 +45,4 @@ interface ProviderServiceInterface {
   putMetadata(key: string, value: unknown, namespace?: string): void;
 }
 
-export { ProviderServiceInterface };
+export { ProviderServiceInterface, ContextMissingStrategy };

packages/tracer/src/types/Tracer.ts

@@ -1,10 +1,6 @@
-import type { ConfigServiceInterface } from '../config';
-import type { Handler } from 'aws-lambda';
-import type {
-  AsyncHandler,
-  LambdaInterface,
-  SyncHandler,
-} from '@aws-lambda-powertools/commons/types';
+import type { ConfigServiceInterface } from './ConfigServiceInterface.js';
+import type { HandlerMethodDecorator } from '@aws-lambda-powertools/commons/types';
+import type { Segment, Subsegment } from 'aws-xray-sdk-core';
 
 /**
  * Options for the tracer class to be used during initialization.
@@ -100,28 +96,51 @@ type CaptureMethodOptions = {
   captureResponse?: boolean;
 };
 
-type HandlerMethodDecorator = (
-  target: LambdaInterface,
+// eslint-disable-next-line  @typescript-eslint/no-explicit-any
+type AnyClassMethod = (...args: any[]) => any;
+// eslint-disable-next-line  @typescript-eslint/no-explicit-any
+type AnyClass = new (...args: any[]) => any;
+
+type MethodDecorator<T extends AnyClass> = (
+  target: InstanceType<T>,
   propertyKey: string | symbol,
-  descriptor:
-    | TypedPropertyDescriptor<SyncHandler<Handler>>
-    | TypedPropertyDescriptor<AsyncHandler<Handler>>
+  descriptor: TypedPropertyDescriptor<AnyClassMethod>
 ) => void;
 
-// TODO: Revisit type below & make it more specific
-type MethodDecorator = (
-  // eslint-disable-next-line  @typescript-eslint/no-explicit-any
-  target: any,
-  propertyKey: string | symbol,
-  // eslint-disable-next-line  @typescript-eslint/no-explicit-any
-  descriptor: TypedPropertyDescriptor<any>
-  // eslint-disable-next-line  @typescript-eslint/no-explicit-any
-) => any;
+interface TracerInterface {
+  addErrorAsMetadata(error: Error, remote?: boolean): void;
+  addResponseAsMetadata(data?: unknown, methodName?: string): void;
+  addServiceNameAnnotation(): void;
+  annotateColdStart(): void;
+  captureAWS<T>(aws: T): void | T;
+  captureAWSv3Client<T>(service: T): void | T;
+  captureAWSClient<T>(service: T): void | T;
+  captureLambdaHandler(
+    options?: CaptureLambdaHandlerOptions
+  ): HandlerMethodDecorator;
+  captureMethod<T extends AnyClass>(
+    options?: CaptureMethodOptions
+  ): MethodDecorator<T>;
+  getSegment(): Segment | Subsegment | undefined;
+  getRootXrayTraceId(): string | undefined;
+  isTraceSampled(): boolean;
+  isTracingEnabled(): boolean;
+  putAnnotation: (key: string, value: string | number | boolean) => void;
+  putMetadata: (
+    key: string,
+    value: unknown,
+    namespace?: string | undefined
+  ) => void;
+  setSegment(segment: Segment | Subsegment): void;
+}
 
 export {
   TracerOptions,
   CaptureLambdaHandlerOptions,
   CaptureMethodOptions,
   HandlerMethodDecorator,
+  AnyClass,
+  AnyClassMethod,
   MethodDecorator,
+  TracerInterface,
 };

packages/tracer/src/types/index.ts

@@ -1 +1,10 @@
-export * from './Tracer';
+export {
+  TracerOptions,
+  CaptureLambdaHandlerOptions,
+  CaptureMethodOptions,
+  HandlerMethodDecorator,
+  AnyClass,
+  AnyClassMethod,
+  MethodDecorator,
+  TracerInterface,
+} from './Tracer.js';

packages/tracer/tests/e2e/allFeatures.decorator.test.functionCode.ts

@@ -1,4 +1,4 @@
-import { Tracer } from '../../src';
+import { Tracer } from '../../src/Tracer.js';
 import type { Callback, Context } from 'aws-lambda';
 import AWS from 'aws-sdk';
 import axios from 'axios';
@@ -79,8 +79,6 @@ export class MyFunctionBase {
 
 class MyFunctionWithDecorator extends MyFunctionBase {
   @tracer.captureLambdaHandler()
-  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-  // @ts-ignore
   public handler(
     event: CustomEvent,
     _context: Context,
@@ -90,8 +88,6 @@ class MyFunctionWithDecorator extends MyFunctionBase {
   }
 
   @tracer.captureMethod()
-  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-  // @ts-ignore
   public myMethod(): string {
     return super.myMethod();
   }
@@ -102,8 +98,6 @@ export const handler = handlerClass.handler.bind(handlerClass);
 
 class MyFunctionWithDecoratorCaptureResponseFalse extends MyFunctionBase {
   @tracer.captureLambdaHandler({ captureResponse: false })
-  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-  // @ts-ignore
   public handler(
     event: CustomEvent,
     _context: Context,
@@ -113,8 +107,6 @@ class MyFunctionWithDecoratorCaptureResponseFalse extends MyFunctionBase {
   }
 
   @tracer.captureMethod({ captureResponse: false })
-  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-  // @ts-ignore
   public myMethod(): string {
     return super.myMethod();
   }