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

Distinguish identity views from single-target views (backport #4186) #4189

Merged
merged 1 commit into from
Jun 18, 2024

Conversation

mergify[bot]
Copy link
Contributor

@mergify mergify bot commented Jun 18, 2024

This is a minor overhaul of DataViews internals that make the various use cases of what were previously referred to as "1-1 views" more clear. This incidentally fixes an issue with bulk connections and views.

While for users this is just a bug fix, this has larger implications for developers. This replaces reifySingleData with two more precise functions:

  • reifyIdentityView - Fast, used for things like Probe legality (which by having pointer semantics, only really works with identity views).
  • reifySingleTarget - Slow, used for legacy annotation support which was, and remains, iffy for views.

A subtle but critical aspect of this PR is that reifyIdentityView works in cases when the reifySingleData did not. It is properly hierarchical: e.g. if you have an Aggregate that is a child of a non-identity view parent yet the child itself is an identity view, it will return the target for that child. This is critical for use cases like FlatIO where the parent Bundle isn't an identity but every single child is.

One negative of this PR is that it makes the awkward "unnamed rename map" logic slower. I benchmarked this on a large design (that uses lots of views) and it's such a small piece of the overall runtime that it's okay (~1%). Regardless that logic is ludicrously slow and is a complete waste. I am thinking about ways to get rid of it but this PR has scope creeped enough. I think we just have to change the annotation API so it's really about coming up with the best way to do it.

This PR actually fixes several bugs, I will file them separately as they illustrate all of the weird corner cases this PR cleans up.

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 #4185, Fixes #4187

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.

This is an automatic backport of pull request #4186 done by [Mergify](https://mergify.com).

This is a minor overhaul of DataViews internals that make the various
use cases of what were previously referred to as "1-1 views" more clear.
This incidentally fixes an issue with bulk connections and views.

(cherry picked from commit 9d2f156)
@mergify mergify bot added the Backport Automated backport, please consider for minor release label Jun 18, 2024
@github-actions github-actions bot added the Bugfix Fixes a bug, will be included in release notes label Jun 18, 2024
@chiselbot chiselbot merged commit 3c7b017 into 6.x Jun 18, 2024
17 checks passed
@chiselbot chiselbot deleted the mergify/bp/6.x/pr-4186 branch June 18, 2024 20:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Backport Automated backport, please consider for minor release Bugfix Fixes a bug, will be included in release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants