feat: Filter admin panel teams by A4 status (#4440)

DafyddLlyr · web-flow · commit f1e2c5867e37 · 2025-03-10T08:24:04.000Z
diff --git a/api.planx.uk/modules/gis/routes.ts b/api.planx.uk/modules/gis/routes.ts
@@ -1,12 +1,10 @@
 import { Router } from "express";
 import { locationSearch } from "./service/index.js";
-import { hasArticle4Schema } from "./service/article4Schema.js";
 import { classifiedRoadsSearch } from "./service/classifiedRoads.js";
 
 const router = Router();
 
 router.get("/gis/:localAuthority", locationSearch);
-router.get("/gis/:localAuthority/article4-schema", hasArticle4Schema);
 router.get("/roads", classifiedRoadsSearch);
 
 export default router;
diff --git a/api.planx.uk/modules/gis/service/article4Schema.ts b/api.planx.uk/modules/gis/service/article4Schema.ts
diff --git a/api.planx.uk/modules/gis/service/digitalLand.ts b/api.planx.uk/modules/gis/service/digitalLand.ts
@@ -36,7 +36,10 @@ export interface LocalAuthorityMetadata {
   };
 }
 
-/** When a team publishes their granular Article 4 data, add them to this list. Key must match team slug */
+/**
+ * When a team publishes their granular Article 4 data, add them to this list. Key must match team slug
+ * The database column team_setting.has_article4_schema also needs to be updated via the Hasura console
+ */
 export const localAuthorityMetadata: Record<string, LocalAuthorityMetadata> = {
   "barking-and-dagenham": barkingAndDagenham,
   barnet,
diff --git a/doc/how-to/how-to-setup-planning-constraints-for-a-team.md b/doc/how-to/how-to-setup-planning-constraints-for-a-team.md
@@ -47,6 +47,8 @@ The dictionary of `records` should have one key/value pair per each unique granu
 The council should map their GIS identifiers themselves in the spreadsheet, but often this is partially complete or missing and simpler to quickly match against planning.data.gov.uk search results ourselves than start a communication back and forth (it's often not the same council person who knows the Article 4 rules as who understands the spatial data structure).
 
 5. **Planx** - Add an entry for this council to the `localAuthorityMetadata` variable defined at the top of `api.planx.uk/modules/gis/service/digitalLand.ts`
+   
+6. **Planx** - Toggle the database column `team_settings.has_article4_schema` to be `true` via the Hasura console. This is used by the admin panel view for platform admins.
 
 Confirm that granular A4 variables are now being returned by the /gis endpoint and written to the passport when navigating a flow.
 
diff --git a/editor.planx.uk/src/pages/PlatformAdminPanel/PlatformAdminPanel.tsx b/editor.planx.uk/src/pages/PlatformAdminPanel/PlatformAdminPanel.tsx
@@ -11,7 +11,6 @@ import {
   False as NotConfigured,
   True as Configured,
 } from "../../ui/shared/DataTable/components/cellIcons";
-import { Article4Status } from "./components/Article4Status";
 import { getFlowNamesForFilter } from "./getFlowNamesForFilter";
 
 const isCouncilTeam = () => {
@@ -63,11 +62,8 @@ export const PlatformAdminPanel = () => {
     },
     {
       field: "article4sEnabled",
-      headerName: "Article 4s (API)",
+      headerName: "Article 4s",
       type: ColumnFilterType.BOOLEAN,
-      customComponent: (params) => {
-        return <Article4Status teamSlug={params.row.slug} />;
-      },
     },
     {
       field: "govpayEnabled",
diff --git a/editor.planx.uk/src/pages/PlatformAdminPanel/components/Article4Status.tsx b/editor.planx.uk/src/pages/PlatformAdminPanel/components/Article4Status.tsx
diff --git a/editor.planx.uk/src/types.ts b/editor.planx.uk/src/types.ts
@@ -105,7 +105,7 @@ export interface AdminPanelData {
   homepage?: string;
   subdomain?: string;
   planningDataEnabled: boolean;
-  article4sEnabled: string;
+  article4sEnabled: boolean;
   govnotifyPersonalisation?: TeamContactSettings;
   govpayEnabled: boolean;
   powerAutomateEnabled: boolean;
diff --git a/editor.planx.uk/src/ui/shared/DataTable/mockTeams.tsx b/editor.planx.uk/src/ui/shared/DataTable/mockTeams.tsx
@@ -20,7 +20,7 @@ export const mockTeams: AdminPanelData[] = [
     actionColour: "#000000",
     homepage: undefined,
     subdomain: undefined,
-    article4sEnabled: "@todo",
+    article4sEnabled: true,
     govnotifyPersonalisation: {
       helpEmail: "example@council.co.uk",
       helpPhone: "(01234) 567890",
@@ -46,7 +46,7 @@ export const mockTeams: AdminPanelData[] = [
     govpayEnabled: true,
     logo: "https://path.to.logo.com/theopensystemslab/planx-team-logos/main/logo.svg",
     slug: "doncaster",
-    article4sEnabled: "@todo",
+    article4sEnabled: false,
     powerAutomateEnabled: false,
   },
   {
@@ -66,7 +66,7 @@ export const mockTeams: AdminPanelData[] = [
     govpayEnabled: false,
     logo: "https://path.to.logo.com/theopensystemslab/planx-team-logos/main/logo.svg",
     slug: "newcastle",
-    article4sEnabled: "@todo",
+    article4sEnabled: true,
     powerAutomateEnabled: true,
   },
   {
@@ -83,7 +83,7 @@ export const mockTeams: AdminPanelData[] = [
     govpayEnabled: true,
     logo: "https://path.to.logo.com/theopensystemslab/planx-team-logos/main/logo.svg",
     slug: "tewkesbury",
-    article4sEnabled: "@todo",
+    article4sEnabled: false,
     powerAutomateEnabled: false,
   },
 ];
diff --git a/hasura.planx.uk/metadata/tables.yaml b/hasura.planx.uk/metadata/tables.yaml
@@ -2441,6 +2441,7 @@
           - email_reply_to_id
           - external_planning_site_name
           - external_planning_site_url
+          - has_article4_schema
           - help_email
           - help_opening_hours
           - help_phone
@@ -2459,6 +2460,7 @@
           - email_reply_to_id
           - external_planning_site_name
           - external_planning_site_url
+          - has_article4_schema
           - help_email
           - help_opening_hours
           - help_phone
@@ -2472,19 +2474,20 @@
     - role: demoUser
       permission:
         columns:
-          - id
+          - boundary_bbox
+          - boundary_url
+          - email_reply_to_id
           - external_planning_site_name
           - external_planning_site_url
-          - homepage
+          - has_article4_schema
           - help_email
           - help_opening_hours
           - help_phone
-          - email_reply_to_id
-          - team_id
-          - boundary_bbox
-          - submission_email
+          - homepage
+          - id
           - reference_code
-          - boundary_url
+          - submission_email
+          - team_id
         filter: {}
       comment: ""
     - role: platformAdmin
@@ -2495,6 +2498,7 @@
           - email_reply_to_id
           - external_planning_site_name
           - external_planning_site_url
+          - has_article4_schema
           - help_email
           - help_opening_hours
           - help_phone
@@ -2513,6 +2517,7 @@
           - email_reply_to_id
           - external_planning_site_name
           - external_planning_site_url
+          - has_article4_schema
           - help_email
           - help_opening_hours
           - help_phone
@@ -2530,6 +2535,7 @@
           - email_reply_to_id
           - external_planning_site_name
           - external_planning_site_url
+          - has_article4_schema
           - help_email
           - help_opening_hours
           - help_phone
@@ -2544,19 +2550,20 @@
     - role: platformAdmin
       permission:
         columns:
-          - id
+          - boundary_bbox
+          - boundary_url
+          - email_reply_to_id
           - external_planning_site_name
           - external_planning_site_url
-          - homepage
+          - has_article4_schema
           - help_email
           - help_opening_hours
           - help_phone
-          - email_reply_to_id
-          - team_id
-          - boundary_bbox
-          - submission_email
+          - homepage
+          - id
           - reference_code
-          - boundary_url
+          - submission_email
+          - team_id
         filter: {}
         check: null
       comment: ""
diff --git a/hasura.planx.uk/migrations/1741268731310_alter_table_public_team_settings_add_column_has_article4_schema/down.sql b/hasura.planx.uk/migrations/1741268731310_alter_table_public_team_settings_add_column_has_article4_schema/down.sql
@@ -0,0 +1,106 @@
+ALTER TABLE "public"."team_settings" DROP COLUMN "has_article4_schema";
+
+-- Recreate view from hasura.planx.uk/migrations/1738843003829_run_sql_migration/up.sql
+CREATE
+OR REPLACE VIEW "public"."teams_summary" AS
+SELECT
+    t.id,
+    t.name,
+    t.slug,
+    ts.reference_code,
+    ts.homepage,
+    t.domain AS subdomain,
+    ti.has_planning_data AS planning_data_enabled,
+    '@todo' :: text AS article_4s_enabled,
+    jsonb_build_object(
+        'helpEmail',
+        ts.help_email,
+        'helpPhone',
+        ts.help_phone,
+        'emailReplyToId',
+        ts.email_reply_to_id,
+        'helpOpeningHours',
+        ts.help_opening_hours
+    ) AS govnotify_personalisation,
+    CASE
+        WHEN (
+            COALESCE(
+                ti.production_govpay_secret,
+                ti.staging_govpay_secret
+            ) IS NOT NULL
+        ) THEN true
+        ELSE false
+    END AS govpay_enabled,
+    ts.submission_email AS send_to_email_address,
+    COALESCE(
+        ti.production_bops_submission_url,
+        ti.staging_bops_submission_url
+    ) AS bops_submission_url,
+    tt.logo,
+    tt.favicon,
+    tt.primary_colour,
+    tt.link_colour,
+    tt.action_colour,
+    CASE
+        WHEN (
+            (
+                COALESCE(
+                    ti.production_file_api_key,
+                    ti.staging_file_api_key
+                ) IS NOT NULL
+            )
+            AND (
+                COALESCE(
+                    ti.production_power_automate_api_key,
+                    ti.staging_power_automate_api_key
+                ) IS NOT NULL
+            )
+            AND (ti.power_automate_webhook_url IS NOT NULL)
+        ) THEN true
+        ELSE false
+    END AS power_automate_enabled,
+    ARRAY_AGG(f.name) FILTER (
+        WHERE
+            f.status = 'online'
+    ) AS live_flows
+FROM
+    (
+        (
+            (
+                teams t
+                JOIN team_integrations ti ON ((ti.team_id = t.id))
+            )
+            JOIN team_themes tt ON ((tt.team_id = t.id))
+        )
+        JOIN team_settings ts ON ((ts.team_id = t.id))
+    )
+    JOIN flows f ON ((f.team_id = t.id))
+GROUP BY
+    t.id,
+    t.name,
+    t.slug,
+    ts.reference_code,
+    ts.homepage,
+    ts.help_email,
+    ts.help_phone,
+    ts.email_reply_to_id,
+    ts.help_opening_hours,
+    ts.submission_email,
+    ts.has_article4_schema,
+    ti.has_planning_data,
+    ti.production_govpay_secret,
+    ti.staging_govpay_secret,
+    ti.production_bops_submission_url,
+    ti.staging_bops_submission_url,
+    ti.production_file_api_key,
+    ti.staging_file_api_key,
+    ti.power_automate_webhook_url,
+    ti.production_power_automate_api_key,
+    ti.staging_power_automate_api_key,
+    tt.logo,
+    tt.favicon,
+    tt.primary_colour,
+    tt.link_colour,
+    tt.action_colour
+ORDER BY
+    t.name;
diff --git a/hasura.planx.uk/migrations/1741268731310_alter_table_public_team_settings_add_column_has_article4_schema/up.sql b/hasura.planx.uk/migrations/1741268731310_alter_table_public_team_settings_add_column_has_article4_schema/up.sql
