Make certain request fields optional to unblock contract testing (#25)

* make optional request fields

* fix readme ci icon

* fix proxy dependency

* format properly

* make response endpoint optional

* put back request context

Author: eduardomourar

README.md

@@ -7,7 +7,7 @@ We're excited to share our progress with adding new languages to the CloudFormat
 
 ## AWS CloudFormation Resource Provider TypeScript Plugin
 
-[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/eduardomourar/cloudformation-cli-typescript-plugin/ci)](https://github.com/eduardomourar/cloudformation-cli-typescript-plugin/actions?query=workflow%3Aci) [![Codecov](https://img.shields.io/codecov/c/gh/eduardomourar/cloudformation-cli-typescript-plugin)](https://codecov.io/gh/eduardomourar/cloudformation-cli-typescript-plugin) [![GitHub release](https://img.shields.io/github/v/release/eduardomourar/cloudformation-cli-typescript-plugin?include_prereleases)](https://github.com/eduardomourar/cloudformation-cli-typescript-plugin/releases) [![Node.js version](https://img.shields.io/badge/dynamic/json?color=brightgreen&url=https://raw.githubusercontent.com/eduardomourar/cloudformation-cli-typescript-plugin/master/package.json&query=$.engines.node&label=nodejs)](https://nodejs.org/)
+[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/eduardomourar/cloudformation-cli-typescript-plugin/ci/master)](https://github.com/eduardomourar/cloudformation-cli-typescript-plugin/actions?query=branch%3Amaster+workflow%3Aci) [![Codecov](https://img.shields.io/codecov/c/gh/eduardomourar/cloudformation-cli-typescript-plugin)](https://codecov.io/gh/eduardomourar/cloudformation-cli-typescript-plugin) [![GitHub release](https://img.shields.io/github/v/release/eduardomourar/cloudformation-cli-typescript-plugin?include_prereleases)](https://github.com/eduardomourar/cloudformation-cli-typescript-plugin/releases) [![Node.js version](https://img.shields.io/badge/dynamic/json?color=brightgreen&url=https://raw.githubusercontent.com/eduardomourar/cloudformation-cli-typescript-plugin/master/package.json&query=$.engines.node&label=nodejs)](https://nodejs.org/)
 
 The CloudFormation CLI (cfn) allows you to author your own resource providers that can be used by CloudFormation.
 

package-lock.json

@@ -62,7 +62,7 @@
         "typescript": "^3.7.0"
     },
     "optionalDependencies": {
-        "aws-sdk": "~2.631.0"
+        "aws-sdk": "~2.712.0"
     },
     "prettier": {
         "parser": "typescript",

package.json

@@ -12,7 +12,7 @@ import {
 } from '{{lib_name}}';
 import { ResourceModel } from './models';
 
-// Use this logger to forward log messages to CloudWatch Logs.
+// Use this logger to forward messages to CloudWatch Logs.
 const LOGGER = console;
 
 interface CallbackContext extends Record<string, any> {}

python/rpdk/typescript/templates/handlers.ts

@@ -2,6 +2,7 @@
     "name": "{{ name }}",
     "version": "0.1.0",
     "description": "{{ description }}",
+    "private": true,
     "main": "dist/handlers.js",
     "files": [
         "dist"

python/rpdk/typescript/templates/package.json

@@ -37,7 +37,10 @@ def find_version(*file_paths):
     include_package_data=True,
     zip_safe=True,
     python_requires=">=3.6",
-    install_requires=["cloudformation-cli>=0.1,<0.2", "aws-lambda-builders>=0.8,<0.9"],
+    install_requires=[
+        "cloudformation-cli>=0.1.10,<0.2",
+        "aws-lambda-builders>=0.8,<0.9",
+    ],
     entry_points={
         "rpdk.v1.languages": [
             "typescript = rpdk.typescript.codegen:TypescriptLanguagePlugin",

setup.py

@@ -206,14 +206,16 @@ export class TestEvent extends BaseDto {
 }
 
 export class RequestData<T = Dict> extends BaseDto {
-    @Expose() callerCredentials?: Credentials;
-    @Expose() providerCredentials?: Credentials;
-    @Expose() providerLogGroupName: LogGroupName;
-    @Expose() logicalResourceId: LogicalResourceId;
     @Expose() resourceProperties: T;
-    @Expose() previousResourceProperties?: T;
+    @Expose() providerLogGroupName?: LogGroupName;
+    @Expose() logicalResourceId?: LogicalResourceId;
     @Expose() systemTags?: Dict<string>;
     @Expose() stackTags?: Dict<string>;
+    // platform credentials aren't really optional, but this is used to
+    // zero them out to prevent e.g. accidental logging
+    @Expose() callerCredentials?: Credentials;
+    @Expose() providerCredentials?: Credentials;
+    @Expose() previousResourceProperties?: T;
     @Expose() previousStackTags?: Dict<string>;
 }
 
@@ -222,14 +224,14 @@ export class HandlerRequest<ResourceT = Dict, CallbackT = Dict> extends BaseDto
     @Expose() awsAccountId: string;
     @Expose() bearerToken: string;
     @Expose() region: string;
-    @Expose() responseEndpoint: string;
-    @Expose() resourceType: string;
-    @Expose() resourceTypeVersion: string;
     @Expose() requestData: RequestData<ResourceT>;
-    @Expose() stackId: string;
+    @Expose() responseEndpoint?: string;
+    @Expose() stackId?: string;
+    @Expose() resourceType?: string;
+    @Expose() resourceTypeVersion?: string;
     @Expose() callbackContext?: CallbackT;
     @Expose() nextToken?: NextToken;
-    @Expose() requestContext: RequestContext<CallbackT>;
+    @Expose() requestContext?: RequestContext<CallbackT>;
 }
 
 export class BaseResourceHandlerRequest<T extends BaseModel> extends BaseDto {

src/interface.ts

@@ -148,10 +148,6 @@ export class ProviderLogHandler {
                         'CloudWatchLogs'
                     ) as CloudWatchLogs;
                 } else {
-                    // Filter provider messages from platform.
-                    const provider: string = request.resourceType
-                        .replace(/::/g, '_')
-                        .toLowerCase();
                     logHandler = ProviderLogHandler.instance = new ProviderLogHandler({
                         accountId: request.awsAccountId,
                         groupName: logGroup,