ensure typed shim files contain only the function name (#1108)

* ensure typed shim files contain only the function name

* change check to onDelete

* refactor FunctionEnvironmentTypeGenerator

* small nit

Author: rtpascual

.changeset/smart-crews-serve.md

@@ -0,0 +1,6 @@
+---
+'@aws-amplify/integration-tests': patch
+'@aws-amplify/backend-function': patch
+---
+
+Ensure typed shim files contain only the function name

packages/backend-function/src/factory.ts

@@ -26,6 +26,7 @@ import {
   FunctionOutput,
   functionOutputKey,
 } from '@aws-amplify/backend-output-schemas';
+import { FunctionEnvironmentTypeGenerator } from './function_env_type_generator.js';
 
 /**
  * Entry point for defining a function in the Amplify ecosystem
@@ -292,7 +293,8 @@ class AmplifyFunction
     this.functionEnvironmentTranslator = new FunctionEnvironmentTranslator(
       functionLambda,
       props.environment,
-      backendSecretResolver
+      backendSecretResolver,
+      new FunctionEnvironmentTypeGenerator(id)
     );
 
     this.resources = {

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

@@ -12,6 +12,7 @@ import assert from 'node:assert';
 import { ParameterPathConversions } from '@aws-amplify/platform-core';
 import { Code, Function, Runtime } from 'aws-cdk-lib/aws-lambda';
 import { Template } from 'aws-cdk-lib/assertions';
+import { FunctionEnvironmentTypeGenerator } from './function_env_type_generator.js';
 
 const testStack = {} as Construct;
 
@@ -21,6 +22,8 @@ const testBackendIdentifier: BackendIdentifier = {
   type: 'branch',
 };
 
+const testLambdaName = 'testFunction';
+
 class TestBackendSecretResolver implements BackendSecretResolver {
   resolveSecret = (backendSecret: BackendSecret): SecretValue => {
     return backendSecret.resolve(testStack, testBackendIdentifier);
@@ -62,7 +65,8 @@ void describe('FunctionEnvironmentTranslator', () => {
     new FunctionEnvironmentTranslator(
       testLambda,
       functionEnvProp,
-      backendResolver
+      backendResolver,
+      new FunctionEnvironmentTypeGenerator(testLambdaName)
     );
 
     const template = Template.fromStack(Stack.of(testLambda));
@@ -88,7 +92,8 @@ void describe('FunctionEnvironmentTranslator', () => {
     new FunctionEnvironmentTranslator(
       testLambda,
       functionEnvProp,
-      backendResolver
+      backendResolver,
+      new FunctionEnvironmentTypeGenerator(testLambdaName)
     );
 
     const template = Template.fromStack(Stack.of(testLambda));
@@ -121,7 +126,8 @@ void describe('FunctionEnvironmentTranslator', () => {
         new FunctionEnvironmentTranslator(
           getTestLambda(),
           functionEnvProp,
-          backendResolver
+          backendResolver,
+          new FunctionEnvironmentTypeGenerator(testLambdaName)
         )
     );
   });
@@ -136,7 +142,8 @@ void describe('FunctionEnvironmentTranslator', () => {
     new FunctionEnvironmentTranslator(
       testLambda,
       functionEnvProp,
-      backendResolver
+      backendResolver,
+      new FunctionEnvironmentTypeGenerator(testLambdaName)
     );
 
     const template = Template.fromStack(Stack.of(testLambda));
@@ -154,7 +161,8 @@ void describe('FunctionEnvironmentTranslator', () => {
     new FunctionEnvironmentTranslator(
       testLambda,
       functionEnvProp,
-      backendResolver
+      backendResolver,
+      new FunctionEnvironmentTypeGenerator(testLambdaName)
     );
 
     const template = Template.fromStack(Stack.of(testLambda));
@@ -216,7 +224,7 @@ void describe('FunctionEnvironmentTranslator', () => {
 });
 
 const getTestLambda = () =>
-  new Function(new Stack(new App()), 'testFunction', {
+  new Function(new Stack(new App()), testLambdaName, {
     code: Code.fromInline('test code'),
     runtime: Runtime.NODEJS_20_X,
     handler: 'handler',

packages/backend-function/src/function_env_translator.ts

@@ -26,7 +26,8 @@ export class FunctionEnvironmentTranslator {
   constructor(
     private readonly lambda: NodejsFunction, // we need to use a specific type here so that we have all the method goodies
     private readonly functionEnvironmentProp: Required<FunctionProps>['environment'],
-    private readonly backendSecretResolver: BackendSecretResolver
+    private readonly backendSecretResolver: BackendSecretResolver,
+    private readonly functionEnvironmentTypeGenerator: FunctionEnvironmentTypeGenerator
   ) {
     for (const [key, value] of Object.entries(this.functionEnvironmentProp)) {
       if (key === this.amplifySsmEnvConfigKey) {
@@ -86,10 +87,9 @@ export class FunctionEnvironmentTranslator {
     // Using CDK validation mechanism as a way to generate a typed process.env shim file at the end of synthesis
     this.lambda.node.addValidation({
       validate: (): string[] => {
-        new FunctionEnvironmentTypeGenerator(
-          this.lambda.node.id,
+        this.functionEnvironmentTypeGenerator.generateTypedProcessEnvShim(
           this.amplifyBackendEnvVarNames
-        ).generateTypedProcessEnvShim();
+        );
         return [];
       },
     });

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

@@ -19,7 +19,7 @@ void describe('FunctionEnvironmentTypeGenerator', () => {
       new FunctionEnvironmentTypeGenerator('testFunction');
     const sampleStaticEnv = '_HANDLER: string;';
 
-    functionEnvironmentTypeGenerator.generateTypedProcessEnvShim();
+    functionEnvironmentTypeGenerator.generateTypedProcessEnvShim([]);
 
     // assert type definition file path
     assert.equal(
@@ -46,10 +46,10 @@ void describe('FunctionEnvironmentTypeGenerator', () => {
       };
     });
     const functionEnvironmentTypeGenerator =
-      new FunctionEnvironmentTypeGenerator('testFunction', ['TEST_ENV']);
+      new FunctionEnvironmentTypeGenerator('testFunction');
     const sampleStaticEnv = 'TEST_ENV: string;';
 
-    functionEnvironmentTypeGenerator.generateTypedProcessEnvShim();
+    functionEnvironmentTypeGenerator.generateTypedProcessEnvShim(['TEST_ENV']);
 
     // assert type definition file path
     assert.equal(
@@ -69,10 +69,10 @@ void describe('FunctionEnvironmentTypeGenerator', () => {
   void it('generated type definition file has valid syntax', async () => {
     const targetDirectory = await fsp.mkdtemp('func_env_type_gen_test');
     const functionEnvironmentTypeGenerator =
-      new FunctionEnvironmentTypeGenerator('testFunction', ['TEST_ENV']);
+      new FunctionEnvironmentTypeGenerator('testFunction');
     const filePath = `${process.cwd()}/.amplify/function-env/testFunction.ts`;
 
-    functionEnvironmentTypeGenerator.generateTypedProcessEnvShim();
+    functionEnvironmentTypeGenerator.generateTypedProcessEnvShim(['TEST_ENV']);
 
     // import to validate syntax of type definition file
     await import(pathToFileURL(filePath).toString());

packages/backend-function/src/function_env_type_generator.ts

@@ -12,10 +12,7 @@ export class FunctionEnvironmentTypeGenerator {
   /**
    * Initialize typed process.env shim file name and location
    */
-  constructor(
-    private readonly functionName: string,
-    private readonly amplifyBackendEnvVars: string[] = []
-  ) {
+  constructor(private readonly functionName: string) {
     this.typeDefFilePath = `${process.cwd()}/.amplify/function-env/${
       this.functionName
     }.ts`;
@@ -24,7 +21,7 @@ export class FunctionEnvironmentTypeGenerator {
   /**
    * Generate a typed process.env shim
    */
-  generateTypedProcessEnvShim() {
+  generateTypedProcessEnvShim(amplifyBackendEnvVars: string[]) {
     const lambdaEnvVarTypeName = 'LambdaProvidedEnvVars';
     const amplifyBackendEnvVarTypeName = 'AmplifyBackendEnvVars';
 
@@ -57,7 +54,7 @@ export class FunctionEnvironmentTypeGenerator {
       `/** 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) => {
+    amplifyBackendEnvVars.forEach((envName) => {
       const declaration = `${envName}: string;`;
 
       declarations.push(declaration);

packages/integration-tests/src/test-project-setup/data_storage_auth_with_triggers.ts

@@ -236,6 +236,13 @@ class DataStorageAuthWithTriggerTestProject extends TestProjectBase {
       backendId,
       'AWS::IAM::Role'
     );
+
+    // ensure typed shim files are generated by checking for onDelete's typed shim
+    const typedShimStats = await fs.stat(
+      path.join(this.projectDirPath, '.amplify', 'function-env', 'onDelete.ts')
+    );
+
+    assert.ok(typedShimStats.isFile());
   }
 
   private setUpDeployEnvironment = async (