FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

[FEATURE] Add plugin versioning support + dashboard lock mode by Gladorme · Pull Request #243 · perses/shared · GitHub

/ shared Public

[FEATURE] Add plugin versioning support + dashboard lock mode - #243

Draft
Gladorme wants to merge 8 commits into
perses:mainfrom
Gladorme:versioning-lock
ConversationCommits (8)ChecksFiles changed
Draft

[FEATURE] Add plugin versioning support + dashboard lock mode#243
Gladorme wants to merge 8 commits into
perses:mainfrom
Gladorme:versioning-lock

Conversation

Gladorme commented Aug 20, 2026

Copy link
Copy Markdown
Member

Description

The goal of this PR is to improve the handling of plugin versioning in dashboard:

  • show plugin version in panel type selector if there is more than one version available
  • "lock" dashboard feature

What is doing the lock mode?
Lock will enforce versioning on all plugins. It will use latest version installed. When a new version is available, it will show a button to update, with a nice diff based on the first panel using the plugin (only for panel plugin). If the plugin version pinned is no longer available, it will show a error.

Blocked, need spec release v0.3.0-beta.4 fixed (token expired, need @Nexucis back :p) and need perses/plugins#773 too

Screenshots

Checklist

  • Pull request has a descriptive title and context useful to a reviewer.
  • Pull request title follows the [<catalog_entry>] <commit message> naming convention using one of the
    following catalog_entry values: FEATURE, ENHANCEMENT, BUGFIX, BREAKINGCHANGE, DOC,IGNORE.
  • All commits have DCO signoffs.

UI Changes

  • Changes that impact the UI include screenshots and/or screencasts of the relevant changes.
  • Code follows the UI guidelines.
  • E2E tests are stable and unlikely to be flaky.
    See e2e docs for more details. Common issues include:
    • Is the data inconsistent? You need to mock API requests.
    • Does the time change? You need to use consistent time values or mock time utilities.
    • Does it have loading states? You need to wait for loading to complete.

Gladorme changed the title Versioning lock [FEATURE] Add plugin versioning + dashboard lock mode Aug 20, 2026
Gladorme changed the title [FEATURE] Add plugin versioning + dashboard lock mode [FEATURE] Add plugin versioning support + dashboard lock mode Aug 20, 2026
Gladorme mentioned this pull request Aug 21, 2026
Draft
6 tasks
shahrokni self-requested a review August 21, 2026 10:52

shahrokni commented Aug 21, 2026

Copy link
Copy Markdown
Contributor

I see this PR is still in draft mode. Are you still working on this?

Gladorme commented Aug 21, 2026

Copy link
Copy Markdown
Member Author

I see this PR is still in draft mode. Are you still working on this?

No, the PR is ready, but it's depending on other PRs, so can't be merged

[FEATURE] Add dashboard versioning
700b5c3 
Signed-off-by: Guillaume LADORME <Gladorme@users.noreply.github.com>
Enforce version selected
9f7cc70 
Signed-off-by: Guillaume LADORME <Gladorme@users.noreply.github.com>
Add versioning to panel type
5edcc41 
Signed-off-by: Guillaume LADORME <Gladorme@users.noreply.github.com>
Add update drawer
dbec5fe 
Signed-off-by: Guillaume LADORME <Gladorme@users.noreply.github.com>
Handle dev plugin
e81a4fd 
Signed-off-by: Guillaume LADORME <Gladorme@users.noreply.github.com>
Reviewing
b0713ab 
Signed-off-by: Guillaume LADORME <Gladorme@users.noreply.github.com>
Apply review changes
7802d79 
Signed-off-by: Guillaume LADORME <Gladorme@users.noreply.github.com>
Fix unlock + lock button
de61b8c 
Signed-off-by: Guillaume LADORME <Gladorme@users.noreply.github.com>
jgbernalp reviewed Aug 27, 2026
View reviewed changes
Comment thread dashboards/src/components/GridLayout/GridItemContent.tsx
const { data: plugin } = usePlugin(
'Panel',
panelDefinition.spec.plugin.kind,
undefined,

jgbernalp Aug 27, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

we probably can include the plugin version and registry as part of the options, so we don't have to pass undefined and the hook signature does not change drastically

jgbernalp reviewed Aug 28, 2026
View reviewed changes
Comment thread dashboards/src/components/GridLayout/GridItemContent.tsx
Comment on lines +106 to +111
const { data: plugin } = usePlugin(
'Panel',
panelDefinition.spec.plugin.kind,
undefined,
getPluginOverrides(panelDefinition.spec.plugin),
);

jgbernalp Aug 28, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality
Suggested change
const { data: plugin } = usePlugin(
'Panel',
panelDefinition.spec.plugin.kind,
undefined,
getPluginOverrides(panelDefinition.spec.plugin),
);
const { data: plugin } = usePlugin(
'Panel',
panelDefinition.spec.plugin.kind,
{
version: panelDefinition.spec.metadata?.version,
registry: panelDefinition.spec.metadata?.registry,
}
);

jgbernalp reviewed Aug 28, 2026
View reviewed changes
Comment thread plugin-system/src/runtime/plugin-registry.ts
* Extract the pinned version/registry from a plugin definition's `metadata`, if any. Returns `undefined` when nothing
* is pinned so the plugin resolves to its latest available version.
*/
export function getPluginOverrides(

jgbernalp Aug 28, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

We don't need this function and can pass the values of plugin?.metadata?.version and plugin?.metadata?.registry directly as the latest version is left empty on purpose.

jgbernalp reviewed Aug 28, 2026
View reviewed changes
Comment thread plugin-system/src/runtime/plugin-registry.ts
Comment on lines 87 to +88
options?: UsePluginOptions<T>,
overrides?: PluginDefinitionMetadata,

jgbernalp Aug 28, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality
Suggested change
options?: UsePluginOptions<T>,
overrides?: PluginDefinitionMetadata,
options?: UsePluginOptions<T>,

jgbernalp reviewed Aug 28, 2026
View reviewed changes
Comment thread plugin-system/src/runtime/plugin-registry.ts
@@ -45,57 +46,111 @@ export function usePluginRegistry(): PluginRegistryContextType {

// Allows consumers to pass useQuery options from react-query when loading a plugin
type UsePluginOptions<T extends PluginType> = Omit<

jgbernalp Aug 28, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality
Suggested change
type UsePluginOptions<T extends PluginType> = Omit<
type UsePluginOptions<T extends PluginType> = Omit<
UseQueryOptions<PluginImplementation<T>, Error, PluginImplementation<T>, UsePluginQueryKey>,
'queryKey' | 'queryFn'
> & {
/** Pin resolution to a specific plugin version. When omitted, the latest available version is used. */
version?: string;
/** Pin resolution to a specific plugin registry. */
registry?: string;
};

jgbernalp reviewed Aug 28, 2026
View reviewed changes
Comment thread plugin-system/src/runtime/profile-queries.ts
const plugin = await getPlugin({
kind: PROFILE_QUERY_KEY,
name: profileQueryKind,
...getPluginOverrides(definition.spec.plugin),

jgbernalp Aug 28, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality
Suggested change
...getPluginOverrides(definition.spec.plugin),
version: definition.spec.plugin.metadata?.version,
registry: definition.spec.plugin.metadata?.registry,

jgbernalp reviewed Aug 28, 2026
View reviewed changes
Comment thread plugin-system/src/runtime/time-series-queries.ts
Comment on lines +96 to +97
undefined,
getPluginOverrides(definition.spec.plugin),

jgbernalp Aug 28, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality
Suggested change
undefined,
getPluginOverrides(definition.spec.plugin),
{
version: definition.spec.plugin.metadata?.version,
registry: definition.spec.plugin.metadata?.registry,
}

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
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

jgbernalp jgbernalp left review comments
shahrokni Awaiting requested review from shahrokni

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

Back | FazBrowse Home | New Git URL