Passing a logger interface to the handlers (#26)

* freeze recursively request object

* pass logger interface to handler

* refactor log delivery completely

* pass timestamp when publishing log event

* support adding filter to log proxy

* scrub sensitive info when logging

* use string replace all with shim library

* ensure s3 fallback logging

* fix zip timestamp issue in codegen test

* use pip new resolver flag

Author: eduardomourar

.github/workflows/ci.yml

@@ -30,15 +30,19 @@ jobs:
         id: install_python
         run: |
           mkdir "$LOG_PATH"
-          pip install --upgrade pip setuptools wheel aws-sam-cli -r https://raw.githubusercontent.com/aws-cloudformation/cloudformation-cli/master/requirements.txt
-          pip install .
+          pip install --upgrade pip
+          pip install --use-feature=2020-resolver --upgrade setuptools wheel aws-sam-cli -r https://raw.githubusercontent.com/aws-cloudformation/cloudformation-cli/master/requirements.txt
+          pip install --use-feature=2020-resolver .
       - uses: actions/setup-node@v1
         with:
           node-version: 12
       - name: Install Dependencies Node.js
         id: install_nodejs
+        # Touch needed because of https://github.com/aws/aws-cli/issues/2639
         run: |
-          npm ci --optional && npm run build
+          npm ci --optional
+          find ./node_modules/* -mtime +10950 -exec touch {} \;
+          npm run build
       - name: Run Unit Tests
         id: unit_testing
         run: |

Pipfile.lock

@@ -7,9 +7,11 @@
         "test": "tests"
     },
     "files": [
-        "dist",
-        "global.d.ts"
+        "dist"
     ],
+    "publishConfig": {
+        "access": "public"
+    },
     "scripts": {
         "build": "npx tsc",
         "prepack": "npm run build",
@@ -33,11 +35,11 @@
     },
     "homepage": "https://github.com/eduardomourar/cloudformation-cli-typescript-plugin#readme",
     "dependencies": {
+        "@org-formation/tombok": "^0.0.1",
         "autobind-decorator": "^2.4.0",
         "class-transformer": "^0.3.1",
-        "promise-sequential": "^1.1.1",
         "reflect-metadata": "^0.1.13",
-        "tombok": "https://github.com/eduardomourar/tombok/releases/download/v0.0.1/tombok-0.0.1.tgz",
+        "string.prototype.replaceall": "^1.0.3",
         "uuid": "^7.0.2"
     },
     "devDependencies": {

package-lock.json

@@ -1,6 +1,6 @@
 import logging
 import shutil
-import zipfile
+import sys
 from subprocess import PIPE, CalledProcessError, run as subprocess_run  # nosec
 from tempfile import TemporaryFile
 
@@ -13,6 +13,12 @@
 from .resolver import contains_model, get_inner_type, translate_type
 from .utils import safe_reserved
 
+if sys.version_info >= (3, 8):  # pragma: no cover
+    from zipfile import ZipFile
+else:  # pragma: no cover
+    from zipfile38 import ZipFile
+
+
 LOG = logging.getLogger(__name__)
 
 EXECUTABLE = "cfn"
@@ -173,7 +179,8 @@ def generate(self, project):
     def _pre_package(self, build_path):
         f = TemporaryFile("w+b")
 
-        with zipfile.ZipFile(f, mode="w") as zip_file:
+        # pylint: disable=unexpected-keyword-arg
+        with ZipFile(f, mode="w", strict_timestamps=False) as zip_file:
             self._recursive_relative_write(build_path, build_path, zip_file)
         f.seek(0)
 

package.json

@@ -10,7 +10,7 @@ Congratulations on starting development! Next steps:
 Implement CloudFormation resource here. Each function must always return a ProgressEvent.
 
 ```typescript
-const progress: ProgressEvent = ProgressEvent.builder()
+const progress: ProgressEvent = ProgressEvent.builder<ProgressEvent<ResourceModel>>()
 
     // Required
     // Must be one of OperationStatus.InProgress, OperationStatus.Failed, OperationStatus.Success
@@ -36,4 +36,4 @@ const progress: ProgressEvent = ProgressEvent.builder()
 
 While importing the [{{ lib_name }}](https://github.com/eduardomourar/cloudformation-cli-typescript-plugin) library, failures can be passed back to CloudFormation by either raising an exception from `exceptions`, or setting the ProgressEvent's `status` to `OperationStatus.Failed` and `errorCode` to one of `HandlerErrorCode`. There is a static helper function, `ProgressEvent.failed`, for this common case.
 
-Keep in mind, during runtime all logs will be delivered to CloudWatch except those used with `debug` method.
+Keep in mind, during runtime all logs will be delivered to CloudWatch if you use the `LoggerProxy.log` method.

python/rpdk/typescript/codegen.py

@@ -4,6 +4,7 @@ import {
     exceptions,
     handlerEvent,
     HandlerErrorCode,
+    LoggerProxy,
     OperationStatus,
     Optional,
     ProgressEvent,
@@ -12,9 +13,6 @@ import {
 } from '{{lib_name}}';
 import { ResourceModel } from './models';
 
-// Use this logger to forward messages to CloudWatch Logs.
-const LOGGER = console;
-
 interface CallbackContext extends Record<string, any> {}
 
 class Resource extends BaseResource<ResourceModel> {
@@ -33,8 +31,9 @@ class Resource extends BaseResource<ResourceModel> {
         session: Optional<SessionProxy>,
         request: ResourceHandlerRequest<ResourceModel>,
         callbackContext: CallbackContext,
+        logger: LoggerProxy
     ): Promise<ProgressEvent> {
-        const model: ResourceModel = request.desiredResourceState;
+        const model: ResourceModel = new ResourceModel(request.desiredResourceState);
         const progress = ProgressEvent.progress<ProgressEvent<ResourceModel, CallbackContext>>(model);
         // TODO: put code here
 
@@ -46,7 +45,7 @@ class Resource extends BaseResource<ResourceModel> {
             // Setting Status to success will signal to CloudFormation that the operation is complete
             progress.status = OperationStatus.Success;
         } catch(err) {
-            LOGGER.log(err);
+            logger.log(err);
             // exceptions module lets CloudFormation know the type of failure that occurred
             throw new exceptions.InternalFailure(err.message);
             // this can also be done by returning a failed progress event
@@ -69,8 +68,9 @@ class Resource extends BaseResource<ResourceModel> {
         session: Optional<SessionProxy>,
         request: ResourceHandlerRequest<ResourceModel>,
         callbackContext: CallbackContext,
+        logger: LoggerProxy
     ): Promise<ProgressEvent> {
-        const model: ResourceModel = request.desiredResourceState;
+        const model: ResourceModel = new ResourceModel(request.desiredResourceState);
         const progress = ProgressEvent.progress<ProgressEvent<ResourceModel, CallbackContext>>(model);
         // TODO: put code here
         progress.status = OperationStatus.Success;
@@ -92,8 +92,9 @@ class Resource extends BaseResource<ResourceModel> {
         session: Optional<SessionProxy>,
         request: ResourceHandlerRequest<ResourceModel>,
         callbackContext: CallbackContext,
+        logger: LoggerProxy
     ): Promise<ProgressEvent> {
-        const model: ResourceModel = request.desiredResourceState;
+        const model: ResourceModel = new ResourceModel(request.desiredResourceState);
         const progress = ProgressEvent.progress<ProgressEvent<ResourceModel, CallbackContext>>();
         // TODO: put code here
         progress.status = OperationStatus.Success;
@@ -114,8 +115,9 @@ class Resource extends BaseResource<ResourceModel> {
         session: Optional<SessionProxy>,
         request: ResourceHandlerRequest<ResourceModel>,
         callbackContext: CallbackContext,
+        logger: LoggerProxy
     ): Promise<ProgressEvent> {
-        const model: ResourceModel = request.desiredResourceState;
+        const model: ResourceModel = new ResourceModel(request.desiredResourceState);
         // TODO: put code here
         const progress = ProgressEvent.success<ProgressEvent<ResourceModel, CallbackContext>>(model);
         return progress;
@@ -135,8 +137,9 @@ class Resource extends BaseResource<ResourceModel> {
         session: Optional<SessionProxy>,
         request: ResourceHandlerRequest<ResourceModel>,
         callbackContext: CallbackContext,
+        logger: LoggerProxy
     ): Promise<ProgressEvent> {
-        const model: ResourceModel = request.desiredResourceState;
+        const model: ResourceModel = new ResourceModel(request.desiredResourceState);
         // TODO: put code here
         const progress = ProgressEvent.builder<ProgressEvent<ResourceModel, CallbackContext>>()
             .status(OperationStatus.Success)

python/rpdk/typescript/templates/README.md

@@ -40,6 +40,7 @@ def find_version(*file_paths):
     install_requires=[
         "cloudformation-cli>=0.1.10,<0.2",
         "aws-lambda-builders>=0.8,<0.9",
+        "zipfile38>=0.0.2,<0.2",
     ],
     entry_points={
         "rpdk.v1.languages": [