Zig Requires Chilkat v11.5.0+

Viewing a Simple Three-Step Execution Plan

See more CURL Examples

This example demonstrates a straightforward, valid dependency chain that results in a three-step execution plan. The goal is not to execute the requests, but to inspect how the plan is constructed using ExaminePlan.

The target curl command requires {{order_id}}. A helper function is defined to produce order_id, but it depends on customer_id. Another helper function produces customer_id, which depends on account_name.

Because account_name is provided as a known input, the dependency chain can be fully resolved:

• customer_id is obtained from account_name
• order_id is obtained from customer_id
• The target curl command uses order_id

When ExaminePlan is called, it builds and returns a three-step execution plan showing the order in which each function would be executed.

Zig

const std = @import("std");
const chilkat = @import("chilkat");

pub fn main(init: std.process.Init) !void {
    const alloc = init.arena.allocator();

    var success: bool = false;

    const http_curl = try chilkat.HttpCurl.init();
    defer http_curl.deinit();

    // The target curl command requires {{order_id}}.
    const target_curl = "curl -X GET https://api.example.com/orders/{{order_id}}";

    // Define a helper function that produces order_id from customer_id.
    var fn_name: [:0]const u8 = "getOrderId";
    http_curl.addFunction(fn_name, "curl -X GET https://api.example.com/order-id?customer={{customer_id}}") catch {};
    http_curl.addOutput(fn_name, "order.id", "order_id") catch {};

    // Define a helper function that produces customer_id from account_name.
    fn_name = "getCustomerId";
    http_curl.addFunction(fn_name, "curl -X GET https://api.example.com/customer-id?account={{account_name}}") catch {};
    http_curl.addOutput(fn_name, "customer.id", "customer_id") catch {};

    // Provide the starting known input.
    http_curl.setVar("account_name", "acme");

    // Examine the execution plan without running any requests.
    const plan_json = try chilkat.JsonObject.init();
    defer plan_json.deinit();
    plan_json.setEmitCompact(false);

    success = if (http_curl.examinePlan(target_curl, plan_json)) true else |_| false;

    // Success is expected to be true.
    std.debug.print("success = {}\n", .{success});

    std.debug.print("{s}\n", .{try plan_json.emit(alloc)});

    // Expected result:
    //
    // {
    //   "plan": [{
    //     "function": "getCustomerId",
    //     "inputs": ["account_name"],
    //     "outputs": ["customer_id"]
    //   },{
    //     "function": "getOrderId",
    //     "inputs": ["customer_id"],
    //     "outputs": ["order_id"]
    //   },{
    //     "function": "targetCurl",
    //     "inputs": ["order_id"],
    //     "outputs": []
    //   }]
    // }
}