Skip to content

Fix infinite loading submission forms #4060

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

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

alexandrevryghem
Copy link
Member

References

Description

Updated the SubmissionRestService#getDataById method to prevent the form from getting stuck in an infinite loop when quick successive calls are made to it. This happens because the getDataById sometimes tries to return the data of a specific request that was actually never dispatched, because a similar request was already being made.

Instructions for Reviewers

This issue happens when RequestService#send is called twice with the same value in a short time, because it prevents sending requests a second time when the same request was already fired by another method (as long as that request is still in the isPending state). Because getDataById explicitly listens from data from a specific request (this.fetchRequest(requestId)), it is possible that it tries to fetch the data of a request that was never dispatched. This refactor instead listens to data coming in based on the url of the request.

Guidance for how to test or review this PR:
This issue only happens when this line returns false, so for testing I would recommend adding a console.log wrapper around this, this way you know when you also have the same edge case:

this.requestService.send(request);

I was able to reproduce this error by refreshing the /workspaceitems/{id}/edit page multiple times (this doesn't happen on the default DSpace forms, but if you have customizations that cause the SubmissionRestService#getDataById from being called multiple times you can experience this issue)

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 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.

@alexandrevryghem alexandrevryghem added bug component: submission port to dspace-7_x This PR needs to be ported to `dspace-7_x` branch for next bug-fix release port to dspace-8_x This PR needs to be ported to `dspace-8_x` branch for next bug-fix release labels Mar 7, 2025
@alexandrevryghem alexandrevryghem self-assigned this Mar 7, 2025
@tdonohue tdonohue added the performance / caching Related to performance, caching or embedded objects label Mar 7, 2025
@tdonohue tdonohue moved this to 🙋 Needs Reviewers Assigned in DSpace 9.0 Release Mar 7, 2025
@alexandrevryghem alexandrevryghem marked this pull request as draft March 7, 2025 14:52
@kshepherd
Copy link
Member

@alexandrevryghem this looks great. I have a draft/for-discussion PR that tries to solve similar cases, but instead uses some debouncing and subscription management changes in the submission service class -- I would love to hear your thoughts on #4214 , and maybe it even makes sense to combine both our approaches?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug component: submission high priority performance / caching Related to performance, caching or embedded objects port to dspace-7_x This PR needs to be ported to `dspace-7_x` branch for next bug-fix release port to dspace-8_x This PR needs to be ported to `dspace-8_x` branch for next bug-fix release
Projects
Status: 🙋 Needs Reviewers Assigned
Development

Successfully merging this pull request may close these issues.

3 participants