Align FlowManager APIs across platforms#805
Align FlowManager APIs across platforms#805KVSRoyal wants to merge 3 commits intoplayer-1-dot-zerofrom
Conversation
33e9748 to
7f55c8b
Compare
Codecov Report❌ Patch coverage is Additional details and impacted files@@ Coverage Diff @@
## player-1-dot-zero #805 +/- ##
=====================================================
- Coverage 85.90% 85.87% -0.03%
=====================================================
Files 507 507
Lines 22891 23129 +238
Branches 2656 2657 +1
=====================================================
+ Hits 19664 19862 +198
- Misses 2898 2939 +41
+ Partials 329 328 -1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
4249f3b to
9be29a4
Compare
| public class AsyncIterationManager<Item : Any, Result : Any, Data : Any>( | ||
| public val iterator: AsyncIterator<Item, Result, Data>, |
There was a problem hiding this comment.
This is public but actually not user-facing, per offline discussions. So no release notes are added for this.
9be29a4 to
ee33a59
Compare
ee33a59 to
06e39f9
Compare
Bundle ReportChanges will decrease total bundle size by 4.58kB (-0.08%) ⬇️. This is within the configured threshold ✅ Detailed changes
Affected Assets, Files, and Routes:view changes for bundle: core/playerAssets Changed:
view changes for bundle: plugins/beacon/coreAssets Changed:
view changes for bundle: plugins/stage-revert-data/coreAssets Changed:
view changes for bundle: plugins/common-types/coreAssets Changed:
view changes for bundle: plugins/common-expressions/coreAssets Changed:
view changes for bundle: react/playerAssets Changed:
view changes for bundle: plugins/metrics/coreAssets Changed:
view changes for bundle: plugins/check-path/coreAssets Changed:
view changes for bundle: plugins/reference-assets/coreAssets Changed:
view changes for bundle: plugins/async-node/coreAssets Changed:
view changes for bundle: plugins/markdown/coreAssets Changed:
|
| A function called to fetch the next flow. If the flow is complete, return `nil`. | ||
| `CompletedState` will be `nil` if it is asking for the first state | ||
| - parameters: | ||
| - state: The `CompletedState` from the previous flow if there was one |
There was a problem hiding this comment.
do we need to update this comment
There was a problem hiding this comment.
I think it's up to date? Is there anything specific that you think we should update?
There was a problem hiding this comment.
oh I meant for changing the parameter name from state to result
| } | ||
|
|
||
| protected val manager: FlowManager = FlowManager(flows) | ||
| protected val internalManager = AsyncIterationManager(manager) |
There was a problem hiding this comment.
Can we rename AsyncIterationManager to AsyncIterationFlow since we're changing the context of what "manager" represents here? Then we can just rename this to managerFlow instead of internalManager
| } | ||
|
|
||
| protected val manager: FlowManager = FlowManager(flows) | ||
| protected val internalManager = AsyncIterationManager(manager) |
There was a problem hiding this comment.
rename this to iterationManager
|
|
||
| /** Generic async iterator that uses some [Result] to determine the next [Item] in the iteration */ | ||
| public interface AsyncIterator<Item : Any, Result : Any> { | ||
| public interface AsyncIterator<Item : Any, Result : Any, Data : Any> { |
There was a problem hiding this comment.
This is a breaking change, right?
There was a problem hiding this comment.
Yeah. I have some release notes for it here.
Why
Ideally, Player's APIs are consistent on different platforms. This PR better aligns the
FlowManagerAPIs across platforms.What
The updates to the Migration Notes double as the "what" section and Release Notes of this PR.
Change Type (required)
Indicate the type of change your pull request is:
patchminormajorN/A(part of 1.0)Does your PR have any documentation updates?