Blyx

Waxwing

Workflow framework · 0.1.0

Check the depth and weighted resolver cost of an expanded GraphQL field plan.

Budget an expanded GraphQL field plan

The plan is only two levels deep, but its visit-weighted work is 17 against a budget of 15.

Run the native CLI

Extract the workflow collection for your platform. Run .\bin\waxwing.exe --help in PowerShell or ./bin/waxwing --help on Linux and macOS. Running the command with no arguments prints the worked example.

Build from source

With Blyx 0.2.1, Rust and a host linker installed, run these commands to edit and rebuild the example.

git clone --depth 1 --branch v0.1.0 https://github.com/Rahulchaube1/blyx-waxwing.git
cd blyx-waxwing
blyxc native-run project.blyx -- "1,2,2" "1,3,2" "1,4,2" 3 15

Why this framework exists

A flat query can cost more than a deep one when list fields fan out. Evaluate expanded cost and depth independently. GraphQL, demand control

Install Waxwing in your editor

Extension RahulChaube.blyx-waxwing · 0.1.0

The extension includes a runnable Blyx example, function completions and the framework source. For the modular project, extract the starter, open its folder and run blyxc native-run main.blyx with the native toolchain installed.

Create an empty .blyx file, type blyx-waxwing-demo and accept the completion. Choose Blyx: Run File to run the example.

For an offline installation, choose Extensions: Install from VSIX for Blyx Language first, then for Waxwing.

Download the companion Blyx Language VSIX

Libraries in this framework

Install with Conda

Create an environment containing Waxwing 0.1.0, its Blyx source and a runnable example. Run the second command with Blyx 0.2.1, Rust and a host linker installed.

conda create -y --prefix ./blyx-env --override-channels -c https://rahulchaube1.github.io/blyx-packages blyx-waxwing=0.1.0=0
blyxc native-run ./blyx-env/share/blyx/waxwing/main.blyx

To use this package in your application, copy share/blyx/waxwing/vendor/waxwing from the environment into your project's vendor directory.

Install the full collection with Homebrew or Scoop

Import into a Blyx project

Install Blyx 0.2.1, Rust 1.85 or newer and a host linker. From the directory containing your entry file, clone this tagged release.

git clone --depth 1 --branch v0.1.0 https://github.com/Rahulchaube1/blyx-waxwing.git vendor/waxwing

You can also download Waxwing as a ZIP. Extract its contents into vendor/waxwing.

Save this as main.blyx beside vendor and run blyxc native-run main.blyx.

use vendor::waxwing::waxwing;

fn main() {
    let depths = [1, 2, 2];
    let units = [1, 3, 2];
    let visits = [1, 4, 2];
    let max_depth = 3.0;
    let budget = 15.0;
    let result = waxwing_budget(depths, units, visits, max_depth, budget);
    if len(result) == 0 { println!("invalid"); return; }
    let mut i = 0;
    while i < len(result) {
        println!(at(result, i));
        i += 1;
    }
}

Expected output

0
2
17
1

API and input requirements

Returns [admitted, maximum depth, total work, costliest field index]. Supply resolved aliases, fragments and list visit estimates from your parser. Invalid arguments and nonfinite results return an empty vector.

APIUse
waxwing_budget(depths, units, visits, max_depth, budget)Returns [admitted, maximum depth, total work, costliest field index]. Supply resolved aliases, fragments and list visit estimates from your parser.

Develop and contribute

Open the tagged source to read the implementation and examples. Include the smallest reproducible Blyx program, compiler version and expected result when reporting an issue.