feat(core): add support for API extensions

[pcfreak30]

• Implemented APIExtension interface for extending APIs through plugins.
• Added RegisterAPIExtension function for registering API extensions.
• Integrated API extension registration and configuration in portal and HTTP service.
• Modified plugin management to handle API extensions.

Summary by CodeRabbit

• New Features
  • Introduced a framework for plugins to extend API functionalities.
  • Enhanced portal initialization to discover and configure these extensions.
  • Improved error handling during API extension integration for greater stability.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 03d7640

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

This update adds an API extension framework to the project. A new file in the core package defines the APIExtension interface along with thread-safe registration and retrieval functions. The plugin system now allows plugins to specify API extensions through an added field and helper function. The portal and HTTP service components are enhanced to register and configure these extensions during initialization, with added error handling and logging mechanisms.

Changes

Files	Change Summary
core/api_extension.go	New file defining the APIExtension interface (methods: TargetAPI, Configure) and implementing thread-safe management via RegisterAPIExtension and GetAPIExtensions.
core/plugin.go	Adds an APIExtensions field to PluginInfo and introduces PluginHasAPIExtensions to check if a plugin has defined API extensions.
portal.go	Introduces registerAPIExtensions in PortalImpl to iterate over plugins, register API extensions, and update context options in the initialization process.
service/http.go	Updates the Init method: separates main API configuration from extension application by creating a subrouter, iterating over extensions from GetAPIExtensions, and enhancing error logging.

Sequence Diagram(s)

sequenceDiagram
    participant Portal
    participant PluginManager
    participant APIExtensionRegistry

    Portal->>PluginManager: Retrieve available plugins
    PluginManager->>Portal: Return plugin list
    Portal->>PluginManager: Check for API extensions (via PluginHasAPIExtensions)
    alt Plugin has API extensions
      PluginManager->>Portal: Provide API extension(s)
      Portal->>APIExtensionRegistry: Call RegisterAPIExtension(extension)
    else
      Portal-->>Portal: Skip registration
    end

Loading

sequenceDiagram
    participant HTTPService
    participant Router
    participant APIExtensionRegistry
    participant APIExtension

    HTTPService->>Router: Create subrouter for API
    HTTPService->>APIExtensionRegistry: GetAPIExtensions(apiName)
    APIExtensionRegistry->>HTTPService: Return list of API extensions
    loop For each extension
      HTTPService->>APIExtension: Call Configure(router, accessService)
      alt Configuration succeeds
        APIExtension-->>HTTPService: Success log
      else Configuration fails
        APIExtension-->>HTTPService: Error log
      end
    end

Loading

Poem

I'm a bunny in the code garden, so spry,
Hopping through new routes that reach the sky.
Extensions bloom like carrots fresh and bright,
Each new function makes my heart feel light.
With a wiggle and a hop, the changes delight!
🥕🐇 Happy coding, day and night!

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)

• We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
  - To enable this feature, set early_access to true under in the settings.

---

📜 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 ccc9511 and 03d7640.

📒 Files selected for processing (4)

• core/api_extension.go (1 hunks)
• core/plugin.go (2 hunks)
• portal.go (2 hunks)
• service/http.go (1 hunks)

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
• @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.