mirror of
https://github.com/discourse/discourse.git
synced 2024-12-02 18:24:31 +08:00
8958b4f76a
Our custom implementation of `getOwner` includes a fallback which returns an owner, even if the passed object does not have one set. This is confusing and creates a false sense of security. Generally if the fallback is used, it means there is a problem with the patterns being used.
This commit renames our custom implementation to `getOwnerWithFallback`, while maintaining the old `getOwner` export with a deprecation notice. Core code is updated to use the official `@ember/application` implementation, or the new `getOwnerWithFallback` function.
This commit updates all core uses of `{ getOwner } from discourse-common/lib/get-owner` to use `getOwnerWithFallback`. Future commits will work through and convert many of these to use the official `@ember/application` implementation
67 lines
1.9 KiB
JavaScript
67 lines
1.9 KiB
JavaScript
import { getOwner as emberGetOwner, setOwner } from "@ember/application";
|
|
import deprecated from "discourse-common/lib/deprecated";
|
|
|
|
let _default = {};
|
|
|
|
/**
|
|
* Works similarly to { getOwner } from `@ember/application`, but has a fallback
|
|
* when the passed object doesn't have an owner.
|
|
*
|
|
* This exists for historical reasons. Ideally, any uses of it should be updated to use
|
|
* the official `@ember/application` implementation.
|
|
*/
|
|
export function getOwnerWithFallback(obj) {
|
|
if (emberGetOwner) {
|
|
return emberGetOwner(obj || _default) || emberGetOwner(_default);
|
|
}
|
|
|
|
return obj.container;
|
|
}
|
|
|
|
/**
|
|
* @deprecated use `getOwnerWithFallback` instead
|
|
*/
|
|
export function getOwner(obj) {
|
|
deprecated(
|
|
"Importing getOwner from `discourse-common/lib/get-owner` is deprecated. Use `import { getOwner } from '@ember/application'`, or if you still need the fallback shim, use `import { getOwnerWithFallback } from 'discourse-common/lib/get-owner';`.",
|
|
{ since: "3.2", id: "discourse.get-owner-with-fallback" }
|
|
);
|
|
return getOwnerWithFallback(obj);
|
|
}
|
|
|
|
export function setDefaultOwner(container) {
|
|
setOwner(_default, container);
|
|
}
|
|
|
|
// `this.container` is deprecated, but we can still build a container-like
|
|
// object for components to use
|
|
export function getRegister(obj) {
|
|
const owner = getOwnerWithFallback(obj);
|
|
const register = {
|
|
lookup: (...args) => owner.lookup(...args),
|
|
lookupFactory: (...args) => {
|
|
if (owner.factoryFor) {
|
|
return owner.factoryFor(...args);
|
|
} else if (owner._lookupFactory) {
|
|
return owner._lookupFactory(...args);
|
|
}
|
|
},
|
|
|
|
deprecateContainer(target) {
|
|
Object.defineProperty(target, "container", {
|
|
get() {
|
|
deprecated(
|
|
"Use `this.register` or `getOwner` instead of `this.container`",
|
|
{ id: "discourse.this-container" }
|
|
);
|
|
return register;
|
|
},
|
|
});
|
|
},
|
|
};
|
|
|
|
setOwner(register, owner);
|
|
|
|
return register;
|
|
}
|