github-mirror/discourse
2
0
Fork 0
mirror of https://github.com/discourse/discourse.git synced 2025-01-18 14:03:18 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

DEV: Ensure deprecation warning banner works in development builds (#28302)

Browse Source 
In development, Ember raises an error when previously-used values are updated during a render. This is to avoid 'backtracking', where parts of templates have to be re-rendered multiple times. In general, this kind of pattern should be avoided, and Ember's warning helps us do that.

However, for the deprecation warning banner, it is quite reasonable for some rendering to trigger a deprecation, and thereby require the global-notice to be re-rendered. We can use our `DeferredTrackedSet` to achieve that. Its `.add` method will delay adding an item to the Set until after the current render has completed.
This commit is contained in:
David Taylor 2024-08-09 15:04:05 +01:00 committed by GitHub
parent 234e155d3c
commit df5561d780
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 30 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
app/assets/javascripts/discourse/app/components/global-notice.js
View File

@ -2,16 +2,16 @@ import Component from "@ember/component";
import EmberObject, { action } from "@ember/object";
import { service } from "@ember/service";
import { htmlSafe } from "@ember/template";
import { TrackedArray } from "@ember-compat/tracked-built-ins";
import { tagName } from "@ember-decorators/component";
import cookie, { removeCookie } from "discourse/lib/cookie";
import { DeferredTrackedSet } from "discourse/lib/tracked-tools";
import { bind } from "discourse-common/utils/decorators";
import I18n from "discourse-i18n";
const _pluginNotices = new TrackedArray();
const _pluginNotices = new DeferredTrackedSet();
export function addGlobalNotice(text, id, options = {}) {
_pluginNotices.push(Notice.create({ text, id, options }));
_pluginNotices.add(Notice.create({ text, id, options }));
}
const GLOBAL_NOTICE_DISMISSED_PROMPT_KEY = "dismissed-global-notice-v2";
@ -153,7 +153,7 @@ export default class GlobalNotice extends Component {
notices.push(this.get("logNotice"));
}
return notices.concat(_pluginNotices).filter((notice) => {
return notices.concat(Array.from(_pluginNotices)).filter((notice) => {
if (notice.options.visibility) {
return notice.options.visibility(notice);
}

26
spec/system/ember_deprecation_spec.rb
View File

@ -52,4 +52,30 @@ describe "JS Deprecation Handling", type: :system do
)
expect(message).to have_text(SiteSetting.warn_critical_js_deprecations_message)
end
it "can show warnings triggered during initial render" do
sign_in Fabricate(:admin)
t = Fabricate(:theme, name: "Theme With Tests")
t.set_field(
target: :extra_js,
type: :js,
name: "discourse/connectors/below-footer/my-connector.gjs",
value: <<~JS,
import deprecated from "discourse-common/lib/deprecated";
function triggerDeprecation(){
deprecated("Fake deprecation message", { id: "fake-deprecation" })
}
export default <template>
{{triggerDeprecation}}
</template>
JS
)
t.save!
SiteSetting.default_theme_id = t.id
visit "/latest"
expect(page).to have_css("#global-notice-critical-deprecation")
end
end