fix: Use left join to capture null metadata combinations

[adityachoudhari26]

Summary by CodeRabbit

• Bug Fixes
  • Improved how resource metadata is aggregated so that only valid metadata entries are shown.
  • Ensured that resources without metadata are now included with a sensible default display.

[coderabbitai]

Walkthrough

The pull request updates the SQL query used to aggregate resource metadata. It replaces a direct call to jsonb_object_agg with a COALESCE wrapper combined with a filter condition that excludes null keys. Additionally, the default value for the metadata aggregation is set to an empty JSON object. The join type for the resourceMetadata table has been changed from innerJoin to leftJoin, allowing resources to be returned even without corresponding metadata records.

Changes

File(s)	Change Summary
packages/api/src/router/resource-metadata-group.ts	Modified SQL aggregation to use COALESCE(jsonb_object_agg(...)) with FILTER (WHERE key IS NOT NULL) and provided a default value of '{}'::jsonb. Changed join type from innerJoin to leftJoin.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant APIRouter as API Router
    participant DB as Database

    Client->>APIRouter: Request resource data
    APIRouter->>DB: Execute SQL query with COALESCE & leftJoin
    DB-->>APIRouter: Return resources and aggregated metadata
    APIRouter-->>Client: Send combined resource and metadata response

Loading

Poem

I'm a rabbit hopping through lines of code,
Where SQL paths and queries lighten my load.
Left joins and filters guide my playful bound,
With JSON defaults, solutions are found!
I celebrate these changes with a joyful, bouncy ode.

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d3ffb18 and afcc64a.

📒 Files selected for processing (1)

• packages/api/src/router/resource-metadata-group.ts (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

`**/*.{ts,tsx}`: **Note on Error Handling:** Avoid strict en...

**/*.{ts,tsx}: Note on Error Handling:
Avoid strict enforcement of try/catch blocks. Code may use early returns, Promise chains (.then().catch()), or other patterns for error handling. These are acceptable as long as they maintain clarity and predictability.

• packages/api/src/router/resource-metadata-group.ts

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

• GitHub Check: Lint
• GitHub Check: build (linux/amd64)
• GitHub Check: Typecheck

🔇 Additional comments (2)

packages/api/src/router/resource-metadata-group.ts (2)

143-148: Improved metadata aggregation to handle null values properly

The changes to the SQL expression enhance robustness in two key ways:

1. Using COALESCE with a default of '{}'::jsonb ensures an empty JSON object is returned when no metadata exists
2. Adding FILTER (WHERE ${resourceMetadata.key} IS NOT NULL) prevents null keys from being included in the aggregation

These changes align with the PR objective and prevent potential null reference issues downstream.

---

151-151: Correctly changed to leftJoin to include resources without metadata

Switching from innerJoin to leftJoin is the core fix for the issue mentioned in the PR title. This change ensures that resources without corresponding metadata entries are still included in query results, rather than being excluded as they would be with an inner join.

This change works in conjunction with the COALESCE wrapper in the metadata aggregation to properly handle the null values that will now be included in the result set.

✨ 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

🪧 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.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @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 generate unit testing code.
  • @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.

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 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.