Skip to content

Commit 3ba4c70

Browse files
kaibocaikaibocai
authored
hide suspend and resume API (#129)
update CHANGELOG.MD
1 parent 6ccb073 commit 3ba4c70

File tree

4 files changed

+113
-114
lines changed

4 files changed

+113
-114
lines changed

‎CHANGELOG.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
## v1.1.0
22

33
### Updates
4-
* Support Suspend and Resume Client APIs ([#104](https://github.com/microsoft/durabletask-java/issues/104))
54
* Fix the potential NPE issue of `DurableTaskClient terminate` method ([#104](https://github.com/microsoft/durabletask-java/issues/104))
65
* Add waitForCompletionOrCreateCheckStatusResponse client API ([#115](https://github.com/microsoft/durabletask-java/pull/115))
76
* Support long timers by breaking up into smaller timers ([#114](https://github.com/microsoft/durabletask-java/issues/114))

‎client/src/main/java/com/microsoft/durabletask/DurableTaskClient.java‎

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -282,33 +282,33 @@ public abstract OrchestrationMetadata waitForInstanceCompletion(
282282
*/
283283
public abstract PurgeResult purgeInstances(PurgeInstanceCriteria purgeInstanceCriteria) throws TimeoutException;
284284

285-
/**
286-
* Suspends a running orchestration instance.
287-
* @param instanceId the ID of the orchestration instance to suspend
288-
*/
289-
public void suspendInstance (String instanceId) {
290-
this.suspendInstance(instanceId, null);
291-
}
292-
293-
/**
294-
* Resumes a running orchestration instance.
295-
* @param instanceId the ID of the orchestration instance to resume
296-
*/
297-
public void resumeInstance(String instanceId) {
298-
this.resumeInstance(instanceId, null);
299-
}
300-
301-
/**
302-
* Suspends a running orchestration instance.
303-
* @param instanceId the ID of the orchestration instance to suspend
304-
* @param reason the reason for suspending the orchestration instance
305-
*/
306-
public abstract void suspendInstance(String instanceId, @Nullable String reason);
307-
308-
/**
309-
* Resumes a running orchestration instance.
310-
* @param instanceId the ID of the orchestration instance to resume
311-
* @param reason the reason for resuming the orchestration instance
312-
*/
313-
public abstract void resumeInstance(String instanceId, @Nullable String reason);
285+
// /**
286+
// * Suspends a running orchestration instance.
287+
// * @param instanceId the ID of the orchestration instance to suspend
288+
// */
289+
// public void suspendInstance (String instanceId) {
290+
// this.suspendInstance(instanceId, null);
291+
// }
292+
//
293+
// /**
294+
// * Resumes a running orchestration instance.
295+
// * @param instanceId the ID of the orchestration instance to resume
296+
// */
297+
// public void resumeInstance(String instanceId) {
298+
// this.resumeInstance(instanceId, null);
299+
// }
300+
//
301+
// /**
302+
// * Suspends a running orchestration instance.
303+
// * @param instanceId the ID of the orchestration instance to suspend
304+
// * @param reason the reason for suspending the orchestration instance
305+
// */
306+
// public abstract void suspendInstance(String instanceId, @Nullable String reason);
307+
//
308+
// /**
309+
// * Resumes a running orchestration instance.
310+
// * @param instanceId the ID of the orchestration instance to resume
311+
// * @param reason the reason for resuming the orchestration instance
312+
// */
313+
// public abstract void resumeInstance(String instanceId, @Nullable String reason);
314314
}

‎client/src/main/java/com/microsoft/durabletask/DurableTaskGrpcClient.java‎

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -283,25 +283,25 @@ public PurgeResult purgeInstances(PurgeInstanceCriteria purgeInstanceCriteria) t
283283
}
284284
}
285285

286-
@Override
287-
public void suspendInstance(String instanceId, @Nullable String reason) {
288-
SuspendRequest.Builder suspendRequestBuilder = SuspendRequest.newBuilder();
289-
suspendRequestBuilder.setInstanceId(instanceId);
290-
if (reason != null) {
291-
suspendRequestBuilder.setReason(StringValue.of(reason));
292-
}
293-
this.sidecarClient.suspendInstance(suspendRequestBuilder.build());
294-
}
295-
296-
@Override
297-
public void resumeInstance(String instanceId, @Nullable String reason) {
298-
ResumeRequest.Builder resumeRequestBuilder = ResumeRequest.newBuilder();
299-
resumeRequestBuilder.setInstanceId(instanceId);
300-
if (reason != null) {
301-
resumeRequestBuilder.setReason(StringValue.of(reason));
302-
}
303-
this.sidecarClient.resumeInstance(resumeRequestBuilder.build());
304-
}
286+
// @Override
287+
// public void suspendInstance(String instanceId, @Nullable String reason) {
288+
// SuspendRequest.Builder suspendRequestBuilder = SuspendRequest.newBuilder();
289+
// suspendRequestBuilder.setInstanceId(instanceId);
290+
// if (reason != null) {
291+
// suspendRequestBuilder.setReason(StringValue.of(reason));
292+
// }
293+
// this.sidecarClient.suspendInstance(suspendRequestBuilder.build());
294+
// }
295+
//
296+
// @Override
297+
// public void resumeInstance(String instanceId, @Nullable String reason) {
298+
// ResumeRequest.Builder resumeRequestBuilder = ResumeRequest.newBuilder();
299+
// resumeRequestBuilder.setInstanceId(instanceId);
300+
// if (reason != null) {
301+
// resumeRequestBuilder.setReason(StringValue.of(reason));
302+
// }
303+
// this.sidecarClient.resumeInstance(resumeRequestBuilder.build());
304+
// }
305305

306306
private PurgeResult toPurgeResult(PurgeInstancesResponse response){
307307
return new PurgeResult(response.getDeletedInstanceCount());

‎client/src/test/java/com/microsoft/durabletask/IntegrationTests.java‎

Lines changed: 65 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -408,71 +408,71 @@ void termination() throws TimeoutException {
408408
}
409409
}
410410

411-
@Test
412-
void suspendResumeOrchestration() throws TimeoutException, InterruptedException {
413-
final String orchestratorName = "suspend";
414-
final String eventName = "MyEvent";
415-
final String eventPayload = "testPayload";
416-
final Duration suspendTimeout = Duration.ofSeconds(5);
417-
418-
DurableTaskGrpcWorker worker = this.createWorkerBuilder()
419-
.addOrchestrator(orchestratorName, ctx -> {
420-
String payload = ctx.waitForExternalEvent(eventName, String.class).await();
421-
ctx.complete(payload);
422-
})
423-
.buildAndStart();
424-
425-
DurableTaskClient client = new DurableTaskGrpcClientBuilder().build();
426-
try (worker; client) {
427-
String instanceId = client.scheduleNewOrchestrationInstance(orchestratorName);
428-
client.suspendInstance(instanceId);
429-
OrchestrationMetadata instance = client.waitForInstanceStart(instanceId, defaultTimeout);
430-
assertNotNull(instance);
431-
assertEquals(OrchestrationRuntimeStatus.SUSPENDED, instance.getRuntimeStatus());
432-
433-
client.raiseEvent(instanceId, eventName, eventPayload);
434-
435-
assertThrows(
436-
TimeoutException.class,
437-
() -> client.waitForInstanceCompletion(instanceId, suspendTimeout, false),
438-
"Expected to throw TimeoutException, but it didn't"
439-
);
440-
441-
String resumeReason = "Resume for testing.";
442-
client.resumeInstance(instanceId, resumeReason);
443-
instance = client.waitForInstanceCompletion(instanceId, defaultTimeout, true);
444-
assertNotNull(instance);
445-
assertEquals(instanceId, instance.getInstanceId());
446-
assertEquals(eventPayload, instance.readOutputAs(String.class));
447-
assertEquals(OrchestrationRuntimeStatus.COMPLETED, instance.getRuntimeStatus());
448-
}
449-
}
450-
451-
@Test
452-
void terminateSuspendOrchestration() throws TimeoutException, InterruptedException {
453-
final String orchestratorName = "suspendResume";
454-
final String eventName = "MyEvent";
455-
final String eventPayload = "testPayload";
456-
457-
DurableTaskGrpcWorker worker = this.createWorkerBuilder()
458-
.addOrchestrator(orchestratorName, ctx -> {
459-
String payload = ctx.waitForExternalEvent(eventName, String.class).await();
460-
ctx.complete(payload);
461-
})
462-
.buildAndStart();
463-
464-
DurableTaskClient client = new DurableTaskGrpcClientBuilder().build();
465-
try (worker; client) {
466-
String instanceId = client.scheduleNewOrchestrationInstance(orchestratorName);
467-
String suspendReason = "Suspend for testing.";
468-
client.suspendInstance(instanceId, suspendReason);
469-
client.terminate(instanceId, null);
470-
OrchestrationMetadata instance = client.waitForInstanceCompletion(instanceId, defaultTimeout, false);
471-
assertNotNull(instance);
472-
assertEquals(instanceId, instance.getInstanceId());
473-
assertEquals(OrchestrationRuntimeStatus.TERMINATED, instance.getRuntimeStatus());
474-
}
475-
}
411+
// @Test
412+
// void suspendResumeOrchestration() throws TimeoutException, InterruptedException {
413+
// final String orchestratorName = "suspend";
414+
// final String eventName = "MyEvent";
415+
// final String eventPayload = "testPayload";
416+
// final Duration suspendTimeout = Duration.ofSeconds(5);
417+
//
418+
// DurableTaskGrpcWorker worker = this.createWorkerBuilder()
419+
// .addOrchestrator(orchestratorName, ctx -> {
420+
// String payload = ctx.waitForExternalEvent(eventName, String.class).await();
421+
// ctx.complete(payload);
422+
// })
423+
// .buildAndStart();
424+
//
425+
// DurableTaskClient client = new DurableTaskGrpcClientBuilder().build();
426+
// try (worker; client) {
427+
// String instanceId = client.scheduleNewOrchestrationInstance(orchestratorName);
428+
// client.suspendInstance(instanceId);
429+
// OrchestrationMetadata instance = client.waitForInstanceStart(instanceId, defaultTimeout);
430+
// assertNotNull(instance);
431+
// assertEquals(OrchestrationRuntimeStatus.SUSPENDED, instance.getRuntimeStatus());
432+
//
433+
// client.raiseEvent(instanceId, eventName, eventPayload);
434+
//
435+
// assertThrows(
436+
// TimeoutException.class,
437+
// () -> client.waitForInstanceCompletion(instanceId, suspendTimeout, false),
438+
// "Expected to throw TimeoutException, but it didn't"
439+
// );
440+
//
441+
// String resumeReason = "Resume for testing.";
442+
// client.resumeInstance(instanceId, resumeReason);
443+
// instance = client.waitForInstanceCompletion(instanceId, defaultTimeout, true);
444+
// assertNotNull(instance);
445+
// assertEquals(instanceId, instance.getInstanceId());
446+
// assertEquals(eventPayload, instance.readOutputAs(String.class));
447+
// assertEquals(OrchestrationRuntimeStatus.COMPLETED, instance.getRuntimeStatus());
448+
// }
449+
// }
450+
//
451+
// @Test
452+
// void terminateSuspendOrchestration() throws TimeoutException, InterruptedException {
453+
// final String orchestratorName = "suspendResume";
454+
// final String eventName = "MyEvent";
455+
// final String eventPayload = "testPayload";
456+
//
457+
// DurableTaskGrpcWorker worker = this.createWorkerBuilder()
458+
// .addOrchestrator(orchestratorName, ctx -> {
459+
// String payload = ctx.waitForExternalEvent(eventName, String.class).await();
460+
// ctx.complete(payload);
461+
// })
462+
// .buildAndStart();
463+
//
464+
// DurableTaskClient client = new DurableTaskGrpcClientBuilder().build();
465+
// try (worker; client) {
466+
// String instanceId = client.scheduleNewOrchestrationInstance(orchestratorName);
467+
// String suspendReason = "Suspend for testing.";
468+
// client.suspendInstance(instanceId, suspendReason);
469+
// client.terminate(instanceId, null);
470+
// OrchestrationMetadata instance = client.waitForInstanceCompletion(instanceId, defaultTimeout, false);
471+
// assertNotNull(instance);
472+
// assertEquals(instanceId, instance.getInstanceId());
473+
// assertEquals(OrchestrationRuntimeStatus.TERMINATED, instance.getRuntimeStatus());
474+
// }
475+
// }
476476

477477
@Test
478478
void activityFanOut() throws IOException, TimeoutException {

0 commit comments

Comments
 (0)