@multiplatform.one/backoffice 7.28.1 → 7.29.0

package/src/report/QueryReportScreen.spec.tsx

@@ -5,7 +5,7 @@
 import { renderWithProviders } from "@multiplatform.one/test-utils";
 import { fireEvent, screen, waitFor } from "@testing-library/react";
 import React from "react";
-import { describe, expect, it } from "vitest";
+import { afterEach, describe, expect, it, vi } from "vitest";
 import { BackofficeProvider } from "../config/BackofficeProvider";
 import { createMemoryNavigator } from "../navigation/navigator";
 import { QueryReportScreen } from "./QueryReportScreen";
@@ -72,3 +72,77 @@ describe("QueryReportScreen filter URL round-trip", () => {
     expect(screen.getByRole("button", { name: /export csv/i })).toBeTruthy();
   });
 });
+
+// LC-96: a report the session may not run is a permission state, not an error
+// whose retry cannot succeed. The bench refuses the Report doc, its script and
+// the run the way Frappe refuses a user without the report's role.
+describe("QueryReportScreen refused run", () => {
+  afterEach(() => {
+    vi.unstubAllGlobals();
+  });
+
+  function stubRefusingBench(message = "You don't have access to Report: Team Workload") {
+    vi.stubGlobal(
+      "fetch",
+      async () =>
+        new Response(
+          JSON.stringify({
+            exc_type: "PermissionError",
+            _server_messages: JSON.stringify([JSON.stringify({ message })]),
+          }),
+          { status: 403, headers: { "content-type": "application/json" } },
+        ),
+    );
+  }
+
+  let run = 0;
+  function renderRefused() {
+    run += 1;
+    const navigation = createMemoryNavigator("/backoffice/query-report/Team%20Workload");
+    return renderWithProviders(
+      <BackofficeProvider
+        frappe={{ baseURL: `https://backoffice-query-report-refused-${run}.mock.test` }}
+        navigation={navigation}
+      >
+        <QueryReportScreen reportName="Team Workload" />
+      </BackofficeProvider>,
+    );
+  }
+
+  it("says the reader can't run the report, with the server's reason and no retry", async () => {
+    stubRefusingBench();
+    renderRefused();
+
+    const state = await screen.findByTestId("frappe-report-not-permitted", {}, { timeout: 8000 });
+    expect(state.textContent).toContain(`You can't run "Team Workload"`);
+    expect(state.textContent).toContain("You don't have access to Report: Team Workload");
+    expect(screen.queryByRole("button", { name: /retry|refresh/i })).toBeNull();
+  });
+
+  // MPO-473: a refused run has nothing to export, and never will.
+  it("offers no Export CSV", async () => {
+    stubRefusingBench();
+    renderRefused();
+
+    await screen.findByTestId("frappe-report-not-permitted", {}, { timeout: 8000 });
+    expect(screen.queryByRole("button", { name: /export csv/i })).toBeNull();
+    expect(screen.queryByText("Export CSV")).toBeNull();
+  });
+
+  // Verbatim from pokemon's bench signed out: is_whitelisted refuses Guest with
+  // one message, a <details> summary and body, which rendered glued as
+  // "Login to accessFunction frappe.desk.query_report.run …".
+  it("renders each line of the server's reason on its own", async () => {
+    stubRefusingBench(
+      "<details><summary>You are not permitted to access this resource. Login to access</summary>Function <strong>frappe.desk.query_report.run</strong> is not whitelisted.</details>",
+    );
+    renderRefused();
+
+    const state = await screen.findByTestId("frappe-report-not-permitted", {}, { timeout: 8000 });
+    const lines = Array.from(state.querySelectorAll("p")).map((node) => node.textContent);
+    expect(lines).toEqual([
+      "You are not permitted to access this resource. Login to access",
+      "Function frappe.desk.query_report.run is not whitelisted.",
+    ]);
+  });
+});

package/src/report/QueryReportScreen.tsx

@@ -31,22 +31,23 @@ import {
   useBackofficeNavigator,
   useBackofficePaths,
 } from "../config/BackofficeProvider";
+import {
+  buildQueryReportColumns,
+  buildQueryReportCsv,
+  defaultFilterValues,
+  isEmptyFilterValue,
+  scrubFieldname,
+  stripReportHtml as stripHtml,
+  useQueryReport,
+  type QueryReportFilters,
+  type QueryReportFixture,
+} from "@multiplatform.one/frappe-ui";
 import { BACKOFFICE_I18N_NAMESPACE } from "../i18n";
-import { buildQueryReportColumns, buildQueryReportCsv } from "./queryReportColumns";
 import { QueryReportFilterBar, queryReportFilterLabel } from "./queryReportFilterBar";
 import {
   parseQueryReportFiltersParam,
   serializeQueryReportFiltersParam,
 } from "./queryReportUrlState";
-import {
-  defaultFilterValues,
-  isEmptyFilterValue,
-  type QueryReportFilters,
-  type QueryReportFixture,
-  scrubFieldname,
-  stripHtml,
-  useQueryReport,
-} from "./useQueryReport";
 
 export interface QueryReportScreenProps {
   /** Report document name (proper-cased, e.g. "Permitted Documents For User"). */
@@ -217,6 +218,17 @@ export function QueryReportScreen({
         )}
       />
     );
+  } else if (report.error && report.refused) {
+    body = (
+      <EmptyState
+        testID="frappe-report-not-permitted"
+        title={t("queryReport.notPermitted", {
+          defaultValue: 'You can\'t run "{{report}}"',
+          report: title,
+        })}
+        description={report.error.message}
+      />
+    );
   } else if (report.error) {
     body = (
       <YStack flex={1} gap="$2">
@@ -303,18 +315,22 @@ export function QueryReportScreen({
         actions={
           <XStack gap="$2" alignItems="center">
             {report.running && !report.loading ? <Spinner size="small" /> : null}
-            <Button size="$2" chromeless onPress={report.reload} disabled={report.loading}>
-              {t("queryReport.refresh", "Refresh")}
-            </Button>
-            <Button
-              size="$2"
-              chromeless
-              icon={DownloadSimpleIcon}
-              onPress={handleExport}
-              disabled={report.loading || report.rows.length === 0}
-            >
-              {t("queryReport.exportCsv", "Export CSV")}
-            </Button>
+            {report.refused ? null : (
+              <>
+                <Button size="$2" chromeless onPress={report.reload} disabled={report.loading}>
+                  {t("queryReport.refresh", "Refresh")}
+                </Button>
+                <Button
+                  size="$2"
+                  chromeless
+                  icon={DownloadSimpleIcon}
+                  onPress={handleExport}
+                  disabled={report.loading || report.rows.length === 0}
+                >
+                  {t("queryReport.exportCsv", "Export CSV")}
+                </Button>
+              </>
+            )}
           </XStack>
         }
       />

package/src/report/queryReportColumns.tsx

@@ -1,123 +1,4 @@
-// Query-report column meta → DataTable columns with fieldtype-aware cells:
-// numerics right-aligned, Date/Datetime trimmed like desk lists, Link cells
-// navigable to the target doc form, HTML values (desk anchor markup)
-// flattened to text.
-import React from "react";
-import { Text } from "@multiplatform.one/components";
-import type { DataTableColumn } from "@multiplatform.one/table";
-import { formatDateCell } from "@multiplatform.one/frappe-ui";
-import { type QueryReportColumn, type QueryReportRow, stripHtml } from "./useQueryReport";
-
-const NUMERIC_FIELDTYPES = new Set(["Currency", "Float", "Int", "Percent", "Duration"]);
-
-export interface BuildQueryReportColumnsArgs {
-  columns: readonly QueryReportColumn[];
-  /** Open a Link cell's target document (doctype comes from column options). */
-  onOpenLink?: (doctype: string, name: string) => void;
-}
-
-function queryReportCell(
-  column: QueryReportColumn,
-  onOpenLink?: (doctype: string, name: string) => void,
-) {
-  return ({ getValue }: { getValue: () => unknown }) => {
-    const raw = getValue();
-    if (raw === null || raw === undefined || raw === "") {
-      return (
-        <Text fontSize="$3" color="$color8">
-          —
-        </Text>
-      );
-    }
-    if (column.fieldtype === "Check") {
-      return (
-        <Text fontSize="$3" color={raw ? "$green11" : "$color8"}>
-          {raw ? "✓" : "—"}
-        </Text>
-      );
-    }
-    const value = String(raw);
-    if (NUMERIC_FIELDTYPES.has(column.fieldtype)) {
-      return (
-        <Text fontSize="$3" color="$color12" textAlign="right">
-          {value}
-        </Text>
-      );
-    }
-    switch (column.fieldtype) {
-      case "Date":
-      case "Datetime":
-        return (
-          <Text fontSize="$3" color="$color11">
-            {formatDateCell(value)}
-          </Text>
-        );
-      case "Link": {
-        const doctype = column.options;
-        if (doctype && onOpenLink) {
-          return (
-            <Text
-              fontSize="$3"
-              color="$color11"
-              textDecorationLine="underline"
-              cursor="pointer"
-              numberOfLines={1}
-              role="link"
-              onPress={(event) => {
-                event?.stopPropagation?.();
-                onOpenLink(doctype, value);
-              }}
-            >
-              {value}
-            </Text>
-          );
-        }
-        return (
-          <Text fontSize="$3" color="$color11" numberOfLines={1}>
-            {value}
-          </Text>
-        );
-      }
-      default:
-        return (
-          <Text fontSize="$3" color="$color11" numberOfLines={1}>
-            {stripHtml(value)}
-          </Text>
-        );
-    }
-  };
-}
-
-/** Build DataTable columns for a query-report run result. */
-export function buildQueryReportColumns({
-  columns,
-  onOpenLink,
-}: BuildQueryReportColumnsArgs): DataTableColumn<QueryReportRow>[] {
-  return columns.map((column) => ({
-    id: column.fieldname,
-    header: column.label,
-    // accessorFn (not accessorKey): report fieldnames may contain path-y
-    // characters like "assigned_to/owner" that key-based access mangles.
-    accessorFn: (row: QueryReportRow) => row[column.fieldname],
-    ...(NUMERIC_FIELDTYPES.has(column.fieldtype) ? { align: "right" as const } : {}),
-    ...(column.width ? { width: column.width } : {}),
-    cell: queryReportCell(column, onOpenLink),
-  }));
-}
-
-function escapeCsvCell(value: unknown): string {
-  if (value === null || value === undefined) return "";
-  const text = stripHtml(String(value));
-  return /[",\n]/.test(text) ? `"${text.replace(/"/g, '""')}"` : text;
-}
-
-/** CSV over the full run result (Desk Export, not just the current page). */
-export function buildQueryReportCsv(
-  columns: readonly QueryReportColumn[],
-  rows: readonly QueryReportRow[],
-): string {
-  return [
-    columns.map((column) => escapeCsvCell(column.label)).join(","),
-    ...rows.map((row) => columns.map((column) => escapeCsvCell(row[column.fieldname])).join(",")),
-  ].join("\n");
-}
+// Query-report columns live in @multiplatform.one/frappe-ui (MPO-15, GL-28);
+// this path keeps handing out the same names.
+export { buildQueryReportColumns, buildQueryReportCsv } from "@multiplatform.one/frappe-ui";
+export type { BuildQueryReportColumnsArgs } from "@multiplatform.one/frappe-ui";

package/src/report/queryReportFilterBar.tsx

@@ -25,18 +25,16 @@ import { useCallback, useEffect, useRef, useState } from "react";
 import { useTranslation } from "react-i18next";
 import { BACKOFFICE_I18N_NAMESPACE } from "../i18n";
 import {
+  compactQueryReportFilters,
   Date as DateField,
   fieldKind,
   fieldLabelFor,
+  isEmptyFilterValue,
   Link as LinkField,
   selectOptionsFromField,
-} from "@multiplatform.one/frappe-ui";
-import {
-  compactQueryReportFilters,
-  isEmptyFilterValue,
   type QueryReportFilterMeta,
   type QueryReportFilters,
-} from "./reportShapes";
+} from "@multiplatform.one/frappe-ui";
 
 export function queryReportFilterLabel(filter: QueryReportFilterMeta): string {
   return filter.label || fieldLabelFor([], filter.fieldname);

package/src/report/queryReportUrlState.ts

@@ -12,7 +12,7 @@
  * `setParams` (history REPLACE, no remount) and adopts inbound param changes
  * (deep links, back/forward), so reload and shared links reproduce the run.
  */
-import { isEmptyFilterValue, type QueryReportFilters } from "./reportShapes";
+import { isEmptyFilterValue, type QueryReportFilters } from "@multiplatform.one/frappe-ui";
 
 /**
  * Parse the `?filters=` deep-link value. The router usually decodes the