aws / aws/aws-cdk

@amzn/synthetics-playwright: Make @amzn/synthetics-playwright public available?

Open
#35,183 6 comments 3 reactions 0 assignees View on GitHub
@aws-cdk/aws-synthetics feature-request p2
Dominant language
TypeScript
Stars
12.9k
Forks
4.6k
Avg merge
2d 3h
Merged PRs (30d)
83

Description

### Describe the feature

Make `@amzn/synthetics-playwright` publicly available used for developing AWS Synthetics Node.js based canaries:

https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Synthetics_WritingCanary_Nodejs_Playwright.html

### Use Case

Based on:

https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Synthetics_WritingCanary_Nodejs_Playwright.html

I am using: `@amzn/synthetics-playwright` to write some AWS Synthetics Node.js canaries:

```
import { synthetics } from '@amzn/synthetics-playwright';
import { expect } from '@playwright/test';

export const handler = async () => {
try {
// Launch a browser
const browser = await synthetics.launch();

// Create a new page
const page = await synthetics.newPage(browser);
```

I have not been able to find the '@amzn/synthetics-playwright` anywhere and this indicates its not publicly available https://github.com/guardian/consent-management-platform/blob/7c41ee4929bd5ad9ff4f03c699f09103709d9ba1/synthetics/src/index.js#L1

Is there a change this package could be made publicly available to increase developer experience when writing Node.js canary handlers?

### Proposed Solution

_No response_

### Other Information

_No response_

### Acknowledgements

- [ ] I may be able to implement this feature request
- [ ] This feature might incur a breaking change

### AWS CDK Library version (aws-cdk-lib)

2.201.0

### AWS CDK CLI version

2.1018.1

### Environment details (OS name and version, etc.)

macOS 15.6

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the linked AWS Synthetics Playwright documentation and the existing references to @amzn/synthetics-playwright. Determine what public-package change is required and where it belongs in the aws-cdk project; done means the package is publicly available for the documented Node.js canary workflow.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws, node.js, playwright, typescript
Domain
cloud, developer-experience
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.