feat(queryKey): add optional tags parameter to query key functions #2391

ahmedrowaihi · 2025-08-06T02:36:25Z

I think we fixed tanstack frontend invalidation forever by this PR
use case:

function predicate(query: Query) {
    return query.queryKey[0].tags?.includes('Resource');
}

thank you @mrlubos for such a wonderful lib

bolt-new-by-stackblitz · 2025-08-06T02:36:28Z

Run & review this pull request in StackBlitz Codeflow.

changeset-bot · 2025-08-06T02:36:28Z

🦋 Changeset detected

Latest commit: ac3456f

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
@hey-api/openapi-ts	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

vercel · 2025-08-06T02:36:29Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
hey-api-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Aug 6, 2025 1:25pm

codecov · 2025-08-06T02:58:27Z

Codecov Report

❌ Patch coverage is 0% with 53 lines in your changes missing coverage. Please review.
✅ Project coverage is 22.46%. Comparing base (ebf969d) to head (ac3456f).
⚠️ Report is 6 commits behind head on main.

Files with missing lines	Patch %	Lines
...pi-ts/src/plugins/@tanstack/query-core/queryKey.ts	0.00%	43 Missing ⚠️
...ins/@tanstack/angular-query-experimental/config.ts	0.00%	2 Missing ⚠️
...api-ts/src/plugins/@tanstack/react-query/config.ts	0.00%	2 Missing ⚠️
...api-ts/src/plugins/@tanstack/solid-query/config.ts	0.00%	2 Missing ⚠️
...pi-ts/src/plugins/@tanstack/svelte-query/config.ts	0.00%	2 Missing ⚠️
...enapi-ts/src/plugins/@tanstack/vue-query/config.ts	0.00%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2391      +/-   ##
==========================================
- Coverage   22.50%   22.46%   -0.04%     
==========================================
  Files         324      324              
  Lines       31904    31956      +52     
  Branches     1234     1234              
==========================================
  Hits         7179     7179              
- Misses      24716    24768      +52     
  Partials        9        9

Flag	Coverage Δ
unittests	`22.46% <0.00%> (-0.04%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

pkg-pr-new · 2025-08-06T02:58:36Z

Open in StackBlitz

npm i https://pkg.pr.new/hey-api/openapi-ts/@hey-api/nuxt@2391

npm i https://pkg.pr.new/hey-api/openapi-ts/@hey-api/openapi-ts@2391

npm i https://pkg.pr.new/hey-api/openapi-ts/@hey-api/vite-plugin@2391

commit: ac3456f

mrlubos · 2025-08-06T09:30:02Z

@ahmedrowaihi

What do you think about adding queryKeys.tags and infiniteQueryKeys.tags options to optionally enable/disable this setting?
Should it be enabled by default? It's definitely going to make query keys larger.
Any concern about potentially breaking any of the existing functionality?

ahmedrowaihi · 2025-08-06T10:04:09Z

What do you think about adding queryKeys.tags and infiniteQueryKeys.tags options to optionally enable/disable this setting?

Reasonable, we should add it

Should it be enabled by default? It's definitely going to make query keys larger.

Not really, we may make it disabled by default

Any concern about potentially breaking any of the existing functionality?

the Infinite ? .... : undefined check was either passing a value or remove it, now I made it always set either true or false, I tested that no issues

mrlubos · 2025-08-06T10:10:08Z

@ahmedrowaihi great!

is definitely some extra work, but I think it's worth it. Every version of the plugin needs updated types.d.ts, you should be able to copy-paste between version though.
sounds good to me
I meant in terms of adding these tags. However, if you're going to keep it disabled by default, this question is irrelevant

…ter cache invalidation

ahmedrowaihi · 2025-08-06T10:38:53Z

@mrlubos anymore suggestions ?

mrlubos

The pull request looks perfect to me! I'm only submitting one change request so we get a cleaner diff if not using tags. Now that tags are disabled by default, you may also consider adding a test showing what it looks like when they're enabled. This is totally up to you though, I might not have configured tests to easily add such change

packages/openapi-ts/src/plugins/@tanstack/query-core/queryKey.ts

mrlubos · 2025-08-06T11:56:09Z

@ahmedrowaihi please rerun snapshots again so CI passes

Co-authored-by: Lubos <lmenus@lmen.us>

mrlubos

Looking good, thank you!

ahmedrowaihi · 2025-08-06T14:06:18Z

Looking good, thank you!

welcome ! yet I have another PR #2399 :'D

vercel bot deployed to Preview August 6, 2025 02:37 View deployment

vercel bot deployed to Preview August 6, 2025 02:55 View deployment

mrlubos self-assigned this Aug 6, 2025

vercel bot deployed to Preview August 6, 2025 10:28 View deployment

ahmedrowaihi force-pushed the feat/tags branch from 6819c49 to b0051f3 Compare August 6, 2025 10:36

vercel bot deployed to Preview August 6, 2025 10:37 View deployment

ahmedrowaihi added 2 commits August 6, 2025 13:37

feat(queryKey): add optional tags parameter to query key functions

936d47b

feat(queryKey): add 'tags' option to query key configurations for bet…

8f32b50

…ter cache invalidation

ahmedrowaihi force-pushed the feat/tags branch from b0051f3 to a29088c Compare August 6, 2025 10:37

vercel bot deployed to Preview August 6, 2025 10:38 View deployment

mrlubos requested changes Aug 6, 2025

View reviewed changes

packages/openapi-ts/src/plugins/@tanstack/query-core/queryKey.ts Outdated Show resolved Hide resolved

vercel bot deployed to Preview August 6, 2025 11:30 View deployment

ahmedrowaihi requested a review from mrlubos August 6, 2025 11:30

hotfix(createQueryKeyCallExpression): reduce generated boilerplate

7d04268

Co-authored-by: Lubos <lmenus@lmen.us>

ahmedrowaihi force-pushed the feat/tags branch from 6a948e3 to 6546da0 Compare August 6, 2025 12:26

vercel bot deployed to Preview August 6, 2025 12:27 View deployment

feat(queryKey): update snapshot tests

0a6f7fe

ahmedrowaihi force-pushed the feat/tags branch from 6546da0 to 0a6f7fe Compare August 6, 2025 12:27

vercel bot deployed to Preview August 6, 2025 12:29 View deployment

Create flat-paws-sniff.md

ac3456f

mrlubos approved these changes Aug 6, 2025

View reviewed changes

vercel bot requested a deployment to Preview August 6, 2025 13:25 Abandoned

vercel bot deployed to Preview August 6, 2025 13:25 View deployment

mrlubos merged commit b3a6f96 into hey-api:main Aug 6, 2025
15 of 17 checks passed

github-actions bot mentioned this pull request Aug 6, 2025

Version Packages #2398

Merged

ahmedrowaihi deleted the feat/tags branch August 6, 2025 13:57

Uh oh!

feat(queryKey): add optional tags parameter to query key functions #2391

feat(queryKey): add optional tags parameter to query key functions #2391

Uh oh!

Conversation

ahmedrowaihi commented Aug 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bolt-new-by-stackblitz bot commented Aug 6, 2025

Uh oh!

changeset-bot bot commented Aug 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

vercel bot commented Aug 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Aug 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

pkg-pr-new bot commented Aug 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mrlubos commented Aug 6, 2025

Uh oh!

ahmedrowaihi commented Aug 6, 2025

Uh oh!

mrlubos commented Aug 6, 2025

Uh oh!

ahmedrowaihi commented Aug 6, 2025

Uh oh!

mrlubos left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mrlubos commented Aug 6, 2025

Uh oh!

mrlubos left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ahmedrowaihi commented Aug 6, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

ahmedrowaihi commented Aug 6, 2025 •

edited

Loading

changeset-bot bot commented Aug 6, 2025 •

edited

Loading

vercel bot commented Aug 6, 2025 •

edited

Loading

codecov bot commented Aug 6, 2025 •

edited

Loading

pkg-pr-new bot commented Aug 6, 2025 •

edited

Loading