Skip to content

Show Aurora add-ons in component SiteOverview - #368

Open
silviubogan wants to merge 11 commits into
plone:mainfrom
silviubogan:addons-versions-in-controlpanels
Open

silviubogan wants to merge 11 commits into
plone:mainfrom
silviubogan:addons-versions-in-controlpanels

Conversation

@silviubogan

@silviubogan silviubogan commented Nov 3, 2026 •

Copy link
Copy Markdown
Member

Made a list of all the installed Aurora add-ons below the version information under the control panels' list.


If your pull request closes an open issue, include the exact text below, immediately followed by the issue number. When your pull request gets merged, then that issue will close automatically.

Closes #366

@silviubogan
silviubogan marked this pull request as ready for review November 3, 2026 22:38
@sneridagh

Copy link
Copy Markdown
Member

@silviubogan thanks for working on this Silviu! One thing, I wanted this to take the shape of a virtual module like the last we added during the last weeks. Can I amend your work on this PR?

@sneridagh

Copy link
Copy Markdown
Member

@silviubogan btw, I merged: #363 so it has to be added and make it work well with the work there.

@silviubogan

Copy link
Copy Markdown
Member Author

@sneridagh

I wanted this to take the shape of a virtual module like the last we added during the last weeks.

Please give me some links. I'm curious.

Can I amend your work on this PR?

Yes.

@silviubogan silviubogan changed the title Show Aurora add-ons in component VersionOverview Show Aurora add-ons in component SiteOverview Nov 7, 2026
The Plone registry Vite plugin generates .plone/registry.appInfo.js with
the name and version of the app and of its add-ons, in add-on order, and
aliases @plone/registry/app-info to it. It has no file system paths, so
client code can import it. Outside of a Vite app it resolves to an empty
fallback in virtual/.

The site overview reads the app version from it instead of importing the
Aurora app's package.json from cmsui.

Assisted-by: Claude Opus 5.5
@sneridagh

sneridagh commented Nov 7, 2026 •

Copy link
Copy Markdown
Member

@silviubogan, I opened plone/aurora#403 · Add the @plone/registry/app-info… as a base for this one, and I’d like refactor this PR on top of it. Here’s why.

Why a separate PR: reading the add-ons is infrastructure in @plone/registry, and the list in SiteOverview is a UI feature. Splitting them keeps each part small to review, and the registry part is useful outside the control panel too.

Why we’re dropping the Volto approach (addonsInfo from the add-ons loader, stored in config.settings):

It leaks local paths. addonsInfo is the whole Package record of each add-on, including modulePath, packageJson and basePath. These are absolute paths of the machine that built the site. Putting it in config.settings sends those paths to every visitor’s browser.
It isn’t how Aurora does build-time data. Aurora exposes generated data as virtual modules (@plone/registry/blocks-docs, @plone/registry/plate-editor). The Vite plugin generates each one, and each has a safe fallback for tests and Storybook. Nothing gets copied into config.settings at startup.
It ties code to the internal Package type. Using @plone/registry/addon-registry for its Package type means depending on the registry’s internals just to read a name and a version.

What plone/aurora#403 · Add the @plone/registry/app-info… adds: import appInfo from '@plone/registry/app-info' gives { name, version, addons: [{ name, version }] } with no paths. In tests and Storybook it resolves to an empty app (or you can vi.mock it). SiteOverview already uses it for the Aurora version, so cmsui no longer imports apps/aurora/package.json.

For this PR, after rebasing on plone/aurora#403 · Add the @plone/registry/app-info…:

Read appInfo.addons in SiteOverview.
Drop config.settings.addonsInfo, the addons prop and the Package imports.
Keep your UI, copy button, translations and tests. Mock @plone/registry/app-info in the test and the story.
Note that, as it stands now, the list is always empty in the app: addons defaults to [], which is truthy, so the fallback to config.settings.addonsInfo is never reached.

Here is the mockup with how would it work with the current version of the control panel.

Image

Add-ons Info in Control panel main.zip

Thanks again!

@silviubogan
silviubogan force-pushed the addons-versions-in-controlpanels branch from a255f4a to eaf7069 Compare November 8, 2026 01:12
@read-the-docs-community

read-the-docs-community Bot commented Nov 8, 2026 •

Copy link
Copy Markdown

Documentation build overview

📚 plone-registry | 🛠️ Build #35744885 | 📁 Comparing 54f4e79 against latest (7e3cc8f)

  🔍 Preview build  

1 file changed
± conceptual-guides/add-on-loader.html

@silviubogan

Copy link
Copy Markdown
Member Author

@sneridagh Please review.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add add-on versions to the controlpanel main view

2 participants