passbolt-styleguide 3.5.3 → 3.6.0-beta1

package/src/react-extension/components/AccountRecovery/HandleReviewAccountRecoveryRequestWorkflow/HandleReviewAccountRecoveryRequestWorkflow.js

@@ -0,0 +1,218 @@
+/**
+ * Passbolt ~ Open source password manager for teams
+ * Copyright (c) 2022 Passbolt SA (https://www.passbolt.com)
+ *
+ * Licensed under GNU Affero General Public License version 3 of the or any later version.
+ * For full copyright and license information, please see the LICENSE.txt
+ * Redistributions of files must retain the above copyright notice.
+ *
+ * @copyright     Copyright (c) 2022 Passbolt SA (https://www.passbolt.com)
+ * @license       https://opensource.org/licenses/AGPL-3.0 AGPL License
+ * @link          https://www.passbolt.com Passbolt(tm)
+ * @since         3.6.0
+ */
+import React from "react";
+import {withTranslation} from "react-i18next";
+import PropTypes from "prop-types";
+import {withDialog} from "../../../contexts/DialogContext";
+import {withActionFeedback} from "../../../contexts/ActionFeedbackContext";
+import {withAppContext} from "../../../contexts/AppContext";
+import {withAccountRecovery} from "../../../contexts/AccountRecoveryUserContext";
+import ProvideAccountRecoveryOrganizationKey from "../../Administration/ProvideAccountRecoveryOrganizationKey/ProvideAccountRecoveryOrganizationKey";
+import ReviewAccountRecoveryRequest from "../ReviewAccountRecoveryRequest/ReviewAccountRecoveryRequest";
+import NotifyError from "../../Common/Error/NotifyError/NotifyError";
+
+/**
+ * This component handle the review account recovery workflow.
+ */
+export class HandleReviewAccountRecoveryRequestWorkflow extends React.Component {
+  /**
+   * Default constructor
+   */
+  constructor(props) {
+    super(props);
+    this.state = this.defaultState;
+    this.bindCallbacks();
+  }
+
+  /**
+   * Get default state
+   * @returns {Object}
+   */
+  get defaultState() {
+    return {
+      responseStatus: null, // The response status.
+      accountRecoveryRequest: null, // The account recovery request to assess.
+      currentOpenedDialog: null,
+    };
+  }
+
+  /**
+   * Component did mount
+   */
+  async componentDidMount() {
+    await this.props.accountRecoveryContext.findAccountRecoveryPolicy();
+    await this.getAccountRecoveryRequest();
+    await this.displayReviewAccountRecoveryDialog();
+  }
+
+  /**
+   * Get the account recovery request
+   * @returns {Promise<Object>}
+   */
+  async getAccountRecoveryRequest() {
+    let accountRecoveryRequest = this.props.accountRecoveryRequest;
+    if (!accountRecoveryRequest) {
+      accountRecoveryRequest = await this.props.context.port.request("passbolt.account-recovery.get-request", this.props.accountRecoveryRequestId);
+    }
+    this.setState({accountRecoveryRequest});
+  }
+
+  /**
+   * Binds the callbacks
+   */
+  bindCallbacks() {
+    this.handleCancelDialog = this.handleCancelDialog.bind(this);
+    this.reviewAccountRecoveryRequest = this.reviewAccountRecoveryRequest.bind(this);
+    this.handleSave = this.handleSave.bind(this);
+    this.handleError = this.handleError.bind(this);
+  }
+
+  /**
+   * Display review account recovery dialog
+   * @return {Promise<void>}
+   */
+  async displayReviewAccountRecoveryDialog() {
+    const dialogId = this.props.dialogContext.open(ReviewAccountRecoveryRequest, {
+      accountRecoveryRequest: this.state.accountRecoveryRequest,
+      onCancel: this.handleCancelDialog,
+      onSubmit: this.reviewAccountRecoveryRequest,
+    });
+    this.setState({
+      currentOpenedDialog: dialogId
+    });
+  }
+
+  /**
+   * Display provide organization key
+   */
+  displayProvideAccountRecoveryOrganizationKeyDialog() {
+    const dialogId = this.props.dialogContext.open(ProvideAccountRecoveryOrganizationKey, {
+      onCancel: this.handleCancelDialog,
+      onSubmit: this.handleSave,
+    });
+    this.setState({
+      currentOpenedDialog: dialogId
+    });
+  }
+
+  /**
+   * Handle cancel dialog
+   */
+  handleCancelDialog() {
+    this.props.onStop();
+    this.props.dialogContext.close(this.state.currentOpenedDialog);
+  }
+
+  /**
+   * Review account recovery request
+   * @param {string} responseStatus The response status. Any of "approved" or "rejected".
+   */
+  reviewAccountRecoveryRequest(responseStatus) {
+    this.setState({responseStatus});
+    if (responseStatus !== 'approved') {
+      this.handleSave();
+    } else {
+      this.displayProvideAccountRecoveryOrganizationKeyDialog();
+    }
+  }
+
+  /**
+   * Handle the approved of a review request account recovery with the ORK.
+   * @param {Object|null} privateGpgKeyDto the private ORK given by the admin if any.
+   */
+  async handleSave(privateGpgKeyDto) {
+    try {
+      await this.props.context.port.request('passbolt.account-recovery.review-request', this.state.accountRecoveryRequest.id, this.state.responseStatus, privateGpgKeyDto);
+      await this.props.actionFeedbackContext.displaySuccess(this.translate("The account recovery review has been saved successfully"));
+      this.props.onStop();
+    } catch (e) {
+      if (e.name === "UserAbortsOperationError") {
+        // It can happen when the user has closed the passphrase entry dialog by instance.
+        return;
+      }
+      console.log(e);
+      this.handleError(e);
+    }
+  }
+
+  /**
+   * Handle an unexpected error
+   * @param error
+   * @returns {Promise<void>}
+   */
+  async handleError(error) {
+    const errorDialogProps = {
+      error: error
+    };
+    this.props.dialogContext.open(NotifyError, errorDialogProps);
+    this.props.onStop();
+    this.props.dialogContext.close(this.state.currentOpenedDialog);
+  }
+
+  /**
+   * Get the translate function
+   * @returns {function(...[*]=)}
+   */
+  get translate() {
+    return this.props.t;
+  }
+
+  /**
+   * Renders the component
+   * @returns {JSX.Element}
+   */
+  render() {
+    return <></>;
+  }
+}
+
+/**
+ * Assert that at least one of the account recovery request props is defined
+ * @param {object} props The props
+ * @param {string} propName The asserted prop
+ * @param {string} componentName The component name
+ * @returns {Error}
+ */
+const requiredAccountRecoveryProp = (props, propName, componentName) => {
+  if (!props.accountRecoveryRequestId && !props.accountRecoveryRequest) {
+    return new Error(`One of 'accountRecoveryRequestId' or 'accountRecoveryRequest' is required by '${componentName}' component.`);
+  }
+  if (props.accountRecoveryRequestId) {
+    PropTypes.checkPropTypes({
+      accountRecoveryRequestId: PropTypes.string,
+    }, props,
+    propName,
+    componentName);
+  }
+  if (props.accountRecoveryRequest) {
+    PropTypes.checkPropTypes({
+      accountRecoveryRequestId: PropTypes.object,
+    }, props,
+    propName,
+    componentName);
+  }
+};
+
+HandleReviewAccountRecoveryRequestWorkflow.propTypes = {
+  onStop: PropTypes.func.isRequired, // The callback to stop the workflow
+  dialogContext: PropTypes.any, // The dialog context
+  actionFeedbackContext: PropTypes.object, // the admin action feedback context
+  accountRecoveryContext: PropTypes.object, // The account recovery context
+  context: PropTypes.object, // the app context
+  accountRecoveryRequestId: requiredAccountRecoveryProp, // The account recovery request id
+  accountRecoveryRequest: requiredAccountRecoveryProp, // The account recovery request
+  t: PropTypes.func // the translation function
+};
+
+export default withAppContext(withAccountRecovery(withDialog(withActionFeedback(withTranslation("common")(HandleReviewAccountRecoveryRequestWorkflow)))));

package/src/react-extension/components/AccountRecovery/HandleReviewAccountRecoveryRequestWorkflow/HandleReviewAccountRecoveryRequestWorkflow.test.data.js

@@ -0,0 +1,49 @@
+/**
+ * Passbolt ~ Open source password manager for teams
+ * Copyright (c) 2022 Passbolt SA (https://www.passbolt.com)
+ *
+ * Licensed under GNU Affero General Public License version 3 of the or any later version.
+ * For full copyright and license information, please see the LICENSE.txt
+ * Redistributions of files must retain the above copyright notice.
+ *
+ * @copyright     Copyright (c) 2022 Passbolt SA (https://www.passbolt.com)
+ * @license       https://opensource.org/licenses/AGPL-3.0 AGPL License
+ * @link          https://www.passbolt.com Passbolt(tm)
+ * @since         3.6.0
+ */
+
+import {v4 as uuidv4} from "uuid";
+import {defaultDialogContext} from "../../../contexts/DialogContext.test.data";
+import {defaultAppContext} from "../../../contexts/ExtAppContext.test.data";
+import {defaultActionFeedbackContextContext} from "../../../contexts/ActionFeedbackContext.test.data";
+
+/**
+ * Default props
+ * @param {Object} props The override
+ * @returns {object}
+ */
+export function defaultProps(props = {}) {
+  const _props = {
+    accountRecoveryRequestId: uuidv4(),
+    accountRecoveryContext: {
+      findAccountRecoveryPolicy: jest.fn(),
+      getOrganizationPolicy: jest.fn(),
+      accountRecoveryOrganizationPolicy: {
+        account_recovery_organization_public_key: {
+          id: uuidv4()
+        }
+      }
+    },
+    actionFeedbackContext: defaultActionFeedbackContextContext(props?.actionFeedbackContext),
+    context: defaultAppContext(props?.context),
+    dialogContext: defaultDialogContext(props?.dialogContext),
+    onStop: jest.fn(),
+    t: text => text
+  };
+  delete props?.adminAccountRecoveryContext; // Treated in the default
+  delete props?.adminAccountRecoveryContext; // Treated in the default
+  delete props?.context; // Treated in the default
+  delete props?.dialogContext; // Treated in the default
+  return Object.assign(_props, props);
+}
+

package/src/react-extension/components/AccountRecovery/HandleReviewAccountRecoveryRequestWorkflow/HandleReviewAccountRecoveryRequestWorkflow.test.js

@@ -0,0 +1,98 @@
+/**
+ * Passbolt ~ Open source password manager for teams
+ * Copyright (c) 2022 Passbolt SA (https://www.passbolt.com)
+ *
+ * Licensed under GNU Affero General Public License version 3 of the or any later version.
+ * For full copyright and license information, please see the LICENSE.txt
+ * Redistributions of files must retain the above copyright notice.
+ *
+ * @copyright     Copyright (c) 2022 Passbolt SA (https://www.passbolt.com)
+ * @license       https://opensource.org/licenses/AGPL-3.0 AGPL License
+ * @link          https://www.passbolt.com Passbolt(tm)
+ * @since         3.6.0
+ */
+
+import {waitFor} from "@testing-library/react";
+import {v4 as uuidv4} from "uuid";
+import {defaultProps} from "./HandleReviewAccountRecoveryRequestWorkflow.test.data";
+import HandleReviewAccountRecoveryRequestWorkflowTestPage from "./HandleReviewAccountRecoveryRequestWorkflow.test.page";
+import ReviewAccountRecovery from "../ReviewAccountRecoveryRequest/ReviewAccountRecoveryRequest";
+import ProvideAccountRecoveryOrganizationKey from "../../Administration/ProvideAccountRecoveryOrganizationKey/ProvideAccountRecoveryOrganizationKey";
+
+describe("HandleReviewAccountRecoveryRequestWorkflow", () => {
+  let page, props, accountRecoveryRequest;
+
+  beforeEach(async() => {
+    props = defaultProps();
+    accountRecoveryRequest = {id: uuidv4()};
+    props.context.port.request = jest.fn(() => accountRecoveryRequest);
+    page = new HandleReviewAccountRecoveryRequestWorkflowTestPage(props);
+    await waitFor(() => {});
+  });
+
+  describe('As AD I should complete an authentication setup', () => {
+    it('As AD I should start with the review account recovery process with an account recovery request id', async() => {
+      expect.assertions(1);
+      const accountRecoveryReviewProps = {
+        accountRecoveryRequest: accountRecoveryRequest,
+        onCancel: page._instance.handleCancelDialog,
+        onSubmit: page._instance.reviewAccountRecoveryRequest,
+      };
+      expect(props.dialogContext.open).toHaveBeenCalledWith(ReviewAccountRecovery, accountRecoveryReviewProps);
+    });
+
+    it('As AD I should start with the review account recovery process with an account recovery request (when an admin follow an email link, the route handler load the request and pass it to the workflow)', async() => {
+      accountRecoveryRequest = {id: uuidv4()};
+      props = defaultProps({accountRecoveryRequest});
+      page = new HandleReviewAccountRecoveryRequestWorkflowTestPage(props);
+      await waitFor(() => {});
+
+      expect.assertions(1);
+      const accountRecoveryReviewProps = {
+        accountRecoveryRequest: accountRecoveryRequest,
+        onCancel: page._instance.handleCancelDialog,
+        onSubmit: page._instance.reviewAccountRecoveryRequest,
+      };
+      expect(props.dialogContext.open).toHaveBeenCalledWith(ReviewAccountRecovery, accountRecoveryReviewProps);
+    });
+
+    it('As AD I can approved the review account recovery', async() => {
+      expect.assertions(1);
+      const status = "approved";
+      page._instance.reviewAccountRecoveryRequest(status);
+      const provideOrganizationKeyProps = {
+        onCancel: page._instance.handleCancelDialog,
+        onSubmit: page._instance.handleSave,
+      };
+      expect(props.dialogContext.open).toHaveBeenNthCalledWith(2, ProvideAccountRecoveryOrganizationKey, provideOrganizationKeyProps);
+    });
+
+    it('As AD I can reject the review account recovery', async() => {
+      expect.assertions(2);
+      const status = "rejected";
+      page._instance.reviewAccountRecoveryRequest(status);
+      await waitFor(() => {});
+      expect(props.actionFeedbackContext.displaySuccess).toHaveBeenCalledWith('The account recovery review has been saved successfully');
+      expect(props.onStop).toHaveBeenCalled();
+    });
+
+    it('As AD I can provide the ORK', async() => {
+      expect.assertions(3);
+      const privateGpgKeyDto = {
+        armored_key: 'private gpg key',
+        passphrase: 'passphrase'
+      };
+      await page._instance.handleSave(privateGpgKeyDto);
+      expect(props.context.port.request).toHaveBeenCalledWith("passbolt.account-recovery.review-request", accountRecoveryRequest.id, null, {"armored_key": "private gpg key", "passphrase": "passphrase"});
+      await waitFor(() => {});
+      expect(props.actionFeedbackContext.displaySuccess).toHaveBeenCalledWith('The account recovery review has been saved successfully');
+      expect(props.onStop).toHaveBeenCalled();
+    });
+
+    it('As AD I can cancel the review account recovery workflow', async() => {
+      expect.assertions(1);
+      await page._instance.handleCancelDialog();
+      expect(props.onStop).toHaveBeenCalled();
+    });
+  });
+});

package/src/react-extension/components/AccountRecovery/HandleReviewAccountRecoveryRequestWorkflow/HandleReviewAccountRecoveryRequestWorkflow.test.page.js

@@ -0,0 +1,37 @@
+/**
+ * Passbolt ~ Open source password manager for teams
+ * Copyright (c) 2022 Passbolt SA (https://www.passbolt.com)
+ *
+ * Licensed under GNU Affero General Public License version 3 of the or any later version.
+ * For full copyright and license information, please see the LICENSE.txt
+ * Redistributions of files must retain the above copyright notice.
+ *
+ * @copyright     Copyright (c) 2022 Passbolt SA (https://www.passbolt.com)
+ * @license       https://opensource.org/licenses/AGPL-3.0 AGPL License
+ * @link          https://www.passbolt.com Passbolt(tm)
+ * @since         3.6.0
+ */
+
+import {render} from "@testing-library/react";
+import React from "react";
+import MockTranslationProvider from "../../../test/mock/components/Internationalisation/MockTranslationProvider";
+import {HandleReviewAccountRecoveryRequestWorkflow} from "./HandleReviewAccountRecoveryRequestWorkflow";
+
+/**
+ * The HandleSaveAccountRecovery component represented as a page
+ */
+export default class HandleReviewAccountRecoveryRequestWorkflowTestPage {
+  /**
+   * Default constructor
+   * @param props Props to attach
+   */
+  constructor(props) {
+    this._page = render(
+      <MockTranslationProvider>
+        <HandleReviewAccountRecoveryRequestWorkflow {...props} ref={node => {
+          this._instance = node;
+        }}/>
+      </MockTranslationProvider>
+    );
+  }
+}