feat: support file server for python llamadeploy #703

thucpn · 2025-07-10T03:16:07Z

Summary by CodeRabbit

New Features
- Added support for file server integration in Python llamadeploy environments.
- Enabled file retrieval from LlamaCloud when files are not found locally, using a new environment flag.
- Exposed a new file server URL in the client configuration for improved file handling.
Bug Fixes
- Improved validation logic for incompatible configuration options in llamadeploy environments.
Refactor
- Enhanced starter question initialization for more robust configuration handling.
Chores
- Updated the "@llamaindex/chat-ui" dependency to version 0.5.16.

changeset-bot · 2025-07-10T03:16:11Z

🦋 Changeset detected

Latest commit: b390da3

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-07-10T03:16:13Z

Walkthrough

This change introduces a configurable file server mechanism for the Python llamadeploy environment, adds support for LlamaCloud file retrieval in the file API, and exposes a FILE_SERVER_URL to the frontend. It updates dependency versions, enhances configuration options, and improves type safety and validation logic throughout the server and UI components.

Changes

File(s)	Change Summary
.changeset/wise-ways-knock.md	Documents new file server support for llamadeploy in the changelog.
packages/server/next/app/api/files/[...slug]/route.ts, helpers.ts	Adds LlamaCloud file retrieval logic, a helper to download files, and pipeline/file name parsing.
packages/server/next/app/components/ui/chat/chat-section.tsx	Passes `fileServerUrl` config to chat workflow hook.
packages/server/next/app/components/ui/chat/chat-starter.tsx	Refactors starter questions initialization with improved array/type checks.
packages/server/package.json	Updates `@llamaindex/chat-ui` dependency from 0.5.12 to 0.5.16.
packages/server/src/server.ts, src/types.ts	Adds `serverUrl` and `fileServer` to server config/types; exposes `FILE_SERVER_URL` to client config; improves validation.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant ChatUI
    participant Server (API)
    participant LlamaCloud

    User->>ChatUI: Requests a file via chat
    ChatUI->>Server (API): GET /api/files/[...slug]
    Server (API)->>Server (API): Check local file existence
    alt File not found locally & LlamaCloud enabled
        Server (API)->>LlamaCloud: Request file URL (with pipeline_id, file_name)
        LlamaCloud-->>Server (API): Return file download URL
        Server (API)->>Server (API): Download file and save locally
        Server (API)->>Server (API): Check file existence again
    end
    alt File found locally
        Server (API)-->>ChatUI: Serve file
    else
        Server (API)-->>ChatUI: 404 Not Found
    end

Suggested reviewers

marcusschiesser

Poem

In the warren of code, a new tunnel appears,
File servers now hop where llamas draw near.
Cloud or local, the files will be found,
With URLs and helpers, they bounce all around.
The chat grows more clever, the config more bright—
A rabbit’s delight on a servery night! 🐇✨

📜 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 e5a442e and b390da3.

⛔ Files ignored due to path filters (1)

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

📒 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. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (16)

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

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.

coderabbitai

Actionable comments posted: 3

🧹 Nitpick comments (2)

packages/server/next/app/api/files/helpers.ts (1)
59-92: LGTM: Well-implemented downloadFile function with proper error handling.

The implementation is robust with several good practices:

HTTP status code validation

Directory creation with recursive option

Proper error handling and cleanup

Promise-based approach for better async handling

This is an improvement over the existing implementation in packages/server/src/utils/file.ts (lines 5-32) which lacks HTTP status code validation.

Consider these optional enhancements for production robustness:
 export async function downloadFile(
   urlToDownload: string,
   downloadedPath: string,
 ): Promise<void> {
+  // Validate URL format
+  if (!urlToDownload.startsWith('https://')) {
+    throw new Error('Only HTTPS URLs are supported');
+  }
+
   return new Promise((resolve, reject) => {
     const dir = path.dirname(downloadedPath);
     fs.mkdirSync(dir, { recursive: true });
     const file = fs.createWriteStream(downloadedPath);

-    https
+    const request = https
       .get(urlToDownload, (response) => {
         if (response.statusCode !== 200) {
           reject(
             new Error(`Failed to download file: Status ${response.statusCode}`),
           );
           return;
         }
         // ... rest of implementation
       })
       .on("error", (err) => {
         fs.unlink(downloadedPath, () => reject(err));
       });
+
+    // Set timeout to prevent hanging downloads
+    request.setTimeout(30000, () => {
+      request.destroy();
+      fs.unlink(downloadedPath, () => reject(new Error('Download timeout')));
+    });
   });
 }
packages/server/src/server.ts (1)
117-120: Consider URL construction safety and validation.

The file server URL construction looks correct, but consider adding validation to ensure the URL is well-formed.

Apply this diff to add URL validation:
   // construct file server url for LlamaDeploy
   // eg. for Non-LlamaCloud: localhost:3000/deployments/chat/ui/api/files/data
   // eg. for LlamaCloud: localhost:3000/deployments/chat/ui/api/files/output/llamacloud
+  if (this.serverUrl && !this.serverUrl.startsWith('http')) {
+    console.warn('serverUrl should include protocol (http/https)');
+  }
   const fileServerUrl = `${this.serverUrl}${basePath}/api/files/${this.fileServer}`;

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 2b85420 and e5a442e.

⛔ Files ignored due to path filters (1)

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

📒 Files selected for processing (8)

.changeset/wise-ways-knock.md (1 hunks)
packages/server/next/app/api/files/[...slug]/route.ts (1 hunks)
packages/server/next/app/api/files/helpers.ts (2 hunks)
packages/server/next/app/components/ui/chat/chat-section.tsx (1 hunks)
packages/server/next/app/components/ui/chat/chat-starter.tsx (1 hunks)
packages/server/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)