fix(apigateway): SAM CLI asset metadata missing from SpecRestApi (#17293)

Adds Assets metadata to RestApi resource in case if AssetApiDefinition is used. This Metadata will enable SAM
CLI to find local assets used by RestApi in the template.

It follows the same design in document [design/code-asset-metadata.md](https://github.com/aws/aws-cdk/pull/design/code-asset-metadata.md)

Fixes #14593

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

Author: moelasmar

packages/@aws-cdk/aws-apigateway/lib/api-definition.ts

@@ -3,6 +3,10 @@ import * as s3_assets from '@aws-cdk/aws-s3-assets';
 
 // keep this import separate from other imports to reduce chance for merge conflicts with v2-main
 // eslint-disable-next-line no-duplicate-imports, import/order
+import * as cxapi from '@aws-cdk/cx-api';
+import { Node } from 'constructs';
+import { CfnRestApi } from './apigateway.generated';
+import { IRestApi } from './restapi';
 import { Construct } from '@aws-cdk/core';
 
 /**
@@ -82,6 +86,15 @@ export abstract class ApiDefinition {
    * assume it's initialized. You may just use it as a construct scope.
    */
   public abstract bind(scope: Construct): ApiDefinitionConfig;
+
+  /**
+   * Called after the CFN RestApi resource has been created to allow the Api
+   * Definition to bind to it. Specifically it's required to allow assets to add
+   * metadata for tooling like SAM CLI to be able to find their origins.
+   */
+  public bindAfterCreate(_scope: Construct, _restApi: IRestApi) {
+    return;
+  }
 }
 
 /**
@@ -198,4 +211,18 @@ export class AssetApiDefinition extends ApiDefinition {
       },
     };
   }
+
+  public bindAfterCreate(scope: Construct, restApi: IRestApi) {
+    if (!scope.node.tryGetContext(cxapi.ASSET_RESOURCE_METADATA_ENABLED_CONTEXT)) {
+      return; // not enabled
+    }
+
+    if (!this.asset) {
+      throw new Error('bindToResource() must be called after bind()');
+    }
+
+    const child = Node.of(restApi).defaultChild as CfnRestApi;
+    child.addMetadata(cxapi.ASSET_RESOURCE_METADATA_PATH_KEY, this.asset.assetPath);
+    child.addMetadata(cxapi.ASSET_RESOURCE_METADATA_PROPERTY_KEY, 'BodyS3Location');
+  }
 }

packages/@aws-cdk/aws-apigateway/lib/restapi.ts

@@ -626,6 +626,9 @@ export class SpecRestApi extends RestApiBase {
       endpointConfiguration: this._configureEndpoints(props),
       parameters: props.parameters,
     });
+
+    props.apiDefinition.bindAfterCreate(this, this);
+
     this.node.defaultChild = resource;
     this.restApiId = resource.ref;
     this.restApiRootResourceId = resource.attrRootResourceId;

packages/@aws-cdk/aws-apigateway/test/api-definition.test.ts

@@ -1,7 +1,9 @@
 import '@aws-cdk/assert-internal/jest';
 import * as path from 'path';
+import { ResourcePart } from '@aws-cdk/assert-internal';
 import * as s3 from '@aws-cdk/aws-s3';
 import * as cdk from '@aws-cdk/core';
+import * as cxapi from '@aws-cdk/cx-api';
 import * as apigw from '../lib';
 
 describe('api definition', () => {
@@ -73,6 +75,23 @@ describe('api definition', () => {
       expect(synthesized.assets.length).toEqual(1);
 
     });
+
+    test('asset metadata added to RestApi resource that contains Asset Api Definition', () => {
+      const stack = new cdk.Stack();
+      stack.node.setContext(cxapi.ASSET_RESOURCE_METADATA_ENABLED_CONTEXT, true);
+      const assetApiDefinition = apigw.ApiDefinition.fromAsset(path.join(__dirname, 'sample-definition.yaml'));
+      new apigw.SpecRestApi(stack, 'API', {
+        apiDefinition: assetApiDefinition,
+      });
+
+      expect(stack).toHaveResource('AWS::ApiGateway::RestApi', {
+        Metadata: {
+          'aws:asset:path': 'asset.68497ac876de4e963fc8f7b5f1b28844c18ecc95e3f7c6e9e0bf250e03c037fb.yaml',
+          'aws:asset:property': 'BodyS3Location',
+        },
+      }, ResourcePart.CompleteDefinition);
+
+    });
   });
 
   describe('apigateway.ApiDefinition.fromBucket', () => {

packages/@aws-cdk/aws-apigateway/test/authorizers/integ.request-authorizer.lit.expected.json

@@ -72,14 +72,14 @@
             ]
           }
         },
-        "Handler": "index.handler",
         "Role": {
           "Fn::GetAtt": [
             "MyAuthorizerFunctionServiceRole8A34C19E",
             "Arn"
           ]
         },
-        "Runtime": "nodejs10.x"
+        "Handler": "index.handler",
+        "Runtime": "nodejs14.x"
       },
       "DependsOn": [
         "MyAuthorizerFunctionServiceRole8A34C19E"
@@ -313,4 +313,4 @@
       }
     }
   }
-}
+}

packages/@aws-cdk/aws-apigateway/test/authorizers/integ.request-authorizer.lit.ts

@@ -15,7 +15,7 @@ const app = new App();
 const stack = new Stack(app, 'RequestAuthorizerInteg');
 
 const authorizerFn = new lambda.Function(stack, 'MyAuthorizerFunction', {
-  runtime: lambda.Runtime.NODEJS_10_X,
+  runtime: lambda.Runtime.NODEJS_14_X,
   handler: 'index.handler',
   code: lambda.AssetCode.fromAsset(path.join(__dirname, 'integ.request-authorizer.handler')),
 });

packages/@aws-cdk/aws-apigateway/test/authorizers/integ.token-authorizer-iam-role.expected.json

@@ -72,14 +72,14 @@
             ]
           }
         },
-        "Handler": "index.handler",
         "Role": {
           "Fn::GetAtt": [
             "MyAuthorizerFunctionServiceRole8A34C19E",
             "Arn"
           ]
         },
-        "Runtime": "nodejs10.x"
+        "Handler": "index.handler",
+        "Runtime": "nodejs14.x"
       },
       "DependsOn": [
         "MyAuthorizerFunctionServiceRole8A34C19E"

packages/@aws-cdk/aws-apigateway/test/authorizers/integ.token-authorizer-iam-role.ts

@@ -16,7 +16,7 @@ const app = new App();
 const stack = new Stack(app, 'TokenAuthorizerIAMRoleInteg');
 
 const authorizerFn = new lambda.Function(stack, 'MyAuthorizerFunction', {
-  runtime: lambda.Runtime.NODEJS_10_X,
+  runtime: lambda.Runtime.NODEJS_14_X,
   handler: 'index.handler',
   code: lambda.AssetCode.fromAsset(path.join(__dirname, 'integ.token-authorizer.handler')),
 });

packages/@aws-cdk/aws-apigateway/test/authorizers/integ.token-authorizer.lit.expected.json

@@ -72,14 +72,14 @@
             ]
           }
         },
-        "Handler": "index.handler",
         "Role": {
           "Fn::GetAtt": [
             "MyAuthorizerFunctionServiceRole8A34C19E",
             "Arn"
           ]
         },
-        "Runtime": "nodejs10.x"
+        "Handler": "index.handler",
+        "Runtime": "nodejs14.x"
       },
       "DependsOn": [
         "MyAuthorizerFunctionServiceRole8A34C19E"
@@ -313,4 +313,4 @@
       }
     }
   }
-}
+}

packages/@aws-cdk/aws-apigateway/test/authorizers/integ.token-authorizer.lit.ts

@@ -15,7 +15,7 @@ const app = new App();
 const stack = new Stack(app, 'TokenAuthorizerInteg');
 
 const authorizerFn = new lambda.Function(stack, 'MyAuthorizerFunction', {
-  runtime: lambda.Runtime.NODEJS_10_X,
+  runtime: lambda.Runtime.NODEJS_14_X,
   handler: 'index.handler',
   code: lambda.AssetCode.fromAsset(path.join(__dirname, 'integ.token-authorizer.handler')),
 });

packages/@aws-cdk/aws-apigateway/test/integ.cors.expected.json

@@ -564,14 +564,14 @@
             ]
           }
         },
-        "Handler": "index.handler",
         "Role": {
           "Fn::GetAtt": [
             "handlerServiceRole187D5A5A",
             "Arn"
           ]
         },
-        "Runtime": "nodejs10.x"
+        "Handler": "index.handler",
+        "Runtime": "nodejs14.x"
       },
       "DependsOn": [
         "handlerServiceRole187D5A5A"