e856ee54ff
This is a way to run `npm install` on the compat test fixtures without the node_modules at the root of the repo interfering with the node's module resolution (and that of parcel/webpack/etc). It's hacky because ideally we'd just put each test in its own docker container for simplicity. We tried that in the private repo, but the complexity is not worth the benefit. |
||
|---|---|---|
| .. | ||
| fixtures | ||
| scripts | ||
| utils | ||
| .gitignore | ||
| integrity.compat-test.ts | ||
| package.json | ||
| README.md | ||
| verdaccio.yml | ||
Compatibility tests
This setup helps us test whether Theatre.js is compatible with popular tools in the JS ecosystem, such as Vite, Next.js, webpack, react, vue, etc.
The directory structure
./fixtures(contains the fixtures - read on for more details)parcel2-react18/: The name of the fixture. This name means we're testing a minimal setup of Theatre.js alongsideparcel2andreact18.package/: This is the npm package that contains a minimal setup oftheatre+parcel2+react18.production.compat-test.ts: This is a jest test for creating a production build of this setup.*.compat-test.ts: Any.compat-test.tsfile will be picked up by jest, so you can use more files to test different aspects of the fixture.
How to run the tests
- First, we run
yarn run install-fixtures, which tries to install Theatre.js on a fixture as if@theatre/core|studio|r3fwere installed through npm. This script runs a local npm registry and publishes a production build of all the Theatre.js packages to it. Then, it iterates through./fixtures/*/packageand runs$ npm installon them, using that local npm registry. If this step fails, that usually means one of@theatre/*packages has adependency/peerDependencythat cannot be satisfied bynpm/yarn. So this is always the first thing to fix. - Then, we run
$ yarn test:compat:run, which will run jest on all of*.compat-test.tsfiles, each of which tests an aspect of a test setup. - Most of our fixtures don't actually have
.compat-test.tsfiles, so we'll have to run them manually and see if Theatre still works in them, jut like a manual QA pass.
Gotchas Some bundlers like webpack are not configured to work well with yarn workspaces by default. For example, the webpack config of create-react-app, tries to look up the node_modules chain to find missing dependencies, which is not a behavior that we want in build-tests setups. So if a setup doesn't work, try running it outside the monorepo to see if being in the monorepo is what's causing it to fail.