-
Notifications
You must be signed in to change notification settings - Fork 2.1k
feat(ui-perf): React Query scaffolding + lazy-extension rollout across 9 entity-detail pages #28017
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
harshach
wants to merge
5
commits into
main
Choose a base branch
from
harshach/perceived-latency-p3-fields-rq
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
bfb0005
feat(ui-perf): add @tanstack/react-query + QueryClientProvider
harshach c23930a
perf(ui-perf): trim `extension` from table first-paint, fetch lazily …
harshach a636e99
perf(ui-perf): trim EXTENSION across all entity-detail pages, lazy vi…
harshach 21acb63
perf(ui-perf): wire useLazyEntityExtension on Drive entity pages
harshach 516a881
perf(ui-perf): migrate TableDetailsPageV1 main entity fetch to useQuery
harshach File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
92 changes: 92 additions & 0 deletions
92
openmetadata-ui/src/main/resources/ui/src/hooks/useLazyEntityExtension.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,92 @@ | ||
| /* | ||
| * Copyright 2026 Collate. | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| import { useQuery } from '@tanstack/react-query'; | ||
| import { useEffect } from 'react'; | ||
| import { EntityTabs, TabSpecificField } from '../enums/entity.enum'; | ||
|
|
||
| interface EntityWithExtension { | ||
| extension?: unknown; | ||
| } | ||
|
|
||
| /** | ||
| * Lazily fetch an entity's `extension` (custom-property values) only when the user activates | ||
| * the Custom Properties tab. Replaces what used to be eager inclusion of {@code EXTENSION} | ||
| * in {@code defaultFields} on every entity-detail page load. | ||
| * | ||
| * Why this exists: | ||
| * - Custom property payloads can run into hundreds of KB on entities with many user-defined | ||
| * properties. Most users never open the Custom Properties tab, so paying for it on first | ||
| * paint is wasted bytes. | ||
| * - The pattern (gated useQuery + merge into local state) was the same on every entity | ||
| * detail page; centralising it avoids 8 copies of the same closure-with-effect. | ||
| * | ||
| * Per-page wiring (call at the page top-level, alongside the main entity state): | ||
| * <pre> | ||
| * useLazyEntityExtension<Dashboard>({ | ||
| * entityType: EntityType.DASHBOARD, | ||
| * fqn: dashboardFQN, | ||
| * activeTab, | ||
| * fetcher: getDashboardByFqn, | ||
| * onResolve: (extension) => | ||
| * setDashboardDetails((prev) => ({ ...prev, extension })), | ||
| * }); | ||
| * </pre> | ||
| * | ||
| * The {@code onResolve} callback shape (rather than passing a setState directly) keeps each | ||
| * consumer in control of their own state-shape semantics — some pages init state as | ||
| * `{} as T` (non-undefined), others as `useState<T>()` (T | undefined). Either works. | ||
| * | ||
| * Behaviour: | ||
| * - Query is gated by `enabled: activeTab === CUSTOM_PROPERTIES && Boolean(fqn)` — does | ||
| * nothing on other tabs. | ||
| * - Stable `queryKey` of `[`<type>-extension`, fqn]` — cached across tab toggles, refetched | ||
| * on FQN change with automatic in-flight cancellation. | ||
| * - 60s {@code staleTime} — custom property values change rarely. | ||
| * - On resolve, fires {@code onResolve(extension)} exactly once per fresh fetch. | ||
| * | ||
| * Caveats: | ||
| * - The {@code onResolve} callback identity is not memoised at the call site. We | ||
| * deliberately depend only on `data?.extension` so we don't fire the merge effect on | ||
| * every parent re-render — the latest callback is captured at fire time. | ||
| */ | ||
| export function useLazyEntityExtension<T extends EntityWithExtension>({ | ||
| entityType, | ||
| fqn, | ||
| activeTab, | ||
| fetcher, | ||
| onResolve, | ||
| }: { | ||
| entityType: string; | ||
| fqn: string | undefined; | ||
| activeTab: string | undefined; | ||
| fetcher: (fqn: string, params: { fields: string }) => Promise<T>; | ||
| onResolve: (extension: T['extension']) => void; | ||
| }): void { | ||
| const enabled = activeTab === EntityTabs.CUSTOM_PROPERTIES && Boolean(fqn); | ||
|
|
||
| const { data } = useQuery({ | ||
| queryKey: [`${entityType}-extension`, fqn], | ||
| queryFn: () => | ||
| fetcher(fqn as string, { fields: TabSpecificField.EXTENSION }), | ||
| enabled, | ||
| staleTime: 60_000, | ||
| }); | ||
|
|
||
| useEffect(() => { | ||
| if (data?.extension === undefined) { | ||
| return; | ||
| } | ||
| onResolve(data.extension); | ||
| // onResolve is intentionally omitted from deps — see header comment. | ||
| }, [data?.extension]); | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The
QueryClientProvideris deliberately placed outsideAuthProviderso the cache survives auth-flow remounts. However, there is noqueryClient.clear()call in the logout handler. If user A logs out and user B logs in on the same browser tab, user B may briefly see user A's cached query results (e.g. the extension/custom-properties payload keyed by table FQN). This is a data-leakage vector in shared-machine environments.The PR description justifies the placement for caching feature-flag fetches across auth transitions, but the trade-off needs an explicit cache wipe on credential change.
Suggested fix:
Check the box to apply the fix or reply for a change | Was this helpful? React with 👍 / 👎