markdown-date-formatter

[jasquat]

Supports #637

This adds a SPIFF_FORMATTER for markdown to format a date string into the configured date in the frontend.

usage:
The date is SPIFF_FORMATTER:::convert_date_to_date_for_display(2024-03-01)

Summary by CodeRabbit

• New Features

  • Enhanced date and time formatting in the ProcessInstanceListTable component for improved readability.
  • Introduced comprehensive tests for the DateAndTimeService and FormattingService to ensure accurate date and duration formatting.

• Refactor

  • Simplified the function signatures in DateAndTimeService by removing unused parameters.
  • Updated FormattingService to more efficiently handle date conversions for display purposes.

• Tests

  • Added new test cases for validating the functionality of date and duration formatting services.

[coderabbitai]

Walkthrough

Walkthrough

The updates focus on enhancing date and time formatting across the application. New formatting functions have been introduced in the ProcessInstanceListTable component, while the DateAndTimeService has been refined to improve duration formatting. The changes also include the simplification of function signatures and the introduction of a new test file for the FormattingService, ensuring the reliability of date and duration conversions for display purposes.

Changes

File Path	Change Summary
.../ProcessInstanceListTable.tsx	Added formatDurationForDisplayForTable and formatDateTimeForTable functions; updated to use these for formatting.
.../DateAndTimeService.test.tsx	Updated to correctly handle duration formatting, including various time units.
.../DateAndTimeService.tsx	Removed unused _row parameter from formatDurationForDisplay and formatDateTime, simplifying function signatures.
.../FormattingService.test.tsx	Introduced test cases for validating functionality in date and duration conversion for display.
.../FormattingService.tsx	Added convert_date_to_date_for_display function; updated checkForSpiffFormats to pass originalValue to functions in spiffFormatFunctions.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

---

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>.
  • Generate unit-tests 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 tests 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 2

Configuration used: .coderabbit.yaml

Commits

Files that changed from the base of the PR and between 13d7fa8 and 4486868.

Files selected for processing (5)

• spiffworkflow-frontend/src/components/ProcessInstanceListTable.tsx (2 hunks)
• spiffworkflow-frontend/src/services/DateAndTimeService.test.tsx (1 hunks)
• spiffworkflow-frontend/src/services/DateAndTimeService.tsx (2 hunks)
• spiffworkflow-frontend/src/services/FormattingService.test.tsx (1 hunks)
• spiffworkflow-frontend/src/services/FormattingService.tsx (2 hunks)

Learnings (2)

spiffworkflow-frontend/src/services/DateAndTimeService.tsx (1)

The user has clarified that `DATE_FORMAT` is a string constant that defines the expected format of the input `dateString` in the `dateStringToYMDFormat` function within `DateAndTimeService.tsx`.

spiffworkflow-frontend/src/components/ProcessInstanceListTable.tsx (3)

The user, jasquat, has indicated a consideration for future refactor regarding the suggestion to abstract the API call logic in `getProcessInstances` function into a separate service or hook for improved modularity and reusability.

---

The user, jasquat, has indicated a consideration for future refactor regarding the suggestion to abstract the API call logic in getProcessInstances function into a separate service or hook for improved modularity and reusability.

---

The user, jasquat, has indicated a consideration for future refactor regarding the suggestion to group related imports together in ProcessInstanceListTable component for better readability.

Additional comments (6)

spiffworkflow-frontend/src/services/FormattingService.tsx (2)

• 7-8: The addition of convert_date_to_date_for_display to spiffFormatFunctions is a good enhancement. Ensure that DateAndTimeService.ymdDateStringToConfiguredFormat is properly handling various date formats and edge cases.
• 18-18: Ensure that originalValue passed to spiffFormatFunctions[spiffFormat] is sanitized and validated to prevent potential issues with date formatting.

spiffworkflow-frontend/src/services/DateAndTimeService.tsx (2)

• 150-150: Simplifying the signature of formatDurationForDisplay by removing unused parameters is a good improvement. Ensure that all calls to this function have been updated accordingly across the project.
• 174-174: The simplification of formatDateTime's signature is beneficial. Verify that this change does not impact any existing functionality where the function is used.

spiffworkflow-frontend/src/components/ProcessInstanceListTable.tsx (2)

• 311-316: Adding formatDurationForDisplayForTable and formatDateTimeForTable enhances the component's formatting capabilities. Ensure these functions are consistently used across all relevant parts of the component for uniformity.
• 340-341: The integration of the new formatting functions into the column display logic is well done. It's important to ensure that the display types are correctly assigned to columns to utilize these formatters effectively.