|
|
(JavaScript) curl How Known Variables Reduce Execution Steps
This example demonstrates how previously resolved values can simplify future executions.
When DoYourThing is called for a curl command, it builds an execution plan by resolving any missing inputs. This may require running one or more helper curl commands to produce the needed values.
As each command runs, any defined output variables are stored in the HttpCurl object and remain available for subsequent calls.
If another curl command is executed afterward—and it requires variables that are already known from earlier executions—those inputs do not need to be resolved again. As a result, the dependency chain is shorter, and the execution plan contains fewer steps.
In other words, each call to DoYourThing benefits from the current set of known variables. The more values that have already been resolved, the simpler and more direct the execution plan becomes.
This demonstrates that dependency resolution is dynamic and incremental: only missing inputs trigger additional steps, while previously computed values are reused automatically. Note: This example requires Chilkat v11.5.0 or greater. For more information, see https://www.chilkatsoft.com/curl_dependency_engine.asp
var success = false;
success = false;
// -----------------------------------------------------------------------------
// NOTE:
// This example builds on the earlier multi-step dependency example, where the
// execution plan required multiple curl commands (getSite → getDrives → target).
//
// If you have not seen that example, refer to it here: curl Multi-Step Dependency
//
//
// In this example, we demonstrate how previously resolved variables (site_id,
// drive_id, etc.) are reused across multiple calls to DoYourThing, resulting
// in simpler execution plans for subsequent requests.
// -----------------------------------------------------------------------------
var httpCurl = new CkHttpCurl();
// The final curl command we want to execute.
// It depends on {{drive_id}}, which may or may not already be known.
var targetCurl = "curl -X GET https://graph.microsoft.com/v1.0/drives/{{drive_id}}/root/children";
// Define helper function to get drives (produces drive_id, requires site_id)
var fnName = "getDrives";
httpCurl.AddFunction(fnName,"curl -X GET https://graph.microsoft.com/v1.0/sites/{{site_id}}/drives");
var jsonPath = "value[0].id";
httpCurl.AddOutput(fnName,jsonPath,"drive_id");
// Define helper function to get site (produces site_id, requires site_name)
fnName = "getSite";
httpCurl.AddFunction(fnName,"GET https://graph.microsoft.com/v1.0/sites/root:/sites/{{site_name}}");
jsonPath = "id";
httpCurl.AddOutput(fnName,jsonPath,"site_id");
// Provide the initial known input.
httpCurl.SetVar("site_name","test");
// Configure OAuth2 authentication (client credentials with secrets)
var jsonOAuth2 = new CkJsonObject();
jsonOAuth2.EnableSecrets = true;
jsonOAuth2.UpdateString("oauth2.client_id","!!sharepoint|oauth2|client_id");
jsonOAuth2.UpdateString("oauth2.client_secret","!!sharepoint|oauth2|client_secret");
jsonOAuth2.UpdateString("oauth2.scope","https://graph.microsoft.com/.default");
jsonOAuth2.UpdateString("oauth2.token_endpoint","!!sharepoint|oauth2|token_endpoint");
httpCurl.SetAuth(jsonOAuth2);
// -----------------------------------------------------------------------------
// EXAMINE THE EXECUTION PLAN (BEFORE RUNNING):
// At this point, drive_id and site_id are NOT known.
// We can inspect the plan that will be executed without sending any requests.
// -----------------------------------------------------------------------------
var planJson = new CkJsonObject();
planJson.EmitCompact = false;
success = httpCurl.ExaminePlan(targetCurl,planJson);
console.log("Execution plan before first call:");
console.log(planJson.Emit());
// Expected output:
//
// {
// "plan": [{
// "function": "getSite",
// "inputs": ["site_name"],
// "outputs": ["site_id"]
// },{
// "function": "getDrives",
// "inputs": ["site_id"],
// "outputs": ["drive_id"]
// },{
// "function": "targetCurl",
// "inputs": ["drive_id"],
// "outputs": []
// }]
// }
// -----------------------------------------------------------------------------
// FIRST CALL:
// At this point, drive_id and site_id are NOT known.
// The execution plan will include all required steps:
//
// 1) getSite → produces site_id
// 2) getDrives → produces drive_id
// 3) targetCurl → uses drive_id
// -----------------------------------------------------------------------------
success = httpCurl.DoYourThing(targetCurl);
if (success == false) {
console.log(httpCurl.LastErrorText);
return;
}
console.log("First call completed.");
console.log("site_id = " + httpCurl.GetVar("site_id"));
console.log("drive_id = " + httpCurl.GetVar("drive_id"));
// -----------------------------------------------------------------------------
// SECOND CALL (DIFFERENT TARGET):
// Now that site_id is already known, we can run another curl command that
// depends only on site_id. No need to call getSite again.
//
// Execution plan:
//
// 1) targetCurl2 → uses existing site_id
// -----------------------------------------------------------------------------
var targetCurl2 = "curl -X GET https://graph.microsoft.com/v1.0/sites/{{site_id}}";
success = httpCurl.ExaminePlan(targetCurl2,planJson);
console.log("");
console.log(planJson.Emit());
// Expected output:
//
// {
// "plan": [{
// "function": "targetCurl",
// "inputs": ["site_id"],
// "outputs": []
// }]
// }
success = httpCurl.DoYourThing(targetCurl);
if (success == false) {
console.log(httpCurl.LastErrorText);
return;
}
console.log("Second call completed (used existing site_id).");
// -----------------------------------------------------------------------------
// THIRD CALL (ORIGINAL TARGET AGAIN):
// drive_id is already known from the first call.
// Therefore, no helper functions are needed this time.
//
// Execution plan:
//
// 1) targetCurl → uses existing drive_id
// -----------------------------------------------------------------------------
success = httpCurl.ExaminePlan(targetCurl,planJson);
console.log("");
console.log(planJson.Emit());
// Expected output:
//
// {
// "plan": [{
// "function": "targetCurl",
// "inputs": ["drive_id"],
// "outputs": []
// }]
// }
success = httpCurl.DoYourThing(targetCurl);
if (success == false) {
console.log(httpCurl.LastErrorText);
return;
}
console.log("Third call completed.");
console.log("No dependency resolution was needed because all inputs were already known.");
|
