Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix issue with submission sections visibility #3276

Merged
merged 5 commits into from
Dec 18, 2024

Conversation

atarix83
Copy link
Contributor

@atarix83 atarix83 commented Aug 29, 2024

References

Description

This PR fixes a bug with submission section visibility described by #3274

Instructions for Reviewers

To test this PR follow those steps:

  • Change the submission configuration in order to set the visibility of a step like the following
<step-definition id="traditionalpageone" mandatory="true">
    <heading>submit.progressbar.describe.stepone</heading>
    <processing-class>org.dspace.app.rest.submit.step.DescribeStep</processing-class>
    <type>submission-form</type>
    <scope visibilityOutside="hidden">submission</scope>
</step-definition>
  • Create a new submission in a collection where workflow is enabled and that it's using the submission configuration set in the previous step
  • Check the step is visible during submission
  • Deposit the item
  • As admin claim the workflow item created and edit it
  • Check the same step is hidden

You can also test the case where the step should be visible during workflow only, by using the following configuration

<step-definition id="traditionalpageone" mandatory="true">
    <heading>submit.progressbar.describe.stepone</heading>
    <processing-class>org.dspace.app.rest.submit.step.DescribeStep</processing-class>
    <type>submission-form</type>
    <scope visibilityOutside="hidden">workflow</scope>
</step-definition>

More test could be done by following the documentation https://wiki.lyrasis.org/display/DSDOC8x/Submission+User+Interface

Checklist

  • 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 yarn lint
  • My PR doesn't introduce circular dependencies (verified via yarn 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.

@atarix83 atarix83 marked this pull request as ready for review August 29, 2024 13:05
@tdonohue tdonohue added bug component: submission port to dspace-8_x This PR needs to be ported to `dspace-8_x` branch for next bug-fix release labels Aug 29, 2024
@tdonohue
Copy link
Member

@atarix83 : Just a quick note, this PR seems to include a large number of unrelated commits (45 commits in total), when only the last few seem related to this bug fix. Could you try to rebase or cleanup this PR so that is shows the proper commits? It might be that you just need to rebase on latest main.

root and others added 5 commits September 3, 2024 09:29
…er component don't overlap the navbar and make it inaccessible

(cherry picked from commit 2c259f5)
…er component don't overlap the navbar and make it inaccessible

(cherry picked from commit 2c259f5)
@atarix83 atarix83 force-pushed the task/main/DURACOM-291 branch from 670f1fe to 25e2c76 Compare September 3, 2024 07:31
@atarix83
Copy link
Contributor Author

atarix83 commented Sep 3, 2024

@tdonohue done

Copy link
Contributor

@nwoodward nwoodward left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 I tested and confirmed this PR and DSpace/DSpace#9783 work. With both PRs deployed locally I was able to limit the scope of the traditionalpageone step so that it only appeared in the submission form but not when editing a Workflow item.

Copy link
Member

@tdonohue tdonohue left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 Thanks @atarix83 ! Code looks good to me. I gave it a light test & trust the tests from @nwoodward

@tdonohue tdonohue added the port to dspace-7_x This PR needs to be ported to `dspace-7_x` branch for next bug-fix release label Dec 18, 2024
@tdonohue tdonohue merged commit 253b2e8 into DSpace:main Dec 18, 2024
13 checks passed
@dspace-bot
Copy link
Contributor

Backport failed for dspace-7_x, because it was unable to cherry-pick the commit(s).

Please cherry-pick the changes locally and resolve any conflicts.

git fetch origin dspace-7_x
git worktree add -d .worktree/backport-3276-to-dspace-7_x origin/dspace-7_x
cd .worktree/backport-3276-to-dspace-7_x
git switch --create backport-3276-to-dspace-7_x
git cherry-pick -x 5c4df8765ef65a975c769839188cce0432aa9bab ee5af8f7d17e2ec34561bc128f8e80508b68d9fa 8e8979a27ab608dac62edc52a7dd53ddecbd28fb 3ecec3af51a16e8aa503b63d32d985d606b26abe 25e2c763be3bf1f8e435b405be0936acce6927a6

@dspace-bot
Copy link
Contributor

Successfully created backport PR for dspace-8_x:

@tdonohue
Copy link
Member

@atarix83 : This was unable to be ported to 7.6.x automatically. Would you be able to make a dspace-7_x version of this PR, so that we could port this fix back to 7.x?

(NOTE: It was ported to 8.x automatically. So, at the very least we'll have this fixed in 8.1)

@tdonohue tdonohue removed the port to dspace-8_x This PR needs to be ported to `dspace-8_x` branch for next bug-fix release label Dec 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug component: submission port to dspace-7_x This PR needs to be ported to `dspace-7_x` branch for next bug-fix release
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

Submission step can't be hidden for only one submission scope
4 participants