@adobe-commerce/aio-toolkit 1.0.12 → 1.0.13

package/CHANGELOG.md

@@ -5,6 +5,43 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.0.13] - 2026-01-07
+
+### ✨ Features
+
+- **feat(logging):** Enhanced action logging with structured data and customizable action type names
+  - Added `setActionTypeName()` and `getActionTypeName()` static methods to `RuntimeAction` for user-friendly log messages
+  - Implemented `JSON.stringify()` for complex object logging (headers, body, results) to properly handle arrays and nested structures
+  - Enhanced GraphQL action with comprehensive logging:
+    - Query parsing with parsed AST logging
+    - Validation failures with detailed error information
+    - Introspection check detection and logging
+    - Variables parsing and logging
+  - Updated all action types with consistent log message patterns:
+    - `RuntimeAction`: "Runtime action execution started/completed"
+    - `GraphQlAction`: "GraphQL action query parsed/validation failed"
+    - `OpenwhiskAction`: "OpenWhisk action execution started/completed"
+    - `EventConsumerAction`: "Event consumer action execution started/completed"
+  - Improved observability in New Relic with human-readable transaction names and structured logs
+
+### 🔧 Maintenance
+
+- **chore(scripts):** Removed deprecated `scripts/postinstall.js`
+  - Postinstall script no longer needed after telemetry package fixes
+  - Cleaner package structure without installation hooks
+
+### 📝 Technical Details
+
+- Enhanced `RuntimeAction` class with action type name customization
+- Updated `GraphQlAction` to set custom action type name via `RuntimeAction.setActionTypeName('GraphQL action')`
+- Modified logging format to use `JSON.stringify()` for headers, body, and result objects
+- Added comprehensive test coverage for:
+  - Custom action type names
+  - JSON.stringify logging format
+  - Missing headers and body graceful handling
+- All 1902 tests passing with 100% coverage maintained
+- No breaking changes - purely additive enhancements with backward compatibility
+
 ## [1.0.12] - 2026-01-06
 
 ### ✨ Features

package/dist/index.d.mts

@@ -43,8 +43,11 @@ type RuntimeActionResponseType = SuccessResponse | ErrorResponse;
 
 declare class RuntimeAction {
     private static actionType;
+    private static actionTypeName;
     static setActionType(type: string): void;
     static getActionType(): string;
+    static setActionTypeName(name: string): void;
+    static getActionTypeName(): string;
     static execute(name?: string, httpMethods?: HttpMethod[], requiredParams?: string[], requiredHeaders?: string[], action?: (params: {
         [key: string]: any;
     }, ctx: {

package/dist/index.d.ts

@@ -43,8 +43,11 @@ type RuntimeActionResponseType = SuccessResponse | ErrorResponse;
 
 declare class RuntimeAction {
     private static actionType;
+    private static actionTypeName;
     static setActionType(type: string): void;
     static getActionType(): string;
+    static setActionTypeName(name: string): void;
+    static getActionTypeName(): string;
     static execute(name?: string, httpMethods?: HttpMethod[], requiredParams?: string[], requiredHeaders?: string[], action?: (params: {
         [key: string]: any;
     }, ctx: {

package/dist/index.js

@@ -1557,6 +1557,23 @@ var _RuntimeAction = class _RuntimeAction {
   static getActionType() {
     return _RuntimeAction.actionType;
   }
+  /**
+   * Sets the action type name for the next action execution
+   * This is used for logging to identify different action types
+   * (runtime-action, webhook-action, event-consumer-action, etc.)
+   *
+   * @param name - The action type name identifier
+   */
+  static setActionTypeName(name) {
+    _RuntimeAction.actionTypeName = name;
+  }
+  /**
+   * Gets the current action type name
+   * @returns The current action type name identifier
+   */
+  static getActionTypeName() {
+    return _RuntimeAction.actionTypeName;
+  }
   /**
    * Creates a runtime action handler with validation, logging, and telemetry
    *
@@ -1617,17 +1634,20 @@ var _RuntimeAction = class _RuntimeAction {
       const logger = telemetry_default.createLogger(name, params);
       try {
         logger.debug({
-          message: `${name}-started`,
-          action_name: name
-        });
-        logger.debug({
-          message: `${name}-headers`,
-          headers: params.__ow_headers || {}
-        });
-        logger.debug({
-          message: `${name}-body`,
-          body: params.__ow_body || {}
+          message: `${_RuntimeAction.getActionTypeName()} execution started`
         });
+        logger.debug(
+          JSON.stringify({
+            message: `${_RuntimeAction.getActionTypeName()} headers received`,
+            headers: params.__ow_headers || {}
+          })
+        );
+        logger.debug(
+          JSON.stringify({
+            message: `${_RuntimeAction.getActionTypeName()} body received`,
+            body: params.__ow_body || {}
+          })
+        );
         const validationError = _RuntimeAction.validateRequest(
           params,
           requiredParams,
@@ -1640,21 +1660,23 @@ var _RuntimeAction = class _RuntimeAction {
           return validationError;
         }
         const result = await action(params, { logger, headers: params.__ow_headers || {} });
-        logger.debug({
-          message: `${name}-completed`,
-          result
-        });
+        logger.debug(
+          JSON.stringify({
+            message: `${_RuntimeAction.getActionTypeName()} execution completed`,
+            result
+          })
+        );
         return result;
       } catch (error) {
         if (error instanceof Error) {
           logger.error({
-            message: `${name}-failed`,
+            message: `${_RuntimeAction.getActionTypeName()} execution failed`,
             error: error.message,
             stack: error.stack
           });
         } else {
           logger.error({
-            message: `${name}-failed`,
+            message: `${_RuntimeAction.getActionTypeName()} execution failed`,
             error
           });
         }
@@ -1696,11 +1718,11 @@ var _RuntimeAction = class _RuntimeAction {
    * }
    * ```
    */
-  static validateRequest(params, requiredParams, requiredHeaders, httpMethods, logger, name) {
+  static validateRequest(params, requiredParams, requiredHeaders, httpMethods, logger, _name) {
     const errorMessage = validator_default.checkMissingRequestInputs(params, requiredParams, requiredHeaders) ?? "";
     if (errorMessage) {
       logger.error({
-        message: `${name}-validation-failed`,
+        message: `${_RuntimeAction.getActionTypeName()} validation failed`,
         error: errorMessage
       });
       return response_default.error(400 /* BAD_REQUEST */, errorMessage);
@@ -1709,7 +1731,7 @@ var _RuntimeAction = class _RuntimeAction {
     if (httpMethods.length > 0 && !httpMethods.includes(requestMethod)) {
       const errorMessage2 = `Invalid HTTP method: ${params.__ow_method}. Allowed methods are: ${httpMethods.join(", ")}`;
       logger.error({
-        message: `${name}-validation-failed`,
+        message: `${_RuntimeAction.getActionTypeName()} validation failed`,
         error: errorMessage2
       });
       return response_default.error(405 /* METHOD_NOT_ALLOWED */, errorMessage2);
@@ -1723,6 +1745,11 @@ __name(_RuntimeAction, "RuntimeAction");
  * Can be set using setActionType() before calling execute()
  */
 _RuntimeAction.actionType = "runtime-action";
+/**
+ * Private static property to store the action type name for logging
+ * Can be set using setActionTypeName() before calling execute()
+ */
+_RuntimeAction.actionTypeName = "Runtime action";
 var RuntimeAction = _RuntimeAction;
 var runtime_action_default = RuntimeAction;
 
@@ -1790,28 +1817,27 @@ var _EventConsumerAction = class _EventConsumerAction {
       const logger = telemetry_default.createLogger(name, params);
       try {
         logger.debug({
-          message: `${name}-started`,
-          action_name: name
+          message: "Event consumer action execution started"
         });
         logger.debug({
-          message: `${name}-headers`,
+          message: "Event consumer action headers received",
           headers: params.__ow_headers || {}
         });
         logger.debug({
-          message: `${name}-parameters`,
+          message: "Event consumer action parameters received",
           parameters: params
         });
         const errorMessage = validator_default.checkMissingRequestInputs(params, requiredParams, requiredHeaders) || "";
         if (errorMessage) {
           logger.error({
-            message: `${name}-validation-failed`,
+            message: "Event consumer action validation failed",
             error: errorMessage
           });
           return response_default.error(400 /* BAD_REQUEST */, errorMessage);
         }
         const result = await action(params, { logger, headers: params.__ow_headers || {} });
         logger.debug({
-          message: `${name}-completed`,
+          message: "Event consumer action execution completed",
           result
         });
         return result;
@@ -1846,65 +1872,91 @@ var _GraphQlAction = class _GraphQlAction {
       hello: /* @__PURE__ */ __name(() => "Hello World!", "hello")
     };
   }, name = "main", disableIntrospection = false) {
-    return runtime_action_default.execute(
-      `graphql-${name}`,
-      ["GET" /* GET */, "POST" /* POST */],
-      ["query"],
-      [],
-      async (params, ctx) => {
-        let graphqlSchema;
-        try {
-          graphqlSchema = (0, import_graphql.buildSchema)(schema);
-        } catch (error) {
-          return response_default.error(400 /* BAD_REQUEST */, error.message);
+    runtime_action_default.setActionType("graphql-action");
+    runtime_action_default.setActionTypeName("GraphQL action");
+    const callback = /* @__PURE__ */ __name(async (params, ctx) => {
+      const { logger } = ctx;
+      let graphqlSchema;
+      try {
+        graphqlSchema = (0, import_graphql.buildSchema)(schema);
+      } catch (error) {
+        return response_default.error(400 /* BAD_REQUEST */, error.message);
+      }
+      const graphqlResolvers = await resolvers({
+        ...ctx,
+        ...{
+          params
         }
-        const graphqlResolvers = await resolvers({
-          ...ctx,
-          ...{
-            params
-          }
+      });
+      const context2 = {};
+      const query = params.query;
+      let parsedQuery;
+      try {
+        parsedQuery = (0, import_graphql.parse)(query);
+      } catch (error) {
+        return response_default.error(400 /* BAD_REQUEST */, error.message);
+      }
+      logger.debug(
+        JSON.stringify({
+          message: "GraphQL action query parsed",
+          query: parsedQuery
+        })
+      );
+      const validationErrors = (0, import_graphql.validate)(graphqlSchema, parsedQuery);
+      if (validationErrors.length) {
+        logger.error({
+          message: "GraphQL action query validation failed",
+          errors: validationErrors
         });
-        const context2 = {};
-        const query = params.query;
-        let parsedQuery;
-        try {
-          parsedQuery = (0, import_graphql.parse)(query);
-        } catch (error) {
-          return response_default.error(400 /* BAD_REQUEST */, error.message);
-        }
-        const validationErrors = (0, import_graphql.validate)(graphqlSchema, parsedQuery);
-        if (validationErrors.length) {
+        return response_default.error(
+          400 /* BAD_REQUEST */,
+          validationErrors.map((err) => err.message).join(", ")
+        );
+      }
+      if (disableIntrospection) {
+        logger.debug({
+          message: "GraphQL action introspection check disabled"
+        });
+        const isIntrospectionQuery = parsedQuery.definitions.some(
+          (definition) => definition.selectionSet.selections.some(
+            (selection) => selection.name.value.startsWith("__")
+          )
+        );
+        if (isIntrospectionQuery) {
+          logger.error({
+            message: "GraphQL action introspection query detected",
+            query: parsedQuery
+          });
           return response_default.error(
             400 /* BAD_REQUEST */,
-            validationErrors.map((err) => err.message).join(", ")
+            "Introspection is disabled for security reasons."
           );
         }
-        if (disableIntrospection) {
-          const isIntrospectionQuery = parsedQuery.definitions.some(
-            (definition) => definition.selectionSet.selections.some(
-              (selection) => selection.name.value.startsWith("__")
-            )
-          );
-          if (isIntrospectionQuery) {
-            return response_default.error(
-              400 /* BAD_REQUEST */,
-              "Introspection is disabled for security reasons."
-            );
-          }
-        }
-        const variables = typeof params.variables === "string" ? JSON.parse(params.variables) : params.variables;
-        return response_default.success(
-          await (0, import_graphql.graphql)({
-            schema: graphqlSchema,
-            source: query,
-            rootValue: graphqlResolvers,
-            contextValue: context2,
-            variableValues: variables,
-            operationName: params.operationName
-          })
-        );
       }
+      const variables = typeof params.variables === "string" ? JSON.parse(params.variables) : params.variables;
+      logger.debug({
+        message: "GraphQL action variables parsed",
+        variables
+      });
+      return response_default.success(
+        await (0, import_graphql.graphql)({
+          schema: graphqlSchema,
+          source: query,
+          rootValue: graphqlResolvers,
+          contextValue: context2,
+          variableValues: variables,
+          operationName: params.operationName
+        })
+      );
+    }, "callback");
+    const graphqlAction = runtime_action_default.execute(
+      `graphql-${name}`,
+      ["GET" /* GET */, "POST" /* POST */],
+      ["query"],
+      [],
+      callback
     );
+    return telemetry_default.initialize(graphqlAction);
   }
 };
 __name(_GraphQlAction, "GraphQlAction");
@@ -1991,29 +2043,28 @@ var _OpenwhiskAction = class _OpenwhiskAction {
       const logger = telemetry_default.createLogger(name, params);
       try {
         logger.debug({
-          message: `${name}-started`,
-          action_name: name
+          message: "OpenWhisk action execution started"
         });
         logger.debug({
-          message: `${name}-params`,
+          message: "OpenWhisk action parameters received",
           params
         });
         const result = await action(params, { logger, headers: params.__ow_headers || {} });
         logger.debug({
-          message: `${name}-completed`,
+          message: "OpenWhisk action execution completed",
           result
         });
         return result;
       } catch (error) {
         if (error instanceof Error) {
           logger.error({
-            message: `${name}-failed`,
+            message: "OpenWhisk action execution failed",
             error: error.message,
             stack: error.stack
           });
         } else {
           logger.error({
-            message: `${name}-failed`,
+            message: "OpenWhisk action execution failed",
             error
           });
         }
@@ -2578,7 +2629,7 @@ var _WebhookAction = class _WebhookAction {
         const verificationErrorMessage = await verifySignature(params);
         if (verificationErrorMessage) {
           logger.error({
-            message: `${name}-signature-verification-failed`,
+            message: "Webhook actionsignature verification failed",
             error: verificationErrorMessage
           });
           const verificationErrorResponse = response_default2.exception(verificationErrorMessage);
@@ -2592,7 +2643,7 @@ var _WebhookAction = class _WebhookAction {
       const errorMessage = validator_default.checkMissingRequestInputs(params, requiredParams, requiredHeaders) ?? "";
       if (errorMessage) {
         logger.error({
-          message: `${name}-validation-failed`,
+          message: "Webhook action validation failed",
           error: errorMessage
         });
         const errorMessageResponse = response_default2.exception(errorMessage);
@@ -2602,6 +2653,7 @@ var _WebhookAction = class _WebhookAction {
       return response_default.success(JSON.stringify(response));
     }, "callback");
     runtime_action_default.setActionType("webhook-action");
+    runtime_action_default.setActionTypeName("Webhook action");
     return runtime_action_default.execute(name, httpMethods, [], [], callback);
   }
 };