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(stf): fix router.InvokeTyped reflection usage #20741

Merged
merged 5 commits into from
Jun 20, 2024
Merged

Conversation

kocubinski
Copy link
Member

@kocubinski kocubinski commented Jun 20, 2024

Description

Minor fix from #20724.
simapp/v2 test passes again, which is now required!


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title, you can find examples of the prefixes below:
  • confirmed ! in the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • updated the relevant documentation or specification, including comments for documenting Go code
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

  • Bug Fixes
    • Corrected the parameter behavior in the merge function, ensuring data is merged accurately.

@kocubinski kocubinski requested a review from a team as a code owner June 20, 2024 15:12
Copy link
Contributor

coderabbitai bot commented Jun 20, 2024

Walkthrough

Walkthrough

The recent changes to the stf_router.go file involve a modification to the merge function. This adjustment swaps the src and dst parameters in the reflect.Indirect calls. By doing so, the behavior of how the merge operation is conducted has been altered, potentially changing the data merging process outcomes between the source and destination.

Changes

Files Change Summaries
server/v2/stf/stf_router.go Modified the merge function to switch the src and dst parameters in the reflect.Indirect calls, possibly impacting the merge behavior.

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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

Copy link
Contributor

@kocubinski your pull request is missing a changelog!

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 9983bde and 5b95ced.

Files selected for processing (1)
  • server/v2/stf/stf_router.go (1 hunks)
Additional context used
Path-based instructions (1)
server/v2/stf/stf_router.go (1)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.

Additional comments not posted (1)
server/v2/stf/stf_router.go (1)

168-168: The change in parameter order in the merge function appears to align with the intended functionality. Ensure this change is consistent across all usages.

Verification successful

The merge function in server/v2/stf/stf_router.go is called once at line 168. We need to ensure this call aligns with the new parameter order. Let's inspect the relevant lines in stf_router.go to confirm this.


The merge function is defined as follows:

func merge(src, dst protoiface.MessageV1) {
	reflect.Indirect(reflect.ValueOf(src)).Set(reflect.Indirect(reflect.ValueOf(dst)))
}

And it is called in the InvokeTyped method:

func (r Router) InvokeTyped(ctx context.Context, req, resp protoiface.MessageV1) error {
	handlerResp, err := r.InvokeUntyped(ctx, req)
	if err != nil {
		return err
	}
	merge(resp, handlerResp)
	return nil
}

The merge function is called with resp as the first argument and handlerResp as the second argument. This aligns with the new parameter order where src is the first argument and dst is the second argument. Therefore, the change in the merge function's parameter order is consistent with its usage in the InvokeTyped method.

  • server/v2/stf/stf_router.go:168: merge(resp, handlerResp)
Scripts executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Description: Verify that the `merge` function's new parameter order does not introduce side effects.

# Test: Search for all usages of the `merge` function. Expect: Consistent usage reflecting the new parameter order.
rg --type go $'merge'

Length of output: 4731



Script:

#!/bin/bash
# Description: Verify the implementation and usage of the `merge` function in `server/v2/stf/stf_router.go`.

# Extract the relevant lines from the file to inspect the `merge` function and its usage.
rg -A 10 -B 10 'merge\(resp, handlerResp\)' server/v2/stf/stf_router.go

Length of output: 672

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 5b95ced and a6e892e.

Files selected for processing (1)
  • server/v2/stf/stf_router.go (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • server/v2/stf/stf_router.go

@kocubinski kocubinski added this pull request to the merge queue Jun 20, 2024
Merged via the queue into main with commit 88da9ef Jun 20, 2024
69 checks passed
@kocubinski kocubinski deleted the kocu/stf-fix branch June 20, 2024 15:57
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.

3 participants