partiql-visualize-dot: add

[rajivr]

Extract code from partiql-rust-cli/src/visualize

Issue #, if available:

Description of changes:

As mentioned here, I have tried to extract code from partiql-rust-cli/src/visualize, so we can easily use it in our tests and other places.

One way of using it might be as follows.

In Cargo.toml

[dev-dependencies]
# ...
partiql-visualize-dot = { path = "../partiql-visualize-dot", version = "0.5.*" }

And then within a test we can do

use partiql_visualize_dot::{PlanToDot, ToDotGraph};

#[test]
fn test {
    // create `logical` which is a value of `LogicalPlan<BindingsOp>`
    let plan_to_dot = PlanToDot::default();
    println!("{}", plan_to_dot.to_graph(&logical));
}

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

[rajivr]

To add further context, here is how I was able to visualize tests::custom_ion_scan_text which uses a custom catalog.

[alancai98]

Thanks for the addition! The PartiQL Rust team is ok w/ moving the partiql-rust-cli dot visualization over. Since this visualization code was part of the experimental partiql-rust-cli, we would prefer if it was under the extension directory and also be behind a features flag.

Could you also add

• An entry to the CHANGELOG for this addition
• A brief README for this new crate, containing some of the verbiage from the partiql-rust-cli about this crate being experimental, subject to change, etc.

Once those are added and the other comments are addressed, we should be good to approve your PR.

[alancai98]

Could you put a features section for dot visualization and call it something like visualize-dot?

[rajivr]

I am not entirely clear how adding visualize-dot to features would be helpful. Please allow me to explain and let me know your thoughts.

From what I can make out, the code in partiql-rust-cli/src/visualize creates an output in dot format, using dot-writer crate.

It then uses other crates to support rendering in different formats, such as png, svg, etc.,

In the current PR, I've only extracted the code to just create dot output. I am guessing when we add support for png, svg output, those can be behind feature flags in order to minimize the dependency graph?

[alancai98]

Sorry perhaps I should have added more detail in my initial comment. Since the dot visualization of the logical plan is still experimental / a PoC, we'd like to put the new functions and structures behind a feature similar to what was done for partiql-ast's serde feature:

• partiql-ast feature for serde:

  partiql-lang-rust/partiql-ast/Cargo.toml

  Lines 31 to 36 in b9a8885

  	serde = [
  	"dep:serde",
  	"rust_decimal/serde-with-str",
  	"rust_decimal/serde",
  	"indexmap/serde",
  	]

• example of using a cfg expression to conditionally include code when serde feature is enabled:

  partiql-lang-rust/partiql-ast/src/ast.rs

  Line 24 in b9a8885

  #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]

With how we had defined the serde feature, the above code would only be compiled and built when the serde feature is specified (or --all-features). We would like something similar for partiql-extension-visualize.

[rajivr]

I have added visualize-dot feature. Please review.

[codecov]

Codecov Report

Attention: 615 lines in your changes are missing coverage. Please review.

Comparison is base (6ef3177) 81.91% compared to head (2e527b8) 79.00%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #438      +/-   ##
==========================================
- Coverage   81.91%   79.00%   -2.91%     
==========================================
  Files          63       65       +2     
  Lines       16718    17333     +615     
  Branches    16718    17333     +615     
==========================================
  Hits        13694    13694              
- Misses       2460     3075     +615     
  Partials      564      564              

Files	Coverage Δ
...ion/partiql-extension-visualize/src/plan_to_dot.rs	0.00% <0.00%> (ø)
...sion/partiql-extension-visualize/src/ast_to_dot.rs	0.00% <0.00%> (ø)

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[rajivr]

Could you also add

* An entry to the CHANGELOG for this addition

* A brief README for this new crate, containing some of the verbiage from the partiql-rust-cli about this crate being experimental, subject to change, etc.

CHANGELOG and README has been added.

[alancai98]

Thanks for applying the comments. Changes since first review look good (and thanks for merging/rebasing off of main!). I left a followup to the features comment from the prior review. Once that's resolved, think this is ready to merge.

[alancai98]

Looks good. Thanks for the PR!

[alancai98]

Ignoring coverage CI failure since this is experimental/PoC.