[fix]: use weak reference to internal sinks when vending to clients #189
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
jamieQ
commented
Feb 6, 2023
| @@ -198,12 +198,11 @@ extension WorkflowNode.SubtreeManager { | |||
| func makeSink<Action>(of actionType: Action.Type) -> Sink<Action> where Action: WorkflowAction, WorkflowType == Action.WorkflowType { | |||
| let reusableSink = sinkStore.findOrCreate(actionType: Action.self) | |||
|
|
|||
| let signpostRef = SignpostRef() | |||
There was a problem hiding this comment.
unrelated change, but figured we might as well not instantiate this here since it isn't necessarily going to be used (we could also further improve this with some additional changes).
jamieQ
commented
Feb 6, 2023
| @@ -243,6 +243,26 @@ final class SubtreeManagerTests: XCTestCase { | |||
| XCTAssertEqual(manager.sideEffectLifetimes.count, 1) | |||
| XCTAssertEqual(manager.sideEffectLifetimes.keys.first, "key-2") | |||
| } | |||
|
|
|||
| func test_eventPipes_notRetainedByExternalSinks() { | |||
There was a problem hiding this comment.
confirmed this fails prior to the change introduced in this PR
JaviSoto
approved these changes
Feb 6, 2023
|
|
||
| XCTAssertNotNil(externalSink) | ||
| XCTAssertNil(weakEventPipe) | ||
| } |
jamieQ
added a commit
that referenced
this pull request
Feb 6, 2023
* main: [fix]: use weak reference to internal sinks when vending to clients (#189) [feat]: add primary associated types to more protocols (#188) [chore]: pre major version bump cleanup (#187) [chore]: bump minimum deployment & swift versions (#186) Abstract ViewEnvironment to shared framework (#185) Bump activesupport from 6.1.4.4 to 6.1.7.1 (#183) [feat]: add primary associated types to `Workflow` protocol (#181) [chore]: update swiftformat ifdef indent rule to no-indent (#182)
jamieQ
added a commit
that referenced
this pull request
Feb 25, 2023
…ow-workflow-conformance * origin/main: Expose AnyScreen.wrappedScreen for inspection (#193) Improve introspection for SignalProducerWorkflow actions (#192) [release]: bump version to 2.2.0 & remove separate concurrency version (#191) [feat]: add runtime observation API (#168) [chore]: refactor some internal actions to use existential any (#190) [fix]: use weak reference to internal sinks when vending to clients (#189) [feat]: add primary associated types to more protocols (#188) [chore]: pre major version bump cleanup (#187) [chore]: bump minimum deployment & swift versions (#186) Abstract ViewEnvironment to shared framework (#185)
4 tasks
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.
Description
previously we would allow a strong reference to the internal
ReusableSinkto be captured by theSinktypes that are vended to clients. this meant that events sent into such 'external' sinks would still propagate through the event handling machinery a bit before realizing that the backing workflow node to which they were destined was no longer around. by using weak references we can prevent extending the life of the internal sinks (and underlying EventPipe) unnecessarily in such cases.ReusableSinkcapturesweakwhen vending to the 'outside world'Checklist