chore(spec2cdk): refactor for mixins

Author: mrgrain

packages/@aws-cdk/custom-resource-handlers/lib/custom-resources-framework/classes.ts

@@ -59,11 +59,11 @@ interface ConstructorBuildProps {
   readonly optionalConstructorProps?: boolean;
 
   /**
-   * Visbility for the constructor.
+   * Visibility for the constructor.
    *
-   * @default MemberVisbility.Public
+   * @default MemberVisibility.Public
    */
-  readonly constructorVisbility?: MemberVisibility;
+  readonly constructorVisibility?: MemberVisibility;
 
   /**
    * These statements are added to the constructor body in the order they appear in this property.
@@ -98,6 +98,13 @@ export interface HandlerFrameworkClassProps {
    * @default - the latest Lambda runtime available in the region.
    */
   readonly runtime?: Runtime;
+
+  /**
+   * Visibility for the constructor.
+   *
+   * @default MemberVisibility.Public
+   */
+  readonly constructorVisibility?: MemberVisibility;
 }
 
 interface BuildRuntimePropertyOptions {
@@ -134,13 +141,13 @@ export abstract class HandlerFrameworkClass extends ClassType {
           ['runtime', this.buildRuntimeProperty(scope, { runtime: props.runtime })],
         ]);
         const metadataStatements: Statement[] = [
-          expr.directCode(`this.node.addMetadata('${CUSTOM_RESOURCE_RUNTIME_FAMILY}', this.runtime.family)`),
+          stmt.directCode(`this.node.addMetadata('${CUSTOM_RESOURCE_RUNTIME_FAMILY}', this.runtime.family)`),
         ];
         this.buildConstructor({
           constructorPropsType: LAMBDA_MODULE.FunctionOptions,
           superProps,
           optionalConstructorProps: true,
-          constructorVisbility: MemberVisibility.Public,
+          constructorVisibility: MemberVisibility.Public,
           statements: metadataStatements,
         });
       }
@@ -226,16 +233,16 @@ export abstract class HandlerFrameworkClass extends ClassType {
           ['runtime', this.buildRuntimeProperty(scope, { runtime: props.runtime, isEvalNodejsProvider })],
         ]);
         const metadataStatements: Statement[] = [
-          expr.directCode(`this.addMetadata('${CUSTOM_RESOURCE_SINGLETON}', true)`),
-          expr.directCode(`this.addMetadata('${CUSTOM_RESOURCE_RUNTIME_FAMILY}', this.runtime.family)`),
-          expr.directCode(`if (props?.logGroup) { this.logGroup.node.addMetadata('${CUSTOM_RESOURCE_SINGLETON_LOG_GROUP}', true) }`),
+          stmt.directCode(`this.addMetadata('${CUSTOM_RESOURCE_SINGLETON}', true)`),
+          stmt.directCode(`this.addMetadata('${CUSTOM_RESOURCE_RUNTIME_FAMILY}', this.runtime.family)`),
+          stmt.directCode(`if (props?.logGroup) { this.logGroup.node.addMetadata('${CUSTOM_RESOURCE_SINGLETON_LOG_GROUP}', true) }`),
           // We need to access the private `_logRetention` custom resource, the only public property - `logGroup` - provides an ARN reference to the resource, instead of the resource itself.
-          expr.directCode(`if (props?.logRetention) { ((this as any).lambdaFunction as lambda.Function)._logRetention?.node.addMetadata('${CUSTOM_RESOURCE_SINGLETON_LOG_RETENTION}', true) }`),
+          stmt.directCode(`if (props?.logRetention) { ((this as any).lambdaFunction as lambda.Function)._logRetention?.node.addMetadata('${CUSTOM_RESOURCE_SINGLETON_LOG_RETENTION}', true) }`),
         ];
         this.buildConstructor({
           constructorPropsType: _interface.type,
           superProps,
-          constructorVisbility: MemberVisibility.Public,
+          constructorVisibility: MemberVisibility.Public,
           statements: metadataStatements,
         });
       }
@@ -337,11 +344,11 @@ export abstract class HandlerFrameworkClass extends ClassType {
             isCustomResourceProvider: true,
           })],
         ]);
-        const metadataStatements: Statement[] = [expr.directCode(`this.node.addMetadata('${CUSTOM_RESOURCE_PROVIDER}', true)`)];
+        const metadataStatements: Statement[] = [stmt.directCode(`this.node.addMetadata('${CUSTOM_RESOURCE_PROVIDER}', true)`)];
         this.buildConstructor({
           constructorPropsType: CORE_MODULE.CustomResourceProviderOptions,
           superProps,
-          constructorVisbility: MemberVisibility.Private,
+          constructorVisibility: props.constructorVisibility ?? MemberVisibility.Private,
           optionalConstructorProps: true,
           statements: metadataStatements,
         });
@@ -370,7 +377,7 @@ export abstract class HandlerFrameworkClass extends ClassType {
 
   private buildConstructor(props: ConstructorBuildProps) {
     const init = this.addInitializer({
-      visibility: props.constructorVisbility,
+      visibility: props.constructorVisibility,
     });
     const scope = init.addParameter({
       name: 'scope',

packages/@aws-cdk/custom-resource-handlers/lib/custom-resources-framework/config.ts

@@ -1,5 +1,6 @@
-/* eslint-disable import/no-extraneous-dependencies */
 import * as path from 'path';
+/* eslint-disable import/no-extraneous-dependencies */
+import { MemberVisibility } from '@cdklabs/typewriter';
 
 /**
  * Handler framework runtimes used for code generation.
@@ -97,6 +98,13 @@ export interface ComponentProps {
    * @default true
    */
   readonly minifyAndBundle?: boolean;
+
+  /**
+   * Visibility for the constructor.
+   *
+   * @default MemberVisibility.Public
+   */
+  readonly constructorVisibility?: MemberVisibility;
 }
 
 export type HandlerFrameworkConfig = { [module: string]: { [identifier: string]: ComponentProps[] } };
@@ -341,6 +349,7 @@ export const config: HandlerFrameworkConfig = {
       {
         type: ComponentType.CUSTOM_RESOURCE_PROVIDER,
         sourceCode: path.resolve(__dirname, '..', 'core', 'cross-region-ssm-writer-handler', 'index.ts'),
+        constructorVisibility: MemberVisibility.Public,
       },
     ],
     'cross-region-ssm-reader-provider': [

packages/@aws-cdk/custom-resource-handlers/lib/custom-resources-framework/framework.ts

@@ -54,6 +54,7 @@ export class HandlerFrameworkModule extends Module {
       handler,
       codeDirectory,
       runtime: component.runtime,
+      constructorVisibility: component.constructorVisibility,
     };
 
     switch (component.type) {

packages/@aws-cdk/custom-resource-handlers/package.json

@@ -48,7 +48,7 @@
     "@types/jest": "^29.5.14",
     "aws-sdk-client-mock": "4.1.0",
     "aws-sdk-client-mock-jest": "4.1.0",
-    "@cdklabs/typewriter": "^0.0.6",
+    "@cdklabs/typewriter": "^0.0.10",
     "jest": "^29.7.0",
     "sinon": "^9.2.4",
     "nock": "^13.5.6",

tools/@aws-cdk/cdk-build-tools/package.json

@@ -61,7 +61,7 @@
     "glob": "^7.2.3",
     "jest": "^29.7.0",
     "jest-junit": "^13.2.0",
-    "jsii": "~5.9.8",
+    "jsii": "~5.9.13",
     "jsii-rosetta": "~5.9.9",
     "jsii-pacmak": "1.118.0",
     "jsii-reflect": "1.118.0",

tools/@aws-cdk/spec2cdk/lib/cdk/ast.ts

@@ -212,7 +212,7 @@ export class AstBuilder {
     return ret;
   }
 
-  private createResourceModule(moduleName: string, serviceName: string, importLocations?: ModuleImportLocations) {
+  protected createResourceModule(moduleName: string, serviceName: string, importLocations?: ModuleImportLocations) {
     const resourceModule = new Module(`@aws-cdk/${moduleName}/${serviceName}`);
     CDK_CORE.import(resourceModule, 'cdk', { fromLocation: importLocations?.core });
     CONSTRUCTS.import(resourceModule, 'constructs');

tools/@aws-cdk/spec2cdk/lib/cdk/relationship-decider.ts

@@ -1,8 +1,7 @@
 import { Property, RelationshipRef, Resource, RichProperty, SpecDatabase } from '@aws-cdk/service-spec-types';
 import { namespaceFromResource, referenceInterfaceName, referenceInterfaceAttributeName, referencePropertyName, typeAliasPrefixFromResource } from '../naming';
 import { getReferenceProps } from './reference-props';
-import { createModuleDefinitionFromCfnNamespace } from '../cfn2ts/pkglint';
-import { log } from '../util';
+import { log, pkglint } from '../util';
 
 // For now we want relationships to be applied only for these services
 export const RELATIONSHIP_SERVICES: string[] = [];
@@ -55,7 +54,7 @@ export class RelationshipDecider {
     originalType: string;
     aliasedType: string;
   }) {
-    const moduleName = createModuleDefinitionFromCfnNamespace(namespace).moduleName;
+    const moduleName = pkglint.createModuleDefinitionFromCfnNamespace(namespace).moduleName;
     const moduleImport = this.imports.find(i => i.moduleName === moduleName);
     if (!moduleImport) {
       this.imports.push({

tools/@aws-cdk/spec2cdk/lib/cdk/resource-class.ts

@@ -24,7 +24,6 @@ import {
   TruthyOr,
   Type,
   TypeDeclarationStatement,
-  DocsSpec,
 } from '@cdklabs/typewriter';
 import { CDK_CORE, CONSTRUCTS } from './cdk';
 import { CloudFormationMapping } from './cloudformation-mapping';
@@ -39,7 +38,7 @@ import {
   staticRequiredTransform,
   staticResourceTypeName,
 } from '../naming';
-import { splitDocumentation } from '../util';
+import { isDefined, splitDocumentation, maybeDeprecated } from '../util';
 import { findArnProperty } from './reference-props';
 import { SelectiveImport, RelationshipDecider } from './relationship-decider';
 
@@ -640,37 +639,6 @@ export class ResourceClass extends ClassType {
   }
 }
 
-/**
- * Type guard to filter out undefined values.
- */
-function isDefined<T>(x: T | undefined): x is T {
-  return x !== undefined;
-}
-
-/**
- * Compute stability taking into account deprecation status.
- */
-function stability(isDeprecated: boolean = false, defaultStability: Stability = Stability.External): Stability {
-  if (isDeprecated) {
-    return Stability.Deprecated;
-  }
-  return defaultStability;
-}
-
-/**
- * Returns deprecation props if deprecated.
- */
-function maybeDeprecated(deprecationNotice?: string, defaultStability: Stability = Stability.External): Pick<DocsSpec, 'deprecated' | 'stability'> {
-  if (deprecationNotice) {
-    return {
-      deprecated: deprecationNotice,
-      stability: stability(Boolean(deprecationNotice), defaultStability),
-    };
-  }
-
-  return {};
-}
-
 /**
  * Given a template like "arn:${Partition}:ec2:${Region}:${Account}:fleet/${FleetId}",
  * and a list of property names, like ["partition", "region", "account", "fleetId"],

tools/@aws-cdk/spec2cdk/lib/cdk/type-converter.ts

@@ -1,3 +1,4 @@
+/* eslint-disable @cdklabs/no-throw-default-error */
 import {
   SpecDatabase,
   PropertyType,

tools/@aws-cdk/spec2cdk/lib/cdk/typedefinition-struct.ts

@@ -1,5 +1,5 @@
 import { Resource, TypeDefinition } from '@aws-cdk/service-spec-types';
-import { ClassType, expr, FreeFunction, Module, Stability, stmt, StructType, Type } from '@cdklabs/typewriter';
+import { ClassType, expr, FreeFunction, Module, PropertySpec, Stability, stmt, StructType, Type } from '@cdklabs/typewriter';
 import { CloudFormationMapping } from './cloudformation-mapping';
 import { RelationshipDecider } from './relationship-decider';
 import { TypeConverter } from './type-converter';
@@ -14,6 +14,18 @@ export interface TypeDefinitionStructOptions {
   readonly resource: Resource;
   readonly resourceClass: ClassType;
   readonly relationshipDecider: RelationshipDecider;
+  /**
+   * Add the cfn producer helpers.
+   * Validator + ToCloudFormation
+   * @default true
+   */
+  readonly cfnProducer?: boolean;
+  /**
+   * Add the cfn parser helpers.
+   * fromCloudFormation
+   * @default true
+   */
+  readonly cfnParser?: boolean;
 }
 
 /**
@@ -27,6 +39,7 @@ export class TypeDefinitionStruct extends StructType {
   private readonly resource: Resource;
   private readonly module: Module;
   private readonly relationshipDecider: RelationshipDecider;
+  private readonly options: TypeDefinitionStructOptions;
 
   constructor(options: TypeDefinitionStructOptions) {
     super(options.resourceClass, {
@@ -46,6 +59,7 @@ export class TypeDefinitionStruct extends StructType {
     this.converter = options.converter;
     this.resource = options.resource;
     this.relationshipDecider = options.relationshipDecider;
+    this.options = options;
 
     this.module = Module.of(this);
   }
@@ -90,7 +104,26 @@ export class TypeDefinitionStruct extends StructType {
       );
     }
 
-    cfnMapping.makeCfnProducer(this.module, this);
-    cfnMapping.makeCfnParser(this.module, this);
+    if (this.options.cfnProducer ?? true) {
+      cfnMapping.makeCfnProducer(this.module, this);
+    }
+    if (this.options.cfnParser ?? true) {
+      cfnMapping.makeCfnParser(this.module, this);
+    }
+  }
+}
+
+/**
+ * Same as TypeDefinitionStruct, but all props are optional.
+ */
+export class PartialTypeDefinitionStruct extends TypeDefinitionStruct {
+  /**
+   * Change property spec to make every prop optional.
+   */
+  public addProperty(prop: PropertySpec) {
+    return super.addProperty({
+      ...prop,
+      optional: true,
+    });
   }
 }