router.ts

import RouteRecognizer, { MatchCallback, Params } from 'route-recognizer';
import { Promise } from 'rsvp';
import { Dict, Maybe, Option } from './core';
import InternalRouteInfo, {
  Route,
  RouteInfo,
  RouteInfoWithAttributes,
  toReadOnlyRouteInfo,
} from './route-info';
import InternalTransition, {
  logAbort,
  OpaqueTransition,
  PublicTransition as Transition,
  QUERY_PARAMS_SYMBOL,
  STATE_SYMBOL,
} from './transition';
import { throwIfAborted, isTransitionAborted } from './transition-aborted-error';
import { TransitionIntent } from './transition-intent';
import NamedTransitionIntent from './transition-intent/named-transition-intent';
import URLTransitionIntent from './transition-intent/url-transition-intent';
import TransitionState, { TransitionError } from './transition-state';
import {
  ChangeList,
  extractQueryParams,
  forEach,
  getChangelist,
  log,
  merge,
  promiseLabel,
} from './utils';

export interface SerializerFunc {
  (model: {}, params: string[]): Dict<unknown>;
}

export interface ParsedHandler {
  handler: string;
  names: string[];
}

export default abstract class Router<T extends Route> {
  private _lastQueryParams = {};
  log?: (message: string) => void;
  state?: TransitionState<T> = undefined;
  oldState: Maybe<TransitionState<T>> = undefined;
  activeTransition?: InternalTransition<T> = undefined;
  currentRouteInfos?: InternalRouteInfo<T>[] = undefined;
  _changedQueryParams?: Dict<unknown> = undefined;
  currentSequence = 0;
  recognizer: RouteRecognizer;

  constructor(logger?: (message: string) => void) {
    this.log = logger;
    this.recognizer = new RouteRecognizer();
    this.reset();
  }

  abstract getRoute(name: string): T | Promise<T>;
  abstract getSerializer(name: string): SerializerFunc | undefined;
  abstract updateURL(url: string): void;
  abstract replaceURL(url: string): void;
  abstract willTransition(
    oldRouteInfos: InternalRouteInfo<T>[],
    newRouteInfos: InternalRouteInfo<T>[],
    transition: Transition
  ): void;
  abstract didTransition(routeInfos: InternalRouteInfo<T>[]): void;
  abstract triggerEvent(
    routeInfos: InternalRouteInfo<T>[],
    ignoreFailure: boolean,
    name: string,
    args: unknown[]
  ): void;

  abstract routeWillChange(transition: Transition): void;
  abstract routeDidChange(transition: Transition): void;
  abstract transitionDidError(error: TransitionError, transition: Transition): Transition | Error;

  /**
    The main entry point into the router. The API is essentially
    the same as the `map` method in `route-recognizer`.

    This method extracts the String handler at the last `.to()`
    call and uses it as the name of the whole route.

    @param {Function} callback
  */
  map(callback: MatchCallback) {
    this.recognizer.map(callback, function (recognizer, routes) {
      for (let i = routes.length - 1, proceed = true; i >= 0 && proceed; --i) {
        let route = routes[i];
        let handler = route.handler as string;
        recognizer.add(routes, { as: handler });
        proceed = route.path === '/' || route.path === '' || handler.slice(-6) === '.index';
      }
    });
  }

  hasRoute(route: string) {
    return this.recognizer.hasRoute(route);
  }

  queryParamsTransition(
    changelist: ChangeList,
    wasTransitioning: boolean,
    oldState: TransitionState<T>,
    newState: TransitionState<T>
  ): OpaqueTransition {
    this.fireQueryParamDidChange(newState, changelist);

    if (!wasTransitioning && this.activeTransition) {
      // One of the routes in queryParamsDidChange
      // caused a transition. Just return that transition.
      return this.activeTransition;
    } else {
      // Running queryParamsDidChange didn't change anything.
      // Just update query params and be on our way.

      // We have to return a noop transition that will
      // perform a URL update at the end. This gives
      // the user the ability to set the url update
      // method (default is replaceState).
      let newTransition = new InternalTransition(this, undefined, undefined);
      newTransition.queryParamsOnly = true;

      oldState.queryParams = this.finalizeQueryParamChange(
        newState.routeInfos,
        newState.queryParams,
        newTransition
      );

      newTransition[QUERY_PARAMS_SYMBOL] = newState.queryParams;

      this.toReadOnlyInfos(newTransition, newState);

      this.routeWillChange(newTransition);

      newTransition.promise = newTransition.promise!.then(
        (result: TransitionState<T> | Route | Error | undefined) => {
          if (!newTransition.isAborted) {
            this._updateURL(newTransition, oldState);
            this.didTransition(this.currentRouteInfos!);
            this.toInfos(newTransition, newState.routeInfos, true);
            this.routeDidChange(newTransition);
          }
          return result;
        },
        null,
        promiseLabel('Transition complete')
      );

      return newTransition;
    }
  }

  transitionByIntent(intent: TransitionIntent<T>, isIntermediate: boolean): InternalTransition<T> {
    try {
      return this.getTransitionByIntent(intent, isIntermediate);
    } catch (e) {
      return new InternalTransition(this, intent, undefined, e, undefined);
    }
  }

  recognize(url: string): Option<RouteInfo> {
    let intent = new URLTransitionIntent<T>(this, url);
    let newState = this.generateNewState(intent);

    if (newState === null) {
      return newState;
    }

    let readonlyInfos = toReadOnlyRouteInfo(newState.routeInfos, newState.queryParams);
    return readonlyInfos[readonlyInfos.length - 1] as RouteInfo;
  }

  recognizeAndLoad(url: string): Promise<RouteInfoWithAttributes> {
    let intent = new URLTransitionIntent<T>(this, url);
    let newState = this.generateNewState(intent);

    if (newState === null) {
      return Promise.reject(`URL ${url} was not recognized`);
    }

    let newTransition: OpaqueTransition = new InternalTransition(this, intent, newState, undefined);
    return newTransition.then(() => {
      let routeInfosWithAttributes = toReadOnlyRouteInfo(
        newState!.routeInfos,
        newTransition[QUERY_PARAMS_SYMBOL],
        true
      ) as RouteInfoWithAttributes[];
      return routeInfosWithAttributes[routeInfosWithAttributes.length - 1];
    });
  }

  private generateNewState(intent: TransitionIntent<T>): Option<TransitionState<T>> {
    try {
      return intent.applyToState(this.state!, false);
    } catch (e) {
      return null;
    }
  }

  private getTransitionByIntent(
    intent: TransitionIntent<T>,
    isIntermediate: boolean
  ): InternalTransition<T> {
    let wasTransitioning = !!this.activeTransition;
    let oldState = wasTransitioning ? this.activeTransition![STATE_SYMBOL] : this.state;
    let newTransition: InternalTransition<T>;

    let newState = intent.applyToState(oldState!, isIntermediate);
    let queryParamChangelist = getChangelist(oldState!.queryParams, newState.queryParams);

    if (routeInfosEqual(newState.routeInfos, oldState!.routeInfos)) {
      // This is a no-op transition. See if query params changed.
      if (queryParamChangelist) {
        let newTransition = this.queryParamsTransition(
          queryParamChangelist,
          wasTransitioning,
          oldState!,
          newState
        );
        newTransition.queryParamsOnly = true;
        return newTransition;
      }

      // No-op. No need to create a new transition.
      return this.activeTransition || new InternalTransition(this, undefined, undefined);
    }

    if (isIntermediate) {
      let transition = new InternalTransition(this, undefined, newState);
      transition.isIntermediate = true;
      this.toReadOnlyInfos(transition, newState);
      this.setupContexts(newState, transition);

      this.routeWillChange(transition);
      return this.activeTransition!;
    }

    // Create a new transition to the destination route.
    newTransition = new InternalTransition(
      this,
      intent,
      newState,
      undefined,
      this.activeTransition
    );

    // transition is to same route with same params, only query params differ.
    // not caught above probably because refresh() has been used
    if (routeInfosSameExceptQueryParams(newState.routeInfos, oldState!.routeInfos)) {
      newTransition.queryParamsOnly = true;
    }

    this.toReadOnlyInfos(newTransition, newState);
    // Abort and usurp any previously active transition.
    if (this.activeTransition) {
      this.activeTransition.redirect(newTransition);
    }
    this.activeTransition = newTransition;

    // Transition promises by default resolve with resolved state.
    // For our purposes, swap out the promise to resolve
    // after the transition has been finalized.
    newTransition.promise = newTransition.promise!.then(
      (result: TransitionState<T>) => {
        return this.finalizeTransition(newTransition, result);
      },
      null,
      promiseLabel('Settle transition promise when transition is finalized')
    );

    if (!wasTransitioning) {
      this.notifyExistingHandlers(newState, newTransition);
    }

    this.fireQueryParamDidChange(newState, queryParamChangelist!);

    return newTransition;
  }

  /**
  @private

  Begins and returns a Transition based on the provided
  arguments. Accepts arguments in the form of both URL
  transitions and named transitions.

  @param {Router} router
  @param {Array[Object]} args arguments passed to transitionTo,
    replaceWith, or handleURL
*/
  private doTransition(
    name?: string,
    modelsArray: Dict<unknown>[] = [],
    isIntermediate = false
  ): InternalTransition<T> {
    let lastArg = modelsArray[modelsArray.length - 1];
    let queryParams: Dict<unknown> = {};

    if (lastArg !== undefined && lastArg.hasOwnProperty('queryParams')) {
      queryParams = modelsArray.pop()!.queryParams as Dict<unknown>;
    }

    let intent;
    if (name === undefined) {
      log(this, 'Updating query params');

      // A query param update is really just a transition
      // into the route you're already on.
      let { routeInfos } = this.state!;
      intent = new NamedTransitionIntent<T>(
        this,
        routeInfos[routeInfos.length - 1].name,
        undefined,
        [],
        queryParams
      );
    } else if (name.charAt(0) === '/') {
      log(this, 'Attempting URL transition to ' + name);
      intent = new URLTransitionIntent<T>(this, name);
    } else {
      log(this, 'Attempting transition to ' + name);
      intent = new NamedTransitionIntent<T>(this, name, undefined, modelsArray, queryParams);
    }

    return this.transitionByIntent(intent, isIntermediate);
  }

  /**
  @private

  Updates the URL (if necessary) and calls `setupContexts`
  to update the router's array of `currentRouteInfos`.
 */
  private finalizeTransition(
    transition: InternalTransition<T>,
    newState: TransitionState<T>
  ): T | Promise<any> {
    try {
      log(
        transition.router,
        transition.sequence,
        'Resolved all models on destination route; finalizing transition.'
      );

      let routeInfos = newState.routeInfos;

      // Run all the necessary enter/setup/exit hooks
      this.setupContexts(newState, transition);

      // Check if a redirect occurred in enter/setup
      if (transition.isAborted) {
        // TODO: cleaner way? distinguish b/w targetRouteInfos?
        this.state!.routeInfos = this.currentRouteInfos!;
        return Promise.reject(logAbort(transition));
      }

      this._updateURL(transition, newState);

      transition.isActive = false;
      this.activeTransition = undefined;

      this.triggerEvent(this.currentRouteInfos!, true, 'didTransition', []);
      this.didTransition(this.currentRouteInfos!);
      this.toInfos(transition, newState.routeInfos, true);
      this.routeDidChange(transition);

      log(this, transition.sequence, 'TRANSITION COMPLETE.');

      // Resolve with the final route.
      return routeInfos[routeInfos.length - 1].route!;
    } catch (e) {
      if (!isTransitionAborted(e)) {
        let infos = transition[STATE_SYMBOL]!.routeInfos;
        transition.trigger(true, 'error', e, transition, infos[infos.length - 1].route);
        transition.abort();
      }

      throw e;
    }
  }

  /**
  @private

  Takes an Array of `RouteInfo`s, figures out which ones are
  exiting, entering, or changing contexts, and calls the
  proper route hooks.

  For example, consider the following tree of routes. Each route is
  followed by the URL segment it handles.

  ```
  |~index ("/")
  | |~posts ("/posts")
  | | |-showPost ("/:id")
  | | |-newPost ("/new")
  | | |-editPost ("/edit")
  | |~about ("/about/:id")
  ```

  Consider the following transitions:

  1. A URL transition to `/posts/1`.
     1. Triggers the `*model` callbacks on the
        `index`, `posts`, and `showPost` routes
     2. Triggers the `enter` callback on the same
     3. Triggers the `setup` callback on the same
  2. A direct transition to `newPost`
     1. Triggers the `exit` callback on `showPost`
     2. Triggers the `enter` callback on `newPost`
     3. Triggers the `setup` callback on `newPost`
  3. A direct transition to `about` with a specified
     context object
     1. Triggers the `exit` callback on `newPost`
        and `posts`
     2. Triggers the `serialize` callback on `about`
     3. Triggers the `enter` callback on `about`
     4. Triggers the `setup` callback on `about`

  @param {Router} transition
  @param {TransitionState} newState
*/
  private setupContexts(newState: TransitionState<T>, transition?: InternalTransition<T>) {
    let partition = this.partitionRoutes(this.state!, newState);
    let i, l, route;

    for (i = 0, l = partition.exited.length; i < l; i++) {
      route = partition.exited[i].route;
      delete route!.context;

      if (route !== undefined) {
        if (route._internalReset !== undefined) {
          route._internalReset(true, transition);
        }

        if (route.exit !== undefined) {
          route.exit(transition);
        }
      }
    }

    let oldState = (this.oldState = this.state);
    this.state = newState;
    let currentRouteInfos = (this.currentRouteInfos = partition.unchanged.slice());

    try {
      for (i = 0, l = partition.reset.length; i < l; i++) {
        route = partition.reset[i].route;
        if (route !== undefined) {
          if (route._internalReset !== undefined) {
            route._internalReset(false, transition);
          }
        }
      }

      for (i = 0, l = partition.updatedContext.length; i < l; i++) {
        this.routeEnteredOrUpdated(
          currentRouteInfos,
          partition.updatedContext[i],
          false,
          transition!
        );
      }

      for (i = 0, l = partition.entered.length; i < l; i++) {
        this.routeEnteredOrUpdated(currentRouteInfos, partition.entered[i], true, transition!);
      }
    } catch (e) {
      this.state = oldState;
      this.currentRouteInfos = oldState!.routeInfos;
      throw e;
    }

    this.state.queryParams = this.finalizeQueryParamChange(
      currentRouteInfos,
      newState.queryParams,
      transition!
    );
  }

  /**
  @private

  Fires queryParamsDidChange event
*/
  private fireQueryParamDidChange(newState: TransitionState<T>, queryParamChangelist: ChangeList) {
    // If queryParams changed trigger event
    if (queryParamChangelist) {
      // This is a little hacky but we need some way of storing
      // changed query params given that no activeTransition
      // is guaranteed to have occurred.
      this._changedQueryParams = queryParamChangelist.all;
      this.triggerEvent(newState.routeInfos, true, 'queryParamsDidChange', [
        queryParamChangelist.changed,
        queryParamChangelist.all,
        queryParamChangelist.removed,
      ]);
      this._changedQueryParams = undefined;
    }
  }

  /**
  @private

  Helper method used by setupContexts. Handles errors or redirects
  that may happen in enter/setup.
*/
  private routeEnteredOrUpdated(
    currentRouteInfos: InternalRouteInfo<T>[],
    routeInfo: InternalRouteInfo<T>,
    enter: boolean,
    transition?: InternalTransition<T>
  ) {
    let route = routeInfo.route,
      context = routeInfo.context;

    function _routeEnteredOrUpdated(route: T) {
      if (enter) {
        if (route.enter !== undefined) {
          route.enter(transition!);
        }
      }

      throwIfAborted(transition);

      route.context = context;

      if (route.contextDidChange !== undefined) {
        route.contextDidChange();
      }

      if (route.setup !== undefined) {
        route.setup(context!, transition!);
      }

      throwIfAborted(transition);

      currentRouteInfos.push(routeInfo);
      return route;
    }

    // If the route doesn't exist, it means we haven't resolved the route promise yet
    if (route === undefined) {
      routeInfo.routePromise = routeInfo.routePromise.then(_routeEnteredOrUpdated);
    } else {
      _routeEnteredOrUpdated(route);
    }

    return true;
  }

  /**
  @private

  This function is called when transitioning from one URL to
  another to determine which routes are no longer active,
  which routes are newly active, and which routes remain
  active but have their context changed.

  Take a list of old routes and new routes and partition
  them into four buckets:

  * unchanged: the route was active in both the old and
    new URL, and its context remains the same
  * updated context: the route was active in both the
    old and new URL, but its context changed. The route's
    `setup` method, if any, will be called with the new
    context.
  * exited: the route was active in the old URL, but is
    no longer active.
  * entered: the route was not active in the old URL, but
    is now active.

  The PartitionedRoutes structure has four fields:

  * `updatedContext`: a list of `RouteInfo` objects that
    represent routes that remain active but have a changed
    context
  * `entered`: a list of `RouteInfo` objects that represent
    routes that are newly active
  * `exited`: a list of `RouteInfo` objects that are no
    longer active.
  * `unchanged`: a list of `RouteInfo` objects that remain active.

  @param {Array[InternalRouteInfo]} oldRoutes a list of the route
    information for the previous URL (or `[]` if this is the
    first handled transition)
  @param {Array[InternalRouteInfo]} newRoutes a list of the route
    information for the new URL

  @return {Partition}
*/
  private partitionRoutes(oldState: TransitionState<T>, newState: TransitionState<T>) {
    let oldRouteInfos = oldState.routeInfos;
    let newRouteInfos = newState.routeInfos;

    let routes: RoutePartition<T> = {
      updatedContext: [],
      exited: [],
      entered: [],
      unchanged: [],
      reset: [],
    };

    let routeChanged,
      contextChanged = false,
      i,
      l;

    for (i = 0, l = newRouteInfos.length; i < l; i++) {
      let oldRouteInfo = oldRouteInfos[i],
        newRouteInfo = newRouteInfos[i];

      if (!oldRouteInfo || oldRouteInfo.route !== newRouteInfo.route) {
        routeChanged = true;
      }

      if (routeChanged) {
        routes.entered.push(newRouteInfo);
        if (oldRouteInfo) {
          routes.exited.unshift(oldRouteInfo);
        }
      } else if (contextChanged || oldRouteInfo.context !== newRouteInfo.context) {
        contextChanged = true;
        routes.updatedContext.push(newRouteInfo);
      } else {
        routes.unchanged.push(oldRouteInfo);
      }
    }

    for (i = newRouteInfos.length, l = oldRouteInfos.length; i < l; i++) {
      routes.exited.unshift(oldRouteInfos[i]);
    }

    routes.reset = routes.updatedContext.slice();
    routes.reset.reverse();

    return routes;
  }

  private _updateURL(transition: OpaqueTransition, state: TransitionState<T>) {
    let urlMethod: string | null = transition.urlMethod;

    if (!urlMethod) {
      return;
    }

    let { routeInfos } = state;
    let { name: routeName } = routeInfos[routeInfos.length - 1];
    let params: Dict<unknown> = {};

    for (let i = routeInfos.length - 1; i >= 0; --i) {
      let routeInfo = routeInfos[i];
      merge(params, routeInfo.params);
      if (routeInfo.route!.inaccessibleByURL) {
        urlMethod = null;
      }
    }

    if (urlMethod) {
      params.queryParams = transition._visibleQueryParams || state.queryParams;
      let url = this.recognizer.generate(routeName, params as Params);

      // transitions during the initial transition must always use replaceURL.
      // When the app boots, you are at a url, e.g. /foo. If some route
      // redirects to bar as part of the initial transition, you don't want to
      // add a history entry for /foo. If you do, pressing back will immediately
      // hit the redirect again and take you back to /bar, thus killing the back
      // button
      let initial = transition.isCausedByInitialTransition;

      // say you are at / and you click a link to route /foo. In /foo's
      // route, the transition is aborted using replaceWith('/bar').
      // Because the current url is still /, the history entry for / is
      // removed from the history. Clicking back will take you to the page
      // you were on before /, which is often not even the app, thus killing
      // the back button. That's why updateURL is always correct for an
      // aborting transition that's not the initial transition
      let replaceAndNotAborting =
        urlMethod === 'replace' && !transition.isCausedByAbortingTransition;

      // because calling refresh causes an aborted transition, this needs to be
      // special cased - if the initial transition is a replace transition, the
      // urlMethod should be honored here.
      let isQueryParamsRefreshTransition = transition.queryParamsOnly && urlMethod === 'replace';

      // say you are at / and you a `replaceWith(/foo)` is called. Then, that
      // transition is aborted with `replaceWith(/bar)`. At the end, we should
      // end up with /bar replacing /. We are replacing the replace. We only
      // will replace the initial route if all subsequent aborts are also
      // replaces. However, there is some ambiguity around the correct behavior
      // here.
      let replacingReplace =
        urlMethod === 'replace' && transition.isCausedByAbortingReplaceTransition;

      if (initial || replaceAndNotAborting || isQueryParamsRefreshTransition || replacingReplace) {
        this.replaceURL!(url);
      } else {
        this.updateURL(url);
      }
    }
  }

  private finalizeQueryParamChange(
    resolvedHandlers: InternalRouteInfo<T>[],
    newQueryParams: Dict<unknown>,
    transition: OpaqueTransition
  ) {
    // We fire a finalizeQueryParamChange event which
    // gives the new route hierarchy a chance to tell
    // us which query params it's consuming and what
    // their final values are. If a query param is
    // no longer consumed in the final route hierarchy,
    // its serialized segment will be removed
    // from the URL.

    for (let k in newQueryParams) {
      if (newQueryParams.hasOwnProperty(k) && newQueryParams[k] === null) {
        delete newQueryParams[k];
      }
    }

    let finalQueryParamsArray: {
      key: string;
      value: string;
      visible: boolean;
    }[] = [];

    this.triggerEvent(resolvedHandlers, true, 'finalizeQueryParamChange', [
      newQueryParams,
      finalQueryParamsArray,
      transition,
    ]);

    if (transition) {
      transition._visibleQueryParams = {};
    }

    let finalQueryParams: Dict<unknown> = {};
    for (let i = 0, len = finalQueryParamsArray.length; i < len; ++i) {
      let qp = finalQueryParamsArray[i];
      finalQueryParams[qp.key] = qp.value;
      if (transition && qp.visible !== false) {
        transition._visibleQueryParams[qp.key] = qp.value;
      }
    }
    return finalQueryParams;
  }

  private toReadOnlyInfos(newTransition: OpaqueTransition, newState: TransitionState<T>) {
    let oldRouteInfos = this.state!.routeInfos;
    this.fromInfos(newTransition, oldRouteInfos);
    this.toInfos(newTransition, newState.routeInfos);
    this._lastQueryParams = newState.queryParams;
  }

  private fromInfos(newTransition: OpaqueTransition, oldRouteInfos: InternalRouteInfo<T>[]) {
    if (newTransition !== undefined && oldRouteInfos.length > 0) {
      let fromInfos = toReadOnlyRouteInfo(
        oldRouteInfos,
        Object.assign({}, this._lastQueryParams),
        true
      ) as RouteInfoWithAttributes[];
      newTransition!.from = fromInfos[fromInfos.length - 1] || null;
    }
  }

  public toInfos(
    newTransition: OpaqueTransition,
    newRouteInfos: InternalRouteInfo<T>[],
    includeAttributes = false
  ) {
    if (newTransition !== undefined && newRouteInfos.length > 0) {
      let toInfos = toReadOnlyRouteInfo(
        newRouteInfos,
        Object.assign({}, newTransition[QUERY_PARAMS_SYMBOL]),
        includeAttributes
      );
      newTransition!.to = toInfos[toInfos.length - 1] || null;
    }
  }

  private notifyExistingHandlers(
    newState: TransitionState<T>,
    newTransition: InternalTransition<T>
  ) {
    let oldRouteInfos = this.state!.routeInfos,
      changing = [],
      i,
      oldRouteInfoLen,
      oldHandler,
      newRouteInfo;

    oldRouteInfoLen = oldRouteInfos.length;
    for (i = 0; i < oldRouteInfoLen; i++) {
      oldHandler = oldRouteInfos[i];
      newRouteInfo = newState.routeInfos[i];

      if (!newRouteInfo || oldHandler.name !== newRouteInfo.name) {
        break;
      }

      if (!newRouteInfo.isResolved) {
        changing.push(oldHandler);
      }
    }

    this.triggerEvent(oldRouteInfos, true, 'willTransition', [newTransition]);
    this.routeWillChange(newTransition);
    this.willTransition(oldRouteInfos, newState.routeInfos, newTransition);
  }

  /**
    Clears the current and target route routes and triggers exit
    on each of them starting at the leaf and traversing up through
    its ancestors.
  */
  reset() {
    if (this.state) {
      forEach<InternalRouteInfo<T>>(this.state.routeInfos.slice().reverse(), function (routeInfo) {
        let route = routeInfo.route;
        if (route !== undefined) {
          if (route.exit !== undefined) {
            route.exit();
          }
        }
        return true;
      });
    }

    this.oldState = undefined;
    this.state = new TransitionState();
    this.currentRouteInfos = undefined;
  }

  /**
    let handler = routeInfo.handler;
    The entry point for handling a change to the URL (usually
    via the back and forward button).

    Returns an Array of handlers and the parameters associated
    with those parameters.

    @param {String} url a URL to process

    @return {Array} an Array of `[handler, parameter]` tuples
  */
  handleURL(url: string) {
    // Perform a URL-based transition, but don't change
    // the URL afterward, since it already happened.
    if (url.charAt(0) !== '/') {
      url = '/' + url;
    }

    return this.doTransition(url)!.method(null);
  }

  /**
    Transition into the specified named route.

    If necessary, trigger the exit callback on any routes
    that are no longer represented by the target route.

    @param {String} name the name of the route
  */
  transitionTo(name: string | { queryParams: Dict<unknown> }, ...contexts: any[]) {
    if (typeof name === 'object') {
      contexts.push(name);
      return this.doTransition(undefined, contexts, false);
    }

    return this.doTransition(name, contexts);
  }

  intermediateTransitionTo(name: string, ...args: any[]) {
    return this.doTransition(name, args, true);
  }

  refresh(pivotRoute?: T) {
    let previousTransition = this.activeTransition;
    let state = previousTransition ? previousTransition[STATE_SYMBOL] : this.state;
    let routeInfos = state!.routeInfos;

    if (pivotRoute === undefined) {
      pivotRoute = routeInfos[0].route;
    }

    log(this, 'Starting a refresh transition');
    let name = routeInfos[routeInfos.length - 1].name;
    let intent = new NamedTransitionIntent(
      this,
      name,
      pivotRoute,
      [],
      this._changedQueryParams || state!.queryParams
    );

    let newTransition = this.transitionByIntent(intent, false);

    // if the previous transition is a replace transition, that needs to be preserved
    if (previousTransition && previousTransition.urlMethod === 'replace') {
      newTransition.method(previousTransition.urlMethod);
    }

    return newTransition;
  }

  /**
    Identical to `transitionTo` except that the current URL will be replaced
    if possible.

    This method is intended primarily for use with `replaceState`.

    @param {String} name the name of the route
  */
  replaceWith(name: string) {
    return this.doTransition(name).method('replace');
  }

  /**
    Take a named route and context objects and generate a
    URL.

    @param {String} name the name of the route to generate
      a URL for
    @param {...Object} objects a list of objects to serialize

    @return {String} a URL
  */
  generate(routeName: string, ...args: unknown[]) {
    let partitionedArgs = extractQueryParams(args),
      suppliedParams = partitionedArgs[0],
      queryParams = partitionedArgs[1];

    // Construct a TransitionIntent with the provided params
    // and apply it to the present state of the router.
    let intent = new NamedTransitionIntent(this, routeName, undefined, suppliedParams);
    let state = intent.applyToState(this.state!, false);

    let params: Params = {};
    for (let i = 0, len = state.routeInfos.length; i < len; ++i) {
      let routeInfo = state.routeInfos[i];
      let routeParams = routeInfo.serialize();
      merge(params, routeParams);
    }
    params.queryParams = queryParams;

    return this.recognizer.generate(routeName, params);
  }

  applyIntent(routeName: string, contexts: Dict<unknown>[]): TransitionState<T> {
    let intent = new NamedTransitionIntent(this, routeName, undefined, contexts);

    let state = (this.activeTransition && this.activeTransition[STATE_SYMBOL]) || this.state!;

    return intent.applyToState(state, false);
  }

  isActiveIntent(
    routeName: string,
    contexts: unknown[],
    queryParams?: Dict<unknown> | null,
    _state?: TransitionState<T>
  ) {
    let state = _state || this.state!,
      targetRouteInfos = state.routeInfos,
      routeInfo,
      len;

    if (!targetRouteInfos.length) {
      return false;
    }

    let targetHandler = targetRouteInfos[targetRouteInfos.length - 1].name;
    let recognizerHandlers: ParsedHandler[] = this.recognizer.handlersFor(targetHandler);

    let index = 0;
    for (len = recognizerHandlers.length; index < len; ++index) {
      routeInfo = targetRouteInfos[index];
      if (routeInfo.name === routeName) {
        break;
      }
    }

    if (index === recognizerHandlers.length) {
      // The provided route name isn't even in the route hierarchy.
      return false;
    }

    let testState = new TransitionState<T>();
    testState.routeInfos = targetRouteInfos.slice(0, index + 1);
    recognizerHandlers = recognizerHandlers.slice(0, index + 1);

    let intent = new NamedTransitionIntent(this, targetHandler, undefined, contexts);

    let newState = intent.applyToHandlers(testState, recognizerHandlers, targetHandler, true, true);

    let routesEqual = routeInfosEqual(newState.routeInfos, testState.routeInfos);
    if (!queryParams || !routesEqual) {
      return routesEqual;
    }

    // Get a hash of QPs that will still be active on new route
    let activeQPsOnNewHandler: Dict<unknown> = {};
    merge(activeQPsOnNewHandler, queryParams);

    let activeQueryParams = state.queryParams;
    for (let key in activeQueryParams) {
      if (activeQueryParams.hasOwnProperty(key) && activeQPsOnNewHandler.hasOwnProperty(key)) {
        activeQPsOnNewHandler[key] = activeQueryParams[key];
      }
    }

    return routesEqual && !getChangelist(activeQPsOnNewHandler, queryParams);
  }

  isActive(routeName: string, ...args: unknown[]) {
    let partitionedArgs = extractQueryParams(args);
    return this.isActiveIntent(routeName, partitionedArgs[0], partitionedArgs[1]);
  }

  trigger(name: string, ...args: any[]) {
    this.triggerEvent(this.currentRouteInfos!, false, name, args);
  }
}

function routeInfosEqual(
  routeInfos: InternalRouteInfo<Route>[],
  otherRouteInfos: InternalRouteInfo<Route>[]
) {
  if (routeInfos.length !== otherRouteInfos.length) {
    return false;
  }

  for (let i = 0, len = routeInfos.length; i < len; ++i) {
    if (routeInfos[i] !== otherRouteInfos[i]) {
      return false;
    }
  }
  return true;
}

function routeInfosSameExceptQueryParams(
  routeInfos: InternalRouteInfo<Route>[],
  otherRouteInfos: InternalRouteInfo<Route>[]
) {
  if (routeInfos.length !== otherRouteInfos.length) {
    return false;
  }

  for (let i = 0, len = routeInfos.length; i < len; ++i) {
    if (routeInfos[i].name !== otherRouteInfos[i].name) {
      return false;
    }

    if (!paramsEqual(routeInfos[i].params, otherRouteInfos[i].params)) {
      return false;
    }
  }
  return true;
}

function paramsEqual(params: Dict<unknown>, otherParams: Dict<unknown>) {
  if (!params && !otherParams) {
    return true;
  } else if ((!params && !!otherParams) || (!!params && !otherParams)) {
    // one is falsy but other is not;
    return false;
  }
  let keys = Object.keys(params);
  let otherKeys = Object.keys(otherParams);

  if (keys.length !== otherKeys.length) {
    return false;
  }

  for (let i = 0, len = keys.length; i < len; ++i) {
    let key = keys[i];

    if (params[key] !== otherParams[key]) {
      return false;
    }
  }

  return true;
}

export interface RoutePartition<T extends Route> {
  updatedContext: InternalRouteInfo<T>[];
  exited: InternalRouteInfo<T>[];
  entered: InternalRouteInfo<T>[];
  unchanged: InternalRouteInfo<T>[];
  reset: InternalRouteInfo<T>[];
}