feat(stdlibs/std)!: change TestSetPrevRealm to TestSetRealm #2164
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
thehowl
requested review from
jaekwon,
moul,
piux2,
deelawn,
mvertes and
a team
as code owners
github-actions
bot
added
the
🧾 package/realm
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #2164 +/- ##
==========================================
+ Coverage 49.12% 49.16% +0.04%
==========================================
Files 576 577 +1
Lines 77805 77583 -222
==========================================
- Hits 38219 38145 -74
+ Misses 36495 36358 -137
+ Partials 3091 3080 -11
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
|
I like the new API that takes a struct and fixes the expected behavior. However, I'm worried about the name. Shouldn't |
Updated OP to better describe reasoning |
moul
approved these changes
May 24, 2024
gfanton
approved these changes
May 29, 2024
omarsy
pushed a commit
to TERITORI/gno
that referenced
this pull request
Jun 3, 2024
…2164) This PR removes the `TestSetPrevRealm` and `TestSetPrevAddr`, added in gnolang#890, in favour of a new API `TestSetRealm`, which is more flexible in its behaviour. The function works by setting the result of `CurrentRealm()` for the frame in which the `TestSetRealm` function is called. Consequently, calling `PrevRealm` in any function called within will yield the value passed to `TestSetRealm`. `TestSetRealm` allows to transparently set "user" and "code" realms, by using two new costructors in the testing stdlibs, `std.NewUserRealm` and `std.NewCodeRealm`, allowing emulation of both kinds of callers. The call is not `TestSetPrevRealm` as it does not permanently "set" the value returned by PrevRealm, as if in a mock; it simply changes the Realm of the current frame, allowing "deep" calls to PrevRealm() to correctly return the value of the previous realm. <details><summary>Contributors' checklist...</summary> - [ ] Added new tests, or not needed, or not feasible - [ ] Provided an example (e.g. screenshot) to aid review or the PR is self-explanatory - [ ] Updated the official documentation or not needed - [ ] No breaking changes were made, or a `BREAKING CHANGE: xxx` message was included in the description - [ ] Added references to related issues and PRs - [ ] Provided any useful hints for running manual tests - [ ] Added new benchmarks to [generated graphs](https://gnoland.github.io/benchmarks), if any. More info [here](https://github.com/gnolang/gno/blob/master/.benchmarks/README.md). </details>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR removes the
TestSetPrevRealmandTestSetPrevAddr, added in #890, in favour of a new APITestSetRealm, which is more flexible in its behaviour.The function works by setting the result of
CurrentRealm()for the frame in which theTestSetRealmfunction is called. Consequently, callingPrevRealmin any function called within will yield the value passed toTestSetRealm.TestSetRealmallows to transparently set "user" and "code" realms, by using two new costructors in the testing stdlibs,std.NewUserRealmandstd.NewCodeRealm, allowing emulation of both kinds of callers.The call is not
TestSetPrevRealmas it does not permanently "set" the value returned by PrevRealm, as if in a mock; it simply changes the Realm of the current frame, allowing "deep" calls to PrevRealm() to correctly return the value of the previous realm.Contributors' checklist...
BREAKING CHANGE: xxxmessage was included in the description