Introduce filter in Fixed/Variable sized Array types

[darkdrag00nv2]

Work towards #2605

Description

Introduce filter function for creating a copy of an Array value with its entries filtered via predicate.

This function would be unavailable to resource arrays since resources cannot be copied

Will send docs PR post the merge.

---

• Targeted PR against master branch
• Linked to Github issue with discussion and accepted design OR link to spec that describes this work
• Code follows the standards mentioned here
• Updated relevant documentation
• Re-reviewed Files changed in the Github PR explorer
• Added appropriate labels

[dsainati1]

Please add some tests here to check that mutation in the array-filtering predicate function is properly prevented here.

[darkdrag00nv2]

Please add some tests here to check that mutation in the array-filtering predicate function is properly prevented here.

@dsainati1 Didn't get it completely. Is it relevant also for non-resource arrays?

I based the implementation on forEachKey of Dictionary and we seem to be doing mutation prevention only for resource kinded values. I thought this won't apply here since we're not allowing filter on resource kinded arrays.

cadence/runtime/interpreter/value.go

Line 17038 in 181924e

interpreter.withMutationPrevention(v.StorageID(), iterate)

[dsainati1]

Ah good point, I missed that this was not implemented for resource arrays. That makes sense.

[SupunS]

FixedSizedArrays since we don't know the size of the output array.

Can't we still make this function available for fixed-sized arrays? The return type of the function would always be variable-sized.

[darkdrag00nv2]

@SupunS Yeah, sure. Can be done. I'll update the PR tomorrow.

[codecov]

Codecov Report

Merging #2678 (9c2eb9d) into master (181924e) will increase coverage by 0.55%.
Report is 30 commits behind head on master.
The diff coverage is 92.30%.

@@            Coverage Diff             @@
##           master    #2678      +/-   ##
==========================================
+ Coverage   78.57%   79.12%   +0.55%     
==========================================
  Files         338      333       -5     
  Lines       78216    78306      +90     
==========================================
+ Hits        61456    61962     +506     
+ Misses      14474    14047     -427     
- Partials     2286     2297      +11     

Flag	Coverage Δ
unittests	79.12% <92.30%> (+0.55%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Changed	Coverage Δ
runtime/interpreter/value.go	67.02% <87.83%> (-1.94%)	⬇️
runtime/sema/type.go	89.75% <100.00%> (+0.10%)	⬆️

... and 21 files with indirect coverage changes

[darkdrag00nv2]

@SupunS This is ready for your review now.

[darkdrag00nv2]

@SupunS @turbolent Gentle ping for review

[SupunS]

Nice!