cozy-harvest-lib 7.1.1 → 7.2.0

package/CHANGELOG.md

@@ -3,6 +3,18 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [7.2.0](https://github.com/cozy/cozy-libs/compare/cozy-harvest-lib@7.1.1...cozy-harvest-lib@7.2.0) (2022-01-31)
+
+
+### Features
+
+* Add the defaultFolderPath attribute to the account ([1e80f81](https://github.com/cozy/cozy-libs/commit/1e80f81))
+* Some naming improvements + unit tests ([bc7e10d](https://github.com/cozy/cozy-libs/commit/bc7e10d))
+
+
+
+
+
 ## [7.1.1](https://github.com/cozy/cozy-libs/compare/cozy-harvest-lib@7.1.0...cozy-harvest-lib@7.1.1) (2022-01-28)
 
 **Note:** Version bump only for package cozy-harvest-lib

package/dist/models/ConnectionFlow.js

@@ -20,6 +20,7 @@ import MicroEE from 'microee';
 import get from 'lodash/get';
 import Realtime from 'cozy-realtime';
 import flag from 'cozy-flags';
+import { Q } from 'cozy-client';
 import { fetchReusableAccount, saveAccount as _saveAccount, ACCOUNTS_DOCTYPE } from '../connections/accounts';
 import clone from 'lodash/clone';
 import { launchTrigger, prepareTriggerAccount, fetchTrigger, ensureTrigger } from '../connections/triggers';
@@ -730,13 +731,21 @@ export var ConnectionFlow = /*#__PURE__*/function () {
 
               case 5:
                 ensuredTrigger = _context9.sent;
+                _context9.next = 8;
+                return this.ensureDefaultFolderPathInAccount(client, {
+                  trigger: ensuredTrigger,
+                  account: account,
+                  konnector: konnector
+                });
+
+              case 8:
                 logger.info("Trigger is ".concat(ensuredTrigger._id));
                 this.trigger = ensuredTrigger;
                 this.emit(UPDATE_EVENT);
-                _context9.next = 11;
+                _context9.next = 13;
                 return this.launch();
 
-              case 11:
+              case 13:
               case "end":
                 return _context9.stop();
             }
@@ -750,6 +759,87 @@ export var ConnectionFlow = /*#__PURE__*/function () {
 
       return ensureTriggerAndLaunch;
     }()
+    /**
+     * Ensures there is a defaultFolderPath attribute in the account
+     * if any folder is needed by the connector.
+     * The account is saved if any change is done to it.
+     * This defaultFolderPath is needed by the stack to recreate the
+     * destination folder if removed by any mean : drive application,
+     * desktop application etc
+     *
+     * @param  {CozyClient} client - A cozy client
+     * @param  {io.cozy.triggers} options.trigger
+     * @param  {io.cozy.accounts} options.account
+     * @param  {io.cozy.konnectors} options.konnector
+     */
+
+  }, {
+    key: "ensureDefaultFolderPathInAccount",
+    value: function () {
+      var _ensureDefaultFolderPathInAccount = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee10(client, _ref4) {
+        var trigger, account, konnector, folderId, folder, result, savedAccount;
+        return _regeneratorRuntime.wrap(function _callee10$(_context10) {
+          while (1) {
+            switch (_context10.prev = _context10.next) {
+              case 0:
+                trigger = _ref4.trigger, account = _ref4.account, konnector = _ref4.konnector;
+                folderId = get(trigger, 'message.folder_to_save');
+
+                if (folderId) {
+                  _context10.next = 4;
+                  break;
+                }
+
+                return _context10.abrupt("return", account);
+
+              case 4:
+                _context10.prev = 4;
+                _context10.next = 7;
+                return client.query(Q('io.cozy.files').getById(folderId));
+
+              case 7:
+                result = _context10.sent;
+                folder = result.data;
+                _context10.next = 15;
+                break;
+
+              case 11:
+                _context10.prev = 11;
+                _context10.t0 = _context10["catch"](4);
+                logger.warn("ConnectionFlow.ensureDefaultFolderPath: folder ".concat(folderId, " does not exist. Could not ensure defaultFolderPath. ").concat(_context10.t0.message));
+                return _context10.abrupt("return", account);
+
+              case 15:
+                if (!(folder.path !== account.defaultFolderPath)) {
+                  _context10.next = 21;
+                  break;
+                }
+
+                account.defaultFolderPath = folder.path;
+                _context10.next = 19;
+                return _saveAccount(client, konnector, account);
+
+              case 19:
+                savedAccount = _context10.sent;
+                return _context10.abrupt("return", savedAccount);
+
+              case 21:
+                return _context10.abrupt("return", account);
+
+              case 22:
+              case "end":
+                return _context10.stop();
+            }
+          }
+        }, _callee10, null, [[4, 11]]);
+      }));
+
+      function ensureDefaultFolderPathInAccount(_x9, _x10) {
+        return _ensureDefaultFolderPathInAccount.apply(this, arguments);
+      }
+
+      return ensureDefaultFolderPathInAccount;
+    }()
     /**
      * Launches the job and sets everything up to follow execution.
      */
@@ -757,41 +847,41 @@ export var ConnectionFlow = /*#__PURE__*/function () {
   }, {
     key: "launch",
     value: function () {
-      var _launch = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee10() {
+      var _launch = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee11() {
         var _this2 = this;
 
-        var _ref4,
-            _ref4$autoSuccessTime,
+        var _ref5,
+            _ref5$autoSuccessTime,
             autoSuccessTimer,
             computedAutoSuccessTimer,
             launcher,
             _iterator2,
             _step2,
             _loop,
-            _args10 = arguments;
+            _args11 = arguments;
 
-        return _regeneratorRuntime.wrap(function _callee10$(_context10) {
+        return _regeneratorRuntime.wrap(function _callee11$(_context11) {
           while (1) {
-            switch (_context10.prev = _context10.next) {
+            switch (_context11.prev = _context11.next) {
               case 0:
-                _ref4 = _args10.length > 0 && _args10[0] !== undefined ? _args10[0] : {}, _ref4$autoSuccessTime = _ref4.autoSuccessTimer, autoSuccessTimer = _ref4$autoSuccessTime === void 0 ? true : _ref4$autoSuccessTime;
+                _ref5 = _args11.length > 0 && _args11[0] !== undefined ? _args11[0] : {}, _ref5$autoSuccessTime = _ref5.autoSuccessTimer, autoSuccessTimer = _ref5$autoSuccessTime === void 0 ? true : _ref5$autoSuccessTime;
                 computedAutoSuccessTimer = autoSuccessTimer && !get(this, 'konnector.clientSide');
                 logger.info('ConnectionFlow: Launching job...');
                 this.setState({
                   status: PENDING
                 });
-                _context10.next = 6;
+                _context11.next = 6;
                 return prepareTriggerAccount(this.client, this.trigger);
 
               case 6:
-                this.account = _context10.sent;
+                this.account = _context11.sent;
                 this.realtime.subscribe('updated', ACCOUNTS_DOCTYPE, this.account._id, this.handleAccountUpdated);
                 logger.info("ConnectionFlow: Subscribed to ".concat(ACCOUNTS_DOCTYPE, ":").concat(this.account._id));
-                _context10.next = 11;
+                _context11.next = 11;
                 return launchTrigger(this.client, this.trigger);
 
               case 11:
-                this.job = _context10.sent;
+                this.job = _context11.sent;
 
                 if (get(this, 'konnector.clientSide')) {
                   logger.info('This connector can be run by the launcher', this.konnector.slug);
@@ -855,10 +945,10 @@ export var ConnectionFlow = /*#__PURE__*/function () {
 
               case 19:
               case "end":
-                return _context10.stop();
+                return _context11.stop();
             }
           }
-        }, _callee10, this);
+        }, _callee11, this);
       }));
 
       function launch() {

package/dist/models/ConnectionFlow.spec.js

@@ -15,6 +15,7 @@ import KonnectorJobWatcher from './konnector/KonnectorJobWatcher';
 import { konnectorPolicy as biKonnectorPolicy } from '../services/budget-insight';
 import fixtures from '../../test/fixtures';
 import sentryHub from '../sentry';
+import { Q } from 'cozy-client';
 jest.mock('../sentry', function () {
   var mockScope = {
     setTag: jest.fn()
@@ -161,6 +162,7 @@ var setup = function setup() {
       trigger = _ref6.trigger;
 
   var client = {
+    query: jest.fn(),
     collection: jest.fn().mockReturnValue({
       all: jest.fn().mockReturnValue({
         data: []
@@ -630,14 +632,106 @@ describe('ConnectionFlow', function () {
         }
       }, _callee20);
     })));
-    it('should call the launcher when needed', /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee22() {
-      var _setup16, client, flow;
+    it('should add the defaultFolderPath to the account when needed', /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee23() {
+      var _setup16, flow, client;
 
-      return _regeneratorRuntime.wrap(function _callee22$(_context22) {
+      return _regeneratorRuntime.wrap(function _callee23$(_context23) {
         while (1) {
-          switch (_context22.prev = _context22.next) {
+          switch (_context23.prev = _context23.next) {
             case 0:
-              _setup16 = setup(), client = _setup16.client;
+              _setup16 = setup(), flow = _setup16.flow, client = _setup16.client;
+              prepareTriggerAccount.mockResolvedValue(fixtures.updatedAccount);
+              ensureTrigger.mockImplementation( /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee21() {
+                return _regeneratorRuntime.wrap(function _callee21$(_context21) {
+                  while (1) {
+                    switch (_context21.prev = _context21.next) {
+                      case 0:
+                        return _context21.abrupt("return", fixtures.createdTriggerWithFolder.attributes);
+
+                      case 1:
+                      case "end":
+                        return _context21.stop();
+                    }
+                  }
+                }, _callee21);
+              })));
+              client.query.mockImplementation( /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee22() {
+                return _regeneratorRuntime.wrap(function _callee22$(_context22) {
+                  while (1) {
+                    switch (_context22.prev = _context22.next) {
+                      case 0:
+                        return _context22.abrupt("return", {
+                          data: {
+                            path: '/default/folder/path'
+                          }
+                        });
+
+                      case 1:
+                      case "end":
+                        return _context22.stop();
+                    }
+                  }
+                }, _callee22);
+              })));
+              _context23.next = 6;
+              return flow.ensureTriggerAndLaunch(client, {
+                account: fixtures.existingAccount,
+                trigger: fixtures.existingTrigger,
+                konnector: fixtures.konnectorWithFolder
+              });
+
+            case 6:
+              expect(flow.account).toEqual(fixtures.updatedAccount);
+              expect(saveAccount).toHaveBeenCalledWith(client, fixtures.konnectorWithFolder, _objectSpread(_objectSpread({}, fixtures.existingAccount), {}, {
+                defaultFolderPath: '/default/folder/path'
+              }));
+              expect(client.query).toHaveBeenCalledWith(Q('io.cozy.files').getById(fixtures.createdTriggerWithFolder.attributes.message.folder_to_save));
+
+            case 9:
+            case "end":
+              return _context23.stop();
+          }
+        }
+      }, _callee23);
+    })));
+    it('should return unmodified account trigger folder does not exist', /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee24() {
+      var _setup17, flow, client;
+
+      return _regeneratorRuntime.wrap(function _callee24$(_context24) {
+        while (1) {
+          switch (_context24.prev = _context24.next) {
+            case 0:
+              _setup17 = setup(), flow = _setup17.flow, client = _setup17.client;
+              prepareTriggerAccount.mockResolvedValue(fixtures.updatedAccount);
+              ensureTrigger.mockResolvedValue(fixtures.createdTriggerWithFolder.attributes);
+              client.query.mockRejectedValue(new Error('404'));
+              _context24.next = 6;
+              return flow.ensureTriggerAndLaunch(client, {
+                account: fixtures.existingAccount,
+                trigger: fixtures.existingTrigger,
+                konnector: fixtures.konnectorWithFolder
+              });
+
+            case 6:
+              expect(flow.account).toEqual(fixtures.updatedAccount);
+              expect(saveAccount).not.toHaveBeenCalled();
+              expect(client.query).toHaveBeenCalledWith(Q('io.cozy.files').getById(fixtures.createdTriggerWithFolder.attributes.message.folder_to_save));
+
+            case 9:
+            case "end":
+              return _context24.stop();
+          }
+        }
+      }, _callee24);
+    })));
+    it('should call the launcher when needed', /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee26() {
+      var _setup18, client, flow;
+
+      return _regeneratorRuntime.wrap(function _callee26$(_context26) {
+        while (1) {
+          switch (_context26.prev = _context26.next) {
+            case 0:
+              _setup18 = setup(), client = _setup18.client;
               flow = new ConnectionFlow(client, fixtures.existingTrigger, fixtures.clientKonnector);
               window.cozy = {
                 ClientConnectorLauncher: 'react-native'
@@ -645,22 +739,22 @@ describe('ConnectionFlow', function () {
               window.ReactNativeWebView = {
                 postMessage: jest.fn()
               };
-              ensureTrigger.mockImplementation( /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee21() {
-                return _regeneratorRuntime.wrap(function _callee21$(_context21) {
+              ensureTrigger.mockImplementation( /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee25() {
+                return _regeneratorRuntime.wrap(function _callee25$(_context25) {
                   while (1) {
-                    switch (_context21.prev = _context21.next) {
+                    switch (_context25.prev = _context25.next) {
                       case 0:
-                        return _context21.abrupt("return", fixtures.existingTrigger);
+                        return _context25.abrupt("return", fixtures.existingTrigger);
 
                       case 1:
                       case "end":
-                        return _context21.stop();
+                        return _context25.stop();
                     }
                   }
-                }, _callee21);
+                }, _callee25);
               })));
               prepareTriggerAccount.mockResolvedValue(fixtures.updatedAccount);
-              _context22.next = 8;
+              _context26.next = 8;
               return flow.ensureTriggerAndLaunch(client, {
                 account: fixtures.existingAccount,
                 trigger: fixtures.existingTrigger
@@ -680,10 +774,10 @@ describe('ConnectionFlow', function () {
 
             case 10:
             case "end":
-              return _context22.stop();
+              return _context26.stop();
           }
         }
-      }, _callee22);
+      }, _callee26);
     })));
     delete window.cozy;
     delete window.ReactNativeWebView;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cozy-harvest-lib",
-  "version": "7.1.1",
+  "version": "7.2.0",
   "description": "Provides logic, modules and components for Cozy's harvest applications.",
   "main": "dist/index.js",
   "author": "Cozy",
@@ -85,5 +85,5 @@
     "react-router-dom": "^5.0.1"
   },
   "sideEffects": false,
-  "gitHead": "bee23139882151ec2e55d817755fbfbb5798d4b2"
+  "gitHead": "beff9977aff2347bbef342015b062f5c4b71c6cd"
 }

package/src/models/ConnectionFlow.js

@@ -3,6 +3,7 @@ import get from 'lodash/get'
 
 import Realtime from 'cozy-realtime'
 import flag from 'cozy-flags'
+import { Q } from 'cozy-client'
 
 import {
   fetchReusableAccount,
@@ -474,12 +475,59 @@ export class ConnectionFlow {
       konnector,
       t
     })
+
+    await this.ensureDefaultFolderPathInAccount(client, {
+      trigger: ensuredTrigger,
+      account,
+      konnector
+    })
+
     logger.info(`Trigger is ${ensuredTrigger._id}`)
     this.trigger = ensuredTrigger
     this.emit(UPDATE_EVENT)
     await this.launch()
   }
 
+  /**
+   * Ensures there is a defaultFolderPath attribute in the account
+   * if any folder is needed by the connector.
+   * The account is saved if any change is done to it.
+   * This defaultFolderPath is needed by the stack to recreate the
+   * destination folder if removed by any mean : drive application,
+   * desktop application etc
+   *
+   * @param  {CozyClient} client - A cozy client
+   * @param  {io.cozy.triggers} options.trigger
+   * @param  {io.cozy.accounts} options.account
+   * @param  {io.cozy.konnectors} options.konnector
+   */
+  async ensureDefaultFolderPathInAccount(
+    client,
+    { trigger, account, konnector }
+  ) {
+    const folderId = get(trigger, 'message.folder_to_save')
+    if (!folderId) {
+      return account
+    }
+
+    let folder
+    try {
+      const result = await client.query(Q('io.cozy.files').getById(folderId))
+      folder = result.data
+    } catch (err) {
+      logger.warn(
+        `ConnectionFlow.ensureDefaultFolderPath: folder ${folderId} does not exist. Could not ensure defaultFolderPath. ${err.message}`
+      )
+      return account
+    }
+    if (folder.path !== account.defaultFolderPath) {
+      account.defaultFolderPath = folder.path
+      const savedAccount = await saveAccount(client, konnector, account)
+      return savedAccount
+    }
+    return account
+  }
+
   /**
    * Launches the job and sets everything up to follow execution.
    */

package/src/models/ConnectionFlow.spec.js

@@ -12,6 +12,7 @@ import KonnectorJobWatcher from './konnector/KonnectorJobWatcher'
 import { konnectorPolicy as biKonnectorPolicy } from '../services/budget-insight'
 import fixtures from '../../test/fixtures'
 import sentryHub from '../sentry'
+import { Q } from 'cozy-client'
 
 jest.mock('../sentry', () => {
   const mockScope = {
@@ -90,6 +91,7 @@ const mockVaultClient = {
 
 const setup = ({ trigger } = {}) => {
   const client = {
+    query: jest.fn(),
     collection: jest.fn().mockReturnValue({
       all: jest.fn().mockReturnValue({
         data: []
@@ -388,6 +390,61 @@ describe('ConnectionFlow', () => {
       expect(flow.account).toEqual(fixtures.updatedAccount)
     })
 
+    it('should add the defaultFolderPath to the account when needed', async () => {
+      const { flow, client } = setup()
+      prepareTriggerAccount.mockResolvedValue(fixtures.updatedAccount)
+
+      ensureTrigger.mockImplementation(
+        async () => fixtures.createdTriggerWithFolder.attributes
+      )
+      client.query.mockImplementation(async () => ({
+        data: {
+          path: '/default/folder/path'
+        }
+      }))
+      await flow.ensureTriggerAndLaunch(client, {
+        account: fixtures.existingAccount,
+        trigger: fixtures.existingTrigger,
+        konnector: fixtures.konnectorWithFolder
+      })
+      expect(flow.account).toEqual(fixtures.updatedAccount)
+      expect(saveAccount).toHaveBeenCalledWith(
+        client,
+        fixtures.konnectorWithFolder,
+        {
+          ...fixtures.existingAccount,
+          defaultFolderPath: '/default/folder/path'
+        }
+      )
+      expect(client.query).toHaveBeenCalledWith(
+        Q('io.cozy.files').getById(
+          fixtures.createdTriggerWithFolder.attributes.message.folder_to_save
+        )
+      )
+    })
+
+    it('should return unmodified account trigger folder does not exist', async () => {
+      const { flow, client } = setup()
+      prepareTriggerAccount.mockResolvedValue(fixtures.updatedAccount)
+
+      ensureTrigger.mockResolvedValue(
+        fixtures.createdTriggerWithFolder.attributes
+      )
+      client.query.mockRejectedValue(new Error('404'))
+      await flow.ensureTriggerAndLaunch(client, {
+        account: fixtures.existingAccount,
+        trigger: fixtures.existingTrigger,
+        konnector: fixtures.konnectorWithFolder
+      })
+      expect(flow.account).toEqual(fixtures.updatedAccount)
+      expect(saveAccount).not.toHaveBeenCalled()
+      expect(client.query).toHaveBeenCalledWith(
+        Q('io.cozy.files').getById(
+          fixtures.createdTriggerWithFolder.attributes.message.folder_to_save
+        )
+      )
+    })
+
     it('should call the launcher when needed', async () => {
       const { client } = setup()
       const flow = new ConnectionFlow(

package/test/fixtures.js

@@ -125,6 +125,20 @@ const fixtures = {
       }
     }
   },
+  createdTriggerWithFolder: {
+    id: 'created-trigger-id',
+    _type: 'io.cozy.triggers',
+    attributes: {
+      arguments: '0 0 0 * * 0',
+      type: '@cron',
+      worker: 'konnector',
+      message: {
+        account: 'updated-account-id',
+        konnector: 'konnectest',
+        folder_to_save: 'folder-id'
+      }
+    }
+  },
   launchedJob: {
     type: 'io.cozy.jobs',
     _id: 'lauched-job-id',