Improve SanityChecker error message

[alamb]

Which issue does this PR close?

Part of #12446

Rationale for this change

Today when the SanityChecker fails it is not always clear why and dumps out a message like thisL

Error during planning: Plan: ["SortPreservingMergeExec: [d@4 ASC NULLS LAST,c@1 ASC NULLS LAST,a@2 ASC NULLS LAST,a0@3 ASC NULLS LAST,b@0 ASC NULLS LAST], fetch=2", " UnionExec", " SortExec: TopK(fetch=2), expr=[d@4 ASC NULLS LAST,c@1 ASC NULLS LAST,a@2 ASC NULLS LAST,b@0 ASC NULLS LAST], preserve_partitioning=[false]", " ProjectionExec: expr=[b@1 as b, c@2 as c, a@0 as a, NULL as a0, d@3 as d]", " CsvExec: file_groups={1 group: [[Users/andrewlamb/Software/datafusion2/datafusion/core/tests/data/window_2.csv]]}, projection=[a, b, c, d], output_ordering=[c@2 ASC NULLS LAST], has_header=true", " SortExec: TopK(fetch=2), expr=[d@4 ASC NULLS LAST,c@1 ASC NULLS LAST,a0@3 ASC NULLS LAST,b@0 ASC NULLS LAST], preserve_partitioning=[false]", " ProjectionExec: expr=[b@1 as b, c@2 as c, NULL as a, a0@0 as a0, d@3 as d]", " CsvExec: file_groups={1 group: [[Users/andrewlamb/Software/datafusion2/datafusion/core/tests/data/window_2.csv]]}, projection=[a0, b, c, d], output_ordering=[c@2 ASC NULLS LAST], has_header=true"] does not satisfy order requirements: [PhysicalSortRequirement { expr: Column { name: "d", index: 4 }, options: Some(SortOptions { descending: false, nulls_first: false }) }, PhysicalSortRequirement { expr: Column { name: "c", index: 1 }, options: Some(SortOptions { descending: false, nulls_first: false }) }, PhysicalSortRequirement { expr: Column { name: "a", index: 2 }, options: Some(SortOptions { descending: false, nulls_first: false }) }, PhysicalSortRequirement { expr: Column { name: "a0", index: 3 }, options: Some(SortOptions { descending: false, nulls_first: false }) }, PhysicalSortRequirement { expr: Column { name: "b", index: 0 }, options: Some(SortOptions { descending: false, nulls_first: false }) }]. Child-0 order: OrderingEquivalenceClass { orderings: [[PhysicalSortExpr { expr: Column { name: "d", index: 4 }, options: SortOptions { descending: false, nulls_first: false } }, PhysicalSortExpr { expr: Column { name: "c", index: 1 }, options: SortOptions { descending: false, nulls_first: false } }]] }

It would be nice to at least have the actual and required ordering dumped out in readable form

What changes are included in this PR?

Improve the display of the actual and required ordering in the error message
Here is an example of what the output looks liek now:

Error during planning: Plan: ["SortPreservingMergeExec: [c@0 ASC NULLS LAST,a@1 ASC NULLS LAST,a0@2 ASC NULLS LAST,b@3 ASC NULLS LAST], fetch=2", " UnionExec", " SortExec: TopK(fetch=2), expr=[c@0 ASC NULLS LAST,a@1 ASC NULLS LAST,b@3 ASC NULLS LAST], preserve_partitioning=[false]", " ProjectionExec: expr=[c@2 as c, a@0 as a, NULL as a0, b@1 as b]", " MemoryExec: partitions=1, partition_sizes=[1]", " SortExec: TopK(fetch=2), expr=[c@0 ASC NULLS LAST,a0@2 ASC NULLS LAST,b@3 ASC NULLS LAST], preserve_partitioning=[false]", " ProjectionExec: expr=[c@2 as c, NULL as a, a0@0 as a0, b@1 as b]", " MemoryExec: partitions=1, partition_sizes=[1]"] does not satisfy order requirements: [c@0 ASC NULLS LAST, a@1 ASC NULLS LAST, a0@2 ASC NULLS LAST, b@3 ASC NULLS LAST]. Child-0 order: [[c@0 ASC NULLS LAST]]

Specifically I think the part is now useful:

does not satisfy order requirements: [c@0 ASC NULLS LAST, a@1 ASC NULLS LAST, a0@2 ASC NULLS LAST, b@3 ASC NULLS LAST]. Child-0 order: [[c@0 ASC NULLS LAST]]

Are these changes tested?

Are there any user-facing changes?

[comphead]

lgtm thanks @alamb wondering why no tests are failing 🤔

[alamb]

lgtm thanks @alamb wondering why no tests are failing 🤔

Its because this error only happens due to bugs (like #12446) so in theory it "shouldn't be able to be hit" 😆

[alamb]

Thank you for the review @comphead