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

package/build/cjs/__tests__/integration.test.js

@@ -1,28 +1,18 @@
 "use strict";
 
 var _appServiceAlerts = require("@dhis2/app-service-alerts");
-
 var _react = require("@testing-library/react");
-
 var _react2 = _interopRequireDefault(require("react"));
-
 var _cacheableSection = require("../lib/cacheable-section");
-
 var _offlineProvider = require("../lib/offline-provider");
-
 var _renderCounter = require("../utils/render-counter");
-
 var _testMocks = require("../utils/test-mocks");
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-function _extends() { _extends = Object.assign || function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }
-
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+function _extends() { return _extends = Object.assign ? Object.assign.bind() : function (n) { for (var e = 1; e < arguments.length; e++) { var t = arguments[e]; for (var r in t) ({}).hasOwnProperty.call(t, r) && (n[r] = t[r]); } return n; }, _extends.apply(null, arguments); }
 const renderCounts = {};
-
 const identity = arg => arg;
-
-const TestControls = (_ref) => {
+const TestControls = _ref => {
+  var _lastUpdated$toISOStr;
   let {
     id,
     makeRecordingHandler = identity
@@ -49,12 +39,11 @@ const TestControls = (_ref) => {
     "data-testid": `is-cached-${id}`
   }, isCached ? 'yes' : 'no'), /*#__PURE__*/_react2.default.createElement("div", {
     "data-testid": `last-updated-${id}`
-  }, lastUpdated || 'never'), /*#__PURE__*/_react2.default.createElement("div", {
+  }, (_lastUpdated$toISOStr = lastUpdated === null || lastUpdated === void 0 ? void 0 : lastUpdated.toISOString()) !== null && _lastUpdated$toISOStr !== void 0 ? _lastUpdated$toISOStr : 'never'), /*#__PURE__*/_react2.default.createElement("div", {
     "data-testid": `recording-state-${id}`
   }, recordingState));
 };
-
-const TestSection = (_ref2) => {
+const TestSection = _ref2 => {
   let {
     id,
     children
@@ -69,7 +58,6 @@ const TestSection = (_ref2) => {
     countsObj: renderCounts
   }), children);
 };
-
 const TestSingleSection = props => {
   // Props are spread so they can be overwritten
   return /*#__PURE__*/_react2.default.createElement(_appServiceAlerts.AlertsProvider, null, /*#__PURE__*/_react2.default.createElement(_offlineProvider.OfflineProvider, _extends({
@@ -79,36 +67,34 @@ const TestSingleSection = props => {
   }, props)), /*#__PURE__*/_react2.default.createElement(TestSection, _extends({
     id: '1'
   }, props))));
-}; // Suppress 'act' warning for these tests
-
+};
 
+// Suppress 'act' warning for these tests
 const originalError = console.error;
 beforeEach(() => {
   // This is done before each because the 'recording error' test uses its own
   // spy on console.error
   jest.spyOn(console, 'error').mockImplementation(function () {
     const pattern = /Warning: An update to .* inside a test was not wrapped in act/;
-
     for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
       args[_key] = arguments[_key];
     }
-
     if (typeof args[0] === 'string' && pattern.test(args[0])) {
       return;
     }
-
     return originalError.call(console, ...args);
   });
 });
 afterEach(() => {
-  jest.clearAllMocks() // This syntax appeases typescript:
+  jest.clearAllMocks()
+  // This syntax appeases typescript:
   ;
   console.error.mockRestore();
   (0, _renderCounter.resetRenderCounts)(renderCounts);
 });
 describe('Coordination between useCacheableSection and CacheableSection', () => {
   it('renders in the default state initially', async () => {
-    (0, _react.render)( /*#__PURE__*/_react2.default.createElement(TestSingleSection, null));
+    (0, _react.render)(/*#__PURE__*/_react2.default.createElement(TestSingleSection, null));
     const {
       getByTestId
     } = _react.screen;
@@ -123,35 +109,31 @@ describe('Coordination between useCacheableSection and CacheableSection', () =>
       getByTestId,
       queryByTestId
     } = _react.screen;
-
     const onStarted = () => {
       expect(getByTestId(/recording-state/)).toHaveTextContent('recording');
       expect(getByTestId(/loading-mask/)).toBeInTheDocument();
       expect(getByTestId(/section-rc/)).toBeInTheDocument();
     };
-
     const onCompleted = () => {
       expect(getByTestId(/recording-state/)).toHaveTextContent('default');
       expect(queryByTestId(/loading-mask/)).not.toBeInTheDocument();
       done();
     };
-
     const recordingOptions = {
       onStarted,
       onCompleted
     };
-
     const makeRecordingHandler = startRecording => {
       return () => startRecording(recordingOptions);
     };
-
-    (0, _react.render)( /*#__PURE__*/_react2.default.createElement(TestSingleSection, {
+    (0, _react.render)(/*#__PURE__*/_react2.default.createElement(TestSingleSection, {
       makeRecordingHandler: makeRecordingHandler
     }));
     await (0, _react.act)(async () => {
       _react.fireEvent.click(getByTestId(/start-recording/));
-    }); // At this stage, should be pending
+    });
 
+    // At this stage, should be pending
     expect(getByTestId(/recording-state/)).toHaveTextContent('pending');
     expect(queryByTestId(/section-rc/)).not.toBeInTheDocument();
     expect.assertions(7);
@@ -161,41 +143,35 @@ describe('Coordination between useCacheableSection and CacheableSection', () =>
     jest.spyOn(console, 'error').mockImplementation(function () {
       const actPattern = /Warning: An update to .* inside a test was not wrapped in act/;
       const errPattern = /Error during recording/;
-
       for (var _len2 = arguments.length, args = new Array(_len2), _key2 = 0; _key2 < _len2; _key2++) {
         args[_key2] = arguments[_key2];
       }
-
       const matchesPattern = actPattern.test(args[0]) || errPattern.test(args[0]);
-
       if (typeof args[0] === 'string' && matchesPattern) {
         return;
       }
-
       return originalError.call(console, ...args);
     });
     const {
       getByTestId,
       queryByTestId
     } = _react.screen;
-    const testOfflineInterface = { ..._testMocks.mockOfflineInterface,
+    const testOfflineInterface = {
+      ..._testMocks.mockOfflineInterface,
       startRecording: _testMocks.errorRecordingMock
     };
-
     const onError = () => {
       expect(getByTestId(/recording-state/)).toHaveTextContent('error');
       expect(queryByTestId(/loading-mask/)).not.toBeInTheDocument();
       expect(getByTestId(/section-rc/)).toBeInTheDocument();
       done();
     };
-
     const makeRecordingHandler = startRecording => {
       return () => startRecording({
         onError
       });
     };
-
-    (0, _react.render)( /*#__PURE__*/_react2.default.createElement(TestSingleSection, {
+    (0, _react.render)(/*#__PURE__*/_react2.default.createElement(TestSingleSection, {
       offlineInterface: testOfflineInterface,
       makeRecordingHandler: makeRecordingHandler
     }));
@@ -203,33 +179,31 @@ describe('Coordination between useCacheableSection and CacheableSection', () =>
       _react.fireEvent.click(getByTestId(/start-recording/));
     });
     expect.assertions(3);
-  }); // ! After bumping testing-library versions, something about this test
-  // ! causes the following ones to mysteriously fail 😤
+  });
 
+  // ! After bumping testing-library versions, something about this test
+  // ! causes the following ones to mysteriously fail 😤
   it.skip('handles an error starting the recording', async done => {
     const {
       getByTestId
     } = _react.screen;
-    const testOfflineInterface = { ..._testMocks.mockOfflineInterface,
+    const testOfflineInterface = {
+      ..._testMocks.mockOfflineInterface,
       startRecording: _testMocks.failedMessageRecordingMock
     };
     const onStarted = jest.fn();
-
     const testErrCondition = err => {
       expect(err.message).toBe('Failed message'); // from the mock
-
       expect(onStarted).not.toHaveBeenCalled();
       expect(getByTestId(/recording-state/)).toHaveTextContent('default');
       done();
     };
-
     const makeRecordingHandler = startRecording => {
       return () => startRecording({
         onStarted
       }).catch(testErrCondition);
     };
-
-    (0, _react.render)( /*#__PURE__*/_react2.default.createElement(TestSingleSection, {
+    (0, _react.render)(/*#__PURE__*/_react2.default.createElement(TestSingleSection, {
       offlineInterface: testOfflineInterface,
       makeRecordingHandler: makeRecordingHandler
     }));
@@ -238,7 +212,6 @@ describe('Coordination between useCacheableSection and CacheableSection', () =>
     });
   });
 });
-
 const TwoTestSections = props =>
 /*#__PURE__*/
 // Props are spread so they can be overwritten (but only on one section)
@@ -252,44 +225,42 @@ _react2.default.createElement(_appServiceAlerts.AlertsProvider, null, /*#__PURE_
   id: '2'
 }), /*#__PURE__*/_react2.default.createElement(TestSection, {
   id: '2'
-}))); // test that other sections don't rerender when one section does
-
+})));
 
+// test that other sections don't rerender when one section does
 describe('Performant state management', () => {
   it('establishes a pre-recording render count', () => {
-    (0, _react.render)( /*#__PURE__*/_react2.default.createElement(TwoTestSections, null));
+    (0, _react.render)(/*#__PURE__*/_react2.default.createElement(TwoTestSections, null));
     const {
       getByTestId
-    } = _react.screen; // Two renders for controls: undefined and 'default' states
-
+    } = _react.screen;
+    // Two renders for controls: undefined and 'default' states
     expect(getByTestId('controls-rc-1')).toHaveTextContent('2');
-    expect(getByTestId('controls-rc-2')).toHaveTextContent('2'); // Just one render for sections
-
+    expect(getByTestId('controls-rc-2')).toHaveTextContent('2');
+    // Just one render for sections
     expect(getByTestId('section-rc-1')).toHaveTextContent('1');
     expect(getByTestId('section-rc-2')).toHaveTextContent('1');
   });
   it('isolates rerenders from other consumers', async done => {
     const {
       getByTestId
-    } = _react.screen; // Make assertions
-
+    } = _react.screen;
+    // Make assertions
     const onCompleted = () => {
       // Before refactor: controls components have 6 renders EACH, and
       // sections 1 and 2 have 2 and 1 renders, respectively
       // After refactor, render counts for section that recorded:
       expect(getByTestId('controls-rc-1')).toHaveTextContent('5');
-      expect(getByTestId('section-rc-1')).toHaveTextContent('2'); // Section that did not record (should be same as pre-recording):
-
+      expect(getByTestId('section-rc-1')).toHaveTextContent('2');
+      // Section that did not record (should be same as pre-recording):
       expect(getByTestId('controls-rc-2')).toHaveTextContent('2');
       expect(getByTestId('section-rc-2')).toHaveTextContent('1');
       done();
     };
-
     const makeRecordingHandler = startRecording => () => startRecording({
       onCompleted
     });
-
-    (0, _react.render)( /*#__PURE__*/_react2.default.createElement(TwoTestSections, {
+    (0, _react.render)(/*#__PURE__*/_react2.default.createElement(TwoTestSections, {
       makeRecordingHandler: makeRecordingHandler
     }));
     await (0, _react.act)(async () => {
@@ -309,44 +280,42 @@ describe('useCacheableSection can be used inside a child of CacheableSection', (
       id: '1'
     }, props)))));
   };
-
   it('handles a successful recording', async done => {
     const {
       getByTestId,
       queryByTestId
     } = _react.screen;
-
-    const onStarted = () => {
-      expect(getByTestId(/recording-state/)).toHaveTextContent('recording');
-      expect(getByTestId(/loading-mask/)).toBeInTheDocument();
-      expect(getByTestId(/section-rc/)).toBeInTheDocument();
+    const onStarted = async () => {
+      await (0, _react.waitFor)(() => {
+        expect(getByTestId(/recording-state/)).toHaveTextContent('recording');
+        expect(getByTestId(/loading-mask/)).toBeInTheDocument();
+        expect(getByTestId(/section-rc/)).toBeInTheDocument();
+      });
     };
-
     const onCompleted = () => {
       expect(getByTestId(/recording-state/)).toHaveTextContent('default');
       expect(queryByTestId(/loading-mask/)).not.toBeInTheDocument();
       done();
     };
-
     const recordingOptions = {
       onStarted,
       onCompleted
     };
-
     const makeRecordingHandler = startRecording => {
       return () => startRecording(recordingOptions);
     };
-
-    (0, _react.render)( /*#__PURE__*/_react2.default.createElement(ChildTest, {
+    (0, _react.render)(/*#__PURE__*/_react2.default.createElement(ChildTest, {
       makeRecordingHandler: makeRecordingHandler
     }));
     await (0, _react.act)(async () => {
-      _react.fireEvent.click(getByTestId(/start-recording/));
-    }); // At this stage, should be pending
-    // - In this test case, 'controls' should not be rendered
-
-    expect(queryByTestId(/recording-state/)).not.toBeInTheDocument();
-    expect(queryByTestId(/section-rc/)).not.toBeInTheDocument();
-    expect.assertions(7);
+      await _react.fireEvent.click(getByTestId(/start-recording/));
+    });
+    await (0, _react.waitFor)(() => {
+      // At this stage, should be pending
+      // - In this test case, 'controls' should not be rendered
+      expect(queryByTestId(/recording-state/)).not.toBeInTheDocument();
+      expect(queryByTestId(/section-rc/)).not.toBeInTheDocument();
+      expect.assertions(7);
+    });
   });
 });

package/build/cjs/index.js

@@ -63,17 +63,10 @@ Object.defineProperty(exports, "useSetOnlineStatusMessage", {
     return _onlineStatusMessage.useSetOnlineStatusMessage;
   }
 });
-
 var _offlineProvider = require("./lib/offline-provider");
-
 var _cacheableSection = require("./lib/cacheable-section");
-
 var _cacheableSectionState = require("./lib/cacheable-section-state");
-
 var _networkStatus = require("./lib/network-status");
-
 var _onlineStatusMessage = require("./lib/online-status-message");
-
 var _clearSensitiveCaches = require("./lib/clear-sensitive-caches");
-
 var _dhis2ConnectionStatus = require("./lib/dhis2-connection-status");

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

@@ -1,31 +1,24 @@
 "use strict";
 
-var _reactHooks = require("@testing-library/react-hooks");
-
-var _react = _interopRequireDefault(require("react"));
-
+var _react = require("@testing-library/react");
+var _react2 = _interopRequireDefault(require("react"));
 var _testMocks = require("../../utils/test-mocks");
-
 var _cacheableSectionState = require("../cacheable-section-state");
-
 var _offlineProvider = require("../offline-provider");
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-const wrapper = (_ref) => {
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+const wrapper = _ref => {
   let {
     children
   } = _ref;
-  return /*#__PURE__*/_react.default.createElement(_offlineProvider.OfflineProvider, {
+  return /*#__PURE__*/_react2.default.createElement(_offlineProvider.OfflineProvider, {
     offlineInterface: _testMocks.mockOfflineInterface
   }, children);
 };
-
 test('useRecordingState has stable references', () => {
   const {
     result,
     rerender
-  } = (0, _reactHooks.renderHook)(() => (0, _cacheableSectionState.useRecordingState)('one'), {
+  } = (0, _react.renderHook)(() => (0, _cacheableSectionState.useRecordingState)('one'), {
     wrapper
   });
   const origRecordingState = result.current.recordingState;
@@ -40,7 +33,7 @@ test('useCachedSection has stable references', () => {
   const {
     result,
     rerender
-  } = (0, _reactHooks.renderHook)(() => (0, _cacheableSectionState.useCachedSection)('one'), {
+  } = (0, _react.renderHook)(() => (0, _cacheableSectionState.useCachedSection)('one'), {
     wrapper
   });
   const origIsCached = result.current.isCached;

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

@@ -1,21 +1,16 @@
 "use strict";
 
 var _FDBFactory = _interopRequireDefault(require("fake-indexeddb/lib/FDBFactory"));
-
 var _idb = require("idb");
-
 require("fake-indexeddb/auto");
-
 var _clearSensitiveCaches = require("../clear-sensitive-caches");
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 // Mocks for CacheStorage API
+
 // Returns true if an existing cache is deleted
 const makeCachesDeleteMock = keys => {
   return jest.fn().mockImplementation(key => Promise.resolve(keys.includes(key)));
 };
-
 const keysMockDefault = jest.fn().mockImplementation(async () => []);
 const deleteMockDefault = makeCachesDeleteMock([]);
 const cachesDefault = {
@@ -30,21 +25,19 @@ window.caches = cachesDefault;
 afterEach(() => {
   window.caches = cachesDefault;
   jest.clearAllMocks();
-}); // silence debug logs for these tests
+});
 
+// silence debug logs for these tests
 const originalDebug = console.debug;
 beforeAll(() => {
   jest.spyOn(console, 'debug').mockImplementation(function () {
     const pattern = /Clearing sensitive caches/;
-
     for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
       args[_key] = arguments[_key];
     }
-
     if (typeof args[0] === 'string' && pattern.test(args[0])) {
       return;
     }
-
     return originalDebug.call(console, ...args);
   });
 });
@@ -59,7 +52,8 @@ it('returns false if caches.keys throws', async () => {
   const spy = jest.fn(() => {
     throw new Error('Security Error');
   });
-  window.caches = { ...cachesDefault,
+  window.caches = {
+    ...cachesDefault,
     keys: spy
   };
   const result = await (0, _clearSensitiveCaches.clearSensitiveCaches)();
@@ -70,7 +64,8 @@ it('clears potentially sensitive caches', async () => {
   const testKeys = ['cache1', 'cache2', 'app-shell', 'other-assets'];
   const keysMock = jest.fn().mockImplementation(() => Promise.resolve(testKeys));
   const deleteMock = makeCachesDeleteMock(testKeys);
-  window.caches = { ...cachesDefault,
+  window.caches = {
+    ...cachesDefault,
     keys: keysMock,
     delete: deleteMock
   };
@@ -84,7 +79,8 @@ it('clears potentially sensitive caches', async () => {
 });
 it('preserves keepable caches', async () => {
   const keysMock = jest.fn().mockImplementation(async () => ['cache1', 'cache2', 'app-shell', 'other-assets', 'workbox-precache-v2-https://hey.howareya.now/']);
-  window.caches = { ...cachesDefault,
+  window.caches = {
+    ...cachesDefault,
     keys: keysMock
   };
   await (0, _clearSensitiveCaches.clearSensitiveCaches)();
@@ -105,10 +101,8 @@ describe('clears sections-db', () => {
           keyPath: 'sectionId'
         });
       }
-
     });
   }
-
   afterEach(() => {
     // reset indexedDB state
     window.indexedDB = new _FDBFactory.default();
@@ -126,8 +120,9 @@ describe('clears sections-db', () => {
       lastUpdated: new Date(),
       requests: 3
     });
-    await (0, _clearSensitiveCaches.clearSensitiveCaches)(); // Sections-db should be cleared
+    await (0, _clearSensitiveCaches.clearSensitiveCaches)();
 
+    // Sections-db should be cleared
     const allSections = await db.getAll(_clearSensitiveCaches.SECTIONS_STORE);
     expect(allSections).toHaveLength(0);
   });
@@ -144,16 +139,18 @@ describe('clears sections-db', () => {
     // if 'databases' property exists
     await openTestDB(_clearSensitiveCaches.SECTIONS_DB);
     const openMock = jest.fn();
-    window.indexedDB.open = openMock; // Remove 'databases' from indexedDB prototype for this test
-    // (simulates Firefox environment)
+    window.indexedDB.open = openMock;
 
+    // Remove 'databases' from indexedDB prototype for this test
+    // (simulates Firefox environment)
     const idbProto = Object.getPrototypeOf(window.indexedDB);
     const databases = idbProto.databases;
     delete idbProto.databases;
     expect('databases' in window.indexedDB).toBe(false);
     await expect((0, _clearSensitiveCaches.clearSensitiveCaches)()).resolves.toBeDefined();
-    expect(openMock).not.toHaveBeenCalled(); // Restore indexedDB prototype for later tests
+    expect(openMock).not.toHaveBeenCalled();
 
+    // Restore indexedDB prototype for later tests
     idbProto.databases = databases;
     expect('databases' in window.indexedDB).toBe(true);
   });