github-mirror/discourse
github-mirror/discourse
2
0
Fork 0
mirror of https://github.com/discourse/discourse.git synced 2025-03-24 01:35:30 +08:00
Code Issues Actions1 Packages Projects Releases Wiki Activity

FEATURE: Initial admin sidebar navigation ()

Browse Source 
This is v0 of admin sidebar navigation, which moves
all of the top-level admin nav from the top of the page
into a sidebar. This is hidden behind a enable_admin_sidebar_navigation
site setting, and is opt-in for now.

This sidebar is dynamically shown whenever the user enters an
admin route in the UI, and is hidden and replaced with either
the:

* Main forum sidebar
* Chat sidebar

Depending on where they navigate to. For now, custom sections
are not supported in the admin sidebar.

This commit removes the experimental admin sidebar generation rake
task but keeps the experimental sidebar UI for now for further
testing; it just uses the real nav as the default now.
This commit is contained in:
Martin Brennan 2023-12-18 11:48:25 +10:00 committed by GitHub
parent 194c84b217
commit 6de00f89c2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
17 changed files with 252 additions and 367 deletions
app
assets/javascripts
admin/addon
components
admin-config-area-sidebar-experiment.js
controllers
admin.js
routes
admin-revamp.jsadmin.js
templates
admin.hbs
discourse/app
instance-initializers
admin-sidebar.js
lib/sidebar
admin-nav-map.js
user/community-section
admin-revamp-section-link.js
models
sidebar_url.rb
config
locales
client.en.ymlserver.en.yml
site_settings.yml
lib
svg_sprite.rb
tasks
javascript.rake
spec
models
sidebar_section_spec.rb
system
admin_revamp_sidebar_navigation_spec.rb
page_objects/components/navigation_menu
base.rb

1
app/assets/javascripts/admin/addon/components/admin-config-area-sidebar-experiment.js

@ -10,6 +10,7 @@ import { ADMIN_NAV_MAP } from "discourse/lib/sidebar/admin-nav-map";
import { resetPanelSections } from "discourse/lib/sidebar/custom-sections";
import { ADMIN_PANEL } from "discourse/services/sidebar-state";
// TODO (martin) (2024-02-01) Remove this experimental UI.
export default class AdminConfigAreaSidebarExperiment extends Component {
@service adminSidebarExperimentStateManager;
@service toasts;

3
app/assets/javascripts/admin/addon/controllers/admin.js

@ -1,4 +1,5 @@
import Controller from "@ember/controller";
import { readOnly } from "@ember/object/computed";
import { inject as service } from "@ember/service";
import { dasherize } from "@ember/string";
import discourseComputed from "discourse-common/utils/decorators";
@ -6,6 +7,8 @@ import discourseComputed from "discourse-common/utils/decorators";
export default class AdminController extends Controller {
@service router;
@readOnly("siteSettings.enable_admin_sidebar_navigation") showAdminSidebar;
@discourseComputed("siteSettings.enable_group_directory")
showGroups(enableGroupDirectory) {
return !enableGroupDirectory;

7
app/assets/javascripts/admin/addon/routes/admin-revamp.js

@ -14,12 +14,7 @@ export default class AdminRoute extends DiscourseRoute {
}
activate() {
if (
!this.siteSettings.userInAnyGroups(
"enable_experimental_admin_ui_groups",
this.currentUser
)
) {
if (!this.siteSettings.enable_admin_sidebar_navigation) {
return DiscourseURL.redirectTo("/admin");
}

18
app/assets/javascripts/admin/addon/routes/admin.js

@ -1,23 +1,35 @@
import { inject as service } from "@ember/service";
import DiscourseRoute from "discourse/routes/discourse";
import { MAIN_PANEL } from "discourse/services/sidebar-state";
import { ADMIN_PANEL, MAIN_PANEL } from "discourse/services/sidebar-state";
import I18n from "discourse-i18n";
export default class AdminRoute extends DiscourseRoute {
@service sidebarState;
@service siteSettings;
titleToken() {
return I18n.t("admin_title");
}
activate() {
if (this.siteSettings.enable_admin_sidebar_navigation) {
this.sidebarState.setPanel(ADMIN_PANEL);
this.sidebarState.setSeparatedMode();
this.sidebarState.hideSwitchPanelButtons();
}
this.controllerFor("application").setProperties({
showTop: false,
});
}
deactivate() {
deactivate(transition) {
this.controllerFor("application").set("showTop", true);
this.sidebarState.setPanel(MAIN_PANEL);
if (this.siteSettings.enable_admin_sidebar_navigation) {
if (!transition?.to.name.startsWith("admin")) {
this.sidebarState.setPanel(MAIN_PANEL);
}
}
}
}

63
app/assets/javascripts/admin/addon/templates/admin.hbs

@ -4,37 +4,40 @@
<div class="row">
<div class="full-width">
<div class="admin-main-nav">
<ul class="nav nav-pills">
<NavItem @route="admin.dashboard" @label="admin.dashboard.title" />
{{#if this.currentUser.admin}}
<NavItem
@route="adminSiteSettings"
@label="admin.site_settings.title"
/>
{{/if}}
<NavItem @route="adminUsers" @label="admin.users.title" />
{{#if this.showGroups}}
<NavItem @route="groups" @label="admin.groups.title" />
{{/if}}
{{#if this.showBadges}}
<NavItem @route="adminBadges" @label="admin.badges.title" />
{{/if}}
{{#if this.currentUser.admin}}
<NavItem @route="adminEmail" @label="admin.email.title" />
{{/if}}
<NavItem @route="adminLogs" @label="admin.logs.title" />
<NavItem @route="adminCustomize" @label="admin.customize.title" />
{{#if this.currentUser.admin}}
<NavItem @route="adminApi" @label="admin.api.title" />
{{#if this.siteSettings.enable_backups}}
<NavItem @route="admin.backups" @label="admin.backups.title" />
{{#unless this.showAdminSidebar}}
<div class="admin-main-nav">
<ul class="nav nav-pills">
<NavItem @route="admin.dashboard" @label="admin.dashboard.title" />
{{#if this.currentUser.admin}}
<NavItem
@route="adminSiteSettings"
@label="admin.site_settings.title"
/>
{{/if}}
<NavItem @route="adminPlugins" @label="admin.plugins.title" />
{{/if}}
<PluginOutlet @name="admin-menu" />
</ul>
</div>
<NavItem @route="adminUsers" @label="admin.users.title" />
{{#if this.showGroups}}
<NavItem @route="groups" @label="admin.groups.title" />
{{/if}}
{{#if this.showBadges}}
<NavItem @route="adminBadges" @label="admin.badges.title" />
{{/if}}
{{#if this.currentUser.admin}}
<NavItem @route="adminEmail" @label="admin.email.title" />
{{/if}}
<NavItem @route="adminLogs" @label="admin.logs.title" />
<NavItem @route="adminCustomize" @label="admin.customize.title" />
{{#if this.currentUser.admin}}
<NavItem @route="adminApi" @label="admin.api.title" />
{{#if this.siteSettings.enable_backups}}
<NavItem @route="admin.backups" @label="admin.backups.title" />
{{/if}}
<NavItem @route="adminPlugins" @label="admin.plugins.title" />
{{/if}}
{{! TODO: What do we do with this?? How many plugins are using? }}
<PluginOutlet @name="admin-menu" />
</ul>
</div>
{{/unless}}
<div class="boxed white admin-content">
<div class="admin-contents {{this.adminContentsClassName}}">

73
app/assets/javascripts/discourse/app/instance-initializers/admin-sidebar.js

@ -4,6 +4,7 @@ import {
addSidebarSection,
} from "discourse/lib/sidebar/custom-sections";
import { ADMIN_PANEL } from "discourse/services/sidebar-state";
import I18n from "discourse-i18n";
function defineAdminSectionLink(BaseCustomSidebarSectionLink) {
const SidebarAdminSectionLink = class extends BaseCustomSidebarSectionLink {
@ -33,7 +34,9 @@ function defineAdminSectionLink(BaseCustomSidebarSectionLink) {
}
get text() {
return this.adminSidebarNavLink.text;
return this.adminSidebarNavLink.label
? I18n.t(this.adminSidebarNavLink.label)
: this.adminSidebarNavLink.text;
}
get prefixType() {
@ -77,7 +80,9 @@ function defineAdminSection(
}
get text() {
return this.adminNavSectionData.text;
return this.adminNavSectionData.label
? I18n.t(this.adminNavSectionData.label)
: this.adminNavSectionData.text;
}
get links() {
@ -103,22 +108,47 @@ export function useAdminNavConfig(navMap) {
hideSectionHeader: true,
links: [
{
name: "Back to Forum",
name: "back_to_forum",
route: "discovery.latest",
text: "Back to Forum",
label: "admin.back_to_forum",
icon: "arrow-left",
},
{
name: "Lobby",
route: "admin-revamp.lobby",
text: "Lobby",
name: "admin_dashboard",
route: "admin.dashboard",
label: "admin.dashboard.title",
icon: "home",
},
{
name: "legacy",
route: "admin",
text: "Legacy Admin",
icon: "wrench",
name: "admin_site_settings",
route: "adminSiteSettings",
label: "admin.site_settings.title",
icon: "cog",
},
{
name: "admin_users",
route: "adminUsers",
label: "admin.users.title",
icon: "users",
},
{
name: "admin_reports",
route: "adminReports",
label: "admin.dashboard.reports_tab",
icon: "chart-pie",
},
{
name: "admin_plugins",
route: "adminPlugins",
label: "admin.plugins.title",
icon: "puzzle-piece",
},
{
name: "admin_badges",
route: "adminBadges",
label: "admin.badges.title",
icon: "certificate",
},
],
},
@ -157,12 +187,7 @@ export default {
return;
}
if (
!this.siteSettings.userInAnyGroups(
"enable_experimental_admin_ui_groups",
this.currentUser
)
) {
if (!this.siteSettings.enable_admin_sidebar_navigation) {
return;
}
@ -179,7 +204,19 @@ export default {
);
const savedConfig = this.adminSidebarExperimentStateManager.navConfig;
const navConfig = useAdminNavConfig(savedConfig || ADMIN_NAV_MAP);
const navMap = savedConfig || ADMIN_NAV_MAP;
if (this.siteSettings.experimental_form_templates) {
navMap.findBy("name", "customize").links.push({
name: "admin_customize_form_templates",
route: "adminCustomizeFormTemplates",
label: "admin.form_templates.nav_title",
icon: "list",
});
}
const navConfig = useAdminNavConfig(navMap);
buildAdminSidebar(navConfig, adminSectionLinkClass);
},
};

230
app/assets/javascripts/discourse/app/lib/sidebar/admin-nav-map.js

@ -1,232 +1,182 @@
// DO NOT EDIT THIS FILE!!!
// Update it by running `rake javascript:update_constants`
export const ADMIN_NAV_MAP = [
{
name: "root",
text: "Root",
links: [
{ name: "admin-revamp", route: "admin-revamp", text: "Revamp" },
{ name: "admin", route: "admin", text: "Admin" },
],
},
{
name: "plugins",
text: "Plugins",
links: [{ name: "admin_plugins", route: "adminPlugins", text: "Plugins" }],
},
{
name: "site_settings",
text: "Site Settings",
links: [
{
name: "admin_site_settings",
route: "adminSiteSettings",
text: "Site Settings",
},
],
},
{
name: "reports",
text: "Reports",
links: [{ name: "admin_reports", route: "adminReports", text: "Reports" }],
},
{
name: "users",
text: "Users",
links: [
{ name: "admin_users_list", route: "adminUsersList", text: "List" },
{ name: "admin_users", route: "adminUsers", text: "Users" },
],
},
{
name: "email",
text: "Email",
links: [
{ name: "admin_email_sent", route: "adminEmail.sent", text: "Sent" },
{
name: "admin_email",
route: "adminEmail.index",
label: "admin.email.settings",
icon: "cog",
},
{
name: "admin_email_sent",
route: "adminEmail.sent",
label: "admin.email.sent",
icon: "arrow-right",
},
{
name: "admin_email_skipped",
route: "adminEmail.skipped",
text: "Skipped",
label: "admin.email.skipped",
icon: "angle-double-right",
},
{
name: "admin_email_bounced",
route: "adminEmail.bounced",
text: "Bounced",
label: "admin.email.bounced",
icon: "times",
},
{
name: "admin_email_received",
route: "adminEmail.received",
text: "Received",
label: "admin.email.received",
icon: "inbox",
},
{
name: "admin_email_rejected",
route: "adminEmail.rejected",
text: "Rejected",
label: "admin.email.rejected",
icon: "ban",
},
{
name: "admin_email_preview-digest",
route: "adminEmail.previewDigest",
text: "Preview Digest",
},
{
name: "admin_email_advanced-test",
route: "adminEmail.advancedTest",
text: "Advanced Test",
},
{ name: "admin_email", route: "adminEmail", text: "Email" },
],
},
{
name: "logs",
text: "Logs",
label: "admin.logs.title",
links: [
{
name: "admin_logs_staff_action_logs",
route: "adminLogs.staffActionLogs",
text: "Staff Action Logs",
label: "admin.logs.staff_actions.title",
icon: "user-shield",
},
{
name: "admin_logs_screened_emails",
route: "adminLogs.screenedEmails",
text: "Screened Emails",
label: "admin.logs.screened_emails.title",
icon: "envelope",
},
{
name: "admin_logs_screened_ip_addresses",
route: "adminLogs.screenedIpAddresses",
text: "Screened Ip Addresses",
label: "admin.logs.screened_ips.title",
icon: "globe",
},
{
name: "admin_logs_screened_urls",
route: "adminLogs.screenedUrls",
text: "Screened Urls",
label: "admin.logs.screened_urls.title",
icon: "globe",
},
{
name: "admin_logs_search_logs",
route: "adminSearchLogs",
text: "Search Logs",
label: "admin.logs.search_logs.title",
icon: "search",
},
{
name: "admin_logs_search_logs_term",
route: "adminSearchLogs.term",
text: "Search Term",
},
{ name: "admin_logs", route: "adminLogs", text: "Logs" },
],
},
{
name: "customize",
text: "Customize",
label: "admin.customize.title",
links: [
{ name: "admin_customize", route: "adminCustomize", text: "Customize" },
{
name: "admin_customize_themes",
route: "adminCustomizeThemes",
text: "Themes",
label: "admin.customize.theme.title",
icon: "paint-brush",
},
{
name: "admin_customize_colors",
route: "adminCustomize.colors",
text: "Colors",
},
{
name: "admin_customize_permalinks",
route: "adminPermalinks",
text: "Permalinks",
},
{
name: "admin_customize_embedding",
route: "adminEmbedding",
text: "Embedding",
},
{
name: "admin_customize_user_fields",
route: "adminUserFields",
text: "User Fields",
},
{ name: "admin_customize_emojis", route: "adminEmojis", text: "Emojis" },
{
name: "admin_customize_form-templates",
route: "adminCustomizeFormTemplates",
text: "Form Templates",
},
{
name: "admin_customize_form-templates_new",
route: "adminCustomizeFormTemplates.new",
text: "Form Templates New",
label: "admin.customize.colors.title",
icon: "palette",
},
{
name: "admin_customize_site_texts",
route: "adminSiteText",
text: "Site Texts",
label: "admin.site_text.title",
icon: "language",
},
{
name: "admin_customize_email_templates",
route: "adminCustomizeEmailTemplates",
text: "Email Templates",
},
{
name: "admin_customize_robots",
route: "adminCustomizeRobotsTxt",
text: "Robots",
label: "admin.email.templates_title",
icon: "envelope",
},
{
name: "admin_customize_email_style",
route: "adminCustomizeEmailStyle",
text: "Email Style",
label: "admin.customize.email_style.title",
icon: "envelope",
},
{
name: "admin_customize_user_fields",
route: "adminUserFields",
label: "admin.user_fields.title",
icon: "user-edit",
},
{
name: "admin_customize_emojis",
route: "adminEmojis",
label: "admin.emoji.title",
icon: "discourse-emojis",
},
{
name: "admin_customize_permalinks",
route: "adminPermalinks",
label: "admin.permalink.title",
icon: "link",
},
{
name: "admin_customize_embedding",
route: "adminEmbedding",
label: "admin.embedding.title",
icon: "code",
},
{
name: "admin_customize_watched_words",
route: "adminWatchedWords",
text: "Watched Words",
},
],
},
{
name: "dashboard",
text: "Dashboard",
links: [
{
name: "admin_dashboard_moderation",
route: "admin.dashboardModeration",
text: "Moderation",
},
{
name: "admin_dashboard_security",
route: "admin.dashboardSecurity",
text: "Security",
},
{
name: "admin_dashboard_reports",
route: "admin.dashboardReports",
text: "Reports",
label: "admin.watched_words.title",
icon: "eye",
},
],
},
{
name: "api",
text: "Api",
label: "admin.api.title",
links: [
{ name: "admin_api_keys", route: "adminApiKeys", text: "Keys" },
{
name: "admin_api_keys",
route: "adminApiKeys",
icon: "key",
label: "admin.api.keys",
},
{
name: "admin_api_web_hooks",
route: "adminWebHooks",
text: "Web Hooks",
label: "admin.web_hooks.title",
icon: "globe",
},
{ name: "admin_api", route: "adminApi", text: "Api" },
],
},
{
name: "backups",
text: "Backups",
label: "admin.backups.menu.backups",
links: [
{ name: "admin_backups_logs", route: "admin.backups.logs", text: "Logs" },
{ name: "admin_backups", route: "admin.backups", text: "Backups" },
{
name: "admin_backups",
route: "admin.backups.index",
label: "admin.backups.menu.backups",
icon: "archive",
},
{
name: "admin_backups_logs",
route: "admin.backups.logs",
label: "admin.backups.menu.logs",
icon: "stream",
},
],
},
{
name: "badges",
text: "Badges",
links: [{ name: "admin_badges", route: "adminBadges", text: "Badges" }],
},
];

5
app/assets/javascripts/discourse/app/lib/sidebar/user/community-section/admin-revamp-section-link.js

@ -31,10 +31,7 @@ export default class AdminRevampSectionLink extends BaseSectionLink {
return (
this.currentUser.staff &&
this.siteSettings.userInAnyGroups(
"enable_experimental_admin_ui_groups",
this.currentUser
)
this.siteSettings.enable_admin_sidebar_navigation
);
}

6
app/models/sidebar_url.rb

@ -22,12 +22,6 @@ class SidebarUrl < ActiveRecord::Base
},
{ name: "Review", path: "/review", icon: "flag", segment: SidebarUrl.segments["primary"] },
{ name: "Admin", path: "/admin", icon: "wrench", segment: SidebarUrl.segments["primary"] },
{
name: "Admin Revamp",
path: "/admin-revamp",
icon: "star",
segment: SidebarUrl.segments["primary"],
},
{ name: "Users", path: "/u", icon: "users", segment: SidebarUrl.segments["secondary"] },
{
name: "About",

3
config/locales/client.en.yml

@ -4722,6 +4722,7 @@ en:
admin:
title: "Discourse Admin"
moderator: "Moderator"
back_to_forum: "Back to Forum"
tags:
remove_muted_tags_from_latest:
@ -4911,6 +4912,7 @@ en:
user: "User"
title: "API"
key: "Key"
keys: "Keys"
created: Created
updated: Updated
last_used: Last Used
@ -5529,6 +5531,7 @@ en:
title: "Emails"
settings: "Settings"
templates: "Templates"
templates_title: "Email Templates"
preview_digest: "Preview Summary"
advanced_test:
title: "Advanced Test"

1
config/locales/server.en.yml

@ -2490,6 +2490,7 @@ en:
enable_experimental_lightbox: "EXPERIMENTAL: Replace the default image lightbox with the revamped design."
experimental_form_templates: "EXPERIMENTAL: Enable the form templates feature. <b>After enabled,</b> manage the templates at <a href='%{base_path}/admin/customize/form-templates'>Customize / Templates</a>."
enable_admin_sidebar_navigation: "EXPERIMENTAL: Enable sidebar navigation for the admin UI, which replaces the top-level admin navigation buttons."
page_loading_indicator: "Configure the loading indicator which appears during page navigations within Discourse. 'Spinner' is a full page indicator. 'Slider' shows a narrow bar at the top of the screen."
show_user_menu_avatars: "Show user avatars in the user menu"

3
config/site_settings.yml

@ -2280,6 +2280,9 @@ developer:
refresh: true
hidden: true
client: true
enable_admin_sidebar_navigation:
default: false
client: true
lazy_load_categories:
default: false
client: true

2
lib/svg_sprite.rb

@ -19,6 +19,7 @@ module SvgSprite
archive
arrow-down
arrow-left
arrow-right
arrow-up
arrows-alt-h
arrows-alt-v
@ -171,6 +172,7 @@ module SvgSprite
mobile-alt
moon
paint-brush
palette
paper-plane
pause
pencil-alt

138
lib/tasks/javascript.rake

@ -129,140 +129,6 @@ def absolute_sourcemap(dest)
end
end
def generate_admin_sidebar_nav_map
vague_categories = { "root" => [] }
admin_routes =
Rails
.application
.routes
.routes
.map do |route|
next if route.verb != "GET"
path = route.path.spec.to_s.gsub("(.:format)", "")
next if !path.include?("admin")
next if path.include?("/:") || path.include?("admin-login")
path
end
.compact
# TODO (martin): This will generate the engine routes based on installed plugins,
# so it is not generic enough to use here. Need to think of another way to do
# this and reconcile with the Ember routes from the client; maybe some button
# that does it at runtime for this experiment?
engine_routes = []
# engine_routes = Rails::Engine
# .subclasses
# .map do |engine|
# engine
# .routes
# .routes
# .map do |route|
# next if route.verb != "GET"
# path = route.path.spec.to_s.gsub("(.:format)", "")
# next if !path.include?("admin")
# next if path.include?("/:") || path.include?("admin-login")
# path
# end
# .compact
# end
# .flatten
admin_routes = admin_routes.concat(engine_routes)
admin_routes.each do |path|
split_path = path.split("/")
if split_path.length >= 3
vague_categories[split_path[2]] ||= []
vague_categories[split_path[2]] << { path: path }
else
vague_categories["root"] << { path: path }
end
end
# rubocop:disable Lint/Void
# Copy this JS to your browser to get the Ember routes.
<<~JS
let routeMap = {}
for (const [key, value] of Object.entries(
Object.fromEntries(
Object.entries(
Discourse.__container__.lookup("service:router")._router._routerMicrolib
.recognizer.names
).filter(([key]) => key.includes("admin"))
)
)) {
let route = value.segments
.map((s) => s.value)
.join("/")
.replace("//", "/");
if (
route.includes("dummy") ||
route.includes("loading") ||
route.includes("_id") ||
route.includes("admin-invite")
) {
continue;
}
routeMap[key] = route;
}
console.log(JSON.stringify(routeMap));
JS
# rubocop:enable Lint/Void
# Paste the output below between ROUTE_MAP.
#
ember_route_map = <<~ROUTE_MAP
{"admin.dashboard.general":"/admin/","admin.dashboard":"/admin/","admin":"/admin/","admin.dashboardModeration":"/admin/dashboard/moderation","admin.dashboardSecurity":"/admin/dashboard/security","admin.dashboardReports":"/admin/dashboard/reports","adminSiteSettings.index":"/admin/site_settings/","adminSiteSettings":"/admin/site_settings/","adminEmail.sent":"/admin/email/sent","adminEmail.skipped":"/admin/email/skipped","adminEmail.bounced":"/admin/email/bounced","adminEmail.received":"/admin/email/received","adminEmail.rejected":"/admin/email/rejected","adminEmail.previewDigest":"/admin/email/preview-digest","adminEmail.advancedTest":"/admin/email/advanced-test","adminEmail.index":"/admin/email/","adminEmail":"/admin/email/","adminCustomize.colors.index":"/admin/customize/colors/","adminCustomize.colors":"/admin/customize/colors/","adminCustomizeThemes.index":"/admin/customize/themes/","adminCustomizeThemes":"/admin/customize/themes/","adminSiteText.edit":"/admin/customize/site_texts/id","adminSiteText.index":"/admin/customize/site_texts/","adminSiteText":"/admin/customize/site_texts/","adminUserFields":"/admin/customize/user_fields","adminEmojis":"/admin/customize/emojis","adminPermalinks":"/admin/customize/permalinks","adminEmbedding":"/admin/customize/embedding","adminCustomizeEmailTemplates.edit":"/admin/customize/email_templates/id","adminCustomizeEmailTemplates.index":"/admin/customize/email_templates/","adminCustomizeEmailTemplates":"/admin/customize/email_templates/","adminCustomizeRobotsTxt":"/admin/customize/robots","adminCustomizeEmailStyle.edit":"/admin/customize/email_style/field_name","adminCustomizeEmailStyle.index":"/admin/customize/email_style/","adminCustomizeEmailStyle":"/admin/customize/email_style/","adminCustomizeFormTemplates.new":"/admin/customize/form-templates/new","adminCustomizeFormTemplates.edit":"/admin/customize/form-templates/id","adminCustomizeFormTemplates.index":"/admin/customize/form-templates/","adminCustomizeFormTemplates":"/admin/customize/form-templates/","adminWatchedWords.index":"/admin/customize/watched_words/","adminWatchedWords":"/admin/customize/watched_words/","adminCustomize.index":"/admin/customize/","adminCustomize":"/admin/customize/","adminApiKeys.new":"/admin/api/keys/new","adminApiKeys.index":"/admin/api/keys/","adminApiKeys":"/admin/api/keys/","adminWebHooks.index":"/admin/api/web_hooks/","adminWebHooks":"/admin/api/web_hooks/","adminApi.index":"/admin/api/","adminApi":"/admin/api/","admin.backups.logs":"/admin/backups/logs","admin.backups.index":"/admin/backups/","admin.backups":"/admin/backups/","adminReports.show":"/admin/reports/type","adminReports.index":"/admin/reports/","adminReports":"/admin/reports/","adminLogs.staffActionLogs":"/admin/logs/staff_action_logs","adminLogs.screenedEmails":"/admin/logs/screened_emails","adminLogs.screenedIpAddresses":"/admin/logs/screened_ip_addresses","adminLogs.screenedUrls":"/admin/logs/screened_urls","adminSearchLogs.index":"/admin/logs/search_logs/","adminSearchLogs":"/admin/logs/search_logs/","adminSearchLogs.term":"/admin/logs/search_logs/term","adminLogs.index":"/admin/logs/","adminLogs":"/admin/logs/","adminUsersList.show":"/admin/users/list/filter","adminUsersList.index":"/admin/users/list/","adminUsersList":"/admin/users/list/","adminUsers.index":"/admin/users/","adminUsers":"/admin/users/","adminBadges.index":"/admin/badges/","adminBadges":"/admin/badges/","adminPlugins.index":"/admin/plugins/","adminPlugins":"/admin/plugins/","admin-revamp.lobby":"/admin-revamp/","admin-revamp":"/admin-revamp/","admin-revamp.config.area":"/admin-revamp/config/area","admin-revamp.config.index":"/admin-revamp/config/","admin-revamp.config":"/admin-revamp/config/"}
ROUTE_MAP
ember_route_map = JSON.parse(ember_route_map)
# Match the Ember routes to the rails routes.
vague_categories.each do |category, route_data|
route_data.each do |rails_route|
ember_route_map.each do |ember_route_name, ember_path|
rails_route[:ember_route] = ember_route_name if ember_path == rails_route[:path] ||
ember_path == rails_route[:path] + "/"
end
end
end
# Remove all rails routes that don't have an Ember equivalent.
vague_categories.each do |category, route_data|
vague_categories[category] = route_data.reject { |rails_route| !rails_route.key?(:ember_route) }
end
# Remove all categories that don't have any routes (meaning they are all rails-only).
vague_categories.each do |category, route_data|
vague_categories.delete(category) if route_data.length == 0
end
# Output in the format needed for sidebar sections and links.
vague_categories.map do |category, route_data|
category_text = category.titleize.gsub("Admin ", "")
{
name: category,
text: category_text,
links:
route_data.map do |rails_route|
{
name: rails_route[:path].split("/").compact_blank.join("_").chomp,
route: rails_route[:ember_route],
text:
rails_route[:path]
.split("/")
.compact_blank
.join(" ")
.chomp
.titleize
.gsub("Admin ", "")
.gsub("#{category_text} ", ""),
}
end,
}
end
end
task "javascript:update_constants" => :environment do
task_name = "update_constants"
@ -296,10 +162,6 @@ task "javascript:update_constants" => :environment do
export const AUTO_GROUPS = #{auto_groups.to_json};
JS
write_template("discourse/app/lib/sidebar/admin-nav-map.js", task_name, <<~JS)
export const ADMIN_NAV_MAP = #{generate_admin_sidebar_nav_map.to_json}
JS
pretty_notifications = Notification.types.map { |n| " #{n[0]}: #{n[1]}," }.join("\n")
write_template("discourse/tests/fixtures/concerns/notification-types.js", task_name, <<~JS)

13
spec/models/sidebar_section_spec.rb

@ -22,18 +22,7 @@ RSpec.describe SidebarSection do
expect(community_section.reload.title).to eq("Community")
expect(community_section.sidebar_section_links.all.map { |link| link.linkable.name }).to eq(
[
"Topics",
"My Posts",
"Review",
"Admin",
"Admin Revamp",
"Users",
"About",
"FAQ",
"Groups",
"Badges",
],
["Topics", "My Posts", "Review", "Admin", "Users", "About", "FAQ", "Groups", "Badges"],
)
end
end

25
spec/system/admin_revamp_sidebar_navigation_spec.rb

@ -2,18 +2,29 @@
describe "Admin Revamp | Sidebar Navigation", type: :system do
fab!(:admin)
let(:sidebar_page) { PageObjects::Components::NavigationMenu::Sidebar.new }
let(:sidebar) { PageObjects::Components::NavigationMenu::Sidebar.new }
before do
SiteSetting.enable_experimental_admin_ui_groups = Group::AUTO_GROUPS[:staff]
SidebarSection.find_by(section_type: "community").reset_community!
SiteSetting.enable_admin_sidebar_navigation = true
sign_in(admin)
end
it "navigates to the admin revamp from the sidebar" do
it "shows the sidebar when navigating to an admin route and hides it when leaving" do
visit("/latest")
sidebar_page.click_section_link("Admin Revamp")
expect(page).to have_content("Lobby")
expect(page).to have_content("Legacy Admin")
sidebar.click_link_in_section("community", "admin")
expect(page).to have_current_path("/admin")
expect(sidebar).to be_visible
expect(page).to have_no_css(".admin-main-nav")
sidebar.click_link_in_section("admin-nav-section-root", "back_to_forum")
expect(page).to have_current_path("/latest")
expect(sidebar).to have_no_section("admin-nav-section-root")
end
it "does not show the admin sidebar if the setting is disabled" do
SiteSetting.enable_admin_sidebar_navigation = false
visit("/latest")
sidebar.click_link_in_section("community", "admin")
expect(page).to have_current_path("/admin")
expect(sidebar).to have_no_section("admin-nav-section-root")
end
end

28
spec/system/page_objects/components/navigation_menu/base.rb

@ -4,16 +4,34 @@ module PageObjects
module Components
module NavigationMenu
class Base < PageObjects::Components::Base
def community_section
find(".sidebar-section[data-section-name='community']")
SIDEBAR_SECTION_LINK_SELECTOR = "sidebar-section-link"
def visible?
has_css?("#d-sidebar.sidebar-container")
end
SIDEBAR_SECTION_LINK_SELECTOR = "sidebar-section-link"
def hidden?
has_no_css?("#d-sidebar.sidebar-container")
end
def community_section
find_section("community")
end
def find_section(name)
find(".sidebar-section[data-section-name='#{name}']")
end
def click_section_link(name)
find(".#{SIDEBAR_SECTION_LINK_SELECTOR}", text: name).click
end
def click_link_in_section(section_name, link_name)
find_section(section_name.parameterize).find(
".#{SIDEBAR_SECTION_LINK_SELECTOR}[data-link-name=\"#{link_name.parameterize}\"]",
).click
end
def has_one_active_section_link?
has_css?(".#{SIDEBAR_SECTION_LINK_SELECTOR}--active", count: 1)
end
@ -30,6 +48,10 @@ module PageObjects
has_css?(".sidebar-sections [data-section-name='#{name.parameterize}']")
end
def has_no_section?(name)
has_no_css?(".sidebar-sections [data-section-name='#{name.parameterize}']")
end
def switch_to_chat
find(".sidebar__panel-switch-button[data-key='chat']").click
end