Submission - Replace plaintext with relationship on lookup - main

[Atmire-Kristof]

References

• Fixes Plaintext author is not cleared after selecting entity through lookup #4843
• 7.6 equivalent: Submission - Replace plaintext with relationship on lookup - 7.6 #4904

Description

This PR changes the submission relationship lookup to make the (first) selected relationship replace the plain text value the lookup started from, if it did.

Instructions for Reviewers

Technical details:

• If the lookup is started from a plain-text metadata value, its "place" and "metadataField" is stored on the lookup modal
• When a relationship is selected for the first time in the modal and those "replace" properties are present, a ReplaceRelationshipAction will be created instead of the usual AddRelationshipAction. This only happens for the first selected relationship, the rest sends a AddRelationshipAction for each selection.
• Relationship-effects takes the following actions in order, when it recieves a ReplaceRelationshipAction:
  • Remove the plain-text metadata value from the item
  • Create the new relationship
  • Update the new relationship's place to be on the deleted value's spot

How to test:

• Start a submission and for a relationship-controlled field (e.g. author), create multiple plain-text values
• Start a lookup from one of the plain-text values
• Select a couple new relationships in the lookup modal (at least two)
• Close the lookup
• Verify the plain-text value you started the lookup from is not present anymore
• Verify the first selected relationship is placed where the removed plain-text value was
• Verify all other selected relationships are placed at the end of the list

Checklist

This checklist provides a reminder of what we are going to look for when reviewing your PR. You do not need to complete this checklist prior creating your PR (draft PRs are always welcome).
However, reviewers may request that you complete any actions in this list if you have not done so. If you are unsure about an item in the checklist, don't hesitate to ask. We're here to help!

• My PR is created against the main branch of code (unless it is a backport or is fixing an issue specific to an older branch).
• My PR is small in size (e.g. less than 1,000 lines of code, not including comments & specs/tests), or I have provided reasons as to why that's not possible.
• My PR passes ESLint validation using npm run lint
• My PR doesn't introduce circular dependencies (verified via npm run check-circ-deps)
• My PR includes TypeDoc comments for all new (or modified) public methods and classes. It also includes TypeDoc for large or complex private methods.
• My PR passes all specs/tests and includes new/updated specs or tests based on the Code Testing Guide.
• My PR aligns with Accessibility guidelines if it makes changes to the user interface.
• My PR uses i18n (internationalization) keys instead of hardcoded English text, to allow for translations.
• My PR includes details on how to test it. I've provided clear instructions to reviewers on how to successfully test this fix or feature.
• If my PR includes new libraries/dependencies (in package.json), I've made sure their licenses align with the DSpace BSD License based on the Licensing of Contributions documentation.
• If my PR includes new features or configurations, I've provided basic technical documentation in the PR itself.
• If my PR fixes an issue ticket, I've linked them together.

[jrcwiok]

• Start a submission and for a relationship-controlled field (e.g. author), create multiple plain-text values
• Start a lookup from one of the plain-text value
• Select a couple new relationships in the lookup modal (at least two)
• Close the lookup
• Verify the plain-text value you started the lookup from is not present anymore
• Verify the first selected relationship is placed where the removed plain-text value was
• Verify all other selected relationships are placed at the end of the list

I interpreted the steps as the following:
I tested on the metadata tab using the author element. I entered plain text author names, clicked on the lookup, and replaced with a value in the list.

[Atmire-Kristof]

Some clarification to my latest changes:

There was a bug with selecting multiple relationships in one action (e.g. selecting the entire page of results at once, using the dropdown). The modal would emit selectObject more than once per selected object because it was being called from two places:

• selectPage was calling this.selectObject.emit manually for the selected page
• Because selectPage also calls this.selectableListService.select, ds-search would internally fire another selectObject event for the same objects

This caused the multiple select to behave in very strange ways, where only one of the selected objects would actually be selected, the others were ignored.

The easiest fix here is to remove the manual emission that selectPage does and just let the results of this.selectableListService.select do their thing.

[tdonohue]

@Atmire-Kristof : I'm testing this today and the behavior is still a bit buggy to me. That said, the basic behavior you describe works. If I select multiple relationships, it works fine. But, if I select just one relationship, it doesn't seem to work.

For instance, this is what I tried which doesn't work:

1. Create a new Publication
2. Add two plain text authors to that publication
3. Next to one author, click the search button. Select one relationship to add instead
4. Go back to the submission form. The plain text author still exists
5. Click the search button again. The relationship appears selected still. Close the popup
6. Now there are two copies of the same plain text author back on the submission form.

However, this does work:

1. Create a new Publication
2. Add two plain text authors to that publication
3. Next to one author, click the search button. Select two relationships.
4. Now, back on the form, the plain text author is replaced with the relationship and the other relationship is listed at the end (as a third author).

So, this PR appears to be a partial fix. It works if you always select multiple relationships. But, if you try to do a 1-to-1 replacement, then it doesn't work. So, it's not a complete fix for #4843