Skip to content
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

Feat | Calendar activity | Legend |Add not hours worked flag #3526

Merged
merged 2 commits into from
Jan 18, 2025

Conversation

CREDO23
Copy link
Contributor

@CREDO23 CREDO23 commented Jan 17, 2025

Description

Fix #3478

Type of Change

  • Bug fix
  • New feature
  • Breaking change
  • Documentation update

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented on my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings

Current screenshots

Screenshot 2025-01-17 at 21 49 55

Summary by CodeRabbit

  • New Features

    • Enhanced internationalization support for activity calendar legend
    • Added new localization keys for "Legend", "Hours", and "Not Hours Worked" across multiple languages
  • Localization

    • Updated language files (Arabic, Bulgarian, German, English, Spanish, French, Hebrew, Italian, Dutch, Polish, Portuguese, Russian, and Chinese) with new translation keys
    • Expanded terminology for reporting and time tracking functionalities
  • Improvements

    • Refined rendering logic for activity calendar legend
    • Updated profile page rendering conditions

@CREDO23 CREDO23 added WEB Web app Improvement Improvement Ever Teams labels Jan 17, 2025
@CREDO23 CREDO23 self-assigned this Jan 17, 2025
@CREDO23 CREDO23 linked an issue Jan 17, 2025 that may be closed by this pull request
Copy link
Contributor

coderabbitai bot commented Jan 17, 2025

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 eslint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

apps/web/lib/features/integrations/activity-calendar/index.tsx

Oops! Something went wrong! :(

ESLint: 8.46.0

ESLint couldn't find the config "next/core-web-vitals" to extend from. Please check that the name of the config is correct.

The config "next/core-web-vitals" was referenced from the config file in "/apps/web/.eslintrc.json".

If you still have problems, please stop by https://eslint.org/chat/help to chat with the team.

Walkthrough

The pull request introduces modifications to multiple components and localization files across the web application. The primary changes involve updating the Profile component's rendering logic in page.tsx, refactoring the ActivityCalendar component in index.tsx, and adding new localization keys for "LEGEND", "HOURS", and "NOT_HOURS_WORKED" across various language JSON files. These updates enhance the application's internationalization and improve the rendering of activity and time-tracking related components.

Changes

File Change Summary
apps/web/app/[locale]/profile/[memberId]/page.tsx Modified rendering logic for Profile component, replacing conditional rendering block with a new Container component
apps/web/lib/features/integrations/activity-calendar/index.tsx Refactored ActivityLegend function with improved internationalization, memoization, and dynamic legend rendering
apps/web/locales/*.json Added new localization keys: "LEGEND", "HOURS", and "NOT_HOURS_WORKED" across multiple language files

Assessment against linked issues

Objective Addressed Explanation
Add legend item for white boxes representing "No Hours Worked" [#3478]

Possibly related PRs

Suggested labels

feature, Timesheets

Suggested reviewers

  • evereq

Poem

🐰 A rabbit's tale of time and space,
Where legends dance with coding grace,
Hours tracked, no moment lost,
Internationalized at minimal cost!
Code hops, translations bloom,
In our digital time-tracking room! 🕰️


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

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. (Beta)
  • @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.

@CREDO23 CREDO23 changed the title add not hours worked Feat | Add not hours worked Jan 17, 2025
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: 0

🧹 Nitpick comments (3)
apps/web/lib/features/integrations/activity-calendar/index.tsx (3)

130-151: Consider extracting color constants to avoid duplication.

The color values are currently duplicated between ActivityCalendar and ActivityLegend. Consider extracting these into a shared constant to maintain consistency and improve maintainability.

// Create a new constants file or add to existing one
export const ACTIVITY_COLORS = {
  NOT_WORKED: '#FFFFFF',
  HOURS_0_4: '#9370DB',
  HOURS_4_10: '#0000FF',
  HOURS_10_18: '#FFA500',
  HOURS_18_24: '#FF4500',
} as const;

158-164: Enhance accessibility with ARIA labels.

The legend items could benefit from improved accessibility. Consider adding appropriate ARIA labels to make the legend more accessible to screen readers.

-<div className="flex items-center" id={`legend-${item.color.slice(1)}`}>
+<div 
+  className="flex items-center" 
+  id={`legend-${item.color.slice(1)}`}
+  role="listitem"
+  aria-label={`${item.label} activity level`}
+>

130-151: Optimize useMemo usage.

The useMemo hook might be unnecessary here since the data structure is static and only the translations change. Consider either:

  1. Moving the data structure outside the component if it's truly static
  2. Or keeping the current implementation if you expect the data structure to change in the future

If you choose option 1, you could refactor it like this:

const LEGEND_DATA = [
  { color: '#FFFFFF', labelKey: 'common.NOT_HOURS_WORKED' },
  { color: '#9370DB', labelKey: 'common.HOURS', range: '0 - 4' },
  // ... other items
];

function ActivityLegend() {
  const t = useTranslations();
  
  return (
    // ... render using LEGEND_DATA.map(item => ({
    //   ...item,
    //   label: item.range ? `${item.range} ${t(item.labelKey)}` : t(item.labelKey)
    // }))
  );
}
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between ac17551 and 37ca77b.

📒 Files selected for processing (1)
  • apps/web/lib/features/integrations/activity-calendar/index.tsx (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Codacy Static Code Analysis
  • GitHub Check: deploy
🔇 Additional comments (2)
apps/web/lib/features/integrations/activity-calendar/index.tsx (2)

4-4: LGTM! Import statements are well-organized.

The new imports are properly utilized in the code changes and follow the project's conventions.

Also applies to: 9-10


154-166: LGTM! Well-structured legend implementation.

The legend implementation is well-structured with:

  • Proper internationalization support
  • Efficient list rendering using Fragment
  • Good handling of the white color edge case
  • Clear and maintainable JSX structure

@CREDO23 CREDO23 changed the title Feat | Add not hours worked Feat | Calendar activity | Legend |Add not hours worked flag Jan 17, 2025
@Cedric921 Cedric921 added this to the v0.2.0 milestone Jan 18, 2025
@evereq evereq merged commit 3d31ece into develop Jan 18, 2025
13 checks passed
@evereq evereq deleted the 3478-update-stats-legend-to-include-time-not-worked branch January 18, 2025 08:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update Stats legend to include Time "Not Worked"
3 participants