Skip to content
  • John Cowen's avatar
    UI: [BUGFIX] Decode/encode urls (#5206) · c8386ec0
    John Cowen authored
    In https://github.com/hashicorp/consul/commit/858b05fc3127d3d20d9554e932353d767c7b5fdc#diff-46ef88aa04507fb9b039344277531584
    we removed encoding values in pathnames as we thought they were
    eventually being encoded by `ember`. It looks like this isn't the case.
    
    Turns out sometimes they are encoded sometimes they aren't. It's complicated.
    If at all possible refer to the PR https://github.com/hashicorp/consul/pull/5206.
    
    It's related to the difference between `dynamic` routes and `wildcard` routes.
    
    Partly related to this is a decision on whether we urlencode the slashes within service names or not. Whilst historically we haven't done this, we feel its a good time to change this behaviour, so we'll also be changing services to use dynamic routes instead of wildcard routes. So service links will then look like /ui/dc-1/services/application%2Fservice rather than /ui/dc-1/services/application/service
    
    Here, we define our routes in a declarative format (for the moment at least JSON) outside of Router.map, and loop through this within Router.map to set all our routes using the standard this.route method. We essentially configure our Router from the outside. As this configuration is now done declaratively outside of Router.map we can also make this data available to href-to and paramsFor, allowing us to detect wildcard routes and therefore apply urlencoding/decoding.
    
    Where I mention 'conditionally' below, this is detection is what is used for the decision.
    
    We conditionally add url encoding to the `{{href-to}}` helper/addon. The
    reasoning here is, if we are asking for a 'href/url' then whatever we
    receive back should always be urlencoded. We've done this by reusing as much
    code from the original `ember-href-to` addon as possible, after this
    change every call to the `{{href-to}}` helper will be urlencoded.
    
    As all links using `{{href-to}}` are now properly urlencoded. We also
    need to decode them in the correct place 'on the other end', so..
    
    We also override the default `Route.paramsFor` method to conditionally decode all
    params before passing them to the `Route.model` hook.
    
    Lastly (the revert), as we almost consistently use url params to
    construct API calls, we make sure we re-encode any slugs that have been
    passed in by the user/developer. The original API for the `createURL`
    function was to allow you to pass values that didn't need encoding,
    values that **did** need encoding, followed by query params (which again
    require url encoding)
    
    All in all this should make the entire ember app url encode/decode safe.
    c8386ec0