Improve typing and documentation for repository URL parsing utility

[the-asmit]

Summary

This PR improves the clarity of the _parse_repo_url utility by introducing
an explicit return type (TypedDict) and enhancing documentation.

Changes

• Added ParsedRepo TypedDict to define the return schema
• Improved docstring describing supported input formats and return values
• Slightly clarified the error message

Notes

• No behaviour or logic changes
• No API changes

Summary by CodeRabbit

• Refactor
  • Enhanced internal code quality and type safety for repository parsing operations.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

📝 Walkthrough

Walkthrough

Updated _parse_repo_url function in the repository service to use a new ParsedRepo TypedDict for stronger type safety, replacing the generic Dict[str, str] return type. Added TypedDict import and expanded documentation to clarify input formats, return fields, and error conditions. No logic modifications.

Changes

Cohort / File(s)	Summary
Type Safety Enhancement backend/app/services/codegraph/repo_service.py	Added TypedDict import; introduced new ParsedRepo TypedDict; updated _parse_repo_url return type from Dict[str, str] to ParsedRepo; expanded function documentation for inputs, return fields, and ValueError conditions

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

🐰 Type safety hops with grace,
No more dicts in dict's place,
ParsedRepo stands tall and true,
A rabbit's gift—precision through and through! 🎉

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 66.67% which is insufficient. The required threshold is 80.00%.	You can run @coderabbitai generate docstrings to improve docstring coverage.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title directly describes the main change: improving typing and documentation for the repository URL parsing utility. This aligns with the PR's core objectives of introducing a ParsedRepo TypedDict, enhancing docstrings, and clarifying error messages.

✨ Finishing touches

• 📝 Generate docstrings

---

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

🧹 Nitpick comments (1)

backend/app/services/codegraph/repo_service.py (1)

75-79: Clear error message with helpful examples.

The error message provides actionable guidance with the two most common input formats. Optionally, you could include all four formats mentioned in the docstring (lines 40-44) for complete consistency, but the current message is sufficient for most use cases.

💡 Optional: Add all supported formats to error message

         raise ValueError(
             f"Invalid repository format: '{repo_input}'. "
-            "Expected formats include 'owner/repo' or "
-            "'https://github.com/owner/repo'."
+            "Expected formats: 'owner/repo', 'https://github.com/owner/repo', "
+            "'github.com/owner/repo', or URLs ending with '.git'."
         )

📜 Review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between aa66519 and 8ecd210.

📒 Files selected for processing (1)

• backend/app/services/codegraph/repo_service.py

🧰 Additional context used

🧬 Code graph analysis (1)

backend/app/services/codegraph/repo_service.py (1)

backend/app/database/supabase/client.py (1)

• get_supabase_client (9-13)

🔇 Additional comments (3)

backend/app/services/codegraph/repo_service.py (3)

4-4: LGTM! Good addition of TypedDict import.

The import is necessary for the new ParsedRepo TypedDict and maintains compatibility with existing code that uses Dict and Any.

---

12-23: Excellent type safety improvement!

The ParsedRepo TypedDict provides clear structure and type safety for repository parsing results. The documentation is comprehensive and accurately describes each field.

---

36-57: Outstanding documentation and type safety improvements!

The enhanced return type and comprehensive docstring significantly improve code maintainability. The documentation clearly describes all supported input formats, return structure, and error conditions, making the function's behavior explicit for future developers.

[the-asmit]

@smokeyScraper check this out. This is a non-behavioural but necessary change to improve parsing clarity.

[Aditya30ag]

No need to add to much docstring as the variable name itself suggest it work.

• Introducing a TypedDict here doesn’t provide much benefit unless we’re enforcing static typing across the codebase.
• The original dict[str, str] return type was sufficient and clearer.

[the-asmit]

Hey @Aditya30ag, Thanks for the clarification — that makes sense.
I understand the preference for focusing on more substantive, problem-solving changes rather than small typing or documentation tweaks. I'll focus on areas where changes provide clearer functional or maintainability benefits.
Appreciate the guidance!