LP#1851413: Restore assumed order of full_path
authorMike Rylander <mrylander@gmail.com>
Tue, 5 Nov 2019 17:30:10 +0000 (12:30 -0500)
committerGalen Charlton <gmc@equinoxinitiative.org>
Fri, 11 Sep 2020 15:08:26 +0000 (11:08 -0400)
Some code, including UI rendering code in the reporting interfaces,
assumes that the order of the full_path stored procedure will be the
same as for the ancestors and descendants procedures, which is tree
order from top to bottom. However, because the full_path procedure
simply UNIONs the other two together without an explicit ORDER BY,
that may not be -- and for org hierarchies that have been modified
heavily, often is not -- the case in practice. This is due to
internals of query planning in Postgres.

The easiest place to see this issues is in the report interface.
Select a template folder that is not currently shared, choose Manage
Folder, select Share Folder, click Go, and see the dropdown of options.
Under some circumstances, the list of org units in the dropdown there
are incorrectly ordered (should be from top of the tree down), and some
that should be available are disabled.

This commit uses the org unit type depth to order the output as assumed.

Signed-off-by: Mike Rylander <mrylander@gmail.com>
Signed-off-by: Rogan Hamby <rogan.hamby@gmail.com>
Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org>
Open-ILS/src/sql/Pg/020.schema.functions.sql
Open-ILS/src/sql/Pg/upgrade/XXXX.function.restore_full_path_order.sql [new file with mode: 0644]

index b256087..9e82ac7 100644 (file)
@@ -205,11 +205,14 @@ CREATE OR REPLACE FUNCTION actor.org_unit_ancestors_distance( INT ) RETURNS TABL
 $$ LANGUAGE SQL STABLE ROWS 1;
 
 CREATE OR REPLACE FUNCTION actor.org_unit_full_path ( INT ) RETURNS SETOF actor.org_unit AS $$
-       SELECT  *
-         FROM  actor.org_unit_ancestors($1)
-                       UNION
-       SELECT  *
-         FROM  actor.org_unit_descendants($1);
+    SELECT  aou.*
+      FROM  actor.org_unit AS aou
+            JOIN (
+                (SELECT au.id, t.depth FROM actor.org_unit_ancestors($1) AS au JOIN actor.org_unit_type t ON (au.ou_type = t.id))
+                    UNION
+                (SELECT au.id, t.depth FROM actor.org_unit_descendants($1) AS au JOIN actor.org_unit_type t ON (au.ou_type = t.id))
+            ) AS ad ON (aou.id=ad.id)
+      ORDER BY ad.depth;
 $$ LANGUAGE SQL STABLE ROWS 1;
 
 CREATE OR REPLACE FUNCTION actor.org_unit_full_path ( INT, INT ) RETURNS SETOF actor.org_unit AS $$
diff --git a/Open-ILS/src/sql/Pg/upgrade/XXXX.function.restore_full_path_order.sql b/Open-ILS/src/sql/Pg/upgrade/XXXX.function.restore_full_path_order.sql
new file mode 100644 (file)
index 0000000..6eb4cc3
--- /dev/null
@@ -0,0 +1,17 @@
+BEGIN;
+
+SELECT evergreen.upgrade_deps_block_check('XXXX', :eg_version);
+
+CREATE OR REPLACE FUNCTION actor.org_unit_full_path ( INT ) RETURNS SETOF actor.org_unit AS $$
+    SELECT  aou.*
+      FROM  actor.org_unit AS aou
+            JOIN (
+                (SELECT au.id, t.depth FROM actor.org_unit_ancestors($1) AS au JOIN actor.org_unit_type t ON (au.ou_type = t.id))
+                    UNION
+                (SELECT au.id, t.depth FROM actor.org_unit_descendants($1) AS au JOIN actor.org_unit_type t ON (au.ou_type = t.id))
+            ) AS ad ON (aou.id=ad.id)
+      ORDER BY ad.depth;
+$$ LANGUAGE SQL STABLE;
+
+COMMIT;
+