Track inner values of resource-kinded optionals

[dsainati1]

Closes #1539

Description

With the change in #1303, it is no longer possible to obtain a reference to an optional value, as all such references are automatically transformed into optional references. However, these references were not properly tracked by the logic added in #1344, meaning that the linked issue was still possible despite the cause seemingly being removed. This adds proper tracking for the inner values of resource-kinded optionals.

---

• 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

[github-actions]

Cadence Benchstat comparison

This branch with compared with the base branch onflow:master commit 7b77432
The command for i in {1..N}; do go test ./... -run=XXX -bench=. -shuffle=on; done was used.
Bench tests were run a total of 7 times on each branch.

Results

	old.txt	new.txt
	time/op		delta
Transfer-2	105ns ± 3%	109ns ± 4%	+3.83%	(p=0.024 n=7+7)
RuntimeFungibleTokenTransfer-2	1.63ms ±23%	1.58ms ±23%	~	(p=1.000 n=7+7)
RuntimeResourceDictionaryValues-2	7.71ms ± 3%	7.85ms ± 8%	~	(p=0.445 n=6+7)
ParseFungibleToken-2	231µs ± 2%	232µs ± 3%	~	(p=0.805 n=7+7)
ParseArray-2	15.2ms ± 7%	15.2ms ± 3%	~	(p=0.620 n=7+7)
ParseDeploy/byte_array-2	23.6ms ± 4%	23.8ms ± 5%	~	(p=0.620 n=7+7)
ParseDeploy/decode_hex-2	1.50ms ± 1%	1.51ms ± 2%	~	(p=0.259 n=7+7)
ParseInfix-2	10.1µs ± 2%	10.3µs ± 2%	~	(p=0.073 n=7+7)
QualifiedIdentifierCreation/One_level-2	3.47ns ± 1%	3.48ns ± 1%	~	(p=0.314 n=7+6)
QualifiedIdentifierCreation/Three_levels-2	175ns ± 1%	177ns ± 3%	~	(p=0.091 n=7+7)
CheckContractInterfaceFungibleTokenConformance-2	174µs ± 1%	177µs ± 3%	~	(p=0.053 n=7+7)
ContractInterfaceFungibleToken-2	49.1µs ± 2%	49.7µs ± 3%	~	(p=0.209 n=7+7)
NewInterpreter/new_interpreter-2	1.39µs ± 2%	1.39µs ± 2%	~	(p=0.865 n=7+6)
NewInterpreter/new_sub-interpreter-2	2.73µs ± 1%	2.73µs ± 2%	~	(p=0.773 n=7+7)
InterpretRecursionFib-2	3.27ms ± 3%	3.29ms ± 1%	~	(p=0.534 n=7+6)
	alloc/op		delta
RuntimeFungibleTokenTransfer-2	273kB ± 0%	273kB ± 0%	~	(p=0.767 n=7+6)
RuntimeResourceDictionaryValues-2	2.25MB ± 0%	2.25MB ± 0%	~	(p=0.435 n=7+7)
Transfer-2	48.0B ± 0%	48.0B ± 0%	~	(all equal)
QualifiedIdentifierCreation/One_level-2	0.00B	0.00B	~	(all equal)
QualifiedIdentifierCreation/Three_levels-2	64.0B ± 0%	64.0B ± 0%	~	(all equal)
CheckContractInterfaceFungibleTokenConformance-2	66.3kB ± 0%	66.3kB ± 0%	~	(all equal)
ContractInterfaceFungibleToken-2	26.7kB ± 0%	26.7kB ± 0%	~	(all equal)
NewInterpreter/new_interpreter-2	848B ± 0%	848B ± 0%	~	(all equal)
NewInterpreter/new_sub-interpreter-2	1.34kB ± 0%	1.34kB ± 0%	~	(all equal)
InterpretRecursionFib-2	1.14MB ± 0%	1.14MB ± 0%	~	(p=0.462 n=7+7)
	allocs/op		delta
RuntimeFungibleTokenTransfer-2	4.58k ± 0%	4.58k ± 0%	~	(p=0.516 n=7+7)
RuntimeResourceDictionaryValues-2	37.6k ± 0%	37.6k ± 0%	~	(p=0.478 n=7+7)
Transfer-2	1.00 ± 0%	1.00 ± 0%	~	(all equal)
QualifiedIdentifierCreation/One_level-2	0.00	0.00	~	(all equal)
QualifiedIdentifierCreation/Three_levels-2	2.00 ± 0%	2.00 ± 0%	~	(all equal)
CheckContractInterfaceFungibleTokenConformance-2	1.07k ± 0%	1.07k ± 0%	~	(all equal)
ContractInterfaceFungibleToken-2	460 ± 0%	460 ± 0%	~	(all equal)
NewInterpreter/new_interpreter-2	13.0 ± 0%	13.0 ± 0%	~	(all equal)
NewInterpreter/new_sub-interpreter-2	40.0 ± 0%	40.0 ± 0%	~	(all equal)
InterpretRecursionFib-2	23.8k ± 0%	23.8k ± 0%	~	(all equal)

[codecov]

Codecov Report

Merging #1630 (b7d1a82) into master (7b77432) will decrease coverage by 0.00%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##           master    #1630      +/-   ##
==========================================
- Coverage   74.76%   74.76%   -0.01%     
==========================================
  Files         288      288              
  Lines       55382    55386       +4     
==========================================
+ Hits        41406    41408       +2     
- Misses      12481    12483       +2     
  Partials     1495     1495              

Flag	Coverage Δ
unittests	74.76% <100.00%> (-0.01%)	⬇️

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

Impacted Files	Coverage Δ
runtime/interpreter/interpreter_expression.go	84.70% <100.00%> (+0.08%)	⬆️
runtime/interpreter/errors.go	22.11% <0.00%> (-1.01%)	⬇️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7b77432...b7d1a82. Read the comment docs.

[turbolent]

Great work!

For the other resource-kinded objects (composites, dictionaries, and arrays) we could track via their dedicated storage ID (as they are mutable, they are stored in separate slabs).
However, optionals (SomeValue) are potentially inlined in storage, so do not have a dedicated storage ID.

I thought at first this is an issue, but as you showed, tracking the potentially resource-kinded inner value of the optional works fine, nice 👍