[WEB-3087] fix: handle cycle start and end timezone conversion in list, create, and update

[gurusainath]

Description

• Fixed timezone conversion issues for start_date and end_date in cycles.
• Ensured proper handling of timezone-aware dates in the cycle list, create, and update operations.

Type of Change

• Bug fix (non-breaking change which fixes an issue)

References

[WEB-3087]

Summary by CodeRabbit

• Bug Fixes

  • Fixed a syntax error in the read_only_fields declaration for CycleUserPropertiesSerializer
  • Corrected project_id access method in CycleWriteSerializer

• New Features

  • Added timezone conversion for start_date and end_date fields in cycle operations
  • Improved handling of date fields to support user's local timezone

[coderabbitai]

Walkthrough

The pull request introduces modifications to the cycle-related serializers and views in the Plane application. The changes primarily focus on updating the CycleWriteSerializer to alter how project_id is accessed and correcting a syntax error in the CycleUserPropertiesSerializer. Additionally, the CycleViewSet in the base views has been enhanced to convert date fields to the user's timezone after creating or updating a cycle.

Changes

File	Change Summary
apiserver/plane/app/serializers/cycle.py	- Modified project_id access in CycleWriteSerializer.validate from dictionary-style to direct attribute access - Fixed syntax error in CycleUserPropertiesSerializer read_only_fields
apiserver/plane/app/views/cycle/base.py	- Added timezone conversion for start_date and end_date in create and partial_update methods of CycleViewSet

Possibly related PRs

• [WEB-2843] chore: updated the cycle end date logic #6194: Modifications to CycleWriteSerializer class
• [WEB-3044] fix: Correct handling of equal start and end dates in cycle create and update #6328: Handling of start_date and end_date in CycleWriteSerializer
• [WEB-3087] fix: project_id handling in cycle create write serializer #6358: Updates to project_id retrieval logic

Suggested labels

🐛bug, ⚙️backend

Suggested reviewers

• NarayanBavisetti
• sriramveeraghanta

Poem

🐰 A Rabbit's Ode to Cycle Serialization 🕰️

In timezones wild and project paths true,
Our code hops with a serializer's view
A comma here, an attribute there,
Debugging with a rabbit's flair!
Timezone dancing, data so bright! 🌈

---

📜 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 448a34a and 1d81557.

⛔ Files ignored due to path filters (1)

• yarn.lock is excluded by !**/yarn.lock, !**/*.lock

📒 Files selected for processing (2)

• apiserver/plane/app/serializers/cycle.py (1 hunks)
• apiserver/plane/app/views/cycle/base.py (2 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (2)

• GitHub Check: lint-apiserver
• GitHub Check: Analyze (javascript)

🔇 Additional comments (4)

apiserver/plane/app/serializers/cycle.py (1)

25-25: Verify attribute access safety.

The change from dictionary-style access self.instance.get("project_id", None) to attribute access self.instance.project_id assumes that self.instance is always a model instance. This could raise an AttributeError if project_id doesn't exist.

Run this script to verify the assumption:

✅ Verification successful

The attribute access is safe

The change from dictionary-style to attribute access is safe because:

• The code first checks if self.instance exists
• When it exists, it's guaranteed to be a model instance from the queryset
• Project is a required field in the Cycle model

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check if self.instance is always a model instance with project_id attribute
# Look for any cases where self.instance might be a dictionary or None

# Search for CycleWriteSerializer instantiation and usage
rg -A 5 "CycleWriteSerializer\(" 

# Search for potential dictionary usage in serializer context
rg "self\.instance" --type py

Length of output: 1816

apiserver/plane/app/views/cycle/base.py (3)

306-309: LGTM! Proper timezone conversion added.

The timezone conversion is correctly applied to the cycle data before sending the response, ensuring consistent timezone representation for the user.

---

395-398: LGTM! Consistent timezone handling in update.

The timezone conversion is consistently applied in both create and update operations, maintaining timezone integrity throughout the cycle's lifecycle.

---

306-309: Verify timezone field definitions.

The code assumes the existence of user_timezone on the User model and proper timezone settings in the Project model. Let's verify these assumptions.

Run this script to check the timezone field definitions:

Also applies to: 395-398

✅ Verification successful

Timezone fields and conversion logic are properly implemented

The codebase has proper timezone support:

• User model has user_timezone field (default: "UTC")
• Project model has timezone field (default: "UTC")
• TimezoneMixin handles timezone activation
• Utility functions manage timezone conversions

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify timezone field definitions in User and Project models

# Check User model for user_timezone field
ast-grep --pattern 'class User {
  $$$
  user_timezone = $field
  $$$
}'

# Check Project model for timezone field
ast-grep --pattern 'class Project {
  $$$
  timezone = $field
  $$$
}'

Length of output: 147

---

Script:

#!/bin/bash
# Find model files that might contain User and Project definitions
fd -t f "models.py|models" -x rg -l "class (User|Project)"

# Once we find the files, let's examine their content
fd -t f "models.py|models" -x rg -A 10 "class (User|Project)" {}

Length of output: 129

---

Script:

#!/bin/bash
# Search for timezone-related fields and configurations
rg -l "timezone" .

# Search specifically in Python files for timezone-related code
rg "timezone" -t py -A 3 -B 3

# Look for Django model definitions
rg "models\." -t py -A 3 -B 3

# Check settings files
fd -t f "settings.py" -x cat {}

Length of output: 70751

Finishing Touches

• 📝 Generate Docstrings

---

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