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 Data.findFirstTypeMismatch to check all elements of Bundles #3928

Merged
merged 1 commit into from
Mar 12, 2024

Conversation

jackkoenig
Copy link
Contributor

Fix embarrassing bug introduced in #3201. Basically, DataMirror.checkTypeEquivalence is only checking the first element of Bundles 🙈

Fixes #3922

Contributor Checklist

  • Did you add Scaladoc to every public function/method?
  • Did you add at least one test demonstrating the PR?
  • Did you delete any extraneous printlns/debugging code?
  • Did you specify the type of improvement?
  • Did you add appropriate documentation in docs/src?
  • Did you request a desired merge strategy?
  • Did you add text to be included in the Release Notes for this change?

Type of Improvement

  • Bugfix

Desired Merge Strategy

  • Squash

Release Notes

Fixes DataMirror.checkTypeEquivalence to actually check all fields of Bundles and Records. This may expose latent bugs in user code.

Reviewer Checklist (only modified by reviewer)

  • Did you add the appropriate labels? (Select the most appropriate one based on the "Type of Improvement")
  • Did you mark the proper milestone (Bug fix: 3.6.x, 5.x, or 6.x depending on impact, API modification or big change: 7.0)?
  • Did you review?
  • Did you check whether all relevant Contributor checkboxes have been checked?
  • Did you do one of the following when ready to merge:
    • Squash: You/ the contributor Enable auto-merge (squash), clean up the commit message, and label with Please Merge.
    • Merge: Ensure that contributor has cleaned up their commit history, then merge with Create a merge commit.

@jackkoenig jackkoenig added the Bugfix Fixes a bug, will be included in release notes label Mar 12, 2024
@jackkoenig jackkoenig added this to the 5.x milestone Mar 12, 2024
@@ -0,0 +1,102 @@
// SPDX-License-Identifier: Apache-2.0
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Turns out there were basically zero tests of this API. I did not write any for Const nor Probe which isn't great, but this needs to backport to 5.x.

@jackkoenig jackkoenig requested a review from azidar March 12, 2024 17:12
@jackkoenig jackkoenig merged commit 6dfc047 into main Mar 12, 2024
17 checks passed
@jackkoenig jackkoenig deleted the fix-checkTypeEquivalence branch March 12, 2024 17:26
@mergify mergify bot added the Backported This PR has been backported label Mar 12, 2024
mergify bot pushed a commit that referenced this pull request Mar 12, 2024
mergify bot pushed a commit that referenced this pull request Mar 12, 2024
chiselbot pushed a commit that referenced this pull request Mar 12, 2024
… (#3929)

(cherry picked from commit 6dfc047)

Co-authored-by: Jack Koenig <koenig@sifive.com>
chiselbot pushed a commit that referenced this pull request Mar 12, 2024
… (#3930)

(cherry picked from commit 6dfc047)

Co-authored-by: Jack Koenig <koenig@sifive.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Backported This PR has been backported Bugfix Fixes a bug, will be included in release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

DataMirror.checkTypeEquivalence is incorrect when using Optional fields
2 participants