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

package/build/cjs/lib/dhis2-connection-status/dhis2-connection-status.js

@@ -4,59 +4,41 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.useDhis2ConnectionStatus = exports.getLastConnectedKey = exports.Dhis2ConnectionStatusProvider = void 0;
-
 var _appServiceConfig = require("@dhis2/app-service-config");
-
 var _lodash = require("lodash");
-
 var _propTypes = _interopRequireDefault(require("prop-types"));
-
 var _react = _interopRequireWildcard(require("react"));
-
 var _offlineInterface = require("../offline-interface");
-
 var _devDebugLog = require("./dev-debug-log");
-
 var _isPingAvailable = require("./is-ping-available");
-
 var _smartInterval = _interopRequireDefault(require("./smart-interval"));
-
 var _usePingQuery = require("./use-ping-query");
-
-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 }; }
 // Utils for saving 'last connected' datetime in local storage
 const lastConnectedKey = 'dhis2.lastConnected';
-
 const getLastConnectedKey = appName => appName ? `${lastConnectedKey}.${appName}` : lastConnectedKey;
-
 exports.getLastConnectedKey = getLastConnectedKey;
-
 const updateLastConnected = appName => {
   // use Date.now() because it's easier to mock for easier unit testing
   const now = new Date(Date.now());
   localStorage.setItem(getLastConnectedKey(appName), now.toUTCString());
   return now;
 };
-
 const getLastConnected = appName => {
   const lastConnected = localStorage.getItem(getLastConnectedKey(appName));
   return lastConnected ? new Date(lastConnected) : null;
 };
-
 const clearLastConnected = appName => {
   localStorage.removeItem(getLastConnectedKey(appName));
 };
-
 const Dhis2ConnectionStatusContext = /*#__PURE__*/_react.default.createContext({
   isConnected: true,
   isDisconnected: false,
   lastConnected: null
 });
+
 /**
  * Provides a boolean indicating client's connection to the DHIS2 server,
  * which is different from connection to the internet.
@@ -66,9 +48,7 @@ const Dhis2ConnectionStatusContext = /*#__PURE__*/_react.default.createContext({
  * and then will initiate periodic pings if there are no incidental requests in
  * order to check the connection consistently
  */
-
-
-const Dhis2ConnectionStatusProvider = (_ref) => {
+const Dhis2ConnectionStatusProvider = _ref => {
   let {
     children
   } = _ref;
@@ -76,21 +56,21 @@ const Dhis2ConnectionStatusProvider = (_ref) => {
   const {
     appName,
     serverVersion
-  } = (0, _appServiceConfig.useConfig)(); // The offline interface persists the latest update from the SW so that
+  } = (0, _appServiceConfig.useConfig)();
+  // The offline interface persists the latest update from the SW so that
   // this hook can initialize to an accurate value. The App Adapter in the
   // platform waits for this value to be populated before rendering the
   // the App Runtime provider (including this), but if that is not done,
   // `latestIsConnected` may be `null` depending on the outcome of race
   // conditions between the SW and the React component tree.
-
   const [isConnected, setIsConnected] = (0, _react.useState)(offlineInterface.latestIsConnected);
   const ping = (0, _usePingQuery.usePingQuery)();
   const smartIntervalRef = (0, _react.useRef)(null);
+
   /**
    * Update state, reset ping backoff if changed, and update
    * the lastConnected value in localStorage
    */
-
   const updateConnectedState = (0, _react.useCallback)(newIsConnected => {
     // use 'set' with a function as param to get latest isConnected
     // without needing it as a dependency for useCallback
@@ -99,13 +79,10 @@ const Dhis2ConnectionStatusProvider = (_ref) => {
         prevIsConnected,
         newIsConnected
       });
-
       if (newIsConnected !== prevIsConnected) {
         var _smartIntervalRef$cur;
-
         // if value changed, reset ping interval to initial delay
         (_smartIntervalRef$cur = smartIntervalRef.current) === null || _smartIntervalRef$cur === void 0 ? void 0 : _smartIntervalRef$cur.reset();
-
         if (newIsConnected) {
           // Need to clear this here so it doesn't affect another
           // session that starts while offline
@@ -114,15 +91,15 @@ const Dhis2ConnectionStatusProvider = (_ref) => {
           updateLastConnected(appName);
         }
       }
-
       return newIsConnected;
     });
-  }, [appName]); // Note that the SW is configured to not cache ping requests and won't
+  }, [appName]);
+
+  // Note that the SW is configured to not cache ping requests and won't
   // trigger `handleChange` below to avoid redundant signals. This also
   // helps to detect the connectivity status when the SW is not available
   // for some reason (maybe private browsing, first installation, or
   // insecure browser context)
-
   const pingAndHandleStatus = (0, _react.useCallback)(() => {
     return ping().then(() => {
       // Ping is successful; set 'connected'
@@ -132,16 +109,16 @@ const Dhis2ConnectionStatusProvider = (_ref) => {
       updateConnectedState(false);
     });
   }, [ping, updateConnectedState]);
-  /** Called when SW reports updates from incidental network traffic */
 
-  const onUpdate = (0, _react.useCallback)((_ref2) => {
+  /** Called when SW reports updates from incidental network traffic */
+  const onUpdate = (0, _react.useCallback)(_ref2 => {
     var _smartIntervalRef$cur2;
-
     let {
       isConnected: newIsConnected
     } = _ref2;
-    (0, _devDebugLog.devDebugLog)('[D2CS] handling update from sw'); // Snooze ping timer to reduce pings since we know state from SW
+    (0, _devDebugLog.devDebugLog)('[D2CS] handling update from sw');
 
+    // Snooze ping timer to reduce pings since we know state from SW
     (_smartIntervalRef$cur2 = smartIntervalRef.current) === null || _smartIntervalRef$cur2 === void 0 ? void 0 : _smartIntervalRef$cur2.snooze();
     updateConnectedState(newIsConnected);
   }, [updateConnectedState]);
@@ -150,26 +127,22 @@ const Dhis2ConnectionStatusProvider = (_ref) => {
     // pinging with the smart interval. Just use the service worker
     if (!serverVersion || !(0, _isPingAvailable.isPingAvailable)(serverVersion)) {
       return;
-    } // Only create the smart interval once
-
+    }
 
+    // Only create the smart interval once
     const smartInterval = (0, _smartInterval.default)({
       // don't ping if window isn't focused or visible
       initialPauseValue: !document.hasFocus() || document.visibilityState !== 'visible',
       callback: pingAndHandleStatus
     });
     smartIntervalRef.current = smartInterval;
-
     const handleBlur = () => smartInterval.pause();
-
-    const handleFocus = () => smartInterval.resume(); // Pinging when going offline should be low/no-cost in both online and
+    const handleFocus = () => smartInterval.resume();
+    // Pinging when going offline should be low/no-cost in both online and
     // local servers
-
-
-    const handleOffline = () => smartInterval.invokeCallbackImmediately(); // Pinging when going online has a cost but improves responsiveness of
+    const handleOffline = () => smartInterval.invokeCallbackImmediately();
+    // Pinging when going online has a cost but improves responsiveness of
     // the connection status -- only do it once every 15 seconds at most
-
-
     const handleOnline = (0, _lodash.throttle)(() => smartInterval.invokeCallbackImmediately(), 15000);
     window.addEventListener('blur', handleBlur);
     window.addEventListener('focus', handleFocus);
@@ -179,8 +152,9 @@ const Dhis2ConnectionStatusProvider = (_ref) => {
       window.removeEventListener('blur', handleBlur);
       window.removeEventListener('focus', handleFocus);
       window.removeEventListener('offline', handleOffline);
-      window.removeEventListener('online', handleOnline); // clean up smart interval and throttled function
+      window.removeEventListener('online', handleOnline);
 
+      // clean up smart interval and throttled function
       smartInterval.clear();
       handleOnline.cancel();
     };
@@ -188,22 +162,21 @@ const Dhis2ConnectionStatusProvider = (_ref) => {
   (0, _react.useEffect)(() => {
     if (!offlineInterface.subscribeToDhis2ConnectionStatus) {
       var _smartIntervalRef$cur3;
-
       // Missing this functionality from the offline interface --
       // use a ping on startup to get the status
       (_smartIntervalRef$cur3 = smartIntervalRef.current) === null || _smartIntervalRef$cur3 === void 0 ? void 0 : _smartIntervalRef$cur3.invokeCallbackImmediately();
       console.warn('Please upgrade to @dhis2/cli-app-scripts@>10.3.8 for full connection status features');
       return;
     }
-
     const unsubscribe = offlineInterface.subscribeToDhis2ConnectionStatus({
       onUpdate
     });
     return () => {
       unsubscribe();
     };
-  }, [offlineInterface, onUpdate]); // Memoize this value to prevent unnecessary rerenders of context provider
+  }, [offlineInterface, onUpdate]);
 
+  // Memoize this value to prevent unnecessary rerenders of context provider
   const contextValue = (0, _react.useMemo)(() => {
     // in the unlikely circumstance that offlineInterface.latestIsConnected
     // is `null` or `undefined` when this initializes, fail safe by defaulting to
@@ -212,7 +185,8 @@ const Dhis2ConnectionStatusProvider = (_ref) => {
     return {
       isConnected: validatedIsConnected,
       isDisconnected: !validatedIsConnected,
-      lastConnected: validatedIsConnected ? null : // Only evaluate if disconnected, since local storage
+      lastConnected: validatedIsConnected ? null :
+      // Only evaluate if disconnected, since local storage
       // is synchronous and disk-based.
       // If lastConnected is not set in localStorage though, set it.
       // (relevant on startup)
@@ -223,20 +197,15 @@ const Dhis2ConnectionStatusProvider = (_ref) => {
     value: contextValue
   }, children);
 };
-
 exports.Dhis2ConnectionStatusProvider = Dhis2ConnectionStatusProvider;
 Dhis2ConnectionStatusProvider.propTypes = {
   children: _propTypes.default.node
 };
-
 const useDhis2ConnectionStatus = () => {
   const context = (0, _react.useContext)(Dhis2ConnectionStatusContext);
-
   if (!context) {
     throw new Error('useDhis2ConnectionStatus must be used within a Dhis2ConnectionStatus provider');
   }
-
   return context;
 };
-
 exports.useDhis2ConnectionStatus = useDhis2ConnectionStatus;