Add deep copy for consumers #86

sonalmahajan15 · 2023-10-19T18:22:21Z

This PR modifies the consumers to add support for deep copy when the consumers are being copied in backpropagation.

[depends on #80 ]

yuxincs

Overall this LGTM modulo two places where the original object is modified in Copy methods. Also, I think it would be good if we have some unit tests for better coverage and guard against the the typos.

yuxincs · 2023-10-23T19:04:06Z

annotation/consume_trigger.go

+	copyConsumer := *t
+	t.Ann = t.Ann.copy()


Suggested change

copyConsumer := *t

t.Ann = t.Ann.copy()

copyConsumer := *t

copyConsumer.Ann = t.Ann.copy()

Right? it's a bit strange for a Copy method to return the original Ann and then modify the receiver's Ann.

Can we also add some unit tests (with the help of reflection) to guard against such cases?

The idea I think would be to use cmp.Diff to check the copied objects are deeply equal, and then use reflections to check (1) the pointer fields in the old and new objects are different, and (2) the old objects are not modified (perhaps by comparing them to another copy made by reflect.Copy).

Good catch! Although not affecting the functionality, this was definitely a type that deserved fixing. You are right, we should unit tests to catch such inadvertent mistakes. Added unit tests for the same under copy_test.

yuxincs · 2023-10-23T20:35:34Z

annotation/consume_trigger.go

+	copyConsumer := *t
+	t.Ann = t.Ann.copy()


Same as the above here :)

(same as above. Fixed and added unit test to safeguard :) )

codecov · 2023-11-06T03:57:28Z

Codecov Report

Attention: 93 lines in your changes are missing coverage. Please review.

Comparison is base (6814686) 89.29% compared to head (302cf5e) 89.18%.

Files	Patch %	Lines
annotation/consume_trigger.go	83.57%	69 Missing ⚠️
assertion/function/assertiontree/backprop.go	70.00%	8 Missing and 4 partials ⚠️
util/asthelper/asthelper.go	80.32%	7 Missing and 5 partials ⚠️

Additional details and impacted files

@@                             Coverage Diff                             @@
##           sonalmahajan15/revamp-producer-consumer      #86      +/-   ##
===========================================================================
- Coverage                                    89.29%   89.18%   -0.11%     
===========================================================================
  Files                                           54       55       +1     
  Lines                                         8688     9156     +468     
===========================================================================
+ Hits                                          7758     8166     +408     
- Misses                                         774      825      +51     
- Partials                                       156      165       +9

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

yuxincs

LGTM apart from one comment to separate the test utility stuff to a separate package for easier maintenance.

I think the test utilities here are general and complex enough to warrant being put in a separate test utility package (which is also what stdlib does), but that can definitely be in a separate follow-up PR.

yuxincs · 2023-11-27T16:13:38Z

annotation/copy_test.go

+
+type CopyTestSuite struct {
+	suite.Suite
+	initStructs   []any


We can probably make this a generic struct with a type constraint on having Copy method to remove some boilerplate code below.

Created issue #172 to perform this refactoring in a follow-up PR.

yuxincs · 2023-11-27T16:15:05Z

annotation/copy_test.go

+// limitations under the License.
+
+package annotation
+


A continuation of the comment made to previous PR: after seeing this, I think we might be more incentivized to move the test utility stuff to a separate package (say, internal/nilawaytest) for easier maintenance.

Created issue #172 to perform this refactoring in a follow-up PR.

This PR refines the error message by incorporating information about the assignments. Following is an example of an informative error message: Code snippet: ``` func test(x *int) { x = nil y := x z := y print(*z) } ``` Error message: ``` Potential nil panic detected. Observed nil flow from source to dereference point: -> errormessage/errormessage.go:32:9: literal `nil` dereferenced via the assignment(s): -> `nil` to `x` at errormessage/errormessage.go:29:2, -> `x` to `y` at errormessage/errormessage.go:30:2, -> `y` to `z` at errormessage/errormessage.go:31:2 ``` [closes #83 ] [depends on #86 ]

sonalmahajan15 requested review from lazaroclapp and yuxincs October 19, 2023 18:22

sonalmahajan15 mentioned this pull request Oct 19, 2023

Refine backprop assignments in error message #87

Merged

sonalmahajan15 force-pushed the sonalmahajan15/add-deep-copy branch from 16bbb5e to 2069a0f Compare October 20, 2023 17:14

sonalmahajan15 force-pushed the sonalmahajan15/revamp-producer-consumer branch from 9b0b5d3 to daae825 Compare October 20, 2023 17:14

yuxincs reviewed Oct 23, 2023

View reviewed changes

sonalmahajan15 force-pushed the sonalmahajan15/revamp-producer-consumer branch from 337055f to 019ced5 Compare November 6, 2023 03:54

sonalmahajan15 force-pushed the sonalmahajan15/add-deep-copy branch from 2069a0f to bba340e Compare November 6, 2023 03:54

yuxincs approved these changes Nov 27, 2023

View reviewed changes

sonalmahajan15 force-pushed the sonalmahajan15/revamp-producer-consumer branch from 019ced5 to 06ebb58 Compare November 27, 2023 20:29

sonalmahajan15 force-pushed the sonalmahajan15/add-deep-copy branch from bba340e to 1c8d6f6 Compare November 27, 2023 20:31

sonalmahajan15 force-pushed the sonalmahajan15/revamp-producer-consumer branch from 06ebb58 to 9534584 Compare November 29, 2023 19:22

sonalmahajan15 force-pushed the sonalmahajan15/add-deep-copy branch from 1c8d6f6 to 7614ccb Compare November 29, 2023 19:26

sonalmahajan15 force-pushed the sonalmahajan15/revamp-producer-consumer branch from 9534584 to c7b4d03 Compare November 30, 2023 20:02

sonalmahajan15 force-pushed the sonalmahajan15/add-deep-copy branch from 7614ccb to d97e64e Compare November 30, 2023 20:02

sonalmahajan15 force-pushed the sonalmahajan15/revamp-producer-consumer branch from c7b4d03 to 35156bd Compare December 12, 2023 00:33

sonalmahajan15 force-pushed the sonalmahajan15/add-deep-copy branch from d97e64e to 650ff29 Compare December 12, 2023 00:34

sonalmahajan15 added 6 commits January 17, 2024 13:12

change producers and consumers to pointer types; add equals

4273f2c

added deep copy method

f2a5ce9

removed commented code

93a9ce4

refactoring

afe7be2

refactors and copy test

396457d

rebase

a1668d2

sonalmahajan15 force-pushed the sonalmahajan15/revamp-producer-consumer branch from 35156bd to 6814686 Compare January 17, 2024 21:14

sonalmahajan15 force-pushed the sonalmahajan15/add-deep-copy branch from 650ff29 to a1668d2 Compare January 17, 2024 21:14

sonalmahajan15 mentioned this pull request Jan 17, 2024

Refactor tests in annotation package #172

Open

sonalmahajan15 merged commit b2995c6 into sonalmahajan15/revamp-producer-consumer Jan 17, 2024
5 checks passed

sonalmahajan15 deleted the sonalmahajan15/add-deep-copy branch January 17, 2024 21:37

sonalmahajan15 mentioned this pull request Jan 17, 2024

Revamp producers and consumers to be used as pointers #80

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add deep copy for consumers #86

Add deep copy for consumers #86

sonalmahajan15 commented Oct 19, 2023

yuxincs left a comment

yuxincs Oct 23, 2023

sonalmahajan15 Nov 6, 2023

yuxincs Oct 23, 2023

sonalmahajan15 Nov 6, 2023

codecov bot commented Nov 6, 2023 •

edited

Loading

yuxincs left a comment

yuxincs Nov 27, 2023

sonalmahajan15 Jan 17, 2024

yuxincs Nov 27, 2023

sonalmahajan15 Jan 17, 2024

Add deep copy for consumers #86

Add deep copy for consumers #86

Conversation

sonalmahajan15 commented Oct 19, 2023

yuxincs left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Nov 6, 2023 • edited Loading

Codecov Report

yuxincs left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Nov 6, 2023 •

edited

Loading