refactor: remove sharedContext from AppSyncGraphQLResolver and related types

Author: arnabrahman

packages/event-handler/src/appsync-graphql/AppSyncGraphQLResolver.ts

@@ -2,7 +2,6 @@ import type { AppSyncResolverEvent, Context } from 'aws-lambda';
 import type {
   BatchResolverAggregateHandlerFn,
   BatchResolverHandlerFn,
-  GraphQlRouterOptions,
   ResolverHandler,
   RouteHandlerOptions,
 } from '../types/appsync-graphql.js';
@@ -43,16 +42,6 @@ import { isAppSyncGraphQLEvent } from './utils.js';
  * ```
  */
 class AppSyncGraphQLResolver extends Router {
-  /**
-   * A map to hold shared contextual data accessible to all resolver handlers.
-   */
-  public readonly sharedContext: Map<string, unknown>;
-
-  public constructor(options?: GraphQlRouterOptions) {
-    super(options);
-    this.sharedContext = new Map<string, unknown>();
-  }
-
   /**
    * Resolve the response based on the provided event and route handlers configured.
    *
@@ -172,18 +161,11 @@ class AppSyncGraphQLResolver extends Router {
         return;
       }
 
-      try {
-        return this.#withErrorHandling(
-          () => this.#executeBatchResolvers(event, context, options),
-          event[0],
-          options
-        );
-      } finally {
-        /**
-         * Clear shared context after batch processing for safety
-         */
-        this.sharedContext.clear();
-      }
+      return this.#withErrorHandling(
+        () => this.#executeBatchResolvers(event, context, options),
+        event[0],
+        options
+      );
     }
     if (!isAppSyncGraphQLEvent(event)) {
       this.logger.warn(
@@ -192,18 +174,11 @@ class AppSyncGraphQLResolver extends Router {
       return;
     }
 
-    try {
-      return this.#withErrorHandling(
-        () => this.#executeSingleResolver(event, context, options),
-        event,
-        options
-      );
-    } finally {
-      /**
-       * Clear shared context after batch processing for safety
-       */
-      this.sharedContext.clear();
-    }
+    return this.#withErrorHandling(
+      () => this.#executeSingleResolver(event, context, options),
+      event,
+      options
+    );
   }
 
   /**
@@ -244,46 +219,6 @@ class AppSyncGraphQLResolver extends Router {
     this.logger.debug('Router included successfully');
   }
 
-  /**
-   * Appends contextual data to be shared with all resolver handlers.
-   *
-   * This method allows you to add key-value pairs to the shared context that will be
-   * accessible to all resolver handlers through the `sharedContext` parameter. The context
-   * is automatically cleared after each invocation for safety.
-   *
-   * @example
-   * ```ts
-   * import { AppSyncGraphQLResolver, Router } from '@aws-lambda-powertools/event-handler/appsync-graphql';
-   *
-   * const postRouter = new Router();
-   * postRouter.onQuery('getPosts', async ({ sharedContext }) => {
-   *   const requestId = sharedContext?.get('requestId');
-   *   return [{ id: 1, title: 'Post 1', requestId }];
-   * });
-   *
-   * const userRouter = new Router();
-   * userRouter.onQuery('getUsers', async ({ sharedContext }) => {
-   *   const requestId = sharedContext?.get('requestId');
-   *   return [{ id: 1, name: 'John Doe', requestId }];
-   * });
-   *
-   * const app = new AppSyncGraphQLResolver();
-   *
-   * app.includeRouter([userRouter, postRouter]);
-   * app.appendContext({ requestId: '12345' });
-   *
-   * export const handler = async (event, context) =>
-   *   app.resolve(event, context);
-   * ```
-   *
-   * @param data - A record of key-value pairs to add to the shared context
-   */
-  public appendContext(data: Record<string, unknown>): void {
-    for (const [key, value] of Object.entries(data)) {
-      this.sharedContext.set(key, value);
-    }
-  }
-
   /**
    * Executes the provided asynchronous function with error handling.
    * If the function throws an error, it delegates error processing to `#handleError`
@@ -422,7 +357,6 @@ class AppSyncGraphQLResolver extends Router {
         {
           event: events,
           context,
-          ...this.#getSharedContextOnlyIfNotEmpty(),
         },
       ]);
 
@@ -445,7 +379,6 @@ class AppSyncGraphQLResolver extends Router {
           {
             event,
             context,
-            ...this.#getSharedContextOnlyIfNotEmpty(),
           },
         ]);
         results.push(result);
@@ -460,7 +393,6 @@ class AppSyncGraphQLResolver extends Router {
           {
             event: events[i],
             context,
-            ...this.#getSharedContextOnlyIfNotEmpty(),
           },
         ]);
         results.push(result);
@@ -508,7 +440,6 @@ class AppSyncGraphQLResolver extends Router {
           {
             event,
             context,
-            ...this.#getSharedContextOnlyIfNotEmpty(),
           },
         ]
       );
@@ -534,19 +465,6 @@ class AppSyncGraphQLResolver extends Router {
       error: 'An unknown error occurred',
     };
   }
-
-  /**
-   * Returns an object containing the shared context only if it has entries.
-   * This helps avoid passing an empty map to handlers.
-   */
-  #getSharedContextOnlyIfNotEmpty(): {
-    sharedContext: Map<string, unknown> | undefined;
-  } {
-    return {
-      sharedContext:
-        this.sharedContext.size > 0 ? this.sharedContext : undefined,
-    };
-  }
 }
 
 export { AppSyncGraphQLResolver };

packages/event-handler/src/types/appsync-graphql.ts

@@ -14,7 +14,6 @@ type BatchResolverSyncHandlerFn<
   options: {
     event: AppSyncResolverEvent<TParams, TSource>;
     context: Context;
-    sharedContext?: Map<string, unknown>;
   }
 ) => unknown;
 
@@ -26,7 +25,6 @@ type BatchResolverHandlerFn<
   options: {
     event: AppSyncResolverEvent<TParams, TSource>;
     context: Context;
-    sharedContext?: Map<string, unknown>;
   }
 ) => Promise<unknown>;
 
@@ -38,7 +36,6 @@ type BatchResolverAggregateHandlerFn<
   options: {
     event: AppSyncResolverEvent<TParams, TSource>[];
     context: Context;
-    sharedContext?: Map<string, unknown>;
   }
 ) => Promise<unknown>;
 
@@ -50,7 +47,6 @@ type BatchResolverSyncAggregateHandlerFn<
   options: {
     event: AppSyncResolverEvent<TParams, TSource>[];
     context: Context;
-    sharedContext?: Map<string, unknown>;
   }
 ) => unknown;
 
@@ -74,7 +70,6 @@ type ResolverSyncHandlerFn<TParams = Record<string, unknown>> = (
   options: {
     event: AppSyncResolverEvent<TParams>;
     context: Context;
-    sharedContext?: Map<string, unknown>;
   }
 ) => unknown;
 
@@ -83,7 +78,6 @@ type ResolverHandlerFn<TParams = Record<string, unknown>> = (
   options: {
     event: AppSyncResolverEvent<TParams>;
     context: Context;
-    sharedContext?: Map<string, unknown>;
   }
 ) => Promise<unknown>;