Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix PROD issue with CallForPosts contributions failing to load #7603

Merged
merged 2 commits into from
Feb 3, 2025

Conversation

bobbykolev
Copy link
Collaborator

@bobbykolev bobbykolev commented Feb 3, 2025

Simple hotfix to iterate over all contributions. Repro only on prod, probably bad data.

Summary by CodeRabbit

  • Chores
    • Updated the package version (0.81.1 → 0.81.2).
  • Bug Fixes
    • Enhanced error messaging for clearer context.
    • Refined data handling to ensure more robust processing of related entries.

Copy link

coderabbitai bot commented Feb 3, 2025

Walkthrough

The pull request updates the package version from "0.81.1" to "0.81.2" in the package.json file. In addition, the useUrlResolver function has been modified to adjust its error messaging to reference calloutsSetId rather than vcNameId and to use the find method for selecting the first valid contribution with an associated post. These changes ensure clearer error reporting and more robust extraction of contribution details.

Changes

Files Change Summary
package.json Version updated from "0.81.1" to "0.81.2".
src/main/urlResolver/.../useUrlResolver.ts Modified error message to reference calloutsSetId and updated logic to retrieve contributions using find.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant UrlResolver
    Caller->>UrlResolver: Invoke useUrlResolver with calloutPostData
    alt Valid Callout Found
        UrlResolver->>UrlResolver: Locate contribution using find()
        UrlResolver->>Caller: Return contributionId and postId
    else Callout Not Found
        UrlResolver->>Caller: Throw error mentioning calloutsSetId
    end
Loading

Possibly related PRs

  • alkem-io/client-web#7021: Involves updating the version number in package.json, similar to the current changes.
  • alkem-io/client-web#7526: Contains a version bump in package.json that aligns directly with this update.
  • alkem-io/client-web#6956: Features a minor version update in package.json, establishing a strong code-level connection.

Suggested labels

client

Suggested reviewers

  • ccanos
  • reactoholic

📜 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 ab42d31 and cdcacf7.

⛔ Files ignored due to path filters (1)
  • package-lock.json is excluded by !**/package-lock.json
📒 Files selected for processing (2)
  • package.json (1 hunks)
  • src/main/urlResolver/useUrlResolver.ts (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • package.json
🧰 Additional context used
📓 Path-based instructions (1)
src/main/urlResolver/useUrlResolver.ts (1)

Pattern src/**/*.{ts,tsx,js}: Review the React.js/TypeScript/JavaScript code for best practices and potential bugs.
Ensure that the code adheres to TypeScript's typing system and modern standards.
Use the following code guide documentation in the codebase: 'docs/code-guidelines.md'.
Ensure sufficient error handling and logging is present, but note:

  • We have a global error handler in place. So local try/catch blocks are not required unless they provide value beyond what the global error handler already covers.
  • Avoid flagging the absence of local error handling in cases where the global error handler suffices.
  • Avoid flagging the absence of logging in cases where the global logger is already in place (graphql usage).

Inform about the recommendation of not using non-null assertion,
except on GraphQL queries where the variable is asserted non-null and followed by a
skip: with the same variable.
Examples:

  • Not Required: there's a skip
    {
    variables: { templateId: templateId! },
    skip: !templateId,
    }

Check for common security vulnerabilities such as:

  • SQL Injection
  • XSS (Cross-Site Scripting)
  • CSRF (Cross-Site Request Forgery)
  • Insecure dependencies
  • Sensitive data exposure
🔇 Additional comments (2)
src/main/urlResolver/useUrlResolver.ts (2)

237-237: LGTM! Error message improvement

The error message now correctly references the context where the lookup fails, making it easier to diagnose issues.


245-247: LGTM! Robust contribution handling

The change improves reliability by ensuring only valid contributions with associated posts are selected, addressing the production issue with CallForPosts contributions failing to load.

Let's verify the GraphQL query structure to ensure we're getting the necessary fields:

✅ Verification successful

I'll re-run the search without restricting by file type to gather the necessary query details.


GraphQL query structure and contribution filtering verified

  • The GraphQL query in src/core/apollo/generated/apollo-hooks.ts correctly provides the necessary fields (via lookup.callout.contributions) to support the updated logic in src/main/urlResolver/useUrlResolver.ts.
  • The updated code now reliably selects a contribution with an associated post, which addresses the production issue.
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the GraphQL query structure for usePostInCalloutUrlResolverQuery

# Search for the GraphQL query definition
rg -A 10 "usePostInCalloutUrlResolverQuery" --type graphql

Length of output: 90


Script:

#!/bin/bash
# Search for the GraphQL query definition involving usePostInCalloutUrlResolverQuery
rg -A 10 "usePostInCalloutUrlResolverQuery"

Length of output: 5378

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 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. (Beta)
  • @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.

@bobbykolev bobbykolev changed the base branch from develop to master February 3, 2025 12:22
@ccanos ccanos merged commit e958d3e into master Feb 3, 2025
5 checks passed
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