@ember-data/request-utils 5.4.0-alpha.6 → 5.4.0-alpha.60

package/README.md

@@ -28,6 +28,16 @@ Install using your javascript package manager of choice. For instance with [pnpm
 ```no-highlight
 pnpm add @ember-data/request-utils
 ```
+
+**Tagged Releases**
+
+- ![NPM Canary Version](https://img.shields.io/npm/v/%40ember-data/request-utils/canary?label=%40canary&color=FFBF00)
+- ![NPM Beta Version](https://img.shields.io/npm/v/%40ember-data/request-utils/beta?label=%40beta&color=ff00ff)
+- ![NPM Stable Version](https://img.shields.io/npm/v/%40ember-data/request-utils/latest?label=%40latest&color=90EE90)
+- ![NPM LTS Version](https://img.shields.io/npm/v/%40ember-data/request-utils/lts?label=%40lts&color=0096FF)
+- ![NPM LTS 4.12 Version](https://img.shields.io/npm/v/%40ember-data/request-utils/lts-4-12?label=%40lts-4-12&color=bbbbbb)
+
+
 ## Utils
 
 - [buildBaseUrl]()

package/addon/index.js

@@ -1,4 +1,4 @@
-import { assert } from '@ember/debug';
+import { assert, deprecate } from '@ember/debug';
 
 /**
  * Simple utility function to assist in url building,
@@ -43,18 +43,70 @@ import { assert } from '@ember/debug';
 // prevents the final constructed object from needing to add
 // host and namespace which are provided by the final consuming
 // class to the prototype which can result in overwrite errors
-let CONFIG = {
+
+const CONFIG = {
   host: '',
   namespace: ''
 };
-function setBuildURLConfig(values) {
-  CONFIG = values;
+
+/**
+ * Sets the global configuration for `buildBaseURL`
+ * for host and namespace values for the application.
+ *
+ * These values may still be overridden by passing
+ * them to buildBaseURL directly.
+ *
+ * This method may be called as many times as needed.
+ * host values of `''` or `'/'` are equivalent.
+ *
+ * Except for the value of `/` as host, host should not
+ * end with `/`.
+ *
+ * namespace should not start or end with a `/`.
+ *
+ * ```ts
+ * type BuildURLConfig = {
+ *   host: string;
+ *   namespace: string'
+ * }
+ * ```
+ *
+ * Example:
+ *
+ * ```ts
+ * import { setBuildURLConfig } from '@ember-data/request-utils';
+ *
+ * setBuildURLConfig({
+ *   host: 'https://api.example.com',
+ *   namespace: 'api/v1'
+ * });
+ * ```
+ *
+ * @method setBuildURLConfig
+ * @static
+ * @public
+ * @for @ember-data/request-utils
+ * @param {BuildURLConfig} config
+ * @return void
+ */
+function setBuildURLConfig(config) {
+  assert(`setBuildURLConfig: You must pass a config object`, config);
+  assert(`setBuildURLConfig: You must pass a config object with a 'host' or 'namespace' property`, 'host' in config || 'namespace' in config);
+  CONFIG.host = config.host || '';
+  CONFIG.namespace = config.namespace || '';
+  assert(`buildBaseURL: host must NOT end with '/', received '${CONFIG.host}'`, CONFIG.host === '/' || !CONFIG.host.endsWith('/'));
+  assert(`buildBaseURL: namespace must NOT start with '/', received '${CONFIG.namespace}'`, !CONFIG.namespace.startsWith('/'));
+  assert(`buildBaseURL: namespace must NOT end with '/', received '${CONFIG.namespace}'`, !CONFIG.namespace.endsWith('/'));
 }
 const OPERATIONS_WITH_PRIMARY_RECORDS = new Set(['findRecord', 'findRelatedRecord', 'findRelatedCollection', 'updateRecord', 'deleteRecord']);
 function isOperationWithPrimaryRecord(options) {
-  return OPERATIONS_WITH_PRIMARY_RECORDS.has(options.op);
+  return 'op' in options && OPERATIONS_WITH_PRIMARY_RECORDS.has(options.op);
+}
+function hasResourcePath(options) {
+  return 'resourcePath' in options && typeof options.resourcePath === 'string' && options.resourcePath.length > 0;
 }
 function resourcePathForType(options) {
+  assert(`resourcePathForType: You must pass a valid op as part of options`, 'op' in options && typeof options.op === 'string');
   return options.op === 'findMany' ? options.identifiers[0].type : options.identifier.type;
 }
 
@@ -97,20 +149,20 @@ function resourcePathForType(options) {
  * @public
  * @for @ember-data/request-utils
  * @param urlOptions
- * @returns string
+ * @return string
  */
 function buildBaseURL(urlOptions) {
   const options = Object.assign({
     host: CONFIG.host,
     namespace: CONFIG.namespace
   }, urlOptions);
-  assert(`buildBaseURL: You must pass \`op\` as part of options`, typeof options.op === 'string' && options.op.length > 0);
-  assert(`buildBaseURL: You must pass \`identifier\` as part of options`, options.op === 'findMany' || options.identifier && typeof options.identifier === 'object');
-  assert(`buildBaseURL: You must pass \`identifiers\` as part of options`, options.op !== 'findMany' || options.identifiers && Array.isArray(options.identifiers) && options.identifiers.length > 0 && options.identifiers.every(i => i && typeof i === 'object'));
-  assert(`buildBaseURL: You must pass valid \`identifier\` as part of options, expected 'id'`, !isOperationWithPrimaryRecord(options) || typeof options.identifier.id === 'string' && options.identifier.id.length > 0);
-  assert(`buildBaseURL: You must pass \`identifiers\` as part of options`, options.op !== 'findMany' || options.identifiers.every(i => typeof i.id === 'string' && i.id.length > 0));
-  assert(`buildBaseURL: You must pass valid \`identifier\` as part of options, expected 'type'`, options.op === 'findMany' || typeof options.identifier.type === 'string' && options.identifier.type.length > 0);
-  assert(`buildBaseURL: You must pass valid \`identifiers\` as part of options, expected 'type'`, options.op !== 'findMany' || typeof options.identifiers[0].type === 'string' && options.identifiers[0].type.length > 0);
+  assert(`buildBaseURL: You must pass \`op\` as part of options`, hasResourcePath(options) || typeof options.op === 'string' && options.op.length > 0);
+  assert(`buildBaseURL: You must pass \`identifier\` as part of options`, hasResourcePath(options) || options.op === 'findMany' || options.identifier && typeof options.identifier === 'object');
+  assert(`buildBaseURL: You must pass \`identifiers\` as part of options`, hasResourcePath(options) || options.op !== 'findMany' || options.identifiers && Array.isArray(options.identifiers) && options.identifiers.length > 0 && options.identifiers.every(i => i && typeof i === 'object'));
+  assert(`buildBaseURL: You must pass valid \`identifier\` as part of options, expected 'id'`, hasResourcePath(options) || !isOperationWithPrimaryRecord(options) || typeof options.identifier.id === 'string' && options.identifier.id.length > 0);
+  assert(`buildBaseURL: You must pass \`identifiers\` as part of options`, hasResourcePath(options) || options.op !== 'findMany' || options.identifiers.every(i => typeof i.id === 'string' && i.id.length > 0));
+  assert(`buildBaseURL: You must pass valid \`identifier\` as part of options, expected 'type'`, hasResourcePath(options) || options.op === 'findMany' || typeof options.identifier.type === 'string' && options.identifier.type.length > 0);
+  assert(`buildBaseURL: You must pass valid \`identifiers\` as part of options, expected 'type'`, hasResourcePath(options) || options.op !== 'findMany' || typeof options.identifiers[0].type === 'string' && options.identifiers[0].type.length > 0);
 
   // prettier-ignore
   const idPath = isOperationWithPrimaryRecord(options) ? encodeURIComponent(options.identifier.id) : '';
@@ -120,7 +172,7 @@ function buildBaseURL(urlOptions) {
     namespace
   } = options;
   const fieldPath = 'fieldPath' in options ? options.fieldPath : '';
-  assert(`buildBaseURL: You tried to build a ${String(options.op)} request to ${resourcePath} but op must be one of "${['findRecord', 'findRelatedRecord', 'findRelatedCollection', 'updateRecord', 'deleteRecord', 'createRecord', 'query', 'findMany'].join('","')}".`, ['findRecord', 'query', 'findMany', 'findRelatedCollection', 'findRelatedRecord', 'createRecord', 'updateRecord', 'deleteRecord'].includes(options.op));
+  assert(`buildBaseURL: You tried to build a url for a ${String('op' in options ? options.op + ' ' : '')}request to ${resourcePath} but resourcePath must be set or op must be one of "${['findRecord', 'findRelatedRecord', 'findRelatedCollection', 'updateRecord', 'deleteRecord', 'createRecord', 'query', 'findMany'].join('","')}".`, hasResourcePath(options) || ['findRecord', 'query', 'findMany', 'findRelatedCollection', 'findRelatedRecord', 'createRecord', 'updateRecord', 'deleteRecord'].includes(options.op));
   assert(`buildBaseURL: host must NOT end with '/', received '${host}'`, host === '/' || !host.endsWith('/'));
   assert(`buildBaseURL: namespace must NOT start with '/', received '${namespace}'`, !namespace.startsWith('/'));
   assert(`buildBaseURL: namespace must NOT end with '/', received '${namespace}'`, !namespace.endsWith('/'));
@@ -130,8 +182,9 @@ function buildBaseURL(urlOptions) {
   assert(`buildBaseURL: fieldPath must NOT end with '/', received '${fieldPath}'`, !fieldPath.endsWith('/'));
   assert(`buildBaseURL: idPath must NOT start with '/', received '${idPath}'`, !idPath.startsWith('/'));
   assert(`buildBaseURL: idPath must NOT end with '/', received '${idPath}'`, !idPath.endsWith('/'));
-  const url = [host === '/' ? '' : host, namespace, resourcePath, idPath, fieldPath].filter(Boolean).join('/');
-  return host ? url : `/${url}`;
+  const hasHost = host !== '' && host !== '/';
+  const url = [hasHost ? host : '', namespace, resourcePath, idPath, fieldPath].filter(Boolean).join('/');
+  return hasHost ? url : `/${url}`;
 }
 const DEFAULT_QUERY_PARAMS_SERIALIZATION_OPTIONS = {
   arrayFormat: 'comma'
@@ -140,20 +193,56 @@ function handleInclude(include) {
   assert(`Expected include to be a string or array, got ${typeof include}`, typeof include === 'string' || Array.isArray(include));
   return typeof include === 'string' ? include.split(',') : include;
 }
-function filterEmpty(obj) {
+
+/**
+ * filter out keys of an object that have falsy values or point to empty arrays
+ * returning a new object with only those keys that have truthy values / non-empty arrays
+ *
+ * @method filterEmpty
+ * @static
+ * @public
+ * @for @ember-data/request-utils
+ * @param {Record<string, Serializable>} source object to filter keys with empty values from
+ * @return {Record<string, Serializable>} A new object with the keys that contained empty values removed
+ */
+function filterEmpty(source) {
   const result = {};
-  for (const key in obj) {
-    const value = obj[key];
-    if (value) {
+  for (const key in source) {
+    const value = source[key];
+    // Allow `0` and `false` but filter falsy values that indicate "empty"
+    if (value !== undefined && value !== null && value !== '') {
       if (!Array.isArray(value) || value.length > 0) {
-        result[key] = obj[key];
+        result[key] = source[key];
       }
     }
   }
   return result;
 }
+
+/**
+ * Sorts query params by both key and value returning a new URLSearchParams
+ * object with the keys inserted in sorted order.
+ *
+ * Treats `included` specially, splicing it into an array if it is a string and sorting the array.
+ *
+ * Options:
+ * - arrayFormat: 'bracket' | 'indices' | 'repeat' | 'comma'
+ *
+ * 'bracket': appends [] to the key for every value e.g. `&ids[]=1&ids[]=2`
+ * 'indices': appends [i] to the key for every value e.g. `&ids[0]=1&ids[1]=2`
+ * 'repeat': appends the key for every value e.g. `&ids=1&ids=2`
+ * 'comma' (default): appends the key once with a comma separated list of values e.g. `&ids=1,2`
+ *
+ * @method sortQueryParams
+ * @static
+ * @public
+ * @for @ember-data/request-utils
+ * @param {URLSearchParams | object} params
+ * @param {object} options
+ * @return {URLSearchParams} A URLSearchParams with keys inserted in sorted order
+ */
 function sortQueryParams(params, options) {
-  options = Object.assign({}, DEFAULT_QUERY_PARAMS_SERIALIZATION_OPTIONS, options);
+  const opts = Object.assign({}, DEFAULT_QUERY_PARAMS_SERIALIZATION_OPTIONS, options);
   const paramsIsObject = !(params instanceof URLSearchParams);
   const urlParams = new URLSearchParams();
   const dictionaryParams = paramsIsObject ? params : {};
@@ -180,7 +269,7 @@ function sortQueryParams(params, options) {
     const value = dictionaryParams[key];
     if (Array.isArray(value)) {
       value.sort();
-      switch (options.arrayFormat) {
+      switch (opts.arrayFormat) {
         case 'indices':
           value.forEach((v, i) => {
             urlParams.append(`${key}[${i}]`, String(v));
@@ -207,22 +296,79 @@ function sortQueryParams(params, options) {
   });
   return urlParams;
 }
+
+/**
+ * Sorts query params by both key and value, returning a query params string
+ *
+ * Treats `included` specially, splicing it into an array if it is a string and sorting the array.
+ *
+ * Options:
+ * - arrayFormat: 'bracket' | 'indices' | 'repeat' | 'comma'
+ *
+ * 'bracket': appends [] to the key for every value e.g. `ids[]=1&ids[]=2`
+ * 'indices': appends [i] to the key for every value e.g. `ids[0]=1&ids[1]=2`
+ * 'repeat': appends the key for every value e.g. `ids=1&ids=2`
+ * 'comma' (default): appends the key once with a comma separated list of values e.g. `ids=1,2`
+ *
+ * @method buildQueryParams
+ * @static
+ * @public
+ * @for @ember-data/request-utils
+ * @param {URLSearchParams | object} params
+ * @param {object} [options]
+ * @return {string} A sorted query params string without the leading `?`
+ */
 function buildQueryParams(params, options) {
   return sortQueryParams(params, options).toString();
 }
 const NUMERIC_KEYS = new Set(['max-age', 's-maxage', 'stale-if-error', 'stale-while-revalidate']);
+
+/**
+ *  Parses a string Cache-Control header value into an object with the following structure:
+ *
+ * ```ts
+ * interface CacheControlValue {
+ *   immutable?: boolean;
+ *   'max-age'?: number;
+ *   'must-revalidate'?: boolean;
+ *   'must-understand'?: boolean;
+ *   'no-cache'?: boolean;
+ *   'no-store'?: boolean;
+ *   'no-transform'?: boolean;
+ *   'only-if-cached'?: boolean;
+ *   private?: boolean;
+ *   'proxy-revalidate'?: boolean;
+ *   public?: boolean;
+ *   's-maxage'?: number;
+ *   'stale-if-error'?: number;
+ *   'stale-while-revalidate'?: number;
+ * }
+ * ```
+ * @method parseCacheControl
+ * @static
+ * @public
+ * @for @ember-data/request-utils
+ * @param {string} header
+ * @return {CacheControlValue}
+ */
 function parseCacheControl(header) {
   let key = '';
   let value = '';
   let isParsingKey = true;
-  let cacheControlValue = {};
+  const cacheControlValue = {};
+  function parseCacheControlValue(stringToParse) {
+    const parsedValue = Number.parseInt(stringToParse);
+    assert(`Invalid Cache-Control value, expected a number but got - ${stringToParse}`, !Number.isNaN(parsedValue));
+    return parsedValue;
+  }
   for (let i = 0; i < header.length; i++) {
-    let char = header.charAt(i);
+    const char = header.charAt(i);
     if (char === ',') {
       assert(`Invalid Cache-Control value, expected a value`, !isParsingKey || !NUMERIC_KEYS.has(key));
       assert(`Invalid Cache-Control value, expected a value after "=" but got ","`, i === 0 || header.charAt(i - 1) !== '=');
       isParsingKey = true;
-      cacheControlValue[key] = NUMERIC_KEYS.has(key) ? Number.parseInt(value) : true;
+      // @ts-expect-error TS incorrectly thinks that optional keys must have a type that includes undefined
+      cacheControlValue[key] = NUMERIC_KEYS.has(key) ? parseCacheControlValue(value) : true;
       key = '';
       value = '';
       continue;
@@ -237,7 +383,8 @@ function parseCacheControl(header) {
       value += char;
     }
     if (i === header.length - 1) {
-      cacheControlValue[key] = NUMERIC_KEYS.has(key) ? Number.parseInt(value) : true;
+      // @ts-expect-error TS incorrectly thinks that optional keys must have a type that includes undefined
+      cacheControlValue[key] = NUMERIC_KEYS.has(key) ? parseCacheControlValue(value) : true;
     }
   }
   return cacheControlValue;
@@ -257,17 +404,231 @@ function isStale(headers, expirationTime) {
   const result = now > deadline;
   return result;
 }
+/**
+ * A basic LifetimesService that can be added to the Store service.
+ *
+ * Determines staleness based on time since the request was last received from the API
+ * using the `date` header.
+ *
+ * Invalidates any request for which `cacheOptions.types` was provided when a createRecord
+ * request for that type is successful.
+ *
+ * For this to work, the `createRecord` request must include the `cacheOptions.types` array
+ * with the types that should be invalidated, or its request should specify the identifiers
+ * of the records that are being created via `records`. Providing both is valid.
+ *
+ * > [!NOTE]
+ * > only requests that had specified `cacheOptions.types` and occurred prior to the
+ * > createRecord request will be invalidated. This means that a given request should always
+ * > specify the types that would invalidate it to opt into this behavior. Abstracting this
+ * > behavior via builders is recommended to ensure consistency.
+ *
+ * This allows the Store's CacheHandler to determine if a request is expired and
+ * should be refetched upon next request.
+ *
+ * The `Fetch` handler provided by `@ember-data/request/fetch` will automatically
+ * add the `date` header to responses if it is not present.
+ *
+ * > [!NOTE]
+ * > Date headers do not have millisecond precision, so expiration times should
+ * > generally be larger than 1000ms.
+ *
+ * Usage:
+ *
+ * ```ts
+ * import { LifetimesService } from '@ember-data/request-utils';
+ * import DataStore from '@ember-data/store';
+ *
+ * // ...
+ *
+ * export class Store extends DataStore {
+ *   constructor(args) {
+ *     super(args);
+ *     this.lifetimes = new LifetimesService({ apiCacheSoftExpires: 30_000, apiCacheHardExpires: 60_000 });
+ *   }
+ * }
+ * ```
+ *
+ * @class LifetimesService
+ * @public
+ * @module @ember-data/request-utils
+ */
 class LifetimesService {
-  constructor(store, config) {
-    this.store = store;
-    this.config = config;
+  _getStore(store) {
+    let set = this._stores.get(store);
+    if (!set) {
+      set = {
+        invalidated: new Set(),
+        types: new Map()
+      };
+      this._stores.set(store, set);
+    }
+    return set;
+  }
+  constructor(config) {
+    this._stores = new WeakMap();
+    const _config = arguments.length === 1 ? config : arguments[1];
+    deprecate(`Passing a Store to the LifetimesService is deprecated, please pass only a config instead.`, arguments.length === 1, {
+      id: 'ember-data:request-utils:lifetimes-service-store-arg',
+      since: {
+        enabled: '5.4',
+        available: '5.4'
+      },
+      for: '@ember-data/request-utils',
+      until: '6.0'
+    });
+    assert(`You must pass a config to the LifetimesService`, _config);
+    assert(`You must pass a apiCacheSoftExpires to the LifetimesService`, typeof _config.apiCacheSoftExpires === 'number');
+    assert(`You must pass a apiCacheHardExpires to the LifetimesService`, typeof _config.apiCacheHardExpires === 'number');
+    this.config = _config;
+  }
+
+  /**
+   * Invalidate a request by its identifier for a given store instance.
+   *
+   * While the store argument may seem redundant, the lifetimes service
+   * is designed to be shared across multiple stores / forks
+   * of the store.
+   *
+   * ```ts
+   * store.lifetimes.invalidateRequest(store, identifier);
+   * ```
+   *
+   * @method invalidateRequest
+   * @public
+   * @param {StableDocumentIdentifier} identifier
+   * @param {Store} store
+   */
+  invalidateRequest(identifier, store) {
+    this._getStore(store).invalidated.add(identifier.lid);
+  }
+
+  /**
+   * Invalidate all requests associated to a specific type
+   * for a given store instance.
+   *
+   * While the store argument may seem redundant, the lifetimes service
+   * is designed to be shared across multiple stores / forks
+   * of the store.
+   *
+   * This invalidation is done automatically when using this service
+   * for both the CacheHandler and the LegacyNetworkHandler.
+   *
+   * ```ts
+   * store.lifetimes.invalidateRequestsForType(store, 'person');
+   * ```
+   *
+   * @method invalidateRequestsForType
+   * @public
+   * @param {string} type
+   * @param {Store} store
+   */
+  invalidateRequestsForType(type, store) {
+    const storeCache = this._getStore(store);
+    const set = storeCache.types.get(type);
+    if (set) {
+      set.forEach(id => {
+        storeCache.invalidated.add(id);
+      });
+    }
+  }
+
+  /**
+   * Invoked when a request has been fulfilled from the configured request handlers.
+   * This is invoked by the CacheHandler for both foreground and background requests
+   * once the cache has been updated.
+   *
+   * Note, this is invoked by the CacheHandler regardless of whether
+   * the request has a cache-key.
+   *
+   * This method should not be invoked directly by consumers.
+   *
+   * @method didRequest
+   * @public
+   * @param {ImmutableRequestInfo} request
+   * @param {ImmutableResponse} response
+   * @param {Store} store
+   * @param {StableDocumentIdentifier | null} identifier
+   * @return {void}
+   */
+  didRequest(request, response, identifier, store) {
+    // if this is a successful createRecord request, invalidate the cacheKey for the type
+    if (request.op === 'createRecord') {
+      const statusNumber = response?.status ?? 0;
+      if (statusNumber >= 200 && statusNumber < 400) {
+        const types = new Set(request.records?.map(r => r.type));
+        const additionalTypes = request.cacheOptions?.types;
+        additionalTypes?.forEach(type => {
+          types.add(type);
+        });
+        types.forEach(type => {
+          this.invalidateRequestsForType(type, store);
+        });
+      }
+
+      // add this document's cacheKey to a map for all associated types
+      // it is recommended to only use this for queries
+    } else if (identifier && request.cacheOptions?.types?.length) {
+      const storeCache = this._getStore(store);
+      request.cacheOptions?.types.forEach(type => {
+        const set = storeCache.types.get(type);
+        if (set) {
+          set.add(identifier.lid);
+          storeCache.invalidated.delete(identifier.lid);
+        } else {
+          storeCache.types.set(type, new Set([identifier.lid]));
+        }
+      });
+    }
   }
-  isHardExpired(identifier) {
-    const cached = this.store.cache.peekRequest(identifier);
+
+  /**
+   * Invoked to determine if the request may be fulfilled from cache
+   * if possible.
+   *
+   * Note, this is only invoked by the CacheHandler if the request has
+   * a cache-key.
+   *
+   * If no cache entry is found or the entry is hard expired,
+   * the request will be fulfilled from the configured request handlers
+   * and the cache will be updated before returning the response.
+   *
+   * @method isHardExpired
+   * @public
+   * @param {StableDocumentIdentifier} identifier
+   * @param {Store} store
+   * @return {boolean} true if the request is considered hard expired
+   */
+  isHardExpired(identifier, store) {
+    // if we are explicitly invalidated, we are hard expired
+    const storeCache = this._getStore(store);
+    if (storeCache.invalidated.has(identifier.lid)) {
+      return true;
+    }
+    const cache = store.cache;
+    const cached = cache.peekRequest(identifier);
     return !cached || !cached.response || isStale(cached.response.headers, this.config.apiCacheHardExpires);
   }
-  isSoftExpired(identifier) {
-    const cached = this.store.cache.peekRequest(identifier);
+
+  /**
+   * Invoked if `isHardExpired` is false to determine if the request
+   * should be update behind the scenes if cache data is already available.
+   *
+   * Note, this is only invoked by the CacheHandler if the request has
+   * a cache-key.
+   *
+   * If true, the request will be fulfilled from cache while a backgrounded
+   * request is made to update the cache via the configured request handlers.
+   *
+   * @method isSoftExpired
+   * @public
+   * @param {StableDocumentIdentifier} identifier
+   * @param {Store} store
+   * @return {boolean} true if the request is considered soft expired
+   */
+  isSoftExpired(identifier, store) {
+    const cache = store.cache;
+    const cached = cache.peekRequest(identifier);
     return !cached || !cached.response || isStale(cached.response.headers, this.config.apiCacheSoftExpires);
   }
 }