Skip to content

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

FEATURE: Show upcoming changes in admin search (#38893)

Martin Brennan5420b2c0bbba
diff --git a/app/controllers/admin/search_controller.rb b/app/controllers/admin/search_controller.rb
index 4157b86b12e..6c258a2e3fe 100644
--- a/app/controllers/admin/search_controller.rb
+++ b/app/controllers/admin/search_controller.rb
@@ -20,6 +20,13 @@ class Admin::SearchController < Admin::AdminController
themes_and_components:
serialize_data(Theme.include_relations.order(:name), BasicThemeSerializer),
reports: Reports::ListQuery.call(admin: current_user.admin?),
+ upcoming_changes:
+ UpcomingChanges::List.call(
+ guardian: current_user.guardian,
+ options: {
+ filter_statuses: %w[experimental alpha beta stable],
+ },
+ ).upcoming_changes,
)
end
diff --git a/frontend/discourse/admin/lib/constants.js b/frontend/discourse/admin/lib/constants.js
index 2706d376e54..5d0620382bf 100644
--- a/frontend/discourse/admin/lib/constants.js
+++ b/frontend/discourse/admin/lib/constants.js
@@ -7,6 +7,7 @@ export const ADMIN_SEARCH_RESULT_TYPES = [
"theme",
"component",
"report",
+ "upcomingChange",
];
export const SITE_SETTING_REQUIRES_CONFIRMATION_TYPES = {
diff --git a/frontend/discourse/admin/services/admin-search-data-source.js b/frontend/discourse/admin/services/admin-search-data-source.js
index 99d76736248..c573fb0ca05 100644
--- a/frontend/discourse/admin/services/admin-search-data-source.js
+++ b/frontend/discourse/admin/services/admin-search-data-source.js
@@ -205,6 +205,31 @@ export class SettingLinkFormatter {
}
}
+export class UpcomingChangeLinkFormatter {
+ /**
+ * @param {Object} upcomingChange - The upcoming change object from the upcoming changes API
+ */
+ constructor(upcomingChange) {
+ this.upcomingChange = upcomingChange;
+ }
+
+ format() {
+ return {
+ label: this.upcomingChange.humanized_name,
+ description: this.upcomingChange.description,
+ url: getURL(
+ `/admin/config/upcoming-changes?changeNamesFilter=${this.upcomingChange.setting}`
+ ),
+ keywords: buildKeywords(
+ this.upcomingChange.humanized_name,
+ this.upcomingChange.setting
+ ),
+ type: "upcoming_change",
+ icon: "flask",
+ };
+ }
+}
+
export default class AdminSearchDataSource extends Service {
@service router;
@service adminNavManager;
@@ -215,6 +240,7 @@ export default class AdminSearchDataSource extends Service {
themeDataSourceItems = [];
componentDataSourceItems = [];
reportDataSourceItems = [];
+ upcomingChangeDataSourceItems = [];
settingPageMap = {
categories: {},
areas: {},
@@ -242,6 +268,7 @@ export default class AdminSearchDataSource extends Service {
this.#processSettings(allItems.settings);
this.#processThemesAndComponents(allItems.themes_and_components);
this.#processReports(allItems.reports);
+ this.#processUpcomingChanges(allItems.upcoming_changes);
this._mapCached = true;
}
@@ -439,4 +466,14 @@ export default class AdminSearchDataSource extends Service {
});
});
}
+
+ #processUpcomingChanges(upcomingChanges) {
+ upcomingChanges.forEach((upcomingChange) => {
+ const formattedUpcomingChangeLink = new UpcomingChangeLinkFormatter(
+ upcomingChange
+ ).format();
+
+ this.upcomingChangeDataSourceItems.push(formattedUpcomingChangeLink);
+ });
+ }
}
diff --git a/frontend/discourse/tests/fixtures/admin-search-fixtures.js b/frontend/discourse/tests/fixtures/admin-search-fixtures.js
index dc283062564..e004e558b06 100644
--- a/frontend/discourse/tests/fixtures/admin-search-fixtures.js
+++ b/frontend/discourse/tests/fixtures/admin-search-fixtures.js
@@ -64,6 +64,21 @@ const adminSearchFixtures = {
description_link: null,
},
],
+ upcoming_changes: [
+ {
+ setting: "enable_upload_debug_mode",
+ humanized_name: "Enable upload debug mode",
+ description: "This enables the amazing upload debug mode",
+ upcoming_change: {
+ enabled_for: "staff",
+ impact: "feature,all_members",
+ impact_role: "all_members",
+ impact_type: "feature",
+ learn_more_url: "https://meta.discourse.org/t/-/395100",
+ status: "alpha"
+ }
+ }
+ ]
},
};
diff --git a/frontend/discourse/tests/unit/services/admin-search-data-source-test.js b/frontend/discourse/tests/unit/services/admin-search-data-source-test.js
index 6fbe35d26e6..fe0b92e29c8 100644
--- a/frontend/discourse/tests/unit/services/admin-search-data-source-test.js
+++ b/frontend/discourse/tests/unit/services/admin-search-data-source-test.js
@@ -5,6 +5,7 @@ import sinon from "sinon";
import {
PageLinkFormatter,
SettingLinkFormatter,
+ UpcomingChangeLinkFormatter,
} from "discourse/admin/services/admin-search-data-source";
import PreloadStore from "discourse/lib/preload-store";
import {
@@ -226,6 +227,7 @@ module("Unit | Service | AdminSearchDataSource", function (hooks) {
this.subject.componentDataSourceItems = [];
this.subject.reportDataSourceItems = [];
this.subject.themeDataSourceItems = [];
+ this.subject.upcomingChangeDataSourceItems = [];
this.subject.pageDataSourceItems = [
{
description: "first page",
@@ -513,3 +515,32 @@ module(
});
}
);
+
+module(
+ "Unit | Service | AdminSearchDataSource | UpcomingChangeLinkFormatter",
+ function () {
+ test("format returns correct label, description, url, keywords, type, and icon", function (assert) {
+ const upcomingChange = {
+ humanized_name: "New upload limits",
+ description: "Upload limits are changing to improve security",
+ setting: "max_upload_size",
+ };
+
+ const result = new UpcomingChangeLinkFormatter(upcomingChange).format();
+
+ assert.strictEqual(result.label, "New upload limits");
+ assert.strictEqual(
+ result.description,
+ "Upload limits are changing to improve security"
+ );
+ assert.strictEqual(
+ result.url,
+ "/admin/config/upcoming-changes?changeNamesFilter=max_upload_size"
+ );
+ assert.strictEqual(result.type, "upcoming_change");
+ assert.strictEqual(result.icon, "flask");
+ assert.true(result.keywords.includes("new upload limits"));
+ assert.true(result.keywords.includes("max_upload_size"));
+ });
+ }
+);