- (Should only have to do this once)
cd __fixtures__/test-project && touch yarn.lock && yarn
- Make your changes to the source code.
- Run
RW_STUDIO_USER_PROJECT_PATH=./__fixtures__/test-project yarn rw dev
- Run the Test Project that send in to Studio using
yarn rw dev
inside__fixtures__/test-project
- Be sure you set the OpenTelemetry sdk path in
redwood.toml
to point to the correct path for your project (see example below under Troubleshooting)
- Make your changes to the source code.
- Run
yarn studio:package
- this will rebuild the project and package it locally. - (Re-)start Studio by running
yarn rw studio
from within the__fixtures__/test-project
directory. - Run the Test Project that send in to Studio using
yarn rw dev
inside__fixtures__/test-project
- Be sure you set the OpenTelemetry sdk path in
redwood.toml
to point to the correct path for your project (see example below under Troubleshooting)
If you have to generate migrations because you have altered the database schema please use yarn studio:migrate
as this will set the appropriate configuration above the default yarn rw prisma migrate dev
.
- Run
yarn rwfw project:tarsync
in the project you want to test with. - Run
yarn studio:package
- this will rebuild the project and package it locally. - Edit
./package.json
in the project you want to test with to include a resolution for Studio pointing to the local Studio package. For example:"@redwoodjs/studio": "/Users/tobbe/dev/redwood/studio/packaged.tgz"
- Run
yarn install
in the project you want to test with to install the new version of Studio. - Run the test project (
yarn rw serve
) - Run
yarn rw studio
from within the test project.
- Make your changes to the Studio source code.
- Run
yarn studio:package
in the Studio project. - Run
yarn install
in the test project - Run the test project (
yarn rw serve
) - Run
yarn rw studio
from within the test project.
If you want to try out any Studio GraphQL queries, you may access the Studio GraphQL Playground at:
https://localhost:4318/.redwood/functions/graphql
If you want to make ad hoc queries against the SQLite database, you can find it in .redwood/studio/prisma.sqlite
in the project that sends data to Studio
If you run into any migration issues, run yarn studio:reset
to remove the database so that migrations can be rerun.
yarn studio:reset
Can also be used to reset and clear out the studio db.
If you do not see any traces or spans, check that your redwood.toml
points to the correct path, for example:
[experimental.opentelemetry]
enabled = true
apiSdk = "/Users/dthyresson/Dropbox/Code/redwoodjs/studio/__fixtures__/test-project/api/dist/opentelemetry.js"
RW_STUDIO_DATABASE_URL=file:./dummy.sqlite
- In studio project root
- yarn rw prisma migrate reset to make sure dummy was up-to-date
If adding a view a view:
- yarn rw prisma migrate dev span-attribute-view --create-only
- Wrote view
- Update prisma schema with the view "model"
If adding a mode:
- Update prisma schema with the new "model"
- yarn rw prisma migrate dev
Then ...
- yarn rw prisma migrate reset
- View was applied to "dummy.sqlite"
- yarn studio:package
- Deleted fixtures/test-project/.redwood/studio/prisma.sqlite to make sure migrate deploy really updated
- Run studio via: yarn rw-studio to apply migrations
npm version [major|minor|patch]
git push upstream --follow-tags
yarn studio:package --release
cd packaged
npm publish