#

API Docs for: v2.11.1
Show: Inherited Protected Private Deprecated

# File: packages/ember-application/lib/system/application-instance.js

    /**
    @module ember
    @submodule ember-application
    */

    import { assign } from 'ember-utils';
    import { deprecate, get, set, run, computed } from 'ember-metal';
    import {
      buildFakeRegistryWithDeprecations,
      RSVP
    } from 'ember-runtime';
    import { environment } from 'ember-environment';
    import { jQuery } from 'ember-views';
    import EngineInstance from './engine-instance';

    let BootOptions;

    /**
      The `ApplicationInstance` encapsulates all of the stateful aspects of a
      running `Application`.

      At a high-level, we break application boot into two distinct phases:

      * Definition time, where all of the classes, templates, and other
        dependencies are loaded (typically in the browser).
      * Run time, where we begin executing the application once everything
        has loaded.

      Definition time can be expensive and only needs to happen once since it is
      an idempotent operation. For example, between test runs and FastBoot
      requests, the application stays the same. It is only the state that we want
      to reset.

      That state is what the `ApplicationInstance` manages: it is responsible for
      creating the container that contains all application state, and disposing of
      it once the particular test run or FastBoot request has finished.

      @public
      @class Ember.ApplicationInstance
      @extends Ember.EngineInstance
    */

    const ApplicationInstance = EngineInstance.extend({
      /**
        The `Application` for which this is an instance.

        @property {Ember.Application} application
        @private
      */
      application: null,

      /**
        The DOM events for which the event dispatcher should listen.

        By default, the application's `Ember.EventDispatcher` listens
        for a set of standard DOM events, such as `mousedown` and
        `keyup`, and delegates them to your application's `Ember.View`
        instances.

        @private
        @property {Object} customEvents
      */
      customEvents: null,

      /**
        The root DOM element of the Application as an element or a
        [jQuery-compatible selector
        string](http://api.jquery.com/category/selectors/).

        @private
        @property {String|DOMElement} rootElement
      */
      rootElement: null,

      init() {
        this._super(...arguments);

        // Register this instance in the per-instance registry.
        //
        // Why do we need to register the instance in the first place?
        // Because we need a good way for the root route (a.k.a ApplicationRoute)
        // to notify us when it has created the root-most view. That view is then
        // appended to the rootElement, in the case of apps, to the fixture harness
        // in tests, or rendered to a string in the case of FastBoot.
        this.register('-application-instance:main', this, { instantiate: false });
      },

      /**
        Overrides the base `EngineInstance._bootSync` method with concerns relevant
        to booting application (instead of engine) instances.

        This method should only contain synchronous boot concerns. Asynchronous
        boot concerns should eventually be moved to the `boot` method, which
        returns a promise.

        Until all boot code has been made asynchronous, we need to continue to
        expose this method for use *internally* in places where we need to boot an
        instance synchronously.

        @private
      */
      _bootSync(options) {
        if (this._booted) { return this; }

        options = new BootOptions(options);

        this.setupRegistry(options);

        if (options.rootElement) {
          this.rootElement = options.rootElement;
        } else {
          this.rootElement = this.application.rootElement;
        }

        if (options.location) {
          let router = get(this, 'router');
          set(router, 'location', options.location);
        }

        this.application.runInstanceInitializers(this);

        if (options.isInteractive) {
          this.setupEventDispatcher();
        }

        this._booted = true;

        return this;
      },

      setupRegistry(options) {
        this.constructor.setupRegistry(this.__registry__, options);
      },

      router: computed(function() {
        return this.lookup('router:main');
      }).readOnly(),

      /**
        This hook is called by the root-most Route (a.k.a. the ApplicationRoute)
        when it has finished creating the root View. By default, we simply take the
        view and append it to the `rootElement` specified on the Application.

        In cases like FastBoot and testing, we can override this hook and implement
        custom behavior, such as serializing to a string and sending over an HTTP
        socket rather than appending to DOM.

        @param view {Ember.View} the root-most view
        @private
      */
      didCreateRootView(view) {
        view.appendTo(this.rootElement);
      },

      /**
        Tells the router to start routing. The router will ask the location for the
        current URL of the page to determine the initial URL to start routing to.
        To start the app at a specific URL, call `handleURL` instead.

        @private
      */
      startRouting() {
        let router = get(this, 'router');
        router.startRouting();
        this._didSetupRouter = true;
      },

      /**
        @private

        Sets up the router, initializing the child router and configuring the
        location before routing begins.

        Because setup should only occur once, multiple calls to `setupRouter`
        beyond the first call have no effect.
      */
      setupRouter() {
        if (this._didSetupRouter) { return; }
        this._didSetupRouter = true;

        let router = get(this, 'router');
        router.setupRouter();
      },

      /**
        Directs the router to route to a particular URL. This is useful in tests,
        for example, to tell the app to start at a particular URL.

        @param url {String} the URL the router should route to
        @private
      */
      handleURL(url) {
        let router = get(this, 'router');

        this.setupRouter();
        return router.handleURL(url);
      },

      /**
        @private
      */
      setupEventDispatcher() {
        let dispatcher = this.lookup('event_dispatcher:main');
        let applicationCustomEvents = get(this.application, 'customEvents');
        let instanceCustomEvents = get(this, 'customEvents');

        let customEvents = assign({}, applicationCustomEvents, instanceCustomEvents);
        dispatcher.setup(customEvents, this.rootElement);

        return dispatcher;
      },

      /**
        Returns the current URL of the app instance. This is useful when your
        app does not update the browsers URL bar (i.e. it uses the `'none'`
        location adapter).

        @public
        @return {String} the current URL
      */
      getURL() {
        let router = get(this, 'router');
        return get(router, 'url');
      },

      // `instance.visit(url)` should eventually replace `instance.handleURL()`;
      // the test helpers can probably be switched to use this implementation too

      /**
        Navigate the instance to a particular URL. This is useful in tests, for
        example, or to tell the app to start at a particular URL. This method
        returns a promise that resolves with the app instance when the transition
        is complete, or rejects if the transion was aborted due to an error.

        @public
        @param url {String} the destination URL
        @return {Promise}
      */
      visit(url) {
        this.setupRouter();

        let bootOptions = this.__container__.lookup('-environment:main');

        let router = get(this, 'router');

        let handleTransitionResolve = () => {
          if (!bootOptions.options.shouldRender) {
            // No rendering is needed, and routing has completed, simply return.
            return this;
          } else {
            return new RSVP.Promise((resolve) => {
              // Resolve once rendering is completed. `router.handleURL` returns the transition (as a thennable)
              // which resolves once the transition is completed, but the transition completion only queues up
              // a scheduled revalidation (into the `render` queue) in the Renderer.
              //
              // This uses `run.schedule('afterRender', ....)` to resolve after that rendering has completed.
              run.schedule('afterRender', null, resolve, this);
            });
          }
        };

        let handleTransitionReject = (error) => {
          if (error.error) {
            throw error.error;
          } else if (error.name === 'TransitionAborted' && router.router.activeTransition) {
            return router.router.activeTransition.then(handleTransitionResolve, handleTransitionReject);
          } else if (error.name === 'TransitionAborted') {
            throw new Error(error.message);
          } else {
            throw error;
          }
        };

        let location = get(router, 'location');

        // Keeps the location adapter's internal URL in-sync
        location.setURL(url);

        // getURL returns the set url with the rootURL stripped off
        return router.handleURL(location.getURL()).then(handleTransitionResolve, handleTransitionReject);
      }
    });

    ApplicationInstance.reopenClass({
      /**
       @private
       @method setupRegistry
       @param {Registry} registry
       @param {BootOptions} options
      */
      setupRegistry(registry, options = {}) {
        if (!options.toEnvironment) {
          options = new BootOptions(options);
        }

        registry.register('-environment:main', options.toEnvironment(), { instantiate: false });
        registry.register('service:-document', options.document, { instantiate: false });

        this._super(registry, options);
      }
    });

    /**
      A list of boot-time configuration options for customizing the behavior of
      an `Ember.ApplicationInstance`.

      This is an interface class that exists purely to document the available
      options; you do not need to construct it manually. Simply pass a regular
      JavaScript object containing the desired options into methods that require
      one of these options object:

      ```javascript
      MyApp.visit("/", { location: "none", rootElement: "#container" });
      ```

      Not all combinations of the supported options are valid. See the documentation
      on `Ember.Application#visit` for the supported configurations.

      Internal, experimental or otherwise unstable flags are marked as private.

      @class BootOptions
      @namespace Ember.ApplicationInstance
      @public
    */
    BootOptions = function BootOptions(options = {}) {
      /**
        Provide a specific instance of jQuery. This is useful in conjunction with
        the `document` option, as it allows you to use a copy of `jQuery` that is
        appropriately bound to the foreign `document` (e.g. a jsdom).

        This is highly experimental and support very incomplete at the moment.

        @property jQuery
        @type Object
        @default auto-detected
        @private
      */
      this.jQuery = jQuery; // This default is overridable below

      /**
        Interactive mode: whether we need to set up event delegation and invoke
        lifecycle callbacks on Components.

        @property isInteractive
        @type boolean
        @default auto-detected
        @private
      */
      this.isInteractive = environment.hasDOM; // This default is overridable below

      /**
        Run in a full browser environment.

        When this flag is set to `false`, it will disable most browser-specific
        and interactive features. Specifically:

        * It does not use `jQuery` to append the root view; the `rootElement`
          (either specified as a subsequent option or on the application itself)
          must already be an `Element` in the given `document` (as opposed to a
          string selector).

        * It does not set up an `EventDispatcher`.

        * It does not run any `Component` lifecycle hooks (such as `didInsertElement`).

        * It sets the `location` option to `"none"`. (If you would like to use
          the location adapter specified in the app's router instead, you can also
          specify `{ location: null }` to specifically opt-out.)

        @property isBrowser
        @type boolean
        @default auto-detected
        @public
      */
      if (options.isBrowser !== undefined) {
        this.isBrowser = !!options.isBrowser;
      } else {
        this.isBrowser = environment.hasDOM;
      }

      if (!this.isBrowser) {
        this.jQuery = null;
        this.isInteractive = false;
        this.location = 'none';
      }

      /**
        Disable rendering completely.

        When this flag is set to `true`, it will disable the entire rendering
        pipeline. Essentially, this puts the app into "routing-only" mode. No
        templates will be rendered, and no Components will be created.

        @property shouldRender
        @type boolean
        @default true
        @public
      */
      if (options.shouldRender !== undefined) {
        this.shouldRender = !!options.shouldRender;
      } else {
        this.shouldRender = true;
      }

      if (!this.shouldRender) {
        this.jQuery = null;
        this.isInteractive = false;
      }

      /**
        If present, render into the given `Document` object instead of the
        global `window.document` object.

        In practice, this is only useful in non-browser environment or in
        non-interactive mode, because Ember's `jQuery` dependency is
        implicitly bound to the current document, causing event delegation
        to not work properly when the app is rendered into a foreign
        document object (such as an iframe's `contentDocument`).

        In non-browser mode, this could be a "`Document`-like" object as
        Ember only interact with a small subset of the DOM API in non-
        interactive mode. While the exact requirements have not yet been
        formalized, the `SimpleDOM` library's implementation is known to
        work.

        @property document
        @type Document
        @default the global `document` object
        @public
      */
      if (options.document) {
        this.document = options.document;
      } else {
        this.document = (typeof document !== 'undefined') ? document : null;
      }

      /**
        If present, overrides the application's `rootElement` property on
        the instance. This is useful for testing environment, where you
        might want to append the root view to a fixture area.

        In non-browser mode, because Ember does not have access to jQuery,
        this options must be specified as a DOM `Element` object instead of
        a selector string.

        See the documentation on `Ember.Applications`'s `rootElement` for
        details.

        @property rootElement
        @type String|Element
        @default null
        @public
       */
      if (options.rootElement) {
        this.rootElement = options.rootElement;
      }

      // Set these options last to give the user a chance to override the
      // defaults from the "combo" options like `isBrowser` (although in
      // practice, the resulting combination is probably invalid)

      /**
        If present, overrides the router's `location` property with this
        value. This is useful for environments where trying to modify the
        URL would be inappropriate.

        @property location
        @type string
        @default null
        @public
      */
      if (options.location !== undefined) {
        this.location = options.location;
      }

      if (options.jQuery !== undefined) {
        this.jQuery = options.jQuery;
      }

      if (options.isInteractive !== undefined) {
        this.isInteractive = !!options.isInteractive;
      }
    };

    BootOptions.prototype.toEnvironment = function() {
      let env = assign({}, environment);
      // For compatibility with existing code
      env.hasDOM = this.isBrowser;
      env.isInteractive = this.isInteractive;
      env.options = this;
      return env;
    };

    Object.defineProperty(ApplicationInstance.prototype, 'container', {
      configurable: true,
      enumerable: false,
      get() {
        let instance = this;
        return {
          lookup() {
            deprecate(
              'Using `ApplicationInstance.container.lookup` is deprecated. Please use `ApplicationInstance.lookup` instead.',
              false, {
                id: 'ember-application.app-instance-container',
                until: '3.0.0',
                url: 'http://emberjs.com/deprecations/v2.x/#toc_ember-applicationinstance-container'
              }
            );
            return instance.lookup(...arguments);
          }
        };
      }
    });

    Object.defineProperty(ApplicationInstance.prototype, 'registry', {
      configurable: true,
      enumerable: false,
      get() {
        return buildFakeRegistryWithDeprecations(this, 'ApplicationInstance');
      }
    });

    export default ApplicationInstance;