@dhis2/app-service-offline 3.11.3 → 3.12.0-alpha.1

package/build/cjs/lib/cacheable-section-state.js

@@ -8,20 +8,15 @@ exports.createCacheableSectionStore = createCacheableSectionStore;
 exports.useCachedSection = useCachedSection;
 exports.useCachedSections = useCachedSections;
 exports.useRecordingState = useRecordingState;
-
 var _propTypes = _interopRequireDefault(require("prop-types"));
-
 var _react = _interopRequireWildcard(require("react"));
-
 var _globalStateService = require("./global-state-service");
-
 var _offlineInterface = require("./offline-interface");
-
-function _getRequireWildcardCache() { if (typeof WeakMap !== "function") return null; var cache = new WeakMap(); _getRequireWildcardCache = function () { return cache; }; return cache; }
-
-function _interopRequireWildcard(obj) { if (obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
+function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+// Functions in here use the global state service to manage cacheable section
+// state in a performant way
 
 /**
  * Helper that transforms an array of cached section objects from the IndexedDB
@@ -36,19 +31,19 @@ function getSectionsById(sectionsArray) {
       sectionId,
       lastUpdated
     } = _ref;
-    return { ...result,
+    return {
+      ...result,
       [sectionId]: {
         lastUpdated
       }
     };
   }, {});
 }
+
 /**
  * Create a store for Cacheable Section state.
  * Expected to be used in app adapter
  */
-
-
 function createCacheableSectionStore() {
   const initialState = {
     recordingStates: {},
@@ -56,41 +51,39 @@ function createCacheableSectionStore() {
   };
   return (0, _globalStateService.createStore)(initialState);
 }
+
 /**
  * Helper hook that returns a value that will persist between renders but makes
  * sure to only set its initial state once.
  * See https://gist.github.com/amcgee/42bb2fa6d5f79e607f00e6dccc733482
  */
-
-
 function useConst(factory) {
   const ref = _react.default.useRef(null);
-
   if (ref.current === null) {
     ref.current = factory();
   }
-
   return ref.current;
 }
+
 /**
  * Provides context for a global state context which will track cached
  * sections' status and cacheable sections' recording states, which will
  * determine how that component will render. The provider will be a part of
  * the OfflineProvider.
  */
-
-
 function CacheableSectionProvider(_ref2) {
   let {
     children
   } = _ref2;
   const offlineInterface = (0, _offlineInterface.useOfflineInterface)();
-  const store = useConst(createCacheableSectionStore); // On load, get sections and add to store
+  const store = useConst(createCacheableSectionStore);
 
+  // On load, get sections and add to store
   (0, _react.useEffect)(() => {
     if (offlineInterface) {
       offlineInterface.getCachedSections().then(sections => {
-        store.mutate(state => ({ ...state,
+        store.mutate(state => ({
+          ...state,
           cachedSections: getSectionsById(sections)
         }));
       });
@@ -100,11 +93,9 @@ function CacheableSectionProvider(_ref2) {
     store: store
   }, children);
 }
-
 CacheableSectionProvider.propTypes = {
   children: _propTypes.default.node
 };
-
 /**
  * Uses an optimized global state to manage 'recording state' values without
  * unnecessarily rerendering all consuming components
@@ -115,17 +106,21 @@ CacheableSectionProvider.propTypes = {
 function useRecordingState(id) {
   const recordingStateSelector = (0, _react.useCallback)(state => state.recordingStates[id], [id]);
   const [recordingState] = (0, _globalStateService.useGlobalState)(recordingStateSelector);
-  const setRecordingStateMutationCreator = (0, _react.useCallback)(newState => state => ({ ...state,
-    recordingStates: { ...state.recordingStates,
+  const setRecordingStateMutationCreator = (0, _react.useCallback)(newState => state => ({
+    ...state,
+    recordingStates: {
+      ...state.recordingStates,
       [id]: newState
     }
   }), [id]);
   const setRecordingState = (0, _globalStateService.useGlobalStateMutation)(setRecordingStateMutationCreator);
   const removeRecordingStateMutationCreator = (0, _react.useCallback)(() => state => {
-    const recordingStates = { ...state.recordingStates
+    const recordingStates = {
+      ...state.recordingStates
     };
     delete recordingStates[id];
-    return { ...state,
+    return {
+      ...state,
       recordingStates
     };
   }, [id]);
@@ -136,17 +131,17 @@ function useRecordingState(id) {
     removeRecordingState
   }), [recordingState, setRecordingState, removeRecordingState]);
 }
+
 /**
  * Returns a function that syncs cached sections in the global state
  * with IndexedDB, so that IndexedDB is the single source of truth
  *
  * @returns {Function} syncCachedSections
  */
-
-
 function useSyncCachedSections() {
   const offlineInterface = (0, _offlineInterface.useOfflineInterface)();
-  const setCachedSectionsMutationCreator = (0, _react.useCallback)(cachedSections => state => ({ ...state,
+  const setCachedSectionsMutationCreator = (0, _react.useCallback)(cachedSections => state => ({
+    ...state,
     cachedSections
   }), []);
   const setCachedSections = (0, _globalStateService.useGlobalStateMutation)(setCachedSectionsMutationCreator);
@@ -155,7 +150,6 @@ function useSyncCachedSections() {
     setCachedSections(getSectionsById(sections));
   }, [offlineInterface, setCachedSections]);
 }
-
 /**
  * Uses global state to manage an object of cached sections' statuses
  *
@@ -165,6 +159,7 @@ function useCachedSections() {
   const [cachedSections] = (0, _globalStateService.useGlobalState)(state => state.cachedSections);
   const syncCachedSections = useSyncCachedSections();
   const offlineInterface = (0, _offlineInterface.useOfflineInterface)();
+
   /**
    * Uses offline interface to remove a section from IndexedDB and Cache
    * Storage.
@@ -172,14 +167,11 @@ function useCachedSections() {
    * Returns a promise that resolves to `true` if a section is found and
    * deleted, or `false` if asection with the specified ID does not exist.
    */
-
   const removeById = (0, _react.useCallback)(async id => {
     const success = await offlineInterface.removeSection(id);
-
     if (success) {
       await syncCachedSections();
     }
-
     return success;
   }, [offlineInterface, syncCachedSections]);
   return (0, _react.useMemo)(() => ({
@@ -188,7 +180,6 @@ function useCachedSections() {
     syncCachedSections
   }), [cachedSections, removeById, syncCachedSections]);
 }
-
 /**
  * Uses global state to manage the cached status of just one section, which
  * prevents unnecessary rerenders of consuming components
@@ -201,6 +192,7 @@ function useCachedSection(id) {
   const syncCachedSections = useSyncCachedSections();
   const offlineInterface = (0, _offlineInterface.useOfflineInterface)();
   const lastUpdated = status && status.lastUpdated;
+
   /**
    * Uses offline interface to remove a section from IndexedDB and Cache
    * Storage.
@@ -208,14 +200,11 @@ function useCachedSection(id) {
    * Returns `true` if a section is found and deleted, or `false` if a
    * section with the specified ID does not exist.
    */
-
   const remove = (0, _react.useCallback)(async () => {
     const success = await offlineInterface.removeSection(id);
-
     if (success) {
       await syncCachedSections();
     }
-
     return success;
   }, [offlineInterface, id, syncCachedSections]);
   return (0, _react.useMemo)(() => ({

package/build/cjs/lib/cacheable-section.js

@@ -5,28 +5,20 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.CacheableSection = CacheableSection;
 exports.useCacheableSection = useCacheableSection;
-
 var _propTypes = _interopRequireDefault(require("prop-types"));
-
 var _react = _interopRequireWildcard(require("react"));
-
+var _reactDom = require("react-dom");
 var _cacheableSectionState = require("./cacheable-section-state");
-
 var _offlineInterface = require("./offline-interface");
-
-function _getRequireWildcardCache() { if (typeof WeakMap !== "function") return null; var cache = new WeakMap(); _getRequireWildcardCache = function () { return cache; }; return cache; }
-
-function _interopRequireWildcard(obj) { if (obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
+function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
+function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 const recordingStates = {
   default: 'default',
   pending: 'pending',
   recording: 'recording',
   error: 'error'
 };
-
 /**
  * Returns the main controls for a cacheable section and manages recording
  * state, which affects the render state of the CacheableSection component.
@@ -53,9 +45,8 @@ function useCacheableSection(id) {
     // On mount, add recording state for this ID to context if needed
     if (!recordingState) {
       setRecordingState(recordingStates.default);
-    } // On unnmount, remove recording state if not recording
-
-
+    }
+    // On unnmount, remove recording state if not recording
     return () => {
       if (recordingState && recordingState !== recordingStates.recording && recordingState !== recordingStates.pending) {
         removeRecordingState();
@@ -88,21 +79,30 @@ function useCacheableSection(id) {
       sectionId: id,
       recordingTimeoutDelay,
       onStarted: () => {
-        onRecordingStarted();
+        // Flush this state update synchronously so that the
+        // right recordingState is set before any other callbacks
+        (0, _reactDom.flushSync)(() => {
+          onRecordingStarted();
+        });
         onStarted && onStarted();
       },
       onCompleted: () => {
-        onRecordingCompleted();
+        (0, _reactDom.flushSync)(() => {
+          onRecordingCompleted();
+        });
         onCompleted && onCompleted();
       },
       onError: error => {
-        onRecordingError(error);
+        (0, _reactDom.flushSync)(() => {
+          onRecordingError(error);
+        });
         onError && onError(error);
       }
     }).then(() => setRecordingState(recordingStates.pending));
-  }, [id, offlineInterface, onRecordingCompleted, onRecordingError, onRecordingStarted, setRecordingState]); // isCached, lastUpdated, remove: _could_ be accessed by useCachedSection,
-  // but provided through this hook for convenience
+  }, [id, offlineInterface, onRecordingCompleted, onRecordingError, onRecordingStarted, setRecordingState]);
 
+  // isCached, lastUpdated, remove: _could_ be accessed by useCachedSection,
+  // but provided through this hook for convenience
   return (0, _react.useMemo)(() => ({
     recordingState,
     startRecording,
@@ -111,7 +111,6 @@ function useCacheableSection(id) {
     remove
   }), [recordingState, startRecording, lastUpdated, isCached, remove]);
 }
-
 /**
  * Used to wrap the relevant component to be recorded and saved offline.
  * Depending on the recording state of the section, this wrapper will
@@ -132,21 +131,21 @@ function CacheableSection(_ref) {
   // Accesses recording state that useCacheableSection controls
   const {
     recordingState
-  } = (0, _cacheableSectionState.useRecordingState)(id); // The following causes the component to reload in the event of a recording
+  } = (0, _cacheableSectionState.useRecordingState)(id);
+
+  // The following causes the component to reload in the event of a recording
   // error; the state will be cleared next time recording moves to pending.
   // It fixes a component getting stuck while rendered without data after
   // failing a recording while offline.
   // Errors can be handled in the `onError` callback to `startRecording`.
-
   if (recordingState === recordingStates.error) {
     return /*#__PURE__*/_react.default.createElement(_react.default.Fragment, null, children);
-  } // Handling rendering with the following conditions prevents an unncessary
-  // rerender after successful recording
-
+  }
 
+  // Handling rendering with the following conditions prevents an unncessary
+  // rerender after successful recording
   return /*#__PURE__*/_react.default.createElement(_react.default.Fragment, null, recordingState === recordingStates.recording && loadingMask, recordingState !== recordingStates.pending && children);
 }
-
 CacheableSection.propTypes = {
   id: _propTypes.default.string.isRequired,
   children: _propTypes.default.node,

package/build/cjs/lib/clear-sensitive-caches.js

@@ -6,14 +6,12 @@ Object.defineProperty(exports, "__esModule", {
 exports.SECTIONS_STORE = exports.SECTIONS_DB = void 0;
 exports.clearSensitiveCaches = clearSensitiveCaches;
 // IndexedDB names; should be the same as in @dhis2/pwa
-const SECTIONS_DB = 'sections-db';
-exports.SECTIONS_DB = SECTIONS_DB;
-const SECTIONS_STORE = 'sections-store'; // Non-sensitive caches that can be kept:
+const SECTIONS_DB = exports.SECTIONS_DB = 'sections-db';
+const SECTIONS_STORE = exports.SECTIONS_STORE = 'sections-store';
 
-exports.SECTIONS_STORE = SECTIONS_STORE;
+// Non-sensitive caches that can be kept:
 const KEEPABLE_CACHES = [/^workbox-precache/ // precached static assets
 ];
-
 /*
  * Clears the 'sections-db' IndexedDB if it exists. Designed to avoid opening
  * a new DB if it doesn't exist yet. Firefox can't check if 'sections-db'
@@ -28,10 +26,8 @@ const clearDB = async dbName => {
     // and offline interface will handle discrepancies in PWA apps.
     return;
   }
-
   const dbs = await window.indexedDB.databases();
-
-  if (!dbs.some((_ref) => {
+  if (!dbs.some(_ref => {
     let {
       name
     } = _ref;
@@ -40,57 +36,51 @@ const clearDB = async dbName => {
     // Sections-db is not created; nothing to do here
     return;
   }
-
   return new Promise((resolve, reject) => {
     // IndexedDB fun:
     const openDBRequest = indexedDB.open(dbName);
-
     openDBRequest.onsuccess = e => {
       const db = e.target.result;
-      const tx = db.transaction(SECTIONS_STORE, 'readwrite'); // When the transaction completes is when the operation is done:
-
+      const tx = db.transaction(SECTIONS_STORE, 'readwrite');
+      // When the transaction completes is when the operation is done:
       tx.oncomplete = () => resolve();
-
       tx.onerror = e => reject(e.target.error);
-
       const os = tx.objectStore(SECTIONS_STORE);
       const clearReq = os.clear();
-
       clearReq.onerror = e => reject(e.target.error);
     };
-
     openDBRequest.onerror = e => {
       reject(e.target.error);
     };
   });
 };
+
 /**
  * Used to clear caches and 'sections-db' IndexedDB when a user logs out or a
  * different user logs in to prevent someone from accessing a different user's
  * caches. Should be able to be used in a non-PWA app.
  */
-
-
 async function clearSensitiveCaches() {
   let dbName = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : SECTIONS_DB;
   console.debug('Clearing sensitive caches');
-  let cacheKeys; // caches.keys can fail in insecure contexts, see:
-  // https://developer.mozilla.org/en-US/docs/Web/API/CacheStorage
+  let cacheKeys;
 
+  // caches.keys can fail in insecure contexts, see:
+  // https://developer.mozilla.org/en-US/docs/Web/API/CacheStorage
   try {
     cacheKeys = await caches.keys();
   } catch (e) {
     // Return false since no caches have been cleared
     return false;
   }
-
-  return Promise.all([// (Resolves to 'false' because this can't detect if anything was deleted):
-  clearDB(dbName).then(() => false), // Remove caches if not in keepable list
+  return Promise.all([
+  // (Resolves to 'false' because this can't detect if anything was deleted):
+  clearDB(dbName).then(() => false),
+  // Remove caches if not in keepable list
   ...cacheKeys.map(key => {
     if (!KEEPABLE_CACHES.some(pattern => pattern.test(key))) {
       return caches.delete(key);
     }
-
     return false;
   })]).then(responses => {
     // Return true if any caches have been cleared

package/build/cjs/lib/dhis2-connection-status/dev-debug-log.js

@@ -5,10 +5,10 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.devDebugLog = devDebugLog;
 const shouldLog = localStorage.getItem('dhis2.debugConnectionStatus');
-
 if (shouldLog) {
   console.log('Logging for dhis2ConnectionStatus is enabled. Remove the `dhis2.debugConnectionStatus` item in localStorage to disable logging.');
 }
+
 /**
  * This can be used to log info if the `dhis2.debugConnectionStatus` value
  * in localStorage is set to a truthy value during development.
@@ -17,8 +17,6 @@ if (shouldLog) {
  * The behavior of the connection status can be quite hard to inspect without
  * logs, but the logs are quite chatty and should be omitted normally.
  */
-
-
 function devDebugLog() {
   if (shouldLog) {
     console.log(...arguments);