feat: flag to enable useChatWorkflow #697

thucpn · 2025-06-27T07:30:31Z

Summary by CodeRabbit

New Features
- Introduced support for deployment-specific chat workflows, configurable by deployment and workflow settings.
- Added a feature flag to enable the new chat workflow functionality.
Improvements
- Centralized configuration for resource paths and deployment settings, making logo and script paths dynamic.
- Enhanced error handling in chat UI for more consistent user feedback.
Dependency Updates
- Updated chat UI package to the latest version for improved stability and features.

changeset-bot · 2025-06-27T07:30:35Z

🦋 Changeset detected

Latest commit: 3665318

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 3 packages

Name	Type
@llamaindex/server	Patch
llamaindex-server-examples	Patch
@create-llama/llama-index-server	Patch

Not sure what this means? Click here to learn what changesets are.

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

coderabbitai · 2025-06-27T07:32:18Z

Walkthrough

This update introduces deployment-specific configuration for the server package, enabling a new llamaDeploy option that adjusts routing, constants, and API endpoints based on deployment and workflow names. The client UI now conditionally uses a workflow-based chat handler. Constants for logo and script paths are centralized, and dependencies are updated.

Changes

Files/Groups	Change Summary
`.changeset/brown-readers-whisper.md`	Added patch note for new `useChatWorkflow` feature flag in `@llamaindex/server`.
`packages/server/next/app/constants.ts`	Introduced constants: `BASE_PATH`, `LLAMA_LOGO_URL`, `SCRIPT_PATH` for centralized configuration.
`packages/server/next/app/components/ui/chat/chat-avatar.tsx`, `.../header.tsx`	Replaced hardcoded image paths with `LLAMA_LOGO_URL` from constants module.
`packages/server/next/app/components/ui/chat/chat-section.tsx`	Added conditional logic to use `useChatWorkflow` or standard chat handler based on deployment/workflow config.
`packages/server/next/app/layout.tsx`	Script tag now uses `SCRIPT_PATH` from constants instead of a hardcoded path.
`packages/server/package.json`, `packages/server/project-config/package.json`	Updated `@llamaindex/chat-ui` dependency from `0.5.6` to `0.5.12`.
`packages/server/src/types.ts`	Added `LlamaDeployConfig` type; updated `UIConfig` and `LlamaIndexServerOptions` to support deployment config.
`packages/server/src/server.ts`	Added `llamaDeploy` option, validation, base path logic, and conditional routing/configuration for deployments.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant ChatSection
    participant ChatUI
    participant Server

    User->>ChatSection: Initiates chat
    ChatSection->>ChatSection: Check DEPLOYMENT and WORKFLOW config
    alt Deployment & Workflow set
        ChatSection->>ChatUI: Use workflow-based handler (useChatWorkflow)
    else
        ChatSection->>ChatUI: Use standard chat handler (useChat)
    end
    ChatUI->>Server: Send chat request (API endpoint may be prefixed)
    Server-->>ChatUI: Respond with chat result

Suggested reviewers

marcusschiesser
leehuwuj

Poem

In the meadow of code, a rabbit hops by,
With new deployments set, and workflows to try.
Constants now gathered, no more path fright,
Logos and scripts shining ever so bright.
Chat flows adapt as the server aligns—
Hopping ahead, through deployment-defined pines! 🐇

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f31b609 and 3665318.

📒 Files selected for processing (1)

packages/server/package.json (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

packages/server/package.json

⏰ Context from checks skipped due to timeout of 90000ms (16)

GitHub Check: python (20, 3.11, macos-latest, fastapi, llamacloud)
GitHub Check: python (20, 3.11, ubuntu-22.04, fastapi, none)
GitHub Check: python (20, 3.11, ubuntu-22.04, fastapi, llamacloud)
GitHub Check: python (20, 3.11, windows-latest, fastapi, llamacloud)
GitHub Check: typescript (22, ubuntu-22.04, nextjs, llamacloud)
GitHub Check: python (20, 3.11, windows-latest, fastapi, none)
GitHub Check: typescript (22, windows-latest, nextjs, llamacloud)
GitHub Check: python (20, 3.11, macos-latest, fastapi, none)
GitHub Check: typescript (22, windows-latest, nextjs, none)
GitHub Check: typescript (22, ubuntu-22.04, nextjs, none)
GitHub Check: typescript (22, macos-latest, nextjs, none)
GitHub Check: typescript (22, macos-latest, nextjs, llamacloud)
GitHub Check: Unit Tests (ubuntu-latest, 3.9)
GitHub Check: Unit Tests (windows-latest, 3.9)
GitHub Check: Type Check
GitHub Check: lint

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

🪧 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.
- Explain this complex logic.
- 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 explain this code block.
- @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 explain its main purpose.
- @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in 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.

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.

packages/server/package.json

coderabbitai

Actionable comments posted: 3

🔭 Outside diff range comments (1)

packages/server/src/server.ts (1)

125-129: Replace deprecated fs.exists with fs.access.

fs.exists is deprecated. Also, using synchronous file operations could block the event loop.

-  private async createComponentsDir(componentsDir: string) {
-    const exists = await promisify(fs.exists)(componentsDir);
-    if (!exists) {
-      await promisify(fs.mkdir)(componentsDir);
-    }
-  }
+  private async createComponentsDir(componentsDir: string) {
+    try {
+      await promisify(fs.access)(componentsDir);
+    } catch {
+      await promisify(fs.mkdir)(componentsDir, { recursive: true });
+    }
+  }

♻️ Duplicate comments (1)

packages/server/project-config/package.json (1)

43-45: Same lock-file sync reminder

Project-level pin updated; make sure pnpm install has been run so lock-file and Docker layers stay in sync.

🧹 Nitpick comments (2)

packages/server/next/app/constants.ts (1)

1-11: Consider the implications of runtime BASE_PATH modification.

While the conditional logic for path construction is correct, having BASE_PATH as a mutable export that gets modified at runtime (as seen in server.ts) could lead to potential issues:

In development with hot module replacement, the value might not update correctly

Multiple server instances could have race conditions

Testing could be affected by state persistence

Consider using environment variables or a configuration function instead of runtime file modification.
packages/server/src/server.ts (1)
66-66: Consider making the deployment path pattern configurable.

The hardcoded path pattern /deployments/${deployment}/ui might not suit all deployment scenarios. Consider making this configurable.
-    const basePath = `/deployments/${deployment}/ui`;
+    const basePath = process.env.LLAMA_DEPLOY_BASE_PATH_PATTERN
+      ? process.env.LLAMA_DEPLOY_BASE_PATH_PATTERN.replace('{deployment}', deployment)
+      : `/deployments/${deployment}/ui`;

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 952b5b4 and b314ee7.

⛔ Files ignored due to path filters (1)

pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml

📒 Files selected for processing (10)

.changeset/brown-readers-whisper.md (1 hunks)
packages/server/next/app/components/ui/chat/chat-avatar.tsx (1 hunks)
packages/server/next/app/components/ui/chat/chat-section.tsx (2 hunks)
packages/server/next/app/components/ui/chat/layout/header.tsx (2 hunks)
packages/server/next/app/constants.ts (1 hunks)
packages/server/next/app/layout.tsx (2 hunks)
packages/server/package.json (1 hunks)
packages/server/project-config/package.json (1 hunks)
packages/server/src/server.ts (4 hunks)
packages/server/src/types.ts (1 hunks)

🧰 Additional context used

📓 Path-based instructions (6)

`**/*.{ts,tsx}`: TypeScript code should be linted using ESLint and formatted with Prettier, as enforced by 'pnpm lint' and 'pnpm format' at the root level.

**/*.{ts,tsx}: TypeScript code should be linted using ESLint and formatted with Prettier, as enforced by 'pnpm lint' and 'pnpm format' at the root level.

📄 Source: CodeRabbit Inference Engine (CLAUDE.md)