(PureBasic) 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.

Note: This example requires Chilkat v11.5.0 or greater.

For more information, see https://www.chilkatsoft.com/curl_dependency_engine.asp

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkHttpCurl.pb"
IncludeFile "CkJsonObject.pb"

Procedure ChilkatExample()

    success.i = 0

    httpCurl.i = CkHttpCurl::ckCreate()
    If httpCurl.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

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

    ; Define a helper function that produces order_id from customer_id.
    fnName.s = "getOrderId"
    CkHttpCurl::ckAddFunction(httpCurl,fnName,"curl -X GET https://api.example.com/order-id?customer={{customer_id}}")
    CkHttpCurl::ckAddOutput(httpCurl,fnName,"order.id","order_id")

    ; Define a helper function that produces customer_id from account_name.
    fnName = "getCustomerId"
    CkHttpCurl::ckAddFunction(httpCurl,fnName,"curl -X GET https://api.example.com/customer-id?account={{account_name}}")
    CkHttpCurl::ckAddOutput(httpCurl,fnName,"customer.id","customer_id")

    ; Provide the starting known input.
    CkHttpCurl::ckSetVar(httpCurl,"account_name","acme")

    ; Examine the execution plan without running any requests.
    planJson.i = CkJsonObject::ckCreate()
    If planJson.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::setCkEmitCompact(planJson, 0)

    success = CkHttpCurl::ckExaminePlan(httpCurl,targetCurl,planJson)

    ; Success is expected to be 1.
    Debug "success = " + Str(success)

    Debug CkJsonObject::ckEmit(planJson)

    ; 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": []
    ;   }]
    ; }


    CkHttpCurl::ckDispose(httpCurl)
    CkJsonObject::ckDispose(planJson)


    ProcedureReturn
EndProcedure