mirror of
https://github.com/temporalio/skill-temporal-developer.git
synced 2026-09-14 13:52:58 +08:00
0c8586b4c2
* Add Java SDK reference files (11 files) Create complete Java reference documentation covering: - java.md: Entry point with quick start tutorial, key concepts - patterns.md: 17 patterns (signals, queries, updates, child workflows, saga, cancellation scopes, heartbeating, etc.) - determinism.md: Safe alternatives table, forbidden operations - determinism-protection.md: Convention-based enforcement (no sandbox) - error-handling.md: ApplicationFailure, retry/timeout config - gotchas.md: Non-deterministic operations, cancellation, heartbeating - testing.md: TestWorkflowEnvironment, Mockito mocking, replay testing - versioning.md: Workflow.getVersion(), worker versioning - data-handling.md: Jackson, PayloadConverter, encryption, search attributes - observability.md: SLF4J logging, Micrometer metrics - advanced-features.md: Schedules, async completion, worker tuning Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * Fix Java alignment issues from self-review - Reduce gotchas.md Non-Deterministic Operations from ~94 lines to ~12 (reference determinism.md instead of duplicating) - Remove Workflow Failure Exception Types duplication from error-handling.md (keep only in advanced-features.md) - Expand versioning.md Worker Versioning with Key Concepts, PINNED vs AUTO_UPGRADE, Deployment Strategies subsections - Fix section names to match Python reference style: Activity Heartbeat Details, Handling Activity Errors, Retry Policy Configuration, Workflow Test Environment, Mocking Activities, Workflow Replay Testing - Reduce data-handling.md Payload Encryption verbosity - Reduce observability.md Logger Customization verbosity - Reduce testing.md to single approach per section - Rename determinism.md "Convention-Based Enforcement" to "SDK Protection" - Fix handler guidance in patterns.md to match Python Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * Fix correctness issues in Java reference files - patterns.md: Fix Queries section — ActivityStub → typed interface (Workflow.newActivityStub returns the typed interface, not ActivityStub) - data-handling.md: Add missing ProtobufPayloadConverter to default converter chain (4th of 5 converters) Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * Add Java to SKILL.md and core/determinism.md - SKILL.md: Add "Temporal Java" trigger phrase, update Overview to list Java, add Java entry to Getting Started references - core/determinism.md: Add Java entry to SDK Protection Mechanisms (no sandbox, convention-based, NonDeterministicException at replay) Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * Apply manual editorial fixes to Java references - java.md: Remove "Understanding Replay" section (covered by Overview), simplify File Organization note (no sandbox rationale) - gotchas.md: Move Heartbeating before Cancellation, make Wrong Retry Classification brief with reference (not inline examples) - error-handling.md: Remove editorializing from Workflow Failure note - determinism-protection.md: Remove cross-language comparison paragraph (state Java's approach on its own terms) Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * Add temporal-workflowcheck static analysis to Java determinism docs - determinism-protection.md: Add "Static Analysis with temporal-workflowcheck" section with Gradle/Maven setup, manual run, and suppression instructions. Beta warning included. - determinism.md: Update overview and SDK Protection to reference workflowcheck - core/determinism.md: Update Java entry in SDK Protection Mechanisms Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * Integrate feedback from Go PR into Java patterns - Updates: Add validator note — validators must not mutate state or block (matches note added to Python, TypeScript, Go, and core) - Saga Pattern: Use Workflow.newDetachedCancellationScope() for compensations so they execute even if the workflow is cancelled (mirrors Go's workflow.NewDisconnectedContext pattern) Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com> * docs: add @WorkflowInit description to java.md Key Concepts Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * mark java as supported * Apply suggestions from code review Co-authored-by: Brian Strauch <brian@brianstrauch.com> * strongly recommend java 21+ * Softened stance on static checker and replay testing. * address python/typescript sandboxing comment --------- Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Co-authored-by: Brian Strauch <brian.strauch@temporal.io> Co-authored-by: Brian Strauch <brian@brianstrauch.com>
84 lines
3.3 KiB
Markdown
84 lines
3.3 KiB
Markdown
# Java Determinism Protection
|
|
|
|
## Overview
|
|
|
|
The Java SDK has **no sandbox** (only Python and TypeScript have sandboxing). Java relies on developer conventions and runtime replay detection to enforce determinism. A static analysis tool (`temporal-workflowcheck`) is available in beta.
|
|
|
|
## Forbidden Operations
|
|
|
|
```java
|
|
// BAD: Non-deterministic operations in workflow code
|
|
Thread.sleep(1000);
|
|
UUID id = UUID.randomUUID();
|
|
double val = Math.random();
|
|
long now = System.currentTimeMillis();
|
|
new Thread(() -> doWork()).start();
|
|
CompletableFuture.supplyAsync(() -> compute());
|
|
|
|
// GOOD: Deterministic Workflow.* alternatives
|
|
Workflow.sleep(Duration.ofSeconds(1));
|
|
String id = Workflow.randomUUID().toString();
|
|
int val = Workflow.newRandom().nextInt();
|
|
long now = Workflow.currentTimeMillis();
|
|
Promise<Void> promise = Async.procedure(() -> doWork());
|
|
CompletablePromise<String> promise = Workflow.newPromise();
|
|
```
|
|
|
|
## Static Analysis with `temporal-workflowcheck`
|
|
|
|
**Warning:** This tool is in beta.
|
|
|
|
`temporal-workflowcheck` scans compiled bytecode to detect non-deterministic operations in workflow code. It catches threading, I/O, randomization, system time access, and non-final static field access — including transitive violations through call chains.
|
|
|
|
### Setup (Gradle)
|
|
|
|
Add the dependency as a compile-only check:
|
|
|
|
```groovy
|
|
dependencies {
|
|
implementation 'io.temporal:temporal-sdk:1.+'
|
|
compileOnly 'io.temporal:temporal-workflowcheck:1.+'
|
|
}
|
|
```
|
|
|
|
See the [Gradle sample](https://github.com/temporalio/sdk-java/tree/master/temporal-workflowcheck/samples/gradle) for full task configuration.
|
|
|
|
### Setup (Maven)
|
|
|
|
See the [Maven sample](https://github.com/temporalio/sdk-java/tree/master/temporal-workflowcheck/samples/maven) for POM configuration.
|
|
|
|
### Running Manually
|
|
|
|
Download the `-all.jar` from Maven Central (`io.temporal:temporal-workflowcheck`) and run:
|
|
|
|
```bash
|
|
java -jar temporal-workflowcheck-<version>-all.jar check <classpath-entries>
|
|
```
|
|
|
|
### Suppressing False Positives
|
|
|
|
Use the `@WorkflowCheck.SuppressWarnings` annotation on methods:
|
|
|
|
```java
|
|
@WorkflowCheck.SuppressWarnings(invalidMembers = "currentTimeMillis")
|
|
public long getCurrentMillis() {
|
|
return System.currentTimeMillis();
|
|
}
|
|
```
|
|
|
|
Or use a `.properties` configuration file with `--config <path>` for third-party library false positives.
|
|
|
|
## Convention-Based Enforcement
|
|
|
|
Java workflow code runs in a cooperative threading model where only one workflow thread executes at a time under a global lock. The SDK does not intercept or block non-deterministic calls. Instead, non-determinism is detected at **replay time**: if replayed code produces results that differ from the recorded history, the SDK throws a `NonDeterministicException`.
|
|
|
|
Use both `temporal-workflowcheck` (static, pre-deploy) and `WorkflowReplayer` (replay testing) to catch non-determinism before production.
|
|
|
|
## Best Practices
|
|
|
|
1. Run `temporal-workflowcheck` in CI to catch non-deterministic code statically
|
|
2. Always use `Workflow.*` APIs instead of standard Java equivalents for time, randomness, UUIDs, sleeping, and threading
|
|
3. Test all workflow code changes with `WorkflowReplayer` against recorded histories
|
|
4. Keep workflows focused on orchestration logic; move all I/O and side effects into activities
|
|
5. Avoid mutable static state shared across workflow instances
|