Skip to content

feat: add activated field to modules metadata#439

Merged
Behzad-rabiei merged 2 commits intomainfrom
add-activated-to-module-metadata
Mar 10, 2025
Merged

feat: add activated field to modules metadata#439
Behzad-rabiei merged 2 commits intomainfrom
add-activated-to-module-metadata

Conversation

@Behzad-rabiei
Copy link
Member

@Behzad-rabiei Behzad-rabiei commented Mar 10, 2025

Summary by CodeRabbit

  • New Features
    • Enhanced module metadata validations by adding an activation flag across key components, ensuring improved management of module state.

@coderabbitai
Copy link

coderabbitai bot commented Mar 10, 2025

Walkthrough

This pull request updates several validation schemas in the module.validation.ts file. It adds an activated property (of type Joi.boolean()) to multiple metadata schemas—namely, hivemindDiscordMetadata, hivemindGoogleMetadata, hivemindNotionMetadata, hivemindMediaWikiMetadata, violationDetectionMetadata, and the metadata within dynamicNftOptions. Additionally, the websiteMediaWikiMetadata function was modified to return the new activated property.

Changes

File(s) Change Summary
src/validations/module.validation.ts - Added activated (Joi.boolean()) to: hivemindDiscordMetadata, hivemindGoogleMetadata, hivemindNotionMetadata, hivemindMediaWikiMetadata, violationDetectionMetadata, and dynamicNftOptions.metadata.
- Modified websiteMediaWikiMetadata to include the activated property in its return value.

Poem

Oh, I'm a code-hopping bunny today,
Bringing new booleans in a playful array.
With schemas spruced and formatting so neat,
I nibble bugs and skip to every beat 🐇.
A hopping hooray for changes complete!


📜 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 5988c66 and c724e3b.

📒 Files selected for processing (1)
  • src/validations/module.validation.ts (5 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/validations/module.validation.ts
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: ci / lint / Lint

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

@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 (1)
src/validations/module.validation.ts (1)

49-172: Consider setting a default value for the activated field.

All the added activated fields are optional without default values. Consider adding a default value (e.g., Joi.boolean().default(true)) to ensure consistent behavior when the field is not explicitly provided.

🧰 Tools
🪛 Biome (1.9.4)

[error] 100-100: Do not add then to an object.

(lint/suspicious/noThenProperty)


[error] 104-104: Do not add then to an object.

(lint/suspicious/noThenProperty)


[error] 108-108: Do not add then to an object.

(lint/suspicious/noThenProperty)


[error] 112-112: Do not add then to an object.

(lint/suspicious/noThenProperty)


[error] 116-116: Do not add then to an object.

(lint/suspicious/noThenProperty)


[error] 120-120: Do not add then to an object.

(lint/suspicious/noThenProperty)


[error] 152-152: Do not add then to an object.

(lint/suspicious/noThenProperty)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 835b63a and 5988c66.

📒 Files selected for processing (1)
  • src/validations/module.validation.ts (6 hunks)
🔇 Additional comments (8)
src/validations/module.validation.ts (8)

4-4: LGTM: Clean up of import statement.

The import statement has been consolidated into a single line, which improves code readability.


49-49: Added activated field for consistency.

The addition of the activated boolean field to the hivemindDiscordMetadata schema allows tracking of activation status for Discord modules.


58-58: Added activated field for consistency.

The addition of the activated boolean field to the hivemindGoogleMetadata schema allows tracking of activation status for Google modules.


72-72: Added activated field for consistency.

The addition of the activated boolean field to the hivemindNotionMetadata schema allows tracking of activation status for Notion modules.


79-79: Added activated field for consistency.

The addition of the activated boolean field to the hivemindMediaWikiMetadata schema allows tracking of activation status for MediaWiki modules.


84-86: Updated websiteMediaWikiMetadata to include activated field.

The websiteMediaWikiMetadata function now returns an object with the activated boolean field instead of an empty object, maintaining consistency with other metadata schemas.


136-136: Added activated field for consistency.

The addition of the activated boolean field to the violationDetectionMetadata schema allows tracking of activation status for violation detection modules.


172-172: Added activated field for consistency.

The addition of the activated boolean field to the dynamicNftOptions metadata schema allows tracking of activation status for dynamic NFT modules.

@Behzad-rabiei Behzad-rabiei merged commit db73a8d into main Mar 10, 2025
13 checks passed
@coderabbitai coderabbitai bot mentioned this pull request Apr 16, 2025
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.

1 participant