langgenius/dify
1
0
Fork 0
mirror of https://github.com/langgenius/dify.git synced 2026-08-25 11:59:42 -04:00
Code Issues 775 Packages Projects Releases 10 Wiki Activity

[Refactor/Chore] Standardize TanStack Query key organization pattern #21559

New Issue
Closed
opened 2026-02-21 20:13:12 -05:00 by yindo · 0 comments
yindo commented 2026-02-21 20:13:12 -05:00
Owner
Copy Link
Copy Source

Originally created by @lyzno1 on GitHub (Jan 10, 2026).

Description

Standardize TanStack Query key organization pattern. Not an immediate refactor — just a guideline for new code and opportunistic improvements.

Related: #30342

Problem

Most service files (~20+) have inconsistent query key patterns:

  • Inline keys in useQuery calls
  • Scattered variables, not exported
  • Missing as const
  • No hierarchy for batch invalidation

Solution

Follow the hierarchical pattern with all root key:

const NAME_SPACE = 'myModule'

export const myModuleKeys = {
  all: [NAME_SPACE] as const,
  list: (params: Params) => [...myModuleKeys.all, 'list', params] as const,
  detail: (id: string) => [...myModuleKeys.all, 'detail', id] as const,
} as const

Why this works:

  • all root → invalidateQueries({ queryKey: keys.all }) clears entire module
  • [...parent, 'child'] → TanStack Query uses prefix matching
  • as const → TypeScript infers exact tuple types

Reference Files

https://github.com/langgenius/dify/blob/a2e03b811e581674603617a4b13d9d25760c44be/web/app/components/plugins/marketplace/query.ts#L8-L13

https://github.com/langgenius/dify/blob/a2e03b811e581674603617a4b13d9d25760c44be/web/service/use-common.ts#L32-L62

Migration

  1. New code → follow this pattern
  2. Existing code → refactor when modifying for other reasons

Files to improve when touched: use-apps.ts, use-plugins.ts, use-tools.ts, use-workflow.ts, use-triggers.ts, use-log.ts, use-explore.ts, knowledge/use-*.ts

Motivation

Enable batch cache invalidation, improve type safety, reduce copy-paste errors.

Originally created by @lyzno1 on GitHub (Jan 10, 2026). ## Description Standardize TanStack Query key organization pattern. **Not** an immediate refactor — just a guideline for new code and opportunistic improvements. Related: #30342 ### Problem Most service files (~20+) have inconsistent query key patterns: - Inline keys in `useQuery` calls - Scattered variables, not exported - Missing `as const` - No hierarchy for batch invalidation ### Solution Follow the hierarchical pattern with `all` root key: ```typescript const NAME_SPACE = 'myModule' export const myModuleKeys = { all: [NAME_SPACE] as const, list: (params: Params) => [...myModuleKeys.all, 'list', params] as const, detail: (id: string) => [...myModuleKeys.all, 'detail', id] as const, } as const ``` **Why this works:** - `all` root → `invalidateQueries({ queryKey: keys.all })` clears entire module - `[...parent, 'child']` → TanStack Query uses prefix matching - `as const` → TypeScript infers exact tuple types ### Reference Files https://github.com/langgenius/dify/blob/a2e03b811e581674603617a4b13d9d25760c44be/web/app/components/plugins/marketplace/query.ts#L8-L13 https://github.com/langgenius/dify/blob/a2e03b811e581674603617a4b13d9d25760c44be/web/service/use-common.ts#L32-L62 ### Migration 1. **New code** → follow this pattern 2. **Existing code** → refactor when modifying for other reasons Files to improve when touched: `use-apps.ts`, `use-plugins.ts`, `use-tools.ts`, `use-workflow.ts`, `use-triggers.ts`, `use-log.ts`, `use-explore.ts`, `knowledge/use-*.ts` ## Motivation Enable batch cache invalidation, improve type safety, reduce copy-paste errors.
yindo added the 💪 enhancement label 2026-02-21 20:13:12 -05:00
yindo closed this issue 2026-02-21 20:13:12 -05:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
Knowledge Pipeline
Proposal
WIP
cloud
dependencies
feat:webapp
good first issue
outdated
performance
pull-request
Mirrored from GitHub Pull Request
 python:uv
refactor
size:L
stale
status: accepting prs
status: blocked
status: in discussion
stt & tts
vulnerablity
web
wont-fix
🌊 feat:workflow
🌚 invalid
🐞 bug
👻 feat:rag
💪 enhancement
📚 documentation
🔨 feat:tools
🙋‍♂️ question
🙏 help wanted
🤔 cant-reproduce
🤖 feat:agent
No Label 💪 enhancement
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
yindo
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: langgenius/dify#21559
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?