Skip to content

Allow overriding orchestration version when starting orchestrations via APIs #658

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.

Sign up for GitHub

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
wants to merge 1 commit into
base: v3.x
Choose a base branch
from
Open

Allow overriding orchestration version when starting orchestrations via APIs #658

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 18 additions & 4 deletions samples-ts/functions/httpStart.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,25 @@ const httpStart: HttpHandler = async (
): Promise<HttpResponse> => {
const client = df.getClient(context);
const body: unknown = await request.json();
const instanceId: string = await client.startNew(request.params.orchestratorName, {
input: body,
});

context.log(`Started orchestration with ID = '${instanceId}'.`);
// Get optional version from query parameter
const version = request.query.get("version");

let instanceId: string;
if (version) {
// Override the orchestration version
instanceId = await client.startNew(request.params.orchestratorName, {
input: body,
version: version,
});
context.log(`Started orchestration with ID = '${instanceId}' and version = '${version}'.`);
} else {
// Use defaultVersion from host.json
instanceId = await client.startNew(request.params.orchestratorName, {
input: body,
});
context.log(`Started orchestration with ID = '${instanceId}'.`);
}

return client.createCheckStatusResponse(request, instanceId);
};
Expand Down
13 changes: 11 additions & 2 deletions samples-ts/functions/orchestrationVersion.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,21 @@ const versionedOrchestrator: OrchestrationHandler = function* (context: Orchestr
yield context.df.waitForExternalEvent("Continue");
context.df.setCustomStatus("Continue event received");

// New sub-orchestrations will use the current defaultVersion specified in host.json
// You can explicitly pass a version to sub-orchestrators
const subOrchestratorWithVersionResult = yield context.df.callSubOrchestrator(
"versionedSuborchestrator",
undefined, // input
undefined, // instanceId
"0.9" // version override
);

// Without specifying version, the sub-orchestrator will use the current defaultVersion
const subOrchestratorResult = yield context.df.callSubOrchestrator("versionedSuborchestrator");

return [
`Orchestration version: ${context.df.version}`,
`Suborchestration version: ${subOrchestratorResult}`,
`Suborchestration version (explicit): ${subOrchestratorWithVersionResult}`,
`Suborchestration version (default): ${subOrchestratorResult}`,
`Activity result: ${activityResult}`,
];
};
Expand Down
2 changes: 1 addition & 1 deletion samples-ts/host.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
},
"extensionBundle": {
"id": "Microsoft.Azure.Functions.ExtensionBundle",
"version": "[3.15.0, 4.0.0)"
"version": "[4.26.0, 5.0.0)"
},
"extensions": {
"durableTask": {
Expand Down
3 changes: 2 additions & 1 deletion src/actions/CallSubOrchestratorAction.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@ export class CallSubOrchestratorAction implements IAction {
constructor(
public readonly functionName: string,
public readonly instanceId?: string,
input?: unknown
input?: unknown,
public readonly version?: string
) {
this.input = input;
Utils.throwIfEmpty(functionName, "functionName");
Expand Down
3 changes: 2 additions & 1 deletion src/actions/CallSubOrchestratorWithRetryAction.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@ export class CallSubOrchestratorWithRetryAction implements IAction {
public readonly functionName: string,
public readonly retryOptions: RetryOptions,
input?: unknown,
public readonly instanceId?: string
public readonly instanceId?: string,
public readonly version?: string
) {
this.input = input;
Utils.throwIfEmpty(functionName, "functionName");
Expand Down
14 changes: 12 additions & 2 deletions src/durableClient/DurableClient.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -484,16 +484,26 @@ export class DurableClient implements types.DurableClient {
const instanceIdPath: string = options?.instanceId ? `/${options.instanceId}` : "";
if (this.clientData.rpcBaseUrl) {
// Fast local RPC path
requestUrl = new URL(
const urlObj = new URL(
`orchestrators/${orchestratorFunctionName}${instanceIdPath}`,
this.clientData.rpcBaseUrl
).href;
);
if (options?.version) {
urlObj.searchParams.append("version", options.version);
}
requestUrl = urlObj.href;
} else {
// Legacy app frontend path
requestUrl = this.clientData.creationUrls.createNewInstancePostUri;
requestUrl = requestUrl
.replace(this.functionNamePlaceholder, orchestratorFunctionName)
.replace(this.instanceIdPlaceholder, instanceIdPath);
if (options?.version) {
const separator = requestUrl.includes("?") ? "&" : "?";
requestUrl = `${requestUrl}${separator}version=${encodeURIComponent(
options.version
)}`;
}
}

const headers = this.getDistributedTracingHeaders();
Expand Down
15 changes: 11 additions & 4 deletions src/orchestrations/DurableOrchestrationContext.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,14 +201,19 @@ export class DurableOrchestrationContext implements types.DurableOrchestrationCo
this.taskOrchestratorExecutor.recordFireAndForgetAction(action);
}

public callSubOrchestrator(name: string, input?: unknown, instanceId?: string): Task {
public callSubOrchestrator(
name: string,
input?: unknown,
instanceId?: string,
version?: string
): Task {
if (!name) {
throw new Error(
"A sub-orchestration function name must be provided when attempting to create a suborchestration"
);
}

const newAction = new CallSubOrchestratorAction(name, instanceId, input);
const newAction = new CallSubOrchestratorAction(name, instanceId, input, version);
const task = new AtomicTask(false, newAction);
return task;
}
Expand All @@ -217,7 +222,8 @@ export class DurableOrchestrationContext implements types.DurableOrchestrationCo
name: string,
retryOptions: types.RetryOptions,
input?: unknown,
instanceId?: string
instanceId?: string,
version?: string
): Task {
if (!name) {
throw new Error(
Expand All @@ -229,7 +235,8 @@ export class DurableOrchestrationContext implements types.DurableOrchestrationCo
name,
retryOptions,
input,
instanceId
instanceId,
version
);
const backingTask = new AtomicTask(false, newAction);
const task = new RetryableTask(backingTask, retryOptions);
Expand Down
108 changes: 101 additions & 7 deletions test/integration/orchestrator-spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1488,6 +1488,45 @@ describe("Orchestrator", () => {
);
});

it("schedules a versioned suborchestrator function", async () => {
const orchestrator = TestOrchestrations.SayHelloWithVersionedSubOrchestrator;
const name = "World";
const id = uuidv1();
const childId = `${id}:0`;
const mockContext = new DummyOrchestrationContext();
const orchestrationInput = new DurableOrchestrationInput(
id,
TestHistories.GetOrchestratorStart(
"SayHelloWithVersionedSubOrchestrator",
moment.utc().toDate()
),
name
);

const result = await orchestrator(orchestrationInput, mockContext);

expect(result).to.be.deep.equal(
new OrchestratorState(
{
isDone: false,
output: undefined,
actions: [
[
new CallSubOrchestratorAction(
"SayHelloWithActivity",
childId,
name,
"v2"
),
],
],
schemaVersion: ReplaySchema.V1,
},
true
)
);
});

it("schedules a suborchestrator function with no instanceId", async () => {
const orchestrator = TestOrchestrations.SayHelloWithSubOrchestratorNoSubId;
const name = "World";
Expand Down Expand Up @@ -1661,8 +1700,18 @@ describe("Orchestrator", () => {
.to.be.an("object")
.that.deep.include({
isDone: false,
// Note: In error paths, actions may be serialized without undefined fields.
// Using a plain object literal avoids setting expectations on the presence
// of any property that would cause deep.include to fail.
actions: [
[new CallSubOrchestratorAction("SayHelloWithActivity", childId, name)],
[
{
actionType: ActionType.CallSubOrchestrator,
functionName: "SayHelloWithActivity",
instanceId: childId,
input: name,
},
],
],
});
expect(orchestrationState.error).to.include(expectedErr);
Expand Down Expand Up @@ -1789,6 +1838,47 @@ describe("Orchestrator", () => {
);
});

it("schedules a versioned suborchestrator function with retry", async () => {
const orchestrator = TestOrchestrations.SayHelloWithVersionedSubOrchestratorRetry;
const name = "World";
const id = uuidv1();
const childId = `${id}:0`;
const mockContext = new DummyOrchestrationContext();
const orchestrationInput = new DurableOrchestrationInput(
id,
TestHistories.GetOrchestratorStart(
"SayHelloWithVersionedSubOrchestratorRetry",
moment.utc().toDate(),
name
),
name
);

const result = await orchestrator(orchestrationInput, mockContext);

expect(result).to.be.deep.equal(
new OrchestratorState(
{
isDone: false,
output: undefined,
actions: [
[
new CallSubOrchestratorWithRetryAction(
"SayHelloInline",
new RetryOptions(10000, 2),
name,
childId,
"v2"
),
],
],
schemaVersion: ReplaySchema.V1,
},
true
)
);
});

it("retries a failed suborchestrator function if < max attempts", async () => {
const orchestrator = TestOrchestrations.SayHelloWithSubOrchestratorRetry;
const name = "World";
Expand Down Expand Up @@ -1864,14 +1954,18 @@ describe("Orchestrator", () => {
.to.be.an("object")
.that.deep.include({
isDone: false,
// Note: In error paths, actions may be serialized without undefined fields.
// Using a plain object literal avoids setting expectations on the presence
// of any property that would cause deep.include to fail.
actions: [
[
new CallSubOrchestratorWithRetryAction(
"SayHelloInline",
new RetryOptions(10000, 2),
name,
childId
),
{
actionType: ActionType.CallSubOrchestratorWithRetry,
functionName: "SayHelloInline",
retryOptions: new RetryOptions(10000, 2),
instanceId: childId,
input: name,
},
],
],
});
Expand Down
30 changes: 30 additions & 0 deletions test/testobjects/TestOrchestrations.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -278,6 +278,20 @@ export class TestOrchestrations {
return output;
});

public static SayHelloWithVersionedSubOrchestrator = createOrchestrator(function* (
context: OrchestrationContext
) {
const input = context.df.getInput();
const childId = context.df.instanceId + ":0";
const output = yield context.df.callSubOrchestrator(
"SayHelloWithActivity",
input,
childId,
"v2"
);
return output;
});

public static SayHelloWithSubOrchestratorNoSubId: any = createOrchestrator(function* (
context: OrchestrationContext
) {
Expand Down Expand Up @@ -314,6 +328,22 @@ export class TestOrchestrations {
return output;
});

public static SayHelloWithVersionedSubOrchestratorRetry: any = createOrchestrator(function* (
context: any
) {
const input = context.df.getInput();
const childId = context.df.instanceId + ":0";
const retryOptions = new df.RetryOptions(10000, 2);
const output = yield context.df.callSubOrchestratorWithRetry(
"SayHelloInline",
retryOptions,
input,
childId,
"v2"
);
return output;
});

public static SayHelloWithSubOrchestratorRetryFanout: any = createOrchestrator(function* (
context: any
) {
Expand Down
6 changes: 6 additions & 0 deletions types/durableClient.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -372,6 +372,12 @@ export interface StartNewOptions {
* JSON-serializable input value for the orchestrator function.
*/
input?: unknown;

/**
* The version to use for the new orchestration instance. If not specified,
* the default version from host.json will be used.
*/
version?: string;
}

/**
Expand Down
9 changes: 7 additions & 2 deletions types/orchestration.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,8 +189,10 @@ export declare class DurableOrchestrationContext {
* @param instanceId A unique ID to use for the sub-orchestration instance.
* If `instanceId` is not specified, the extension will generate an id in
* the format `<calling orchestrator instance ID>:<#>`
* @param version The version to use for the sub-orchestration instance.
* If not specified, the default version from host.json will be used.
*/
callSubOrchestrator(name: string, input?: unknown, instanceId?: string): Task;
callSubOrchestrator(name: string, input?: unknown, instanceId?: string, version?: string): Task;

/**
* Schedules an orchestrator function named `name` for execution with retry
Expand All @@ -201,12 +203,15 @@ export declare class DurableOrchestrationContext {
* @param input The JSON-serializable input to pass to the orchestrator
* function.
* @param instanceId A unique ID to use for the sub-orchestration instance.
* @param version The version to use for the sub-orchestration instance.
* If not specified, the default version from host.json will be used.
*/
callSubOrchestratorWithRetry(
name: string,
retryOptions: RetryOptions,
input?: unknown,
instanceId?: string
instanceId?: string,
version?: string
): Task;

/**
Expand Down