Skip to content

fix: call parent ngOnDestroy in dynamic form control container - #4644

Merged
tdonohue merged 1 commit into
DSpace:mainfrom
jlipka:fix/form-control-container-unsubscribe
Sep 9, 2025
Merged

fix: call parent ngOnDestroy in dynamic form control container#4644
tdonohue merged 1 commit into
DSpace:mainfrom
jlipka:fix/form-control-container-unsubscribe

Conversation

@jlipka

@jlipka jlipka commented Aug 20, 2025

Copy link
Copy Markdown
Contributor

References

Fixes #4645

Description

The 'DsDynamicFormControlContainerComponent' extends the 'DynamicFormControlContainerComponent', which comes from a third-party library (ng-dynamic-forms). When navigating away from a form that uses this component, any existing subscriptions are now removed and the default behavior of the lifecycle method "ngOnDestroy" is triggered again.

Instructions for Reviewers

I took memory snapshots using Firefox after navigation into a submission, click "save for later" and reopen it and looped this sequence about 10 times. The screenshot is probably not highly scientific, but it shows that there are significantly more objects and arrays in memory:
2025-08-20_unsubscribe-fix-comparison
If you know of a way to illustrate the effects even better, I would be grateful if you could let me know.

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.

@jlipka
jlipka marked this pull request as ready for review August 20, 2025 08:15
@tdonohue tdonohue added bug component: submission 1 APPROVAL pull request only requires a single approval to merge port to dspace-7_x port to dspace-8_x This PR needs to be ported to `dspace-8_x` branch for next bug-fix release port to dspace-9_x This PR needs to be ported to `dspace-9_x` branch for next bug-fix release labels Aug 20, 2025
@tdonohue tdonohue moved this to 🙋 Needs Reviewers Assigned in DSpace 10.0 Release Aug 20, 2025
@tdonohue
tdonohue self-requested a review August 20, 2025 21:56
@tdonohue tdonohue added this to the 10.0 milestone Sep 9, 2025

@tdonohue tdonohue left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

👍 Thanks @jlipka ! I'm able to reproduce the memory differences locally, though it's not as significant. Nonetheless, it looks to be beneficial to me as well and the code change is quite simple!

@github-project-automation github-project-automation Bot moved this from 🙋 Needs Reviewers Assigned to 👍 Reviewer Approved in DSpace 10.0 Release Sep 9, 2025
@tdonohue tdonohue added the performance / caching Related to performance, caching or embedded objects label Sep 9, 2025
@tdonohue
tdonohue merged commit b78b7c9 into DSpace:main Sep 9, 2025
15 checks passed
@github-project-automation github-project-automation Bot moved this from 👍 Reviewer Approved to ✅ Done in DSpace 10.0 Release Sep 9, 2025
@dspace-bot

Copy link
Copy Markdown
Contributor

Successfully created backport PR for dspace-7_x:

@dspace-bot

Copy link
Copy Markdown
Contributor

Successfully created backport PR for dspace-8_x:

@dspace-bot

Copy link
Copy Markdown
Contributor

Successfully created backport PR for dspace-9_x:

@tdonohue tdonohue removed port to dspace-7_x port to dspace-8_x This PR needs to be ported to `dspace-8_x` branch for next bug-fix release port to dspace-9_x This PR needs to be ported to `dspace-9_x` branch for next bug-fix release labels Sep 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

1 APPROVAL pull request only requires a single approval to merge bug component: submission high priority performance / caching Related to performance, caching or embedded objects

Projects

No open projects
Status: ✅ Done

Development

Successfully merging this pull request may close these issues.

Memory leak when navigating away from DynamicFormControlContainerComponent – missing call to parent ngOnDestroy

3 participants