feat(client-appsync): Adds support for a new API to evaluate mapping templates with mock data, allowing you to remotely unit test your AppSync resolvers and functions.

awstools · awstools · commit 9f42ace92208 · 2022-07-26T18:30:20.000Z
diff --git a/clients/client-appsync/src/AppSync.ts b/clients/client-appsync/src/AppSync.ts
@@ -84,6 +84,11 @@ import {
   DisassociateApiCommandInput,
   DisassociateApiCommandOutput,
 } from "./commands/DisassociateApiCommand";
+import {
+  EvaluateMappingTemplateCommand,
+  EvaluateMappingTemplateCommandInput,
+  EvaluateMappingTemplateCommandOutput,
+} from "./commands/EvaluateMappingTemplateCommand";
 import {
   FlushApiCacheCommand,
   FlushApiCacheCommandInput,
@@ -772,6 +777,44 @@ export class AppSync extends AppSyncClient {
     }
   }
 
+  /**
+   * <p>Evaluates a given template and returns the response. The mapping template can be a
+   *          request or response template.</p>
+   *          <p>Request templates take the incoming request after a GraphQL operation is parsed and
+   *          convert it into a request configuration for the selected data source operation. Response
+   *          templates interpret responses from the data source and map it to the shape of the GraphQL
+   *          field output type.</p>
+   *          <p>Mapping templates are written in the Apache Velocity Template Language (VTL).</p>
+   */
+  public evaluateMappingTemplate(
+    args: EvaluateMappingTemplateCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<EvaluateMappingTemplateCommandOutput>;
+  public evaluateMappingTemplate(
+    args: EvaluateMappingTemplateCommandInput,
+    cb: (err: any, data?: EvaluateMappingTemplateCommandOutput) => void
+  ): void;
+  public evaluateMappingTemplate(
+    args: EvaluateMappingTemplateCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: EvaluateMappingTemplateCommandOutput) => void
+  ): void;
+  public evaluateMappingTemplate(
+    args: EvaluateMappingTemplateCommandInput,
+    optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EvaluateMappingTemplateCommandOutput) => void),
+    cb?: (err: any, data?: EvaluateMappingTemplateCommandOutput) => void
+  ): Promise<EvaluateMappingTemplateCommandOutput> | void {
+    const command = new EvaluateMappingTemplateCommand(args);
+    if (typeof optionsOrCb === "function") {
+      this.send(command, optionsOrCb);
+    } else if (typeof cb === "function") {
+      if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
+      this.send(command, optionsOrCb || {}, cb);
+    } else {
+      return this.send(command, optionsOrCb);
+    }
+  }
+
   /**
    * <p>Flushes an <code>ApiCache</code> object.</p>
    */
diff --git a/clients/client-appsync/src/AppSyncClient.ts b/clients/client-appsync/src/AppSyncClient.ts
@@ -71,6 +71,10 @@ import { DeleteGraphqlApiCommandInput, DeleteGraphqlApiCommandOutput } from "./c
 import { DeleteResolverCommandInput, DeleteResolverCommandOutput } from "./commands/DeleteResolverCommand";
 import { DeleteTypeCommandInput, DeleteTypeCommandOutput } from "./commands/DeleteTypeCommand";
 import { DisassociateApiCommandInput, DisassociateApiCommandOutput } from "./commands/DisassociateApiCommand";
+import {
+  EvaluateMappingTemplateCommandInput,
+  EvaluateMappingTemplateCommandOutput,
+} from "./commands/EvaluateMappingTemplateCommand";
 import { FlushApiCacheCommandInput, FlushApiCacheCommandOutput } from "./commands/FlushApiCacheCommand";
 import { GetApiAssociationCommandInput, GetApiAssociationCommandOutput } from "./commands/GetApiAssociationCommand";
 import { GetApiCacheCommandInput, GetApiCacheCommandOutput } from "./commands/GetApiCacheCommand";
@@ -138,6 +142,7 @@ export type ServiceInputTypes =
   | DeleteResolverCommandInput
   | DeleteTypeCommandInput
   | DisassociateApiCommandInput
+  | EvaluateMappingTemplateCommandInput
   | FlushApiCacheCommandInput
   | GetApiAssociationCommandInput
   | GetApiCacheCommandInput
@@ -189,6 +194,7 @@ export type ServiceOutputTypes =
   | DeleteResolverCommandOutput
   | DeleteTypeCommandOutput
   | DisassociateApiCommandOutput
+  | EvaluateMappingTemplateCommandOutput
   | FlushApiCacheCommandOutput
   | GetApiAssociationCommandOutput
   | GetApiCacheCommandOutput
diff --git a/clients/client-appsync/src/commands/EvaluateMappingTemplateCommand.ts b/clients/client-appsync/src/commands/EvaluateMappingTemplateCommand.ts
@@ -0,0 +1,107 @@
+// smithy-typescript generated code
+import { getSerdePlugin } from "@aws-sdk/middleware-serde";
+import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http";
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import {
+  FinalizeHandlerArguments,
+  Handler,
+  HandlerExecutionContext,
+  HttpHandlerOptions as __HttpHandlerOptions,
+  MetadataBearer as __MetadataBearer,
+  MiddlewareStack,
+  SerdeContext as __SerdeContext,
+} from "@aws-sdk/types";
+
+import { AppSyncClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AppSyncClient";
+import {
+  EvaluateMappingTemplateRequest,
+  EvaluateMappingTemplateRequestFilterSensitiveLog,
+  EvaluateMappingTemplateResponse,
+  EvaluateMappingTemplateResponseFilterSensitiveLog,
+} from "../models/models_0";
+import {
+  deserializeAws_restJson1EvaluateMappingTemplateCommand,
+  serializeAws_restJson1EvaluateMappingTemplateCommand,
+} from "../protocols/Aws_restJson1";
+
+export interface EvaluateMappingTemplateCommandInput extends EvaluateMappingTemplateRequest {}
+export interface EvaluateMappingTemplateCommandOutput extends EvaluateMappingTemplateResponse, __MetadataBearer {}
+
+/**
+ * <p>Evaluates a given template and returns the response. The mapping template can be a
+ *          request or response template.</p>
+ *          <p>Request templates take the incoming request after a GraphQL operation is parsed and
+ *          convert it into a request configuration for the selected data source operation. Response
+ *          templates interpret responses from the data source and map it to the shape of the GraphQL
+ *          field output type.</p>
+ *          <p>Mapping templates are written in the Apache Velocity Template Language (VTL).</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { AppSyncClient, EvaluateMappingTemplateCommand } from "@aws-sdk/client-appsync"; // ES Modules import
+ * // const { AppSyncClient, EvaluateMappingTemplateCommand } = require("@aws-sdk/client-appsync"); // CommonJS import
+ * const client = new AppSyncClient(config);
+ * const command = new EvaluateMappingTemplateCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @see {@link EvaluateMappingTemplateCommandInput} for command's `input` shape.
+ * @see {@link EvaluateMappingTemplateCommandOutput} for command's `response` shape.
+ * @see {@link AppSyncClientResolvedConfig | config} for AppSyncClient's `config` shape.
+ *
+ */
+export class EvaluateMappingTemplateCommand extends $Command<
+  EvaluateMappingTemplateCommandInput,
+  EvaluateMappingTemplateCommandOutput,
+  AppSyncClientResolvedConfig
+> {
+  // Start section: command_properties
+  // End section: command_properties
+
+  constructor(readonly input: EvaluateMappingTemplateCommandInput) {
+    // Start section: command_constructor
+    super();
+    // End section: command_constructor
+  }
+
+  /**
+   * @internal
+   */
+  resolveMiddleware(
+    clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
+    configuration: AppSyncClientResolvedConfig,
+    options?: __HttpHandlerOptions
+  ): Handler<EvaluateMappingTemplateCommandInput, EvaluateMappingTemplateCommandOutput> {
+    this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize));
+
+    const stack = clientStack.concat(this.middlewareStack);
+
+    const { logger } = configuration;
+    const clientName = "AppSyncClient";
+    const commandName = "EvaluateMappingTemplateCommand";
+    const handlerExecutionContext: HandlerExecutionContext = {
+      logger,
+      clientName,
+      commandName,
+      inputFilterSensitiveLog: EvaluateMappingTemplateRequestFilterSensitiveLog,
+      outputFilterSensitiveLog: EvaluateMappingTemplateResponseFilterSensitiveLog,
+    };
+    const { requestHandler } = configuration;
+    return stack.resolve(
+      (request: FinalizeHandlerArguments<any>) =>
+        requestHandler.handle(request.request as __HttpRequest, options || {}),
+      handlerExecutionContext
+    );
+  }
+
+  private serialize(input: EvaluateMappingTemplateCommandInput, context: __SerdeContext): Promise<__HttpRequest> {
+    return serializeAws_restJson1EvaluateMappingTemplateCommand(input, context);
+  }
+
+  private deserialize(output: __HttpResponse, context: __SerdeContext): Promise<EvaluateMappingTemplateCommandOutput> {
+    return deserializeAws_restJson1EvaluateMappingTemplateCommand(output, context);
+  }
+
+  // Start section: command_body_extra
+  // End section: command_body_extra
+}
diff --git a/clients/client-appsync/src/commands/index.ts b/clients/client-appsync/src/commands/index.ts
@@ -17,6 +17,7 @@ export * from "./DeleteGraphqlApiCommand";
 export * from "./DeleteResolverCommand";
 export * from "./DeleteTypeCommand";
 export * from "./DisassociateApiCommand";
+export * from "./EvaluateMappingTemplateCommand";
 export * from "./FlushApiCacheCommand";
 export * from "./GetApiAssociationCommand";
 export * from "./GetApiCacheCommand";
diff --git a/clients/client-appsync/src/models/models_0.ts b/clients/client-appsync/src/models/models_0.ts
@@ -113,7 +113,7 @@ export interface CognitoUserPoolConfig {
 
   /**
    * <p>A regular expression for validating the incoming Amazon Cognito user pool app client
-   *          ID.</p>
+   *          ID. If this value isn't set, no filtering is applied.</p>
    */
   appIdClientRegex?: string;
 }
@@ -1250,7 +1250,7 @@ export interface DomainNameConfig {
   appsyncDomainName?: string;
 
   /**
-   * <p>The ID of your Amazon Route 53 hosted zone.</p>
+   * <p>The ID of your Amazon Route 53 hosted zone.</p>
    */
   hostedZoneId?: string;
 }
@@ -1551,7 +1551,7 @@ export interface UserPoolConfig {
 
   /**
    * <p>A regular expression for validating the incoming Amazon Cognito user pool app client
-   *          ID.</p>
+   *          ID. If this value isn't set, no filtering is applied.</p>
    */
   appIdClientRegex?: string;
 }
@@ -1694,7 +1694,7 @@ export interface CachingConfig {
    * <p>The TTL in seconds for a resolver that has caching activated.</p>
    *          <p>Valid values are 1–3,600 seconds.</p>
    */
-  ttl?: number;
+  ttl: number | undefined;
 
   /**
    * <p>The caching keys for a resolver that has caching activated.</p>
@@ -2057,6 +2057,43 @@ export interface DisassociateApiRequest {
 
 export interface DisassociateApiResponse {}
 
+export interface EvaluateMappingTemplateRequest {
+  /**
+   * <p>The mapping template; this can be a request or response template. A
+   *             <code>template</code> is required for this action.</p>
+   */
+  template: string | undefined;
+
+  /**
+   * <p>The map that holds all of the contextual information for your resolver invocation. A
+   *             <code>context</code> is required for this action.</p>
+   */
+  context: string | undefined;
+}
+
+/**
+ * <p>Contains the list of errors generated when attempting to evaluate a mapping
+ *          template.</p>
+ */
+export interface ErrorDetail {
+  /**
+   * <p>The error payload.</p>
+   */
+  message?: string;
+}
+
+export interface EvaluateMappingTemplateResponse {
+  /**
+   * <p>The mapping template; this can be a request or response template.</p>
+   */
+  evaluationResult?: string;
+
+  /**
+   * <p>The <code>ErrorDetail</code> object.</p>
+   */
+  error?: ErrorDetail;
+}
+
 /**
  * <p>Represents the input of a <code>FlushApiCache</code> operation.</p>
  */
@@ -3537,6 +3574,27 @@ export const DisassociateApiResponseFilterSensitiveLog = (obj: DisassociateApiRe
   ...obj,
 });
 
+/**
+ * @internal
+ */
+export const EvaluateMappingTemplateRequestFilterSensitiveLog = (obj: EvaluateMappingTemplateRequest): any => ({
+  ...obj,
+});
+
+/**
+ * @internal
+ */
+export const ErrorDetailFilterSensitiveLog = (obj: ErrorDetail): any => ({
+  ...obj,
+});
+
+/**
+ * @internal
+ */
+export const EvaluateMappingTemplateResponseFilterSensitiveLog = (obj: EvaluateMappingTemplateResponse): any => ({
+  ...obj,
+});
+
 /**
  * @internal
  */
diff --git a/clients/client-appsync/src/protocols/Aws_restJson1.ts b/clients/client-appsync/src/protocols/Aws_restJson1.ts
diff --git a/codegen/sdk-codegen/aws-models/appsync.json b/codegen/sdk-codegen/aws-models/appsync.json
