feat(extensions): add Chat contribution type (SIP-214)

[michael-s-molina]

SUMMARY

Implements the Chat contribution type described in SIP-214, co-authored with Enzo Martellucci (@EnxDev). This introduces the chat and navigation namespaces in @apache-superset/core, giving extensions a first-class API to contribute a persistent chat interface and react to page navigation events. The host manages layout, open/close state, display mode, and persistence — extensions implement the trigger and panel components and use the API to drive behavior.

These are the first two namespaces in a planned series. Surface-specific namespaces (dashboard, explore, SQL Lab, dataset) will follow in subsequent SIPs, allowing extensions to progressively access deeper contextual information. Agentic UI actions — modifying charts, editing queries, triggering workflows — are intentionally out of scope here and deferred to the Client Actions SIP.

Singleton model

Only one chat is active at a time. This is a deliberate design choice: rendering multiple chat providers simultaneously would create competing conversational experiences and introduce ambiguity for the user. Chat is treated as a deployment-level selection rather than a multi-provider composition.

Registering a chat

import { chat } from '@apache-superset/core';
import ChatTrigger from './ChatTrigger';
import ChatPanel from './ChatPanel';

chat.registerChat(
  { id: 'my-org.my-chat', name: 'My Chat' },
  ChatTrigger,
  ChatPanel,
);

The trigger is always visible in the bottom-right corner. The panel can be shown as a floating overlay or as a resizable sidebar docked beside the page content. The user's preference is persisted across reloads.

Display modes

• 'floating' (default) — panel opens as an overlay anchored to the trigger.
• 'panel' — the page layout splits into content + chat sidebar with a draggable divider.

Extensions can switch modes programmatically or react to user-initiated changes:

chat.setDisplayMode('panel');

chat.onDidChangeDisplayMode(mode => {
  console.log('display mode changed to', mode);
});

Navigation awareness

The navigation namespace is new in @apache-superset/core. Extensions can query the current page or subscribe to page changes, enabling context-aware chat behavior:

import { navigation } from '@apache-superset/core';

console.log(navigation.getPage()); // e.g. 'dashboard', 'explore', 'sqllab'

navigation.onDidChangePage(page => {
  console.log('navigated to', page);
});

Documentation

The Contribution Types page and a new Chat reference page (under docs/developer_docs/extensions/) cover registration, display modes, the full open/close and event API, and the navigation namespace.

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

Screen.Recording.2026-06-18.at.10.01.17.mov

TESTING INSTRUCTIONS

Manual verification

Enable the ENABLE_EXTENSIONS feature flag, then create a minimal extension with the following index.tsx:

import React from 'react';
import { chat } from '@apache-superset/core';

const Trigger = () => {
  const handleClick = () =>
    chat.isOpen() ? chat.close() : chat.open();
  return <button onClick={handleClick}>💬</button>;
};

const Panel = () => (
  <div style={{ background: '#fff', height: '100%', padding: 16 }}>
    Hello from chat
  </div>
);

chat.registerChat({ id: 'test.chat', name: 'Test Chat' }, Trigger, Panel);

ADDITIONAL INFORMATION

• Has associated issue
• Required feature flags: Chat host rendering is guarded by the existing ENABLE_EXTENSIONS flag
• Changes UI
• Includes DB Migration
• Introduces new feature or API
• Removes existing feature or API

[bito-code-review]

Bito Review Skipped - Source Branch Not Found

Bito didn’t review this change because the pull request is no longer valid. It may have been merged, or the source/target branch may no longer exist.

[netlify]

✅ Deploy Preview for superset-docs-preview ready!

Name	Link
🔨 Latest commit	d89a9d9
🔍 Latest deploy log	https://app.netlify.com/projects/superset-docs-preview/deploys/6a37c693b5bbdf0009798b2b
😎 Deploy Preview	https://deploy-preview-41205--superset-docs-preview.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
🤖 Make changes	Run an agent on this branch

---

To edit notification comments on pull requests, go to your Netlify project configuration.

[bito-code-review]

The issue is valid. The any type in ComponentType<any> and ComponentProps<any> in superset-frontend/src/views/routes.tsx bypasses TypeScript's type checking, which is discouraged.

To resolve this, you can replace any with unknown or a more specific type if available. Given the context, unknown is a safer alternative that forces explicit type narrowing when the component or props are used.

Would you like me to fetch all other comments on this PR to validate and implement fixes for them as well?

superset-frontend/src/views/routes.tsx

type Routes = {
  path: string;
  Component: ComponentType<unknown>;
  Fallback?: ComponentType<unknown>;
  props?: ComponentProps<unknown>;
}[];

[codecov]

Codecov Report

❌ Patch coverage is 83.76068% with 38 lines in your changes missing coverage. Please review.
✅ Project coverage is 64.39%. Comparing base (b612f57) to head (d89a9d9).

Files with missing lines	Patch %	Lines
superset-frontend/src/views/App.tsx	0.00%	27 Missing ⚠️
superset-frontend/src/views/routes.tsx	0.00%	4 Missing ⚠️
superset-frontend/src/core/editors/index.ts	50.00%	2 Missing ⚠️
superset-frontend/src/core/menus/index.ts	71.42%	2 Missing ⚠️
superset-frontend/src/core/views/index.ts	81.81%	2 Missing ⚠️
superset-frontend/src/core/chat/ChatHost.tsx	96.15%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master   #41205      +/-   ##
==========================================
+ Coverage   64.36%   64.39%   +0.02%     
==========================================
  Files        2653     2659       +6     
  Lines      144867   145018     +151     
  Branches    33421    33449      +28     
==========================================
+ Hits        93250    93389     +139     
- Misses      49946    49956      +10     
- Partials     1671     1673       +2     

Flag	Coverage Δ
hive	39.33% <ø> (ø)
javascript	68.61% <83.76%> (+0.05%)	⬆️
mysql	58.05% <ø> (ø)
postgres	58.12% <ø> (-0.01%)	⬇️
presto	40.92% <ø> (ø)
python	59.56% <ø> (-0.01%)	⬇️
sqlite	57.78% <ø> (ø)
unit	100.00% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[bito-code-review]

Code Review Agent Run #9a27e6

Actionable Suggestions - 1

• superset-frontend/src/core/navigation/index.ts - 1

  • CWE-20: Browser API at module load · Line 60-61

Additional Suggestions - 4

• superset-frontend/src/views/routes.tsx - 1

  • Duplicate route registration · Line 239-239
    The `REGISTRATIONS` route is added twice: once unconditionally at line 239 and again conditionally at line 265 when `authRegistrationEnabled` is true. Remove the duplicate at line 239 to prevent redundant route registration.
    Code suggestion

    --- a/superset-frontend/src/views/routes.tsx
    +++ b/superset-frontend/src/views/routes.tsx
     @@ -236,7 +236,6 @@ const routes: Route[] = [
        { path: RoutePaths.USER_INFO, Component: UserInfo },
        { path: RoutePaths.ACTION_LOG, Component: ActionLogList },
    -  { path: RoutePaths.REGISTRATIONS, Component: UserRegistrations },
      ];
     
      if (isFeatureEnabled(FeatureFlag.TaggingSystem)) {

• superset-frontend/src/core/chat/ChatProvider.test.ts - 2

  • Misleading test name · Line 37-37
    The test name 'returns the descriptor copy' is misleading — `getChat()` returns the original reference (ChatProvider.ts:131), not a copy. The assertion uses `toEqual` which passes due to object identity. If a true copy were intended, `toEqual` would fail since the original object would be reused.
    Code suggestion

    --- superset-frontend/src/core/chat/ChatProvider.test.ts (line 37) ---
     37:-test('registerChat sets the registration and returns the descriptor copy', () => {
    +test('registerChat sets the registration and returns the descriptor', () => {

  • Weak message assertions · Line 54-56
    Warning message assertions use only `toContain` for IDs. The test doesn't verify the 'Using X; discarding Y' message structure, so a malformed message like 'second.chat, first.chat' would pass.
    Code suggestion

    --- superset-frontend/src/core/chat/ChatProvider.test.ts (lines 54-56) ---
     54:   expect(warn).toHaveBeenCalledTimes(1);
     55:   expect(warn.mock.calls[0][0]).toContain('second.chat');
     56:   expect(warn.mock.calls[0][0]).toContain('first.chat');
    +  expect(warn.mock.calls[0][0]).toMatch(/Using ".*"; discarding ".*"/);

• docs/developer_docs/sidebars.js - 1

  • Sidebar naming inconsistency · Line 50-51
    The 'Extension Points' category in developer_docs/sidebars.js now has 3 items (sqllab, editors, chat), but docs/sidebarTutorials.js only has 2 (sqllab, editors). Verify whether the chat extension point should also be added to the tutorials sidebar for consistency.

Filtered by Review Rules

Bito filtered these suggestions based on rules created automatically for your feedback. Manage rules.

• superset-frontend/src/core/chat/ChatHost.test.tsx - 1

  • Spy cleanup timing issue · Line 70-89

Review Details

• Files reviewed - 33 · Commit Range: 380e700..0ad3ef2

  • docs/developer_docs/sidebars.js
  • superset-frontend/packages/superset-core/src/chat/index.ts
  • superset-frontend/packages/superset-core/src/common/index.ts
  • superset-frontend/packages/superset-core/src/contributions/index.ts
  • superset-frontend/packages/superset-core/src/index.ts
  • superset-frontend/packages/superset-core/src/navigation/index.ts
  • superset-frontend/packages/superset-core/src/views/index.ts
  • superset-frontend/src/core/chat/ChatHost.test.tsx
  • superset-frontend/src/core/chat/ChatHost.tsx
  • superset-frontend/src/core/chat/ChatProvider.test.ts
  • superset-frontend/src/core/chat/ChatProvider.ts
  • superset-frontend/src/core/chat/index.test.ts
  • superset-frontend/src/core/chat/index.ts
  • superset-frontend/src/core/editors/EditorProviders.test.ts
  • superset-frontend/src/core/editors/EditorProviders.ts
  • superset-frontend/src/core/editors/index.ts
  • superset-frontend/src/core/index.ts
  • superset-frontend/src/core/menus/index.ts
  • superset-frontend/src/core/navigation/index.test.ts
  • superset-frontend/src/core/navigation/index.ts
  • superset-frontend/src/core/sqlLab/index.ts
  • superset-frontend/src/core/storeUtils.ts
  • superset-frontend/src/core/utils.ts
  • superset-frontend/src/core/views/index.ts
  • superset-frontend/src/extensions/ExtensionsLoader.test.ts
  • superset-frontend/src/extensions/ExtensionsStartup.test.tsx
  • superset-frontend/src/extensions/ExtensionsStartup.tsx
  • superset-frontend/src/extensions/Namespaces.ts
  • superset-frontend/src/utils/localStorageHelpers.ts
  • superset-frontend/src/views/App.tsx
  • superset-frontend/src/views/routePaths.ts
  • superset-frontend/src/views/routes.tsx
  • superset/extensions/utils.py
• Files skipped - 4

  • docs/developer_docs/extensions/contribution-types.md - Reason: Filter setting
  • docs/developer_docs/extensions/extension-points/chat.md - Reason: Filter setting
  • superset-frontend/package-lock.json - Reason: Filter setting
  • superset-frontend/packages/superset-core/package.json - Reason: Filter setting
• Tools

  • Whispers (Secret Scanner) - ✔︎ Successful
  • Detect-secrets (Secret Scanner) - ✔︎ Successful
  • Eslint (Linter) - ✔︎ Successful
  • MyPy (Static Code Analysis) - ✔︎ Successful
  • Astral Ruff (Static Code Analysis) - ✔︎ Successful

---

Bito Usage Guide

Commands

Type the following command in the pull request comment and save the comment.

• /review - Manually triggers a full AI review.

• /pause - Pauses automatic reviews on this pull request.

• /resume - Resumes automatic reviews.

• /resolve - Marks all Bito-posted review comments as resolved.

• /abort - Cancels all in-progress reviews.

Refer to the documentation for additional commands.

Configuration

This repository uses Superset You can customize the agent settings here or contact your Bito workspace admin at evan@preset.io.

Documentation & Help

• Customize agent settings
• Review rules
• General documentation
• FAQ

AI Code Review powered by

[EnxDev]

LGTM, just a few minor nits.

Thank you for all the work you've put into this.
It was a pleasure collaborating with you, and I really enjoyed working together on it!

[bito-code-review]

Code Review Agent Run #732ce7

Actionable Suggestions - 0

Review Details

• Files reviewed - 3 · Commit Range: 0ad3ef2..76f88f5

  • superset-frontend/src/core/storeUtils.ts
  • superset-frontend/src/extensions/ExtensionsStartup.tsx
  • superset-frontend/src/views/App.tsx
• Files skipped - 1

  • docs/developer_docs/extensions/extension-points/chat.md - Reason: Filter setting
• Tools

  • Whispers (Secret Scanner) - ✔︎ Successful
  • Detect-secrets (Secret Scanner) - ✔︎ Successful
  • Eslint (Linter) - ✔︎ Successful

---

Bito Usage Guide

Commands

Type the following command in the pull request comment and save the comment.

• /review - Manually triggers a full AI review.

• /pause - Pauses automatic reviews on this pull request.

• /resume - Resumes automatic reviews.

• /resolve - Marks all Bito-posted review comments as resolved.

• /abort - Cancels all in-progress reviews.

Refer to the documentation for additional commands.

Configuration

This repository uses Superset You can customize the agent settings here or contact your Bito workspace admin at evan@preset.io.

Documentation & Help

• Customize agent settings
• Review rules
• General documentation
• FAQ

AI Code Review powered by

[rusackas]

This LGTM! The host-owned mounting, the per-id error boundaries, and the persistence coverage are all nicely done.

One small thing: routes.tsx widens Component/Fallback to ComponentType<any>. I get that the route components have heterogeneous props, but it's nudging the wrong way on the no-any push — would ComponentType<{ user?: ... }> or even unknown work there, or is that more trouble than it's worth?

Not blocking, EnxDev's already approved at HEAD. Happy to merge.