@warp-drive/ember 5.6.0-beta.0 → 5.6.0-beta.2

package/dist/index.js

@@ -1,17 +1,11 @@
 import { service } from '@ember/service';
 import Component from '@glimmer/component';
-import { tracked, cached } from '@glimmer/tracking';
 import { macroCondition, moduleExists, importSync, getGlobalConfig } from '@embroider/macros';
-import { getPromiseState, getRequestState } from '@ember-data/store/-private';
-export { getPromiseState, getRequestState } from '@ember-data/store/-private';
-import { EnableHydration } from '@warp-drive/core-types/request';
+import { getPromiseState, DISPOSE, createRequestSubscription } from '@warp-drive/core/store/-private';
+export { getPromiseState, getRequestState } from '@warp-drive/core/store/-private';
 import { precompileTemplate } from '@ember/template-compilation';
 import { setComponentTemplate } from '@ember/component';
 
-/**
- * @module @warp-drive/ember
- */
-
 const and = (x, y) => Boolean(x && y);
 /**
  * The `<Throw />` component is used to throw an error in a template.
@@ -95,6 +89,7 @@ class Await extends Component {
     }), this);
   }
 }
+
 const deferred = /* @__PURE__ */new WeakMap();
 function deferDecorator(proto, prop, desc) {
   let map = deferred.get(proto);
@@ -134,20 +129,6 @@ function decorateFieldV2(prototype, prop, decorators, initializer) {
     deferDecorator(prototype, prop, desc);
   }
 }
-function decorateMethodV2(prototype, prop, decorators) {
-  const origDesc = Object.getOwnPropertyDescriptor(prototype, prop);
-  let desc = {
-    ...origDesc
-  };
-  for (let decorator of decorators) {
-    desc = decorator(prototype, prop, desc) || desc;
-  }
-  if (desc.initializer !== void 0) {
-    desc.value = desc.initializer ? desc.initializer.call(prototype) : void 0;
-    desc.initializer = void 0;
-  }
-  Object.defineProperty(prototype, prop, desc);
-}
 function initializeDeferredDecorator(target, prop) {
   let desc = findDeferredDecorator(target.constructor, prop);
   if (desc) {
@@ -160,10 +141,6 @@ function initializeDeferredDecorator(target, prop) {
   }
 }
 
-/**
- * @module @warp-drive/ember
- */
-
 function notNull(x) {
   macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
     if (!test) {
@@ -173,8 +150,6 @@ function notNull(x) {
   return x;
 }
 const not = x => !x;
-// default to 30 seconds unavailable before we refresh
-const DEFAULT_DEADLINE = 30_000;
 const IdleBlockMissingError = new Error('No idle block provided for <Request> component, and no query or request was provided.');
 let consume = service;
 if (macroCondition(moduleExists('ember-provide-consume-context'))) {
@@ -183,9 +158,6 @@ if (macroCondition(moduleExists('ember-provide-consume-context'))) {
   } = importSync('ember-provide-consume-context');
   consume = contextConsume;
 }
-function isNeverString(val) {
-  return val;
-}
 /**
  * The `<Request />` component is a powerful tool for managing data fetching and
  * state in your Ember application. It provides a declarative approach to reactive
@@ -414,525 +386,6 @@ class Request extends Component {
   *
   * @internal
   */
-  static {
-    decorateFieldV2(this.prototype, "isOnline", [tracked], function () {
-      return true;
-    });
-  }
-  #isOnline = (initializeDeferredDecorator(this, "isOnline"), void 0);
-  /**
-  * Whether the browser reports that the network is online.
-  *
-  * @internal
-  */
-  static {
-    decorateFieldV2(this.prototype, "isHidden", [tracked], function () {
-      return true;
-    });
-  }
-  #isHidden = (initializeDeferredDecorator(this, "isHidden"), void 0);
-  /**
-  * Whether the browser reports that the tab is hidden.
-  *
-  * @internal
-  */
-  static {
-    decorateFieldV2(this.prototype, "isRefreshing", [tracked], function () {
-      return false;
-    });
-  }
-  #isRefreshing = (initializeDeferredDecorator(this, "isRefreshing"), void 0);
-  /**
-  * Whether the component is currently refreshing the request.
-  *
-  * @internal
-  */
-  static {
-    decorateFieldV2(this.prototype, "_localRequest", [tracked]);
-  }
-  #_localRequest = (initializeDeferredDecorator(this, "_localRequest"), void 0);
-  /**
-  * The most recent blocking request that was made, typically
-  * the result of a reload.
-  *
-  * This will never be the original request passed as an arg to
-  * the component.
-  *
-  * @internal
-  */
-  static {
-    decorateFieldV2(this.prototype, "_latestRequest", [tracked]);
-  }
-  #_latestRequest = (initializeDeferredDecorator(this, "_latestRequest"), void 0);
-  /**
-  * The most recent request that was made, typically due to either a
-  * reload or a refresh.
-  *
-  * This will never be the original request passed as an arg to
-  * the component.
-  *
-  * @internal
-  */
-  /**
-  * The time at which the network was reported as offline.
-  *
-  * @internal
-  */
-  unavailableStart;
-  intervalStart;
-  nextInterval;
-  invalidated;
-  isUpdating;
-  /**
-  * The event listener for network status changes,
-  * cached to use the reference for removal.
-  *
-  * @internal
-  */
-  onlineChanged;
-  /**
-  * The event listener for visibility status changes,
-  * cached to use the reference for removal.
-  *
-  * @internal
-  */
-  backgroundChanged;
-  /**
-  * The last request passed as an arg to the component,
-  * cached for comparison.
-  *
-  * @internal
-  */
-  _originalRequest;
-  /**
-  * The last query passed as an arg to the component,
-  * cached for comparison.
-  *
-  * @internal
-  */
-  _originalQuery;
-  _subscription;
-  _subscribedTo;
-  constructor(owner, args) {
-    super(owner, args);
-    this._subscribedTo = null;
-    this._subscription = null;
-    this.intervalStart = null;
-    this.invalidated = false;
-    this.nextInterval = null;
-    this.installListeners();
-    void this.beginPolling();
-  }
-  async beginPolling() {
-    // await the initial request
-    try {
-      await this.request;
-    } catch {
-      // ignore errors here, we just want to wait for the request to finish
-    } finally {
-      if (!this.isDestroyed) {
-        void this.scheduleInterval();
-      }
-    }
-  }
-  get isIdle() {
-    const {
-      request,
-      query
-    } = this.args;
-    return Boolean(!request && !query);
-  }
-  static {
-    decorateMethodV2(this.prototype, "isIdle", [cached]);
-  }
-  get autorefreshTypes() {
-    const {
-      autorefresh
-    } = this.args;
-    let types;
-    if (autorefresh === true) {
-      types = ['online', 'invalid'];
-    } else if (typeof autorefresh === 'string') {
-      types = autorefresh.split(',');
-    } else {
-      types = [];
-    }
-    return new Set(types);
-  }
-  // we only run this function on component creation
-  // and when an update is triggered, so it does not
-  // react to changes in the autorefreshThreshold
-  // or autorefresh args.
-  //
-  // if we need to react to those changes, we can
-  // use a modifier or internal component or some
-  // such to trigger a re-run of this function.
-  static {
-    decorateMethodV2(this.prototype, "autorefreshTypes", [cached]);
-  }
-  async scheduleInterval() {
-    const {
-      autorefreshThreshold
-    } = this.args;
-    const hasValidThreshold = typeof autorefreshThreshold === 'number' && autorefreshThreshold > 0;
-    if (typeof window === 'undefined' ||
-    // dont schedule without a threshold
-    !hasValidThreshold ||
-    // dont schedule if we weren't told to
-    !this.autorefreshTypes.has('interval') ||
-    // dont schedule if we're already scheduled
-    this.intervalStart !== null) {
-      return;
-    }
-    // if we have a current request, wait for it to finish
-    // before scheduling the next one
-    if (this._latestRequest) {
-      try {
-        await this._latestRequest;
-      } catch {
-        // ignore errors here, we just want to wait for the request to finish
-      }
-      if (this.isDestroyed) {
-        return;
-      }
-    }
-    // setup the next interval
-    this.intervalStart = Date.now();
-    this.nextInterval = setTimeout(() => {
-      this.maybeUpdate();
-    }, autorefreshThreshold);
-  }
-  clearInterval() {
-    if (this.nextInterval) {
-      clearTimeout(this.nextInterval);
-      this.intervalStart = null;
-    }
-  }
-  updateSubscriptions() {
-    if (this.isIdle) {
-      return;
-    }
-    const requestId = this._request.lid;
-    // if we're already subscribed to this request, we don't need to do anything
-    if (this._subscribedTo === requestId) {
-      return;
-    }
-    // if we're subscribed to a different request, we need to unsubscribe
-    this.removeSubscriptions();
-    // if we have a request, we need to subscribe to it
-    if (requestId) {
-      this._subscribedTo = requestId;
-      this._subscription = this.store.notifications.subscribe(requestId, (_id, op) => {
-        // ignore subscription events that occur while our own component's request
-        // is ocurring
-        if (this.isUpdating) {
-          return;
-        }
-        switch (op) {
-          case 'invalidated':
-            {
-              // if we're subscribed to invalidations, we need to update
-              if (this.autorefreshTypes.has('invalid')) {
-                this.invalidated = true;
-                this.maybeUpdate();
-              }
-              break;
-            }
-          case 'state':
-            {
-              const latest = this.store.requestManager._deduped.get(requestId);
-              const priority = latest?.priority;
-              const state = this.reqState;
-              if (!priority) {
-                // if there is no priority, we have completed whatever request
-                // was occurring and so we are no longer refreshing (if we were)
-                this.isRefreshing = false;
-              } else if (priority.blocking && !state.isLoading) {
-                // if we are blocking, there is an active request for this identity
-                // that MUST be fulfilled from network (not cache).
-                // Thus this is not "refreshing" because we should clear out and
-                // block on this request.
-                //
-                // we receive state notifications when either a request initiates
-                // or completes.
-                //
-                // In the completes case: we may receive the state notification
-                // slightly before the request is finalized because the NotificationManager
-                // may sync flush it (and thus deliver it before the microtask completes)
-                //
-                // In the initiates case: we aren't supposed to receive one unless there
-                // is no other request in flight for this identity.
-                //
-                // However, there is a race condition here where the completed
-                // notification can trigger an update that generates a new request
-                // thus giving us an initiated notification before the older request
-                // finalizes.
-                //
-                // When this occurs, if the triggered update happens to have caused
-                // a new request to be made for the same identity AND that request
-                // is the one passed into this component as the @request arg, then
-                // getRequestState will return the state of the new request.
-                // We can detect this by checking if the request state is "loading"
-                // as outside of this case we would have a completed request.
-                //
-                // That is the reason for the `&& !state.isLoading` check above.
-                // TODO should we just treat this as refreshing?
-                this.isRefreshing = false;
-                this.maybeUpdate('policy', true);
-              } else {
-                this.isRefreshing = true;
-              }
-            }
-        }
-      });
-    }
-  }
-  removeSubscriptions() {
-    if (this._subscription) {
-      this.store.notifications.unsubscribe(this._subscription);
-      this._subscribedTo = null;
-      this._subscription = null;
-    }
-  }
-  /**
-  * Install the event listeners for network and visibility changes.
-  * This is only done in browser environments with a global `window`.
-  *
-  * @internal
-  */
-  installListeners() {
-    if (typeof window === 'undefined') {
-      return;
-    }
-    this.isOnline = window.navigator.onLine;
-    this.unavailableStart = this.isOnline ? null : Date.now();
-    this.isHidden = document.visibilityState === 'hidden';
-    this.onlineChanged = event => {
-      this.isOnline = event.type === 'online';
-      if (event.type === 'offline' && this.unavailableStart === null) {
-        this.unavailableStart = Date.now();
-      }
-      this.maybeUpdate();
-    };
-    this.backgroundChanged = () => {
-      const isHidden = document.visibilityState === 'hidden';
-      this.isHidden = isHidden;
-      if (isHidden && this.unavailableStart === null) {
-        this.unavailableStart = Date.now();
-      }
-      this.maybeUpdate();
-    };
-    window.addEventListener('online', this.onlineChanged, {
-      passive: true,
-      capture: true
-    });
-    window.addEventListener('offline', this.onlineChanged, {
-      passive: true,
-      capture: true
-    });
-    document.addEventListener('visibilitychange', this.backgroundChanged, {
-      passive: true,
-      capture: true
-    });
-  }
-  /**
-  * If the network is online and the tab is visible, either reload or refresh the request
-  * based on the component's configuration and the requested update mode.
-  *
-  * Valid modes are:
-  *
-  * - `'reload'`: Force a reload of the request.
-  * - `'refresh'`: Refresh the request in the background.
-  * - `'policy'`: Make the request, letting the store's configured CachePolicy decide whether to reload, refresh, or do nothing.
-  * - `undefined`: Make the request using the component's autorefreshBehavior setting if the autorefreshThreshold has passed.
-  *
-  * @internal
-  */
-  maybeUpdate(mode, silent) {
-    if (this.isIdle) {
-      return;
-    }
-    const canAttempt = Boolean(this.isOnline && !this.isHidden && (mode || this.autorefreshTypes.size));
-    if (!canAttempt) {
-      if (!silent && mode && mode !== 'invalidated') {
-        throw new Error(`Reload not available: the network is not online or the tab is hidden`);
-      }
-      return;
-    }
-    const {
-      autorefreshTypes
-    } = this;
-    let shouldAttempt = this.invalidated || Boolean(mode);
-    if (!shouldAttempt && autorefreshTypes.has('online')) {
-      const {
-        unavailableStart
-      } = this;
-      const {
-        autorefreshThreshold
-      } = this.args;
-      const deadline = typeof autorefreshThreshold === 'number' ? autorefreshThreshold : DEFAULT_DEADLINE;
-      shouldAttempt = Boolean(unavailableStart && Date.now() - unavailableStart > deadline);
-    }
-    if (!shouldAttempt && autorefreshTypes.has('interval')) {
-      const {
-        intervalStart
-      } = this;
-      const {
-        autorefreshThreshold
-      } = this.args;
-      if (intervalStart && typeof autorefreshThreshold === 'number' && autorefreshThreshold > 0) {
-        shouldAttempt = Boolean(Date.now() - intervalStart >= autorefreshThreshold);
-      }
-    }
-    this.unavailableStart = null;
-    this.invalidated = false;
-    if (shouldAttempt) {
-      this.clearInterval();
-      const request = Object.assign({}, this.reqState.request);
-      const realMode = mode === 'invalidated' ? null : mode;
-      const val = realMode ?? this.args.autorefreshBehavior ?? 'policy';
-      switch (val) {
-        case 'reload':
-          request.cacheOptions = Object.assign({}, request.cacheOptions, {
-            reload: true
-          });
-          break;
-        case 'refresh':
-          request.cacheOptions = Object.assign({}, request.cacheOptions, {
-            backgroundReload: true
-          });
-          break;
-        case 'policy':
-          break;
-        default:
-          throw new Error(`Invalid ${mode ? 'update mode' : '@autorefreshBehavior'} for <Request />: ${isNeverString(val)}`);
-      }
-      const wasStoreRequest = request[EnableHydration] === true;
-      macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
-        if (!test) {
-          throw new Error(`Cannot supply a different store via context than was used to create the request`);
-        }
-      })(!request.store || request.store === this.store) : {};
-      this.isUpdating = true;
-      this._latestRequest = wasStoreRequest ? this.store.request(request) : this.store.requestManager.request(request);
-      if (val !== 'refresh') {
-        this._localRequest = this._latestRequest;
-      }
-      void this.scheduleInterval();
-      void this._latestRequest.finally(() => {
-        this.isUpdating = false;
-      });
-    }
-  }
-  /**
-  * Retry the request, reloading it from the server.
-  *
-  * @internal
-  */
-  retry = async () => {
-    this.maybeUpdate('reload');
-    await this._localRequest;
-  };
-  /**
-  * Refresh the request, updating it in the background.
-  *
-  * @internal
-  */
-  refresh = async () => {
-    this.maybeUpdate('refresh');
-    await this._latestRequest;
-  };
-  get errorFeatures() {
-    return {
-      isHidden: this.isHidden,
-      isOnline: this.isOnline,
-      retry: this.retry
-    };
-  }
-  static {
-    decorateMethodV2(this.prototype, "errorFeatures", [cached]);
-  }
-  get contentFeatures() {
-    const feat = {
-      isHidden: this.isHidden,
-      isOnline: this.isOnline,
-      reload: this.retry,
-      refresh: this.refresh,
-      isRefreshing: this.isRefreshing,
-      latestRequest: this._latestRequest
-    };
-    if (feat.isRefreshing) {
-      feat.abort = () => {
-        this._latestRequest?.abort();
-      };
-    }
-    return feat;
-  }
-  static {
-    decorateMethodV2(this.prototype, "contentFeatures", [cached]);
-  }
-  willDestroy() {
-    this.removeSubscriptions();
-    if (typeof window === 'undefined') {
-      return;
-    }
-    this.clearInterval();
-    window.removeEventListener('online', this.onlineChanged, {
-      passive: true,
-      capture: true
-    });
-    window.removeEventListener('offline', this.onlineChanged, {
-      passive: true,
-      capture: true
-    });
-    document.removeEventListener('visibilitychange', this.backgroundChanged, {
-      passive: true,
-      capture: true
-    });
-  }
-  get _request() {
-    const {
-      request,
-      query
-    } = this.args;
-    macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
-      if (!test) {
-        throw new Error(`Cannot use both @request and @query args with the <Request> component`);
-      }
-    })(!request || !query) : {};
-    const {
-      _localRequest,
-      _originalRequest,
-      _originalQuery
-    } = this;
-    const isOriginalRequest = request === _originalRequest && query === _originalQuery;
-    if (_localRequest && isOriginalRequest) {
-      return _localRequest;
-    }
-    // update state checks for the next time
-    this._originalQuery = query;
-    this._originalRequest = request;
-    if (request) {
-      return request;
-    }
-    macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
-      if (!test) {
-        throw new Error(`You must provide either @request or an @query arg with the <Request> component`);
-      }
-    })(query) : {};
-    return this.store.request(query);
-  }
-  static {
-    decorateMethodV2(this.prototype, "_request", [cached]);
-  }
-  get request() {
-    const request = this._request;
-    this.updateSubscriptions();
-    return request;
-  }
-  static {
-    decorateMethodV2(this.prototype, "request", [cached]);
-  }
   get store() {
     const store = this.args.store || this._store;
     macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
@@ -942,14 +395,29 @@ class Request extends Component {
     })(store) : {};
     return store;
   }
-  get reqState() {
-    return getRequestState(this.request);
+  _state = null;
+  get state() {
+    let {
+      _state
+    } = this;
+    const {
+      store
+    } = this;
+    if (_state && _state.store !== store) {
+      _state[DISPOSE]();
+      _state = null;
+    }
+    if (!_state) {
+      this._state = _state = createRequestSubscription(store, this.args);
+    }
+    return _state;
   }
-  get result() {
-    return this.reqState.result;
+  willDestroy() {
+    this._state[DISPOSE]();
+    this._state = null;
   }
   static {
-    setComponentTemplate(precompileTemplate("\n    {{#if (and this.isIdle (has-block \"idle\"))}}\n      {{yield to=\"idle\"}}\n    {{else if this.isIdle}}\n      <Throw @error={{IdleBlockMissingError}} />\n    {{else if this.reqState.isLoading}}\n      {{yield this.reqState.loadingState to=\"loading\"}}\n    {{else if (and this.reqState.isCancelled (has-block \"cancelled\"))}}\n      {{yield (notNull this.reqState.error) this.errorFeatures to=\"cancelled\"}}\n    {{else if (and this.reqState.isError (has-block \"error\"))}}\n      {{yield (notNull this.reqState.error) this.errorFeatures to=\"error\"}}\n    {{else if this.reqState.isSuccess}}\n      {{yield this.result this.contentFeatures to=\"content\"}}\n    {{else if (not this.reqState.isCancelled)}}\n      <Throw @error={{(notNull this.reqState.error)}} />\n    {{/if}}\n    {{yield this.reqState to=\"always\"}}\n  ", {
+    setComponentTemplate(precompileTemplate("\n    {{#if (and this.state.isIdle (has-block \"idle\"))}}\n      {{yield to=\"idle\"}}\n\n    {{else if this.state.isIdle}}\n      <Throw @error={{IdleBlockMissingError}} />\n\n    {{else if this.state.reqState.isLoading}}\n      {{yield this.state.reqState.loadingState to=\"loading\"}}\n\n    {{else if (and this.state.reqState.isCancelled (has-block \"cancelled\"))}}\n      {{yield (notNull this.state.reqState.reason) this.state.errorFeatures to=\"cancelled\"}}\n\n    {{else if (and this.state.reqState.isError (has-block \"error\"))}}\n      {{yield (notNull this.state.reqState.reason) this.state.errorFeatures to=\"error\"}}\n\n    {{else if this.state.reqState.isSuccess}}\n      {{yield this.state.result this.state.contentFeatures to=\"content\"}}\n\n    {{else if (not this.state.reqState.isCancelled)}}\n      <Throw @error={{(notNull this.state.reqState.reason)}} />\n    {{/if}}\n\n    {{yield this.state.reqState to=\"always\"}}\n  ", {
       strictMode: true,
       scope: () => ({
         and,
@@ -961,4 +429,5 @@ class Request extends Component {
     }), this);
   }
 }
-export { Await, Request, Throw };
+
+export { Await, Request, Throw };

package/dist/install.js

@@ -1,9 +1,9 @@
-import '@ember-data/store/-private';
 import { tagForProperty } from '@ember/-internals/metal';
-import { createCache, track, updateTag, consumeTag, getValue, dirtyTag } from '@glimmer/validator';
 import { _backburner } from '@ember/runloop';
-import { setupSignals } from '@ember-data/store/configure';
-import { macroCondition, getGlobalConfig } from '@embroider/macros';
+import { createCache, track, updateTag, consumeTag, getValue, dirtyTag } from '@glimmer/validator';
+import { macroCondition, getGlobalConfig, importSync } from '@embroider/macros';
+import { setupSignals } from '@warp-drive/core/configure';
+
 const emberDirtyTag = dirtyTag;
 function buildSignalConfig(options) {
   const ARRAY_SIGNAL = options.wellknown.Array;
@@ -60,8 +60,18 @@ function buildSignalConfig(options) {
     willSyncFlushWatchers: () => {
       //@ts-expect-error
       return !!_backburner.currentInstance && _backburner._autorun !== true;
+    },
+    waitFor: async promise => {
+      if (macroCondition(getGlobalConfig().WarpDrive.env.TESTING)) {
+        const {
+          waitForPromise
+        } = importSync('@ember/test-waiters');
+        return waitForPromise(promise);
+      }
+      return promise;
     }
   };
 }
 setupSignals(buildSignalConfig);
-export { buildSignalConfig };
+
+export { buildSignalConfig };