A platform for community discussion. Free, open, simple.
DEV: Add plugin APIs for extending models (#41655)
Jarek Radosz8b0ac6242238
diff --git a/frontend/discourse/admin/models/admin-user.js b/frontend/discourse/admin/models/admin-user.jsindex 94852bc95b8..9fc5f1b2d0b 100644--- a/frontend/discourse/admin/models/admin-user.js+++ b/frontend/discourse/admin/models/admin-user.js@@ -4,6 +4,7 @@ import { popupAjaxError } from "discourse/lib/ajax-error";import getURL from "discourse/lib/get-url";import { deepEqual } from "discourse/lib/object";import { autoTrackedArray } from "discourse/lib/tracked-tools";+import { applyBehaviorTransformer } from "discourse/lib/transformer";import { userPath } from "discourse/lib/url";import User from "discourse/models/user";import { i18n } from "discourse-i18n";@@ -265,9 +266,14 @@ export default class AdminUser extends User {}unsuspend() {- return ajax(`/admin/users/${this.id}/unsuspend`, {- type: "PUT",- }).then((result) => this.setProperties(result.suspension));+ return applyBehaviorTransformer(+ "admin-user-unsuspend",+ () =>+ ajax(`/admin/users/${this.id}/unsuspend`, {+ type: "PUT",+ }).then((result) => this.setProperties(result.suspension)),+ { user: this }+ );}logOut() {@@ -298,20 +304,26 @@ export default class AdminUser extends User {}unsilence() {- this.set("silencingUser", true);-- return ajax(`/admin/users/${this.id}/unsilence`, {- type: "PUT",- })- .then((result) => {- this.setProperties({- silence_reason: result.unsilence.silence_reason,- full_silence_reason: result.unsilence.full_silence_reason,- silenced_at: result.unsilence.silence_at,- silenced_till: result.unsilence.silence_till,- });- })- .finally(() => this.set("silencingUser", false));+ return applyBehaviorTransformer(+ "admin-user-unsilence",+ () => {+ this.set("silencingUser", true);++ return ajax(`/admin/users/${this.id}/unsilence`, {+ type: "PUT",+ })+ .then((result) => {+ this.setProperties({+ silence_reason: result.unsilence.silence_reason,+ full_silence_reason: result.unsilence.full_silence_reason,+ silenced_at: result.unsilence.silence_at,+ silenced_till: result.unsilence.silence_till,+ });+ })+ .finally(() => this.set("silencingUser", false));+ },+ { user: this }+ );}silence(data) {diff --git a/frontend/discourse/admin/models/site-setting.js b/frontend/discourse/admin/models/site-setting.jsindex ea2efd440b5..ec58dfcffb4 100644--- a/frontend/discourse/admin/models/site-setting.js+++ b/frontend/discourse/admin/models/site-setting.js@@ -9,6 +9,7 @@ import {import SettingObjectHelper from "discourse/admin/lib/setting-object-helper";import { ajax } from "discourse/lib/ajax";import { bind } from "discourse/lib/decorators";+import { applyValueTransformer } from "discourse/lib/transformer";import { i18n } from "discourse-i18n";/**@@ -126,7 +127,11 @@ export default class SiteSetting extends EmberObject {@computed("settingObjectHelper.allowsNone")get allowsNone() {- return this.settingObjectHelper?.allowsNone;+ return applyValueTransformer(+ "site-setting-allows-none",+ this.settingObjectHelper?.allowsNone,+ { siteSetting: this }+ );}set allowsNone(value) {diff --git a/frontend/discourse/app/lib/model-extensions.js b/frontend/discourse/app/lib/model-extensions.jsnew file mode 100644index 00000000000..078d9e1fc45--- /dev/null+++ b/frontend/discourse/app/lib/model-extensions.js@@ -0,0 +1,227 @@+import { tracked } from "@glimmer/tracking";+import { dependentKeyCompat } from "@ember/object/compat";+import { trackedObject, trackedSet } from "@ember/reactive/collections";+import classPrepend from "discourse/lib/class-prepend";+import {+ autoTrackedArray,+ resettableTracked,+} from "discourse/lib/tracked-tools";++const FIELD_TYPES = ["array", "object", "set"];++// Lets an instance resolve its model name at construction, before the store+// assigns `__type`.+const MODEL_NAME = Symbol("model-extension-name");++const fields = new Map(); // modelName -> Map<name, { defaultValue, type }>+const saveProperties = new Map(); // modelName -> Map<name, valueFn | undefined>+const callbacks = new Map(); // modelName -> Map<event, Array<fn>>++const CALLBACK_EVENTS = [+ "init",+ "beforeCreate",+ "afterCreate",+ "beforeUpdate",+ "afterUpdate",+ "beforeDestroy",+ "afterDestroy",+];++const CALLBACK_ALIASES = {+ beforeSave: ["beforeCreate", "beforeUpdate"],+ afterSave: ["afterCreate", "afterUpdate"],+};++function getOrCreate(map, key, factory) {+ let value = map.get(key);+ if (value === undefined) {+ value = factory();+ map.set(key, value);+ }+ return value;+}++export function stampModelClass(klass, modelName) {+ klass[MODEL_NAME] ??= modelName;+}++export function modelNameFor(instance) {+ return instance?.constructor?.[MODEL_NAME];+}++// --- Fields (tracked data properties) ---++export function registerModelField(+ modelName,+ name,+ { defaultValue, type } = {}+) {+ if (type !== undefined && !FIELD_TYPES.includes(type)) {+ throw new Error(+ `Unknown model field type: \`${type}\` (expected one of ${FIELD_TYPES.join(+ ", "+ )})`+ );+ }++ getOrCreate(fields, modelName, () => new Map()).set(name, {+ defaultValue,+ type,+ });+}++// Registered field names for a model. Merge paths (e.g. `Post#updateFromPost`)+// need them: these per-instance fields are invisible to `enumerateTrackedKeys`.+export function modelFieldNames(modelName) {+ return [...(fields.get(modelName)?.keys() ?? [])];+}++export function clearModelFields(modelName) {+ fields.delete(modelName);+}++// Per-instance tracked property, seeded via `initializer` so the default is+// applied (`tracked()` ignores a `value` descriptor and rejects it in dev).+function defineTrackedField(instance, name, value) {+ Object.defineProperty(+ instance,+ name,+ tracked(instance, name, { enumerable: true, initializer: () => value })+ );+}++// Array variant, using `autoTrackedArray` so classic `@computed` chains observe+// mutations.+function defineTrackedArrayField(instance, name, value) {+ Object.defineProperty(+ instance,+ name,+ autoTrackedArray(instance, name, { initializer: () => value })+ );+}++// Defines each registered field as a tracked property on the instance. Runs in+// `RestModel`'s constructor, before the server payload, so a server value wins.+export function applyRegisteredFields(instance) {+ const modelFields = fields.get(modelNameFor(instance));+ if (!modelFields) {+ return;+ }++ for (const [name, { defaultValue, type }] of modelFields) {+ // Function defaults run per instance; a plain value is shared across+ // instances, so mutable defaults should use a function or a `type`.+ const value =+ typeof defaultValue === "function"+ ? defaultValue.call(instance)+ : defaultValue;++ if (type === "array") {+ defineTrackedArrayField(instance, name, value);+ } else if (type === "object") {+ defineTrackedField(instance, name, trackedObject(value));+ } else if (type === "set") {+ defineTrackedField(instance, name, trackedSet(value));+ } else {+ defineTrackedField(instance, name, value);+ }+ }+}++// --- Getters, methods, and resettable fields ---+// Applied via `classPrepend`: auto-rolled-back between tests, and cleanly+// stacked on the existing class.++// Prepends a subclass defining `name` on its prototype. `describe(prototype)`+// returns the descriptor (`resettableTracked` keys off the prototype).+function definePrototypeMember(klass, name, describe) {+ classPrepend(klass, (Superclass) => {+ const Subclass = class extends Superclass {};+ Object.defineProperty(Subclass.prototype, name, {+ configurable: true,+ ...describe(Subclass.prototype),+ });+ return Subclass;+ });+}++export function defineModelAccessor(klass, name, { get, set } = {}) {+ // `@dependentKeyCompat` keeps the getter observable by classic+ // `@computed`/`@observes` consumers, so it faithfully replaces a `@computed`+ // (matches how core decorates its own native getters).+ definePrototypeMember(klass, name, (prototype) =>+ dependentKeyCompat(prototype, name, { get, set })+ );+}++export function defineModelMethod(klass, name, fn) {+ definePrototypeMember(klass, name, () => ({ writable: true, value: fn }));+}++// The field resets to `initializer`'s value whenever that value changes, while+// a manual set sticks until the next change (see `resettableTracked`).+export function defineModelResettableField(klass, name, initializer) {+ definePrototypeMember(klass, name, (proto) =>+ resettableTracked(proto, name, { initializer })+ );+}++// --- Save properties (included in the persisted payload) ---++export function registerModelSaveProperty(modelName, name, valueFn) {+ getOrCreate(saveProperties, modelName, () => new Map()).set(name, valueFn);+}++// Save-payload additions for a model's registered save properties (a `valueFn`+// overrides the plain `instance[name]`). Used by models with a custom save path.+export function extraSavePropertiesFor(modelName, instance) {+ const result = {};+ const properties = saveProperties.get(modelName);+ if (properties) {+ for (const [name, valueFn] of properties) {+ result[name] = valueFn ? valueFn.call(instance) : instance[name];+ }+ }+ return result;+}++// Merges a model's registered save properties into `props` in place. Used by+// the generic `RestModel` save path.+export function mergeSaveProperties(modelName, instance, props) {+ Object.assign(props, extraSavePropertiesFor(modelName, instance));+}++// --- Lifecycle callbacks ---++export function registerModelCallback(modelName, event, fn) {+ const events = CALLBACK_ALIASES[event] ?? [event];++ for (const resolved of events) {+ if (!CALLBACK_EVENTS.includes(resolved)) {+ throw new Error(`Unknown model callback event: \`${event}\``);+ }+ }++ const byEvent = getOrCreate(callbacks, modelName, () => new Map());+ for (const resolved of events) {+ getOrCreate(byEvent, resolved, () => []).push(fn);+ }+}++// Runs callbacks synchronously in registration order, returning a promise that+// settles once async ones do, so save paths can `await` it (`init` ignores it).+export function applyModelCallbacks(modelName, event, instance, result) {+ const fns = callbacks.get(modelName)?.get(event);+ if (!fns) {+ return;+ }++ return Promise.all(fns.map((fn) => fn.call(instance, result)));+}++// USE ONLY FOR TESTING PURPOSES.+export function resetModelExtensions() {+ fields.clear();+ saveProperties.clear();+ callbacks.clear();+}diff --git a/frontend/discourse/app/lib/plugin-api.gjs b/frontend/discourse/app/lib/plugin-api.gjsindex 8c05006c389..9da3462409f 100644--- a/frontend/discourse/app/lib/plugin-api.gjs+++ b/frontend/discourse/app/lib/plugin-api.gjs@@ -74,6 +74,15 @@ import {registerHighlightJSPlugin,} from "discourse/lib/highlight-syntax";import { registerIconRenderer, replaceIcon } from "discourse/lib/icon-library";+import {+ defineModelAccessor,+ defineModelMethod,+ defineModelResettableField,+ registerModelCallback,+ registerModelField,+ registerModelSaveProperty,+ stampModelClass,+} from "discourse/lib/model-extensions";import { registerModelTransformer } from "discourse/lib/model-transformers";import { registerNotificationTypeRenderer } from "discourse/lib/notification-types-manager";import { registerOnBeforeCategoryTypesChange } from "discourse/lib/on-before-category-types-change";@@ -750,6 +759,212 @@ class _PluginApi {names.forEach((name) => _addTrackedTopicProperty(name));}+ // Resolves the `model:<name>` class; `stamp` marks it so instances can+ // resolve their model name at construction.+ _resolveModelClass(modelName, { stamp = false } = {}) {+ const klass = this._resolveClass(`model:${modelName}`);+ if (!klass) {+ return;+ }+ if (stamp) {+ stampModelClass(klass.class, modelName);+ }+ return klass.class;+ }++ /**+ * Adds a tracked data field to a store model, so a property your plugin adds+ * (e.g. one included in the server payload) is reactive in the UI.+ *+ * Must be called from a pre-initializer, before the model is first looked up.+ *+ * @param {string} modelName - The model's resolver name, e.g. "bookmark".+ * @param {string} name - The name of the field to add.+ * @param {Object} [options]+ * @param {(*|Function)} [options.defaultValue] - Value when the server omits+ * the field (default `undefined`). A function runs per instance at+ * construction — before the payload (server wins) and too early for create+ * args — for per-record mutable defaults, e.g. `() => ({})`.+ * @param {("array"|"object"|"set")} [options.type] - Store the field as a+ * reactive collection, created fresh per instance so it is never shared.+ * @param {boolean} [options.resettable] - Requires a function `defaultValue`;+ * resets to it when the derived value changes, and a manual assignment+ * sticks until then.+ *+ * @example+ * api.addModelField("bookmark", "is_pinned", { defaultValue: false });+ * api.addModelField("post", "comments", { type: "array" });+ * api.addModelField("post", "polls_votes", { type: "object" });+ * api.addModelField("post", "meta", { defaultValue: () => ({}) });+ * api.addModelField("composer", "createAsPostVoting", {+ * resettable: true,+ * defaultValue() {+ * return !!this.category?.create_as_post_voting_default;+ * },+ * });+ */+ addModelField(modelName, name, options = {}) {+ const klass = this._resolveModelClass(modelName, { stamp: true });+ if (!klass) {+ return;+ }++ if (options.resettable) {+ if (typeof options.defaultValue !== "function") {+ throw new Error(+ "addModelField: `resettable` requires `defaultValue` to be a function (the initializer to reset to)."+ );+ }+ defineModelResettableField(klass, name, options.defaultValue);+ } else {+ registerModelField(modelName, name, options);+ }+ }++ /**+ * Adds an accessor (getter and/or setter) to a store model.+ *+ * Defined on the prototype (works in templates and with autotracking). For a+ * single side, prefer `addModelGetter` / `addModelSetter`.+ *+ * Must be called from a pre-initializer, before the model is first looked up.+ *+ * @param {string} modelName - The model's resolver name, e.g. "bookmark".+ * @param {string} name - The name of the property to add.+ * @param {Object} accessor+ * @param {Function} [accessor.get] - Getter, called with the instance as `this`.+ * @param {Function} [accessor.set] - Setter, called with the new value.+ *+ * @example+ * api.addModelAccessor("post", "polls", {+ * get() {+ * return this._polls;+ * },+ * set(value) {+ * this._polls = value;+ * },+ * });+ */+ addModelAccessor(modelName, name, accessor) {+ const klass = this._resolveModelClass(modelName);+ if (klass) {+ defineModelAccessor(klass, name, accessor);+ }+ }++ /**+ * Adds a getter (computed/derived property) to a store model. Shorthand for+ * `addModelAccessor` with only a getter.+ *+ * Must be called from a pre-initializer, before the model is first looked up.+ *+ * @param {string} modelName - The model's resolver name, e.g. "bookmark".+ * @param {string} name - The name of the getter to add.+ * @param {Function} getter - Called with the model instance as `this`.+ *+ * @example+ * api.addModelGetter("bookmark", "isPinned", function () {+ * return this.is_pinned;+ * });+ */+ addModelGetter(modelName, name, getter) {+ this.addModelAccessor(modelName, name, { get: getter });+ }++ /**+ * Adds a setter to a store model. Shorthand for `addModelAccessor` with only a+ * setter.+ *+ * Must be called from a pre-initializer, before the model is first looked up.+ *+ * @param {string} modelName - The model's resolver name, e.g. "topic".+ * @param {string} name - The name of the setter to add.+ * @param {Function} setter - Called with the new value; the instance is `this`.+ *+ * @example+ * api.addModelSetter("topic", "related_topics", function (value) {+ * this._relatedTopicsRecords = value;+ * });+ */+ addModelSetter(modelName, name, setter) {+ this.addModelAccessor(modelName, name, { set: setter });+ }++ /**+ * Adds an instance method to a store model.+ *+ * Must be called from a pre-initializer, before the model is first looked up.+ *+ * @param {string} modelName - The model's resolver name, e.g. "bookmark".+ * @param {string} name - The name of the method to add.+ * @param {Function} fn - Called with the model instance as `this`.+ *+ * @example+ * api.addModelMethod("bookmark", "togglePin", function () {+ * this.is_pinned = !this.is_pinned;+ * });+ */+ addModelMethod(modelName, name, fn) {+ const klass = this._resolveModelClass(modelName);+ if (klass) {+ defineModelMethod(klass, name, fn);+ }+ }++ /**+ * Registers a property to include in a model's save payload.+ *+ * For persisting a field your plugin adds (see `addModelField`). By default+ * `instance[name]` is sent; pass `valueFn` (bound to the instance) to send a+ * computed value, e.g. to nest data under `custom_fields`.+ *+ * Must be called from a pre-initializer, before the model is first looked up.+ *+ * @param {string} modelName - The model's resolver name, e.g. "group".+ * @param {string} name - The name of the property to include when saving.+ * @param {Function} [valueFn] - Returns the value to send; called with the+ * model instance as `this`.+ *+ * @example+ * api.addModelSaveProperty("group", "assignable_level");+ * api.addModelSaveProperty("group", "custom_fields", function () {+ * return { my_field: this.my_field };+ * });+ */+ addModelSaveProperty(modelName, name, valueFn) {+ if (this._resolveModelClass(modelName, { stamp: true })) {+ registerModelSaveProperty(modelName, name, valueFn);+ }+ }++ /**+ * Registers a callback to run on a model's lifecycle.+ *+ * Runs with the model instance as `this`, replacing `modifyClass` overrides+ * of `init`/`save`. `init` fires per instance after create args are applied.+ * Create/update events fire on the standard store save path (and for `Group`,+ * which also fires destroy); other models with a custom `save()` (e.g.+ * `Category`) don't. `after*` callbacks returning a promise are awaited.+ *+ * Must be called from a pre-initializer, before the model is first looked up.+ *+ * @param {string} modelName - The model's resolver name, e.g. "bookmark".+ * @param {("init"|"beforeCreate"|"afterCreate"|"beforeUpdate"|"afterUpdate"|"beforeDestroy"|"afterDestroy"|"beforeSave"|"afterSave")} event -+ * The lifecycle event. "beforeSave"/"afterSave" fire for both create and update.+ * @param {Function} fn - Called with nothing (init/destroy), the request props+ * (before create/update), or the server result (after*).+ *+ * @example+ * api.addModelCallback("bookmark", "afterSave", function (result) {+ * // ...+ * });+ */+ addModelCallback(modelName, event, fn) {+ if (this._resolveModelClass(modelName, { stamp: true })) {+ registerModelCallback(modelName, event, fn);+ }+ }+/*** Decommissioned API**/diff --git a/frontend/discourse/app/lib/registry/transformers.js b/frontend/discourse/app/lib/registry/transformers.jsindex 6df4d8cff01..fec04d6d20e 100644--- a/frontend/discourse/app/lib/registry/transformers.js+++ b/frontend/discourse/app/lib/registry/transformers.js@@ -9,9 +9,13 @@*/// eslint-discourse keep-array-sortedexport const BEHAVIOR_TRANSFORMERS = Object.freeze([+ "admin-user-unsilence",+ "admin-user-unsuspend","apply-local-dates","category-visibility-change","composer-actions-on-select",+ "composer-apply-topic-template",+ "composer-open","composer-position:correct-scroll-position","composer-position:editor-touch-move","create-account",@@ -20,9 +24,11 @@ export const BEHAVIOR_TRANSFORMERS = Object.freeze(["full-page-search-load-more","post-menu-toggle-like-action","post-stream-error-loading",+ "post-stream-suggested-topics","post-stream-update-from-json","topic-controller:finished-editing","topic-list-item-click",+ "topic-update-from-json",]);/**@@ -46,10 +52,14 @@ export const VALUE_TRANSFORMERS = Object.freeze(["category-default-colors","category-description-text","category-display-name",+ "category-list-attributes",+ "category-list-request","category-sort-orders",+ "category-subcategories","category-text-color","category-visibility-private-locked","composer-actions-content",+ "composer-editing-post","composer-editor-quoted-post-avatar-template","composer-editor-reply-placeholder","composer-force-editor-mode",@@ -59,6 +69,7 @@ export const VALUE_TRANSFORMERS = Object.freeze(["composer-save-button-label","composer-service-cannot-submit-post","composer-toggles-class",+ "composer-user","create-topic-button-class","create-topic-button-draft-menu-class","create-topic-icon",@@ -70,6 +81,7 @@ export const VALUE_TRANSFORMERS = Object.freeze(["flag-description","flag-formatted-name","full-page-refresh-on-navigation",+ "group-members-request","hamburger-dropdown-click-outside-exceptions","header-notifications-avatar-size","home-logo-href",@@ -92,10 +104,12 @@ export const VALUE_TRANSFORMERS = Object.freeze(["post-avatar-class","post-avatar-size","post-avatar-template",+ "post-can-edit","post-class","post-event-listener","post-flag-available-flags","post-flag-title",+ "post-is-small-action","post-language-selector-priority","post-menu-buttons","post-menu-collapsed",@@ -115,8 +129,10 @@ export const VALUE_TRANSFORMERS = Object.freeze(["quote-params","route-to-url","sidebar-anonymous-default-categories",+ "site-setting-allows-none","small-user-attrs","tag-separator",+ "topic-escaped-excerpt","topic-list-class","topic-list-columns","topic-list-header-sortable-column",@@ -124,11 +140,15 @@ export const VALUE_TRANSFORMERS = Object.freeze(["topic-list-item-expand-pinned","topic-list-item-mobile-layout","topic-list-item-style",+ "topic-list-topics-from",+ "topic-reply-count","topic-show-footer-buttons","user-field-components","user-list-display-name","user-list-display-username",+ "user-location","user-menu-notification-item-acting-user-avatar","user-notes-modal-subtitle",+ "user-path","welcome-banner-display-for-route",]);diff --git a/frontend/discourse/app/models/category-list.js b/frontend/discourse/app/models/category-list.jsindex fbeda424aff..c79b78407e9 100644--- a/frontend/discourse/app/models/category-list.js+++ b/frontend/discourse/app/models/category-list.js@@ -6,6 +6,7 @@ import { number } from "discourse/lib/formatter";import LegacyArrayLikeObject from "discourse/lib/legacy-array-like-object";import PreloadStore from "discourse/lib/preload-store";import { autoTrackedArray } from "discourse/lib/tracked-tools";+import { applyValueTransformer } from "discourse/lib/transformer";import Site from "discourse/models/site";import Topic from "discourse/models/topic";import { i18n } from "discourse-i18n";@@ -131,18 +132,29 @@ export default class CategoryList extends LegacyArrayLikeObject {if (parentCategory) {data.parent_category_id = parentCategory.id;}- return ajax("/categories.json", { data });+ return ajax("/categories.json", {+ data: applyValueTransformer("category-list-request", data, {+ parentCategory,+ }),+ });});const categoryList = result?.category_list || {};- return CategoryList.create({- store,- categories: this.categoriesFrom(store, result, parentCategory).content,- parentCategory,- can_create_category: categoryList.can_create_category,- can_create_topic: categoryList.can_create_topic,- });+ return CategoryList.create(+ applyValueTransformer(+ "category-list-attributes",+ {+ store,+ categories: this.categoriesFrom(store, result, parentCategory)+ .content,+ parentCategory,+ can_create_category: categoryList.can_create_category,+ can_create_topic: categoryList.can_create_topic,+ },+ { result, parentCategory }+ )+ );}/**diff --git a/frontend/discourse/app/models/category.js b/frontend/discourse/app/models/category.jsindex 2d427973668..0656d84c111 100644--- a/frontend/discourse/app/models/category.js+++ b/frontend/discourse/app/models/category.js@@ -13,6 +13,10 @@ import {import { AUTO_GROUPS } from "discourse/lib/constants";import { getOwnerWithFallback } from "discourse/lib/get-owner";import getURL from "discourse/lib/get-url";+import {+ extraSavePropertiesFor,+ registerModelSaveProperty,+} from "discourse/lib/model-extensions";import { MultiCache } from "discourse/lib/multi-cache";import { NotificationLevels } from "discourse/lib/notification-levels";import { autoTrackedArray } from "discourse/lib/tracked-tools";@@ -25,20 +29,19 @@ import Topic from "./topic";const CATEGORY_ASYNC_SEARCH_CACHE = {};const CATEGORY_ASYNC_HIERARCHICAL_SEARCH_CACHE = {};-const pluginSaveProperties = new Set();let _uncategorized;/*** @internal- * Adds a tracked property to the post model.+ * Registers a property to include when saving a category.** Intended to be used only in the plugin API.*- * @param {string} propertyKey - The key of the property to track.+ * @param {string} propertyKey - The key of the property to include.*/export function _addCategoryPropertyForSave(propertyKey) {- pluginSaveProperties.add(propertyKey);+ registerModelSaveProperty("category", propertyKey);}export default class Category extends RestModel {@@ -557,7 +560,11 @@ export default class Category extends RestModel {}get subcategories() {- return this.site.categoriesByParentId.get(this.id) || [];+ return applyValueTransformer(+ "category-subcategories",+ this.site.categoriesByParentId.get(this.id) || [],+ { category: this }+ );}get unloadedSubcategoryCount() {@@ -872,10 +879,7 @@ export default class Category extends RestModel {}_pluginSaveProperties() {- return Array.from(pluginSaveProperties).reduce((obj, key) => {- obj[key] = this[key];- return obj;- }, {});+ return extraSavePropertiesFor("category", this);}_permissionsForUpdate() {diff --git a/frontend/discourse/app/models/composer.js b/frontend/discourse/app/models/composer.jsindex 5f2679bd7f8..7160e63c289 100644--- a/frontend/discourse/app/models/composer.js+++ b/frontend/discourse/app/models/composer.js@@ -14,7 +14,10 @@ import deprecated from "discourse/lib/deprecated";import { QUOTE_REGEXP } from "discourse/lib/quote";import { serializeTags } from "discourse/lib/serialize-tags";import { prioritizeNameFallback } from "discourse/lib/settings";-import { applyValueTransformer } from "discourse/lib/transformer";+import {+ applyBehaviorTransformer,+ applyValueTransformer,+} from "discourse/lib/transformer";import { emailValid, escapeExpression } from "discourse/lib/utilities";import Category from "discourse/models/category";import Draft from "discourse/models/draft";@@ -229,6 +232,19 @@ export default class Composer extends RestModel {@tracked _archetypesOverride;+ @tracked _user;++ @dependentKeyCompat+ get user() {+ return applyValueTransformer("composer-user", this._user, {+ composer: this,+ });+ }++ set user(value) {+ this._user = value;+ }+@computed("site.archetypes")get archetypes() {if (this._archetypesOverride !== undefined) {@@ -395,7 +411,9 @@ export default class Composer extends RestModel {@dependentKeyCompatget editingPost() {- return isEdit(this.get("action"));+ return applyValueTransformer("composer-editing-post", isEdit(this.action), {+ composer: this,+ });}@computed("category.minimumRequiredTags")@@ -903,29 +921,35 @@ export default class Composer extends RestModel {}applyTopicTemplate(oldCategoryId, categoryId) {- if (this.action !== CREATE_TOPIC) {- return;- }+ applyBehaviorTransformer(+ "composer-apply-topic-template",+ () => {+ if (this.action !== CREATE_TOPIC) {+ return;+ }- let reply = this.reply;+ let reply = this.reply;- // If the user didn't change the template, clear it- if (oldCategoryId) {- const oldCat = Category.findById(oldCategoryId);- if (oldCat && oldCat.topic_template === reply) {- reply = "";- }- }+ // If the user didn't change the template, clear it+ if (oldCategoryId) {+ const oldCat = Category.findById(oldCategoryId);+ if (oldCat && oldCat.topic_template === reply) {+ reply = "";+ }+ }- if (!isEmpty(reply)) {- return;- }+ if (!isEmpty(reply)) {+ return;+ }- const category = Category.findById(categoryId);- if (category) {- this.set("reply", category.topic_template || "");- this.set("originalText", category.topic_template || "");- }+ const category = Category.findById(categoryId);+ if (category) {+ this.set("reply", category.topic_template || "");+ this.set("originalText", category.topic_template || "");+ }+ },+ { composer: this, oldCategoryId, categoryId }+ );}/**@@ -953,12 +977,19 @@ export default class Composer extends RestModel {@param {String} [opts.title]**/open(opts) {- let promise = Promise.resolve();-if (!opts) {opts = {};}+ return applyBehaviorTransformer("composer-open", () => this._open(opts), {+ composer: this,+ opts,+ });+ }++ _open(opts) {+ let promise = Promise.resolve();+this.set("loading", true);if (diff --git a/frontend/discourse/app/models/group.js b/frontend/discourse/app/models/group.jsindex 190b6157e53..f83adf3b35e 100644--- a/frontend/discourse/app/models/group.js+++ b/frontend/discourse/app/models/group.js@@ -5,7 +5,12 @@ import { trackedArray } from "@ember/reactive/collections";import { isEmpty } from "@ember/utils";import { observes } from "@ember-decorators/object";import { ajax } from "discourse/lib/ajax";+import {+ applyModelCallbacks,+ extraSavePropertiesFor,+} from "discourse/lib/model-extensions";import { autoTrackedArray } from "discourse/lib/tracked-tools";+import { applyValueTransformer } from "discourse/lib/transformer";import Category from "discourse/models/category";import GroupHistory from "discourse/models/group-history";import RestModel from "discourse/models/rest";@@ -21,7 +26,8 @@ export default class Group extends RestModel {}static loadMembers(name, opts) {- return ajax(`/groups/${name}/members.json`, { data: opts });+ const data = applyValueTransformer("group-members-request", opts, { name });+ return ajax(`/groups/${name}/members.json`, { data });}static mentionable(name) {@@ -404,10 +410,12 @@ export default class Group extends RestModel {attrs["owner_usernames"] = this.ownerUsernames;}- return attrs;+ return { ...attrs, ...extraSavePropertiesFor("group", this) };}async create() {+ await applyModelCallbacks("group", "beforeCreate", this);+const response = await ajax("/admin/groups", {type: "POST",data: { group: this.asJSON() },@@ -420,20 +428,30 @@ export default class Group extends RestModel {});await this.reloadMembers();+ await applyModelCallbacks("group", "afterCreate", this, response);}- save(opts = {}) {- return ajax(`/groups/${this.id}`, {+ async save(opts = {}) {+ await applyModelCallbacks("group", "beforeUpdate", this, opts);++ const result = await ajax(`/groups/${this.id}`, {type: "PUT",data: { group: this.asJSON(), ...opts },});++ await applyModelCallbacks("group", "afterUpdate", this, result);+ return result;}- destroy() {+ async destroy() {if (!this.id) {return;}- return ajax(`/admin/groups/${this.id}`, { type: "DELETE" });++ await applyModelCallbacks("group", "beforeDestroy", this);+ const result = await ajax(`/admin/groups/${this.id}`, { type: "DELETE" });+ await applyModelCallbacks("group", "afterDestroy", this, result);+ return result;}findLogs(offset, filters) {diff --git a/frontend/discourse/app/models/post-stream.js b/frontend/discourse/app/models/post-stream.jsindex f3e9fadbf44..b2da640c178 100644--- a/frontend/discourse/app/models/post-stream.js+++ b/frontend/discourse/app/models/post-stream.js@@ -1346,13 +1346,19 @@ export default class PostStream extends RestModel {}_setSuggestedTopics(result) {- if (!result.suggested_topics) {- return;- }+ applyBehaviorTransformer(+ "post-stream-suggested-topics",+ () => {+ if (!result.suggested_topics) {+ return;+ }- this.topic.setProperties({- suggested_topics: result.suggested_topics,- suggested_group_name: result.suggested_group_name,- });+ this.topic.setProperties({+ suggested_topics: result.suggested_topics,+ suggested_group_name: result.suggested_group_name,+ });+ },+ { postStream: this, result }+ );}}diff --git a/frontend/discourse/app/models/post.js b/frontend/discourse/app/models/post.jsindex dcc16a5d576..4dc1f5c55fa 100644--- a/frontend/discourse/app/models/post.js+++ b/frontend/discourse/app/models/post.js@@ -7,13 +7,17 @@ import { Promise } from "rsvp";import { resolveShareUrl } from "discourse/helpers/share-url";import { ajax } from "discourse/lib/ajax";import { popupAjaxError } from "discourse/lib/ajax-error";+import {+ clearModelFields,+ modelFieldNames,+ registerModelField,+ stampModelClass,+} from "discourse/lib/model-extensions";import { deepEqual } from "discourse/lib/object";import { cook } from "discourse/lib/text";import { fancyTitle } from "discourse/lib/topic-fancy-title";-import {- defineTrackedProperty,- enumerateTrackedKeys,-} from "discourse/lib/tracked-tools";+import { enumerateTrackedKeys } from "discourse/lib/tracked-tools";+import { applyValueTransformer } from "discourse/lib/transformer";import { userPath } from "discourse/lib/url";import { postUrl } from "discourse/lib/utilities";import ActionSummary from "discourse/models/action-summary";@@ -24,8 +28,6 @@ import Site from "discourse/models/site";import User from "discourse/models/user";import { i18n } from "discourse-i18n";-const pluginTrackedProperties = new Set();-/*** @internal* Adds a tracked property to the post model.@@ -35,7 +37,8 @@ const pluginTrackedProperties = new Set();* @param {string} propertyKey - The key of the property to track.*/export function _addTrackedPostProperty(propertyKey) {- pluginTrackedProperties.add(propertyKey);+ stampModelClass(Post, "post");+ registerModelField("post", propertyKey);}/**@@ -44,7 +47,7 @@ export function _addTrackedPostProperty(propertyKey) {* USE ONLY FOR TESTING PURPOSES.*/export function clearAddedTrackedPostProperties() {- pluginTrackedProperties.clear();+ clearModelFields("post");}export default class Post extends RestModel {@@ -143,7 +146,6 @@ export default class Post extends RestModel {@tracked badges_granted;@tracked bookmarked;@tracked can_delete;- @tracked can_edit;@tracked can_permanently_delete;@tracked can_recover;@tracked can_see_hidden_post;@@ -201,20 +203,23 @@ export default class Post extends RestModel {@tracked via_email;@tracked wiki;@tracked yours;+ @tracked _can_edit;// for compatibility with existing code// mark fist post as deleted if topic was deleted// post is either highlighted as deleted or hidden/removed from the post stream// post or content still can be recovered- constructor() {- super(...arguments);-- // adds tracked properties defined by plugin to the instance- pluginTrackedProperties.forEach((propertyKey) => {- defineTrackedProperty(this, propertyKey);+ @dependentKeyCompat+ get can_edit() {+ return applyValueTransformer("post-can-edit", this._can_edit, {+ post: this,});}+ set can_edit(value) {+ this._can_edit = value;+ }+@dependentKeyCompatget canEdit() {return this.can_edit;@@ -454,9 +459,11 @@ export default class Post extends RestModel {}get isSmallAction() {- return (+ return applyValueTransformer(+ "post-is-small-action",this.post_type === this.site.post_types.small_action ||- this.action_code === "split_topic"+ this.action_code === "split_topic",+ { post: this });}@@ -678,7 +685,7 @@ export default class Post extends RestModel {[...Object.keys(otherPost),...enumerateTrackedKeys(otherPost),- ...pluginTrackedProperties,+ ...modelFieldNames("post"),].forEach((key) => {let value = otherPost[key],oldValue = this[key];diff --git a/frontend/discourse/app/models/rest.js b/frontend/discourse/app/models/rest.jsindex 9ffafd1765e..c5a7eb38600 100644--- a/frontend/discourse/app/models/rest.js+++ b/frontend/discourse/app/models/rest.js@@ -5,8 +5,18 @@ import { dependentKeyCompat } from "@ember/object/compat";import { getOwner, setOwner } from "@ember/owner";import { Promise } from "rsvp";import { getOwnerWithFallback } from "discourse/lib/get-owner";+import {+ applyModelCallbacks,+ applyRegisteredFields,+ mergeSaveProperties,+ modelNameFor,+} from "discourse/lib/model-extensions";import { enumerateTrackedEntries } from "discourse/lib/tracked-tools";+function waitForCallbacks(pending, next) {+ return pending ? pending.then(next) : next();+}+export default class RestModel extends EmberObject {// Overwrite and JSON will be passed through here before `create` and `update`static munge(json) {@@ -38,6 +48,22 @@ export default class RestModel extends EmberObject {primaryKey = "id";@tracked __state;+ constructor() {+ super(...arguments);++ // Defines plugin-registered fields as tracked properties, before the server+ // payload is assigned. See `addModelField`.+ applyRegisteredFields(this);+ }++ init() {+ super.init(...arguments);++ // Fires `init` callbacks after the create args are assigned, so they see+ // the initial state. See `addModelCallback`.+ applyModelCallbacks(modelNameFor(this), "init", this);+ }+@dependentKeyCompatget isNew() {return this.__state === "new";@@ -61,11 +87,16 @@ export default class RestModel extends EmberObject {props = props || this.updateProperties();+ const modelName = modelNameFor(this);+ mergeSaveProperties(modelName, this, props);+this.beforeUpdate(props);this.set("isSaving", true);- return this.store- .update(this.__type, this.get(this.primaryKey), props)+ return waitForCallbacks(+ applyModelCallbacks(modelName, "beforeUpdate", this, props),+ () => this.store.update(this.__type, this.get(this.primaryKey), props)+ ).then((res) => {const payload = this.__munge(res.payload || res.responseJson);@@ -78,8 +109,13 @@ export default class RestModel extends EmberObject {this.setProperties(payload);this.afterUpdate(res);- res.target = this;- return res;+ return waitForCallbacks(+ applyModelCallbacks(modelName, "afterUpdate", this, res),+ () => {+ res.target = this;+ return res;+ }+ );}).finally(() => this.set("isSaving", false));}@@ -91,13 +127,18 @@ export default class RestModel extends EmberObject {props = props || this.createProperties();+ const modelName = modelNameFor(this);+ mergeSaveProperties(modelName, this, props);+this.beforeCreate(props);const adapter = this.store.adapterFor(this.__type);this.set("isSaving", true);- return adapter- .createRecord(this.store, this.__type, props)+ return waitForCallbacks(+ applyModelCallbacks(modelName, "beforeCreate", this, props),+ () => adapter.createRecord(this.store, this.__type, props)+ ).then((res) => {if (!res) {throw new Error("Received no data back from createRecord");@@ -111,8 +152,13 @@ export default class RestModel extends EmberObject {}this.afterCreate(res);- res.target = this;- return res;+ return waitForCallbacks(+ applyModelCallbacks(modelName, "afterCreate", this, res),+ () => {+ res.target = this;+ return res;+ }+ );}).finally(() => this.set("isSaving", false));}diff --git a/frontend/discourse/app/models/topic-list.js b/frontend/discourse/app/models/topic-list.jsindex 3186bc0c8f2..8a28997654e 100644--- a/frontend/discourse/app/models/topic-list.js+++ b/frontend/discourse/app/models/topic-list.js@@ -8,6 +8,7 @@ import { removeValuesFromArray } from "discourse/lib/array-tools";import deprecated from "discourse/lib/deprecated";import { getOwnerWithFallback } from "discourse/lib/get-owner";import { autoTrackedArray } from "discourse/lib/tracked-tools";+import { applyValueTransformer } from "discourse/lib/transformer";import RestModel from "discourse/models/rest";import Site from "discourse/models/site";import User from "discourse/models/user";@@ -63,7 +64,7 @@ export default class TopicList extends RestModel {});}- return result.topic_list[listKey].map((t) => {+ const topics = result.topic_list[listKey].map((t) => {t.posters.forEach((p) => {p.user = users[p.user_id];p.extraClasses = p.extras;@@ -83,6 +84,12 @@ export default class TopicList extends RestModel {return store.createRecord("topic", t);});++ return applyValueTransformer("topic-list-topics-from", topics, {+ store,+ result,+ opts,+ });}static munge(json, store) {diff --git a/frontend/discourse/app/models/topic.js b/frontend/discourse/app/models/topic.jsindex 1bb403e578c..0d158f48d81 100644--- a/frontend/discourse/app/models/topic.js+++ b/frontend/discourse/app/models/topic.js@@ -12,16 +12,22 @@ import { TOPIC_VISIBILITY_REASONS } from "discourse/lib/constants";import deprecated from "discourse/lib/deprecated";import { longDate } from "discourse/lib/formatter";import getURL from "discourse/lib/get-url";+import {+ clearModelFields,+ registerModelField,+ stampModelClass,+} from "discourse/lib/model-extensions";import { applyModelTransformations } from "discourse/lib/model-transformers";import { deepEqual, deepMerge } from "discourse/lib/object";import PreloadStore from "discourse/lib/preload-store";import { serializeTags } from "discourse/lib/serialize-tags";import { emojiUnescape } from "discourse/lib/text";import { fancyTitle } from "discourse/lib/topic-fancy-title";+import { autoTrackedArray } from "discourse/lib/tracked-tools";import {- autoTrackedArray,- defineTrackedProperty,-} from "discourse/lib/tracked-tools";+ applyBehaviorTransformer,+ applyValueTransformer,+} from "discourse/lib/transformer";import DiscourseURL, { userPath } from "discourse/lib/url";import ActionSummary from "discourse/models/action-summary";import Bookmark from "discourse/models/bookmark";@@ -32,14 +38,13 @@ import { flushMap } from "discourse/services/store";import { i18n } from "discourse-i18n";import Category from "./category";-const pluginTrackedProperties = new Set();-export function _addTrackedTopicProperty(propertyKey) {- pluginTrackedProperties.add(propertyKey);+ stampModelClass(Topic, "topic");+ registerModelField("topic", propertyKey);}export function clearAddedTrackedTopicProperties() {- pluginTrackedProperties.clear();+ clearModelFields("topic");}export function loadTopicView(topic, args) {@@ -354,14 +359,6 @@ export default class Topic extends RestModel {topic: this,});- constructor() {- super(...arguments);-- pluginTrackedProperties.forEach((propertyKey) => {- defineTrackedProperty(this, propertyKey);- });- }-@computed("lastPoster.user")get lastPosterUser() {return this.lastPoster?.user;@@ -586,7 +583,9 @@ export default class Topic extends RestModel {@computed("posts_count")get replyCount() {- return this.posts_count - 1;+ return applyValueTransformer("topic-reply-count", this.posts_count - 1, {+ topic: this,+ });}get details() {@@ -946,29 +945,35 @@ export default class Topic extends RestModel {// Update our attributes from a JSON resultupdateFromJson(json) {- const keys = Object.keys(json);- if (!json.view_hidden) {- this.details.updateFromJson(json.details);-- removeValuesFromArray(keys, ["details", "post_stream"]);-- if (json.published_page) {- this.set(- "publishedPage",- this.store.createRecord("published-page", json.published_page)- );- }- }- keys.forEach((key) => this.set(key, json[key]));+ return applyBehaviorTransformer(+ "topic-update-from-json",+ () => {+ const keys = Object.keys(json);+ if (!json.view_hidden) {+ this.details.updateFromJson(json.details);++ removeValuesFromArray(keys, ["details", "post_stream"]);++ if (json.published_page) {+ this.set(+ "publishedPage",+ this.store.createRecord("published-page", json.published_page)+ );+ }+ }+ keys.forEach((key) => this.set(key, json[key]));- if (this.bookmarks.length) {- this.set(- "bookmarks",- this.bookmarks.map((bm) => Bookmark.create(bm))- );- }+ if (this.bookmarks.length) {+ this.set(+ "bookmarks",+ this.bookmarks.map((bm) => Bookmark.create(bm))+ );+ }- return this;+ return this;+ },+ { topic: this, json }+ );}reload(opts = {}) {@@ -1015,7 +1020,11 @@ export default class Topic extends RestModel {@computed("excerpt")get escapedExcerpt() {- return emojiUnescape(this.excerpt);+ return applyValueTransformer(+ "topic-escaped-excerpt",+ emojiUnescape(this.excerpt),+ { topic: this }+ );}@computed("excerpt")diff --git a/frontend/discourse/app/models/user.js b/frontend/discourse/app/models/user.jsindex 868c2af160d..62326b61802 100644--- a/frontend/discourse/app/models/user.js+++ b/frontend/discourse/app/models/user.js@@ -34,7 +34,10 @@ import PreloadStore from "discourse/lib/preload-store";import singleton from "discourse/lib/singleton";import { emojiUnescape } from "discourse/lib/text";import { autoTrackedArray } from "discourse/lib/tracked-tools";-import { applyBehaviorTransformer } from "discourse/lib/transformer";+import {+ applyBehaviorTransformer,+ applyValueTransformer,+} from "discourse/lib/transformer";import { userPath } from "discourse/lib/url";import { defaultHomepage, escapeExpression } from "discourse/lib/utilities";import Badge from "discourse/models/badge";@@ -259,6 +262,8 @@ export default class User extends RestModel.extend(Evented) {statusManager = new UserStatusManager(this);+ @tracked _location;+@computed("private_messages_stats.all")get hasPMs() {return this.private_messages_stats?.all > 0;@@ -322,6 +327,17 @@ export default class User extends RestModel.extend(Evented) {this.sidebar_sections = value;}+ @dependentKeyCompat+ get location() {+ return applyValueTransformer("user-location", this._location, {+ user: this,+ });+ }++ set location(value) {+ this._location = value;+ }+@computed("[email protected]")get sidebarTagNames() {return this.sidebarTags?.map?.((item) => item.name) ?? [];@@ -454,7 +470,9 @@ export default class User extends RestModel.extend(Evented) {@computed()get path() {// no need to observe, requires a hard refresh to update- return userPath(this.username_lower);+ return applyValueTransformer("user-path", userPath(this.username_lower), {+ user: this,+ });}@computed()diff --git a/frontend/discourse/tests/helpers/qunit-helpers.js b/frontend/discourse/tests/helpers/qunit-helpers.jsindex d6a5552f972..3056e9fecb5 100644--- a/frontend/discourse/tests/helpers/qunit-helpers.js+++ b/frontend/discourse/tests/helpers/qunit-helpers.js@@ -55,6 +55,7 @@ import { cleanUpHashtagTypeClasses } from "discourse/lib/hashtag-type-registry";import { reset as resetLinkLookup } from "discourse/lib/link-lookup";import { resetMentions } from "discourse/lib/link-mentions";import { forceMobile, resetMobile } from "discourse/lib/mobile";+import { resetModelExtensions } from "discourse/lib/model-extensions";import { resetModelTransformers } from "discourse/lib/model-transformers";import { resetNotificationTypeRenderers } from "discourse/lib/notification-types-manager";import { cloneJSON, deepMerge } from "discourse/lib/object";@@ -261,6 +262,7 @@ export function testCleanup(container, app) {resetItemSelectCallbacks();resetUserMenuTabs();resetLinkLookup();+ resetModelExtensions();resetModelTransformers();resetMentions();resetProsemirrorEngine();diff --git a/frontend/discourse/tests/unit/lib/model-extensions-test.js b/frontend/discourse/tests/unit/lib/model-extensions-test.jsnew file mode 100644index 00000000000..5765aef5a9b--- /dev/null+++ b/frontend/discourse/tests/unit/lib/model-extensions-test.js@@ -0,0 +1,477 @@+import { addObserver } from "@ember/object/observers";+import { getOwner } from "@ember/owner";+import { settled } from "@ember/test-helpers";+import { setupTest } from "ember-qunit";+import { module, test } from "qunit";+import RestAdapter from "discourse/adapters/rest";+import { rollbackAllPrepends } from "discourse/lib/class-prepend";+import {+ applyModelCallbacks,+ modelFieldNames,+ registerModelCallback,+ registerModelField,+ resetModelExtensions,+} from "discourse/lib/model-extensions";+import { withPluginApi } from "discourse/lib/plugin-api";+import { isTrackedArray } from "discourse/lib/tracked-tools";+import RestModel from "discourse/models/rest";++let capturedCreateProps;+let capturedUpdateProps;++class TestExtensionModel extends RestModel {+ createProperties() {+ return { name: this.name };+ }++ updateProperties() {+ return { name: this.name };+ }+}++class TestExtensionAdapter extends RestAdapter {+ createRecord(store, type, props) {+ // Snapshot so a callback that mutates `props` after the request fires+ // can't retroactively change what we captured.+ capturedCreateProps = { ...props };+ return Promise.resolve({ payload: { id: 1, ...props } });+ }++ update(store, type, id, props) {+ capturedUpdateProps = { ...props };+ return Promise.resolve({ payload: { id, ...props } });+ }+}++module("Unit | Lib | model-extensions", function (hooks) {+ setupTest(hooks);++ hooks.beforeEach(function () {+ capturedCreateProps = undefined;+ capturedUpdateProps = undefined;++ const owner = getOwner(this);+ owner.register("model:test-extension-model", TestExtensionModel);+ owner.register("adapter:test-extension-model", TestExtensionAdapter);+ this.store = owner.lookup("service:store");+ });++ hooks.afterEach(function () {+ rollbackAllPrepends();+ resetModelExtensions();+ });++ test("addModelField uses the default until a server value overrides it", function (assert) {+ withPluginApi((api) =>+ api.addModelField("test-extension-model", "rank", { defaultValue: 5 })+ );++ const record = this.store.createRecord("test-extension-model", {+ name: "a",+ });+ assert.strictEqual(record.rank, 5, "falls back to the default");++ record.rank = 9;+ assert.strictEqual(record.rank, 9, "the field is writable and tracked");++ const fromServer = this.store.createRecord("test-extension-model", {+ name: "b",+ rank: 7,+ });+ assert.strictEqual(fromServer.rank, 7, "a server value wins");+ });++ test("addModelField type array gives per-instance tracked arrays", function (assert) {+ withPluginApi((api) =>+ api.addModelField("test-extension-model", "tags", {+ type: "array",+ defaultValue: [],+ })+ );++ const a = this.store.createRecord("test-extension-model", { name: "a" });+ const b = this.store.createRecord("test-extension-model", { name: "b" });++ assert.true(isTrackedArray(a.tags), "the default is a tracked array");++ a.tags.push("x");+ assert.deepEqual([...a.tags], ["x"]);+ assert.deepEqual([...b.tags], [], "each record gets its own array");++ a.tags = ["y", "z"];+ assert.true(isTrackedArray(a.tags), "an assigned plain array is coerced");+ assert.deepEqual([...a.tags], ["y", "z"]);+ });++ test("addModelField type array coerces a server-provided array", function (assert) {+ withPluginApi((api) =>+ api.addModelField("test-extension-model", "tags", { type: "array" })+ );++ const record = this.store.createRecord("test-extension-model", {+ name: "a",+ tags: ["p", "q"],+ });++ assert.true(isTrackedArray(record.tags));+ assert.deepEqual([...record.tags], ["p", "q"]);+ });++ test("addModelField type object gives a per-instance tracked object", function (assert) {+ withPluginApi((api) =>+ api.addModelField("test-extension-model", "bag", { type: "object" })+ );++ const a = this.store.createRecord("test-extension-model", { name: "a" });+ const b = this.store.createRecord("test-extension-model", { name: "b" });++ assert.notStrictEqual(a.bag, b.bag, "each record gets its own object");+ a.bag.x = 1;+ assert.strictEqual(b.bag.x, undefined, "mutations do not leak");+ });++ test("addModelField type set gives a per-instance tracked set", function (assert) {+ withPluginApi((api) =>+ api.addModelField("test-extension-model", "seen", { type: "set" })+ );++ const a = this.store.createRecord("test-extension-model", { name: "a" });+ const b = this.store.createRecord("test-extension-model", { name: "b" });++ a.seen.add("x");+ assert.true(a.seen.has("x"));+ assert.false(b.seen.has("x"), "mutations do not leak");+ });++ test("addModelField rejects an unknown type", function (assert) {+ assert.throws(+ () =>+ withPluginApi((api) =>+ api.addModelField("test-extension-model", "bad", { type: "bogus" })+ ),+ /Unknown model field type/+ );+ });++ test("addModelField function defaultValue runs per instance", function (assert) {+ withPluginApi((api) =>+ api.addModelField("test-extension-model", "bag", {+ defaultValue: () => ({}),+ })+ );++ const a = this.store.createRecord("test-extension-model", { name: "a" });+ const b = this.store.createRecord("test-extension-model", { name: "b" });++ assert.notStrictEqual(a.bag, b.bag, "each record gets its own object");+ a.bag.x = 1;+ assert.strictEqual(b.bag.x, undefined, "mutations do not leak");+ });++ test("addModelField function defaultValue is a fallback the server payload overrides", function (assert) {+ withPluginApi((api) =>+ api.addModelField("test-extension-model", "rank", {+ defaultValue: () => 5,+ })+ );++ const withoutValue = this.store.createRecord("test-extension-model", {+ name: "a",+ });+ assert.strictEqual(withoutValue.rank, 5, "used when the server omits it");++ const withValue = this.store.createRecord("test-extension-model", {+ name: "b",+ rank: 9,+ });+ assert.strictEqual(withValue.rank, 9, "a server value wins");+ });++ test("addModelField resettable resets to the initializer when it changes", function (assert) {+ withPluginApi((api) =>+ api.addModelField("test-extension-model", "derivedName", {+ resettable: true,+ defaultValue() {+ return this.name;+ },+ })+ );++ const record = this.store.createRecord("test-extension-model", {+ name: "a",+ });+ assert.strictEqual(record.derivedName, "a", "derives from the instance");++ record.derivedName = "manual";+ assert.strictEqual(+ record.derivedName,+ "manual",+ "a manual set sticks while the derived value is unchanged"+ );++ record.name = "b";+ assert.strictEqual(+ record.derivedName,+ "b",+ "resets to the new derived value, discarding the manual set"+ );+ });++ test("addModelField resettable requires a function defaultValue", function (assert) {+ assert.throws(+ () =>+ withPluginApi((api) =>+ api.addModelField("test-extension-model", "bad", {+ resettable: true,+ defaultValue: 5,+ })+ ),+ /`resettable` requires `defaultValue` to be a function/+ );+ });++ test("addModelSetter adds a setter-only accessor", function (assert) {+ withPluginApi((api) =>+ api.addModelSetter("test-extension-model", "shout", function (value) {+ this.name = value.toLowerCase();+ })+ );++ const record = this.store.createRecord("test-extension-model", {+ name: "x",+ });+ record.shout = "HELLO";+ assert.strictEqual(record.name, "hello");+ });++ test("addModelAccessor adds a property with a getter and a setter", function (assert) {+ withPluginApi((api) =>+ api.addModelAccessor("test-extension-model", "upperName", {+ get() {+ return this.name?.toUpperCase();+ },+ set(value) {+ this.name = value.toLowerCase();+ },+ })+ );++ const record = this.store.createRecord("test-extension-model", {+ name: "abc",+ });+ assert.strictEqual(record.upperName, "ABC", "the getter derives a value");++ record.upperName = "XYZ";+ assert.strictEqual(record.name, "xyz", "the setter runs");+ assert.strictEqual(record.upperName, "XYZ");+ });++ test("addModelGetter adds a getter-only derived property", function (assert) {+ withPluginApi((api) =>+ api.addModelGetter("test-extension-model", "upperName", function () {+ return this.name?.toUpperCase();+ })+ );++ const record = this.store.createRecord("test-extension-model", {+ name: "abc",+ });+ assert.strictEqual(record.upperName, "ABC");+ });++ test("addModelGetter is observable by classic observers (dependentKeyCompat)", async function (assert) {+ withPluginApi((api) => {+ api.addModelField("test-extension-model", "count", { defaultValue: 1 });+ api.addModelGetter("test-extension-model", "doubled", function () {+ return this.count * 2;+ });+ });++ const record = this.store.createRecord("test-extension-model", {+ name: "a",+ });+ assert.strictEqual(record.doubled, 2, "derives from the tracked field");++ // eslint-disable-next-line ember/no-observers -- verifies classic-observer interop+ addObserver(record, "doubled", () => assert.step("changed"));+ record.count = 5;+ await settled();++ assert.verifySteps(["changed"], "a classic observer fires on change");+ assert.strictEqual(record.doubled, 10);+ });++ test("addModelMethod adds an instance method", function (assert) {+ withPluginApi((api) =>+ api.addModelMethod("test-extension-model", "shout", function () {+ return `${this.name}!`;+ })+ );++ const record = this.store.createRecord("test-extension-model", {+ name: "hi",+ });+ assert.strictEqual(record.shout(), "hi!");+ });++ test("addModelSaveProperty includes the property in the save payload", async function (assert) {+ withPluginApi((api) => {+ api.addModelField("test-extension-model", "rank", { defaultValue: 0 });+ api.addModelSaveProperty("test-extension-model", "rank");+ });++ const record = this.store.createRecord("test-extension-model", {+ name: "a",+ rank: 7,+ });+ await record.save();++ assert.strictEqual(capturedCreateProps.rank, 7, "merged into the payload");+ assert.strictEqual(+ capturedCreateProps.name,+ "a",+ "keeps default properties"+ );+ });++ test("addModelSaveProperty accepts a value function", async function (assert) {+ withPluginApi((api) => {+ api.addModelSaveProperty(+ "test-extension-model",+ "custom_fields",+ function () {+ return { derived: this.name };+ }+ );+ });++ const record = this.store.createRecord("test-extension-model", {+ name: "a",+ });+ await record.save();++ assert.deepEqual(+ capturedCreateProps.custom_fields,+ { derived: "a" },+ "the computed value is merged into the payload"+ );+ });++ test("addModelCallback fires around the persistence lifecycle", async function (assert) {+ withPluginApi((api) => {+ api.addModelCallback("test-extension-model", "afterCreate", () =>+ assert.step("create")+ );+ api.addModelCallback("test-extension-model", "afterUpdate", () =>+ assert.step("update")+ );+ });++ const record = this.store.createRecord("test-extension-model", {+ name: "a",+ });++ await record.save();+ assert.verifySteps(["create"], "afterCreate fires on create");++ await record.save();+ assert.verifySteps(["update"], "afterUpdate fires on a subsequent save");+ assert.strictEqual(capturedUpdateProps.name, "a");+ });++ test("an async before callback settles before the request fires", async function (assert) {+ withPluginApi((api) => {+ api.addModelCallback(+ "test-extension-model",+ "beforeCreate",+ async function (props) {+ await Promise.resolve();+ props.stamped = "create";+ }+ );+ api.addModelCallback(+ "test-extension-model",+ "beforeUpdate",+ async function (props) {+ await Promise.resolve();+ props.stamped = "update";+ }+ );+ });++ const record = this.store.createRecord("test-extension-model", {+ name: "a",+ });++ await record.save();+ assert.strictEqual(+ capturedCreateProps.stamped,+ "create",+ "the create request waits for the async beforeCreate hook"+ );++ await record.save();+ assert.strictEqual(+ capturedUpdateProps.stamped,+ "update",+ "the update request waits for the async beforeUpdate hook"+ );+ });++ test("addModelCallback init fires after the create args are applied", function (assert) {+ const seen = [];+ withPluginApi((api) =>+ api.addModelCallback("test-extension-model", "init", function () {+ seen.push(this.name);+ })+ );++ this.store.createRecord("test-extension-model", { name: "a" });+ assert.deepEqual(seen, ["a"], "runs once, with the assigned args visible");+ });++ test("registerModelCallback expands the afterSave alias", function (assert) {+ registerModelCallback("widget", "afterSave", () =>+ assert.step("afterSave")+ );++ applyModelCallbacks("widget", "afterCreate", {}, {});+ applyModelCallbacks("widget", "afterUpdate", {}, {});++ assert.verifySteps(+ ["afterSave", "afterSave"],+ "runs for both create and update"+ );+ });++ test("registerModelCallback rejects unknown events", function (assert) {+ assert.throws(+ () => registerModelCallback("widget", "bogus", () => {}),+ /Unknown model callback event/+ );+ });++ test("applyModelCallbacks awaits async callbacks", async function (assert) {+ const steps = [];+ registerModelCallback("widget", "afterDestroy", async () => {+ await Promise.resolve();+ steps.push("callback");+ });++ await applyModelCallbacks("widget", "afterDestroy", {}, {});+ steps.push("after");++ assert.deepEqual(+ steps,+ ["callback", "after"],+ "the returned promise settles once async callbacks resolve"+ );+ });++ test("modelFieldNames returns the registered field names", function (assert) {+ registerModelField("widget", "a");+ registerModelField("widget", "b");++ assert.deepEqual(modelFieldNames("widget"), ["a", "b"]);+ });+});diff --git a/plugins/discourse-ai/assets/javascripts/discourse/initializers/related-topics.gjs b/plugins/discourse-ai/assets/javascripts/discourse/initializers/related-topics.gjsindex 14780f182d3..543e5c98fbb 100644--- a/plugins/discourse-ai/assets/javascripts/discourse/initializers/related-topics.gjs+++ b/plugins/discourse-ai/assets/javascripts/discourse/initializers/related-topics.gjs@@ -1,4 +1,3 @@-import { tracked } from "@glimmer/tracking";import BasicTopicList from "discourse/components/basic-topic-list";import { withPluginApi } from "discourse/lib/plugin-api";import dIcon from "discourse/ui-kit/helpers/d-icon";@@ -42,39 +41,33 @@ export default {condition: ({ topic }) => topic.relatedTopics?.length,});- api.modifyClass(- "model:topic",- (Superclass) =>- class extends Superclass {- @tracked _relatedTopicsRecords = null;+ api.addModelField("topic", "_relatedTopicsRecords", {+ defaultValue: null,+ });- // Only updates if we have data - preserves cache when scrolling.- set related_topics(value) {- if (value?.length) {- this._relatedTopicsRecords = value.map((topic) =>- this.store.createRecord("topic", topic)- );- }- }+ // Only updates if we have data - preserves cache when scrolling.+ api.addModelSetter("topic", "related_topics", function (value) {+ if (value?.length) {+ this._relatedTopicsRecords = value.map((topic) =>+ this.store.createRecord("topic", topic)+ );+ }+ });- get relatedTopics() {- return this._relatedTopicsRecords;- }- }- );+ api.addModelGetter("topic", "relatedTopics", function () {+ return this._relatedTopicsRecords;+ });- api.modifyClass(- "model:post-stream",- (Superclass) =>- class extends Superclass {- _setSuggestedTopics(result) {- super._setSuggestedTopics(...arguments);+ api.registerBehaviorTransformer(+ "post-stream-suggested-topics",+ ({ context, next }) => {+ next();- if (result.related_topics) {- this.topic.related_topics = result.related_topics;- }- }+ if (context.result.related_topics) {+ context.postStream.topic.related_topics =+ context.result.related_topics;}+ });});},diff --git a/plugins/discourse-assign/assets/javascripts/discourse/initializers/extend-for-assigns.js b/plugins/discourse-assign/assets/javascripts/discourse/initializers/extend-for-assigns.jsindex 3dc0b1eae47..f8b0acb3554 100644--- a/plugins/discourse-assign/assets/javascripts/discourse/initializers/extend-for-assigns.js+++ b/plugins/discourse-assign/assets/javascripts/discourse/initializers/extend-for-assigns.js@@ -1,4 +1,3 @@-import { computed } from "@ember/object";import { getOwner } from "@ember/owner";import { trustHTML } from "@ember/template";import getURL from "discourse/lib/get-url";@@ -322,21 +321,12 @@ function initialize(api) {: {});- api.modifyClass(- "model:bookmark",- (Superclass) =>- class extends Superclass {- @computed("assigned_to_user")- get assignedToUserPath() {- return assignedToUserPath(this.assigned_to_user);- }-- @computed("assigned_to_group")- get assignedToGroupPath() {- return assignedToGroupPath(this.assigned_to_group);- }- }- );+ api.addModelGetter("bookmark", "assignedToUserPath", function () {+ return assignedToUserPath(this.assigned_to_user);+ });+ api.addModelGetter("bookmark", "assignedToGroupPath", function () {+ return assignedToGroupPath(this.assigned_to_group);+ });api.modifyClass("component:topic-notifications-button",@@ -448,17 +438,7 @@ function initialize(api) {return result;});- api.modifyClass(- "model:group",- (Superclass) =>- class extends Superclass {- asJSON() {- return Object.assign({}, super.asJSON(...arguments), {- assignable_level: this.assignable_level,- });- }- }- );+ api.addModelSaveProperty("group", "assignable_level");api.modifyClass("controller:topic",@@ -549,26 +529,12 @@ function customizePost(api, siteSettings) {"can_assign");- api.modifyClass(- "model:post",- (Superclass) =>- class extends Superclass {- get can_edit() {- return isAssignSmallAction(this.action_code) ? true : super.can_edit;- }-- // overriding tracked properties requires overriding both the getter and the setter.- // otherwise the superclass will throw an error when the application sets the field value- set can_edit(value) {- super.can_edit = value;- }+ api.registerValueTransformer("post-can-edit", ({ value, context }) =>+ isAssignSmallAction(context.post.action_code) ? true : value+ );- get isSmallAction() {- return isAssignSmallAction(this.action_code)- ? true- : super.isSmallAction;- }- }+ api.registerValueTransformer("post-is-small-action", ({ value, context }) =>+ isAssignSmallAction(context.post.action_code) ? true : value);api.renderAfterWrapperOutlet(diff --git a/plugins/discourse-assign/assets/javascripts/discourse/models/topic.js b/plugins/discourse-assign/assets/javascripts/discourse/models/topic.jsindex bb0aceade0e..d449e8a0309 100644--- a/plugins/discourse-assign/assets/javascripts/discourse/models/topic.js+++ b/plugins/discourse-assign/assets/javascripts/discourse/models/topic.js@@ -1,85 +1,74 @@-import { tracked } from "@glimmer/tracking";import { Assignment } from "./assignment";export function extendTopicModel(api) {- api.modifyClass(- "model:topic",- (Superclass) =>- class extends Superclass {- @tracked assigned_to_group;- @tracked assigned_to_group_id;- @tracked assigned_to_user;- @tracked assigned_to_user_id;- @tracked assignment_note;- @tracked assignment_status;- @tracked can_assign;- @tracked indirectly_assigned_to;+ api.addModelField("topic", "assigned_to_group");+ api.addModelField("topic", "assigned_to_group_id");+ api.addModelField("topic", "assigned_to_user");+ api.addModelField("topic", "assigned_to_user_id");+ api.addModelField("topic", "assignment_note");+ api.addModelField("topic", "assignment_status");+ api.addModelField("topic", "can_assign");+ api.addModelField("topic", "indirectly_assigned_to");- assignees() {- const result = [];+ api.addModelMethod("topic", "assignees", function () {+ const result = [];- if (this.assigned_to_user) {- result.push(this.assigned_to_user);- }+ if (this.assigned_to_user) {+ result.push(this.assigned_to_user);+ }- const postAssignees = this.assignedPosts().map((p) => p.assigned_to);- result.push(...postAssignees);- return result;- }+ const postAssignees = this.assignedPosts().map((p) => p.assigned_to);+ result.push(...postAssignees);+ return result;+ });- uniqueAssignees() {- const map = new Map();- this.assignees().forEach((user) => map.set(user.username, user));- return [...map.values()];- }+ api.addModelMethod("topic", "uniqueAssignees", function () {+ const map = new Map();+ this.assignees().forEach((user) => map.set(user.username, user));+ return [...map.values()];+ });- assignedPosts() {- if (!this.indirectly_assigned_to) {- return [];- }+ api.addModelMethod("topic", "assignedPosts", function () {+ if (!this.indirectly_assigned_to) {+ return [];+ }- return Object.entries(this.indirectly_assigned_to).map(- ([key, value]) => {- value.postId = key;- return value;- }- );- }+ return Object.entries(this.indirectly_assigned_to).map(([key, value]) => {+ value.postId = key;+ return value;+ });+ });- assignments() {- return [this.topicAssignment(), ...this.postAssignments()].filter(- (item) => item != null- );- }+ api.addModelMethod("topic", "assignments", function () {+ return [this.topicAssignment(), ...this.postAssignments()].filter(+ (item) => item != null+ );+ });- postAssignments() {- if (!this.indirectly_assigned_to) {- return [];- }+ api.addModelMethod("topic", "postAssignments", function () {+ if (!this.indirectly_assigned_to) {+ return [];+ }- return Object.entries(this.indirectly_assigned_to).map(- ([key, value]) => {- value.postId = key;- return Assignment.fromPost(value);- }- );- }+ return Object.entries(this.indirectly_assigned_to).map(([key, value]) => {+ value.postId = key;+ return Assignment.fromPost(value);+ });+ });- topicAssignment() {- return Assignment.fromTopic(this);- }+ api.addModelMethod("topic", "topicAssignment", function () {+ return Assignment.fromTopic(this);+ });- isAssigned() {- return this.assigned_to_user || this.assigned_to_group;- }+ api.addModelMethod("topic", "isAssigned", function () {+ return this.assigned_to_user || this.assigned_to_group;+ });- isAssignedTo(user) {- return this.assigned_to_user?.username === user.username;- }+ api.addModelMethod("topic", "isAssignedTo", function (user) {+ return this.assigned_to_user?.username === user.username;+ });- hasAssignedPosts() {- return !!this.postAssignments().length;- }- }- );+ api.addModelMethod("topic", "hasAssignedPosts", function () {+ return !!this.postAssignments().length;+ });}diff --git a/plugins/discourse-policy/assets/javascripts/discourse/initializers/extend-for-policy.gjs b/plugins/discourse-policy/assets/javascripts/discourse/initializers/extend-for-policy.gjsindex 301ad2cf311..a7e071f2d96 100644--- a/plugins/discourse-policy/assets/javascripts/discourse/initializers/extend-for-policy.gjs+++ b/plugins/discourse-policy/assets/javascripts/discourse/initializers/extend-for-policy.gjs@@ -1,6 +1,5 @@import EmberObject from "@ember/object";import { withPluginApi } from "discourse/lib/plugin-api";-import { autoTrackedArray } from "discourse/lib/tracked-tools";import { escapeExpression } from "discourse/lib/utilities";import { i18n } from "discourse-i18n";import PostPolicy from "../components/post-policy";@@ -96,14 +95,14 @@ export default {"policy_revoked");- api.modifyClass(- "model:post",- (Superclass) =>- class extends Superclass {- @autoTrackedArray policy_accepted_by = [];- @autoTrackedArray policy_not_accepted_by = [];- }- );+ api.addModelField("post", "policy_accepted_by", {+ type: "array",+ defaultValue: [],+ });+ api.addModelField("post", "policy_not_accepted_by", {+ type: "array",+ defaultValue: [],+ });api.decorateCookedElement(attachPolicy, {onlyStream: false,diff --git a/plugins/discourse-post-voting/assets/javascripts/discourse/initializers/extend-composer-actions.js b/plugins/discourse-post-voting/assets/javascripts/discourse/initializers/extend-composer-actions.jsindex 5bf5bd65b07..052b9d06b1e 100644--- a/plugins/discourse-post-voting/assets/javascripts/discourse/initializers/extend-composer-actions.js+++ b/plugins/discourse-post-voting/assets/javascripts/discourse/initializers/extend-composer-actions.js@@ -1,5 +1,3 @@-/* eslint-disable ember/no-observers */-import { observer } from "@ember/object";import { withPluginApi } from "discourse/lib/plugin-api";import { CREATE_TOPIC } from "discourse/models/composer";import { i18n } from "discourse-i18n";@@ -143,33 +141,32 @@ export default {});- api.modifyClass("model:composer", {- pluginId: "discourse-post-voting",-- categoryCreateAsPostVotingDefault: observer("categoryId", function () {- const createAsPostVoting =- this.category?.create_as_post_voting_default;-- const onlyPostVotingInThisCategory =- this.category?.only_post_voting_in_this_category;-- if (this.creatingTopic && onlyPostVotingInThisCategory) {- this.set("createAsPostVoting", true);- this.set(- "onlyPostVotingInThisCategory",- onlyPostVotingInThisCategory- );- this.notifyPropertyChange("replyOptions");- this.notifyPropertyChange("action");- } else if (+ // Purely derived from the category.+ api.addModelGetter(+ "composer",+ "onlyPostVotingInThisCategory",+ function () {+ return (this.creatingTopic &&- createAsPostVoting !== this.createAsPostVoting- ) {- this.set("createAsPostVoting", createAsPostVoting);- this.notifyPropertyChange("replyOptions");- this.notifyPropertyChange("action");+ !!this.category?.only_post_voting_in_this_category+ );+ }+ );++ // Defaults from the category (forced on when it's post-voting-only),+ // resets on category change, and is user-toggleable until then.+ api.addModelField("composer", "createAsPostVoting", {+ resettable: true,+ defaultValue() {+ if (!this.creatingTopic) {+ return false;}- }),++ return (+ this.onlyPostVotingInThisCategory ||+ !!this.category?.create_as_post_voting_default+ );+ },});});},diff --git a/plugins/discourse-post-voting/assets/javascripts/discourse/initializers/post-voting-edits.gjs b/plugins/discourse-post-voting/assets/javascripts/discourse/initializers/post-voting-edits.gjsindex 28403ff0489..d0e051c46c3 100644--- a/plugins/discourse-post-voting/assets/javascripts/discourse/initializers/post-voting-edits.gjs+++ b/plugins/discourse-post-voting/assets/javascripts/discourse/initializers/post-voting-edits.gjs@@ -1,7 +1,6 @@import Component from "@glimmer/component";import routeAction from "discourse/helpers/route-action";import { withPluginApi } from "discourse/lib/plugin-api";-import { autoTrackedArray } from "discourse/lib/tracked-tools";import PostVotingAnswerButton from "../components/post-voting-answer-button";import PostVotingAnswerHeader, {ORDER_BY_ACTIVITY_FILTER,@@ -36,13 +35,7 @@ function initPlugin(api, container) {}function customizePost(api) {- api.modifyClass(- "model:post",- (Superclass) =>- class extends Superclass {- @autoTrackedArray comments;- }- );+ api.addModelField("post", "comments", { type: "array" });api.addTrackedPostProperties("comments_count",@@ -51,22 +44,16 @@ function customizePost(api) {"post_voting_vote_count");- api.modifyClass(- "model:post-stream",- (Superclass) =>- class extends Superclass {- orderStreamByActivity() {- this.cancelFilter();- this.set("filter", ORDER_BY_ACTIVITY_FILTER);- return this.refresh({ refreshInPlace: true });- }+ api.addModelMethod("post-stream", "orderStreamByActivity", function () {+ this.cancelFilter();+ this.set("filter", ORDER_BY_ACTIVITY_FILTER);+ return this.refresh({ refreshInPlace: true });+ });- orderStreamByVotes() {- this.cancelFilter();- return this.refresh({ refreshInPlace: true });- }- }- );+ api.addModelMethod("post-stream", "orderStreamByVotes", function () {+ this.cancelFilter();+ return this.refresh({ refreshInPlace: true });+ });api.renderAfterWrapperOutlet("post-avatar",diff --git a/plugins/discourse-topic-voting/assets/javascripts/discourse/pre-initializers/extend-category-for-voting.js b/plugins/discourse-topic-voting/assets/javascripts/discourse/pre-initializers/extend-category-for-voting.jsindex 1ea05df800b..4c78e260bc8 100644--- a/plugins/discourse-topic-voting/assets/javascripts/discourse/pre-initializers/extend-category-for-voting.js+++ b/plugins/discourse-topic-voting/assets/javascripts/discourse/pre-initializers/extend-category-for-voting.js@@ -1,4 +1,3 @@-import { tracked } from "@glimmer/tracking";import { computed, get } from "@ember/object";import { withPluginApi } from "discourse/lib/plugin-api";import Category from "discourse/models/category";@@ -46,23 +45,11 @@ function extendCategory(api) {{ priority: -100 });- api.modifyClass(- "model:topic",- (Superclass) =>- class extends Superclass {- @tracked vote_count;- @tracked user_voted;- }- );- api.modifyClass(- "model:user",- (Superclass) =>- class extends Superclass {- @tracked votes_exceeded;- @tracked vote_limit;- @tracked votes_left;- }- );+ api.addModelField("topic", "vote_count");+ api.addModelField("topic", "user_voted");+ api.addModelField("user", "votes_exceeded");+ api.addModelField("user", "vote_limit");+ api.addModelField("user", "votes_left");}export default {diff --git a/plugins/poll/assets/javascripts/discourse/initializers/extend-for-poll.gjs b/plugins/poll/assets/javascripts/discourse/initializers/extend-for-poll.gjsindex 286d586030d..d111b1eab1f 100644--- a/plugins/poll/assets/javascripts/discourse/initializers/extend-for-poll.gjs+++ b/plugins/poll/assets/javascripts/discourse/initializers/extend-for-poll.gjs@@ -1,4 +1,3 @@-import { tracked } from "@glimmer/tracking";import EmberObject from "@ember/object";import { trackedObject } from "@ember/reactive/collections";import { bind } from "discourse/lib/decorators";@@ -88,32 +87,27 @@ function initializePolls(api) {});- api.modifyClass(- "model:post",- (Superclass) =>- class extends Superclass {- @tracked polls_votes = trackedObject();- @tracked pollsObject = trackedObject();- @tracked _polls;-- get polls() {- return this._polls;- }-- set polls(value) {- this._polls = value;- this._refreshPollsObject();- }+ api.addModelField("post", "polls_votes", { type: "object" });+ api.addModelField("post", "pollsObject", { type: "object" });+ api.addModelField("post", "_polls");++ api.addModelAccessor("post", "polls", {+ get() {+ return this._polls;+ },+ set(value) {+ this._polls = value;+ this._refreshPollsObject();+ },+ });- _refreshPollsObject() {- for (const rawPoll of this.polls) {- const name = rawPoll.name;- this.pollsObject[name] ||= trackedObject();- Object.assign(this.pollsObject[name], rawPoll);- }- }- }- );+ api.addModelMethod("post", "_refreshPollsObject", function () {+ for (const rawPoll of this.polls) {+ const name = rawPoll.name;+ this.pollsObject[name] ||= trackedObject();+ Object.assign(this.pollsObject[name], rawPoll);+ }+ });api.decorateCookedElement(attachPolls, { onlyStream: true });