DEV: Remove legacy resolver (#21263)

This commit is contained in:
Isaac Janzen 2023-04-26 13:39:15 -05:00 committed by GitHub
parent 7f803a0335
commit c6d44e504f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 0 additions and 376 deletions

View File

@ -1,343 +0,0 @@
import Ember from "ember";
import { classify, dasherize, decamelize } from "@ember/string";
import deprecated from "discourse-common/lib/deprecated";
import { findHelper } from "discourse-common/lib/helpers";
import { get } from "@ember/object";
import SuffixTrie from "discourse-common/lib/suffix-trie";
let _options = {};
let moduleSuffixTrie = null;
export function setResolverOption(name, value) {
_options[name] = value;
}
export function getResolverOption(name) {
return _options[name];
}
export function clearResolverOptions() {
_options = {};
}
function parseName(fullName) {
const nameParts = fullName.split(":");
const type = nameParts[0];
let fullNameWithoutType = nameParts[1];
const namespace = get(this, "namespace");
const root = namespace;
return {
fullName,
type,
fullNameWithoutType,
name: fullNameWithoutType,
root,
resolveMethodName: "resolve" + classify(type),
};
}
function lookupModuleBySuffix(suffix) {
if (!moduleSuffixTrie) {
moduleSuffixTrie = new SuffixTrie("/");
Object.keys(requirejs.entries).forEach((name) => {
if (!name.includes("/templates/")) {
moduleSuffixTrie.add(name);
}
});
}
return moduleSuffixTrie.withSuffix(suffix, 1)[0];
}
export function buildResolver(baseName) {
return Ember.DefaultResolver.extend({
parseName,
resolveRouter(parsedName) {
const routerPath = `${baseName}/router`;
if (requirejs.entries[routerPath]) {
const module = requirejs(routerPath, null, null, true);
return module.default;
}
return this._super(parsedName);
},
normalize(fullName) {
if (fullName === "app-events:main") {
deprecated(
"`app-events:main` has been replaced with `service:app-events`",
{
since: "2.4.0",
dropFrom: "2.9.0.beta1",
id: "discourse.app-events-main",
}
);
return "service:app-events";
}
for (const [key, value] of Object.entries({
"controller:discovery.categoryWithID": "controller:discovery.category",
"controller:discovery.parentCategory": "controller:discovery.category",
"controller:tags-show": "controller:tag-show",
"controller:tags.show": "controller:tag.show",
"controller:tagsShow": "controller:tagShow",
"route:discovery.categoryWithID": "route:discovery.category",
"route:discovery.parentCategory": "route:discovery.category",
"route:tags-show": "route:tag-show",
"route:tags.show": "route:tag.show",
"route:tagsShow": "route:tagShow",
})) {
if (fullName === key) {
deprecated(`${key} was replaced with ${value}`, {
since: "2.6.0",
id: "discourse.legacy-resolver-resolutions",
});
return value;
}
}
const split = fullName.split(":");
if (split.length > 1) {
const appBase = `${baseName}/${split[0]}s/`;
const adminBase = "admin/" + split[0] + "s/";
const wizardBase = "wizard/" + split[0] + "s/";
// Allow render 'admin/templates/xyz' too
split[1] = split[1].replace(".templates", "").replace("/templates", "");
// Try slashes
let dashed = dasherize(split[1].replace(/\./g, "/"));
if (
requirejs.entries[appBase + dashed] ||
requirejs.entries[adminBase + dashed] ||
requirejs.entries[wizardBase + dashed]
) {
return split[0] + ":" + dashed;
}
// Try with dashes instead of slashes
dashed = dasherize(split[1].replace(/\./g, "-"));
if (
requirejs.entries[appBase + dashed] ||
requirejs.entries[adminBase + dashed] ||
requirejs.entries[wizardBase + dashed]
) {
return split[0] + ":" + dashed;
}
}
return this._super(fullName);
},
customResolve(parsedName) {
// If we end with the name we want, use it. This allows us to define components within plugins.
const suffix = parsedName.type + "s/" + parsedName.fullNameWithoutType,
dashed = dasherize(suffix),
moduleName = lookupModuleBySuffix(dashed);
let module;
if (moduleName) {
module = requirejs(moduleName, null, null, true /* force sync */);
if (module && module["default"]) {
module = module["default"];
}
}
return module;
},
resolveWidget(parsedName) {
return this.customResolve(parsedName) || this._super(parsedName);
},
resolveAdapter(parsedName) {
return this.customResolve(parsedName) || this._super(parsedName);
},
resolveModel(parsedName) {
return this.customResolve(parsedName) || this._super(parsedName);
},
resolveView(parsedName) {
return this.customResolve(parsedName) || this._super(parsedName);
},
resolveHelper(parsedName) {
return (
findHelper(parsedName.fullNameWithoutType) ||
this.customResolve(parsedName) ||
this._super(parsedName)
);
},
resolveController(parsedName) {
return this.customResolve(parsedName) || this._super(parsedName);
},
resolveComponent(parsedName) {
return this.customResolve(parsedName) || this._super(parsedName);
},
resolveService(parsedName) {
return this.customResolve(parsedName) || this._super(parsedName);
},
resolveRawView(parsedName) {
return this.customResolve(parsedName) || this._super(parsedName);
},
resolveRoute(parsedName) {
if (parsedName.fullNameWithoutType === "basic") {
return requirejs("discourse/routes/discourse", null, null, true)
.default;
}
return this.customResolve(parsedName) || this._super(parsedName);
},
findLoadingTemplate(parsedName) {
if (parsedName.fullNameWithoutType.match(/loading$/)) {
return Ember.TEMPLATES.loading;
}
},
findConnectorTemplate(parsedName) {
const full = parsedName.fullNameWithoutType.replace("components/", "");
if (full.startsWith("connectors")) {
return Ember.TEMPLATES[`javascripts/${full}`];
}
},
resolveTemplate(parsedName) {
return (
this.findPluginMobileTemplate(parsedName) ||
this.findPluginTemplate(parsedName) ||
this.findMobileTemplate(parsedName) ||
this.findTemplate(parsedName) ||
this.findLoadingTemplate(parsedName) ||
this.findConnectorTemplate(parsedName) ||
Ember.TEMPLATES.not_found
);
},
findPluginTemplate(parsedName) {
const pluginParsedName = this.parseName(
parsedName.fullName.replace("template:", "template:javascripts/")
);
return this.findTemplate(pluginParsedName);
},
findPluginMobileTemplate(parsedName) {
if (_options.mobileView) {
let pluginParsedName = this.parseName(
parsedName.fullName.replace(
"template:",
"template:javascripts/mobile/"
)
);
return this.findTemplate(pluginParsedName);
}
},
findMobileTemplate(parsedName) {
if (_options.mobileView) {
let mobileParsedName = this.parseName(
parsedName.fullName.replace("template:", "template:mobile/")
);
return this.findTemplate(mobileParsedName);
}
},
findTemplate(parsedName) {
const withoutType = parsedName.fullNameWithoutType,
slashedType = withoutType.replace(/\./g, "/"),
decamelized = decamelize(withoutType),
dashed = decamelized.replace(/\./g, "-").replace(/\_/g, "-"),
templates = Ember.TEMPLATES;
return (
this._super(parsedName) ||
templates[slashedType] ||
templates[withoutType] ||
templates[withoutType.replace(/\.raw$/, "")] ||
templates[dashed] ||
templates[decamelized.replace(/\./, "/")] ||
templates[decamelized.replace(/\_/, "/")] ||
templates[`${baseName}/templates/${withoutType}`] ||
this.findAdminTemplate(parsedName) ||
this.findWizardTemplate(parsedName) ||
this.findUnderscoredTemplate(parsedName)
);
},
findUnderscoredTemplate(parsedName) {
let decamelized = decamelize(parsedName.fullNameWithoutType);
let underscored = decamelized.replace(/\-/g, "_");
return Ember.TEMPLATES[underscored];
},
// Try to find a template within a special admin namespace, e.g. adminEmail => admin/templates/email
// (similar to how discourse lays out templates)
findAdminTemplate(parsedName) {
let decamelized = decamelize(parsedName.fullNameWithoutType);
if (decamelized.startsWith("components")) {
let comPath = `admin/templates/${decamelized}`;
const compTemplate =
Ember.TEMPLATES[`javascripts/${comPath}`] || Ember.TEMPLATES[comPath];
if (compTemplate) {
return compTemplate;
}
}
if (decamelized === "javascripts/admin") {
return Ember.TEMPLATES["admin/templates/admin"];
}
if (
decamelized.startsWith("admin") ||
decamelized.startsWith("javascripts/admin")
) {
decamelized = decamelized.replace(/^admin\_/, "admin/templates/");
decamelized = decamelized.replace(/^admin\./, "admin/templates/");
decamelized = decamelized.replace(/\./g, "_");
const dashed = decamelized.replace(/_/g, "-");
return (
Ember.TEMPLATES[decamelized] ||
Ember.TEMPLATES[dashed] ||
Ember.TEMPLATES[dashed.replace("admin-", "admin/")]
);
}
},
findWizardTemplate(parsedName) {
let decamelized = decamelize(parsedName.fullNameWithoutType);
if (decamelized.startsWith("components")) {
let comPath = `wizard/templates/${decamelized}`;
const compTemplate =
Ember.TEMPLATES[`javascripts/${comPath}`] || Ember.TEMPLATES[comPath];
if (compTemplate) {
return compTemplate;
}
}
if (decamelized === "javascripts/wizard") {
return Ember.TEMPLATES["wizard/templates/wizard"];
}
if (
decamelized.startsWith("wizard") ||
decamelized.startsWith("javascripts/wizard")
) {
decamelized = decamelized.replace(/^wizard\_/, "wizard/templates/");
decamelized = decamelized.replace(/^wizard\./, "wizard/templates/");
decamelized = decamelized.replace(/\./g, "_");
const dashed = decamelized.replace(/_/g, "-");
return (
Ember.TEMPLATES[decamelized] ||
Ember.TEMPLATES[dashed] ||
Ember.TEMPLATES[dashed.replace("wizard-", "wizard/")]
);
}
},
});
}

View File

@ -3,7 +3,6 @@ import deprecated from "discourse-common/lib/deprecated";
import { findHelper } from "discourse-common/lib/helpers"; import { findHelper } from "discourse-common/lib/helpers";
import SuffixTrie from "discourse-common/lib/suffix-trie"; import SuffixTrie from "discourse-common/lib/suffix-trie";
import Resolver from "ember-resolver"; import Resolver from "ember-resolver";
import { buildResolver as buildLegacyResolver } from "discourse-common/lib/legacy-resolver";
import DiscourseTemplateMap from "discourse-common/lib/discourse-template-map"; import DiscourseTemplateMap from "discourse-common/lib/discourse-template-map";
let _options = {}; let _options = {};
@ -152,16 +151,7 @@ function lookupModuleBySuffix(suffix) {
} }
export function buildResolver(baseName) { export function buildResolver(baseName) {
let LegacyResolver = buildLegacyResolver(baseName);
return class extends Resolver { return class extends Resolver {
LegacyResolver = LegacyResolver;
init(props) {
super.init(props);
this.legacyResolver = this.LegacyResolver.create(props);
}
resolveRouter(/* parsedName */) { resolveRouter(/* parsedName */) {
const routerPath = `${baseName}/router`; const routerPath = `${baseName}/router`;
if (requirejs.entries[routerPath]) { if (requirejs.entries[routerPath]) {
@ -268,23 +258,6 @@ export function buildResolver(baseName) {
} }
} }
resolveOther(parsedName) {
let resolved = super.resolveOther(parsedName);
if (!resolved) {
let legacyParsedName = this.legacyResolver.parseName(
`${parsedName.type}:${parsedName.fullName}`
);
resolved = this.legacyResolver.resolveOther(legacyParsedName);
if (resolved) {
deprecated(
`Unable to resolve with new resolver, but resolved with legacy resolver: ${parsedName.fullName}`,
{ id: "discourse.legacy-resolver-fallback" }
);
}
}
return resolved;
}
resolveHelper(parsedName) { resolveHelper(parsedName) {
return findHelper(parsedName.fullNameWithoutType); return findHelper(parsedName.fullNameWithoutType);
} }

View File

@ -1,6 +1,5 @@
import Mobile from "discourse/lib/mobile"; import Mobile from "discourse/lib/mobile";
import { setResolverOption } from "discourse-common/resolver"; import { setResolverOption } from "discourse-common/resolver";
import { setResolverOption as setLegacyResolverOption } from "discourse-common/lib/legacy-resolver";
// Initializes the `Mobile` helper object. // Initializes the `Mobile` helper object.
export default { export default {
@ -16,6 +15,5 @@ export default {
site.set("isMobileDevice", Mobile.isMobileDevice); site.set("isMobileDevice", Mobile.isMobileDevice);
setResolverOption("mobileView", Mobile.mobileView); setResolverOption("mobileView", Mobile.mobileView);
setLegacyResolverOption("mobileView", Mobile.mobileView);
}, },
}; };

View File

@ -8,7 +8,5 @@ globalThis.deprecationWorkflow.config = {
{ handler: "silence", matchId: "routing.transition-methods" }, { handler: "silence", matchId: "routing.transition-methods" },
{ handler: "silence", matchId: "route-disconnect-outlet" }, { handler: "silence", matchId: "route-disconnect-outlet" },
{ handler: "silence", matchId: "this-property-fallback" }, { handler: "silence", matchId: "this-property-fallback" },
{ handler: "silence", matchId: "ember.globals-resolver" },
{ handler: "silence", matchId: "globals-resolver" },
], ],
}; };

View File

@ -47,7 +47,6 @@ import sinon from "sinon";
import siteFixtures from "discourse/tests/fixtures/site-fixtures"; import siteFixtures from "discourse/tests/fixtures/site-fixtures";
import { clearExtraKeyboardShortcutHelp } from "discourse/lib/keyboard-shortcuts"; import { clearExtraKeyboardShortcutHelp } from "discourse/lib/keyboard-shortcuts";
import { clearResolverOptions } from "discourse-common/resolver"; import { clearResolverOptions } from "discourse-common/resolver";
import { clearResolverOptions as clearLegacyResolverOptions } from "discourse-common/lib/legacy-resolver";
import { clearNavItems } from "discourse/models/nav-item"; import { clearNavItems } from "discourse/models/nav-item";
import { import {
cleanUpComposerUploadHandler, cleanUpComposerUploadHandler,
@ -206,7 +205,6 @@ export function testCleanup(container, app) {
clearBlockDecorateCallbacks(); clearBlockDecorateCallbacks();
clearTextDecorateCallbacks(); clearTextDecorateCallbacks();
clearResolverOptions(); clearResolverOptions();
clearLegacyResolverOptions();
clearTagsHtmlCallbacks(); clearTagsHtmlCallbacks();
clearToolbarCallbacks(); clearToolbarCallbacks();
resetSidebarSection(); resetSidebarSection();