cozy-bar 35.3.2 → 35.4.0

package/dist/components/PlatformBanners/useBanners.js

@@ -9,16 +9,22 @@ exports.useBanners = void 0;
 
 var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
 
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
 var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
 
 var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
 
+var _logger = _interopRequireDefault(require("../../lib/logger"));
+
 var _react = require("react");
 
 var _cozyClient = require("cozy-client");
 
 var _banner = require("cozy-client/dist/models/banner");
 
+var _useRealtime2 = _interopRequireDefault(require("cozy-realtime/dist/useRealtime"));
+
 var POLL_INTERVAL_MS = 5 * 60 * 1000;
 /**
  * The banners to display, kept up to date. cozy-client owns the reading rules;
@@ -64,8 +70,8 @@ var useBanners = function useBanners() {
           case 10:
             _context.prev = 10;
             _context.t0 = _context["catch"](3);
-            // eslint-disable-next-line no-console
-            console.warn('[cozy-bar] could not read the platform banners', _context.t0);
+
+            _logger.default.warn('could not read the platform banners', _context.t0);
 
           case 13:
           case "end":
@@ -74,6 +80,11 @@ var useBanners = function useBanners() {
       }
     }, _callee, null, [[3, 10]]);
   })), [client]);
+  (0, _useRealtime2.default)(client !== null && client !== void 0 ? client : {}, (0, _defineProperty2.default)({}, _banner.BANNERS_DOCTYPE, {
+    created: read,
+    updated: read,
+    deleted: read
+  }), [read]);
   (0, _react.useEffect)(function () {
     var readIfVisible = function readIfVisible() {
       if (document.visibilityState !== 'visible') return;
@@ -114,8 +125,9 @@ var useBanners = function useBanners() {
             case 7:
               _context2.prev = 7;
               _context2.t0 = _context2["catch"](2);
-              // eslint-disable-next-line no-console
-              console.warn('[cozy-bar] could not record the dismissal', _context2.t0);
+
+              _logger.default.warn('could not record the dismissal', _context2.t0);
+
               read();
 
             case 11:

package/dist/components/PlatformBanners/useBanners.spec.jsx

@@ -0,0 +1,87 @@
+import { render, waitFor } from '@testing-library/react'
+import React from 'react'
+
+import { useBanners } from './useBanners'
+
+jest.mock('cozy-client', () => ({ useClient: jest.fn() }))
+jest.mock('cozy-client/dist/models/banner', () => ({
+  BANNERS_DOCTYPE: 'io.cozy.banners',
+  getActiveBanners: jest.fn(),
+  dismiss: jest.fn()
+}))
+
+const { useClient } = require('cozy-client')
+const { getActiveBanners } = require('cozy-client/dist/models/banner')
+
+const Probe = () => {
+  const { banners } = useBanners()
+  return <div data-testid="count">{banners.length}</div>
+}
+
+const setup = realtime => {
+  useClient.mockReturnValue({ plugins: realtime ? { realtime } : {} })
+  return render(<Probe />)
+}
+
+describe('useBanners', () => {
+  beforeEach(() => {
+    jest.clearAllMocks()
+    getActiveBanners.mockResolvedValue([])
+  })
+
+  it('subscribes to the banner events and drops them on unmount', async () => {
+    const realtime = { subscribe: jest.fn(), unsubscribe: jest.fn() }
+    const { unmount } = setup(realtime)
+
+    await waitFor(() => expect(realtime.subscribe).toHaveBeenCalledTimes(3))
+    expect(realtime.subscribe.mock.calls.map(([event]) => event)).toEqual([
+      'created',
+      'updated',
+      'deleted'
+    ])
+    expect(realtime.subscribe).toHaveBeenCalledWith(
+      'created',
+      'io.cozy.banners',
+      expect.any(Function)
+    )
+
+    unmount()
+    expect(realtime.unsubscribe.mock.calls).toEqual(
+      realtime.subscribe.mock.calls
+    )
+  })
+
+  it('re-reads when a realtime event arrives', async () => {
+    const realtime = { subscribe: jest.fn(), unsubscribe: jest.fn() }
+    const { findByTestId, getByTestId } = setup(realtime)
+
+    await findByTestId('count')
+    expect(getActiveBanners).toHaveBeenCalledTimes(1)
+
+    getActiveBanners.mockResolvedValue([{ bannerId: 'demo' }])
+    const [, , handler] = realtime.subscribe.mock.calls[1]
+    handler()
+
+    await waitFor(() => expect(getByTestId('count')).toHaveTextContent('1'))
+  })
+
+  it('still renders without the realtime plugin', async () => {
+    const { findByTestId } = setup(null)
+    await expect(findByTestId('count')).resolves.toHaveTextContent('0')
+  })
+
+  it('renders when the realtime plugin is registered but logged out', async () => {
+    const loggedOut = () => {
+      throw new Error(
+        'Unable to use realtime while cozy-client is not logged in'
+      )
+    }
+    const { findByTestId, unmount } = setup({
+      subscribe: loggedOut,
+      unsubscribe: loggedOut
+    })
+
+    await expect(findByTestId('count')).resolves.toHaveTextContent('0')
+    expect(() => unmount()).not.toThrow()
+  })
+})

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cozy-bar",
-  "version": "35.3.2",
+  "version": "35.4.0",
   "description": "cozy-bar.js library, a small lib provided by cozy-stack to inject the Cozy-bar component into each app",
   "main": "dist/index.js",
   "author": "Cozy Cloud <contact@cozycloud.cc> (https://cozy.io/)",
@@ -75,5 +75,5 @@
     "react-router-dom": ">=6.14.2",
     "twake-i18n": ">=0.3.0"
   },
-  "gitHead": "aa6c91c03a8b734177fddb3075aa26110516c218"
+  "gitHead": "50ca3bc5c37f45ab07b1ca61fa8bcc4766d0a819"
 }