Removal of attributes from queryparams

[coderberry]

I found that when I removed fields from the params hash which is used to generate the QueryParameters object, it doesn't remove it from the URL. Here's what I had to do to resolve this:

/**
 * Returns the query parameters and actual contexts given
 * a handler name and list of contexts (the arguments to
 * transitionTo and generate). Returns an object with two
 * properties:
 * - queryParams: The query params object for the given arguments
 * - contexts: The contexts argument minus an eventual QueryParameters object.
 * - args: The full argument array for generate / transitionTo
 *          (handler name and contexts without query params).
 */
var queryPartition = function(router, handlerName, contexts) {
    var queryParams = {},
        currentHandlerInfos = router.currentHandlerInfos || [],
        overrideParams, handlers,
        matchPoint;

    // Detect a QueryParameters object and shift it off the parameters array
    if (contexts[0] && contexts[0] instanceof Ember.Router.QueryParameters) {
        var paramsObject = contexts.shift();
        overrideParams = paramsObject.getProperties(keys(paramsObject));
    }

    // Get the query parameters that should be maintained
    if (!router.hasRoute(handlerName)) {
        handlerName += '.index';
    }

    handlers = router.recognizer.handlersFor(handlerName);
    matchPoint = getMatchPoint(router, handlers, contexts);

    for (var i = 0, l = currentHandlerInfos.length; i < l, i < matchPoint; i++) {
        var handlerObj = currentHandlerInfos[i],
            handler = handlerObj.handler;

        // Merge with existing query params
        if (handler.currentQueryParams) {
            merge(queryParams, handler.currentQueryParams);
        }
    }

    // Overridden
    queryParams = overrideParams;

    // if (overrideParams) {
    //  // Merge the query object parameters into
    //  // the params.
    //  merge(queryParams, overrideParams);
    // }

    // // Clean out any value that is falsy
    // keys(queryParams).forEach(function(key) {
    //  if (!queryParams[key]) {
    //      delete queryParams[key];
    //  }
    // });

    return {
        contexts: contexts,
        queryParams: queryParams,
        args: [handlerName].concat(contexts)
    };
};

I don't want to mess up functionality, but I can't understand why the original code was there (see commented out sections).

Thanks!

Eric

[coderberry]

It seems that by doing this, it broke refresh functionality.

[ElteHupkes]

@cavneb The code you're mentioning takes care of maintaining query parameters of parent states. For instance, let's say I have a /posts/:id/comments route, currently called as /posts/15/comments?post_sort=date, and I want to change the comment sort. Now I don't want the comment route to mess with or even care about the sorting state of the posts - so when I change the comment sort with something like:

// Some controller var perhaps
queryParams = Ember.Router.QueryParameters.create({comment_sort: 'author'});

{{#linkTo "posts.view.comments" queryParams}}Sort by author{{/linkTo}}

I don't want the posts sort to be discarded. Therefore I calculate which routes will not be exited and merge in their existing query parameters with the supplied params. So to clarify, when you specify a query parameter object, it applies only to the routes that are actually changed, and this behavior is intended. If you want to remove parameters of parent routes you can "nullify" them, i.e. specify a "falsy" value in the QueryParameters object.

That being said, I think I might've made a mistake in how I calculate exactly which parameters are being merged in leading to the unexpected behavior you're describing. I'll try to fix this tomorrow (which probably means a different thing to you since we appear to be living on different continents ;]).

[ElteHupkes]

I just pushed a commit that I think might solve your problem. This doesn't affect the behavior for multiple nested routes, which is what I'm mostly working with (also what my example JSFiddle is based on), so that probably explains why I haven't noticed this before. Can you tell me if it now behaves as expected?

For nested routes there usually is an additional (possibly implicit) index route which doesn't observe the query parameter itself but is the target of any link to the route, so technically the link affects that route and not its parent. Unfortunately with global query parameters behavior like this is always going to be at least mildly ambiguous.

[coderberry]

My application has become somewhat complex.. I will create a very small simple app which will demonstrate the issue I am having. I'll provide this sometime this week. Thanks for your help!

[camdub]

I am still having this issue. When passing a null or falsy value, the URL does not update.

i.e., var params = Em.Router.QueryParameters.create({ filter: null });

I'll try and create a small sample app.

[ElteHupkes]

Weird.. I do something similar in my own app (even using "filter" as a query key) and it works just fine. Could you build a JSFiddle showing it failing maybe?