fix: make session_id visible in Message History Retrieve mode

[Vigtu]

Summary

Fixes the UI bug where the session_id input field was hidden when the Message History component was in "Retrieve" mode, preventing users from dynamically setting the session ID for retrieving specific conversation history.

Changes Made

• Added session_id to default_keys list to make it visible by default
• Added session_id to the Retrieve mode configuration in mode_config
• Kept advanced=True as requested to maintain proper field categorization

Root Cause

The issue was caused by dual visibility control:

1. session_id was missing from mode_config["Retrieve"] list
2. session_id was missing from default_keys list

Test Plan

• Verify session_id field is now visible in Message History component when in Retrieve mode
• Verify session_id field appears in advanced settings section
• Verify the field accepts input and properly retrieves messages for specific sessions

Fixes #9464

Technical Details

Files modified:

• src/backend/base/langflow/components/helpers/memory.py
  • Line 22: Added session_id to default_keys
  • Line 25: Added session_id to Retrieve mode config

The fix ensures the session_id field is properly visible and functional when using the Message History component in Retrieve mode, allowing users to dynamically specify which conversation's messages to retrieve.

Summary by CodeRabbit

• New Features

  • Memory component now supports session-scoped storage and retrieval via a Session ID field.
  • Retrieval can be filtered by Session ID for more precise context handling.
  • Session ID is configurable in the UI across supported modes.

• Chores

  • Updated starter templates (Custom Component Generator, Meeting Summary, Memory Chatbot) to expose and use the Session ID field in the Memory component.

[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

The MemoryComponent now exposes session_id as a public field. default_keys and the Retrieve entry in mode_config were updated to include session_id in the Python component and in three starter project JSONs. No other logic or control-flow changes were introduced.

Changes

Cohort / File(s)	Summary
Memory component (Python) src/backend/base/langflow/components/helpers/memory.py	Added "session_id" to default_keys and to mode_config["Retrieve"] field list.
Starter projects: Memory component exposure src/backend/base/langflow/initial_setup/starter_projects/Custom Component Generator.json, .../Meeting Summary.json, .../Memory Chatbot.json	Updated embedded MemoryComponent metadata: added "session_id" to default_keys and to mode_config["Retrieve"]; updated code hashes accordingly.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  actor U as User
  participant UI as Builder UI
  participant MH as MemoryComponent (Retrieve)
  participant DB as Memory Store

  U->>UI: Configure Retrieve mode
  UI->>MH: Provide n_messages, order, template, memory, session_id
  MH->>DB: Retrieve messages filtered by session_id
  DB-->>MH: Messages
  MH-->>UI: Retrieved history
  UI-->>U: Display results

Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Assessment against linked issues

Objective	Addressed	Explanation
Make session_id visible/connectable in Message History Retrieve mode (#9464)	✅

Possibly related PRs

• feat(auth): update AUTO_LOGIN authentication to enforce API key or JWT requirement #8513 — Also modifies MemoryComponent around session_id handling in starter JSONs; likely adjacent to this UI exposure change.

Suggested labels

size:L, lgtm

Suggested reviewers

• erichare
• edwinjosechittilappilly
• mfortman11

✨ Finishing touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment

---

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

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (2)

src/backend/base/langflow/initial_setup/starter_projects/Memory Chatbot.json (2)

1233-1255: Make session_id visible on initial load (optional UX hardening)

In this starter, the session_id input’s show is set to false. While default_keys + update_build_config should flip visibility at runtime, setting show: true prevents any race/initial-render inconsistencies and guarantees visibility even if the UI doesn’t call update_build_config immediately.

Apply this minimal diff within the Memory node’s template for the session_id field:

-                "show": false,
+                "show": true,

---

972-981: Consider adding mode to field_order near the top (nit)

Field order already includes mode, good. To reinforce UX, ensure it remains the first field (it is now). No change required; just noting that this ordering is important for the visibility logic.

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

• MCP integration is disabled by default for public repositories
• Jira integration is disabled by default for public repositories
• Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between d835313 and 4ff2803.

📒 Files selected for processing (4)

• src/backend/base/langflow/components/helpers/memory.py (1 hunks)
• src/backend/base/langflow/initial_setup/starter_projects/Custom Component Generator.json (2 hunks)
• src/backend/base/langflow/initial_setup/starter_projects/Meeting Summary.json (2 hunks)
• src/backend/base/langflow/initial_setup/starter_projects/Memory Chatbot.json (2 hunks)

🧰 Additional context used

📓 Path-based instructions (3)

src/backend/base/langflow/components/**/*.py

📄 CodeRabbit inference engine (.cursor/rules/backend_development.mdc)

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

Files:

• src/backend/base/langflow/components/helpers/memory.py

{src/backend/**/*.py,tests/**/*.py,Makefile}

📄 CodeRabbit inference engine (.cursor/rules/backend_development.mdc)

{src/backend/**/*.py,tests/**/*.py,Makefile}: Run make format_backend to format Python code before linting or committing changes
Run make lint to perform linting checks on backend Python code

Files:

• src/backend/base/langflow/components/helpers/memory.py

src/backend/**/components/**/*.py

📄 CodeRabbit inference engine (.cursor/rules/icons.mdc)

In your Python component class, set the icon attribute to a string matching the frontend icon mapping exactly (case-sensitive).

Files:

• src/backend/base/langflow/components/helpers/memory.py

⏰ 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). (1)

• GitHub Check: test-starter-projects

🔇 Additional comments (4)

src/backend/base/langflow/components/helpers/memory.py (1)

22-26: session_id visibility confirmed

All verifications passed — the session_id field is now properly exposed in Retrieve mode and remains in the Advanced section:

• In src/backend/base/langflow/components/helpers/memory.py
  • default_keys includes "session_id" (line 22)
  • mode_config["Retrieve"] includes "session_id" (line 25)

• In all starter project templates under
  src/backend/base/langflow/initial_setup/starter_projects
  • default_keys and mode_config["Retrieve"] both include "session_id"

No further action required.

src/backend/base/langflow/initial_setup/starter_projects/Meeting Summary.json (1)

1785-1849: Starter flow embeds updated MemoryComponent (with session_id) — good

The embedded component code now advertises default_keys including session_id and adds it to the Retrieve action. code_hash was updated accordingly. Looks consistent with the Python source.

Please open this starter in the app and switch the Message History node to Retrieve mode. Confirm:

• “Session ID” appears under Advanced.
• Typing a known session_id actually filters messages returned by the node.

src/backend/base/langflow/initial_setup/starter_projects/Memory Chatbot.json (1)

988-1053: Starter flow sync — MemoryComponent code and hash updated

This starter also embeds the new MemoryComponent with session_id added in both places. Hash updated. Matches the fix intent.

src/backend/base/langflow/initial_setup/starter_projects/Custom Component Generator.json (1)

302-302: Session ID exposure in Retrieve mode — looks correct

The embedded MemoryComponent code now includes:

• default_keys = ["mode", "memory", "session_id"]
• mode_config["Retrieve"] includes "session_id"

This should restore the field’s visibility in Retrieve mode while keeping it categorized as advanced. No functional regressions apparent in retrieve_messages/store_message related to session_id handling.

[coderabbitai]

💡 Verification agent

🧩 Analysis chain

Verify code_hash and cross-file consistency

code_hash changed, which is expected after modifying the embedded code. Please confirm the same update (default_keys + Retrieve mode_config) landed in the other starter projects mentioned in the PR description, and that their code_hash values also reflect the new code-string, to avoid drift.

Run this script from the repo root to verify all starter projects and the Python component align:

---

🏁 Script executed:

#!/bin/bash
set -euo pipefail

# 1) Validate starter projects embed session_id in default_keys and Retrieve config
echo "Scanning starter projects for MemoryComponent updates..."
rg -nC2 --glob 'src/backend/base/langflow/initial_setup/starter_projects/*.json' \
  -e 'default_keys\s*=\s*\["mode",\s*"memory",\s*"session_id"\]' \
  -e '"Retrieve":\s*\[.*"session_id".*\]' \
  | sed 's/^/  /' || true

echo
echo "Files missing expected patterns:"
for f in src/backend/base/langflow/initial_setup/starter_projects/*.json; do
  if ! rg -q 'default_keys\s*=\s*\["mode",\s*"memory",\s*"session_id"\]' "$f" \
     || ! rg -q '"Retrieve":\s*\[.*"session_id".*\]' "$f"; then
    echo "  - $f"
  fi
done

# 2) Validate the source component in memory.py has the same changes
echo
echo "Checking source MemoryComponent (memory.py) for the same updates..."
fd memory.py src/backend/base/langflow/components/helpers -x rg -nC2 \
  -e 'default_keys\s*=\s*\["mode",\s*"memory",\s*"session_id"\]' {} \
  -e '"Retrieve":\s*\[.*"session_id".*\]' {} | sed 's/^/  /'

echo
echo "Done."

Length of output: 15734

---

Ensure memory component updates are applied to all starter project JSONs

The MemoryComponent in src/backend/base/langflow/components/helpers/memory.py has been updated to include "session_id" in both default_keys and the "Retrieve" mode configuration, but none of the starter project JSON files under src/backend/base/langflow/initial_setup/starter_projects/ include these changes. To avoid drift and ensure consistency, please apply the following update to every JSON:

-  "default_keys": ["mode", "memory"],
+  "default_keys": ["mode", "memory", "session_id"],

-  "mode_config": {
-    "Store": ["message", "memory", "sender", "sender_name"],
-    "Retrieve": ["n_messages", "order", "template", "memory"]
-  },
+  "mode_config": {
+    "Store":   ["message", "memory", "sender", "sender_name", "session_id"],
+    "Retrieve":["n_messages", "order", "template", "memory", "session_id"]
+  },

Then regenerate each file’s code_hash so it matches the new embedded code string.

Files requiring these updates (all JSONs in the starter_projects directory):

• src/backend/base/langflow/initial_setup/starter_projects/Basic Prompt Chaining.json
• src/backend/base/langflow/initial_setup/starter_projects/Basic Prompting.json
• src/backend/base/langflow/initial_setup/starter_projects/Blog Writer.json
• src/backend/base/langflow/initial_setup/starter_projects/Custom Component Generator.json
• src/backend/base/langflow/initial_setup/starter_projects/Document Q&A.json
• src/backend/base/langflow/initial_setup/starter_projects/Financial Report Parser.json
• src/backend/base/langflow/initial_setup/starter_projects/Hybrid Search RAG.json
• src/backend/base/langflow/initial_setup/starter_projects/Image Sentiment Analysis.json
• src/backend/base/langflow/initial_setup/starter_projects/Instagram Copywriter.json
• src/backend/base/langflow/initial_setup/starter_projects/Invoice Summarizer.json
• src/backend/base/langflow/initial_setup/starter_projects/Knowledge Ingestion.json
• src/backend/base/langflow/initial_setup/starter_projects/Knowledge Retrieval.json
• src/backend/base/langflow/initial_setup/starter_projects/Market Research.json
• src/backend/base/langflow/initial_setup/starter_projects/Meeting Summary.json
• src/backend/base/langflow/initial_setup/starter_projects/Memory Chatbot.json
• src/backend/base/langflow/initial_setup/starter_projects/News Aggregator.json
• src/backend/base/langflow/initial_setup/starter_projects/Nvidia Remix.json
• src/backend/base/langflow/initial_setup/starter_projects/Pokédex Agent.json
• src/backend/base/langflow/initial_setup/starter_projects/Portfolio Website Code Generator.json
• src/backend/base/langflow/initial_setup/starter_projects/Price Deal Finder.json
• src/backend/base/langflow/initial_setup/starter_projects/Research Agent.json
• src/backend/base/langflow/initial_setup/starter_projects/Research Translation Loop.json
• src/backend/base/langflow/initial_setup/starter_projects/SEO Keyword Generator.json
• src/backend/base/langflow/initial_setup/starter_projects/SaaS Pricing.json
• src/backend/base/langflow/initial_setup/starter_projects/Search agent.json
• src/backend/base/langflow/initial_setup/starter_projects/Sequential Tasks Agents.json
• src/backend/base/langflow/initial_setup/starter_projects/Simple Agent.json
• src/backend/base/langflow/initial_setup/starter_projects/Social Media Agent.json
• src/backend/base/langflow/initial_setup/starter_projects/Text Sentiment Analysis.json
• src/backend/base/langflow/initial_setup/starter_projects/Travel Planning Agents.json
• src/backend/base/langflow/initial_setup/starter_projects/Twitter Thread Generator.json
• src/backend/base/langflow/initial_setup/starter_projects/Vector Store RAG.json
• src/backend/base/langflow/initial_setup/starter_projects/Youtube Analysis.json

Committable suggestion skipped: line range outside the PR's diff.

🤖 Prompt for AI Agents

In src/backend/base/langflow/initial_setup/starter_projects/Custom Component
Generator.json around line 240, the starter JSONs do not include the updated
MemoryComponent fields; update every JSON in
src/backend/base/langflow/initial_setup/starter_projects/ to add "session_id" to
MemoryComponent's default_keys and to the "Retrieve" mode configuration
(matching the changes made in
src/backend/base/langflow/components/helpers/memory.py), then recompute and
replace each file's code_hash so it matches the new embedded code string for
that file (ensure the embedded code block and its hash are consistent for each
JSON listed).

[Empreiteiro]

LGTM

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud