CreateWiki icon indicating copy to clipboard operation
CreateWiki copied to clipboard

Add Request Lock to RequestWiki

Open pixDeVl opened this issue 1 year ago • 5 comments

Summary by CodeRabbit

  • New Features

    • Introduced a locking mechanism for wiki requests, allowing users to specify if a wiki page should be locked during creation.
    • Added a new checkbox field for locking functionality in the wiki creation form.
  • Bug Fixes

    • Improved handling of request locking logic during form submission.
  • Database Changes

    • Added a cw_lock column to the cw_requests table, enabling tracking of lock states for requests.

pixDeVl avatar Aug 17 '24 19:08 pixDeVl

[!IMPORTANT]

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

This update introduces a locking mechanism for wiki requests, enhancing control over the creation and management of wiki pages. Key changes include the addition of a locking checkbox in the form, a new lock property in the WikiRequest class, and a corresponding database column. These modifications allow users to specify if a wiki page should be locked, improving user interaction and request handling in the system.

Changes

Files Change Summary
includes/RequestWiki/RequestWikiRequestViewer.php Added lock checkbox to the form descriptor and updated submitForm to handle the lock field in form submissions.
includes/RequestWiki/WikiRequest.php Introduced a public property $lock and a method getLocked() to manage the locking state of requests.
sql/cw_requests.sql, sql/patches/patch-cw_requests-add-cw_lock.sql Added a new column cw_lock (TINYINT, NOT NULL, DEFAULT '0') to the cw_requests table for tracking locking state, enhancing request management capabilities.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Form
    participant RequestWikiRequestViewer
    participant WikiRequest

    User->>Form: Submit new wiki request with lock
    Form->>RequestWikiRequestViewer: submitForm(lock)
    RequestWikiRequestViewer->>WikiRequest: lock = $formData['lock']
    WikiRequest->>WikiRequest: Store lock state
    Note over WikiRequest: Request is created with lock state

🐇 In a world of locks and pages so bright,
A checkbox now dances with delight.
With a click, our wikis can stay secure,
A hop and a skip, we’re ready for more!
Let’s write and create, with joy we will sing,
For locked pages bring a wonderful thing! 🥕✨


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

coderabbitai[bot] avatar Aug 17 '24 19:08 coderabbitai[bot]

@coderabbitai review

RhinosF1 avatar Aug 18 '24 13:08 RhinosF1

Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

coderabbitai[bot] avatar Aug 18 '24 13:08 coderabbitai[bot]

@coderabbitai review

RhinosF1 avatar Aug 18 '24 13:08 RhinosF1

Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

coderabbitai[bot] avatar Aug 18 '24 13:08 coderabbitai[bot]

This will end up being done in #567

Universal-Omega avatar Sep 29 '24 03:09 Universal-Omega