cozy-harvest-lib 9.0.0 → 9.2.0

package/CHANGELOG.md

@@ -3,6 +3,53 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [9.2.0](https://github.com/cozy/cozy-libs/compare/cozy-harvest-lib@9.1.2...cozy-harvest-lib@9.2.0) (2022-05-09)
+
+
+### Features
+
+* Add BI connection creation via BI webview ([35ea078](https://github.com/cozy/cozy-libs/commit/35ea07805b5604d7882051bc0f7b43b38516922f))
+* Unit tests + comments ([93e960e](https://github.com/cozy/cozy-libs/commit/93e960ee3236df742b8665d4d79cf6cf675d4f8f))
+
+
+
+
+
+## 9.1.2 (2022-05-05)
+
+**Note:** Version bump only for package cozy-harvest-lib
+
+
+
+
+
+## [9.1.1](https://github.com/cozy/cozy-libs/compare/cozy-harvest-lib@9.1.0...cozy-harvest-lib@9.1.1) (2022-05-02)
+
+
+### Bug Fixes
+
+* bump form-data from 3.0.0 to 4.0.0 ([0a8546f](https://github.com/cozy/cozy-libs/commit/0a8546f2712a8164ff2bd08dfb60230bf97e1b85))
+
+
+
+
+
+# [9.1.0](https://github.com/cozy/cozy-libs/compare/cozy-harvest-lib@9.0.0...cozy-harvest-lib@9.1.0) (2022-05-02)
+
+
+### Bug Fixes
+
+* Multiple fixes after review ([0351500](https://github.com/cozy/cozy-libs/commit/0351500e1845df6ef4a31211aec6061090ccf66e))
+
+
+### Features
+
+* Open InAppBrowser via cozy-intent when in flaghip app ([5ee31ea](https://github.com/cozy/cozy-libs/commit/5ee31eafcb62e23a6242386bb6b09312f778e871))
+
+
+
+
+
 # [9.0.0](https://github.com/cozy/cozy-libs/compare/cozy-harvest-lib@8.4.3...cozy-harvest-lib@9.0.0) (2022-04-29)
 
 

package/dist/components/InAppBrowser.js

@@ -0,0 +1,65 @@
+import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
+import _regeneratorRuntime from "@babel/runtime/regenerator";
+import { useEffect } from 'react';
+import PropTypes from 'prop-types';
+import { useWebviewIntent } from 'cozy-intent';
+import logger from '../logger';
+
+var InAppBrowser = function InAppBrowser(_ref) {
+  var url = _ref.url,
+      onClose = _ref.onClose;
+  var webviewIntent = useWebviewIntent();
+  useEffect(function () {
+    function insideEffect() {
+      return _insideEffect.apply(this, arguments);
+    }
+
+    function _insideEffect() {
+      _insideEffect = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee() {
+        var result;
+        return _regeneratorRuntime.wrap(function _callee$(_context) {
+          while (1) {
+            switch (_context.prev = _context.next) {
+              case 0:
+                if (!webviewIntent) {
+                  _context.next = 5;
+                  break;
+                }
+
+                _context.next = 3;
+                return webviewIntent.call('showInAppBrowser', {
+                  url: url
+                });
+
+              case 3:
+                result = _context.sent;
+
+                if ((result === null || result === void 0 ? void 0 : result.type) === 'cancel' && onClose) {
+                  onClose();
+                } else if ((result === null || result === void 0 ? void 0 : result.type) !== 'dismiss') {
+                  logger.error('Unexpected InAppBrowser result', result);
+                }
+
+              case 5:
+              case "end":
+                return _context.stop();
+            }
+          }
+        }, _callee);
+      }));
+      return _insideEffect.apply(this, arguments);
+    }
+
+    insideEffect();
+    return function cleanup() {
+      webviewIntent.call('closeInAppBrowser');
+    };
+  }, [webviewIntent, url, onClose]);
+  return null;
+};
+
+InAppBrowser.propTypes = {
+  url: PropTypes.string.isRequired,
+  onClose: PropTypes.func
+};
+export default InAppBrowser;

package/dist/components/InAppBrowser.spec.js

@@ -0,0 +1,104 @@
+import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
+import _regeneratorRuntime from "@babel/runtime/regenerator";
+import React from 'react';
+import { render, waitFor } from '@testing-library/react';
+import InAppBrowser from './InAppBrowser';
+import { WebviewIntentProvider } from 'cozy-intent';
+describe('InAppBrowser', function () {
+  it('should call showInAppBrowser', /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee() {
+    var url, intentCall, webviewService;
+    return _regeneratorRuntime.wrap(function _callee$(_context) {
+      while (1) {
+        switch (_context.prev = _context.next) {
+          case 0:
+            url = 'https://test.url';
+            intentCall = jest.fn();
+            webviewService = {
+              call: intentCall
+            };
+            intentCall.mockResolvedValue({
+              type: 'dismiss'
+            });
+            render( /*#__PURE__*/React.createElement(WebviewIntentProvider, {
+              webviewService: webviewService
+            }, /*#__PURE__*/React.createElement(InAppBrowser, {
+              url: url
+            })));
+            expect(webviewService.call).toHaveBeenNthCalledWith(1, 'showInAppBrowser', {
+              url: url
+            });
+
+          case 6:
+          case "end":
+            return _context.stop();
+        }
+      }
+    }, _callee);
+  })));
+  it('should call onClose when user closes the inAppBrowser in app', /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee2() {
+    var url, intentCall, webviewService, onClose;
+    return _regeneratorRuntime.wrap(function _callee2$(_context2) {
+      while (1) {
+        switch (_context2.prev = _context2.next) {
+          case 0:
+            url = 'https://test.url';
+            intentCall = jest.fn();
+            webviewService = {
+              call: intentCall
+            };
+            onClose = jest.fn();
+            intentCall.mockResolvedValue({
+              type: 'cancel'
+            });
+            render( /*#__PURE__*/React.createElement(WebviewIntentProvider, {
+              webviewService: webviewService
+            }, /*#__PURE__*/React.createElement(InAppBrowser, {
+              url: url,
+              onClose: onClose
+            })));
+            _context2.next = 8;
+            return waitFor(function () {
+              return expect(onClose).toHaveBeenCalledTimes(1);
+            });
+
+          case 8:
+            expect(onClose).toHaveBeenCalledWith();
+
+          case 9:
+          case "end":
+            return _context2.stop();
+        }
+      }
+    }, _callee2);
+  })));
+  it('should call closeInAppBrowser when the component is unmounted', /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee3() {
+    var url, intentCall, webviewService, _render, unmount;
+
+    return _regeneratorRuntime.wrap(function _callee3$(_context3) {
+      while (1) {
+        switch (_context3.prev = _context3.next) {
+          case 0:
+            url = 'https://test.url';
+            intentCall = jest.fn();
+            webviewService = {
+              call: intentCall
+            };
+            intentCall.mockResolvedValue({
+              type: 'dismiss'
+            });
+            _render = render( /*#__PURE__*/React.createElement(WebviewIntentProvider, {
+              webviewService: webviewService
+            }, /*#__PURE__*/React.createElement(InAppBrowser, {
+              url: url
+            }))), unmount = _render.unmount;
+            unmount();
+            expect(webviewService.call).toHaveBeenNthCalledWith(2, 'closeInAppBrowser');
+
+          case 7:
+          case "end":
+            return _context3.stop();
+        }
+      }
+    }, _callee3);
+  })));
+});

package/dist/components/OAuthWindow.js

@@ -15,9 +15,11 @@ import PropTypes from 'prop-types';
 import { withClient } from 'cozy-client';
 import { translate } from 'cozy-ui/transpiled/react/I18n';
 import CozyRealtime from 'cozy-realtime';
+import { isFlagshipApp } from 'cozy-device-helper';
 import { prepareOAuth, checkOAuthData, terminateOAuth, OAUTH_REALTIME_CHANNEL } from '../helpers/oauth'; // TODO use PopUp from cozy-ui
 
 import Popup from './Popup';
+import InAppBrowser from './InAppBrowser';
 var OAUTH_POPUP_HEIGHT = 800;
 var OAUTH_POPUP_WIDTH = 800;
 /**
@@ -177,14 +179,17 @@ export var OAuthWindow = /*#__PURE__*/function (_PureComponent) {
       var _this$state = this.state,
           oAuthUrl = _this$state.oAuthUrl,
           succeed = _this$state.succeed;
-      return oAuthUrl && !succeed && /*#__PURE__*/React.createElement(Popup, {
+      return oAuthUrl && !succeed && (!isFlagshipApp() ? /*#__PURE__*/React.createElement(Popup, {
         url: oAuthUrl,
         height: OAUTH_POPUP_HEIGHT,
         width: OAUTH_POPUP_WIDTH,
         onClose: this.handleClose,
         onUrlChange: this.handleUrlChange,
         title: t("oauth.window.title")
-      });
+      }) : /*#__PURE__*/React.createElement(InAppBrowser, {
+        url: oAuthUrl,
+        onClose: this.handleClose
+      }));
     }
   }]);
 

package/dist/components/TriggerManager.js

@@ -522,8 +522,9 @@ export var DumbTriggerManager = /*#__PURE__*/function (_Component) {
       var showSpinner = submitting && selectedCipher && step === 'ciphersList';
       var showCiphersList = step === 'ciphersList';
       var showAccountForm = step === 'accountForm';
+      var konnectorPolicy = findKonnectorPolicy(konnector);
 
-      if (oauth) {
+      if (oauth || konnectorPolicy.isBIWebView) {
         return /*#__PURE__*/React.createElement(OAuthForm, {
           client: client,
           flow: flow,

package/dist/helpers/oauth.js

@@ -88,7 +88,7 @@ export var handleOAuthResponse = function handleOAuthResponse() {
  * @param  {string} cozyUrl cozy url
  * @param  {string} accountType connector slug
  * @param  {string} oAuthStateKey localStorage key
- * @param  {Object} oAuthConf connector manifest oauth configuration
+ * @param  {Object} [oAuthConf={}]  connector manifest oauth configuration
  * @param  {string} redirectSlug The app we want to redirect the user on after the end of the flow
  * @param  {string} nonce unique nonce string
  * @param  {Object} extraParams some extra parameters to add to the query string
@@ -98,7 +98,8 @@ export var getOAuthUrl = function getOAuthUrl(_ref) {
   var cozyUrl = _ref.cozyUrl,
       accountType = _ref.accountType,
       oAuthStateKey = _ref.oAuthStateKey,
-      oAuthConf = _ref.oAuthConf,
+      _ref$oAuthConf = _ref.oAuthConf,
+      oAuthConf = _ref$oAuthConf === void 0 ? {} : _ref$oAuthConf,
       nonce = _ref.nonce,
       redirectSlug = _ref.redirectSlug,
       extraParams = _ref.extraParams;

package/dist/konnector-policies.js

@@ -1,5 +1,6 @@
 import logger from './logger';
 import { konnectorPolicy as biKonnectorPolicy } from './services/budget-insight';
+import { konnectorPolicy as biWebViewPolicy } from './services/biWebView';
 var defaultKonnectorPolicy = {
   accountContainsAuth: true,
   saveInVault: true,
@@ -9,7 +10,7 @@ var defaultKonnectorPolicy = {
   },
   name: 'default'
 };
-var policies = [biKonnectorPolicy, defaultKonnectorPolicy].filter(Boolean);
+var policies = [biWebViewPolicy, biKonnectorPolicy, defaultKonnectorPolicy].filter(Boolean);
 logger.info('Available konnector policies', policies);
 export var findKonnectorPolicy = function findKonnectorPolicy(konnector) {
   var policy = policies.find(function (policy) {

package/dist/services/biWebView.js

@@ -0,0 +1,271 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
+import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
+var _excluded = ["code"];
+
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+
+import _regeneratorRuntime from "@babel/runtime/regenerator";
+
+/**
+ * Interface between Budget Insight and Cozy using BI's webview
+ *
+ * - Deals with the konnector to get temporary tokens
+ */
+import { getBIConnection } from './bi-http';
+import assert from '../assert';
+import logger from '../logger';
+import flag from 'cozy-flags';
+import { fetchExtraOAuthUrlParams, createTemporaryToken, setBIConnectionId, saveBIConfig, findAccountWithBiConnection, convertBIErrortoKonnectorJobError, isBudgetInsightConnector } from './budget-insight';
+import { KonnectorJobError } from '../helpers/konnectors';
+export var isBiWebViewConnector = function isBiWebViewConnector(konnector) {
+  return flag('harvest.bi.webview') && isBudgetInsightConnector(konnector);
+};
+/**
+ * Runs multiple checks on the bi connection referenced in the given account
+ *
+ * @param {io.cozy.accounts} options.account The account content
+ * @param {ConnectionFlow} options.flow
+ * @param {io.cozy.konnectors} options.konnector connector manifest content
+ * @param {CozyClient} options.client CozyClient object
+ *
+ * @return {Integer} Connection Id
+ */
+
+export var checkBIConnection = /*#__PURE__*/function () {
+  var _ref2 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(_ref) {
+    var account, client, konnector, flow, connId, biConfig, tempToken, config, connection, sameAccount, err;
+    return _regeneratorRuntime.wrap(function _callee$(_context) {
+      while (1) {
+        switch (_context.prev = _context.next) {
+          case 0:
+            account = _ref.account, client = _ref.client, konnector = _ref.konnector, flow = _ref.flow;
+            _context.prev = 1;
+            connId = getWebviewBIConnectionId(account);
+            logger.info('Creating temporary token...');
+            _context.next = 6;
+            return createTemporaryToken({
+              client: client,
+              konnector: konnector,
+              account: account
+            });
+
+          case 6:
+            biConfig = _context.sent;
+            saveBIConfig(flow, biConfig);
+            tempToken = biConfig.code, config = _objectWithoutProperties(biConfig, _excluded);
+            logger.info('Created temporary token');
+            assert(tempToken, 'No temporary token');
+            logger.info("fetch connection ".concat(connId, "..."));
+            _context.next = 14;
+            return getBIConnection(config, connId, tempToken);
+
+          case 14:
+            connection = _context.sent;
+            _context.next = 17;
+            return findAccountWithBiConnection({
+              client: client,
+              konnector: konnector,
+              connectionId: connection.id
+            });
+
+          case 17:
+            sameAccount = _context.sent;
+
+            if (!sameAccount) {
+              _context.next = 22;
+              break;
+            }
+
+            err = new KonnectorJobError('ACCOUNT_WITH_SAME_IDENTIFIER_ALREADY_DEFINED');
+            err.accountId = sameAccount._id;
+            throw err;
+
+          case 22:
+            return _context.abrupt("return", connection);
+
+          case 25:
+            _context.prev = 25;
+            _context.t0 = _context["catch"](1);
+            return _context.abrupt("return", convertBIErrortoKonnectorJobError(_context.t0));
+
+          case 28:
+          case "end":
+            return _context.stop();
+        }
+      }
+    }, _callee, null, [[1, 25]]);
+  }));
+
+  return function checkBIConnection(_x) {
+    return _ref2.apply(this, arguments);
+  };
+}();
+/**
+ * Handles webview connection
+ *
+ * @param {io.cozy.accounts} options.account The account content
+ * @param {ConnectionFlow} options.flow
+ * @param {io.cozy.konnectors} options.konnector connector manifest content
+ * @param {CozyClient} options.client CozyClient object
+ *
+ * @return {Integer} Connection Id
+ */
+
+export var handleOAuthAccount = /*#__PURE__*/function () {
+  var _ref4 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee2(_ref3) {
+    var account, flow, konnector, client, t, cozyBankId, biWebviewAccount, connectionId;
+    return _regeneratorRuntime.wrap(function _callee2$(_context2) {
+      while (1) {
+        switch (_context2.prev = _context2.next) {
+          case 0:
+            account = _ref3.account, flow = _ref3.flow, konnector = _ref3.konnector, client = _ref3.client, t = _ref3.t;
+            cozyBankId = getCozyBankId({
+              konnector: konnector,
+              account: account
+            });
+            biWebviewAccount = _objectSpread(_objectSpread({}, account), cozyBankId ? {
+              auth: {
+                bankId: cozyBankId
+              }
+            } : {});
+            connectionId = getWebviewBIConnectionId(biWebviewAccount);
+
+            if (!connectionId) {
+              _context2.next = 12;
+              break;
+            }
+
+            logger.info("Found a BI webview connection id: ".concat(connectionId));
+            flow.konnector = konnector;
+            _context2.next = 9;
+            return flow.saveAccount(setBIConnectionId(biWebviewAccount, connectionId));
+
+          case 9:
+            biWebviewAccount = _context2.sent;
+            _context2.next = 12;
+            return flow.handleFormSubmit({
+              client: client,
+              account: biWebviewAccount,
+              konnector: konnector,
+              t: t
+            });
+
+          case 12:
+            return _context2.abrupt("return", connectionId);
+
+          case 13:
+          case "end":
+            return _context2.stop();
+        }
+      }
+    }, _callee2);
+  }));
+
+  return function handleOAuthAccount(_x2) {
+    return _ref4.apply(this, arguments);
+  };
+}();
+/**
+ * Gets BI webview connection id which is returned in the account by the stack
+ * via oauth callback url
+ *
+ * @param {io.cozy.accounts} The account content created by the stack
+ *
+ * @return {Integer} Connection Id
+ */
+
+var getWebviewBIConnectionId = function getWebviewBIConnectionId(account) {
+  var _account$oauth, _account$oauth$query, _account$oauth$query$;
+
+  return Number((account === null || account === void 0 ? void 0 : (_account$oauth = account.oauth) === null || _account$oauth === void 0 ? void 0 : (_account$oauth$query = _account$oauth.query) === null || _account$oauth$query === void 0 ? void 0 : (_account$oauth$query$ = _account$oauth$query.connection_id) === null || _account$oauth$query$ === void 0 ? void 0 : _account$oauth$query$[0]) || null);
+};
+/**
+ * Hook from ConnectionFlow after account creation
+ *
+ * @param {io.cozy.accounts} options.account - created account
+ * @param {io.cozy.konnectors} options.konnector  - manifest of the konnector for which the account is created
+ * @param {ConnectionFlow} options.flow - current ConnectionFlow instance
+ * @param {CozyClient} options.client - current CozyClient instance
+ *
+ * @returns {Promise<io.cozy.accounts>}
+ */
+
+
+export var onBIAccountCreation = /*#__PURE__*/function () {
+  var _ref6 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee3(_ref5) {
+    var fullAccount, client, flow, konnector, account, biConnection;
+    return _regeneratorRuntime.wrap(function _callee3$(_context3) {
+      while (1) {
+        switch (_context3.prev = _context3.next) {
+          case 0:
+            fullAccount = _ref5.account, client = _ref5.client, flow = _ref5.flow, konnector = _ref5.konnector;
+            _context3.next = 3;
+            return flow.saveAccount(fullAccount);
+
+          case 3:
+            account = _context3.sent;
+            _context3.next = 6;
+            return checkBIConnection({
+              account: _objectSpread(_objectSpread({}, fullAccount), {}, {
+                _id: account._id
+              }),
+              client: client,
+              konnector: konnector,
+              flow: flow
+            });
+
+          case 6:
+            biConnection = _context3.sent;
+            flow.setData({
+              biConnection: biConnection
+            });
+            _context3.next = 10;
+            return flow.saveAccount(setBIConnectionId(account, biConnection.id));
+
+          case 10:
+            return _context3.abrupt("return", _context3.sent);
+
+          case 11:
+          case "end":
+            return _context3.stop();
+        }
+      }
+    }, _callee3);
+  }));
+
+  return function onBIAccountCreation(_x3) {
+    return _ref6.apply(this, arguments);
+  };
+}();
+/**
+ * Finds the current bankIid in a given konnector or account
+ *
+ * @param {io.cozy.accounts} options.account The account content
+ * @param {io.cozy.konnectors} options.konnector connector manifest content
+ */
+
+export var getCozyBankId = function getCozyBankId(_ref7) {
+  var _konnector$parameters, _account$auth;
+
+  var konnector = _ref7.konnector,
+      account = _ref7.account;
+  var cozyBankId = (konnector === null || konnector === void 0 ? void 0 : (_konnector$parameters = konnector.parameters) === null || _konnector$parameters === void 0 ? void 0 : _konnector$parameters.bankId) || (account === null || account === void 0 ? void 0 : (_account$auth = account.auth) === null || _account$auth === void 0 ? void 0 : _account$auth.bankId);
+
+  if (!cozyBankId) {
+    logger.error('Could not find any bank id');
+  }
+
+  return cozyBankId;
+};
+export var konnectorPolicy = {
+  isBIWebView: true,
+  name: 'budget-insight-webview',
+  match: isBiWebViewConnector,
+  saveInVault: false,
+  onAccountCreation: onBIAccountCreation,
+  fetchExtraOAuthUrlParams: fetchExtraOAuthUrlParams,
+  handleOAuthAccount: handleOAuthAccount
+};