Make indexing assignment entitled #2664
Merged
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
…onflow/cadence into supun/entitled-assigment
SupunS
added
Language Breaking Change
Cadence Benchstat comparisonThis branch with compared with the base branch onflow:feature/mutability-restrictions commit e8c73bd Collapsed results for better readability
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Codecov Report
@@ Coverage Diff @@
## feature/mutability-restrictions #2664 +/- ##
===================================================================
+ Coverage 78.90% 78.92% +0.01%
===================================================================
Files 341 341
Lines 81860 81906 +46
===================================================================
+ Hits 64595 64644 +49
+ Misses 14909 14907 -2
+ Partials 2356 2355 -1
Flags with carried forward coverage won't be shown. Click here to find out more.
|
dsainati1
reviewed
Jul 19, 2023
There was a problem hiding this comment.
I don't think it's safe to only require Insertable access for indexed assignment, unfortunately. In the example in the test:
let array: [String] = ["foo", "bar"]
fun test() {
var arrayRef = &array as auth(Insertable) &[String]
arrayRef[0] = "baz"
}
This both inserts "baz" and also removes "foo". Similarly, when doing a swap, you are both inserting one element and removing another. As such I think this operation needs to have Mutable-only access. Ideally we could say that it has (Mutable) | (Insertable, Removable), but we don't support this level of complexity. I think we can just permit it only for Mutable now, and later if we add the ability for entitlements to inherit or extend each other we can define Mutable to be the intersection of Insertable and Removable to fix this oddity.
|
ah that's a good flag! I think internally we can make the |
|
Oh nice! If we can special case this internally that would be great. We should just make sure to make the error message here not produce the "raw" entitlement set so as not to mislead people about what is possible in user-land. |
dsainati1
suggested changes
Aug 1, 2023
There was a problem hiding this comment.
I forgot one thing when reviewing this: because dictionaries and arrays now support entitled operations, ArrayType and DictionaryType need to be updated to conform to EntitlementSupportingType in type.go, and the implementation of SupportedEntitlements for these types should include Mutable, Insertable and Removable.
These can be tested by adding a test to TestCheckEntitlementConditions to test that when returning a resource array or dictionary type, the created reference type of result in a function postcondition contains these entitlements properly.
|
@dsainati1 Added in ae64ba2 |
dsainati1
approved these changes
Aug 1, 2023
SupunS
merged commit 5b47d1a
into
feature/mutability-restrictions
10 of 11 checks passed
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.
Closes #2647
Work towards onflow/flips#86
Description
Make index assignments on references (
arrayRef[0] = somethingordictRef[index] = something) to require entitlements.masterbranchFiles changedin the Github PR explorer