[v1] Planner docs and cleanup

[alancai98]

Relevant Issues

• None

Description

• Planner package audit
• Add javadoc for public planner APIs
• Re-arrange planner directories
• Remove top-level internal functions
• Fix warnings in internal planner code + tests

License Information

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

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 80.03%. Comparing base (4bf549b) to head (4b549ee).
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff            @@
##               main    #1708   +/-   ##
=========================================
  Coverage     80.03%   80.03%           
  Complexity       47       47           
=========================================
  Files            19       19           
  Lines           506      506           
  Branches         23       23           
=========================================
  Hits            405      405           
  Misses           88       88           
  Partials         13       13           

Flag	Coverage Δ
EXAMPLES	80.03% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

[alancai98]

(self-review) unified the utils/util/helper subpackages to be under util

[alancai98]

(self-review) previously, these were all top-level internal functions. moved to be under a designated internal object

[alancai98]

(self-review) unified normalize and transforms sub-packages to be under transforms. confusingly, we had some normalize code split between the two packages

[github-actions]

CROSS-ENGINE-REPORT ❌

	BASE (LEGACY-V0.14.8)	TARGET (EVAL-6979E3A)	+/-
% Passing	89.67%	94.32%	4.65% ✅
Passing	5287	5561	274 ✅
Failing	609	47	-562 ✅
Ignored	0	288	288 🔶
Total Tests	5896	5896	0 ✅

Testing Details

• Base Commit: v0.14.8
• Base Engine: LEGACY
• Target Commit: 6979e3a
• Target Engine: EVAL

Result Details

• ❌ REGRESSION DETECTED. See Now Failing/Ignored Tests. ❌
• Passing in both: 2637
• Failing in both: 17
• Ignored in both: 0
• PASSING in BASE but now FAILING in TARGET: 2
• PASSING in BASE but now IGNORED in TARGET: 115
• FAILING in BASE but now PASSING in TARGET: 180
• IGNORED in BASE but now PASSING in TARGET: 0

Now FAILING Tests ❌

The following 2 test(s) were previously PASSING in BASE but are now FAILING in TARGET:

Click here to see

1. inPredicateWithTableConstructor, compileOption: PERMISSIVE
2. notInPredicateWithTableConstructor, compileOption: PERMISSIVE

Now IGNORED Tests ❌

The complete list can be found in GitHub CI summary, either from Step Summary or in the Artifact.

Now Passing Tests

180 test(s) were previously failing in BASE (LEGACY-V0.14.8) but now pass in TARGET (EVAL-6979E3A). Before merging, confirm they are intended to pass.

The complete list can be found in GitHub CI summary, either from Step Summary or in the Artifact.

CROSS-COMMIT-REPORT ✅

	BASE (EVAL-CB0276C)	TARGET (EVAL-6979E3A)	+/-
% Passing	94.32%	94.32%	0.00% ✅
Passing	5561	5561	0 ✅
Failing	47	47	0 ✅
Ignored	288	288	0 ✅
Total Tests	5896	5896	0 ✅

Testing Details

• Base Commit: cb0276c
• Base Engine: EVAL
• Target Commit: 6979e3a
• Target Engine: EVAL

Result Details

• Passing in both: 5561
• Failing in both: 47
• Ignored in both: 288
• PASSING in BASE but now FAILING in TARGET: 0
• PASSING in BASE but now IGNORED in TARGET: 0
• FAILING in BASE but now PASSING in TARGET: 0
• IGNORED in BASE but now PASSING in TARGET: 0