added bus message mycroft.skill.ready

[builderjer]

Emits a bus message, mycroft.skill.ready after each skill is loaded. This allows for the skill to perform specific tasks after is is loaded correctly.

Summary by CodeRabbit

• New Features
  • Enhanced skill initialization now includes an automatic readiness notification that informs other system components once the skill is fully loaded, promoting smoother integration and coordination.

[coderabbitai]

Walkthrough

The update modifies the on_ready_status method in the OVOSSkill class within ovos_workshop/skills/ovos.py. A new call to self.bus.emit(Message("mycroft.skill.ready", {"id": self.skill_id})) has been added to emit a readiness message once the skill initialization is complete. This change incorporates an additional notification mechanism while retaining the existing logging functionality.

Changes

File Path	Change Summary
ovos_workshop/.../ovos.py	Added a call to self.bus.emit(Message("mycroft.skill.ready", {"id": self.skill_id})) in the on_ready_status method to notify when the skill is ready.

Sequence Diagram(s)

sequenceDiagram
    participant Skill as OVOSSkill
    participant Bus
    participant Listener as Other Components
    Skill->>Skill: on_ready_status()
    Skill->>Bus: emit(Message("mycroft.skill.ready", {"id": self.skill_id}))
    Bus->>Listener: Dispatch "mycroft.skill.ready" message

Loading

Poem

I'm a rabbit coder, hopping with delight,
Sending ready messages out of sight!
I tap the code with eager feet,
Ensuring all is primed and neat.
With every hop, the system beams bright!
🐇✨

✨ Finishing Touches

• 📝 Generate Docstrings (Beta)

---

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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

ovos_workshop/skills/ovos.py (1)

752-754: Consider enhancing the message data and documentation.

While the implementation is correct, consider these improvements:

1. Add docstring to describe the bus message emission.
2. Consider including additional context in the message data, such as:
   • Skill name
   • Initialization timestamp
   • Skill version

Example enhancement:

 def on_ready_status(self):
+    """
+    Called when the skill is ready. Logs the status and emits a bus message.
+    
+    Emits:
+        mycroft.skill.ready: Indicates skill is initialized and ready
+        Message data includes:
+            - id: Unique skill identifier
+    """
     LOG.info(f'{self.skill_id} is ready.')
-    self.bus.emit(Message("mycroft.skill.ready", {"id": self.skill_id}))
+    self.bus.emit(Message("mycroft.skill.ready", {
+        "id": self.skill_id,
+        "name": self.name,
+        "timestamp": time.time()
+    }))

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between cfaec5a and 2d4a874.

📒 Files selected for processing (1)

• ovos_workshop/skills/ovos.py (1 hunks)

🔇 Additional comments (1)

ovos_workshop/skills/ovos.py (1)

753-754: LGTM! The bus message emission is well-placed and properly implemented.

The addition of the bus message mycroft.skill.ready with the skill's ID is a good enhancement that enables skills to execute specific tasks after loading. The message is emitted after logging, which maintains a logical sequence of operations.