Update documentation and configuration to reflect the transition from…#203
Update documentation and configuration to reflect the transition from…#203AnkushMalaker merged 3 commits intodevfrom
Conversation
… 'friend-backend' to 'chronicle-backend' across various files, including setup instructions, Docker configurations, and service logs.
|
Caution Review failedThe pull request is closed. WalkthroughSystematically renames backend service references from "friend-backend" to "chronicle-backend" across CI/CD workflows, Docker configurations, nginx routing, test infrastructure, and documentation. No functional logic modifications or control-flow changes. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~15 minutes
Possibly related PRs
Suggested reviewers
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
📜 Recent review detailsConfiguration used: defaults Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
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. Comment |
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
CLAUDE.md (1)
59-183: Test environment configuration has a critical mismatch requiring correction.Port numbers and credentials align with documentation as verified:
- Backend (8001), WebUI (3001), Qdrant (6337/6338), MongoDB (27018), and Redis (6380) ports correctly prevent conflicts with production ports (8000, 3000, 6333, 6334, 27017, 6379).
- Test credentials (AUTH_SECRET_KEY, ADMIN_EMAIL, ADMIN_PASSWORD) match documented values exactly.
However,
DISABLE_SPEAKER_RECOGNITIONis set tofalsein docker-compose-test.yml, contradicting the documentation which states it should betrueto prevent segment duplication. Update the test configuration to match the documented intent.
🧹 Nitpick comments (1)
backends/advanced/Caddyfile.template (1)
1-1: Consider updating the file header comment.Line 1 references "Friend-Lite" which is inconsistent with the repository-wide rename to Chronicle. Consider updating to "Chronicle" for consistency.
🔎 Suggested update:
-# Caddy reverse proxy configuration for Friend-Lite +# Caddy reverse proxy configuration for Chronicle
📜 Review details
Configuration used: defaults
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (22)
.github/workflows/robot-tests.yml(2 hunks)CLAUDE.md(1 hunks)Docs/getting-started.md(1 hunks)Docs/init-system.md(1 hunks)backends/advanced/Caddyfile.template(3 hunks)backends/advanced/Docs/HTTPS_SETUP.md(4 hunks)backends/advanced/Docs/README.md(1 hunks)backends/advanced/Docs/architecture.md(2 hunks)backends/advanced/Docs/auth.md(2 hunks)backends/advanced/Docs/quickstart.md(1 hunks)backends/advanced/docker-compose.yml(1 hunks)backends/advanced/nginx.conf.template(10 hunks)backends/advanced/tests/test_integration.py(1 hunks)backends/advanced/webui/README.md(3 hunks)backends/simple/README.md(1 hunks)backends/simple/docker-compose.yml(2 hunks)extras/speaker-recognition/docker-compose.yml(1 hunks)skaffold.yaml(2 hunks)tests/TESTING_USER_GUIDE.md(1 hunks)tests/endpoints/rq_queue_tests.robot(1 hunks)tests/run-robot-tests.sh(4 hunks)tests/setup/README.md(1 hunks)
🧰 Additional context used
📓 Path-based instructions (3)
**/*.robot
📄 CodeRabbit inference engine (CLAUDE.md)
**/*.robot: When writing or modifying Robot Framework tests, follow the testing guidelines in @tests/TESTING_GUIDELINES.md and approved tags in @tests/tags.md. Only use the 11 approved tags, tab-separated.
Before writing any Robot Framework test code, scan relevant resource files for existing keywords. NEVER write code that duplicates existing keywords.
Follow the Arrange-Act-Assert pattern in Robot Framework tests with inline verifications (not abstracted to keywords)
Only create Robot Framework keywords for reusable setup/action operations AFTER confirming no existing keyword exists. Keep verifications inline in tests, not in resource keywords.
Use tab-separated tags in Robot Framework tests. DO NOT use space-separated tags. Only use the 11 approved tags from @tests/tags.md.
Use descriptive Robot Framework test and keyword names that explain business purpose, not technical implementation
Files:
tests/endpoints/rq_queue_tests.robot
**/docker-compose*.{yml,yaml}
📄 CodeRabbit inference engine (CLAUDE.md)
Check if src/ is volume mounted. If not, run
docker compose buildso that code changes are reflected. Do not simply rundocker compose restartas it will not rebuild the image.
Files:
backends/simple/docker-compose.ymlbackends/advanced/docker-compose.ymlextras/speaker-recognition/docker-compose.yml
**/*.py
📄 CodeRabbit inference engine (CLAUDE.md)
**/*.py: Use Black formatter with 100-character line length for Python code
Use isort for import sorting in Python code
ALL imports must be at the top of the file after the docstring. NEVER import modules in the middle of functions or files. Use lazy imports sparingly and only when absolutely necessary for circular import issues.
Group imports in order: standard library, third-party, local imports
Always raise errors, never silently ignore. Use explicit error handling with proper exceptions rather than silent failures.
Do not add defensivehasattr()checks. Research and understand input/response or class structure instead.
Useuv run pythonoruv run python3instead of directpythonorpython3commands for Python execution
Files:
backends/advanced/tests/test_integration.py
🧠 Learnings (2)
📚 Learning: 2025-12-16T14:24:28.301Z
Learnt from: CR
Repo: chronicler-ai/chronicle PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-12-16T14:24:28.301Z
Learning: Applies to **/{websocket,ws,audio,streaming}*.py : Use Wyoming protocol (JSONL + binary) for WebSocket communication with structured audio sessions
Applied to files:
backends/advanced/nginx.conf.template
📚 Learning: 2025-12-08T23:52:34.959Z
Learnt from: AnkushMalaker
Repo: chronicler-ai/chronicle PR: 178
File: backends/advanced/src/advanced_omi_backend/services/memory/providers/mycelia.py:218-223
Timestamp: 2025-12-08T23:52:34.959Z
Learning: In Python code (chronicle project), prefer logging.exception() inside except blocks to automatically log the full stack trace. When re-raising exceptions, always chain with 'raise ... from e' to preserve the original context; use 'raise ... from None' only if you explicitly want to suppress the context. This improves debuggability across Python files.
Applied to files:
backends/advanced/tests/test_integration.py
🧬 Code graph analysis (1)
backends/advanced/tests/test_integration.py (4)
backends/advanced/src/advanced_omi_backend/routers/modules/health_routes.py (1)
health_check(84-479)backends/advanced/src/advanced_omi_backend/llm_client.py (2)
health_check(33-35)health_check(110-136)backends/advanced/src/advanced_omi_backend/speaker_recognition_client.py (1)
health_check(589-626)extras/asr-services/parakeet-offline.py (1)
health_check(439-441)
🪛 Ruff (0.14.8)
backends/advanced/tests/test_integration.py
460-460: Starting a process with a partial executable path
(S607)
⏰ 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: robot-tests
🔇 Additional comments (29)
backends/advanced/webui/README.md (1)
60-60: Service rename is complete and verified.The
chronicle-backendservice is properly defined in the docker-compose.yml configuration, and all documentation references are consistent across the README (lines 60, 73, and 82). No remainingfriend-backendreferences exist in the documentation.backends/advanced/Docs/quickstart.md (1)
397-397: Documentation update is correct and verified.The troubleshooting command correctly references
chronicle-backend, which is the actual service name defined inbackends/advanced/docker-compose.yml. The change is accurate and will function as expected end-to-end.skaffold.yaml (2)
198-198: Deploy image reference correctly updated.The deploy images list has been updated to reference
chronicle-backend-test, which is consistent with the build artifact name change at line 187.
187-187: Image rename to chronicle-backend-test is complete and consistent.The rename from
friend-backend-testtochronicle-backend-testis correctly reflected in both the build artifacts (line 187) and deploy images (line 198). No remaining references to the old name exist in the codebase.CLAUDE.md (2)
16-58: All referenced setup documentation files exist and are correctly linked.Verification confirms that all files referenced in the Initial Setup & Configuration section (quickstart.md, Docs/init-system.md, Docs/getting-started.md, backends/advanced/SETUP_SCRIPTS.md, backends/advanced/Docs/quickstart.md, wizard.py, backends/advanced/init.py, extras/speaker-recognition/init.py) are present in the repository. The section provides clear, well-structured guidance with no broken documentation links.
452-470: Verify Robot Framework testing documentation references.The Robot Framework testing section references documentation files and resource keywords. Verification confirms:
- ✓
tests/TESTING_GUIDELINES.mdexists and contains testing patterns- ✓
tests/tags.mdexists and lists exactly 11 approved tags- ✓ Resource keyword files exist in
tests/resources/(e.g.,queue_keywords.robot,conversation_keywords.robot,audio_keywords.robot,chat_keywords.robot,memory_keywords.robot)The reference to
websocket_keywords.robotis inaccurate—no keyword file with this name exists in the repository. Use the existing resource files intests/resources/when checking for reusable keywords.Likely an incorrect or invalid review comment.
Docs/getting-started.md (1)
396-402: LGTM! Documentation updated correctly.The troubleshooting documentation now references the correct service name
chronicle-backend, which matches the updated docker-compose configuration.backends/simple/README.md (1)
115-123: LGTM! Documentation updated correctly.The monitoring documentation now references the correct service name
chronicle-backend, consistent with the updated docker-compose configuration.backends/advanced/Docs/architecture.md (2)
585-595: LGTM! Architecture diagram updated correctly.The mermaid diagram now references
chronicle-backend, consistent with the service name changes throughout the repository.
619-625: LGTM! Section heading updated correctly.The container specification section now references
chronicle-backend, maintaining consistency with the docker-compose configuration.tests/setup/README.md (1)
210-224: LGTM! Test documentation updated correctly.The container inspection command now references the correct test container name
advanced-chronicle-backend-test-1, which aligns with the updated service naming in the test docker-compose configuration.tests/endpoints/rq_queue_tests.robot (1)
26-42: LGTM! Test keyword updated correctly.The
Restart Backend Servicekeyword now references the correct test service namechronicle-backend-testin both the stop and start commands, ensuring consistency with the test environment configuration..github/workflows/robot-tests.yml (2)
134-154: LGTM! CI/CD readiness check updated correctly.The backend readiness waiting loop now references the correct test service name
chronicle-backend-testin the logging output, ensuring proper visibility during CI/CD runs.
217-226: LGTM! CI/CD failure logging updated correctly.The service log display step now references the correct test service name
chronicle-backend-test, ensuring accurate log collection when tests fail.extras/speaker-recognition/docker-compose.yml (1)
109-112: LGTM! Network rename is consistent.The network name change from
friend-networktochronicle-networkaligns with the broader renaming across the repository. Since this is an external network, ensure that all services referencing this network are updated together (which appears to be covered by this PR).After merging, recreate the containers to apply the network name change:
#!/bin/bash # Navigate to the directory cd extras/speaker-recognition # Stop and remove existing containers docker compose down # Start with new network name docker compose up -d # Verify network creation docker network ls | grep chronicle-networkbackends/advanced/docker-compose.yml (1)
226-230: LGTM! Network configuration updated correctly.The default network name change from
friend-networktochronicle-networkis consistent with the repository-wide renaming.After merging, recreate the containers to apply the network name change:
#!/bin/bash # Navigate to the directory cd backends/advanced # Stop and remove existing containers with old network docker compose down # Start with new network configuration docker compose up --build -d # Verify the new network is created docker network ls | grep chronicle-networkAs per coding guidelines, since
src/is volume-mounted, code changes are reflected without rebuild, but network name changes require container recreation.backends/advanced/Docs/auth.md (1)
263-263: LGTM! Documentation updated consistently.The log commands correctly reference the renamed
chronicle-backendservice.Also applies to: 275-275
tests/TESTING_USER_GUIDE.md (1)
725-725: LGTM! Test documentation updated correctly.The container name reference aligns with the renamed test service.
Docs/init-system.md (1)
213-213: LGTM! Service reference updated correctly.The log command now correctly targets the renamed backend service.
backends/advanced/nginx.conf.template (1)
46-47: LGTM! Comprehensive nginx configuration update.All upstream and proxy_pass references consistently updated from
friend_backendtochronicle_backendacross all routes (API, auth, WebSocket endpoints, health checks). The configuration maintains correct proxy behavior with the renamed service.Also applies to: 73-73, 83-83, 93-93, 103-103, 120-120, 138-138, 156-156, 165-165, 174-174
backends/advanced/tests/test_integration.py (1)
460-460: LGTM! Test health check updated correctly.The container status check now correctly targets the renamed
chronicle-backend-testservice, maintaining proper health validation during test startup.backends/advanced/Docs/HTTPS_SETUP.md (1)
92-92: LGTM! HTTPS documentation updated comprehensively.All service references, restart commands, and port mappings correctly reflect the renamed
chronicle-backendservice throughout the HTTPS setup guide.Also applies to: 102-102, 172-172, 195-195
backends/advanced/Caddyfile.template (1)
22-22: LGTM! Caddy configuration updated comprehensively.All reverse proxy targets consistently updated from
friend-backend:8000tochronicle-backend:8000across all routes and production examples.Also applies to: 32-32, 37-37, 42-42, 46-46, 51-51, 56-56, 71-71, 76-76, 81-81, 86-86, 90-90, 95-95, 100-100
backends/simple/docker-compose.yml (1)
2-2: LGTM! Docker Compose service renamed consistently.Service name, internal hostname reference in the ngrok command, and dependency relationship all correctly updated to
chronicle-backend.Also applies to: 17-17, 19-19
backends/advanced/Docs/README.md (1)
192-192: LGTM! Documentation updated correctly.The docker compose logs command reference has been updated to reflect the new service name.
tests/run-robot-tests.sh (4)
115-115: LGTM! Container cleanup updated correctly.The container name reference has been updated to match the new service naming convention.
119-119: Nice addition: quieter pull output.The
--quiet-pullflag reduces log verbosity during image pulls, which is helpful for cleaner CI output.
167-168: LGTM! Error logging updated correctly.The backend service logs reference has been updated to match the new service name.
239-239: LGTM! Test failure logging updated correctly.The backend service logs reference has been updated to match the new service name for post-test troubleshooting.
|
| Metric | Count |
|---|---|
| ✅ Passed | 90 |
| ❌ Failed | 1 |
| 📊 Total | 91 |
📊 View Reports
GitHub Pages (Live Reports):
Download Artifacts:
- robot-test-reports-html - HTML reports
- robot-test-results-xml - XML output
|
| Metric | Count |
|---|---|
| ✅ Passed | 90 |
| ❌ Failed | 1 |
| 📊 Total | 91 |
📊 View Reports
GitHub Pages (Live Reports):
Download Artifacts:
- robot-test-reports-html - HTML reports
- robot-test-results-xml - XML output
2 participants
… 'friend-backend' to 'chronicle-backend' across various files, including setup instructions, Docker configurations, and service logs.
Summary by CodeRabbit
Documentation
Chores
✏️ Tip: You can customize this high-level summary in your review settings.