feat(synthetics): node playwright 1.0 and python selenium 4.1 runtime #32245

badmintoncryer · 2024-11-22T04:09:03Z

Issue # (if applicable)

None

Reason for this change

AWS Synthetics begins supporting the NodeJS Playwright runtime.

https://aws.amazon.com/about-aws/whats-new/2024/11/amazon-cloudwatch-synthetics-playwright-runtime-canaries-nodejs/

And Python Selenium runtime v4.1 is also released.

https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Library_python_selenium.html#CloudWatch_Synthetics_runtimeversion-syn-python-selenium-4.1

Description of changes

Add two runtimes to Runtime class

SYNTHETICS_PYTHON_SELENIUM_4_1
SYNTHETICS_NODEJS_PLAYWRIGHT_1_0

Description of how you validated changes

Execute describe-runtime AWS CLI.

aws synthetics describe-runtime-versions --region us-east-1 | grep VersionName
            "VersionName": "syn-python-selenium-4.1",
            ...,
            "VersionName": "syn-nodejs-playwright-1.0",
            ...

Checklist

My code adheres to the CONTRIBUTING GUIDE and DESIGN GUIDELINES

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

codecov · 2024-11-22T04:21:46Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 80.54%. Comparing base (5735e9e) to head (bba5689).

Additional details and impacted files

@@           Coverage Diff           @@
##             main   #32245   +/-   ##
=======================================
  Coverage   80.54%   80.54%           
=======================================
  Files         106      106           
  Lines        6954     6954           
  Branches     1287     1287           
=======================================
  Hits         5601     5601           
  Misses       1175     1175           
  Partials      178      178

Flag	Coverage Δ
suite.unit	`80.54% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

Components	Coverage Δ
packages/aws-cdk	`80.54% <ø> (ø)`

gracelu0

Thank you for the PR! Could we name this PR with feat instead of chore and add to this integ test: https://github.com/aws/aws-cdk/blob/main/packages/%40aws-cdk-testing/framework-integ/test/aws-synthetics/test/integ.canary.ts?

aws-cdk-automation

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.

Pull request has been modified.

badmintoncryer · 2024-12-05T12:23:59Z

@gracelu0 Thank you for your review! I have some problems.

Currently, the code cannot deploy the PlayWright runtime, so I would like to modify the validateCanaryAsset() function to accept Runtime instead of RuntimeFamily as its argument.

-  private validateCanaryAsset(scope: Construct, handler: string, family: RuntimeFamily) {
+  private validateCanaryAsset(scope: Construct, handler: string, runtime: Runtime) {

To align with this change, the bind() function's arguments also need to be updated.

- public bind(scope: Construct, handler: string, family: RuntimeFamily): CodeConfig {
+ public bind(scope: Construct, handler: string, runtime: Runtime): CodeConfig {

However, this would introduce a breaking change to a public function, causing the CI to fail.

API elements with incompatible changes:
err  - METHOD aws-cdk-lib.aws_synthetics.AssetCode.bind: argument family, takes aws-cdk-lib.aws_synthetics.Runtime (formerly aws-cdk-lib.aws_synthetics.RuntimeFamily): aws-cdk-lib.aws_synthetics.RuntimeFamily is an enum different from aws-cdk-lib.aws_synthetics.Runtime [incompatible-argument:aws-cdk-lib.aws_synthetics.AssetCode.bind]
err  - METHOD aws-cdk-lib.aws_synthetics.Code.bind: argument family, takes aws-cdk-lib.aws_synthetics.Runtime (formerly aws-cdk-lib.aws_synthetics.RuntimeFamily): aws-cdk-lib.aws_synthetics.RuntimeFamily is an enum different from aws-cdk-lib.aws_synthetics.Runtime [incompatible-argument:aws-cdk-lib.aws_synthetics.Code.bind]
err  - METHOD aws-cdk-lib.aws_synthetics.InlineCode.bind: argument _family, takes aws-cdk-lib.aws_synthetics.Runtime (formerly aws-cdk-lib.aws_synthetics.RuntimeFamily): aws-cdk-lib.aws_synthetics.RuntimeFamily is an enum different from aws-cdk-lib.aws_synthetics.Runtime [incompatible-argument:aws-cdk-lib.aws_synthetics.InlineCode.bind]
err  - METHOD aws-cdk-lib.aws_synthetics.S3Code.bind: argument _family, takes aws-cdk-lib.aws_synthetics.Runtime (formerly aws-cdk-lib.aws_synthetics.RuntimeFamily): aws-cdk-lib.aws_synthetics.RuntimeFamily is an enum different from aws-cdk-lib.aws_synthetics.Runtime [incompatible-argument:aws-cdk-lib.aws_synthetics.S3Code.bind]
Checking region info facts... OK.
Some packages seem to have undergone breaking API changes. Please avoid.

Could you provide some advice on how to approach this modification?

nmussy

I didn't have a chance to go over everything, but from what little testing I ran before being made aware of my duplicate implementation:

activeTracing is not (yet?) supported for Playwright. Despite being allowed as a Node.js Runtime by the CDK, CloudFormation will throw on deployment

aws-cdk/packages/aws-cdk-lib/aws-synthetics/lib/canary.ts

Lines 592 to 594 in 27619cc

    
           if (props.activeTracing && !cdk.Token.isUnresolved(props.runtime.family) && props.runtime.family !== RuntimeFamily.NODEJS) { 
        
             throw new Error('You can only enable active tracing for canaries that use canary runtime version `syn-nodejs-2.0` or later.'); 
        
           }

I'm not sure about artifactS3EncryptionMode, but the CDK allows the use of the property as well, so it would at least require updating the error message and adding integration coverage

aws-cdk/packages/aws-cdk-lib/aws-synthetics/lib/canary.ts

Lines 686 to 688 in 27619cc

    
           if (!isNodeRuntime && props.artifactS3EncryptionMode) { 
        
             throw new Error(`Artifact encryption is only supported for canaries that use Synthetics runtime version \`syn-nodejs-puppeteer-3.3\` or later, got \`${props.runtime.name}\`.`); 
        
           }

nmussy · 2024-12-14T02:37:23Z

packages/@aws-cdk-testing/framework-integ/test/aws-synthetics/test/integ.canary.ts

 const puppeteer80 = createCanaryByRuntimes(Runtime.SYNTHETICS_NODEJS_PUPPETEER_8_0);
+const playwright10 = createCanaryByRuntimes(Runtime.SYNTHETICS_NODEJS_PLAYWRIGHT_1_0);


Could you add tests for SYNTHETICS_NODEJS_PUPPETEER_9_0 and SYNTHETICS_NODEJS_PUPPETEER_9_1? They weren't covered when they were added

I've added!

nmussy · 2024-12-14T02:54:33Z

packages/aws-cdk-lib/aws-synthetics/lib/code.ts

+      const hasValidExtension = playwrightValidExtensions.some(ext => fs.existsSync(path.join(assetPath, `${filename}${ext}`)));
+      if (runtime.family === RuntimeFamily.NODEJS && runtime.name.includes('puppeteer') && !fs.existsSync(path.join(assetPath, 'nodejs', 'node_modules', nodeFilename))) {


Playwright canaries should support multiple directories (e.g. a/b/c/entrypoint.mjs), see docs:

Optionally, you can also store your entry point file in a folder structure of your choice. However, be sure that the folder path is specified in your handler name.

I think the validation would handle it fine, but could you add a unit test and an integ to make sure we support it correctly?

Thank you for your information. I don't know that.
I've created both integ and unit test for multiple directories.

aws-cdk-automation · 2024-12-20T00:11:36Z

This PR cannot be merged because it has conflicts. Please resolve them. The PR will be considered stale and closed if it remains in an unmergeable state.

aws-cdk-automation · 2024-12-21T00:11:41Z

This PR has been in the BUILD FAILING state for 3 weeks, and looks abandoned. To keep this PR from being closed, please continue work on it. If not, it will automatically be closed in a week.

aws-cdk-automation

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.

badmintoncryer · 2024-12-22T03:32:34Z

@gracelu0 Thank you for your review! I have some problems.

Currently, the code cannot deploy the PlayWright runtime, so I would like to modify the validateCanaryAsset() function to accept Runtime instead of RuntimeFamily as its argument.

-  private validateCanaryAsset(scope: Construct, handler: string, family: RuntimeFamily) {
+  private validateCanaryAsset(scope: Construct, handler: string, runtime: Runtime) {

To align with this change, the bind() function's arguments also need to be updated.

- public bind(scope: Construct, handler: string, family: RuntimeFamily): CodeConfig {
+ public bind(scope: Construct, handler: string, runtime: Runtime): CodeConfig {

However, this would introduce a breaking change to a public function, causing the CI to fail.

API elements with incompatible changes:
err  - METHOD aws-cdk-lib.aws_synthetics.AssetCode.bind: argument family, takes aws-cdk-lib.aws_synthetics.Runtime (formerly aws-cdk-lib.aws_synthetics.RuntimeFamily): aws-cdk-lib.aws_synthetics.RuntimeFamily is an enum different from aws-cdk-lib.aws_synthetics.Runtime [incompatible-argument:aws-cdk-lib.aws_synthetics.AssetCode.bind]
err  - METHOD aws-cdk-lib.aws_synthetics.Code.bind: argument family, takes aws-cdk-lib.aws_synthetics.Runtime (formerly aws-cdk-lib.aws_synthetics.RuntimeFamily): aws-cdk-lib.aws_synthetics.RuntimeFamily is an enum different from aws-cdk-lib.aws_synthetics.Runtime [incompatible-argument:aws-cdk-lib.aws_synthetics.Code.bind]
err  - METHOD aws-cdk-lib.aws_synthetics.InlineCode.bind: argument _family, takes aws-cdk-lib.aws_synthetics.Runtime (formerly aws-cdk-lib.aws_synthetics.RuntimeFamily): aws-cdk-lib.aws_synthetics.RuntimeFamily is an enum different from aws-cdk-lib.aws_synthetics.Runtime [incompatible-argument:aws-cdk-lib.aws_synthetics.InlineCode.bind]
err  - METHOD aws-cdk-lib.aws_synthetics.S3Code.bind: argument _family, takes aws-cdk-lib.aws_synthetics.Runtime (formerly aws-cdk-lib.aws_synthetics.RuntimeFamily): aws-cdk-lib.aws_synthetics.RuntimeFamily is an enum different from aws-cdk-lib.aws_synthetics.Runtime [incompatible-argument:aws-cdk-lib.aws_synthetics.S3Code.bind]
Checking region info facts... OK.
Some packages seem to have undergone breaking API changes. Please avoid.

Could you provide some advice on how to approach this modification?

The third argument of the Code.bind function has been updated to accept a type of Runtime | RuntimeFamily instead of just RuntimeFamily to avoid breaking changes.

Consequently, the specifications for the arguments of the bind method have also been updated in classes such as InlineCode and S3Code, which implement the Code class. However, since these classes do not utilize the third argument, the impact is expected to be minimal.

badmintoncryer · 2024-12-22T03:33:31Z

@nmussy Thank you for your review!! I've addressed all of your comments.

nmussy · 2024-12-24T08:57:14Z

packages/aws-cdk-lib/aws-synthetics/lib/canary.ts

@@ -684,7 +689,7 @@ export class Canary extends cdk.Resource implements ec2.IConnectable {

    // Only check runtime family is Node.js because versions prior to `syn-nodejs-puppeteer-3.3` are deprecated and can no longer be configured.
    if (!isNodeRuntime && props.artifactS3EncryptionMode) {
-      throw new Error(`Artifact encryption is only supported for canaries that use Synthetics runtime version \`syn-nodejs-puppeteer-3.3\` or later, got \`${props.runtime.name}\`.`);


Would you be able to add a test for Playwright in integ.canary-artifact-s3-encryption to confirm this works as expected? Thanks

aws-cdk-automation · 2024-12-24T10:43:23Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
Commit ID: bba5689
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

add runtime version

bf3d3d4

github-actions bot added the p2 label Nov 22, 2024

aws-cdk-automation requested a review from a team November 22, 2024 04:09

github-actions bot added the distinguished-contributor [Pilot] contributed 50+ PRs to the CDK label Nov 22, 2024

aws-cdk-automation added the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Nov 22, 2024

mazyu36 approved these changes Nov 22, 2024

View reviewed changes

aws-cdk-automation added pr/needs-maintainer-review This PR needs a review from a Core Team Member and removed pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. labels Nov 22, 2024

badmintoncryer changed the title ~~chore(synthetics): node playwright and python selenium runtime~~ chore(synthetics): node playwright 1.0 and python selenium 4.1 runtime Nov 22, 2024

gracelu0 previously requested changes Nov 25, 2024

View reviewed changes

aws-cdk-automation removed the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Nov 25, 2024

badmintoncryer changed the title ~~chore(synthetics): node playwright 1.0 and python selenium 4.1 runtime~~ feat(synthetics): node playwright 1.0 and python selenium 4.1 runtime Nov 28, 2024

aws-cdk-automation previously requested changes Nov 28, 2024

View reviewed changes

badmintoncryer added 5 commits November 28, 2024 21:15

Merge remote-tracking branch 'origin/main' into synthetics-runtime

e5a2786

update integ test

79046e1

update integ test

2e5a4ca

update unit test

2856673

Merge branch 'main' into synthetics-runtime

8ef293d

fix unit test

788848c

github-actions bot mentioned this pull request Dec 1, 2024

Monthly PR metrics report #32340

Open

gracelu0 mentioned this pull request Dec 13, 2024

feat(synthetics): runtimes nodejs-playwright-1.0 and python-selenium-4.1 #32517

Closed

1 task

nmussy suggested changes Dec 14, 2024

View reviewed changes

badmintoncryer added 2 commits December 21, 2024 22:16

Merge remote-tracking branch 'origin/main' into synthetics-runtime

bc19f3c

tracing config

a0af52a

badmintoncryer force-pushed the synthetics-runtime branch from a0af52a to bf3d3d4 Compare December 21, 2024 22:51

aws-cdk-automation previously requested changes Dec 21, 2024

View reviewed changes

Merge remote-tracking branch 'origin/main' into synthetics-runtime

6cd56c0

badmintoncryer force-pushed the synthetics-runtime branch from 66ad184 to 6cd56c0 Compare December 21, 2024 22:59

badmintoncryer added 3 commits December 22, 2024 08:45

update integ

b998d6a

update test

461a4ef

backward compatibility

ed5c9ac

aws-cdk-automation added the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Dec 22, 2024

nmussy reviewed Dec 24, 2024

View reviewed changes

Merge branch 'main' into synthetics-runtime

bba5689

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(synthetics): node playwright 1.0 and python selenium 4.1 runtime #32245

feat(synthetics): node playwright 1.0 and python selenium 4.1 runtime #32245

badmintoncryer commented Nov 22, 2024

codecov bot commented Nov 22, 2024 •

edited

Loading

gracelu0 left a comment

aws-cdk-automation left a comment

badmintoncryer commented Dec 5, 2024

nmussy left a comment •

edited

Loading

nmussy Dec 14, 2024

badmintoncryer Dec 21, 2024

nmussy Dec 14, 2024

badmintoncryer Dec 22, 2024

aws-cdk-automation commented Dec 20, 2024

aws-cdk-automation commented Dec 21, 2024

aws-cdk-automation left a comment

badmintoncryer commented Dec 22, 2024

badmintoncryer commented Dec 22, 2024

nmussy Dec 24, 2024

aws-cdk-automation commented Dec 24, 2024

	if (props.activeTracing && !cdk.Token.isUnresolved(props.runtime.family) && props.runtime.family !== RuntimeFamily.NODEJS) {
	throw new Error('You can only enable active tracing for canaries that use canary runtime version `syn-nodejs-2.0` or later.');
	}

	if (!isNodeRuntime && props.artifactS3EncryptionMode) {
	throw new Error(`Artifact encryption is only supported for canaries that use Synthetics runtime version \`syn-nodejs-puppeteer-3.3\` or later, got \`${props.runtime.name}\`.`);
	}

		const puppeteer80 = createCanaryByRuntimes(Runtime.SYNTHETICS_NODEJS_PUPPETEER_8_0);
		const playwright10 = createCanaryByRuntimes(Runtime.SYNTHETICS_NODEJS_PLAYWRIGHT_1_0);

		const hasValidExtension = playwrightValidExtensions.some(ext => fs.existsSync(path.join(assetPath, `${filename}${ext}`)));
		if (runtime.family === RuntimeFamily.NODEJS && runtime.name.includes('puppeteer') && !fs.existsSync(path.join(assetPath, 'nodejs', 'node_modules', nodeFilename))) {

feat(synthetics): node playwright 1.0 and python selenium 4.1 runtime #32245

Are you sure you want to change the base?

feat(synthetics): node playwright 1.0 and python selenium 4.1 runtime #32245

Conversation

badmintoncryer commented Nov 22, 2024

Issue # (if applicable)

Reason for this change

Description of changes

Description of how you validated changes

Checklist

codecov bot commented Nov 22, 2024 • edited Loading

Codecov Report

gracelu0 left a comment

Choose a reason for hiding this comment

aws-cdk-automation left a comment

Choose a reason for hiding this comment

badmintoncryer commented Dec 5, 2024

nmussy left a comment • edited Loading

Choose a reason for hiding this comment

nmussy Dec 14, 2024

Choose a reason for hiding this comment

badmintoncryer Dec 21, 2024

Choose a reason for hiding this comment

nmussy Dec 14, 2024

Choose a reason for hiding this comment

badmintoncryer Dec 22, 2024

Choose a reason for hiding this comment

aws-cdk-automation commented Dec 20, 2024

aws-cdk-automation commented Dec 21, 2024

aws-cdk-automation left a comment

Choose a reason for hiding this comment

badmintoncryer commented Dec 22, 2024

badmintoncryer commented Dec 22, 2024

nmussy Dec 24, 2024

Choose a reason for hiding this comment

aws-cdk-automation commented Dec 24, 2024

AWS CodeBuild CI Report

codecov bot commented Nov 22, 2024 •

edited

Loading

nmussy left a comment •

edited

Loading