Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: codegen cdk vended handler framework #28234

Closed
wants to merge 79 commits into from
Closed
Show file tree
Hide file tree
Changes from 78 commits
Commits
Show all changes
79 commits
Select commit Hold shift + click to select a range
cc1ab88
initial work on handler framework
colifran Nov 14, 2023
c8510d2
latest runtime
colifran Nov 15, 2023
34b00c0
added code to determine latest runtime and added a way to check for d…
colifran Nov 15, 2023
e1f3df8
refactor
colifran Nov 15, 2023
34755a3
file name
colifran Nov 15, 2023
64480b8
file path
colifran Nov 15, 2023
d11caf3
refactor
colifran Nov 15, 2023
f40f232
refactor
colifran Nov 15, 2023
5c4c47c
refactor
colifran Nov 15, 2023
1fbe2c9
naming
colifran Nov 15, 2023
01147e8
refactored and stopped using semver for version compare
colifran Nov 16, 2023
7d738ee
export version compare
colifran Nov 16, 2023
765e854
base class
colifran Nov 16, 2023
a1929f5
runtime determiner utility class
colifran Nov 16, 2023
f7f8ff7
private constructor
colifran Nov 16, 2023
98a88c5
refactor of runtime determiner
colifran Nov 16, 2023
8650123
error messages
colifran Nov 16, 2023
3b8f205
testing and docstrings
colifran Nov 16, 2023
ec18a1c
added isDeprecated flag to deprecated runtimes and added more tests
colifran Nov 16, 2023
193c8b9
unit tests
colifran Nov 16, 2023
4c55149
update unit test
colifran Nov 16, 2023
cc09759
singleton unit tests and docstrings
colifran Nov 16, 2023
7bdb2f9
singleton unit tests
colifran Nov 16, 2023
e86afa5
added some deprecated runtime unit tests
colifran Nov 16, 2023
cd196b7
Merge branch 'main' into colifran/cdk-vended-handler-framework
colifran Nov 20, 2023
e23503f
remove exports from index
colifran Nov 17, 2023
0446133
update cdk code to cdk handler and add handler as a property
colifran Nov 20, 2023
7bc5738
unit tests
colifran Nov 20, 2023
04d5de8
renamed cdk-code.test to cdk-handler.test
colifran Nov 20, 2023
fea5616
update index
colifran Nov 20, 2023
39c4f3e
runtime unit tests
colifran Nov 20, 2023
72daf6a
cdk function integ test
colifran Nov 20, 2023
9ef7f31
reference path for types
colifran Nov 20, 2023
2eb901a
updated replica provider with new framework and changed integ test st…
colifran Nov 20, 2023
b144ff5
global snaps
colifran Nov 20, 2023
e61ff82
global replicas provisioned snaps
colifran Nov 20, 2023
cc52bdf
updated receipt to use cdk handler and cdk singleton function
colifran Nov 20, 2023
6fa5f4a
receipt snaps
colifran Nov 20, 2023
ac37074
refactored runtime determiner
colifran Nov 21, 2023
8c6c0ac
refactored runtime determiner and moved handler framework into its ow…
colifran Nov 21, 2023
8febdf1
renamed handler property to entrypoint
colifran Nov 21, 2023
32439cf
refactored runtime determiner and added content to readme
colifran Nov 21, 2023
31e43ab
readme
colifran Nov 21, 2023
bd62d07
default runtime docstring
colifran Nov 21, 2023
50ea546
Merge branch 'main' into colifran/cdk-vended-handler-framework
colifran Nov 27, 2023
a0c5d87
Merge branch 'main' into colifran/cdk-vended-handler-framework
colifran Nov 28, 2023
b1ec4d3
added initial code for CdkCustomResourceProvider
colifran Nov 27, 2023
abbf10a
custom resource provider base class
colifran Nov 28, 2023
d45a76c
cdk custom resource provider
colifran Nov 28, 2023
a5fd5b5
options interface
colifran Nov 28, 2023
8178135
reverted changes in edge function
colifran Nov 28, 2023
2ea9e37
refactored custom resource provider
colifran Nov 28, 2023
f0a4b61
wip
colifran Nov 28, 2023
0098580
wip
colifran Nov 28, 2023
490eda1
CdkCustomResourceProvider
colifran Nov 28, 2023
7f93955
refactored cdk handler, cdk function, and cdk singleton function. com…
colifran Nov 28, 2023
98601bf
cdk-handler tests
colifran Nov 28, 2023
fe7bd42
unit tests for cdk custom resource provider
colifran Nov 29, 2023
4ecd18e
merge conflicts
colifran Nov 29, 2023
fdaee2c
removed commented out code from edge function
colifran Nov 29, 2023
0b46310
updated aws custom resource provider and reverted changes in integ tests
colifran Nov 29, 2023
cd27fac
global replicas provisioned snaps
colifran Nov 29, 2023
4be3621
global snapsw
colifran Nov 29, 2023
428ae6e
snaps
colifran Nov 30, 2023
81b7796
handler path
colifran Nov 30, 2023
a68a854
custom resource props format
colifran Nov 30, 2023
ffa888d
refactor deprecated runtimes unit tests to use test.each
colifran Nov 30, 2023
fc02c0b
fixed cdk handler unit tests
colifran Nov 30, 2023
6b8542d
fixed cdk custom resource provider unit tests
colifran Nov 30, 2023
9ee148c
update aws custom resource to use nodejs18
colifran Nov 30, 2023
4856943
use code from asset in cdk handler
colifran Nov 30, 2023
3fa4aac
moved all framework files under handler-framework module
colifran Nov 30, 2023
7048170
readme
colifran Nov 30, 2023
437842f
mock provider
colifran Nov 30, 2023
8dff028
doc string
colifran Nov 30, 2023
e728d15
Merge branch 'main' into colifran/cdk-vended-handler-framework
colifran Dec 1, 2023
569eedb
initial code for framework codegen
colifran Dec 1, 2023
c90a85a
framewokr codegen
colifran Dec 2, 2023
0ccf3e8
props
colifran Dec 2, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions packages/@aws-cdk/cdk-handler-framework/.eslintrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
const baseConfig = require('@aws-cdk/cdk-build-tools/config/eslintrc');
baseConfig.parserOptions.project = __dirname + '/tsconfig.json';
module.exports = baseConfig;
19 changes: 19 additions & 0 deletions packages/@aws-cdk/cdk-handler-framework/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
*.js
*.js.map
*.d.ts
tsconfig.json
node_modules
*.generated.ts
dist
.jsii

.LAST_BUILD
.nyc_output
coverage
nyc.config.js
.LAST_PACKAGE
*.snk
!.eslintrc.js
!jest.config.js

junit.xml
29 changes: 29 additions & 0 deletions packages/@aws-cdk/cdk-handler-framework/.npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Don't include original .ts files when doing `npm pack`
*.ts
!*.d.ts
coverage
.nyc_output
*.tgz

dist
.LAST_PACKAGE
.LAST_BUILD
!*.js

# Include .jsii
!.jsii

*.snk

*.tsbuildinfo

tsconfig.json
.eslintrc.js
jest.config.js

# exclude cdk artifacts
**/cdk.out
junit.xml
test/
!*.lit.ts
**/*.snapshot
201 changes: 201 additions & 0 deletions packages/@aws-cdk/cdk-handler-framework/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,201 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
2 changes: 2 additions & 0 deletions packages/@aws-cdk/cdk-handler-framework/NOTICE
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
AWS Cloud Development Kit (AWS CDK)
Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
39 changes: 39 additions & 0 deletions packages/@aws-cdk/cdk-handler-framework/lib/cdk-imports.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
import { ExternalModule, Type } from '@cdklabs/typewriter';

class ConstructsModule extends ExternalModule {
public readonly Construct = Type.fromName(this, 'Construct');
public readonly IConstruct = Type.fromName(this, 'IConstruct');

public constructor() {
super('constructs');
}
}

class CdkHandlerModule extends ExternalModule {
public readonly CdkHandler = Type.fromName(this, 'CdkHandler');

public constructor() {
super('../../handler-framework/lib/cdk-handler');
}
}

class CdkFunctionModule extends ExternalModule {
public readonly CdkFunction = Type.fromName(this, 'CdkFunction');

public constructor() {
super('../../handler-framework/lib/cdk-function');
}
}

class CdkSingletonFunctionModule extends ExternalModule {
public readonly CdkSingletonFunction = Type.fromName(this, 'CdkSingletonFunction');

public constructor() {
super('../../handler-framework/lib/cdk-singleton-function');
}
}

export const CONSTRUCTS_MODULE = new ConstructsModule();
export const CDK_HANDLER_MODULE = new CdkHandlerModule();
export const CDK_FUNCTION_MODULE = new CdkFunctionModule();
export const CDK_SINGLETON_FUNCTION_MODULE = new CdkSingletonFunctionModule();
65 changes: 65 additions & 0 deletions packages/@aws-cdk/cdk-handler-framework/lib/class-builder.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
import { SuperInitializer, ClassType, Type, IScope, expr, stmt } from '@cdklabs/typewriter';
import { CDK_FUNCTION_MODULE, CDK_SINGLETON_FUNCTION_MODULE, CONSTRUCTS_MODULE } from './cdk-imports';

export abstract class CdkHandlerClass extends ClassType {
public static buildCdkFunction(scope: IScope, className: string, codeDirectory: string): ClassType {
return new (class CdkFunction extends CdkHandlerClass {
public constructor() {
super(scope, {
name: className,
extends: CDK_FUNCTION_MODULE.CdkFunction,
});
this.buildConstructor(codeDirectory);
}
})();
}

public static buildCdkSingletonFunction(scope: IScope, className: string, codeDirectory: string): ClassType {
return new (class CdkSingleFunction extends CdkHandlerClass {
public constructor() {
super(scope, {
name: className,
extends: CDK_SINGLETON_FUNCTION_MODULE.CdkSingletonFunction,
});
this.buildConstructor(codeDirectory);
}
})();
}

public static buildCdkCustomResourceProvider() {}

private buildConstructor(codeDirectory: string, entrypoint?: string) {
// constructor
const init = this.addInitializer({});

// build CdkHandler instance
init.addBody(
stmt.constVar(
expr.ident('cdkHandlerProps'),
expr.object({
codeDirectory: expr.directCode(codeDirectory),
entrypoint: entrypoint ? expr.directCode(entrypoint) : expr.lit('index.handler'),
}),
),
);
init.addBody(
stmt.constVar(
expr.ident('cdkHandler'),
expr.directCode('new CdkHandler(scope, `Handler`, cdkHandlerProps)'),
),
);

// build super call
const scope = init.addParameter({
name: 'scope',
type: CONSTRUCTS_MODULE.Construct,
});
const id = init.addParameter({
name: 'id',
type: Type.STRING,
});
init.addBody(new SuperInitializer(scope, id, expr.object({
handler: expr.ident('cdkHandler'),
})));
}
}
Loading
Loading