mirror of
https://github.com/discourse/discourse.git
synced 2024-12-14 01:53:46 +08:00
8f1a5c9392
It's important to keep our core log output as clean as possible to avoid 'crying wolf', and so that any deprecations triggered by plugin/theme tests are indeed caused by that theme/plugin, and not core. This commit will make the core test suite fail if any deprecations are triggered. If a new deprecation is introduced (e.g. as part of a dependency update) and we need more time to resolve it it can be silenced via ember-deprecation-workflow. This does not affect plugin/theme test runs.
105 lines
3.6 KiB
JavaScript
105 lines
3.6 KiB
JavaScript
const handlers = [];
|
|
const disabledDeprecations = new Set();
|
|
const emberCliDeprecationWorkflows =
|
|
window.deprecationWorkflow?.config?.workflow;
|
|
|
|
/**
|
|
* Display a deprecation warning with the provided message. The warning will be prefixed with the theme/plugin name
|
|
* if it can be automatically determined based on the current stack.
|
|
* @param {String} msg The deprecation message
|
|
* @param {Object} [options] Deprecation options
|
|
* @param {String} [options.id] A unique identifier for this deprecation. This should be namespaced by dots (e.g. discourse.my_deprecation)
|
|
* @param {String} [options.since] The Discourse version this deprecation was introduced in
|
|
* @param {String} [options.dropFrom] The Discourse version this deprecation will be dropped in. Typically one major version after `since`
|
|
* @param {String} [options.url] A URL which provides more detail about the deprecation
|
|
* @param {boolean} [options.raiseError] Raise an error when this deprecation is triggered. Defaults to `false`
|
|
*/
|
|
export default function deprecated(msg, options = {}) {
|
|
const { id, since, dropFrom, url, raiseError } = options;
|
|
|
|
if (id && disabledDeprecations.has(id)) {
|
|
return;
|
|
}
|
|
|
|
msg = ["Deprecation notice:", msg];
|
|
if (since) {
|
|
msg.push(`[deprecated since Discourse ${since}]`);
|
|
}
|
|
if (dropFrom) {
|
|
msg.push(`[removal in Discourse ${dropFrom}]`);
|
|
}
|
|
if (id) {
|
|
msg.push(`[deprecation id: ${id}]`);
|
|
}
|
|
if (url) {
|
|
msg.push(`[info: ${url}]`);
|
|
}
|
|
msg = msg.join(" ");
|
|
|
|
let consolePrefix = "";
|
|
if (window.Discourse) {
|
|
// This module doesn't exist in pretty-text/wizard/etc.
|
|
consolePrefix =
|
|
require("discourse/lib/source-identifier").consolePrefix() || "";
|
|
}
|
|
|
|
handlers.forEach((h) => h(msg, options));
|
|
|
|
if (raiseError) {
|
|
throw msg;
|
|
}
|
|
|
|
const matchedWorkflow = emberCliDeprecationWorkflows?.find(
|
|
(w) => w.matchId === id
|
|
);
|
|
|
|
if (matchedWorkflow?.handler !== "silence") {
|
|
console.warn(...[consolePrefix, msg].filter(Boolean)); //eslint-disable-line no-console
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Register a function which will be called whenever a deprecation is triggered
|
|
* @param {function} callback The callback function. Arguments will match those of `deprecated()`.
|
|
*/
|
|
export function registerDeprecationHandler(callback) {
|
|
handlers.push(callback);
|
|
}
|
|
|
|
/**
|
|
* Silence one or more deprecations while running `callback`
|
|
* @param {(string|string[])} deprecationIds A single id, or an array of ids, of deprecations to silence
|
|
* @param {function} callback The function to call while deprecations are silenced.
|
|
*/
|
|
export function withSilencedDeprecations(deprecationIds, callback) {
|
|
const idArray = [].concat(deprecationIds);
|
|
try {
|
|
idArray.forEach((id) => disabledDeprecations.add(id));
|
|
const result = callback();
|
|
if (result instanceof Promise) {
|
|
throw new Error(
|
|
"withSilencedDeprecations callback returned a promise. Use withSilencedDeprecationsAsync instead."
|
|
);
|
|
}
|
|
return result;
|
|
} finally {
|
|
idArray.forEach((id) => disabledDeprecations.delete(id));
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Silence one or more deprecations while running an async `callback`
|
|
* @async
|
|
* @param {(string|string[])} deprecationIds A single id, or an array of ids, of deprecations to silence
|
|
* @param {function} callback The asynchronous function to call while deprecations are silenced.
|
|
*/
|
|
export async function withSilencedDeprecationsAsync(deprecationIds, callback) {
|
|
const idArray = [].concat(deprecationIds);
|
|
try {
|
|
idArray.forEach((id) => disabledDeprecations.add(id));
|
|
return await callback();
|
|
} finally {
|
|
idArray.forEach((id) => disabledDeprecations.delete(id));
|
|
}
|
|
}
|