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

fix: create cycle function #5775

Merged
merged 2 commits into from
Oct 8, 2024
Merged

fix: create cycle function #5775

merged 2 commits into from
Oct 8, 2024

Conversation

gakshita
Copy link
Collaborator

@gakshita gakshita commented Oct 8, 2024

Summary
Removed annotation from createCycle func from makeObserver to allow function overriding

Summary by CodeRabbit

  • New Features
    • Enhanced state management for cycle creation with improved asynchronous handling.
    • Introduced a placeholder method for future functionality to fetch active cycle progress.
    • Added a new endpoint to convert a draft issue to a regular issue.
    • Implemented versioning information in API responses for cycle-related data.
    • Enhanced draft issue functionality, allowing for the creation of issues from drafts with improved data management.

Copy link
Contributor

coderabbitai bot commented Oct 8, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The changes primarily involve modifications to the CycleStore class in the cycle.store.ts file, where the createCycle method's signature has been updated to utilize an action decorator, enhancing its compatibility with MobX's state management. A new method, fetchActiveCycleProgressPro, has also been added as an action but remains unimplemented. Similar improvements have been made across various files, focusing on enhancing readability, maintainability, and functionality within the API and serializers.

Changes

File Path Change Summary
web/core/store/cycle.store.ts - Updated createCycle method to use action decorator for async handling.
- Added unimplemented method fetchActiveCycleProgressPro.
apiserver/plane/api/views/cycle.py - Simplified conditions in get and patch methods for clarity.
apiserver/plane/app/serializers/draft.py - Added project_id handling in create and update methods of DraftIssueCreateSerializer.
- Updated references from issue to draft_issue in various places.
apiserver/plane/app/urls/workspace.py - Added new URL path for converting a draft issue to a regular issue.
apiserver/plane/app/views/cycle/base.py - Added version field to response in list, create, partial_update, and retrieve methods.
apiserver/plane/app/views/workspace/draft.py - Added create_draft_to_issue method to facilitate issue creation from a draft.

Possibly related PRs

  • [WEB-2007] fix: cycles loading optimization #5207: The changes in the CycleStore class in the main PR enhance the handling of asynchronous actions, which relates to the modifications in the ICycleStore interface and CycleStore class in this PR, indicating a focus on state management improvements.
  • fix: create cycle function #5775: The main PR updates the createCycle method to improve its integration with MobX, which directly relates to the changes made in the createCycle function in this PR, focusing on function overriding and flexibility in usage.

Suggested labels

🌐frontend, ⚙️backend

Suggested reviewers

  • pablohashescobar
  • sriramveeraghanta

Poem

🐰 In the store where cycles spin,
A new action's tucked within.
With MobX now in play,
Async updates lead the way.
Fetching progress, soon to be,
A hopping change for all to see! 🌼


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 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: 0

🧹 Outside diff range and nitpick comments (1)
web/core/store/cycle.store.ts (1)

619-619: Implementation needed for fetchActiveCycleProgressPro.

The fetchActiveCycleProgressPro method has been added with the correct action decorator, but it currently lacks implementation. This might be intentional if it's a placeholder for future functionality.

Would you like assistance in implementing this method or creating a TODO comment to track this task?

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 6e52f1b and efb61d4.

📒 Files selected for processing (1)
  • web/core/store/cycle.store.ts (1 hunks)
🧰 Additional context used
🔇 Additional comments (1)
web/core/store/cycle.store.ts (1)

619-627: LGTM! Improved MobX integration for createCycle method.

The changes to the createCycle method enhance its integration with MobX:

  1. Using the action decorator explicitly marks this method as a MobX action.
  2. Converting to an arrow function ensures proper this binding.

These modifications guarantee that all state changes within createCycle are correctly tracked by MobX, leading to more predictable and efficient state management.

@pushya22 pushya22 merged commit 6d78418 into preview Oct 8, 2024
9 of 13 checks passed
@pushya22 pushya22 deleted the fix-create-cycle branch October 8, 2024 14:31
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.

4 participants