UI: Surfacing plugin version for Secret Engines #30712

drivera258 · 2025-05-21T20:40:56Z

Description

What does this PR do?

Update to surface running plugin versions next to each enabled secret engine on list view
Add version (if applicable) to engine to icon tooltip
Add unsupported message to icon tooltip for secret engines that are not supported

Before	After

TODO only if you're a HashiCorp employee

Backport Labels: If this fix needs to be backported, use the appropriate backport/ label that matches the desired release branch. Note that in the CE repo, the latest release branch will look like backport/x.x.x, but older release branches will be backport/ent/x.x.x+ent.
- LTS: If this fixes a critical security vulnerability or severity 1 bug, it will also need to be backported to the current LTS versions of Vault. To ensure this, use all available enterprise labels.
ENT Breakage: If this PR either 1) removes a public function OR 2) changes the signature
of a public function, even if that change is in a CE file, double check that
applying the patch for this PR to the ENT repo and running tests doesn't
break any tests. Sometimes ENT only tests rely on public functions in CE
files.
Jira: If this change has an associated Jira, it's referenced either
in the PR description, commit message, or branch name.
RFC: If this change has an associated RFC, please link it in the description.
ENT PR: If this change has an associated ENT PR, please link it in the
description. Also, make sure the changelog is in this PR, not in your ENT PR.

github-actions · 2025-05-21T21:04:27Z

CI Results:
All Go tests succeeded! ✅

github-actions · 2025-05-23T16:58:52Z

Build Results:
All builds succeeded! ✅

drivera258 · 2025-05-28T20:47:49Z

ui/app/helpers/engines-display-name.js

+ * TODO: maybe add param on object that mentions secret or auth or enterprise
+ */
+
+const ALL_ENGINES = [


When Angel and I paired on this, we decided on removing the auth-display-names helper (that claire created when doing auth work) in favor of have just one centralized helper for getting display names (ie. this file)

However tests were being wonky with swapping the auth helper with this new one so i undid my changes and kept them separate

A helper that returns an array isn't really a good use case for creating a helper. I think it'd make much more sense to make thisconst a util and the helper could be a find function (engine-display-data) that takes a type as an argument. We've historically used helpers for lots of things that should technically be utils.

Feel free to update use cases of auth-display-names if you do the above!

@Monkeychip - let me know if you disagree! I don't want to give conflicting suggestions 😄

hellobontempo · 2025-05-28T21:07:04Z

ui/app/components/secret-engine/list.hbs

+            @text={{if
+              backend.isSupportedBackend
+              (concat
+                (get (find-by "type" backend.type (engines-display-name)) "displayName")
+                (if (eq backend.version 2) " version 2" (if (eq backend.version 1) " version 1" ""))
+              )
+              "This secret engine type is not currently supported by the UI."
+            }}


Could this logic be moved into a template helper in the component file? It might make it a little easier to parse and reduce the chance for regressions if/when updates are made in the future

Update per suggestion below - I think it'd make sense to update engine-display-names to be engine-display-data that was a find function which would clean this logic up as well

Monkeychip · 2025-05-28T21:07:43Z

ui/lib/core/addon/components/secrets-engine-mount-config.ts

@@ -36,6 +36,7 @@ export default class SecretsEngineMountConfig extends Component<Args> {
      { label: 'Secret Engine Type', value: model.engineType },
      { label: 'Path', value: model.path },
      { label: 'Accessor', value: model.accessor },
+      { label: 'Running Plugin Version', value: model.runningPluginVersion },


According to our capitalization policy (confirmed in the Figma file "Capitalization"), we use Title Case for headings and titles, but Sentence case for attributes and labels. I initially used Running Plugin Version to match the existing labels on this form, but technically, it should be sentence-cased. If you feel so inclined, could you update the rest of the Labels on this model to match this pattern? Note: because of openAPI the only time we don't use sentence-case is with Default Lease TTL or Max Lease TTL.

Suggested change

{ label: 'Running Plugin Version', value: model.runningPluginVersion },

{ label: 'Running plugin version', value: model.runningPluginVersion },

Monkeychip · 2025-05-28T21:08:30Z

ui/tests/acceptance/secret-engine-list-view-test.js

+      .dom('.hds-tooltip-container')
+      .hasText(
+        'This secret engine type is not currently supported by the UI.',
+        'shows tooltip for unsupported engine'


Suggested change

'shows tooltip for unsupported engine'

'shows tooltip text for unsupported engine'

Monkeychip · 2025-05-28T21:10:06Z

ui/tests/acceptance/secret-engine-list-view-test.js

+    await selectChoose(GENERAL.searchSelect.trigger('filter-by-engine-type'), 'kv');
+
+    await triggerEvent('.hds-tooltip-button', 'mouseenter');
+    assert.dom('.hds-tooltip-container').hasText('KV version 2', 'shows tooltip for kv version 2');


Could we add another section to this test to cover a non-versioned supported engine—like ssh—that won’t include a version in the text? It’s part of the logic, so I want to make sure that case is explicitly covered.

hellobontempo · 2025-05-28T21:13:13Z

ui/app/helpers/engines-display-name.js

+  return ALL_ENGINES.slice();
+}
+
+export default buildHelper(methods);


Using buildHelper is outdated syntax and no longer necessary, the function can just be exported https://guides.emberjs.com/release/components/helper-functions/#toc_global-helper-functions

hellobontempo · 2025-05-28T21:14:05Z

ui/app/helpers/engines-display-name.js

+  {
+    displayName: 'LDAP',
+    type: 'ldap',
+    engineRoute: 'ldap.overview',


I believe engineRoute keys should probably deleted as it's unrelated to the function of this const?

drivera258 added 2 commits May 21, 2025 14:56

surfacing running version

3474f7a

Merge branch 'main' into ui/VAULT-34931/add-plugin-version

d5650c0

drivera258 changed the title ~~UI: Surfacing plugin version~~ UI: Surfacing plugin version for Secret Engines May 21, 2025

github-actions bot added the hashicorp-contributed-pr If the PR is HashiCorp (i.e. not-community) contributed label May 21, 2025

drivera258 added pr/no-changelog pr/no-milestone labels May 21, 2025

vercel bot deployed to Preview May 21, 2025 20:48 View deployment

update test

952fff9

drivera258 marked this pull request as ready for review May 23, 2025 16:55

drivera258 requested a review from a team as a code owner May 23, 2025 16:55

Merge branch 'main' into ui/VAULT-34931/add-plugin-version

539361f

vercel bot deployed to Preview May 23, 2025 19:47 View deployment

Monkeychip and others added 2 commits May 23, 2025 14:05

clean up and add version 1 for kv version1

6ad3c3b

update to use right helper

e0768ba

drivera258 marked this pull request as draft May 27, 2025 22:23

drivera258 added 4 commits May 27, 2025 18:23

updating get

f2ed453

moving things back

530590f

adding tests for tooltips

d347bc1

removing line

8c87d83

drivera258 added this to the 1.20.0-rc milestone May 28, 2025

changelog

4422d88

drivera258 added ui and removed pr/no-changelog pr/no-milestone labels May 28, 2025

drivera258 marked this pull request as ready for review May 28, 2025 19:15

drivera258 requested a review from a team as a code owner May 28, 2025 19:15

drivera258 requested review from robmonte and removed request for robmonte May 28, 2025 19:15

drivera258 commented May 28, 2025

View reviewed changes

hellobontempo reviewed May 28, 2025

View reviewed changes

Monkeychip reviewed May 28, 2025

View reviewed changes

hellobontempo reviewed May 28, 2025

View reviewed changes

drivera258 added 5 commits May 29, 2025 11:39

Pr comments

67313e4

fixing tests

a7184bb

updating const & helper usage

e4c7757

fix tests pt2

75569ad

maybe commit all files

a981a25

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

UI: Surfacing plugin version for Secret Engines #30712

UI: Surfacing plugin version for Secret Engines #30712

drivera258 commented May 21, 2025 •

edited

Loading

Uh oh!

github-actions bot commented May 21, 2025 •

edited

Loading

Uh oh!

github-actions bot commented May 23, 2025

Uh oh!

drivera258 May 28, 2025 •

edited

Loading

Uh oh!

hellobontempo May 28, 2025 •

edited

Loading

Uh oh!

hellobontempo May 28, 2025

Uh oh!

hellobontempo May 28, 2025

Uh oh!

hellobontempo May 28, 2025

Uh oh!

hellobontempo May 28, 2025

Uh oh!

Monkeychip May 28, 2025

Uh oh!

Monkeychip May 28, 2025

Uh oh!

Monkeychip May 28, 2025 •

edited

Loading

Uh oh!

hellobontempo May 28, 2025

Uh oh!

hellobontempo May 28, 2025

Uh oh!

Uh oh!

	{ label: 'Running Plugin Version', value: model.runningPluginVersion },
	{ label: 'Running plugin version', value: model.runningPluginVersion },

	'shows tooltip for unsupported engine'
	'shows tooltip text for unsupported engine'

UI: Surfacing plugin version for Secret Engines #30712

Are you sure you want to change the base?

UI: Surfacing plugin version for Secret Engines #30712

Conversation

drivera258 commented May 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

TODO only if you're a HashiCorp employee

Uh oh!

github-actions bot commented May 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented May 23, 2025

Uh oh!

drivera258 May 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hellobontempo May 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Monkeychip May 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

drivera258 commented May 21, 2025 •

edited

Loading

github-actions bot commented May 21, 2025 •

edited

Loading

drivera258 May 28, 2025 •

edited

Loading

hellobontempo May 28, 2025 •

edited

Loading

Monkeychip May 28, 2025 •

edited

Loading