open-consul/ui/packages/consul-ui/app/helpers/href-mut.js

18 lines
504 B
JavaScript
Raw Normal View History

import Helper from '@ember/component/helper';
import { inject as service } from '@ember/service';
import { hrefTo } from 'consul-ui/helpers/href-to';
ui: Fix using 'ui-like' KVs when using an empty default nspace (#7734) When using namespaces, the 'default' namespace is a little special in that we wanted the option for all our URLs to stay the same when using namespaces if you are using the default namespace, with the option of also being able to explicitly specify `~default` as a namespace. In other words both `ui/services/service-name` and `ui/~default/services/service-name` show the same thing. This means that if you switch between OSS and Enterprise, all of your URLs stay the same, but you can still specifically link to the default namespace itself. Our routing configuration is duplicated in order to achieve this: ``` - :dc - :service - :kv - :edit - :nspace - :dc - :service - :kv - :edit ``` Secondly, ember routing resolves/matches routes in the order that you specify them, unless, its seems, when using wildcard routes, like we do in the KV area. When not using the wildcard routes the above routing configuration resolves/matches a `/dc-1/kv/service` to the `dc.kv.edit` route correctly (dc:dc-1, kv:services), that route having been configured in a higher priority than the nspace routes. However when configured with wildcards (required in the KV area), note the asterisk below: ``` - :dc :service - :kv - *edit - :nspace - :dc - :service - :kv - *edit ``` Given something like `/dc-1/kv/services` the router instead matches the `nspace.dc.service` (nspace:dc-1, dc:kv, service:services) route first even though the `dc.kv.edit` route should still match first. Changing the `dc.kv.edit` route back to use a non-wildcard route (:edit instead of *edit), returns the router to match the routes in the correct order. In order to work around this, we catch any incorrectly matched routes (those being directed to the nspace Route but not having a `~` character in the nspace parameter), and then recalculate the correct route name and parameters. Lastly we use this recalculated route to direct the user/app to the correct route. This route recalcation requires walking up the route to gather up all of the required route parameters, and although this feels like something that could already exist in ember, it doesn't seem to. We had already done a lot of this work a while ago when implementing our `href-mut` helper. This commit therefore repurposes that work slighlty and externalizes it outside of the helper itself into a more usable util so we can import it where we need it. Tests have been added before refactoring it down to make the code easier to follow.
2020-04-30 08:28:20 +00:00
import { getOwner } from '@ember/application';
import transitionable from 'consul-ui/utils/routing/transitionable';
export default Helper.extend({
router: service('router'),
compute([params], hash) {
ui: Fix using 'ui-like' KVs when using an empty default nspace (#7734) When using namespaces, the 'default' namespace is a little special in that we wanted the option for all our URLs to stay the same when using namespaces if you are using the default namespace, with the option of also being able to explicitly specify `~default` as a namespace. In other words both `ui/services/service-name` and `ui/~default/services/service-name` show the same thing. This means that if you switch between OSS and Enterprise, all of your URLs stay the same, but you can still specifically link to the default namespace itself. Our routing configuration is duplicated in order to achieve this: ``` - :dc - :service - :kv - :edit - :nspace - :dc - :service - :kv - :edit ``` Secondly, ember routing resolves/matches routes in the order that you specify them, unless, its seems, when using wildcard routes, like we do in the KV area. When not using the wildcard routes the above routing configuration resolves/matches a `/dc-1/kv/service` to the `dc.kv.edit` route correctly (dc:dc-1, kv:services), that route having been configured in a higher priority than the nspace routes. However when configured with wildcards (required in the KV area), note the asterisk below: ``` - :dc :service - :kv - *edit - :nspace - :dc - :service - :kv - *edit ``` Given something like `/dc-1/kv/services` the router instead matches the `nspace.dc.service` (nspace:dc-1, dc:kv, service:services) route first even though the `dc.kv.edit` route should still match first. Changing the `dc.kv.edit` route back to use a non-wildcard route (:edit instead of *edit), returns the router to match the routes in the correct order. In order to work around this, we catch any incorrectly matched routes (those being directed to the nspace Route but not having a `~` character in the nspace parameter), and then recalculate the correct route name and parameters. Lastly we use this recalculated route to direct the user/app to the correct route. This route recalcation requires walking up the route to gather up all of the required route parameters, and although this feels like something that could already exist in ember, it doesn't seem to. We had already done a lot of this work a while ago when implementing our `href-mut` helper. This commit therefore repurposes that work slighlty and externalizes it outside of the helper itself into a more usable util so we can import it where we need it. Tests have been added before refactoring it down to make the code easier to follow.
2020-04-30 08:28:20 +00:00
return hrefTo(
this,
this.router,
transitionable(this.router.currentRoute, params, getOwner(this)),
hash
);
},
});