Skip to content

A platform for community discussion. Free, open, simple.

PERF: Keep admin report UI out of the initial bundle (#44771)

Renato Atilio2ab87d85ce39
diff --git a/frontend/discourse/admin/lib/admin-dashboard-report-renderers.js b/frontend/discourse/admin/lib/admin-dashboard-report-renderers.js
index 6076a4cb1ae..f310149559b 100644
--- a/frontend/discourse/admin/lib/admin-dashboard-report-renderers.js
+++ b/frontend/discourse/admin/lib/admin-dashboard-report-renderers.js
@@ -1,18 +1,11 @@
import CoreReportCard from "discourse/admin/components/dashboard/report-cards/core-report";
-
-const renderers = new Map();
-
-export function registerAdminDashboardReportRenderer(source, ComponentClass) {
- renderers.set(source, ComponentClass);
-}
+import { applyValueTransformer } from "discourse/lib/transformer";
export function lookupAdminDashboardReportRenderer(source) {
if (source === "core_report") {
return CoreReportCard;
}
- return renderers.get(source);
-}
-
-export function resetAdminDashboardReportRenderers() {
- renderers.clear();
+ return applyValueTransformer("admin-dashboard-report-renderer", undefined, {
+ source,
+ });
}
diff --git a/frontend/discourse/app/lib/plugin-api.gjs b/frontend/discourse/app/lib/plugin-api.gjs
index 50245ba5f55..c12be4715c0 100644
--- a/frontend/discourse/app/lib/plugin-api.gjs
+++ b/frontend/discourse/app/lib/plugin-api.gjs
@@ -1,6 +1,5 @@
/* eslint-disable ember/no-jquery */
import $ from "jquery";
-import { registerAdminDashboardReportRenderer } from "discourse/admin/lib/admin-dashboard-report-renderers";
import { registerAdminDashboardSection } from "discourse/admin/lib/admin-dashboard-sections";
import { registerAdminReportRelatedItemsRenderer } from "discourse/admin/lib/admin-report-related-items";
import { _renderBlocks } from "discourse/blocks/block-outlet";
@@ -3246,7 +3245,11 @@ class _PluginApi {
* @param {Component} componentClass - A Glimmer component that accepts @item, @payload, @filters.
*/
registerAdminDashboardReportRenderer(source, componentClass) {
- registerAdminDashboardReportRenderer(source, componentClass);
+ this.registerValueTransformer(
+ "admin-dashboard-report-renderer",
+ ({ value, context }) =>
+ context.source === source ? componentClass : value
+ );
}
/**
diff --git a/frontend/discourse/app/lib/registry/transformers.js b/frontend/discourse/app/lib/registry/transformers.js
index dd5a2b63a31..66b5745eed1 100644
--- a/frontend/discourse/app/lib/registry/transformers.js
+++ b/frontend/discourse/app/lib/registry/transformers.js
@@ -44,6 +44,7 @@ export const BEHAVIOR_TRANSFORMERS = Object.freeze([
*/
// eslint-discourse keep-array-sorted
export const VALUE_TRANSFORMERS = Object.freeze([
+ "admin-dashboard-report-renderer",
"admin-onboarding-start-posting-options",
"admin-plugin-icon",
"admin-reports-show-query-params",
diff --git a/frontend/discourse/tests/helpers/qunit-helpers.js b/frontend/discourse/tests/helpers/qunit-helpers.js
index c8fb514b2ff..7fb96674d7c 100644
--- a/frontend/discourse/tests/helpers/qunit-helpers.js
+++ b/frontend/discourse/tests/helpers/qunit-helpers.js
@@ -14,7 +14,6 @@ import $ from "jquery";
import { resetCache as resetOneboxCache } from "pretty-text/oneboxer";
import QUnit, { module, test } from "qunit";
import sinon from "sinon";
-import { resetAdminDashboardReportRenderers } from "discourse/admin/lib/admin-dashboard-report-renderers";
import { resetAdminDashboardSections } from "discourse/admin/lib/admin-dashboard-sections";
import { resetAdminReportRelatedItemsRenderers } from "discourse/admin/lib/admin-report-related-items";
import { _resetOutletLayoutsForTesting } from "discourse/blocks/block-outlet";
@@ -223,7 +222,6 @@ export function testCleanup(container, app) {
resetMobile();
noteKeyboardEvidence();
resetAdditionalReportModes();
- resetAdminDashboardReportRenderers();
resetAdminReportRelatedItemsRenderers();
resetAdminDashboardSections();
resetDeferredClassModifications();
diff --git a/frontend/discourse/tests/integration/components/dashboard/reports-test.gjs b/frontend/discourse/tests/integration/components/dashboard/reports-test.gjs
index 3c8ba64870d..37fa7555ef2 100644
--- a/frontend/discourse/tests/integration/components/dashboard/reports-test.gjs
+++ b/frontend/discourse/tests/integration/components/dashboard/reports-test.gjs
@@ -10,7 +10,7 @@ import {
} from "@ember/test-helpers";
import { module, test } from "qunit";
import DashboardReports from "discourse/admin/components/dashboard/reports";
-import { registerAdminDashboardReportRenderer } from "discourse/admin/lib/admin-dashboard-report-renderers";
+import { withPluginApi } from "discourse/lib/plugin-api";
import { setupRenderingTest } from "discourse/tests/helpers/component-test";
import pretender, { response } from "discourse/tests/helpers/create-pretender";
import {
@@ -27,6 +27,12 @@ const FakeReportRenderer = <template>
<div class="fake-report-renderer">{{@payload.type}}</div>
</template>;
+function registerFakeReportRenderer() {
+ withPluginApi((api) =>
+ api.registerAdminDashboardReportRenderer("test_source", FakeReportRenderer)
+ );
+}
+
const ITEMS = [
{
source: "test_source",
@@ -106,7 +112,7 @@ module("Integration | Component | DashboardReports", function (hooks) {
});
test("shows a per-card loading spinner, then each card's own success, empty, or error state once the bulk fetch resolves", async function (assert) {
- registerAdminDashboardReportRenderer("test_source", FakeReportRenderer);
+ registerFakeReportRenderer();
const { resolve } = deferredBulkFetch();
@@ -178,7 +184,7 @@ module("Integration | Component | DashboardReports", function (hooks) {
});
test("shows a loading spinner immediately when the date range changes, instead of the stale chart", async function (assert) {
- registerAdminDashboardReportRenderer("test_source", FakeReportRenderer);
+ registerFakeReportRenderer();
let resolveSecondFetch;
let fetchCount = 0;
@@ -248,7 +254,7 @@ module("Integration | Component | DashboardReports", function (hooks) {
});
test("does not render resize handles for a non-admin viewer", async function (assert) {
- registerAdminDashboardReportRenderer("test_source", FakeReportRenderer);
+ registerFakeReportRenderer();
pretender.post("/admin/dashboard/reports/bulk", () =>
response({
@@ -279,7 +285,7 @@ module("Integration | Component | DashboardReports", function (hooks) {
});
test("toggles a card's width via a plain click on its resize handle and persists it through the layout endpoint", async function (assert) {
- registerAdminDashboardReportRenderer("test_source", FakeReportRenderer);
+ registerFakeReportRenderer();
pretender.post("/admin/dashboard/reports/bulk", () =>
response({
@@ -335,7 +341,7 @@ module("Integration | Component | DashboardReports", function (hooks) {
});
test("applies a resize locally without re-fetching the dashboard or any report's chart data", async function (assert) {
- registerAdminDashboardReportRenderer("test_source", FakeReportRenderer);
+ registerFakeReportRenderer();
let bulkFetchCount = 0;
pretender.post("/admin/dashboard/reports/bulk", () => {
@@ -409,7 +415,7 @@ module("Integration | Component | DashboardReports", function (hooks) {
});
test("persists an earlier resize when a different card is resized afterward", async function (assert) {
- registerAdminDashboardReportRenderer("test_source", FakeReportRenderer);
+ registerFakeReportRenderer();
pretender.post("/admin/dashboard/reports/bulk", () =>
response({
@@ -491,7 +497,7 @@ module("Integration | Component | DashboardReports", function (hooks) {
});
test("grows the card live row by row as a drag crosses each row boundary, reflowing its sibling, then persists on release", async function (assert) {
- registerAdminDashboardReportRenderer("test_source", FakeReportRenderer);
+ registerFakeReportRenderer();
pretender.post("/admin/dashboard/reports/bulk", () =>
response({
@@ -638,7 +644,7 @@ module("Integration | Component | DashboardReports", function (hooks) {
});
test("commits a card to spanning both columns while staying a single row when dragged mostly horizontally", async function (assert) {
- registerAdminDashboardReportRenderer("test_source", FakeReportRenderer);
+ registerFakeReportRenderer();
pretender.post("/admin/dashboard/reports/bulk", () =>
response({
@@ -757,7 +763,7 @@ module("Integration | Component | DashboardReports", function (hooks) {
});
test("renders both bottom corners on a wide card, and each shrinks it while keeping the opposite edge fixed", async function (assert) {
- registerAdminDashboardReportRenderer("test_source", FakeReportRenderer);
+ registerFakeReportRenderer();
pretender.post("/admin/dashboard/reports/bulk", () =>
response({
@@ -893,7 +899,7 @@ module("Integration | Component | DashboardReports", function (hooks) {
});
test("clamps the live row count at the maximum during an extreme drag", async function (assert) {
- registerAdminDashboardReportRenderer("test_source", FakeReportRenderer);
+ registerFakeReportRenderer();
pretender.post("/admin/dashboard/reports/bulk", () =>
response({