marmelab / marmelab/greenframe-cli
Better access to playwright API
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 284
- Forks
- 12
- PR merge metrics
- No merged PRs in 30d
Description
# Problem
## No playwright configuration
Can't pass options to browser or context, like ignoreHTTPErrors, locale, timezone. Every time we want to support a playwright feature, we need to implement a new flag and publish a new version
## Can't reuse existing playwright tests
If I'm already using playwright as my e2e test framework and have some actual e2e tests, I would like to be able to use the same files and not have to maintain the same test for playwright, and for greenframe
## Can't use page objects
Since I can't import local files in my greenframe tests, I can't implement the page object pattern on my scenarios. It's really a pity because this pattern is very common and makes tests so much more readable.
## VM2 isolation is not needed in the CLI
We don't need VM2 isolation when executing tests locally, which is what greenframe-cli is doing.
VM2 makes it impossible to use imports and such.
## Distant mode still needs to work
For now, it only sends the scenario files set in the configuration file. But if we want to be able to plug greenframe to any pre existing test suite, we need to be able to have the full code, imported modules too.
# Solution for local open and analyze
- Remove VM2
- Execute playwright programmatically directly from the CLI code, with all the context of the project we're in. (playwright can't be executed programmatically, we'll have to do a bash exec with npx run playwright)
- Add a greenframe init that proxies playwright init ?
This will break the functions we added to playwright page object.
We should probably have a `@greenframe/playwright` that overrides the page object of playwright to add `waitForNetworkIdle`, `scrollToElement`, `scrollByDistance`, `scrollToEnd`, `addMilestone`, `getMilestones`.
# Solution for distant mode
In order for us to execute distant playwright tests, we need to...
- resolve all local imports
- allow people to import "@playwright/test"
- allow people to use pure playwright test
My guess is that, if we transpile the playwright test locally before sending to greenframe servers, it should include local imports (and maybe even playwright and all other libs or playwright extensions used)
We could even support typescript if we do that.
The analyzes running on greenframe servers should still use VM2 and disallow all external or node-builtin(fs,fetch...) module access.
We can probably do a cheaper solution by disallowing any import other than `@playwright/test` and `@greenframe/playwright` in the tests files. It should be good enough for people wanting distant analyzes.
# Breaking changes
All previously written scenarios won't work anymore.
They will need a few changes:
- import `@playwright/test`
- import `@greenframe/playwright` if any GF functions were used
- wrap the function in test()
This can probably be codmodded
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the greenframe-cli execution path and the VM2 boundary described in the issue; compare local open-and-analyze behavior with distant mode and existing Playwright scenario handling. Map the required configuration, imports, page-object extensions, and migration changes before implementation. Done means pre-existing Playwright suites work in both modes while preserving the stated distant-mode isolation rules.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- cli, developer-experience, testing-qa
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100