Fix amplifyApiEnvironmentName in non sandbox environments (#2730)

Author: sobolk

.changeset/cool-olives-exist.md

@@ -0,0 +1,5 @@
+---
+'@aws-amplify/backend-data': patch
+---
+
+Fix amplifyApiEnvironmentName in non sandbox environments

packages/backend-data/src/convert_js_resolvers.test.ts

@@ -24,11 +24,11 @@ const testSchema = /* GraphQL */ `
   }
 `;
 
-const createStackAndSetContext = (): Stack => {
+const createStackAndSetContext = (backendType: 'sandbox' | 'branch'): Stack => {
   const app = new App();
   app.node.setContext('amplify-backend-name', 'testEnvName');
   app.node.setContext('amplify-backend-namespace', 'testBackendId');
-  app.node.setContext('amplify-backend-type', 'branch');
+  app.node.setContext('amplify-backend-type', backendType);
   const stack = new Stack(app);
   return stack;
 };
@@ -60,13 +60,13 @@ void describe('defaultJsResolverCode', () => {
   });
 });
 
-void describe('convertJsResolverDefinition', () => {
+void describe('convertJsResolverDefinition - branch deployment', () => {
   let stack: Stack;
   let amplifyApi: AmplifyData;
   const authorizationModes = { apiKeyConfig: { expires: Duration.days(7) } };
 
   void beforeEach(() => {
-    stack = createStackAndSetContext();
+    stack = createStackAndSetContext('branch');
     amplifyApi = new AmplifyData(stack, 'amplifyData', {
       apiName: 'amplifyData',
       definition: AmplifyDataDefinition.fromString(testSchema),
@@ -191,6 +191,69 @@ void describe('convertJsResolverDefinition', () => {
     template.resourceCountIs('AWS::AppSync::Resolver', 1);
   });
 
+  void it('adds api id and environment name to stash for non-sandbox deployment', () => {
+    const absolutePath = resolve(
+      fileURLToPath(import.meta.url),
+      '../../lib/assets',
+      'js_resolver_handler.js',
+    );
+
+    const schema = a.schema({
+      customQuery: a
+        .query()
+        .authorization((allow) => allow.publicApiKey())
+        .returns(a.string())
+        .handler(
+          a.handler.custom({
+            entry: absolutePath,
+          }),
+        ),
+    });
+    const { jsFunctions } = schema.transform();
+    convertJsResolverDefinition(stack, amplifyApi, jsFunctions);
+
+    const template = Template.fromStack(stack);
+    template.hasResourceProperties('AWS::AppSync::Resolver', {
+      Runtime: {
+        Name: 'APPSYNC_JS',
+        RuntimeVersion: '1.0.0',
+      },
+      Kind: 'PIPELINE',
+      TypeName: 'Query',
+      FieldName: 'customQuery',
+      Code: {
+        'Fn::Join': [
+          '',
+          [
+            "/**\n * Pipeline resolver request handler\n */\nexport const request = (ctx) => {\n    ctx.stash.awsAppsyncApiId = '",
+            {
+              'Fn::GetAtt': [
+                Match.stringLikeRegexp('amplifyDataGraphQLAPI.*'),
+                'ApiId',
+              ],
+            },
+            "';\n    ctx.stash.amplifyApiEnvironmentName = 'testEnvName';\n    return {};\n};\n/**\n * Pipeline resolver response handler\n */\nexport const response = (ctx) => {\n    return ctx.prev.result;\n};\n",
+          ],
+        ],
+      },
+    });
+  });
+});
+
+void describe('convertJsResolverDefinition - sandbox deployment', () => {
+  let stack: Stack;
+  let amplifyApi: AmplifyData;
+  const authorizationModes = { apiKeyConfig: { expires: Duration.days(7) } };
+
+  void beforeEach(() => {
+    stack = createStackAndSetContext('sandbox');
+    amplifyApi = new AmplifyData(stack, 'amplifyData', {
+      apiName: 'amplifyData',
+      definition: AmplifyDataDefinition.fromString(testSchema),
+      authorizationModes,
+    });
+  });
+
   void it('adds api id and environment name to stash', () => {
     const absolutePath = resolve(
       fileURLToPath(import.meta.url),

packages/backend-data/src/convert_js_resolvers.ts

@@ -7,6 +7,7 @@ import { fileURLToPath } from 'node:url';
 import { readFileSync } from 'fs';
 import { Asset } from 'aws-cdk-lib/aws-s3-assets';
 import { resolveEntryPath } from './resolve_entry_path.js';
+import { CDKContextKey } from '@aws-amplify/platform-core';
 
 const APPSYNC_PIPELINE_RESOLVER = 'PIPELINE';
 const APPSYNC_JS_RUNTIME_NAME = 'APPSYNC_JS';
@@ -78,8 +79,11 @@ export const convertJsResolverDefinition = (
 
     const resolverName = `Resolver_${resolver.typeName}_${resolver.fieldName}`;
 
-    const amplifyApiEnvironmentName =
-      scope.node.tryGetContext('amplifyEnvironmentName') ?? 'NONE';
+    const isSandboxDeployment =
+      scope.node.tryGetContext(CDKContextKey.DEPLOYMENT_TYPE) === 'sandbox';
+    const amplifyApiEnvironmentName = isSandboxDeployment
+      ? 'NONE'
+      : scope.node.tryGetContext(CDKContextKey.BACKEND_NAME);
     new CfnResolver(scope, resolverName, {
       apiId: amplifyApi.apiId,
       fieldName: resolver.fieldName,