@dhis2/app-service-offline 3.9.2 → 3.9.4

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

@@ -7,6 +7,8 @@ exports.useDhis2ConnectionStatus = exports.getLastConnectedKey = exports.Dhis2Co
 
 var _appServiceConfig = require("@dhis2/app-service-config");
 
+var _lodash = require("lodash");
+
 var _propTypes = _interopRequireDefault(require("prop-types"));
 
 var _react = _interopRequireWildcard(require("react"));
@@ -160,24 +162,27 @@ const Dhis2ConnectionStatusProvider = (_ref) => {
 
     const handleBlur = () => smartInterval.pause();
 
-    const handleFocus = () => smartInterval.resume(); // On offline event, ping immediately to test server connection.
-    // Only do this when going offline -- it's theoretically no-cost
-    // for both online and offline servers. Pinging when going online
-    // can be costly for clients connecting over the internet to online
-    // servers.
+    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
+    // the connection status -- only do it once every 15 seconds at most
 
-    const handleOffline = () => smartInterval.invokeCallbackImmediately();
 
+    const handleOnline = (0, _lodash.throttle)(() => smartInterval.invokeCallbackImmediately(), 15000);
     window.addEventListener('blur', handleBlur);
     window.addEventListener('focus', handleFocus);
     window.addEventListener('offline', handleOffline);
+    window.addEventListener('online', handleOnline);
     return () => {
       window.removeEventListener('blur', handleBlur);
       window.removeEventListener('focus', handleFocus);
-      window.removeEventListener('offline', handleOffline); // clean up smart interval
+      window.removeEventListener('offline', handleOffline);
+      window.removeEventListener('online', handleOnline); // clean up smart interval and throttled function
 
       smartInterval.clear();
+      handleOnline.cancel();
     };
   }, [pingAndHandleStatus, serverVersion]);
   (0, _react.useEffect)(() => {

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

@@ -515,6 +515,30 @@ describe('it pings when an offline event is detected', () => {
     });
   });
 });
+describe('it pings when an online event is detected', () => {
+  test('if the app is focused, it pings immediately', () => {
+    (0, _reactHooks.renderHook)(() => (0, _dhis2ConnectionStatus.useDhis2ConnectionStatus)(), {
+      wrapper
+    });
+    window.dispatchEvent(new Event('offline'));
+    expect(mockPing).toHaveBeenCalledTimes(1);
+    window.dispatchEvent(new Event('online'));
+    expect(mockPing).toHaveBeenCalledTimes(2);
+  });
+  test('pings are throttled', () => {
+    (0, _reactHooks.renderHook)(() => (0, _dhis2ConnectionStatus.useDhis2ConnectionStatus)(), {
+      wrapper
+    });
+    window.dispatchEvent(new Event('offline'));
+    window.dispatchEvent(new Event('online'));
+    window.dispatchEvent(new Event('offline'));
+    expect(mockPing).toHaveBeenCalledTimes(3);
+    window.dispatchEvent(new Event('online')); // Another ping should NOT be sent immediately after this latest
+    // online event
+
+    expect(mockPing).toHaveBeenCalledTimes(3); // (Not testing throttle time here because further pings may interfere)
+  });
+});
 describe('lastConnected status', () => {
   test('it sets lastConnected in localStorage when it becomes disconnected', async () => {
     const {

package/build/cjs/lib/dhis2-connection-status/is-ping-available.js

@@ -9,7 +9,7 @@ exports.isPingAvailable = isPingAvailable;
  * Checks the server version to see if the /api/ping endpoint is available for
  * this version.
  *
- * The endpoint was released for versions 2.37.10, 2.38.3, 2.39.2, and 2.40.0
+ * The endpoint was released for versions 2.37.10, 2.38.4, 2.39.2, and 2.40.0
  * (see DHIS2-14531). All versions below that are considered unsupported
  *
  * If the patchVersion is undefined, it's assumed to be a dev server that's
@@ -32,7 +32,7 @@ function isPingAvailable(serverVersion) {
       return patch === undefined || patch >= 2;
 
     case 38:
-      return patch === undefined || patch >= 3;
+      return patch === undefined || patch >= 4;
 
     case 37:
       return patch === undefined || patch >= 10;

package/build/cjs/lib/dhis2-connection-status/is-ping-available.test.js

@@ -16,7 +16,7 @@ const fixedVersions = [{
   full: 'unimportant',
   major: 2,
   minor: 38,
-  patch: 3
+  patch: 4
 }, {
   full: 'unimportant',
   major: 2,

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

@@ -1,4 +1,5 @@
 import { useConfig } from '@dhis2/app-service-config';
+import { throttle } from 'lodash';
 import PropTypes from 'prop-types';
 import React, { useCallback, useState, useRef, useMemo, useEffect, useContext } from 'react';
 import { useOfflineInterface } from '../offline-interface';
@@ -135,24 +136,27 @@ export const Dhis2ConnectionStatusProvider = (_ref) => {
 
     const handleBlur = () => smartInterval.pause();
 
-    const handleFocus = () => smartInterval.resume(); // On offline event, ping immediately to test server connection.
-    // Only do this when going offline -- it's theoretically no-cost
-    // for both online and offline servers. Pinging when going online
-    // can be costly for clients connecting over the internet to online
-    // servers.
+    const handleFocus = () => smartInterval.resume(); // Pinging when going offline should be low/no-cost in both online and
+    // local servers
 
 
-    const handleOffline = () => smartInterval.invokeCallbackImmediately();
+    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 = throttle(() => smartInterval.invokeCallbackImmediately(), 15000);
     window.addEventListener('blur', handleBlur);
     window.addEventListener('focus', handleFocus);
     window.addEventListener('offline', handleOffline);
+    window.addEventListener('online', handleOnline);
     return () => {
       window.removeEventListener('blur', handleBlur);
       window.removeEventListener('focus', handleFocus);
-      window.removeEventListener('offline', handleOffline); // clean up smart interval
+      window.removeEventListener('offline', handleOffline);
+      window.removeEventListener('online', handleOnline); // clean up smart interval and throttled function
 
       smartInterval.clear();
+      handleOnline.cancel();
     };
   }, [pingAndHandleStatus, serverVersion]);
   useEffect(() => {

package/build/es/lib/dhis2-connection-status/dhis2-connection-status.test.js

@@ -505,6 +505,30 @@ describe('it pings when an offline event is detected', () => {
     });
   });
 });
+describe('it pings when an online event is detected', () => {
+  test('if the app is focused, it pings immediately', () => {
+    renderHook(() => useDhis2ConnectionStatus(), {
+      wrapper
+    });
+    window.dispatchEvent(new Event('offline'));
+    expect(mockPing).toHaveBeenCalledTimes(1);
+    window.dispatchEvent(new Event('online'));
+    expect(mockPing).toHaveBeenCalledTimes(2);
+  });
+  test('pings are throttled', () => {
+    renderHook(() => useDhis2ConnectionStatus(), {
+      wrapper
+    });
+    window.dispatchEvent(new Event('offline'));
+    window.dispatchEvent(new Event('online'));
+    window.dispatchEvent(new Event('offline'));
+    expect(mockPing).toHaveBeenCalledTimes(3);
+    window.dispatchEvent(new Event('online')); // Another ping should NOT be sent immediately after this latest
+    // online event
+
+    expect(mockPing).toHaveBeenCalledTimes(3); // (Not testing throttle time here because further pings may interfere)
+  });
+});
 describe('lastConnected status', () => {
   test('it sets lastConnected in localStorage when it becomes disconnected', async () => {
     const {

package/build/es/lib/dhis2-connection-status/is-ping-available.js

@@ -2,7 +2,7 @@
  * Checks the server version to see if the /api/ping endpoint is available for
  * this version.
  *
- * The endpoint was released for versions 2.37.10, 2.38.3, 2.39.2, and 2.40.0
+ * The endpoint was released for versions 2.37.10, 2.38.4, 2.39.2, and 2.40.0
  * (see DHIS2-14531). All versions below that are considered unsupported
  *
  * If the patchVersion is undefined, it's assumed to be a dev server that's
@@ -25,7 +25,7 @@ export function isPingAvailable(serverVersion) {
       return patch === undefined || patch >= 2;
 
     case 38:
-      return patch === undefined || patch >= 3;
+      return patch === undefined || patch >= 4;
 
     case 37:
       return patch === undefined || patch >= 10;

package/build/es/lib/dhis2-connection-status/is-ping-available.test.js

@@ -13,7 +13,7 @@ const fixedVersions = [{
   full: 'unimportant',
   major: 2,
   minor: 38,
-  patch: 3
+  patch: 4
 }, {
   full: 'unimportant',
   major: 2,

package/build/types/lib/dhis2-connection-status/is-ping-available.d.ts

@@ -3,7 +3,7 @@ import { Version } from '@dhis2/app-service-config';
  * Checks the server version to see if the /api/ping endpoint is available for
  * this version.
  *
- * The endpoint was released for versions 2.37.10, 2.38.3, 2.39.2, and 2.40.0
+ * The endpoint was released for versions 2.37.10, 2.38.4, 2.39.2, and 2.40.0
  * (see DHIS2-14531). All versions below that are considered unsupported
  *
  * If the patchVersion is undefined, it's assumed to be a dev server that's

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@dhis2/app-service-offline",
     "description": "A runtime service for online/offline detection and offline caching",
-    "version": "3.9.2",
+    "version": "3.9.4",
     "main": "./build/cjs/index.js",
     "module": "./build/es/index.js",
     "types": "build/types/index.d.ts",
@@ -33,7 +33,7 @@
         "coverage": "yarn test --coverage"
     },
     "peerDependencies": {
-        "@dhis2/app-service-config": "3.9.2",
+        "@dhis2/app-service-config": "3.9.4",
         "prop-types": "^15.7.2",
         "react": "^16.8.6",
         "react-dom": "^16.8.6"