UI: Ember upgrade: Handle deprecation router service from host #28603

hellobontempo · 2024-10-04T21:38:04Z

Description

Handles Use alias for inject router service from host application. This PR is based on initial work done by #28281, which I recommend comparing to the changes here.

In summary this PR:

replaces router engine dependencies with aliased app-router
call the alias @service('app-router') router within engines instead of @service router

Deviations from original PR:

The reason for this is based on the ember guides here:

I decided to handle the transition-to slightly differently than the original PR. I uninstalled ember-router-helpers and replaced it with a global transition-to helper that uses getOwner to dynamically determine which router to use.
Similarly, I refactored LinkedBlock (which is a core component used across engines and the main app) to lookup the appropriate router service via a getter, which felt more stable instead of attempting to inject a service that doesn't exist (which according to above, would throw an error)

TODO only if you're a HashiCorp employee

Backport Labels: If this PR is in the ENT repo and needs to be backported, backport
to N, N-1, and N-2, using the backport/ent/x.x.x+ent labels. If this PR is in the CE repo, you should only backport to N, using the backport/x.x.x label, not the enterprise labels.
- 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 · 2024-10-04T21:41:33Z

Build Results:
All builds succeeded! ✅

github-actions · 2024-10-04T21:46:03Z

CI Results:
All Go tests succeeded! ✅

hellobontempo · 2024-10-07T17:42:29Z

ui/app/app.js

@@ -8,20 +8,27 @@ import Resolver from 'ember-resolver';
 import loadInitializers from 'ember-load-initializers';
 import config from 'vault/config/environment';

-// TODO: DEPRECATION https://ember-engines.com/docs/deprecations#-use-alias-for-inject-router-service-from-host-application


now engines reference the alias app-router instead of router directly

hellobontempo · 2024-10-07T17:43:24Z

ui/lib/config-ui/addon/components/messages/page/create-and-edit.js

@@ -23,7 +23,7 @@ import { isAfter } from 'date-fns';
 */

 export default class MessagesList extends Component {
-  @service router;
+  @service('app-router') router;


this is how you pass the service if the variable you assign it to (i.e. router) differs from the service name

hellobontempo · 2024-10-07T17:46:34Z

ui/lib/core/addon/helpers/transition-to.js

+<MyForm @onSave={{transition-to "vault.cluster.some.route.item" "item-id"}} />
+<MyForm @onSave={{transition-to "vault.cluster.some.external.route"  external=true}} />
+*/
+export default class TransitionTo extends Helper {


Open to other ideas here, this seemed like a nice and simple way to dynamically use the transition-to helper without knowing the router ahead of time. It also was nice to remove an dependency 🎉

For reference, Chelsea had made a specific engine-transition-to helper here. Which is what I used as a basis for building this component.

Also there are no instances now where we pass external=true but I've copied her test to validate this works as expected.

I like this approach a lot. Nice work!

hellobontempo · 2024-10-07T17:49:25Z

ui/package.json

@@ -136,7 +136,6 @@
    "ember-qunit": "^8.0.1",
    "ember-resolver": "^11.0.1",
    "ember-responsive": "5.0.0",
-    "ember-router-helpers": "^0.4.0",


replaced with (new) global transition-to helper

Monkeychip · 2024-10-07T19:24:56Z

ui/lib/core/addon/components/linked-block.js

@@ -4,7 +4,7 @@
 */

 import Component from '@glimmer/component';
-import { service } from '@ember/service';
+import { getOwner } from '@ember/owner';


Monkeychip · 2024-10-07T19:28:17Z

ui/lib/core/addon/mixins/replication-actions.js

@@ -11,7 +11,6 @@ import { task } from 'ember-concurrency';

 export default Mixin.create({
  store: service(),
-  router: service(),


I wonder why we had this service in here to begin with🤔

Yeah, I was going to move the service to the components that used the ReplicationActions mixin but then realized this wasn't used anywhere in the mixin or where the mixin was used?? My guess is left behind during a refactor?

But would definitely appreciate a second set of eyes double checking!

Monkeychip

I was able to smoke test replication and other transitions. Nice work!

hellobontempo · 2024-10-08T16:01:16Z

✅ enterprise tests

hellobontempo added 2 commits October 4, 2024 13:32

use alias for router injection

3e34768

update @router declarations in engine files

4fa1e2f

hellobontempo requested a review from a team as a code owner October 4, 2024 21:38

hellobontempo added this to the 1.19.0-rc milestone Oct 4, 2024

hellobontempo added pr/no-changelog ui labels Oct 4, 2024

github-actions bot added the hashicorp-contributed-pr If the PR is HashiCorp (i.e. not-community) contributed label Oct 4, 2024

hellobontempo changed the title ~~UI/vault 31211/deprecation router service from host~~ UI: Ember upgrade: Handle deprecation router service from host Oct 4, 2024

hellobontempo added 4 commits October 4, 2024 15:02

fix remaining pki router imports

81087dc

dynamically set router based on owner

9efe568

address replication routers

e02f2b5

update markdown docs

ef1b1c4

hellobontempo commented Oct 7, 2024

View reviewed changes

hellobontempo added 2 commits October 7, 2024 11:59

use non-deprecated import for getOwner

8cadb91

revert out of scope changes

20ce766

Monkeychip reviewed Oct 7, 2024

View reviewed changes

Monkeychip approved these changes Oct 7, 2024

View reviewed changes

add transition-to test

60b196d

hellobontempo merged commit 7774261 into main Oct 8, 2024
31 checks passed

hellobontempo deleted the ui/VAULT-31211/deprecation-router-service-from-host branch October 8, 2024 16:01

hellobontempo mentioned this pull request Oct 8, 2024

Remove deprecation from workflow #28628

Merged

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

UI: Ember upgrade: Handle deprecation router service from host #28603

UI: Ember upgrade: Handle deprecation router service from host #28603

hellobontempo commented Oct 4, 2024 •

edited

Loading

github-actions bot commented Oct 4, 2024

github-actions bot commented Oct 4, 2024 •

edited

Loading

hellobontempo Oct 7, 2024

hellobontempo Oct 7, 2024

hellobontempo Oct 7, 2024

Monkeychip Oct 7, 2024

hellobontempo Oct 7, 2024 •

edited

Loading

Monkeychip Oct 7, 2024

Monkeychip Oct 7, 2024

hellobontempo Oct 7, 2024

hellobontempo Oct 7, 2024

Monkeychip left a comment

hellobontempo commented Oct 8, 2024

UI: Ember upgrade: Handle deprecation router service from host #28603

UI: Ember upgrade: Handle deprecation router service from host #28603

Conversation

hellobontempo commented Oct 4, 2024 • edited Loading

Description

Deviations from original PR:

TODO only if you're a HashiCorp employee

github-actions bot commented Oct 4, 2024

github-actions bot commented Oct 4, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hellobontempo Oct 7, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Monkeychip left a comment

Choose a reason for hiding this comment

hellobontempo commented Oct 8, 2024

hellobontempo commented Oct 4, 2024 •

edited

Loading

github-actions bot commented Oct 4, 2024 •

edited

Loading

hellobontempo Oct 7, 2024 •

edited

Loading