Skip to content

Handle all supported date value types in date picker#5345

Merged
tdonohue merged 1 commit into
DSpace:mainfrom
oscar-escire:Issue/2956
May 22, 2026
Merged

Handle all supported date value types in date picker#5345
tdonohue merged 1 commit into
DSpace:mainfrom
oscar-escire:Issue/2956

Conversation

@oscar-escire
Copy link
Copy Markdown
Contributor

References

Description

Replace unsafe .toString() calls on date model values with a new dateValueToString() utility that properly handles all supported types (string, Date, NgbDateStruct) and throws an informative error for unsupported object types.

Instructions for Reviewers

  1. Run npm test -- --include="src/app/utils/date.util.spec.ts" — all 32 tests should pass
  2. Run npm test -- --include="src/app/shared/form/builder/ds-dynamic-form-ui/models/date-picker/date-picker.component.spec.ts" — all 17 tests should pass
  3. Run npm test -- --include="src/app/shared/form/builder/parsers/date-field-parser.spec.ts" — all 3 tests should pass
  4. Verify date picker fields work correctly in submission forms (e.g. Date of Issue)

List of changes in this PR:

  • Added dateValueToString() utility function in src/app/utils/date.util.ts that safely converts string | Date | object values to YYYY-MM-DD formatted strings
  • Updated date-picker.component.ts to use dateValueToString() instead of .toString(), removing the eslint-disable comment and todo
  • Updated date-field-parser.ts to use dateValueToString() instead of .toString(), removing the eslint-disable comment and todo
  • Added 5 unit tests for dateValueToString() in date.util.spec.ts (string, Date, NgbDateStruct, arbitrary object, empty object)
  • Added 2 test suites in date-picker.component.spec.ts to verify initialization from Date and NgbDateStruct-like objects

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.

@lgeggleston lgeggleston added bug code task 1 APPROVAL pull request only requires a single approval to merge low priority labels Apr 1, 2026
@lgeggleston lgeggleston moved this to 🙋 Needs Reviewers Assigned in DSpace 10.0 Release Apr 1, 2026
@GauravD2t
Copy link
Copy Markdown
Contributor

Hello @oscar-escire, thanks for your contribution. The datetime picker works perfectly on my end, and all test cases passed.

image

Copy link
Copy Markdown

@nathanmlf nathanmlf left a comment

Choose a reason for hiding this comment

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

Hey @oscar-escire! I tested it on my side and it works as expected. Nice job!

@tdonohue tdonohue moved this from 🙋 Needs Reviewers Assigned to 👍 Reviewer Approved in DSpace 10.0 Release May 18, 2026
@tdonohue tdonohue added this to the 10.0 milestone May 22, 2026
Copy link
Copy Markdown
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 @oscar-escire ! This looks good to me. The changes are minor overall, and I verified the date field still works the same as before. Not seeing any newly introduced issues

@tdonohue tdonohue added the port to dspace-9_x This PR needs to be ported to `dspace-9_x` branch for next bug-fix release label May 22, 2026
@tdonohue tdonohue merged commit cb968ba into DSpace:main May 22, 2026
16 checks passed
@github-project-automation github-project-automation Bot moved this from 👍 Reviewer Approved to ✅ Done in DSpace 10.0 Release May 22, 2026
@dspace-bot
Copy link
Copy Markdown
Contributor

Backport failed for dspace-9_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-9_x
git worktree add -d .worktree/backport-5345-to-dspace-9_x origin/dspace-9_x
cd .worktree/backport-5345-to-dspace-9_x
git switch --create backport-5345-to-dspace-9_x
git cherry-pick -x 639e647d3b992ef8975418943ca17e2de34c3a09

@tdonohue tdonohue removed the port to dspace-9_x This PR needs to be ported to `dspace-9_x` branch for next bug-fix release label May 22, 2026
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 code task low priority

Projects

Status: ✅ Done

Development

Successfully merging this pull request may close these issues.

Dynamic form date picker & parser may use date values unsafely

6 participants