Make TanStack Query dev tools load conditionally

maximilianoertel commented 4 weeks ago

Proposed changes

This PR updates the loading mechanism for the TanStack Query dev tools to ensure they are only loaded by default in the development environment.

For debugging purposes, the dev tools can still be accessed in environments where they were previously enabled (such as staging) by setting the VITE_QUERY_DEVTOOLS_ENABLED environment variable and running window.toggleDevtools() in the console.

Types of changes

[ ] Bugfix (non-breaking change which fixes an issue)
[x] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
[ ] Refactoring (non-breaking change that does not add functionality but makes code cleaner or more efficient)
[ ] Documentation Update
[ ] Tests (new or updated tests)
[ ] Style (changes to code styling)
[ ] CI (continuous integration changes)
[ ] Repository Maintenance
[ ] Other (please describe below)

Checklist

[x] I have read the guidelines for contributing.
[x] The changes in this PR are as small as they can be. They represent one and only one fix or enhancement.
[x] Linting checks pass with my changes.
[x] Any existing unit tests pass with my changes.
[x] Any existing end-to-end tests pass with my changes.
[ ] I have added tests that prove my fix is effective or that my feature works.
[ ] If this PR fixes an existing issue, I have added a unit or end-to-end test that will detect if this issue reoccurs.
[ ] I have added JSDoc comments as appropriate.
[ ] I have added the necessary documentation to the roar-docs repository.
[x] I have shared this PR on the roar-pr-reviews channel (if I have access)
[x] I have linked relevant issues (if any)

Justification of missing checklist items

n/a

Further comments

n/a

Ref https://github.com/yeatmanlab/roar/issues/318

github-actions[bot] commented 4 weeks ago

Coverage Report

Status	Category	Percentage	Covered / Total
🔵	Lines	4.36%	336 / 7702
🔵	Statements	4.27%	362 / 8469
🔵	Functions	5.18%	98 / 1890
🔵	Branches	2.21%	102 / 4601

File Coverage

File	Stmts	% Branch	% Funcs	% Lines	Uncovered Lines
Changed Files
src/App.vue	0%	0%	0%	0%	33, 33-36, 35, 35, 42-44, 46-47, 49-53, 50-52, 55, 55, 57, 59-85, 87-89, 88, 91-103, 92-101, 95-100, 96-99, 102, 105-116, 106-107, 109-115, 110-115, 112-114, 113

Generated in workflow #455

github-actions[bot] commented 4 weeks ago

Visit the preview URL for this PR (updated for commit 6d9316d):

https://roar-staging--pr816-ref-318-query-compos-ktgilyci.web.app

_{(expires Tue, 01 Oct 2024 20:31:20 GMT)}

_{🔥 via Firebase Hosting GitHub Action 🌎}

_{Sign: 2631e9c58fd0104ecbfddd72a62245ddac467460}

cypress[bot] commented 4 weeks ago

roar-dashboard-e2e Run #7235

Run Properties: Notests #7235 • 6d9316dd5a: Component Tests for PR 816 "Make TanStack Query dev tools load conditionally" fr...

Project	`roar-dashboard-e2e`
Branch Review	`ref/318/query-composables-dev-tools`
Run status	`Notests #7235`
Run duration	`01m 38s`
Commit	`6d9316dd5a: Component Tests for PR 816 "Make TanStack Query dev tools load conditionally" fr...`
Committer	`Maximilian Oertel`
View all properties for this run ↗︎

Test results
Failures	`0`
Flaky	`0`
Pending	`0`
Skipped	`1`
Passing	`0`
View all changes introduced in this branch ↗︎

richford commented 3 weeks ago

@maximilianoertel , can you rebase to see if that fixes the tests?

yeatmanlab / roar-dashboard