cozy-search 2.3.3 → 2.5.0

package/dist/components/KnowledgeBase/ragIndexing.js

@@ -5,7 +5,7 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.setupRagIndexing = exports.migrateAssistantsWithoutFolder = exports.makeRagIndexTriggerAttributes = exports.findRagIndexTriggers = exports.RAG_INDEX_WORKER = exports.RAG_INDEX_FILES_DEBOUNCE = void 0;
+exports.setupRagIndexing = exports.migrateAssistantsWithoutFolder = exports.makeRagIndexTriggerAttributes = exports.findRagIndexTriggers = exports.fetchAssistants = exports.createRagIndexTriggers = exports.RAG_INDEX_WORKER = exports.RAG_INDEX_FILES_DEBOUNCE = void 0;
 
 var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
 
@@ -154,39 +154,61 @@ var findRagIndexTriggers = /*#__PURE__*/function () {
     return _ref.apply(this, arguments);
   };
 }();
+
+exports.findRagIndexTriggers = findRagIndexTriggers;
+
+var fetchAssistants = function fetchAssistants(client) {
+  var _buildAllAssistantsQu = (0, _queries.buildAllAssistantsQuery)(),
+      definition = _buildAllAssistantsQu.definition,
+      options = _buildAllAssistantsQu.options;
+
+  return client.queryAll(definition(), options);
+};
 /**
  * Gives the root folder to every assistant without a knowledge base
  * folder (the rule is permanent: an assistant always has one). A conflict
  * on one assistant means another session did it: skipped.
+ * @param {import('cozy-client').CozyClient} client - The cozy client.
+ * @param {Array<object>} [assistants] - The assistants, when already fetched.
  * @returns {Promise<string[]>} The ids of the migrated assistants.
  */
 
 
-exports.findRagIndexTriggers = findRagIndexTriggers;
+exports.fetchAssistants = fetchAssistants;
 
 var migrateAssistantsWithoutFolder = /*#__PURE__*/function () {
-  var _ref2 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(client) {
-    var migrated, _buildAllAssistantsQu, definition, options, assistants, _iterator2, _step2, assistant, knowledgeBase;
+  var _ref2 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(client, assistants) {
+    var migrated, _iterator2, _step2, assistant, knowledgeBase;
 
     return _regenerator.default.wrap(function _callee2$(_context2) {
       while (1) {
         switch (_context2.prev = _context2.next) {
           case 0:
             migrated = [];
-            _buildAllAssistantsQu = (0, _queries.buildAllAssistantsQuery)(), definition = _buildAllAssistantsQu.definition, options = _buildAllAssistantsQu.options;
-            _context2.next = 4;
-            return client.queryAll(definition(), options);
+            _context2.t0 = _createForOfIteratorHelper;
+            _context2.t1 = assistants;
 
-          case 4:
-            assistants = _context2.sent;
-            _iterator2 = _createForOfIteratorHelper(assistants);
-            _context2.prev = 6;
+            if (_context2.t1) {
+              _context2.next = 7;
+              break;
+            }
+
+            _context2.next = 6;
+            return fetchAssistants(client);
+
+          case 6:
+            _context2.t1 = _context2.sent;
+
+          case 7:
+            _context2.t2 = _context2.t1;
+            _iterator2 = (0, _context2.t0)(_context2.t2);
+            _context2.prev = 9;
 
             _iterator2.s();
 
-          case 8:
+          case 11:
             if ((_step2 = _iterator2.n()).done) {
-              _context2.next = 25;
+              _context2.next = 28;
               break;
             }
 
@@ -194,68 +216,68 @@ var migrateAssistantsWithoutFolder = /*#__PURE__*/function () {
             knowledgeBase = (0, _knowledgeBase.withRootFolderIfMissing)(assistant.knowledgeBase);
 
             if (!(knowledgeBase === assistant.knowledgeBase)) {
-              _context2.next = 13;
+              _context2.next = 16;
               break;
             }
 
-            return _context2.abrupt("continue", 23);
+            return _context2.abrupt("continue", 26);
 
-          case 13:
-            _context2.prev = 13;
-            _context2.next = 16;
+          case 16:
+            _context2.prev = 16;
+            _context2.next = 19;
             return client.save(_objectSpread(_objectSpread({}, assistant), {}, {
               knowledgeBase: knowledgeBase
             }));
 
-          case 16:
+          case 19:
             migrated.push(assistant._id);
-            _context2.next = 23;
+            _context2.next = 26;
             break;
 
-          case 19:
-            _context2.prev = 19;
-            _context2.t0 = _context2["catch"](13);
+          case 22:
+            _context2.prev = 22;
+            _context2.t3 = _context2["catch"](16);
 
-            if (!((_context2.t0 === null || _context2.t0 === void 0 ? void 0 : _context2.t0.status) !== 409)) {
-              _context2.next = 23;
+            if (!((_context2.t3 === null || _context2.t3 === void 0 ? void 0 : _context2.t3.status) !== 409)) {
+              _context2.next = 26;
               break;
             }
 
-            throw _context2.t0;
+            throw _context2.t3;
 
-          case 23:
-            _context2.next = 8;
+          case 26:
+            _context2.next = 11;
             break;
 
-          case 25:
-            _context2.next = 30;
+          case 28:
+            _context2.next = 33;
             break;
 
-          case 27:
-            _context2.prev = 27;
-            _context2.t1 = _context2["catch"](6);
-
-            _iterator2.e(_context2.t1);
-
           case 30:
             _context2.prev = 30;
+            _context2.t4 = _context2["catch"](9);
+
+            _iterator2.e(_context2.t4);
+
+          case 33:
+            _context2.prev = 33;
 
             _iterator2.f();
 
-            return _context2.finish(30);
+            return _context2.finish(33);
 
-          case 33:
+          case 36:
             return _context2.abrupt("return", migrated);
 
-          case 34:
+          case 37:
           case "end":
             return _context2.stop();
         }
       }
-    }, _callee2, null, [[6, 27, 30, 33], [13, 19]]);
+    }, _callee2, null, [[9, 30, 33, 36], [16, 22]]);
   }));
 
-  return function migrateAssistantsWithoutFolder(_x2) {
+  return function migrateAssistantsWithoutFolder(_x2, _x3) {
     return _ref2.apply(this, arguments);
   };
 }();
@@ -336,10 +358,44 @@ var ensureTriggers = /*#__PURE__*/function () {
     }, _callee3, null, [[15, 20]]);
   }));
 
-  return function ensureTriggers(_x3, _x4) {
+  return function ensureTriggers(_x4, _x5) {
     return _ref3.apply(this, arguments);
   };
 }();
+/**
+ * Creates the rag-index triggers the instance lacks, and launches the
+ * files one when it is created.
+ * @param {import('cozy-client').CozyClient} client - The cozy client.
+ * @returns {Promise<string[]>} The `arguments` of the triggers created.
+ */
+
+
+var createRagIndexTriggers = /*#__PURE__*/function () {
+  var _ref4 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee4(client) {
+    var created;
+    return _regenerator.default.wrap(function _callee4$(_context4) {
+      while (1) {
+        switch (_context4.prev = _context4.next) {
+          case 0:
+            created = [];
+            _context4.next = 3;
+            return ensureTriggers(client, created);
+
+          case 3:
+            return _context4.abrupt("return", created);
+
+          case 4:
+          case "end":
+            return _context4.stop();
+        }
+      }
+    }, _callee4);
+  }));
+
+  return function createRagIndexTriggers(_x6) {
+    return _ref4.apply(this, arguments);
+  };
+}();
 /**
  * Makes the instance ready for the assistants-driven indexing: the files
  * and assistants triggers exist (the files one is launched when created),
@@ -354,61 +410,63 @@ var ensureTriggers = /*#__PURE__*/function () {
  */
 
 
+exports.createRagIndexTriggers = createRagIndexTriggers;
+
 var setupRagIndexing = /*#__PURE__*/function () {
-  var _ref4 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee4(client) {
+  var _ref5 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee5(client) {
     var result;
-    return _regenerator.default.wrap(function _callee4$(_context4) {
+    return _regenerator.default.wrap(function _callee5$(_context5) {
       while (1) {
-        switch (_context4.prev = _context4.next) {
+        switch (_context5.prev = _context5.next) {
           case 0:
             result = {
               triggers: [],
               migrated: [],
               errors: []
             };
-            _context4.prev = 1;
-            _context4.next = 4;
+            _context5.prev = 1;
+            _context5.next = 4;
             return ensureTriggers(client, result.triggers);
 
           case 4:
-            _context4.next = 10;
+            _context5.next = 10;
             break;
 
           case 6:
-            _context4.prev = 6;
-            _context4.t0 = _context4["catch"](1);
-            warn('cannot set up the rag-index triggers', _context4.t0);
-            result.errors.push(_context4.t0);
+            _context5.prev = 6;
+            _context5.t0 = _context5["catch"](1);
+            warn('cannot set up the rag-index triggers', _context5.t0);
+            result.errors.push(_context5.t0);
 
           case 10:
-            _context4.prev = 10;
-            _context4.next = 13;
+            _context5.prev = 10;
+            _context5.next = 13;
             return migrateAssistantsWithoutFolder(client);
 
           case 13:
-            result.migrated = _context4.sent;
-            _context4.next = 20;
+            result.migrated = _context5.sent;
+            _context5.next = 20;
             break;
 
           case 16:
-            _context4.prev = 16;
-            _context4.t1 = _context4["catch"](10);
-            warn('cannot migrate the assistants without folder', _context4.t1);
-            result.errors.push(_context4.t1);
+            _context5.prev = 16;
+            _context5.t1 = _context5["catch"](10);
+            warn('cannot migrate the assistants without folder', _context5.t1);
+            result.errors.push(_context5.t1);
 
           case 20:
-            return _context4.abrupt("return", result);
+            return _context5.abrupt("return", result);
 
           case 21:
           case "end":
-            return _context4.stop();
+            return _context5.stop();
         }
       }
-    }, _callee4, null, [[1, 6], [10, 16]]);
+    }, _callee5, null, [[1, 6], [10, 16]]);
   }));
 
-  return function setupRagIndexing(_x5) {
-    return _ref4.apply(this, arguments);
+  return function setupRagIndexing(_x7) {
+    return _ref5.apply(this, arguments);
   };
 }();
 

package/dist/components/KnowledgeBase/ragIndexing.spec.js

@@ -3,6 +3,8 @@ import { Q } from 'cozy-client'
 import { ROOT_DIR_ID } from './knowledgeBase'
 import {
   RAG_INDEX_FILES_DEBOUNCE,
+  createRagIndexTriggers,
+  fetchAssistants,
   findRagIndexTriggers,
   makeRagIndexTriggerAttributes,
   migrateAssistantsWithoutFolder,
@@ -266,3 +268,52 @@ describe('setupRagIndexing', () => {
     expect(triggersCollection.create).not.toHaveBeenCalled()
   })
 })
+
+describe('createRagIndexTriggers', () => {
+  it('creates the missing triggers and launches the files one', async () => {
+    const { client, triggersCollection } = makeClient()
+    await expect(createRagIndexTriggers(client)).resolves.toEqual([
+      ASSISTANTS,
+      FILES
+    ])
+    expect(triggersCollection.create).toHaveBeenCalledTimes(2)
+    expect(triggersCollection.launch).toHaveBeenCalledTimes(1)
+  })
+
+  it('creates nothing when both triggers exist', async () => {
+    const { client, triggersCollection } = makeClient({
+      triggers: [filesTrigger, assistantsTrigger]
+    })
+    await expect(createRagIndexTriggers(client)).resolves.toEqual([])
+    expect(triggersCollection.create).not.toHaveBeenCalled()
+    expect(triggersCollection.launch).not.toHaveBeenCalled()
+  })
+})
+
+describe('fetchAssistants', () => {
+  it('lists every assistant', async () => {
+    const assistants = [{ _id: 'a' }, { _id: 'b' }]
+    const { client } = makeClient({ assistants })
+    await expect(fetchAssistants(client)).resolves.toEqual(assistants)
+    expect(client.queryAll).toHaveBeenCalledTimes(1)
+  })
+})
+
+describe('migrateAssistantsWithoutFolder with the assistants given', () => {
+  it('does not query them again', async () => {
+    const { client } = makeClient()
+    const assistants = [
+      { _id: 'bare', _type: ASSISTANTS },
+      {
+        _id: 'ok',
+        _type: ASSISTANTS,
+        knowledgeBase: [{ doctype: FILES, dirId: 'dir-1' }]
+      }
+    ]
+    await expect(
+      migrateAssistantsWithoutFolder(client, assistants)
+    ).resolves.toEqual(['bare'])
+    expect(client.queryAll).not.toHaveBeenCalled()
+    expect(client.save).toHaveBeenCalledTimes(1)
+  })
+})

package/dist/components/KnowledgeBase/useAssistantsAutoprovision.d.ts

@@ -0,0 +1 @@
+export function useAssistantsAutoprovision(): void;

package/dist/components/KnowledgeBase/useAssistantsAutoprovision.js

@@ -0,0 +1,25 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.useAssistantsAutoprovision = void 0;
+
+var _react = require("react");
+
+var _cozyClient = require("cozy-client");
+
+var _autoprovision = require("./autoprovision");
+
+/**
+ * Provisions the flagged assistants when the assistant UI opens, so an
+ * instance gets them even if the host app did not do it at startup.
+ */
+var useAssistantsAutoprovision = function useAssistantsAutoprovision() {
+  var client = (0, _cozyClient.useClient)();
+  (0, _react.useEffect)(function () {
+    if (client) (0, _autoprovision.autoprovisionAssistants)(client);
+  }, [client]);
+};
+
+exports.useAssistantsAutoprovision = useAssistantsAutoprovision;

package/dist/components/KnowledgeBase/useAssistantsAutoprovision.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/components/KnowledgeBase/useAssistantsAutoprovision.spec.js

@@ -0,0 +1,33 @@
+import { renderHook } from '@testing-library/react-hooks/dom'
+
+import { useClient } from 'cozy-client'
+
+import { autoprovisionAssistants } from './autoprovision'
+import { useAssistantsAutoprovision } from './useAssistantsAutoprovision'
+
+jest.mock('cozy-client', () => ({ useClient: jest.fn() }))
+jest.mock('./autoprovision', () => ({ autoprovisionAssistants: jest.fn() }))
+
+describe('useAssistantsAutoprovision', () => {
+  beforeEach(() => {
+    useClient.mockReset()
+    autoprovisionAssistants.mockReset().mockResolvedValue(null)
+  })
+
+  it('provisions with the client on mount', () => {
+    const client = { id: 'client' }
+    useClient.mockReturnValue(client)
+    const { rerender } = renderHook(() => useAssistantsAutoprovision())
+    rerender()
+
+    expect(autoprovisionAssistants).toHaveBeenCalledTimes(1)
+    expect(autoprovisionAssistants).toHaveBeenCalledWith(client)
+  })
+
+  it('waits for a client', () => {
+    useClient.mockReturnValue(null)
+    renderHook(() => useAssistantsAutoprovision())
+
+    expect(autoprovisionAssistants).not.toHaveBeenCalled()
+  })
+})

package/dist/components/KnowledgeBase/useRagIndexTriggers.d.ts

@@ -0,0 +1 @@
+export function useRagIndexTriggers(): void;

package/dist/components/KnowledgeBase/useRagIndexTriggers.js

@@ -0,0 +1,27 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.useRagIndexTriggers = void 0;
+
+var _react = require("react");
+
+var _cozyClient = require("cozy-client");
+
+var _autoprovision = require("./autoprovision");
+
+/**
+ * Ensures the rag-index triggers at startup, when the autoprovision flag
+ * lists assistants: the knowledge base folders are then indexed as they
+ * change, before the assistant is ever opened. The assistants themselves
+ * are provisioned when the assistant opens.
+ */
+var useRagIndexTriggers = function useRagIndexTriggers() {
+  var client = (0, _cozyClient.useClient)();
+  (0, _react.useEffect)(function () {
+    if (client && (0, _autoprovision.autoprovisionEntries)()) (0, _autoprovision.ensureRagIndexTriggers)(client);
+  }, [client]);
+};
+
+exports.useRagIndexTriggers = useRagIndexTriggers;

package/dist/components/KnowledgeBase/useRagIndexTriggers.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/components/KnowledgeBase/useRagIndexTriggers.spec.js

@@ -0,0 +1,47 @@
+import { renderHook } from '@testing-library/react-hooks/dom'
+
+import { useClient } from 'cozy-client'
+
+import { autoprovisionEntries, ensureRagIndexTriggers } from './autoprovision'
+import { useRagIndexTriggers } from './useRagIndexTriggers'
+
+jest.mock('cozy-client', () => ({ useClient: jest.fn() }))
+jest.mock('./autoprovision', () => ({
+  autoprovisionEntries: jest.fn(),
+  ensureRagIndexTriggers: jest.fn()
+}))
+
+const client = { id: 'client' }
+
+describe('useRagIndexTriggers', () => {
+  beforeEach(() => {
+    useClient.mockReset().mockReturnValue(client)
+    autoprovisionEntries.mockReset().mockReturnValue([{ name: 'Docs' }])
+    ensureRagIndexTriggers.mockReset().mockResolvedValue({
+      triggers: [],
+      error: null
+    })
+  })
+
+  it('ensures the triggers with the client on mount', () => {
+    const { rerender } = renderHook(() => useRagIndexTriggers())
+    rerender()
+
+    expect(ensureRagIndexTriggers).toHaveBeenCalledTimes(1)
+    expect(ensureRagIndexTriggers).toHaveBeenCalledWith(client)
+  })
+
+  it('does nothing without flag entries', () => {
+    autoprovisionEntries.mockReturnValue(null)
+    renderHook(() => useRagIndexTriggers())
+
+    expect(ensureRagIndexTriggers).not.toHaveBeenCalled()
+  })
+
+  it('waits for a client', () => {
+    useClient.mockReturnValue(null)
+    renderHook(() => useRagIndexTriggers())
+
+    expect(ensureRagIndexTriggers).not.toHaveBeenCalled()
+  })
+})

package/dist/components/queries.js

@@ -23,8 +23,7 @@ exports.ACCOUNTS_DOCTYPE = ACCOUNTS_DOCTYPE;
 var EMAIL_DOCTYPE = 'com.linagora.email';
 exports.EMAIL_DOCTYPE = EMAIL_DOCTYPE;
 
-var defaultFetchPolicy = _cozyClient.fetchPolicies.olderThan(86400); // 24 hours
-
+var defaultFetchPolicy = _cozyClient.fetchPolicies.olderThan(5 * 60 * 1000);
 
 var buildFilesByIds = function buildFilesByIds(ids, enabled) {
   return {

package/dist/index.d.ts

@@ -11,3 +11,6 @@ export { StreamBridge, createCozyRealtimeChatAdapter } from './components/adapte
 export { default as AssistantView } from './components/Views/AssistantView';
 export { assistantIdFromName, AUTOPROVISION_FLAG, ensureProvisionedAssistants, getDefaultProvisionedAssistantId } from './components/KnowledgeBase/provisioning';
 export { setupRagIndexing } from './components/KnowledgeBase/ragIndexing';
+export { autoprovisionAssistants, ensureRagIndexTriggers } from './components/KnowledgeBase/autoprovision';
+export { useRagIndexTriggers } from './components/KnowledgeBase/useRagIndexTriggers';
+export { useAssistantsAutoprovision } from './components/KnowledgeBase/useAssistantsAutoprovision';

package/dist/index.js

@@ -83,6 +83,12 @@ Object.defineProperty(exports, "assistantIdFromName", {
     return _provisioning.assistantIdFromName;
   }
 });
+Object.defineProperty(exports, "autoprovisionAssistants", {
+  enumerable: true,
+  get: function get() {
+    return _autoprovision.autoprovisionAssistants;
+  }
+});
 Object.defineProperty(exports, "createCozyRealtimeChatAdapter", {
   enumerable: true,
   get: function get() {
@@ -95,6 +101,12 @@ Object.defineProperty(exports, "ensureProvisionedAssistants", {
     return _provisioning.ensureProvisionedAssistants;
   }
 });
+Object.defineProperty(exports, "ensureRagIndexTriggers", {
+  enumerable: true,
+  get: function get() {
+    return _autoprovision.ensureRagIndexTriggers;
+  }
+});
 Object.defineProperty(exports, "getDefaultProvisionedAssistantId", {
   enumerable: true,
   get: function get() {
@@ -107,6 +119,18 @@ Object.defineProperty(exports, "setupRagIndexing", {
     return _ragIndexing.setupRagIndexing;
   }
 });
+Object.defineProperty(exports, "useAssistantsAutoprovision", {
+  enumerable: true,
+  get: function get() {
+    return _useAssistantsAutoprovision.useAssistantsAutoprovision;
+  }
+});
+Object.defineProperty(exports, "useRagIndexTriggers", {
+  enumerable: true,
+  get: function get() {
+    return _useRagIndexTriggers.useRagIndexTriggers;
+  }
+});
 
 var _AssistantLink = _interopRequireDefault(require("./components/Search/AssistantLink"));
 
@@ -132,4 +156,10 @@ var _AssistantView = _interopRequireDefault(require("./components/Views/Assistan
 
 var _provisioning = require("./components/KnowledgeBase/provisioning");
 
-var _ragIndexing = require("./components/KnowledgeBase/ragIndexing");
+var _ragIndexing = require("./components/KnowledgeBase/ragIndexing");
+
+var _autoprovision = require("./components/KnowledgeBase/autoprovision");
+
+var _useRagIndexTriggers = require("./components/KnowledgeBase/useRagIndexTriggers");
+
+var _useAssistantsAutoprovision = require("./components/KnowledgeBase/useAssistantsAutoprovision");

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "cozy-search",
   "description": "UI components about search bar and IA assistant",
-  "version": "2.3.3",
+  "version": "2.5.0",
   "author": {
     "name": "Cozy Cloud",
     "url": "https://github.com/cozy"
@@ -96,5 +96,5 @@
     "lint": "cd .. && yarn eslint --ext js,jsx,ts packages/cozy-search"
   },
   "types": "dist/index.d.ts",
-  "gitHead": "5269c3bcf245d4e9e47cbefd29286aa733602bb7"
+  "gitHead": "d7d90a7a9805e76249173a0546cdc374cf596cec"
 }