ensure resource access env vars are added to typed shim files (#1091)

Author: rtpascual

.changeset/modern-terms-stare.md

@@ -0,0 +1,6 @@
+---
+'@aws-amplify/integration-tests': patch
+'@aws-amplify/backend-function': patch
+---
+
+Ensure resource access env vars are added to function typed shim files

packages/backend-function/src/function_env_type_generator.test.ts

@@ -36,7 +36,7 @@ void describe('FunctionEnvironmentTypeGenerator', () => {
     mock.restoreAll();
   });
 
-  void it('generates a type definition file with dynamic environment variables', () => {
+  void it('generates a type definition file with Amplify backend environment variables', () => {
     const fdCloseMock = mock.fn();
     const fsOpenSyncMock = mock.method(fs, 'openSync');
     const fsWriteFileSyncMock = mock.method(fs, 'writeFileSync', () => null);

packages/backend-function/src/function_env_type_generator.ts

@@ -36,6 +36,9 @@ export class FunctionEnvironmentTypeGenerator {
     }
 
     // Add Lambda runtime environment variables to the typed shim
+    declarations.push(
+      `/** Lambda runtime environment variables, see https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-runtime */`
+    );
     declarations.push(`type ${lambdaEnvVarTypeName} = {`);
     for (const key in staticEnvironmentVariables) {
       const comment = `/** ${staticEnvironmentVariables[key]} */`;
@@ -50,6 +53,9 @@ export class FunctionEnvironmentTypeGenerator {
      * 1. Defined by the customer passing env vars to the environment parameter for defineFunction
      * 2. Defined by resource access mechanisms
      */
+    declarations.push(
+      `/** Amplify backend environment variables available at runtime, this includes environment variables defined in \`defineFunction\` and by cross resource mechanisms */`
+    );
     declarations.push(`type ${amplifyBackendEnvVarTypeName} = {`);
     this.amplifyBackendEnvVars.forEach((envName) => {
       const declaration = `${envName}: string;`;
@@ -58,11 +64,9 @@ export class FunctionEnvironmentTypeGenerator {
     });
     declarations.push(`};${EOL}`);
 
-    const content =
-      `/** Lambda runtime environment variables, see https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-runtime */${EOL}` +
-      `export const env = process.env as ${lambdaEnvVarTypeName} & ${amplifyBackendEnvVarTypeName};${EOL}${EOL}${declarations.join(
-        EOL
-      )}`;
+    const content = `export const env = process.env as ${lambdaEnvVarTypeName} & ${amplifyBackendEnvVarTypeName};${EOL}${EOL}${declarations.join(
+      EOL
+    )}`;
 
     fs.writeFileSync(this.typeDefFilePath, content);
   }

packages/integration-tests/src/test-projects/data-storage-auth-with-triggers-ts/.amplify/function-env/defaultNodeFunction.ts

@@ -1,9 +1,9 @@
 /**
  * This file is here to make Typescript happy for initial type checking and will be overwritten when tests run
  */
-/** Lambda runtime environment variables, see https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-runtime */
-export const env = process.env as LambdaProvidedEnvVars & DefinedEnvVars;
+export const env = process.env as LambdaProvidedEnvVars & AmplifyBackendEnvVars;
 
+/** Lambda runtime environment variables, see https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-runtime */
 type LambdaProvidedEnvVars = {
   /** The handler location configured on the function. */
   _HANDLER: string;
@@ -81,7 +81,9 @@ type LambdaProvidedEnvVars = {
   TZ: string;
 };
 
-type DefinedEnvVars = {
+/** Amplify backend environment variables available at runtime, this includes environment variables defined in `defineFunction` and by cross resource mechanisms */
+type AmplifyBackendEnvVars = {
   TEST_SECRET: string;
   TEST_SHARED_SECRET: string;
+  testName_BUCKET_NAME: string;
 };

packages/integration-tests/src/test-projects/data-storage-auth-with-triggers-ts/amplify/func-src/response_generator.ts

@@ -11,7 +11,7 @@ Amplify.configure(
   {
     Storage: {
       S3: {
-        bucket: process.env.testName_BUCKET_NAME,
+        bucket: env.testName_BUCKET_NAME,
         region: env.AWS_REGION,
       },
     },