[WIP] Support multiple bots per instance

[moreal]

⚒️ This pull request isn't ready to be reviewed.

[gemini-code-assist]

Summary of Changes

Hello @moreal, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request introduces a significant architectural enhancement, enabling the hosting of multiple ActivityPub bots within a single application instance. It provides new APIs to create and manage these bots, ensuring they can share common infrastructure while maintaining isolated data storage and handling requests appropriately. This change aims to simplify deployment and resource management for developers running several bots.

Highlights

• Multi-Bot Instance Support: Introduced the capability to host multiple ActivityPub bots within a single application instance, allowing them to share core infrastructure like KV stores and message queues.
• New Instance API: Added a createInstance() function to create a server instance capable of managing multiple bots. This includes a new Instance interface with methods for creating both static and dynamic bots.
• Bot Creation Flexibility: The Instance.createBot() method now supports creating static bots with fixed identifiers and profiles, as well as dynamic bots using a BotDispatcher function for on-demand profile resolution.
• Data Isolation: Implemented bot-scoped data isolation for the SQLite repository (@fedify/botkit-sqlite), adding a botId option to SqliteRepositoryOptions and a bot_id column to all database tables. This ensures each bot's data is separate.
• Session Bot Identity: A new BotInfo interface and Session.botInfo property have been added, allowing event handlers to easily access the identity (identifier, username, name, class) of the bot currently being interacted with.
• Backward Compatibility & Migration: The existing createBot() function continues to work for single-bot use cases, and existing single-bot SQLite databases are automatically migrated to include the new bot_id column for seamless transition.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[codecov]

Codecov Report

❌ Patch coverage is 49.52381% with 53 lines in your changes missing coverage. Please review.
✅ All tests successful. No failed tests found.

Files with missing lines	Patch %	Lines
packages/botkit/src/repository.ts	0.00%	23 Missing ⚠️
packages/botkit-sqlite/src/mod.ts	68.57%	22 Missing ⚠️
packages/botkit/src/session-impl.ts	0.00%	8 Missing ⚠️

Files with missing lines	Coverage Δ
packages/botkit/src/bot-impl.ts	81.68% <100.00%> (+0.03%)	⬆️
packages/botkit/src/bot.ts	75.22% <ø> (ø)
packages/botkit/src/session-impl.ts	80.48% <0.00%> (-1.99%)	⬇️
packages/botkit-sqlite/src/mod.ts	55.80% <68.57%> (+1.38%)	⬆️
packages/botkit/src/repository.ts	82.54% <0.00%> (-2.74%)	⬇️

🚀 New features to boost your workflow:

• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[gemini-code-assist]

Code Review

This pull request introduces significant changes to support hosting multiple bots on a single instance. A new Instance abstraction is added to manage shared infrastructure, and bots can be created statically or dynamically. The SQLite repository is updated with bot_id columns and migrations for data isolation. The KvRepository is also updated to support per-bot data scoping via prefixes.

The changes are well-structured and the new APIs are clearly documented. I've found a couple of minor issues: an empty catch block in the SQLite migration logic that could hide errors, and an unused repository option in CreateInstanceOptions. Overall, this is a great step towards multi-tenancy for BotKit.

[gemini-code-assist]

The empty catch block here is concerning as it can swallow unexpected errors during the database migration, making debugging difficult. While the comment suggests this is to ignore errors on newly created tables, it's safer to log any caught errors. This ensures that if an unexpected issue occurs (e.g., a syntax error, permissions issue), it won't fail silently.

    } catch (error) {
      // Swallowing errors can hide potential issues. It's better to log them,
      // even if they are expected in some cases. This helps with debugging.
      logger.warn(
        `Failed to check for 'bot_id' column on table '${tableName}'. This might be okay if the table was just created.`,
        { error },
      );
    }

[gemini-code-assist]

The repository option in CreateInstanceOptions seems to be unused in the InstanceImpl implementation. The implementation always creates a new KvRepository for each bot with scoped prefixes.

This option is likely a leftover from CreateBotOptions and is misleading for createInstance. For multi-bot support, a single Repository instance is not suitable. Perhaps a repository factory function like (botId: string) => Repository would be more appropriate if custom repository logic is needed per bot.

I'd recommend either removing this option or implementing it as a factory.