test(amber): add unit test coverage for AmberMessage envelopes#4829
Open
aglinxinyuan wants to merge 2 commits intoapache:mainfrom
Open
test(amber): add unit test coverage for AmberMessage envelopes#4829aglinxinyuan wants to merge 2 commits intoapache:mainfrom
aglinxinyuan wants to merge 2 commits intoapache:mainfrom
Conversation
Add AmberMessageEnvelopesSpec covering the engine message envelope layer: - WorkflowFIFOMessage and WorkflowRecoveryMessage round-trip via case class accessors and the WorkflowMessage / Serializable traits - RecoveryPayload subtypes carry their args (with a real Pekko ActorSystem to wire ResendOutputTo's ActorRef field) - WorkflowMessage.getInMemSize for DataFrame, empty DataFrame, and the 200L default branch for any other WorkflowFIFOMessagePayload - WorkflowFIFOMessagePayload / DirectControlMessagePayload traits are implementable as custom payloads The catch-all "case _ => 200L" for non-WorkflowFIFOMessage subtypes is intentionally not tested because WorkflowMessage is sealed and today has only one subtype, so that branch is dead by construction. Closes apache#4828 Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
aglinxinyuan
requested review from
Yicong-Huang and
Copilot
and removed request for
Copilot
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #4829 +/- ##
============================================
+ Coverage 42.84% 43.20% +0.36%
- Complexity 2027 2036 +9
============================================
Files 957 957
Lines 34077 34077
Branches 3753 3753
============================================
+ Hits 14600 14724 +124
+ Misses 18693 18578 -115
+ Partials 784 775 -9
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Yicong-Huang
approved these changes
May 3, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds a new Scala unit test suite for Amber's message-envelope layer under ambermessage, targeting the lightweight wrapper/message types that underpin engine messaging and flow-control sizing.
Changes:
- Add
AmberMessageEnvelopesSpeccoveringWorkflowFIFOMessageandWorkflowRecoveryMessagefield/accessor behavior. - Add tests for
RecoveryPayloadsubtypes, includingResendOutputTowith a PekkoActorSystem. - Add tests for
WorkflowMessage.getInMemSizeand basic trait wiring forWorkflowFIFOMessagePayloadandDirectControlMessagePayload.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Per Copilot feedback on apache#4829: terminate() does not wait for shutdown to complete, leaving Pekko threads outliving the test and making "amber-message-envelopes-test" unavailable on JVM reruns. Switch to a suite-local ActorSystem shut down via TestKit.shutdownActorSystem in afterAll, matching the ControllerSpec / WorkerSpec cleanup pattern. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This file contains hidden or 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
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.
What changes were proposed in this PR?
Add
AmberMessageEnvelopesSpeccovering the engine message envelope layer:WorkflowFIFOMessage/WorkflowRecoveryMessageround-trip via case class accessors and theWorkflowMessage/SerializabletraitsRecoveryPayloadsubtypes (UpdateRecoveryStatus,ResendOutputTo,NotifyFailedNode) carry their args; theResendOutputToActorRef field is exercised via a real PekkoActorSystemWorkflowMessage.getInMemSizefor a DataFrame payload, an empty-frame DataFrame, and the 200L default for any otherWorkflowFIFOMessagePayloadWorkflowFIFOMessagePayload/DirectControlMessagePayloadtrait wiringThe catch-all
case _ => 200Lfor non-WorkflowFIFOMessagesubtypes is intentionally not tested becauseWorkflowMessageis sealed and today has only one subtype, so that branch is dead by construction.Any related issues, documentation, discussions?
Closes #4828
How was this PR tested?
sbt "WorkflowExecutionService/testOnly org.apache.texera.amber.engine.common.ambermessage.AmberMessageEnvelopesSpec"— 11/11 tests pass.Was this PR authored or co-authored using generative AI tooling?
Generated-by: Claude Code (Claude Opus 4.7)