Merge pull request #1129 from fabmiz/ENG-2083/drafts-contrib-list

[ENG-2083] Allow contributors to remove themselves from draft registrations

Author: fabmiz

app/adapters/contributor.ts

@@ -1,3 +1,4 @@
+import { assert } from '@ember/debug';
 import { inject as service } from '@ember/service';
 import DS from 'ember-data';
 
@@ -15,18 +16,27 @@ export default class ContributorAdapter extends OsfAdapter {
  requestType: string,
  ) {
  if (requestType === 'createRecord' || requestType === 'findRecord') {
- const [nId, uId] = (id || '').split('-');
- const nodeId = snapshot ? snapshot.record.get('nodeId') : nId;
+ let userId;
+ let nodeId;
+
+ if (requestType === 'findRecord') {
+ [nodeId, userId] = (id || '').split('-');
+ assert(`"contributorId" must be "nodeId-userId": got ${nodeId}-${userId}`, Boolean(nodeId && userId));
+ } else {
+ nodeId = snapshot.record.get('nodeId');
+ assert(`"nodeId" is required to create a contributor; got ${nodeId}`, Boolean(nodeId));
+ }
+
  const node = this.store.peekRecord('node', nodeId);
 
  if (!node) {
  throw new Error('Trying to add a contributor to a Node that hasn\'t been loaded into the store');
  }
 
- const base = this.buildRelationshipURL((node as any)._internalModel.createSnapshot(), 'contributors');
+ const baseUrl = this.buildRelationshipURL((node as any)._internalModel.createSnapshot(), 'contributors');
 
  if (requestType === 'findRecord') {
- return `${base}${uId}/`;
+ return `${baseUrl}${userId}/`;
  }
 
  const params = {
@@ -35,7 +45,7 @@ export default class ContributorAdapter extends OsfAdapter {
  send_email: snapshot ? (snapshot.record.get('sendEmail') || false) : true,
  };
 
- return `${base}?${param(params)}`;
+ return `${baseUrl}?${param(params)}`;
  }
 
  return super.buildURL(modelName, id, snapshot, requestType);

lib/osf-components/addon/components/contributor-list/component.ts

@@ -1,16 +1,22 @@
 import { tagName } from '@ember-decorators/component';
 import Component from '@ember/component';
-import { computed } from '@ember/object';
+import { action, computed } from '@ember/object';
 import { alias } from '@ember/object/computed';
 import { inject as service } from '@ember/service';
-import { task } from 'ember-concurrency-decorators';
+import { dropTask, task } from 'ember-concurrency-decorators';
 import DS from 'ember-data';
+import config from 'ember-get-config';
+import Intl from 'ember-intl/services/intl';
+import Toast from 'ember-toastr/services/toast';
 
+import RouterService from '@ember/routing/router-service';
 import { layout } from 'ember-osf-web/decorators/component';
 import Contributor from 'ember-osf-web/models/contributor';
 import Node from 'ember-osf-web/models/node';
 import { QueryHasManyResult } from 'ember-osf-web/models/osf-model';
+import CurrentUser from 'ember-osf-web/services/current-user';
 import Ready from 'ember-osf-web/services/ready';
+import captureException from 'ember-osf-web/utils/capture-exception';
 import defaultTo from 'ember-osf-web/utils/default-to';
 
 import styles from './styles';
@@ -26,14 +32,19 @@ export default class ContributorList extends Component {
  shouldTruncate: boolean = defaultTo(this.shouldTruncate, true);
  shouldLinkUsers: boolean = defaultTo(this.shouldLinkUsers, false);
  shouldEnableClaimUser: boolean = false;
+ allowRemoveMe: boolean = false;
 
  // Private properties
  @service store!: DS.Store;
  @service ready!: Ready;
+ @service toast!: Toast;
+ @service intl!: Intl;
+ @service currentUser!: CurrentUser;
+ @service router!: RouterService;
 
  page = 1;
  displayedContributors: Contributor[] = [];
- totalContributors?: number;
+ totalContributors = 0;
  shouldLoadAll: boolean = navigator.userAgent.includes('Prerender');
 
  @alias('loadContributors.isRunning')
@@ -71,6 +82,46 @@ export default class ContributorList extends Component {
  blocker.done();
  });
 
+ @dropTask({ withTestWaiter: true })
+ removeMeTask = task(function *(this: ContributorList) {
+ if (!this.node || this.node.isAnonymous || !this.currentUser.currentUserId) {
+ return;
+ }
+
+ const userID = this.currentUser.currentUserId;
+ let contributor = this.displayedContributors
+ .find(contrib => contrib.users.get('id') === this.currentUser.currentUserId);
+
+ if (!contributor) {
+ contributor = yield this.store.findRecord('contributor', `${this.node.id}-${userID}`);
+ this.setProperties({
+ displayedContributors: [...this.displayedContributors, contributor],
+ });
+ }
+
+ try {
+ yield contributor!.destroyRecord();
+ this.toast.success(this.intl.t('contributor_list.remove_contributor.success'));
+ this.router.transitionTo('home');
+ } catch (e) {
+ const { supportEmail } = config.support;
+ const errorMessage = this.intl
+ .t('contributor_list.remove_contributor.error', { supportEmail, htmlSafe: true });
+ captureException(e, { errorMessage });
+ this.toast.error(errorMessage);
+ }
+ });
+
+ @action
+ removeMe() {
+ this.removeMeTask.perform();
+ }
+
+ @computed('allowRemoveMe', 'currentUser.currentUserId', 'totalContributors')
+ get shouldShowRemoveMeButton() {
+ return this.allowRemoveMe && this.currentUser.currentUserId && this.totalContributors > 1;
+ }
+
  @computed('truncated')
  get truncateCount() {
  return this.shouldTruncate ? 3 : undefined;

lib/osf-components/addon/components/contributor-list/styles.scss

@@ -1,3 +1,7 @@
 :global(.btn).load-contribs {
  padding: 0 0 3px;
 }
+
+.Button__removeMe {
+ margin-bottom: 5px;
+}

lib/osf-components/addon/components/contributor-list/template.hbs

@@ -1,6 +1,20 @@
 {{#if this.node.isAnonymous}}
  {{t 'contributor_list.anonymous'}}
 {{else}}
+ {{#if this.shouldShowRemoveMeButton}}
+ <div local-class='Button__removeMe'>
+ <DeleteButton
+ data-test-contributor-remove-me
+ local-class='RemoveContributorButton'
+ @buttonLabel={{t 'contributor_list.remove_contributor.button_label'}}
+ @delete={{this.removeMe}}
+ @smallSecondary={{true}}
+ @modalTitle={{t 'contributor_list.remove_contributor.confirm_remove.title'}}
+ @modalBody={{t 'contributor_list.remove_contributor.confirm_remove.body'}}
+ @confirmButtonText={{t 'contributor_list.remove_contributor.confirm_remove.button'}}
+ />
+ </div>
+ {{/if}}
  <InlineList
  @items={{this.displayedContributors}}
  @total={{this.totalContributors}}

lib/osf-components/addon/components/delete-button/component.ts

@@ -27,6 +27,7 @@ export default class DeleteButton extends Component {
 
  // Optional arguments
  small: boolean = defaultTo(this.small, false);
+ smallSecondary: boolean = defaultTo(this.smallSecondary, false);
  noBackground: boolean = defaultTo(this.noBackground, false);
  hardConfirm: boolean = defaultTo(this.hardConfirm, false);
  disabled: boolean = defaultTo(this.disabled, false);

lib/osf-components/addon/components/delete-button/styles.scss

@@ -10,6 +10,10 @@
  }
 }
 
+.Button__secondaryDestroy {
+ color: $brand-danger;
+}
+
 .Modal__confirmBlock {
  display: block;
  font-weight: normal;

lib/osf-components/addon/components/delete-button/template.hbs

@@ -10,6 +10,18 @@
  >
  {{fa-icon 'times' size='lg'}}
  </Button>
+{{else if this.smallSecondary}}
+ <Button
+ data-analytics-name='Delete button'
+ data-test-delete-button-secondary-destroy
+ local-class='Button__secondaryDestroy'
+ disabled={{this.disabled}}
+ @type='secondary'
+ @layout='small'
+ {{on 'click' this._show}}
+ >
+ {{this.buttonLabel}}
+ </Button>
 {{else}}
  <Button
  data-analytics-name='Delete button'

lib/osf-components/addon/components/registries/review-metadata-renderer/template.hbs

@@ -1,7 +1,7 @@
 {{assert 'Registries::ReviewMetadataRenderer requires a draftRegistration' @draftRegistration}}
 <h2 id='MetadataPageLabel'>{{t 'registries.drafts.draft.metadata.page_label'}}</h2>
 
-<Registries::ReviewMetadataRenderer::LabelDisplay 
+<Registries::ReviewMetadataRenderer::LabelDisplay
  @draftRegistration={{@draftRegistration}}
  @changeset={{@metadataChangeset}}
  @field='title'
@@ -10,7 +10,7 @@
  {{~if @draftRegistration.title @draftRegistration.title (t 'registries.registration_metadata.no_title')~}}
 </Registries::ReviewMetadataRenderer::LabelDisplay>
 
-<Registries::ReviewMetadataRenderer::LabelDisplay 
+<Registries::ReviewMetadataRenderer::LabelDisplay
  @draftRegistration={{@draftRegistration}}
  @changeset={{@metadataChangeset}}
  @field='description'
@@ -19,7 +19,20 @@
  {{~if @draftRegistration.description @draftRegistration.description (t 'registries.registration_metadata.no_description')~}}
 </Registries::ReviewMetadataRenderer::LabelDisplay>
 
-<Registries::ReviewMetadataRenderer::LabelDisplay 
+<Registries::ReviewMetadataRenderer::LabelDisplay
+ @draftRegistration={{@draftRegistration}}
+ @changeset={{@metadataChangeset}}
+ @field='contributors'
+>
+ <ContributorList
+ @node={{get-model @draftRegistration.branchedFrom}}
+ @shouldLinkUsers={{true}}
+ @shouldTruncate={{false}}
+ @allowRemoveMe={{true}}
+ />
+</Registries::ReviewMetadataRenderer::LabelDisplay>
+
+<Registries::ReviewMetadataRenderer::LabelDisplay
  @draftRegistration={{@draftRegistration}}
  @changeset={{@metadataChangeset}}
  @field='category'
@@ -34,25 +47,25 @@
  {{/if}}
 </Registries::ReviewMetadataRenderer::LabelDisplay>
 
-<Registries::ReviewMetadataRenderer::LabelDisplay 
+<Registries::ReviewMetadataRenderer::LabelDisplay
  @draftRegistration={{@draftRegistration}}
  @changeset={{@metadataChangeset}}
  @field='affiliated_institutions'
  @fieldText='affiliated institutions'
  local-class='{{unless @draftRegistration.affiliatedInstitutions 'NoResponse'}}'
 >
- {{~if @draftRegistration.affiliatedInstitutions 
+ {{~if @draftRegistration.affiliatedInstitutions
  (join ', ' (map-by 'name' @draftRegistration.affiliatedInstitutions))
  (t 'registries.registration_metadata.no_affiliated_institutions')~}}
 </Registries::ReviewMetadataRenderer::LabelDisplay>
 
-<Registries::ReviewMetadataRenderer::LabelDisplay 
+<Registries::ReviewMetadataRenderer::LabelDisplay
  @draftRegistration={{@draftRegistration}}
  @changeset={{@metadataChangeset}}
  @field='license'
  local-class='{{unless @draftRegistration.license.name 'NoResponse'}}'
 >
- {{#if @draftRegistration.license.name}} 
+ {{#if @draftRegistration.license.name}}
  <LicenseViewer @registration={{@draftRegistration}} />
  {{else}}
  {{~t 'registries.form_view.none_selected'~}}
@@ -64,7 +77,7 @@
  <div local-class='NestedProperty'>
  {{#each fields as |field|}}
  {{#let (get @draftRegistration.nodeLicense field) as |nodeLicenseField|}}
- <Registries::ReviewMetadataRenderer::LabelDisplay 
+ <Registries::ReviewMetadataRenderer::LabelDisplay
  @draftRegistration={{@draftRegistration}}
  @changeset={{@metadataChangeset}}
  @field='nodeLicense.{{field}}'
@@ -84,21 +97,21 @@
  {{/if}}
 {{/let}}
 
-<Registries::ReviewMetadataRenderer::LabelDisplay 
+<Registries::ReviewMetadataRenderer::LabelDisplay
  @draftRegistration={{@draftRegistration}}
  @changeset={{@metadataChangeset}}
  @field='subjects'
  local-class='{{unless @draftRegistration.subjects 'NoResponse'}}'
 >
- {{#if @draftRegistration.subjects}} 
+ {{#if @draftRegistration.subjects}}
  <Subjects::Display @subjects={{@draftRegistration.subjects}} />
  {{else}}
  {{~t 'registries.registration_metadata.no_subjects'~}}
  {{/if}}
 
 </Registries::ReviewMetadataRenderer::LabelDisplay>
 
-<Registries::ReviewMetadataRenderer::LabelDisplay 
+<Registries::ReviewMetadataRenderer::LabelDisplay
  @draftRegistration={{@draftRegistration}}
  @changeset={{@metadataChangeset}}
  @field='tags'