A platform for community discussion. Free, open, simple.
PERF: Avoid HTML escaping preloaded JSON (#41978)
Alan Guo Xiang Tana43c0bddf80a
diff --git a/app/helpers/qunit_helper.rb b/app/helpers/qunit_helper.rbindex 7c00fab63c6..183a6127778 100644--- a/app/helpers/qunit_helper.rb+++ b/app/helpers/qunit_helper.rb@@ -20,7 +20,11 @@ module QunitHelperpreloaded.merge!(site_settings_preload_data)return "" if preloaded.empty?- tag.div("", id: "data-preloaded", data: { preloaded: preloaded.to_json })+ tag.script(+ raw(ERB::Util.json_escape(preloaded.to_json)),+ type: "application/json",+ id: "data-preloaded",+ )endprivatediff --git a/app/views/layouts/application.html.erb b/app/views/layouts/application.html.erbindex 46a98b6e8eb..521e727efff 100644--- a/app/views/layouts/application.html.erb+++ b/app/views/layouts/application.html.erb@@ -98,7 +98,7 @@<%= render partial: "common/discourse_stylesheet" %></discourse-assets-stylesheets><discourse-assets-json>- <div class="hidden" id="data-preloaded" data-preloaded="<%= preloaded_json %>"></div>+ <script type="application/json" id="data-preloaded"><%= raw(preloaded_json) %></script></discourse-assets-json><discourse-assets-icons></discourse-assets-icons></discourse-assets>diff --git a/frontend/discourse/app/app.js b/frontend/discourse/app/app.jsindex 428c85a4133..e802ad3a079 100644--- a/frontend/discourse/app/app.js+++ b/frontend/discourse/app/app.js@@ -22,7 +22,10 @@ import { importSync } from "@embroider/macros";import { normalizeEmberEventHandling } from "discourse/lib/ember-events";import { isRailsTesting, isTesting } from "discourse/lib/environment";import { withPluginApi } from "discourse/lib/plugin-api";-import { populatePreloadStore } from "discourse/lib/preload-store";+import {+ populatePreloadStore,+ readPreloadedData,+} from "discourse/lib/preload-store";import { buildResolver } from "discourse/resolver";populatePreloadStore();@@ -106,8 +109,7 @@ async function loadPluginFromModulePreload(link) {function registerPreloadedThemeSettings() {try {- const element = document.getElementById("data-preloaded");- const preloaded = JSON.parse(element.dataset.preloaded);+ const preloaded = readPreloadedData();const activatedThemes = JSON.parse(preloaded.activatedThemes);for (const [themeId, info] of Object.entries(activatedThemes)) {registerSettings(parseInt(themeId, 10), info.settings);diff --git a/frontend/discourse/app/lib/preload-store.js b/frontend/discourse/app/lib/preload-store.jsindex 74b23b443d4..ab416702828 100644--- a/frontend/discourse/app/lib/preload-store.js+++ b/frontend/discourse/app/lib/preload-store.js@@ -58,6 +58,15 @@ const PreloadStore = {},};+export function readPreloadedData() {+ const element = document.getElementById("data-preloaded");+ if (!element) {+ return;+ }++ return JSON.parse(element.textContent);+}+export function populatePreloadStore() {let setupData;const setupDataElement = document.getElementById("data-discourse-setup");@@ -65,12 +74,7 @@ export function populatePreloadStore() {setupData = setupDataElement.dataset;}- let preloaded;- const preloadedDataElement = document.getElementById("data-preloaded");- if (preloadedDataElement) {- preloaded = JSON.parse(preloadedDataElement.dataset.preloaded);- }-+ const preloaded = readPreloadedData();const keys = preloaded ? Object.keys(preloaded) : [];if (keys.length === 0 && !isTesting()) {throw "No preload data found in #data-preloaded. Unable to boot Discourse.";diff --git a/frontend/discourse/tests/unit/lib/preload-store-test.js b/frontend/discourse/tests/unit/lib/preload-store-test.jsindex 3ee797a5076..25fe1a04b67 100644--- a/frontend/discourse/tests/unit/lib/preload-store-test.js+++ b/frontend/discourse/tests/unit/lib/preload-store-test.js@@ -1,7 +1,7 @@import { setupTest } from "ember-qunit";import { module, test } from "qunit";import { Promise } from "rsvp";-import PreloadStore from "discourse/lib/preload-store";+import PreloadStore, { readPreloadedData } from "discourse/lib/preload-store";module("Unit | Utility | preload-store", function (hooks) {setupTest(hooks);@@ -10,6 +10,24 @@ module("Unit | Utility | preload-store", function (hooks) {PreloadStore.store("bane", "evil");});+ hooks.afterEach(function () {+ document.getElementById("data-preloaded")?.remove();+ });++ test("readPreloadedData reads JSON script content", function (assert) {+ const element = document.createElement("script");+ element.id = "data-preloaded";+ element.type = "application/json";+ element.textContent = JSON.stringify({ site: "{}" });+ document.body.append(element);++ assert.deepEqual(+ readPreloadedData(),+ { site: "{}" },+ "reads the preloaded data"+ );+ });+test("get", function (assert) {assert.blank(PreloadStore.get("joker"), "returns blank for a missing key");assert.strictEqual(diff --git a/plugins/chat/spec/requests/application_controller_spec.rb b/plugins/chat/spec/requests/application_controller_spec.rbindex 26d12f76402..f799fa48729 100644--- a/plugins/chat/spec/requests/application_controller_spec.rb+++ b/plugins/chat/spec/requests/application_controller_spec.rb@@ -5,9 +5,7 @@ RSpec.describe ApplicationController dofab!(:admin)def preloaded_json- JSON.parse(- Nokogiri::HTML5.fragment(response.body).css("div#data-preloaded").first["data-preloaded"],- )+ JSON.parse(Nokogiri::HTML5.fragment(response.body).css("script#data-preloaded").first.text)endbefore dodiff --git a/spec/helpers/application_helper_spec.rb b/spec/helpers/application_helper_spec.rbindex fd98488d396..f7a18c1894f 100644--- a/spec/helpers/application_helper_spec.rb+++ b/spec/helpers/application_helper_spec.rb@@ -569,8 +569,11 @@ RSpec.describe ApplicationHelper dologin_method: nil,)- @application_layout_preloader.store_preloaded("test", %{["< \x80"]})- expect(helper.preloaded_json).to include(%{"test":"[\\"\\u003c \uFFFD\\"]"})+ @application_layout_preloader.store_preloaded("test", %{["</script><script> \x80"]})+ expect(helper.preloaded_json).to include(+ %{"test":"[\\"\\u003c\\\\/script\\u003e\\u003cscript\\u003e \uFFFD\\"]"},+ )+ expect(helper.preloaded_json).not_to include("</script>")endenddiff --git a/spec/requests/admin/backups_controller_spec.rb b/spec/requests/admin/backups_controller_spec.rbindex b24dea7900a..c1657b4f8e7 100644--- a/spec/requests/admin/backups_controller_spec.rb+++ b/spec/requests/admin/backups_controller_spec.rb@@ -23,7 +23,7 @@ RSpec.describe Admin::BackupsController dodef map_preloadedJSON- .parse(Nokogiri.HTML5(response.body).at_css("[data-preloaded]")["data-preloaded"])+ .parse(Nokogiri.HTML5(response.body).at_css("#data-preloaded").text).map { |key, value| [key, JSON.parse(value)] }.to_henddiff --git a/spec/requests/application_controller_spec.rb b/spec/requests/application_controller_spec.rbindex a6178d851e0..9a6dfd0aa60 100644--- a/spec/requests/application_controller_spec.rb+++ b/spec/requests/application_controller_spec.rb@@ -1752,8 +1752,8 @@ RSpec.describe ApplicationController doit "does not include banner info for anonymous users" doget "/login"- expect(response.body).to have_tag("div#data-preloaded") do |element|- json = JSON.parse(element.current_scope.attribute("data-preloaded").value)+ expect(response.body).to have_tag("script#data-preloaded") do |element|+ json = JSON.parse(element.current_scope.text)expect(json["banner"]).to eq("{}")endend@@ -1762,8 +1762,8 @@ RSpec.describe ApplicationController dosign_in(user)get "/"- expect(response.body).to have_tag("div#data-preloaded") do |element|- json = JSON.parse(element.current_scope.attribute("data-preloaded").value)+ expect(response.body).to have_tag("script#data-preloaded") do |element|+ json = JSON.parse(element.current_scope.text)expect(JSON.parse(json["banner"])["html"]).to eq("<p>A banner topic</p>")endend@@ -1774,8 +1774,8 @@ RSpec.describe ApplicationController doit "does include banner info for anonymous users" doget "/login"- expect(response.body).to have_tag("div#data-preloaded") do |element|- json = JSON.parse(element.current_scope.attribute("data-preloaded").value)+ expect(response.body).to have_tag("script#data-preloaded") do |element|+ json = JSON.parse(element.current_scope.text)expect(JSON.parse(json["banner"])["html"]).to eq("<p>A banner topic</p>")endend@@ -1784,7 +1784,7 @@ RSpec.describe ApplicationController docontext "with content localization enabled" dodef banner_htmlpreloaded = Nokogiri::HTML5.fragment(response.body).css("#data-preloaded").first- JSON.parse(JSON.parse(preloaded["data-preloaded"])["banner"])["html"]+ JSON.parse(JSON.parse(preloaded.text)["banner"])["html"]endbefore do@@ -1862,9 +1862,7 @@ RSpec.describe ApplicationController dodescribe "preloading data" dodef preloaded_json- JSON.parse(- Nokogiri::HTML5.fragment(response.body).css("div#data-preloaded").first["data-preloaded"],- )+ JSON.parse(Nokogiri::HTML5.fragment(response.body).css("script#data-preloaded").first.text)endcontext "when user is anon" dodiff --git a/spec/requests/categories_controller_spec.rb b/spec/requests/categories_controller_spec.rbindex f2b6d4f5886..bd0fcc7c640 100644--- a/spec/requests/categories_controller_spec.rb+++ b/spec/requests/categories_controller_spec.rb@@ -19,8 +19,8 @@ RSpec.describe CategoriesController doSiteSetting.categories_topics.times { Fabricate(:topic) }get "/categories"- expect(response.body).to have_tag("div#data-preloaded") do |element|- json = JSON.parse(element.current_scope.attribute("data-preloaded").value)+ expect(response.body).to have_tag("script#data-preloaded") do |element|+ json = JSON.parse(element.current_scope.text)expect(json["topic_list"]).to include(%{"more_topics_url":"/latest"})endenddiff --git a/spec/requests/invites_controller_spec.rb b/spec/requests/invites_controller_spec.rbindex b91f3a79c0a..bfe25aec3c7 100644--- a/spec/requests/invites_controller_spec.rb+++ b/spec/requests/invites_controller_spec.rb@@ -25,8 +25,8 @@ RSpec.describe InvitesController do),)- expect(response.body).to have_tag("div#data-preloaded") do |element|- json = JSON.parse(element.current_scope.attribute("data-preloaded").value)+ expect(response.body).to have_tag("script#data-preloaded") do |element|+ json = JSON.parse(element.current_scope.text)invite_info = JSON.parse(json["invite_info"])expect(invite_info["username"]).to eq("")expect(invite_info["email"]).to eq("i*****g@a***********e.ooo")@@ -38,8 +38,8 @@ RSpec.describe InvitesController doexpect(response.status).to eq(200)expect(response.body).to include(invite.email)- expect(response.body).to have_tag("div#data-preloaded") do |element|- json = JSON.parse(element.current_scope.attribute("data-preloaded").value)+ expect(response.body).to have_tag("script#data-preloaded") do |element|+ json = JSON.parse(element.current_scope.text)invite_info = JSON.parse(json["invite_info"])expect(invite_info["username"]).to eq("") # Default is that we don't use emails to suggest usernamesexpect(invite_info["email"]).to eq(invite.email)@@ -65,8 +65,8 @@ RSpec.describe InvitesController dostaged_user.save_custom_fieldsget "/invites/#{invite.invite_key}"- expect(response.body).to have_tag("div#data-preloaded") do |element|- json = JSON.parse(element.current_scope.attribute("data-preloaded").value)+ expect(response.body).to have_tag("script#data-preloaded") do |element|+ json = JSON.parse(element.current_scope.text)invite_info = JSON.parse(json["invite_info"])expect(invite_info["username"]).not_to eq(staged_user.username)expect(invite_info["user_fields"]).to be_nil@@ -82,8 +82,8 @@ RSpec.describe InvitesController doserver_session[:authentication] = { email: invite.email, email_valid: false }get "/invites/#{invite.invite_key}"- expect(response.body).to have_tag("div#data-preloaded") do |element|- json = JSON.parse(element.current_scope.attribute("data-preloaded").value)+ expect(response.body).to have_tag("script#data-preloaded") do |element|+ json = JSON.parse(element.current_scope.text)invite_info = JSON.parse(json["invite_info"])expect(invite_info["email"]).to eq(invite.email)expect(invite_info["user_fields"]).to be_nil@@ -99,8 +99,8 @@ RSpec.describe InvitesController doserver_session[:authentication] = { email: invite.email, email_valid: true }get "/invites/#{invite.invite_key}"- expect(response.body).to have_tag("div#data-preloaded") do |element|- json = JSON.parse(element.current_scope.attribute("data-preloaded").value)+ expect(response.body).to have_tag("script#data-preloaded") do |element|+ json = JSON.parse(element.current_scope.text)invite_info = JSON.parse(json["invite_info"])expect(invite_info["username"]).to eq(staged_user.username)expect(invite_info["user_fields"][user_field.id.to_s]).to eq("some value")@@ -114,8 +114,8 @@ RSpec.describe InvitesController dostaged_user.save_custom_fieldsget "/invites/#{invite.invite_key}?t=#{invite.email_token}"- expect(response.body).to have_tag("div#data-preloaded") do |element|- json = JSON.parse(element.current_scope.attribute("data-preloaded").value)+ expect(response.body).to have_tag("script#data-preloaded") do |element|+ json = JSON.parse(element.current_scope.text)invite_info = JSON.parse(json["invite_info"])expect(invite_info["username"]).to eq(staged_user.username)expect(invite_info["user_fields"][user_field.id.to_s]).to eq("some value")@@ -124,15 +124,15 @@ RSpec.describe InvitesController doit "includes token validity boolean" doget "/invites/#{invite.invite_key}"- expect(response.body).to have_tag("div#data-preloaded") do |element|- json = JSON.parse(element.current_scope.attribute("data-preloaded").value)+ expect(response.body).to have_tag("script#data-preloaded") do |element|+ json = JSON.parse(element.current_scope.text)invite_info = JSON.parse(json["invite_info"])expect(invite_info["email_verified_by_link"]).to eq(false)endget "/invites/#{invite.invite_key}?t=#{invite.email_token}"- expect(response.body).to have_tag("div#data-preloaded") do |element|- json = JSON.parse(element.current_scope.attribute("data-preloaded").value)+ expect(response.body).to have_tag("script#data-preloaded") do |element|+ json = JSON.parse(element.current_scope.text)invite_info = JSON.parse(json["invite_info"])expect(invite_info["email_verified_by_link"]).to eq(true)end@@ -213,8 +213,8 @@ RSpec.describe InvitesController do),)- expect(response.body).to have_tag("div#data-preloaded") do |element|- json = JSON.parse(element.current_scope.attribute("data-preloaded").value)+ expect(response.body).to have_tag("script#data-preloaded") do |element|+ json = JSON.parse(element.current_scope.text)invite_info = JSON.parse(json["invite_info"])expect(invite_info["username"]).to eq(user.username)expect(invite_info["email"]).to eq(user.email)@@ -238,8 +238,8 @@ RSpec.describe InvitesController do),)- expect(response.body).to have_tag("div#data-preloaded") do |element|- json = JSON.parse(element.current_scope.attribute("data-preloaded").value)+ expect(response.body).to have_tag("script#data-preloaded") do |element|+ json = JSON.parse(element.current_scope.text)invite_info = JSON.parse(json["invite_info"])expect(invite_info["username"]).to eq(user.username)expect(invite_info["email"]).to eq(user.email)@@ -255,8 +255,8 @@ RSpec.describe InvitesController doget "/invites/#{invite.invite_key}"expect(response.status).to eq(200)- expect(response.body).to have_tag("div#data-preloaded") do |element|- json = JSON.parse(element.current_scope.attribute("data-preloaded").value)+ expect(response.body).to have_tag("script#data-preloaded") do |element|+ json = JSON.parse(element.current_scope.text)invite_info = JSON.parse(json["invite_info"])expect(invite_info["existing_user_can_redeem"]).to eq(false)expect(invite_info["existing_user_can_redeem_error"]).to eq(@@ -271,8 +271,8 @@ RSpec.describe InvitesController doget "/invites/#{invite.invite_key}"expect(response.status).to eq(200)- expect(response.body).to have_tag("div#data-preloaded") do |element|- json = JSON.parse(element.current_scope.attribute("data-preloaded").value)+ expect(response.body).to have_tag("script#data-preloaded") do |element|+ json = JSON.parse(element.current_scope.text)invite_info = JSON.parse(json["invite_info"])expect(invite_info["existing_user_can_redeem"]).to eq(false)end@@ -285,8 +285,8 @@ RSpec.describe InvitesController doget "/invites/#{invite.invite_key}"expect(response.status).to eq(200)- expect(response.body).to have_tag("div#data-preloaded") do |element|- json = JSON.parse(element.current_scope.attribute("data-preloaded").value)+ expect(response.body).to have_tag("script#data-preloaded") do |element|+ json = JSON.parse(element.current_scope.text)invite_info = JSON.parse(json["invite_info"])expect(invite_info["existing_user_id"]).to eq(user.id)expect(invite_info["existing_user_can_redeem"]).to eq(false)@@ -302,8 +302,8 @@ RSpec.describe InvitesController doget "/invites/#{invite.invite_key}"expect(response.status).to eq(200)- expect(response.body).to have_tag("div#data-preloaded") do |element|- json = JSON.parse(element.current_scope.attribute("data-preloaded").value)+ expect(response.body).to have_tag("script#data-preloaded") do |element|+ json = JSON.parse(element.current_scope.text)invite_info = JSON.parse(json["invite_info"])expect(invite_info["existing_user_id"]).to eq(user.id)expect(invite_info["existing_user_can_redeem"]).to eq(true)diff --git a/spec/requests/list_controller_spec.rb b/spec/requests/list_controller_spec.rbindex b9ea4e820dc..de05ad08db8 100644--- a/spec/requests/list_controller_spec.rb+++ b/spec/requests/list_controller_spec.rb@@ -19,8 +19,8 @@ RSpec.describe ListController doexpect(response.status).to eq(200)expect(response.body).not_to include(SiteSetting.klipy_api_key)- expect(response.body).to have_tag("div#data-preloaded") do |element|- data_preloaded = JSON.parse(element.current_scope.attribute("data-preloaded").value)+ expect(response.body).to have_tag("script#data-preloaded") do |element|+ data_preloaded = JSON.parse(element.current_scope.text)site_settings = JSON.parse(data_preloaded["siteSettings"])expect(site_settings).not_to have_key("klipy_api_key")diff --git a/spec/requests/users_controller_spec.rb b/spec/requests/users_controller_spec.rbindex 692c53e177e..8abfb58d255 100644--- a/spec/requests/users_controller_spec.rb+++ b/spec/requests/users_controller_spec.rb@@ -375,8 +375,8 @@ RSpec.describe UsersController do)expect(response.status).to eq(200)- expect(response.body).to have_tag("div#data-preloaded") do |element|- json = JSON.parse(element.current_scope.attribute("data-preloaded").value)+ expect(response.body).to have_tag("script#data-preloaded") do |element|+ json = JSON.parse(element.current_scope.text)expect(json["password_reset"]).to include('{"is_developer":false,"admin":false,"second_factor_required":false,"security_key_required":false,"backup_enabled":false,"multiple_second_factor_methods":false}',)@@ -532,8 +532,8 @@ RSpec.describe UsersController doget "/u/password-reset/#{email_token.token}"- expect(response.body).to have_tag("div#data-preloaded") do |element|- json = JSON.parse(element.current_scope.attribute("data-preloaded").value)+ expect(response.body).to have_tag("script#data-preloaded") do |element|+ json = JSON.parse(element.current_scope.text)expect(json["password_reset"]).to include('{"is_developer":false,"admin":false,"second_factor_required":true,"security_key_required":false,"backup_enabled":false,"multiple_second_factor_methods":false}',)@@ -589,8 +589,8 @@ RSpec.describe UsersController doendit "preloads with a security key challenge and allowed credential ids" do- expect(response.body).to have_tag("div#data-preloaded") do |element|- json = JSON.parse(element.current_scope.attribute("data-preloaded").value)+ expect(response.body).to have_tag("script#data-preloaded") do |element|+ json = JSON.parse(element.current_scope.text)password_reset = JSON.parse(json["password_reset"])expect(password_reset["challenge"]).not_to eq(nil)expect(password_reset["allowed_credential_ids"]).to eq(@@ -5608,8 +5608,8 @@ RSpec.describe UsersController doexpect(response.status).to eq(200)- expect(response.body).to have_tag("div#data-preloaded") do |element|- json = JSON.parse(element.current_scope.attribute("data-preloaded").value)+ expect(response.body).to have_tag("script#data-preloaded") do |element|+ json = JSON.parse(element.current_scope.text)expect(json["accountCreated"]).to include("{\"message\":\"#{I18n.t("login.activate_email", email: user1.email).gsub!("</", "<\\/")}\",\"show_controls\":true,\"username\":\"#{user1.username}\",\"email\":\"#{user1.email}\"}",)