ref: improve docling template updates and error message

[jordanrfrazier]

Improves the Export Docling component to indicate that it only works with Docling documents. Adds dynamic updates to the template to hide fields that are not relevant for certain image modes.

Summary by CodeRabbit

• New Features

  • Improved export options for Docling documents, with dynamic UI adjustments based on the selected export format for a more intuitive user experience.

• Bug Fixes

  • Enhanced error messages for missing document keys, providing clearer guidance for resolving input issues.
  • Improved authentication logic to handle specific auto-login scenarios more reliably.

• Chores

  • Updated project and dependency versions to 1.5.0 across backend and frontend components.

[coderabbitai]

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

This update increments the project version to 1.5.0 and upgrades the "langflow-base" dependency to 0.5.0. It introduces a new UI configuration update method for document export, enhances error messages for document conversion, and simplifies API key authentication logic.

Changes

Files/Paths	Change Summary
pyproject.toml, src/backend/base/pyproject.toml, src/frontend/package.json	Updated project and package versions to 1.5.0; upgraded "langflow-base" dependency to 0.5.0.
src/backend/base/langflow/base/data/docling_utils.py	Added import for DocumentConverter; improved error message for missing doc_key with conversion guidance.
src/backend/base/langflow/components/docling/export_docling_document.py	Added update_build_config method to dynamically adjust UI options based on export format; enabled real-time refresh.
src/backend/base/langflow/services/auth/utils.py	Simplified API key validation logic; added early return for auto-login bypass; unified API key check path.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant UI
    participant ExportDoclingDocumentComponent

    User->>UI: Selects export format
    UI->>ExportDoclingDocumentComponent: Calls update_build_config(format)
    ExportDoclingDocumentComponent-->>UI: Returns updated config (show/hide options)

Loading

sequenceDiagram
    participant Request
    participant api_key_security
    participant UserRead

    Request->>api_key_security: Request with/without API key
    alt skip_auth_auto_login enabled and no API key
        api_key_security-->>Request: Return validated UserRead
    else API key provided
        api_key_security->>api_key_security: check_key(API key)
        api_key_security-->>Request: Return result or error
    end

Loading

Suggested labels

refactor, enhancement, size:S, lgtm

Suggested reviewers

• erichare

✨ Finishing Touches

🧪 Generate Unit Tests

• Create PR with Unit Tests
• Post Copyable Unit Tests in a Comment
• Commit Unit Tests in branch docling-qol

---

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.
  • 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 auto-generate unit tests to generate unit tests 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.

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: 2

🧹 Nitpick comments (1)

src/backend/base/langflow/components/docling/export_docling_document.py (1)

71-85: Good implementation with a minor optimization opportunity.

The dynamic UI configuration logic correctly shows/hides relevant fields based on export format:

• Markdown-specific placeholders are hidden for non-Markdown formats
• Image mode is hidden for text-only formats (Plaintext/DocTags)

Apply this diff to improve code readability by merging the multiple comparisons:

-        elif field_name == "export_format" and (field_value == "Plaintext" or field_value == "DocTags"):
+        elif field_name == "export_format" and field_value in {"Plaintext", "DocTags"}:

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between e280932 and 786b1d9.

⛔ Files ignored due to path filters (2)

• src/frontend/package-lock.json is excluded by !**/package-lock.json
• uv.lock is excluded by !**/*.lock

📒 Files selected for processing (6)

• pyproject.toml (2 hunks)
• src/backend/base/langflow/base/data/docling_utils.py (2 hunks)
• src/backend/base/langflow/components/docling/export_docling_document.py (3 hunks)
• src/backend/base/langflow/services/auth/utils.py (2 hunks)
• src/backend/base/pyproject.toml (1 hunks)
• src/frontend/package.json (1 hunks)

🧰 Additional context used

📓 Path-based instructions (5)

`{uv.lock,pyproject.toml}`: Use uv (>=0.4) as the Python package manager for dependency management

{uv.lock,pyproject.toml}: Use uv (>=0.4) as the Python package manager for dependency management

📄 Source: CodeRabbit Inference Engine (.cursor/rules/backend_development.mdc)

List of files the instruction was applied to:

• pyproject.toml

`src/frontend/{package*.json,tsconfig.json,tailwind.config.*,vite.config.*}`: Fr...

src/frontend/{package*.json,tsconfig.json,tailwind.config.*,vite.config.*}: Frontend configuration files such as 'package.json', 'tsconfig.json', 'tailwind.config.', and 'vite.config.' must be present and properly maintained in 'src/frontend/'.

📄 Source: CodeRabbit Inference Engine (.cursor/rules/frontend_development.mdc)

List of files the instruction was applied to:

• src/frontend/package.json

`src/backend/**/*.py`: Run make format_backend to format Python code early and often Run make lint to check for linting issues in backend Python code

src/backend/**/*.py: Run make format_backend to format Python code early and often
Run make lint to check for linting issues in backend Python code

📄 Source: CodeRabbit Inference Engine (.cursor/rules/backend_development.mdc)

List of files the instruction was applied to:

• src/backend/base/langflow/base/data/docling_utils.py
• src/backend/base/langflow/services/auth/utils.py
• src/backend/base/langflow/components/docling/export_docling_document.py

`src/backend/base/langflow/components/**/*.py`: Add new backend components to th...

src/backend/base/langflow/components/**/*.py: Add new backend components to the appropriate subdirectory under src/backend/base/langflow/components/
Implement async component methods using async def and await for asynchronous operations
Use asyncio.create_task for background work in async components and ensure proper cleanup on cancellation
Use asyncio.Queue for non-blocking queue operations in async components and handle timeouts appropriately

📄 Source: CodeRabbit Inference Engine (.cursor/rules/backend_development.mdc)

List of files the instruction was applied to:

• src/backend/base/langflow/components/docling/export_docling_document.py

`src/backend/**/components/**/*.py`: In your Python component class, set the `icon` attribute to a string matching the frontend icon mapping exactly (case-sensitive).

src/backend/**/components/**/*.py: In your Python component class, set the icon attribute to a string matching the frontend icon mapping exactly (case-sensitive).

📄 Source: CodeRabbit Inference Engine (.cursor/rules/icons.mdc)

List of files the instruction was applied to:

• src/backend/base/langflow/components/docling/export_docling_document.py

🧠 Learnings (5)

src/backend/base/pyproject.toml (4)

Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/backend_development.mdc:0-0
Timestamp: 2025-06-30T14:39:17.428Z
Learning: Applies to src/backend/base/langflow/components/**/__init__.py : Update __init__.py with alphabetical imports when adding new components

Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/testing.mdc:0-0
Timestamp: 2025-06-30T14:41:58.837Z
Learning: Applies to {src/backend/tests/**/*.py,tests/**/*.py} : Test backward compatibility across Langflow versions by mapping component files to supported versions using 'VersionComponentMapping'.

Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/backend_development.mdc:0-0
Timestamp: 2025-06-30T14:39:17.428Z
Learning: Applies to src/backend/base/langflow/components/**/*.py : Add new backend components to the appropriate subdirectory under src/backend/base/langflow/components/

Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/testing.mdc:0-0
Timestamp: 2025-06-30T14:41:58.837Z
Learning: Applies to {src/backend/tests/**/*.py,tests/**/*.py} : Test Langflow's REST API endpoints using the async 'client' fixture and assert correct status codes and response structure.

pyproject.toml (1)

Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/testing.mdc:0-0
Timestamp: 2025-06-30T14:41:58.837Z
Learning: Applies to {src/backend/tests/**/*.py,tests/**/*.py} : Test backward compatibility across Langflow versions by mapping component files to supported versions using 'VersionComponentMapping'.

src/frontend/package.json (5)

Learnt from: ogabrielluiz
PR: langflow-ai/langflow#0
File: :0-0
Timestamp: 2025-06-26T19:43:18.260Z
Learning: In langflow custom components, the `module_name` parameter is now propagated through template building functions to add module metadata and code hashes to frontend nodes for better component tracking and debugging.

Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/frontend_development.mdc:0-0
Timestamp: 2025-06-30T14:40:29.494Z
Learning: Applies to src/frontend/src/components/**/*FlowGraph.tsx : Use React Flow for flow graph visualization components.

Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/frontend_development.mdc:0-0
Timestamp: 2025-06-30T14:40:29.494Z
Learning: Applies to src/frontend/{package*.json,tsconfig.json,tailwind.config.*,vite.config.*} : Frontend configuration files such as 'package.json', 'tsconfig.json', 'tailwind.config.*', and 'vite.config.*' must be present and properly maintained in 'src/frontend/'.

Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/backend_development.mdc:0-0
Timestamp: 2025-06-30T14:39:17.428Z
Learning: Starter project files are auto-formatted after langflow run; these changes can be committed or ignored

Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-06-30T14:40:02.667Z
Learning: Applies to docs/docs/**/*.{md,mdx} : Use consistent terminology: always capitalize 'Langflow', 'Component', and 'Flow' when referring to Langflow concepts; always uppercase 'API' and 'JSON'.

src/backend/base/langflow/services/auth/utils.py (1)

Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/backend_development.mdc:0-0
Timestamp: 2025-06-30T14:39:17.428Z
Learning: Applies to src/backend/tests/unit/components/**/*.py : Test authenticated FastAPI endpoints using logged_in_headers in tests

src/backend/base/langflow/components/docling/export_docling_document.py (2)

Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/testing.mdc:0-0
Timestamp: 2025-06-30T14:41:58.837Z
Learning: Applies to {src/backend/tests/**/*.py,tests/**/*.py} : Test component configuration updates by asserting changes in build config dictionaries.

Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/backend_development.mdc:0-0
Timestamp: 2025-06-30T14:39:17.428Z
Learning: Applies to src/backend/base/langflow/components/**/__init__.py : Update __init__.py with alphabetical imports when adding new components

🪛 Ruff (0.11.9)

src/backend/base/langflow/base/data/docling_utils.py

2-2: docling.document_converter.DocumentConverter imported but unused

Remove unused import: docling.document_converter.DocumentConverter

(F401)

---

30-30: Line too long (197 > 120)

(E501)

src/backend/base/langflow/components/docling/export_docling_document.py

80-80: Consider merging multiple comparisons: field_value in {"Plaintext", "DocTags"}.

Merge multiple comparisons

(PLR1714)

🪛 Flake8 (7.2.0)

src/backend/base/langflow/base/data/docling_utils.py

[error] 2-2: 'docling.document_converter.DocumentConverter' imported but unused

(F401)

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

• GitHub Check: Update Starter Projects
• GitHub Check: Run Ruff Check and Format
• GitHub Check: Ruff Style Check (3.13)
• GitHub Check: Optimize new Python code in this PR
• GitHub Check: autofix

🔇 Additional comments (6)

src/backend/base/langflow/services/auth/utils.py (2)

62-62: LGTM! Critical bug fix for auto-login flow.

The added return statement correctly fixes a bug where the auto-login path would not return the UserRead model when skip_auth_auto_login is enabled, which would have caused the function to fall through unexpectedly.

---

68-68: Good simplification of API key validation logic.

The consolidation of API key validation using query_param or header_param eliminates code duplication while maintaining the same logical behavior. This makes the code more maintainable and easier to understand.

Also applies to: 77-77

src/frontend/package.json (1)

3-3: Version bump looks good.

The frontend version update to 1.5.0 is consistent with the coordinated release across the project components.

pyproject.toml (1)

3-3: Version synchronization looks correct.

Both the project version bump to 1.5.0 and the langflow-base dependency update to 0.5.0 are properly synchronized for this coordinated release.

Also applies to: 20-20

src/backend/base/pyproject.toml (1)

3-3: Backend version update is consistent.

The langflow-base version bump to 0.5.0 aligns with the overall project release and dependency updates.

src/backend/base/langflow/components/docling/export_docling_document.py (1)

31-31: LGTM! Real-time refresh enables dynamic UI updates.

The addition of real_time_refresh=True correctly enables immediate UI configuration updates when the export format changes, which aligns with the new update_build_config method functionality.

[coderabbitai]

⚠️ Potential issue

Remove unused import.

The DocumentConverter import is not used anywhere in the code and should be removed to avoid clutter.

-from docling.document_converter import DocumentConverter

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

	from docling.document_converter import DocumentConverter
	# (The import for DocumentConverter has been removed)

🧰 Tools

🪛 Ruff (0.11.9)

2-2: docling.document_converter.DocumentConverter imported but unused

Remove unused import: docling.document_converter.DocumentConverter

(F401)

🪛 Flake8 (7.2.0)

[error] 2-2: 'docling.document_converter.DocumentConverter' imported but unused

(F401)

🤖 Prompt for AI Agents

In src/backend/base/langflow/base/data/docling_utils.py at line 2, the import of
DocumentConverter is unused and should be removed to clean up the code. Delete
the line importing DocumentConverter from docling.document_converter.