microsoft / microsoft/durabletask-java
Improved orchestrator and activity input/output handling
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Java
- Sterne
- 29
- Forks
- 18
- Ø Merge
- 1 T. 10 Std.
- Gemergte PRs (30 T.)
- 2
Beschreibung
Background
The current TaskOrchestration and TaskActivity interfaces require implementations to use the context object to receive inputs. Consider the following example (copied from the integration tests):
final String orchestratorName = "SingleActivity";
final String activityName = "Echo";
final String input = Instant.now().toString();
DurableTaskGrpcWorker worker = this.createWorkerBuilder()
.addOrchestrator(orchestratorName, ctx -> {
String activityInput = ctx.getInput(String.class);
String output = ctx.callActivity(activityName, activityInput, String.class).get();
ctx.complete(output);
})
.addActivity(activityName, ctx -> {
return String.format("Hello, %s!", ctx.getInput(String.class));
})
.buildAndStart();
This design, while it works, has a few issues:
- The fetching of inputs is not type-safe because the call to
ctx.getInput(String.class)could fail if the input isn't actually a string. - The call to
ctx.getInput()isn't intuitive, making the programming model harder for developers to learn. - The call to
ctx.complete(output)is both unintuitive and inconsistent with how activity functions are defined.
This issue tracks improving the programming model to make processing inputs and outputs more intuitive and type-safe.
Proposal
The proposal is to change these interface definitions so that a developer could write the following, simpler orchestration and activity implementations:
final String orchestratorName = "SingleActivity";
final String activityName = "Echo";
final String input = Instant.now().toString();
DurableTaskGrpcWorker worker = this.createWorkerBuilder()
.addOrchestrator(orchestratorName, (ctx, activityInput) -> {
return ctx.callActivity(activityName, activityInput, String.class).get();
})
.addActivity(activityName, (ctx, name) -> {
return String.format("Hello, %s!", name);
})
.buildAndStart();
The differences are:
- The orchestrator and activity functions have the input passed to them explicitly.
- The orchestrator can use the return value to set the output.
This results in a simpler, more intuitive programming model and is also consistent with the proposed C# programming model.
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne damit, die TaskOrchestration- und TaskActivity-Schnittstellen sowie die in der Issue referenzierten Integrationstestbeispiele zu überprüfen. Verfolge, wie Eingaben und Ausgaben derzeit durch den Kontext fließen, und aktualisiere anschließend das Programmiermodell so, dass Implementierungen typisierte Eingaben erhalten und Ausgaben wie gezeigt zurückgeben; die Integrationstests sollten die vorgeschlagene Verwendung demonstrieren.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- java
- Bereich
- backend-api-design
- Issue-Typ
- Feature
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100