Skip to content

formatDateTimeISO() fix #2010

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

Merged
merged 3 commits into from
May 1, 2025
Merged

formatDateTimeISO() fix #2010

merged 3 commits into from
May 1, 2025

Conversation

matt-aitken
Copy link
Member

@matt-aitken matt-aitken commented May 1, 2025

We use the formatDateTimeISO() function to format dates in our new date tooltip which lets you copy ISO dates.

They need to be in this format:

2025-01-15T06:01:19.000-08:00
2025-04-29T14:01:19.123Z

Previously they weren't respecting the timezone correctly and were in the wrong format too. I've added some tests as well.

Summary by CodeRabbit

  • Bug Fixes

    • Improved date and time formatting to correctly handle various time zones and daylight saving transitions, ensuring accurate ISO-like output.
  • Tests

    • Added comprehensive tests to verify correct formatting across multiple time zones, including daylight saving periods and offset handling.

Copy link

changeset-bot bot commented May 1, 2025

⚠️ No Changeset found

Latest commit: 04e1b34

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Contributor

coderabbitai bot commented May 1, 2025

"""

Walkthrough

The changes introduce a revised implementation of the formatDateTimeISO function, enhancing its handling of time zones and date formatting. The function now manually constructs ISO-like date strings, accurately reflecting the specified time zone, including proper formatting of offsets and support for daylight saving time. Additionally, a new test suite has been added to rigorously verify the function's output across various time zones, including UTC, Europe/London, and America/Los_Angeles, as well as during daylight saving and standard time periods.

Changes

File(s) Change Summary
apps/webapp/app/components/primitives/DateTime.tsx Refactored formatDateTimeISO to manually format dates and handle time zone offsets and daylight saving time.
apps/webapp/test/components/DateTime.test.ts Added comprehensive tests for formatDateTimeISO covering multiple time zones and daylight saving transitions.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant DateTime
    participant IntlFormatter

    Caller->>DateTime: formatDateTimeISO(date, timeZone)
    alt timeZone is "UTC"
        DateTime->>DateTime: Return date.toISOString()
    else Other timeZone
        DateTime->>IntlFormatter: Format date parts (year, month, day, hour, minute, second) in timeZone
        DateTime->>IntlFormatter: Get timezone offset string in timeZone
        DateTime->>DateTime: Construct ISO-like string with offset
        DateTime->>Caller: Return formatted string
    end
Loading

Poem

In the warren of code, a date hops anew,
With time zones and offsets, precision in view.
From London to L.A., and UTC’s embrace,
Each tick and each tock now falls into place.
With tests as our carrots, we check every zone—
The world’s time, now formatted, is perfectly shown!
🕰️🐇
"""


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5cf6fdf and 04e1b34.

📒 Files selected for processing (2)
  • apps/webapp/app/components/primitives/DateTime.tsx (1 hunks)
  • apps/webapp/test/components/DateTime.test.ts (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • apps/webapp/app/components/primitives/DateTime.tsx
  • apps/webapp/test/components/DateTime.test.ts
⏰ Context from checks skipped due to timeout of 90000ms (7)
  • GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - pnpm)
  • GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - npm)
  • GitHub Check: e2e / 🧪 CLI v3 tests (ubuntu-latest - pnpm)
  • GitHub Check: e2e / 🧪 CLI v3 tests (ubuntu-latest - npm)
  • GitHub Check: units / 🧪 Unit Tests
  • GitHub Check: typecheck / typecheck
  • GitHub Check: Analyze (javascript-typescript)
✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🧹 Nitpick comments (1)
apps/webapp/test/components/DateTime.test.ts (1)

1-48: Additional test cases to consider

The test suite is comprehensive for standard use cases, but could benefit from additional edge cases.

Consider adding these test cases to make the suite more robust:

  1. Test with an invalid timezone to ensure graceful handling
  2. Test with dates before 1970 (negative timestamps)
  3. Test with dates at DST transition boundaries
it("should handle invalid timezones gracefully", () => {
  const date = new Date("2025-04-29T14:01:19.123Z");
  const result = formatDateTimeISO(date, "Invalid/Timezone");
  // Should fall back to UTC or handle gracefully
  expect(result).toBe("2025-04-29T14:01:19.123Z");
});

it("should handle pre-1970 dates correctly", () => {
  const date = new Date("1969-12-31T23:59:59.123Z");
  const result = formatDateTimeISO(date, "UTC");
  expect(result).toBe("1969-12-31T23:59:59.123Z");
});
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between aacec56 and 5cf6fdf.

📒 Files selected for processing (2)
  • apps/webapp/app/components/primitives/DateTime.tsx (1 hunks)
  • apps/webapp/test/components/DateTime.test.ts (1 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (1)
apps/webapp/test/components/DateTime.test.ts (1)
apps/webapp/app/components/primitives/DateTime.tsx (1)
  • formatDateTimeISO (100-138)
⏰ Context from checks skipped due to timeout of 90000ms (7)
  • GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - pnpm)
  • GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - npm)
  • GitHub Check: e2e / 🧪 CLI v3 tests (ubuntu-latest - pnpm)
  • GitHub Check: e2e / 🧪 CLI v3 tests (ubuntu-latest - npm)
  • GitHub Check: units / 🧪 Unit Tests
  • GitHub Check: typecheck / typecheck
  • GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (3)
apps/webapp/test/components/DateTime.test.ts (3)

4-9: Good test coverage for UTC with Z suffix

The test correctly verifies that UTC dates are formatted with the "Z" suffix using toISOString().


11-25: Comprehensive testing for Europe/London timezone

Good test coverage for Europe/London timezone during both BST (summer) and GMT (winter) with the correct offset handling.


27-41: Thorough testing for America/Los_Angeles timezone

The tests correctly verify the formatting for America/Los_Angeles timezone during both PDT (summer) and PST (winter) with the proper timezone offsets.

@matt-aitken matt-aitken merged commit d2dde0a into main May 1, 2025
11 of 12 checks passed
@matt-aitken matt-aitken deleted the datetime-copy-fix branch May 1, 2025 16:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants