Menerapkan timer tahan lama untuk penundaan dan batas waktu

Durable Functions menyediakan timer durable untuk digunakan dalam fungsi orkestrator untuk menerapkan penundaan atau untuk menyiapkan batas waktu pada tindakan asinkron. Gunakan timer yang tahan lama dalam fungsi orkestrator alih-alih sleep atau delay API yang mungkin sudah ada dalam bahasa.

SDK Tugas Tahan Lama menyediakan timer tahan lama untuk digunakan dalam orkestrasi untuk menerapkan penundaan atau untuk menyiapkan batas waktu pada tindakan asinkron. Gunakan timer yang tahan lama dalam orkestrasi alih-alih sleep atau delay API yang mungkin sudah terintegrasi ke dalam bahasa.

Penting

Saat ini, PowerShell Durable Task SDK tidak tersedia.

Timer tahan lama adalah tugas yang dibuat menggunakan API create timer yang sesuai untuk bahasa yang tersedia, seperti yang ditunjukkan dalam contoh berikut dan mengambil waktu jatuh tempo atau durasi sebagai argumen.

C#

// Put the orchestrator to sleep for 72 hours
DateTime dueTime = context.CurrentUtcDateTime.AddHours(72);
await context.CreateTimer(dueTime, CancellationToken.None);

JavaScript

// Put the orchestrator to sleep for 72 hours
// Note that DateTime comes from the "luxon" module
const deadline = DateTime.fromJSDate(context.df.currentUtcDateTime, {zone: 'utc'}).plus({ hours: 72 });
yield context.df.createTimer(deadline.toJSDate());

Python

# Put the orchestrator to sleep for 72 hours
due_time = context.current_utc_datetime + timedelta(hours=72)
durable_timeout_task = context.create_timer(due_time)

PowerShell

# Put the orchestrator to sleep for 72 hours
$duration = New-TimeSpan -Hours 72
Start-DurableTimer -Duration $duration

Java

// Put the orchestrator to sleep for 72 hours
ctx.createTimer(Duration.ofHours(72)).await();

C#

// Put the orchestration to sleep for 72 hours
await context.CreateTimer(TimeSpan.FromHours(72), CancellationToken.None);

Python

# Put the orchestration to sleep for 72 hours
from datetime import timedelta
yield ctx.create_timer(timedelta(hours=72))

Java

// Put the orchestration to sleep for 72 hours
ctx.createTimer(Duration.ofHours(72)).await();

JavaScript

// Put the orchestration to sleep for 72 hours
yield ctx.createTimer(72 * 60 * 60);

PowerShell

SDK Tugas Tahan Lama tidak tersedia untuk PowerShell. Gunakan Durable Functions sebagai gantinya.

Saat Anda await tugas timer, fungsi orkestrator berhenti sejenak sampai waktu kedaluwarsa yang telah ditentukan.

Ketika Anda await tugas timer, orkestrasi berhenti sampai waktu berakhir yang ditentukan.

Nota

Orkestrasi terus memproses peristiwa masuk lainnya sambil menunggu tugas timer kedaluwarsa.

Batasan timer tahan lama

Saat Anda membuat timer yang kedaluwarsa pada pukul 16.30 UTC, Kerangka Kerja Tugas Tahan Lama yang mendasar mengantrekan pesan yang hanya terlihat pada pukul 16.30 UTC. Jika aplikasi fungsi diskalakan ke nol instans sementara itu, pesan timer yang baru terlihat memastikan bahwa aplikasi fungsi diaktifkan lagi pada VM yang sesuai.

Nota

• Untuk aplikasi JavaScript, Python, dan PowerShell, timer tahan lama dibatasi hingga enam hari. Untuk mengatasi batasan ini, gunakan API timer dalam perulangan while untuk mensimulasikan penundaan yang lebih lama. Aplikasi .NET dan Java terbaru mendukung timer dengan durasi yang dapat diatur sesuka hati.
• Tergantung pada versi SDK dan penyedia penyimpanan yang digunakan, timer panjang enam hari atau lebih mungkin diterapkan secara internal menggunakan serangkaian timer yang lebih singkat (misalnya, durasi tiga hari) hingga waktu kedaluwarsa yang diinginkan tercapai. Perilaku ini dapat diamati di penyimpanan data yang mendasar tetapi tidak memengaruhi perilaku orkestrasi.
• Jangan gunakan API tanggal/waktu bawaan untuk mendapatkan waktu saat ini. Saat menghitung tanggal kedaluwarsa timer di masa depan, selalu gunakan API waktu saat ini dari fungsi orkestrator. Untuk informasi selengkapnya, lihat artikel Batasan kode fungsi orkestrator.

Saat Anda membuat timer yang kedaluwarsa pada pukul 16.30 UTC, Kerangka Kerja Tugas Tahan Lama yang mendasar mengantrekan pesan yang hanya terlihat pada pukul 16.30 UTC. Pesan timer memastikan bahwa pekerja diaktifkan lagi ketika timer habis.

Nota

• Menentukan penundaan panjang (misalnya, penundaan beberapa hari atau lebih) dapat mengakibatkan pembuatan beberapa timer tahan lama yang dikelola secara internal. Kode orkestrasi tidak perlu menyadari perilaku ini. Namun, mungkin dapat diamati pada log framework dan status riwayat tersimpan.
• Jangan gunakan API tanggal dan waktu bawaan untuk mendapatkan waktu saat ini. Saat menghitung tanggal mendatang agar timer kedaluwarsa, selalu gunakan properti waktu konteks orkestrasi saat ini (seperti context.CurrentUtcDateTime di .NET, ctx.current_utc_datetime di Python, atau ctx.currentUtcDateTime di JavaScript).

Gunakan timer tahan lama untuk penundaan

Contoh berikut menunjukkan cara menggunakan timer tahan lama untuk menunda eksekusi. Contohnya mengeluarkan pemberitahuan penagihan setiap hari selama 10 hari.

C#

[FunctionName("BillingIssuer")]
public static async Task Run(
    [OrchestrationTrigger] IDurableOrchestrationContext context)
{
    for (int i = 0; i < 10; i++)
    {
        DateTime deadline = context.CurrentUtcDateTime.Add(TimeSpan.FromDays(1));
        await context.CreateTimer(deadline, CancellationToken.None);
        await context.CallActivityAsync("SendBillingEvent");
    }
}

Nota

Contoh C# sebelumnya menargetkan Durable Functions 2.x. Untuk Durable Functions 1.x, gunakan DurableOrchestrationContext alih-alih IDurableOrchestrationContext. Untuk informasi selengkapnya tentang perbedaan antar versi, lihat artikel versi Durable Functions .

JavaScript

const df = require("durable-functions");
const { DateTime } = require("luxon");

module.exports = df.orchestrator(function*(context) {
    for (let i = 0; i < 10; i++) {
        const deadline = DateTime.fromJSDate(context.df.currentUtcDateTime, {zone: 'utc'}).plus({ days: 1 });
        yield context.df.createTimer(deadline.toJSDate());
        yield context.df.callActivity("SendBillingEvent");
    }
});

Python

import azure.functions as func
import azure.durable_functions as df
from datetime import datetime, timedelta

def orchestrator_function(context: df.DurableOrchestrationContext):
    for i in range(0, 9):
        deadline = context.current_utc_datetime + timedelta(days=1)
        yield context.create_timer(deadline)
        yield context.call_activity("SendBillingEvent")

main = df.Orchestrator.create(orchestrator_function)

PowerShell

param($Context)

for ($num = 0 ; $num -le 9 ; $num++){
    $expiryTime = New-TimeSpan -Days 1
    $timerTask = Start-DurableTimer -Duration $expiryTime
    Invoke-DurableActivity -FunctionName 'SendBillingEvent'
}

Java

@FunctionName("BillingIssuer")
public String billingIssuer(
        @DurableOrchestrationTrigger(name = "ctx") TaskOrchestrationContext ctx) {
    for (int i = 0; i < 10; i++) {
        ctx.createTimer(Duration.ofDays(1)).await();
        ctx.callActivity("SendBillingEvent").await();
    }
    return "done";
}

C#

public class BillingIssuer : TaskOrchestrator<object?, string>
{
    public override async Task<string> RunAsync(TaskOrchestrationContext context, object? input)
    {
        for (int i = 0; i < 10; i++)
        {
            await context.CreateTimer(TimeSpan.FromDays(1), CancellationToken.None);
            await context.CallActivityAsync("SendBillingEvent");
        }
        return "done";
    }
}

Python

from datetime import timedelta
from durabletask import task

def send_billing_event(ctx: task.ActivityContext, _) -> None:
    # Send billing event
    pass

def billing_issuer(ctx: task.OrchestrationContext, _):
    for i in range(10):
        yield ctx.create_timer(timedelta(days=1))
        yield ctx.call_activity(send_billing_event)
    return "done"

Java

public class BillingIssuer implements TaskOrchestration {
    @Override
    public void run(TaskOrchestrationContext ctx) {
        for (int i = 0; i < 10; i++) {
            ctx.createTimer(Duration.ofDays(1)).await();
            ctx.callActivity("SendBillingEvent").await();
        }
        ctx.complete("done");
    }
}

JavaScript

import { ActivityContext, OrchestrationContext, TOrchestrator } from "@microsoft/durabletask-js";

const sendBillingEvent = async (_: ActivityContext): Promise<void> => {
    // Send billing event
};

const billingIssuer: TOrchestrator = async function* (ctx: OrchestrationContext): any {
    for (let i = 0; i < 10; i++) {
        yield ctx.createTimer(24 * 60 * 60); // 1 day
        yield ctx.callActivity(sendBillingEvent);
    }
    return "done";
};

PowerShell

SDK Tugas Tahan Lama tidak tersedia untuk PowerShell. Gunakan Durable Functions sebagai gantinya.

Peringatan

Hindari perulangan tak terbatas dalam fungsi orkestrator. Untuk informasi tentang cara menerapkan skenario perulangan tak terbatas dengan aman dan efisien, lihat Orkestrasi abadi.

Peringatan

Hindari perulangan tak terbatas dalam orkestrasi. Untuk informasi tentang cara menerapkan skenario perulangan tak terbatas dengan aman dan efisien, lihat Orkestrasi abadi.

Gunakan timer tahan lama untuk batas waktu

Contoh ini menunjukkan cara menggunakan timer tahan lama untuk menerapkan batas waktu:

C#

[FunctionName("TryGetQuote")]
public static async Task<bool> Run(
    [OrchestrationTrigger] IDurableOrchestrationContext context)
{
    TimeSpan timeout = TimeSpan.FromSeconds(30);
    DateTime deadline = context.CurrentUtcDateTime.Add(timeout);

    using (var cts = new CancellationTokenSource())
    {
        Task activityTask = context.CallActivityAsync("GetQuote");
        Task timeoutTask = context.CreateTimer(deadline, cts.Token);

        Task winner = await Task.WhenAny(activityTask, timeoutTask);
        if (winner == activityTask)
        {
            // success case
            cts.Cancel();
            return true;
        }
        else
        {
            // timeout case
            return false;
        }
    }
}

Nota

Contoh C# sebelumnya menargetkan Durable Functions 2.x. Untuk Durable Functions 1.x, gunakan DurableOrchestrationContext alih-alih IDurableOrchestrationContext. Untuk informasi selengkapnya tentang perbedaan antar versi, lihat artikel versi Durable Functions .

JavaScript

const df = require("durable-functions");
const { DateTime } = require("luxon");

module.exports = df.orchestrator(function*(context) {
    const deadline = DateTime.fromJSDate(context.df.currentUtcDateTime, {zone: 'utc'}).plus({ seconds: 30 });

    const activityTask = context.df.callActivity("GetQuote");
    const timeoutTask = context.df.createTimer(deadline.toJSDate());

    const winner = yield context.df.Task.any([activityTask, timeoutTask]);
    if (winner === activityTask) {
        // success case
        timeoutTask.cancel();
        return true;
    }
    else
    {
        // timeout case
        return false;
    }
});

Python

import azure.functions as func
import azure.durable_functions as df
from datetime import datetime, timedelta

def orchestrator_function(context: df.DurableOrchestrationContext):
    deadline = context.current_utc_datetime + timedelta(seconds=30)
    activity_task = context.call_activity("GetQuote")
    timeout_task = context.create_timer(deadline)

    winner = yield context.task_any([activity_task, timeout_task])
    if winner == activity_task:
        timeout_task.cancel()
        return True
    elif winner == timeout_task:
        return False

main = df.Orchestrator.create(orchestrator_function)

PowerShell

param($Context)

$expiryTime =  New-TimeSpan -Seconds 30

$activityTask = Invoke-DurableActivity -FunctionName 'GetQuote' -NoWait
$timerTask = Start-DurableTimer -Duration $expiryTime -NoWait

$winner = Wait-DurableTask -Task @($activityTask, $timerTask) -Any

if ($winner -eq $activityTask) {
    Stop-DurableTimerTask -Task $timerTask
    return $True
}
else {
    return $False
}

Java

@FunctionName("TryGetQuote")
public boolean tryGetQuote(
        @DurableOrchestrationTrigger(name = "ctx") TaskOrchestrationContext ctx) {
    Task<Double> activityTask = ctx.callActivity("GetQuote", Double.class);
    Task<Void> timerTask = ctx.createTimer(Duration.ofSeconds(30));

    Task<?> winner = ctx.anyOf(activityTask, timerTask);
    if (winner == activityTask) {
        // success case
        return true;
    } else {
        // timeout case
        return false;
    }
}

C#

public class TryGetQuote : TaskOrchestrator<object?, bool>
{
    public override async Task<bool> RunAsync(TaskOrchestrationContext context, object? input)
    {
        using var cts = new CancellationTokenSource();

        Task<double> activityTask = context.CallActivityAsync<double>("GetQuote");
        Task timeoutTask = context.CreateTimer(TimeSpan.FromSeconds(30), cts.Token);

        Task winner = await Task.WhenAny(activityTask, timeoutTask);
        if (winner == activityTask)
        {
            // success case
            cts.Cancel();
            return true;
        }
        else
        {
            // timeout case
            return false;
        }
    }
}

Python

from datetime import timedelta
from durabletask import task

def get_quote(ctx: task.ActivityContext, _) -> float:
    # Get quote logic
    return 100.0

def try_get_quote(ctx: task.OrchestrationContext, _):
    activity_task = ctx.call_activity(get_quote)
    timeout_task = ctx.create_timer(timedelta(seconds=30))

    winner = yield task.when_any([activity_task, timeout_task])
    if winner == activity_task:
        # success case
        return True
    else:
        # timeout case
        return False

Java

public class TryGetQuote implements TaskOrchestration {
    @Override
    public void run(TaskOrchestrationContext ctx) {
        Task<Double> activityTask = ctx.callActivity("GetQuote", Double.class);
        Task<Void> timerTask = ctx.createTimer(Duration.ofSeconds(30));

        Task<?> winner = ctx.anyOf(activityTask, timerTask).await();
        if (winner == activityTask) {
            // success case
            ctx.complete(true);
        } else {
            // timeout case
            ctx.complete(false);
        }
    }
}

JavaScript

import { ActivityContext, OrchestrationContext, TOrchestrator, whenAny } from "@microsoft/durabletask-js";

const getQuote = async (_: ActivityContext): Promise<number> => {
    // Get quote logic
    return 100.0;
};

const tryGetQuote: TOrchestrator = async function* (ctx: OrchestrationContext): any {
    const activityTask = ctx.callActivity(getQuote);
    const timeoutTask = ctx.createTimer(30);

    const winner = yield whenAny([activityTask, timeoutTask]);
    if (winner === activityTask) {
        // success case
        return true;
    } else {
        // timeout case
        return false;
    }
};

PowerShell

SDK Tugas Tahan Lama tidak tersedia untuk PowerShell. Gunakan Durable Functions sebagai gantinya.

Peringatan

Di .NET, JavaScript, Python, dan PowerShell, batalkan timer tahan lama yang dibuat jika kode Anda tidak menunggunya selesai. Lihat contoh sebelumnya tentang cara membatalkan timer yang tertunda. Kerangka Tugas Tahan Lama tidak mengubah status orkestrasi menjadi "Selesai" hingga semua tugas yang belum selesai, termasuk tugas timer yang tahan lama, baik diselesaikan maupun dibatalkan.

Peringatan

Jika SDK Anda mendukung pembatalan timer (misalnya, .NET), batalkan timer tahan lama yang dibuat jika kode Anda tidak menunggunya selesai. Lihat contoh sebelumnya tentang cara membatalkan timer yang tertunda. Kerangka Tugas Tahan Lama tidak mengubah status orkestrasi menjadi "Selesai" hingga semua tugas yang belum selesai, termasuk tugas timer yang tahan lama, baik diselesaikan maupun dibatalkan.

Mekanisme pembatalan ini menggunakan pola when-any yang tidak mengakhiri fungsi aktivitas yang sedang berjalan atau eksekusi sub-orkestrasi. Sebaliknya, itu hanya memungkinkan fungsi orkestrator mengabaikan hasilnya dan melanjutkan. Jika aplikasi fungsi Anda menggunakan paket Konsumsi, Anda masih ditagih untuk waktu dan memori yang dikonsumsi oleh fungsi aktivitas yang terbengkalai. Secara default, fungsi yang berjalan dalam paket Konsumsi memiliki batas waktu lima menit. Jika batas ini terlampaui, host Azure Functions akan memulai ulang untuk menghentikan semua proses eksekusi dan mencegah situasi penagihan yang tidak terkendali. Batas waktu fungsi dapat dikonfigurasi.

Untuk contoh yang lebih rinci tentang cara menerapkan batas waktu dalam fungsi orkestrator, lihat artikel Interaksi manusia .

Mekanisme pembatalan ini menggunakan pola when-any tidak mengakhiri aktivitas yang sedang berjalan atau eksekusi sub-orkestrasi. Sebaliknya, itu hanya memungkinkan orkestrasi mengabaikan hasilnya dan melanjutkan.

Langkah berikutnya

Pelajari cara memicu dan menangani peristiwa eksternal

Mulai menggunakan Durable Task SDK