fix(graphql-transformer-core): use addResourceDependency on aws-cdk-lib >= 2.262.0 to silence deprecation warning

Author: Simone319

packages/amplify-graphql-model-transformer/src/resources/dynamo-model-resource-generator.ts

@@ -2,7 +2,7 @@ import * as cdk from 'aws-cdk-lib';
 import { TransformerContextProvider } from '@aws-amplify/graphql-transformer-interfaces';
 import { ModelResourceIDs, ResourceConstants, SyncResourceIDs } from 'graphql-transformer-common';
 import { ObjectTypeDefinitionNode } from 'graphql';
-import { SyncUtils, setResourceName } from '@aws-amplify/graphql-transformer-core';
+import { SyncUtils, setResourceName, addCfnResourceDependency } from '@aws-amplify/graphql-transformer-core';
 import { AttributeType, CfnTable, ITable, StreamViewType, Table, TableEncryption } from 'aws-cdk-lib/aws-dynamodb';
 import { CfnDataSource } from 'aws-cdk-lib/aws-appsync';
 import * as iam from 'aws-cdk-lib/aws-iam';
@@ -139,7 +139,7 @@ export class DynamoModelResourceGenerator extends ModelResourceGenerator {
     );
 
     const cfnDataSource = dataSource.node.defaultChild as CfnDataSource;
-    cfnDataSource.addDependency(role.node.defaultChild as CfnRole);
+    addCfnResourceDependency(cfnDataSource, role.node.defaultChild as CfnRole);
 
     if (context.isProjectUsingDataStore()) {
       // eslint-disable-next-line @typescript-eslint/no-explicit-any

packages/amplify-graphql-transformer-core/src/__tests__/cfn-dependency.test.ts

@@ -0,0 +1,40 @@
+import { App, Stack, CfnResource } from 'aws-cdk-lib';
+import { Template } from 'aws-cdk-lib/assertions';
+import { addCfnResourceDependency } from '../utils/cfn-dependency';
+
+const makePair = () => {
+  const stack = new Stack(new App(), 'TestStack');
+  const target = new CfnResource(stack, 'Target', { type: 'AWS::IAM::Role', properties: {} });
+  const source = new CfnResource(stack, 'Source', { type: 'AWS::AppSync::DataSource', properties: {} });
+  return { stack, source, target };
+};
+
+describe('addCfnResourceDependency', () => {
+  it('emits a CloudFormation DependsOn entry', () => {
+    const { stack, source, target } = makePair();
+    addCfnResourceDependency(source, target);
+    const resources = Template.fromStack(stack).toJSON().Resources;
+    expect(resources.Source.DependsOn).toEqual([stack.resolve(target.logicalId)]);
+  });
+
+  it('prefers addResourceDependency when the installed CDK exposes it', () => {
+    const { source, target } = makePair();
+    const spy = jest.fn();
+    (source as unknown as Record<string, unknown>).addResourceDependency = spy;
+    const legacy = jest.spyOn(source, 'addDependency');
+    addCfnResourceDependency(source, target);
+    expect(spy).toHaveBeenCalledWith(target);
+    expect(legacy).not.toHaveBeenCalled();
+  });
+
+  it('falls back to addDependency on CDK versions without addResourceDependency', () => {
+    const { source, target } = makePair();
+    const capable = source as unknown as { addResourceDependency?: unknown };
+    const original = capable.addResourceDependency;
+    capable.addResourceDependency = undefined;
+    const legacy = jest.spyOn(source, 'addDependency');
+    addCfnResourceDependency(source, target);
+    expect(legacy).toHaveBeenCalledWith(target);
+    capable.addResourceDependency = original;
+  });
+});

packages/amplify-graphql-transformer-core/src/appsync-function.ts

@@ -3,7 +3,7 @@ import { BackedDataSource, BaseDataSource, CfnFunctionConfiguration } from 'aws-
 import { Construct } from 'constructs';
 import { InlineTemplate } from './cdk-compat/template-asset';
 import { GraphQLApi } from './graphql-api';
-import { setResourceName } from './utils';
+import { addCfnResourceDependency, setResourceName } from './utils';
 import { getRuntimeSpecificFunctionProps } from './utils/function-runtime';
 
 export interface BaseFunctionConfigurationProps {
@@ -66,7 +66,7 @@ export class AppSyncFunctionConfiguration extends Construct {
     setResourceName(this.function, { name: id });
     props.api.addSchemaDependency(this.function);
     if (props.dataSource instanceof BackedDataSource) {
-      this.function.addDependency(props.dataSource?.ds);
+      addCfnResourceDependency(this.function, props.dataSource?.ds);
     }
     this.arn = this.function.attrFunctionArn;
     this.functionId = this.function.attrFunctionId;

packages/amplify-graphql-transformer-core/src/graphql-api.ts

@@ -22,7 +22,7 @@ import { Construct } from 'constructs';
 import { LogRetention, RetentionDays } from 'aws-cdk-lib/aws-logs';
 import { TransformerSchema } from './cdk-compat/schema-asset';
 import { DefaultTransformHost } from './transform-host';
-import { setResourceName } from './utils';
+import { addCfnResourceDependency, setResourceName } from './utils';
 
 export interface GraphqlApiProps {
   /**
@@ -194,7 +194,7 @@ export class GraphQLApi extends GraphqlApiBase implements GraphQLAPIProvider {
         (mode: AuthorizationMode) => mode.authorizationType === AuthorizationType.API_KEY && mode.apiKeyConfig,
       )?.apiKeyConfig;
       this.apiKeyResource = this.createAPIKey(config);
-      this.apiKeyResource.addDependency(this.schemaResource);
+      addCfnResourceDependency(this.apiKeyResource, this.schemaResource);
       this.apiKey = this.apiKeyResource.attrApiKey;
     }
 
@@ -297,7 +297,7 @@ export class GraphQLApi extends GraphqlApiBase implements GraphQLAPIProvider {
   }
 
   public addSchemaDependency(construct: CfnResource): boolean {
-    construct.addDependency(this.schemaResource);
+    addCfnResourceDependency(construct, this.schemaResource);
     return true;
   }
 

packages/amplify-graphql-transformer-core/src/index.ts

@@ -75,6 +75,7 @@ export {
   isSqlStrategy,
   normalizeDbType,
   setResourceName,
+  addCfnResourceDependency,
   SQLLambdaResourceNames,
 } from './utils';
 export type { SetResourceNameProps } from './utils';

packages/amplify-graphql-transformer-core/src/utils/cfn-dependency.ts

@@ -0,0 +1,23 @@
+import { CfnResource } from 'aws-cdk-lib';
+
+type ResourceDependencyCapable = { addResourceDependency?: (target: CfnResource) => void };
+
+/**
+ * Declares that `source` depends on `target`, emitting a CloudFormation `DependsOn` entry.
+ *
+ * aws-cdk-lib >= 2.262.0 renamed `CfnResource#addDependency` to `addResourceDependency` and
+ * deprecated the old name (jsii emits a runtime deprecation warning). Older versions do not
+ * expose `addResourceDependency` at all. Feature-detecting at runtime keeps this library
+ * warning-free on new CDK while remaining compatible with older supported versions.
+ *
+ * @param source the resource that depends on `target`
+ * @param target the resource that must be created first
+ */
+export const addCfnResourceDependency = (source: CfnResource, target: CfnResource): void => {
+  const candidate = source as unknown as ResourceDependencyCapable;
+  if (typeof candidate.addResourceDependency === 'function') {
+    candidate.addResourceDependency(target);
+  } else {
+    source.addDependency(target);
+  }
+};

packages/amplify-graphql-transformer-core/src/utils/index.ts

@@ -20,6 +20,7 @@ export {
   getNonScalarFields,
   getParameterStoreSecretPath,
 } from './rds-util';
+export { addCfnResourceDependency } from './cfn-dependency';
 export const APICategory = 'api';
 export {
   setResourceName,