-
Notifications
You must be signed in to change notification settings - Fork 18
v1.10.0 Release #302
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Varshitha Bachu (bachuv)
wants to merge
3
commits into
main
Choose a base branch
from
vabachu/prepare-v1.10.0-release
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
v1.10.0 Release #302
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| # Durable Task Azure Blob Payloads for Java | ||
|
|
||
| The `durabletask-azure-blob-payloads` module transparently externalizes large Durable Task payloads to Azure Blob Storage. Payloads below the configured threshold continue to travel inline; larger payloads are replaced with opaque blob references and restored before user code receives them. | ||
|
|
||
| ## Install | ||
|
|
||
| Add the module alongside the Durable Task client and your backend-specific extension: | ||
|
|
||
| ```groovy | ||
| implementation 'com.microsoft:durabletask-azure-blob-payloads:1.10.0' | ||
|
bachuv marked this conversation as resolved.
|
||
| ``` | ||
|
|
||
| The module includes Azure Blob Storage support. Applications that use managed identity should also add `com.azure:azure-identity`. | ||
|
|
||
| ## Usage | ||
|
|
||
| Configure the same storage location for every client and worker that exchanges externalized payloads: | ||
|
|
||
| ```java | ||
| LargePayloadStorageOptions payloadOptions = new LargePayloadStorageOptions() | ||
| .setConnectionString(System.getenv("PAYLOAD_STORAGE_CONNECTION_STRING")) | ||
| .setContainerName("durabletask-payloads") | ||
| .setThresholdBytes(900_000); | ||
|
|
||
| PayloadStore payloadStore = new BlobPayloadStore(payloadOptions); | ||
|
|
||
| DurableTaskGrpcClientBuilder clientBuilder = new DurableTaskGrpcClientBuilder(); | ||
| DurableTaskSchedulerClientExtensions.useDurableTaskScheduler(clientBuilder, schedulerConnectionString); | ||
| LargePayloadClientExtensions.useExternalizedPayloads(clientBuilder, payloadStore, payloadOptions); | ||
|
|
||
| DurableTaskGrpcWorkerBuilder workerBuilder = new DurableTaskGrpcWorkerBuilder(); | ||
| DurableTaskSchedulerWorkerExtensions.useDurableTaskScheduler(workerBuilder, schedulerConnectionString); | ||
| LargePayloadWorkerExtensions.useExternalizedPayloads(workerBuilder, payloadStore, payloadOptions); | ||
| ``` | ||
|
|
||
| For identity-based authentication, configure an account URI and `TokenCredential` instead of a connection string: | ||
|
|
||
| ```java | ||
| LargePayloadStorageOptions payloadOptions = new LargePayloadStorageOptions() | ||
| .setAccountUri(URI.create("https://<account>.blob.core.windows.net")) | ||
| .setCredential(new DefaultAzureCredentialBuilder().build()); | ||
| ``` | ||
|
|
||
| ## Defaults and limits | ||
|
|
||
| - Payloads of at least 900,000 bytes are externalized by default. | ||
| - The threshold can be configured up to 1 MiB. | ||
| - The default maximum externalized payload size is 10 MiB. | ||
| - Payloads are gzip-compressed by default. | ||
| - The default container name is `durabletask-payloads`. | ||
| - The container is created automatically on the first upload. | ||
|
|
||
| The storage identity needs permission to create the container and read and write blobs. Payload blobs are retained after orchestration processing, so configure an Azure Storage lifecycle policy appropriate for the application's retention requirements. | ||
|
|
||
| ## Sample | ||
|
|
||
| See [`LargePayloadSample`](../samples/src/main/java/io/durabletask/samples/LargePayloadSample.java): | ||
|
|
||
| ```text | ||
| ./gradlew :samples:runLargePayloadSample | ||
| ``` | ||
|
|
||
| The sample uses the DTS emulator and Azurite and verifies a payload larger than 1 MiB through a client, orchestration, and activity round trip. | ||
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
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
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
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
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
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
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
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Non-blocking: the
Packagesartifact is missing the sources and Javadoc JARs forazurefunctionsandazuremanaged.I inspected the artifact from this PR's CI run: it contains 11 JARs rather than the expected 15 (binary, sources, and Javadoc for each of the five modules). The earlier
./gradlew clean testdeletes the initially assembled outputs, and the later integration-test builds recreate the sources/Javadoc JARs only forclient,azure-blob-payloads, andexporthistory.Could we run
./gradlew assembleimmediately before this upload so all five modules have complete outputs? All binary JARs are present, and the separate official release pipeline assembles and publishes independently, so this is a CI artifact completeness issue rather than a runtime or production-release blocker.