cozy-harvest-lib 17.2.2 → 17.3.0

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [17.3.0](https://github.com/cozy/cozy-libs/compare/cozy-harvest-lib@17.2.2...cozy-harvest-lib@17.3.0) (2023-09-28)
+
+
+### Features
+
+* Add createAccountSilently ([7236d8f](https://github.com/cozy/cozy-libs/commit/7236d8fa40e6e5fa633f17e88b481b08b0369ed6))
+
+
+
+
+
 ## [17.2.2](https://github.com/cozy/cozy-libs/compare/cozy-harvest-lib@17.2.1...cozy-harvest-lib@17.2.2) (2023-08-31)
 
 **Note:** Version bump only for package cozy-harvest-lib

package/dist/models/ConnectionFlow.js

@@ -56,8 +56,8 @@ var isStepEvent = function isStepEvent(eventName) {
  *
  * @param  {Object} options
  * @param  {import('cozy-client/types/types').IOCozyAccount} options.account - Existing io.cozy.account or object
- * @param  {Object} options.cipher - Vault cipher if vault has been unlocked
- * @param  {String} options.cipher.id - Vault cipher id
+ * @param  {Object} [options.cipher] - Vault cipher if vault has been unlocked
+ * @param  {String} [options.cipher.id] - Vault cipher id
  * @param  {ConnectionFlow} options.flow - Current connection flow
  * @param  {CozyClient} options.client - A CozyClient instance
  * @param  {import('cozy-client/types/types').IOCozyKonnector} options.konnector - Konnector to which the account is linked
@@ -752,6 +752,114 @@ export var ConnectionFlow = /*#__PURE__*/function () {
 
       return handleFormSubmit;
     }()
+    /**
+     * - Creates io.cozy.accounts
+     * - Saves account
+     * - Ensures trigger is existing for account
+     */
+
+  }, {
+    key: "createAccountSilently",
+    value: function () {
+      var _createAccountSilently = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee7(options) {
+        var konnector, userCredentials, t, account, trigger, client, konnectorPolicy;
+        return _regeneratorRuntime.wrap(function _callee7$(_context7) {
+          while (1) {
+            switch (_context7.prev = _context7.next) {
+              case 0:
+                konnector = options.konnector, userCredentials = options.userCredentials, t = options.t;
+                _context7.prev = 1;
+                account = options.account, trigger = options.trigger;
+                client = this.client;
+                this.setState({
+                  status: CREATING_ACCOUNT,
+                  firstRun: true // when the user submits new authentication information, this is considered a first run
+
+                });
+                this.trigger = trigger;
+                this.account = account;
+                this.t = t;
+                assert(client, 'No client');
+                konnectorPolicy = this.getKonnectorPolicy(); // @ts-ignore
+
+                logger.log("ConnectionFlow: Handling submit, with konnector policy ".concat(konnectorPolicy.name)); // @ts-ignore
+
+                logger.info('ConnectionFlow: Bypassing cipher creation because of vault may be unlocked');
+
+                if (!konnectorPolicy.needsAccountAndTriggerCreation) {
+                  _context7.next = 24;
+                  break;
+                }
+
+                // @ts-ignore
+                logger.debug('ConnectionFlow: Creating/updating account...', account);
+                _context7.next = 16;
+                return createOrUpdateAccount({
+                  account: account,
+                  client: client,
+                  flow: this,
+                  konnector: konnector,
+                  konnectorPolicy: konnectorPolicy,
+                  userCredentials: userCredentials
+                });
+
+              case 16:
+                account = _context7.sent;
+                this.account = account; // @ts-ignore
+
+                logger.info("ConnectionFlow: Saved account ".concat(account._id)); // @ts-ignore
+
+                logger.debug('ConnectionFlow: Ensuring trigger...');
+                _context7.next = 22;
+                return ensureTrigger(client, {
+                  trigger: trigger,
+                  account: account,
+                  konnector: konnector,
+                  t: t
+                });
+
+              case 22:
+                this.trigger = _context7.sent;
+                // @ts-ignore
+                logger.info("Trigger is ".concat(this.trigger._id));
+
+              case 24:
+                this.setState({
+                  accountError: null
+                });
+                _context7.next = 34;
+                break;
+
+              case 27:
+                _context7.prev = 27;
+                _context7.t0 = _context7["catch"](1);
+                // @ts-ignore
+                logger.error(_context7.t0);
+                this.setState({
+                  accountError: _context7.t0
+                });
+                this.triggerEvent(ERROR_EVENT, _context7.t0);
+                sentryHub.withScope(function (scope) {
+                  scope.setTag('konnector', konnector.slug); // Capture the original exception instead of the user one
+
+                  sentryHub.captureException(_context7.t0.original || _context7.t0);
+                });
+                throw _context7.t0;
+
+              case 34:
+              case "end":
+                return _context7.stop();
+            }
+          }
+        }, _callee7, this, [[1, 27]]);
+      }));
+
+      function createAccountSilently(_x7) {
+        return _createAccountSilently.apply(this, arguments);
+      }
+
+      return createAccountSilently;
+    }()
     /**
      * Ensures a trigger is created and launched
      *
@@ -767,16 +875,16 @@ export var ConnectionFlow = /*#__PURE__*/function () {
   }, {
     key: "ensureTriggerAndLaunch",
     value: function () {
-      var _ensureTriggerAndLaunch = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee7(client, _ref3) {
+      var _ensureTriggerAndLaunch = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee8(client, _ref3) {
         var account, konnector, trigger, t;
-        return _regeneratorRuntime.wrap(function _callee7$(_context7) {
+        return _regeneratorRuntime.wrap(function _callee8$(_context8) {
           while (1) {
-            switch (_context7.prev = _context7.next) {
+            switch (_context8.prev = _context8.next) {
               case 0:
                 account = _ref3.account, konnector = _ref3.konnector, trigger = _ref3.trigger, t = _ref3.t;
                 // @ts-ignore
                 logger.debug('ConnectionFlow: Ensuring trigger...');
-                _context7.next = 4;
+                _context8.next = 4;
                 return ensureTrigger(client, {
                   trigger: trigger,
                   account: account,
@@ -785,10 +893,10 @@ export var ConnectionFlow = /*#__PURE__*/function () {
                 });
 
               case 4:
-                this.trigger = _context7.sent;
+                this.trigger = _context8.sent;
                 // @ts-ignore
                 logger.info("Trigger is ".concat(this.trigger._id));
-                _context7.next = 8;
+                _context8.next = 8;
                 return this.ensureDefaultFolderPathInAccount(client, {
                   trigger: this.trigger,
                   account: account,
@@ -798,18 +906,18 @@ export var ConnectionFlow = /*#__PURE__*/function () {
               case 8:
                 // @ts-ignore
                 this.emit(UPDATE_EVENT);
-                _context7.next = 11;
+                _context8.next = 11;
                 return this.launch();
 
               case 11:
               case "end":
-                return _context7.stop();
+                return _context8.stop();
             }
           }
-        }, _callee7, this);
+        }, _callee8, this);
       }));
 
-      function ensureTriggerAndLaunch(_x7, _x8) {
+      function ensureTriggerAndLaunch(_x8, _x9) {
         return _ensureTriggerAndLaunch.apply(this, arguments);
       }
 
@@ -890,27 +998,27 @@ export var ConnectionFlow = /*#__PURE__*/function () {
   }, {
     key: "refetchTrigger",
     value: function () {
-      var _refetchTrigger = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee8() {
+      var _refetchTrigger = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee9() {
         var trigger;
-        return _regeneratorRuntime.wrap(function _callee8$(_context8) {
+        return _regeneratorRuntime.wrap(function _callee9$(_context9) {
           while (1) {
-            switch (_context8.prev = _context8.next) {
+            switch (_context9.prev = _context9.next) {
               case 0:
                 if (this.trigger) {
-                  _context8.next = 2;
+                  _context9.next = 2;
                   break;
                 }
 
-                return _context8.abrupt("return", null);
+                return _context9.abrupt("return", null);
 
               case 2:
                 // @ts-ignore
                 logger.debug("ConnectionFlow: Refetching trigger  ".concat(this.trigger._id));
-                _context8.next = 5;
+                _context9.next = 5;
                 return fetchTrigger(this.client, this.trigger._id);
 
               case 5:
-                trigger = _context8.sent;
+                trigger = _context9.sent;
                 // @ts-ignore
                 logger.debug("Refetched trigger", trigger);
                 this.trigger = trigger;
@@ -920,10 +1028,10 @@ export var ConnectionFlow = /*#__PURE__*/function () {
 
               case 10:
               case "end":
-                return _context8.stop();
+                return _context9.stop();
             }
           }
-        }, _callee8, this);
+        }, _callee9, this);
       }));
 
       function refetchTrigger() {
@@ -950,69 +1058,69 @@ export var ConnectionFlow = /*#__PURE__*/function () {
   }, {
     key: "ensureDefaultFolderPathInAccount",
     value: function () {
-      var _ensureDefaultFolderPathInAccount = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee9(client, _ref4) {
+      var _ensureDefaultFolderPathInAccount = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee10(client, _ref4) {
         var _trigger$message2;
 
         var trigger, account, konnector, folderId, folder, result, savedAccount;
-        return _regeneratorRuntime.wrap(function _callee9$(_context9) {
+        return _regeneratorRuntime.wrap(function _callee10$(_context10) {
           while (1) {
-            switch (_context9.prev = _context9.next) {
+            switch (_context10.prev = _context10.next) {
               case 0:
                 trigger = _ref4.trigger, account = _ref4.account, konnector = _ref4.konnector;
                 // @ts-ignore the message property does not exist in TriggersDoctype
                 folderId = trigger === null || trigger === void 0 ? void 0 : (_trigger$message2 = trigger.message) === null || _trigger$message2 === void 0 ? void 0 : _trigger$message2.folder_to_save;
 
                 if (folderId) {
-                  _context9.next = 4;
+                  _context10.next = 4;
                   break;
                 }
 
-                return _context9.abrupt("return", account);
+                return _context10.abrupt("return", account);
 
               case 4:
-                _context9.prev = 4;
-                _context9.next = 7;
+                _context10.prev = 4;
+                _context10.next = 7;
                 return client.query(Q('io.cozy.files').getById(folderId));
 
               case 7:
-                result = _context9.sent;
+                result = _context10.sent;
                 folder = result.data;
 
                 if (!(folder.path !== account.defaultFolderPath)) {
-                  _context9.next = 15;
+                  _context10.next = 15;
                   break;
                 }
 
                 account.defaultFolderPath = folder.path;
-                _context9.next = 13;
+                _context10.next = 13;
                 return _saveAccount(client, konnector, account);
 
               case 13:
-                savedAccount = _context9.sent;
-                return _context9.abrupt("return", savedAccount);
+                savedAccount = _context10.sent;
+                return _context10.abrupt("return", savedAccount);
 
               case 15:
-                _context9.next = 20;
+                _context10.next = 20;
                 break;
 
               case 17:
-                _context9.prev = 17;
-                _context9.t0 = _context9["catch"](4);
+                _context10.prev = 17;
+                _context10.t0 = _context10["catch"](4);
                 // @ts-ignore
-                logger.warn("ConnectionFlow.ensureDefaultFolderPath: folder ".concat(folderId, " does not exist. Could not ensure defaultFolderPath. ").concat(_context9.t0.message));
+                logger.warn("ConnectionFlow.ensureDefaultFolderPath: folder ".concat(folderId, " does not exist. Could not ensure defaultFolderPath. ").concat(_context10.t0.message));
 
               case 20:
-                return _context9.abrupt("return", account);
+                return _context10.abrupt("return", account);
 
               case 21:
               case "end":
-                return _context9.stop();
+                return _context10.stop();
             }
           }
-        }, _callee9, null, [[4, 17]]);
+        }, _callee10, null, [[4, 17]]);
       }));
 
-      function ensureDefaultFolderPathInAccount(_x9, _x10) {
+      function ensureDefaultFolderPathInAccount(_x10, _x11) {
         return _ensureDefaultFolderPathInAccount.apply(this, arguments);
       }
 
@@ -1041,7 +1149,7 @@ 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 _this3 = this;
 
         var _ref5,
@@ -1051,13 +1159,13 @@ export var ConnectionFlow = /*#__PURE__*/function () {
             error,
             konnectorPolicy,
             computedAutoSuccessTimer,
-            _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:
-                _ref5 = _args10.length > 0 && _args10[0] !== undefined ? _args10[0] : {}, _ref5$autoSuccessTime = _ref5.autoSuccessTimer, autoSuccessTimer = _ref5$autoSuccessTime === void 0 ? true : _ref5$autoSuccessTime;
+                _ref5 = _args11.length > 0 && _args11[0] !== undefined ? _args11[0] : {}, _ref5$autoSuccessTime = _ref5.autoSuccessTimer, autoSuccessTimer = _ref5$autoSuccessTime === void 0 ? true : _ref5$autoSuccessTime;
                 _this$getState = this.getState(), error = _this$getState.error;
 
                 if (this.isUserActionError(error)) {
@@ -1078,15 +1186,15 @@ export var ConnectionFlow = /*#__PURE__*/function () {
                 });
 
                 if (!this.trigger) {
-                  _context10.next = 11;
+                  _context11.next = 11;
                   break;
                 }
 
-                _context10.next = 10;
+                _context11.next = 10;
                 return prepareTriggerAccount(this.client, this.trigger);
 
               case 10:
-                this.account = _context10.sent;
+                this.account = _context11.sent;
 
               case 11:
                 if (konnectorPolicy.onLaunch) {
@@ -1107,31 +1215,31 @@ export var ConnectionFlow = /*#__PURE__*/function () {
                 }
 
                 if (konnectorPolicy.needsTriggerLaunch) {
-                  _context10.next = 14;
+                  _context11.next = 14;
                   break;
                 }
 
-                return _context10.abrupt("return");
+                return _context11.abrupt("return");
 
               case 14:
                 this.realtime.subscribe('updated', ACCOUNTS_DOCTYPE, this.account._id, this.handleAccountUpdated); // @ts-ignore
 
                 logger.info("ConnectionFlow: Subscribed to ".concat(ACCOUNTS_DOCTYPE, ":").concat(this.account._id));
-                _context10.next = 18;
+                _context11.next = 18;
                 return launchTrigger(this.client, this.trigger);
 
               case 18:
-                this.job = _context10.sent;
+                this.job = _context11.sent;
                 this.watchJob({
                   autoSuccessTimer: computedAutoSuccessTimer
                 });
 
               case 20:
               case "end":
-                return _context10.stop();
+                return _context11.stop();
             }
           }
-        }, _callee10, this);
+        }, _callee11, this);
       }));
 
       function launch() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cozy-harvest-lib",
-  "version": "17.2.2",
+  "version": "17.3.0",
   "description": "Provides logic, modules and components for Cozy's harvest applications.",
   "main": "dist/index.js",
   "author": "Cozy",
@@ -112,5 +112,5 @@
     "react-router-dom": ">=4.3.1"
   },
   "sideEffects": false,
-  "gitHead": "003501e10490f2c107c8a9f081bc1be30851dc37"
+  "gitHead": "613e1fad6cdd407f406bc33b8d0683a3af7d2f7a"
 }

package/src/models/ConnectionFlow.js

@@ -72,8 +72,8 @@ const isStepEvent = eventName => stepEvents.includes(eventName)
  *
  * @param  {Object} options
  * @param  {import('cozy-client/types/types').IOCozyAccount} options.account - Existing io.cozy.account or object
- * @param  {Object} options.cipher - Vault cipher if vault has been unlocked
- * @param  {String} options.cipher.id - Vault cipher id
+ * @param  {Object} [options.cipher] - Vault cipher if vault has been unlocked
+ * @param  {String} [options.cipher.id] - Vault cipher id
  * @param  {ConnectionFlow} options.flow - Current connection flow
  * @param  {CozyClient} options.client - A CozyClient instance
  * @param  {import('cozy-client/types/types').IOCozyKonnector} options.konnector - Konnector to which the account is linked
@@ -544,6 +544,84 @@ export class ConnectionFlow {
     }
   }
 
+  /**
+   * - Creates io.cozy.accounts
+   * - Saves account
+   * - Ensures trigger is existing for account
+   */
+  async createAccountSilently(options) {
+    const { konnector, userCredentials, t } = options
+    try {
+      let { account, trigger } = options
+
+      const client = this.client
+
+      this.setState({
+        status: CREATING_ACCOUNT,
+        firstRun: true // when the user submits new authentication information, this is considered a first run
+      })
+      this.trigger = trigger
+      this.account = account
+
+      this.t = t
+
+      assert(client, 'No client')
+      const konnectorPolicy = this.getKonnectorPolicy()
+      // @ts-ignore
+      logger.log(
+        `ConnectionFlow: Handling submit, with konnector policy ${konnectorPolicy.name}`
+      )
+
+      // @ts-ignore
+      logger.info(
+        'ConnectionFlow: Bypassing cipher creation because of vault may be unlocked'
+      )
+
+      if (konnectorPolicy.needsAccountAndTriggerCreation) {
+        // @ts-ignore
+        logger.debug('ConnectionFlow: Creating/updating account...', account)
+        account = await createOrUpdateAccount({
+          account,
+          client,
+          flow: this,
+          konnector,
+          konnectorPolicy,
+          userCredentials
+        })
+
+        this.account = account
+
+        // @ts-ignore
+        logger.info(`ConnectionFlow: Saved account ${account._id}`)
+
+        // @ts-ignore
+        logger.debug('ConnectionFlow: Ensuring trigger...')
+        this.trigger = await ensureTrigger(client, {
+          trigger,
+          account,
+          konnector,
+          t
+        })
+        // @ts-ignore
+        logger.info(`Trigger is ${this.trigger._id}`)
+      }
+
+      this.setState({ accountError: null })
+    } catch (e) {
+      // @ts-ignore
+      logger.error(e)
+      this.setState({ accountError: e })
+      this.triggerEvent(ERROR_EVENT, e)
+      sentryHub.withScope(scope => {
+        scope.setTag('konnector', konnector.slug)
+
+        // Capture the original exception instead of the user one
+        sentryHub.captureException(e.original || e)
+      })
+      throw e
+    }
+  }
+
   /**
    * Ensures a trigger is created and launched
    *