Skip to content

chore: address PR #613 review nits (test PII + meta docstring) - #646

Merged
galshubeli merged 1 commit into
stagingfrom
fix/review-comments-cleanup
Jul 15, 2026
Merged

chore: address PR #613 review nits (test PII + meta docstring)#646
galshubeli merged 1 commit into
stagingfrom
fix/review-comments-cleanup

Conversation

@galshubeli

@galshubeli galshubeli commented Jul 15, 2026

Copy link
Copy Markdown
Collaborator

Summary

Two low-risk cleanups surfaced by the automated review of the staging→main release PR (#613). The remaining automated findings were verified as false positives and left unchanged (rationale below + replied on #613).

Fixed

  • tests/test_usage_tracking.py — the USER_ID fixture was built from a real employee email (gal.shubeli@falkordb.com). Replaced with a fictitious test.user@example.com; base64 behaviour is identical. (Copilot)
  • api/routes/meta.py — module docstring referenced version/health, but only /version exists. Aligned the docstring with the actual route surface. (Copilot)

pytest tests/test_usage_tracking.py tests/test_meta_route.py → 13 passed.

Verified false positives (no change)

  • openai missing from [server] extra → use_memory ImportError (Copilot): graphiti-core 0.29.1 declares openai as a core dependency, so queryweaver[server] installs it transitively. from openai import AsyncAzureOpenAI always resolves.
  • PyPI publish can bypass TestPyPI gate on reruns (overcut-ai): the workflow already builds once in a dedicated build job, uploads the artifact, and both publish jobs consume that same artifact; needs: is success-gated by default and each publish job is behind a protected environment.
  • Vite dev proxy missing /version (overcut-ai): the frontend calls buildApiUrl('/version'), which resolves to /api/version on the dev server (BASE_URL='/api') and is forwarded by the existing /api proxy. Works in dev as-is.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation

    • Updated public metadata route documentation to accurately describe the available version endpoint.
  • Tests

    • Updated usage-tracking test data to use a generic example email address and its corresponding identifier.

Two low-risk cleanups from the automated review of the staging->main
release PR (#613):

- tests/test_usage_tracking.py: replace the real employee email used to
  build USER_ID with a fictitious example.com address. Keeps the base64
  encoding behaviour identical while keeping PII out of test data.
- api/routes/meta.py: the module docstring referenced "version/health"
  but only /version exists. Align the docstring with the actual surface.

The other automated findings were verified as false positives and are
left unchanged (see PR replies): publish-pypi.yml already builds once and
shares the artifact across both publish jobs with success-gated `needs`;
the Vite dev proxy already forwards /version via the /api prefix
(buildApiUrl -> /api/version); and `openai` is a transitive dependency of
graphiti-core (0.29.1), so the [server] extra install always includes it.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@overcut-ai

overcut-ai Bot commented Jul 15, 2026

Copy link
Copy Markdown

Completed Working on "Code Review"

✅ Code review complete. No issues found - all changes look good! ✅

✅ Workflow completed successfully.


👉 View complete log

@github-actions

Copy link
Copy Markdown

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

Scanned Files

None

@railway-app
railway-app Bot temporarily deployed to queryweaver / QueryWeaver-pr-646 July 15, 2026 09:20 Destroyed
@coderabbitai

coderabbitai Bot commented Jul 15, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 1fda3de8-3527-47fd-b817-8f08034bf44c

📥 Commits

Reviewing files that changed from the base of the PR and between 9548c59 and 437a5ca.

📒 Files selected for processing (2)
  • api/routes/meta.py
  • tests/test_usage_tracking.py

📝 Walkthrough

Walkthrough

The changes update the metadata route module documentation to reference /version and replace the usage-tracking test email fixture, including its derived user identifier.

Changes

Metadata route documentation

Layer / File(s) Summary
Version route documentation
api/routes/meta.py
Updates the module docstring to describe the public /version endpoint only.

Usage tracking test fixture

Layer / File(s) Summary
Usage tracking email fixture
tests/test_usage_tracking.py
Replaces the test email constant, updating the derived encoded USER_ID used by assertions.

Estimated code review effort: 1 (Trivial) | ~2 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main changes: removing test PII and updating the meta route docstring.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/review-comments-cleanup

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

Comment @coderabbitai help to get the list of available commands.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Low-risk cleanup PR addressing nits from the staging→main release review: removes real-looking PII from a unit test fixture and aligns the public metadata module docstring with the actual route surface.

Changes:

  • Replaced a real employee email used in tests/test_usage_tracking.py with a fictitious example email while keeping identical base64 behavior.
  • Updated api/routes/meta.py module docstring to reference the /version endpoint (and removed the outdated /health mention).

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
tests/test_usage_tracking.py Swaps the hardcoded email test value to a fictitious address while preserving the same encoding/decoding behavior.
api/routes/meta.py Adjusts the module docstring to match the actual public metadata endpoint(s).
Comments suppressed due to low confidence (1)

api/routes/meta.py:5

  • The module docstring now says “route” (singular) but still refers to “endpoints”, “them”, and “Their tag” (plural). Since this module only exposes a single /version endpoint, update the wording to be consistent and avoid confusing API readers.
"""Public metadata route (``/version``) for the QueryWeaver API.

These endpoints are intentionally unauthenticated so the frontend can read
them before login. Their tag is not mapped to any MCP type, so FastMCP's
default EXCLUDE route map keeps them out of the MCP tool surface.

@galshubeli
galshubeli merged commit 5c55e14 into staging Jul 15, 2026
15 checks passed
@galshubeli
galshubeli deleted the fix/review-comments-cleanup branch July 15, 2026 09:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants