Skip to content

A platform for community discussion. Free, open, simple.

DEV: Vendor `BufferedProxy` into core (#43510)

David Taylorbc501c2164e5
diff --git a/frontend/discourse/admin/controllers/admin-customize-robots-txt.js b/frontend/discourse/admin/controllers/admin-customize-robots-txt.js
index c99a3dd2a0d..95962437120 100644
--- a/frontend/discourse/admin/controllers/admin-customize-robots-txt.js
+++ b/frontend/discourse/admin/controllers/admin-customize-robots-txt.js
@@ -2,8 +2,8 @@ import { cached, tracked } from "@glimmer/tracking";
import Controller from "@ember/controller";
import { action, computed } from "@ember/object";
import { dependentKeyCompat } from "@ember/object/compat";
-import BufferedProxy from "ember-buffered-proxy/proxy";
import { ajax } from "discourse/lib/ajax";
+import BufferedProxy from "discourse/lib/buffered-proxy";
import { deepEqual } from "discourse/lib/object";
export default class AdminCustomizeRobotsTxtController extends Controller {
diff --git a/frontend/discourse/admin/controllers/admin-email-templates/edit.js b/frontend/discourse/admin/controllers/admin-email-templates/edit.js
index e10ee057107..54b6465ff4d 100644
--- a/frontend/discourse/admin/controllers/admin-email-templates/edit.js
+++ b/frontend/discourse/admin/controllers/admin-email-templates/edit.js
@@ -3,9 +3,9 @@ import Controller, { inject as controller } from "@ember/controller";
import { action, computed } from "@ember/object";
import { dependentKeyCompat } from "@ember/object/compat";
import { service } from "@ember/service";
-import BufferedProxy from "ember-buffered-proxy/proxy";
import { interpolationKeysWithStatus as computeInterpolationKeysWithStatus } from "discourse/admin/lib/interpolation-keys";
import { popupAjaxError } from "discourse/lib/ajax-error";
+import BufferedProxy from "discourse/lib/buffered-proxy";
import { isObject } from "discourse/lib/object";
import { i18n } from "discourse-i18n";
diff --git a/frontend/discourse/admin/controllers/admin-site-text/edit.js b/frontend/discourse/admin/controllers/admin-site-text/edit.js
index 690b6393fc2..40766f781ef 100644
--- a/frontend/discourse/admin/controllers/admin-site-text/edit.js
+++ b/frontend/discourse/admin/controllers/admin-site-text/edit.js
@@ -3,9 +3,9 @@ import Controller from "@ember/controller";
import { action, computed } from "@ember/object";
import { dependentKeyCompat } from "@ember/object/compat";
import { service } from "@ember/service";
-import BufferedProxy from "ember-buffered-proxy/proxy";
import { interpolationKeysWithStatus as computeInterpolationKeysWithStatus } from "discourse/admin/lib/interpolation-keys";
import { popupAjaxError } from "discourse/lib/ajax-error";
+import BufferedProxy from "discourse/lib/buffered-proxy";
import { i18n } from "discourse-i18n";
export default class AdminSiteTextEdit extends Controller {
diff --git a/frontend/discourse/admin/models/site-setting.js b/frontend/discourse/admin/models/site-setting.js
index 9307134ec76..d57fa59b1f4 100644
--- a/frontend/discourse/admin/models/site-setting.js
+++ b/frontend/discourse/admin/models/site-setting.js
@@ -1,13 +1,13 @@
import { tracked } from "@glimmer/tracking";
import EmberObject, { computed, set } from "@ember/object";
import { trustHTML } from "@ember/template";
-import BufferedProxy from "ember-buffered-proxy/proxy";
import {
DEFAULT_USER_PREFERENCES,
SITE_SETTING_REQUIRES_CONFIRMATION_TYPES,
} from "discourse/admin/lib/constants";
import SettingObjectHelper from "discourse/admin/lib/setting-object-helper";
import { ajax } from "discourse/lib/ajax";
+import BufferedProxy from "discourse/lib/buffered-proxy";
import { bind } from "discourse/lib/decorators";
import { applyValueTransformer } from "discourse/lib/transformer";
import { i18n } from "discourse-i18n";
@@ -86,7 +86,9 @@ export default class SiteSetting extends EmberObject {
constructor() {
super(...arguments);
- this.buffered = BufferedProxy.create({ content: this });
+ this.buffered = /** @type {BufferedProxy} */ (
+ BufferedProxy.create({ content: this })
+ );
}
@computed("settingObjectHelper.overridden")
diff --git a/frontend/discourse/app/components/tag-groups-form.gjs b/frontend/discourse/app/components/tag-groups-form.gjs
index c172c6ea31b..9f2436938b6 100644
--- a/frontend/discourse/app/components/tag-groups-form.gjs
+++ b/frontend/discourse/app/components/tag-groups-form.gjs
@@ -5,8 +5,8 @@ import { action, computed } from "@ember/object";
import { service } from "@ember/service";
import { isEmpty } from "@ember/utils";
import { tagName } from "@ember-decorators/component";
-import BufferedProxy from "ember-buffered-proxy/proxy";
import { popupAjaxError } from "discourse/lib/ajax-error";
+import BufferedProxy from "discourse/lib/buffered-proxy";
import { AUTO_GROUPS } from "discourse/lib/constants";
import PermissionType from "discourse/models/permission-type";
import GroupChooser from "discourse/select-kit/components/group-chooser";
diff --git a/frontend/discourse/app/controllers/topic.js b/frontend/discourse/app/controllers/topic.js
index 44ee0136075..93e1c8bda26 100644
--- a/frontend/discourse/app/controllers/topic.js
+++ b/frontend/discourse/app/controllers/topic.js
@@ -13,7 +13,6 @@ import { next, schedule } from "@ember/runloop";
import { service } from "@ember/service";
import { isEmpty, isPresent } from "@ember/utils";
import { observes } from "@ember-decorators/object";
-import BufferedProxy from "ember-buffered-proxy/proxy";
import { Promise } from "rsvp";
import DEditorOriginalTranslationPreview from "discourse/components/d-editor-original-translation-preview";
import BookmarkModal from "discourse/components/modal/bookmark";
@@ -31,6 +30,7 @@ import {
uniqueItemsFromArray,
} from "discourse/lib/array-tools";
import { BookmarkFormData } from "discourse/lib/bookmark-form-data";
+import BufferedProxy from "discourse/lib/buffered-proxy";
import { resetCachedTopicList } from "discourse/lib/cached-topic-list";
import { bind } from "discourse/lib/decorators";
import EmbedMode from "discourse/lib/embed-mode";
diff --git a/frontend/discourse/app/lib/buffered-proxy.js b/frontend/discourse/app/lib/buffered-proxy.js
new file mode 100644
index 00000000000..a379f6872b9
--- /dev/null
+++ b/frontend/discourse/app/lib/buffered-proxy.js
@@ -0,0 +1,145 @@
+import { tracked } from "@glimmer/tracking";
+import { meta } from "@ember/-internals/meta";
+import { isArray } from "@ember/array";
+import {
+ defineProperty,
+ get,
+ getProperties,
+ notifyPropertyChange,
+ set,
+} from "@ember/object";
+import { dependentKeyCompat } from "@ember/object/compat";
+import ObjectProxy from "@ember/object/proxy";
+
+const hasOwnProp = Object.prototype.hasOwnProperty;
+
+function isEmpty(obj) {
+ for (const key in obj) {
+ if (hasOwnProp.call(obj, key)) {
+ return false;
+ }
+ }
+ return true;
+}
+
+/**
+ * An `ObjectProxy` which holds writes in a buffer until they are applied to the
+ * underlying `content`, so edits can be discarded without touching the original.
+ */
+export default class BufferedProxy extends ObjectProxy {
+ @tracked hasBufferedChanges;
+
+ init() {
+ this.initializeBuffer();
+ set(this, "hasBufferedChanges", false);
+ super.init(...arguments);
+ }
+
+ @dependentKeyCompat
+ get hasChanges() {
+ return this.hasBufferedChanges;
+ }
+
+ initializeBuffer(onlyTheseKeys) {
+ if (isArray(onlyTheseKeys) && !isEmpty(onlyTheseKeys)) {
+ onlyTheseKeys.forEach((key) => delete this.buffer[key]);
+ } else {
+ set(this, "buffer", Object.create(null));
+ }
+ }
+
+ unknownProperty(key) {
+ const buffer = get(this, "buffer");
+
+ return hasOwnProp.call(buffer, key)
+ ? buffer[key]
+ : super.unknownProperty(key);
+ }
+
+ setUnknownProperty(key, value) {
+ const m = meta(this);
+
+ // A prototype or still-initializing object has no buffer to delegate to.
+ if (m.proto === this || (m.isInitializing && m.isInitializing())) {
+ defineProperty(this, key, null, value);
+ return value;
+ }
+
+ const { buffer, content } = getProperties(this, ["buffer", "content"]);
+ const current = content == null ? undefined : get(content, key);
+ const previous = hasOwnProp.call(buffer, key) ? buffer[key] : current;
+
+ if (previous === value) {
+ return;
+ }
+
+ if (current === value) {
+ delete buffer[key];
+ if (isEmpty(buffer)) {
+ set(this, "hasBufferedChanges", false);
+ }
+ } else {
+ buffer[key] = value;
+ set(this, "hasBufferedChanges", true);
+ }
+
+ notifyPropertyChange(this, key);
+
+ return value;
+ }
+
+ applyBufferedChanges(onlyTheseKeys) {
+ const { buffer, content } = getProperties(this, ["buffer", "content"]);
+
+ for (const key of Object.keys(buffer)) {
+ if (isArray(onlyTheseKeys) && !onlyTheseKeys.includes(key)) {
+ continue;
+ }
+
+ set(content, key, buffer[key]);
+ }
+
+ this.initializeBuffer(onlyTheseKeys);
+
+ if (isEmpty(get(this, "buffer"))) {
+ set(this, "hasBufferedChanges", false);
+ }
+ }
+
+ discardBufferedChanges(onlyTheseKeys) {
+ const buffer = get(this, "buffer");
+
+ this.initializeBuffer(onlyTheseKeys);
+
+ for (const key of Object.keys(buffer)) {
+ if (isArray(onlyTheseKeys) && !onlyTheseKeys.includes(key)) {
+ continue;
+ }
+
+ notifyPropertyChange(this, key);
+ }
+
+ if (isEmpty(get(this, "buffer"))) {
+ set(this, "hasBufferedChanges", false);
+ }
+ }
+
+ applyChanges(...args) {
+ return this.applyBufferedChanges(...args);
+ }
+
+ discardChanges(...args) {
+ return this.discardBufferedChanges(...args);
+ }
+
+ /** Whether a single key differs from `content`, rather than the whole buffer. */
+ hasChanged(key) {
+ const { buffer, content } = getProperties(this, ["buffer", "content"]);
+
+ if (typeof key !== "string" || typeof get(buffer, key) === "undefined") {
+ return false;
+ }
+
+ return get(buffer, key) !== get(content, key);
+ }
+}
diff --git a/frontend/discourse/app/loader-shims.js b/frontend/discourse/app/loader-shims.js
index 95b27a808dc..86c170f110b 100644
--- a/frontend/discourse/app/loader-shims.js
+++ b/frontend/discourse/app/loader-shims.js
@@ -183,12 +183,6 @@ loaderShim("ember-this-fallback/this-fallback-helper", () =>
loaderShim("ember-this-fallback/try-lookup-helper", () =>
importSync("./lib/ember-this-fallback/try-lookup-helper")
);
-loaderShim("ember-buffered-proxy/helpers", () =>
- importSync("ember-buffered-proxy/helpers")
-);
-loaderShim("ember-buffered-proxy/mixin", () =>
- importSync("ember-buffered-proxy/mixin")
-);
loaderShim("ember-buffered-proxy/proxy", () =>
- importSync("ember-buffered-proxy/proxy")
+ importSync("./lib/buffered-proxy")
);
diff --git a/frontend/discourse/package.json b/frontend/discourse/package.json
index ab6c59e6dec..32791dc0208 100644
--- a/frontend/discourse/package.json
+++ b/frontend/discourse/package.json
@@ -157,7 +157,6 @@
"discourse-i18n": "workspace:*",
"discourse-markdown-it": "workspace:1.0.0",
"ember-async-data": "^2.0.1",
- "ember-buffered-proxy": "^2.1.1",
"ember-cli": "~7.2.0",
"ember-cli-deprecation-workflow": "^4.0.1",
"ember-cli-htmlbars": "^7.0.1",
diff --git a/patches/ember-buffered-proxy.patch b/patches/ember-buffered-proxy.patch
deleted file mode 100644
index a40945ffd99..00000000000
--- a/patches/ember-buffered-proxy.patch
+++ /dev/null
@@ -1,40 +0,0 @@
-diff --git a/addon/mixin.js b/addon/mixin.js
-index 2908c546735d262efca3f4e50a32587a3ae27c04..1aa9cd7975434bb193ed7e8d053df97c2e877124 100644
---- a/addon/mixin.js
-+++ b/addon/mixin.js
-@@ -1,6 +1,6 @@
- /* eslint-disable ember/no-get */
- /* eslint-disable ember/no-new-mixins */
--import Ember from 'ember';
-+import { meta } from '@ember/-internals/meta';
- import Mixin from '@ember/object/mixin';
- import { isArray } from '@ember/array';
- import { readOnly } from '@ember/object/computed';
-@@ -12,20 +12,20 @@ import {
- notifyPropertyChange,
- } from '@ember/object';
-
--import { gte, lte } from 'ember-compatibility-helpers';
-+// import { gte, lte } from 'ember-compatibility-helpers';
-
- import { aliasMethod, empty } from './helpers';
-
--const { meta } = Ember; // eslint-disable-line ember/new-module-imports
-+// const { meta } = Ember; // eslint-disable-line ember/new-module-imports
- const hasOwnProp = Object.prototype.hasOwnProperty;
-
- function monkeyPatchedNotifyPropertyChange(context, key) {
-- if (gte('3.13.0') && lte('3.19.0')) {
-- let content = get(context, 'content');
-- notifyPropertyChange(content, key);
-- } else {
-+ // if (gte('3.13.0') && lte('3.19.0')) {
-+ // let content = get(context, 'content');
-+ // notifyPropertyChange(content, key);
-+ // } else {
- notifyPropertyChange(context, key);
-- }
-+ // }
- }
-
- export default Mixin.create({
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
index 1cc27821ea5..93413404a43 100644
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
@@ -20,9 +20,6 @@ patchedDependencies:
hash: 387f93bad78f3a98b20dc742f4f0b7a165c7e6ebc65cc60356748346c0725c7f
path: patches/[email protected]
- ember-buffered-proxy:
- hash: 6f462c5d8fcc3ebcc27fc038b7be66b9337f0c848ad18e37a2101cb62b29ede5
- path: patches/ember-buffered-proxy.patch
hash: 0ef38ddd130e8270d1f48debbc77216b6bb635e263e3e0a7eea1d11143a3f102
path: patches/[email protected]
@@ -599,9 +596,6 @@ importers:
ember-async-data:
specifier: ^2.0.1
version: 2.0.1(@babel/[email protected])
- ember-buffered-proxy:
- specifier: ^2.1.1
- version: 2.1.1(patch_hash=6f462c5d8fcc3ebcc27fc038b7be66b9337f0c848ad18e37a2101cb62b29ede5)(@babel/[email protected])
ember-cli:
specifier: ~7.2.0
@@ -3359,12 +3353,6 @@ packages:
'@babel/core': ^7.0.0
webpack: '>=2'
- resolution: {integrity: sha512-Wpmw4TbhR3Eq2t3W51eBAQSdKlr+uAyF0GI4GtPfMCD12Y4cIdpKC9l0RjNTH/P9isFypSqqewMPm7//fnZlNA==}
- engines: {node: '>=4'}
- peerDependencies:
- '@babel/core': ^7.0.0-beta.42
-
resolution: {integrity: sha512-wfel/vb3pXfwIDZUrkoDrn5FHmlWI96PCJ3UCDv2a86poJ3EQrnArNW5KfHSVJ9IOgxHbo748cQt7sDU+0KCEw==}
engines: {node: '>=6'}
@@ -4310,10 +4298,6 @@ packages:
resolution: {integrity: sha512-MjxJK2nfCJmmQI/rju2TrycmAa1AxmTarfvygbcrrgW0s4WeZHtbGXCO2z1lW9wfrShqeTo/o+3Mgk+9xcDTWg==}
engines: {node: 12.* || 14.* || >= 16}
- resolution: {integrity: sha512-eF9m36dm+rYegmND3lTSg4HJVH67oQXmcHLZmWUIxZC9zKK+/tO8QEgXjbquixBCNyUFw+fTNeyCG2PGApjXDA==}
- engines: {node: 12.* || 14.* || >= 16}
-
resolution: {integrity: sha512-sKvOiPNHr5F/60NLd7SFzMpYPte/nnGkq/tMIfXejfKHIhaiIkYFqX8Z9UFTKWLLn+V7NOaby6niNPZUdvKCRw==}
engines: {node: 6.* || 8.* || >= 10.*}
@@ -4377,10 +4361,6 @@ packages:
engines: {node: '>= 20.19.0'}
hasBin: true
- resolution: {integrity: sha512-BtkjulweiXo9c3yVWrtexw2dTmBrvavD/xixNC6TKOBdrixUwU+6nuOO9dufDWsMxoid7MvtmDpzc9+mE8PdaA==}
- engines: {node: 10.* || >= 12.*}
-
resolution: {integrity: sha512-8N1WWt1KuMntWvB+i9ShwXFMU0tliJO7XinLJB+fihSl/ip+72UWAW3UCRttpiirKuIXJPpwqt6VCmlKbL8C4A==}
peerDependencies:
@@ -11265,11 +11245,6 @@ snapshots:
make-dir: 3.1.0
schema-utils: 2.7.1
- dependencies:
- '@babel/core': 7.29.7
- semver: 5.7.2
-
[email protected](patch_hash=387f93bad78f3a98b20dc742f4f0b7a165c7e6ebc65cc60356748346c0725c7f)(@babel/[email protected]):
dependencies:
'@babel/core': 7.29.7
@@ -12323,14 +12298,6 @@ snapshots:
- supports-color
- webpack
- [email protected](patch_hash=6f462c5d8fcc3ebcc27fc038b7be66b9337f0c848ad18e37a2101cb62b29ede5)(@babel/[email protected]):
- dependencies:
- ember-cli-babel: 7.26.11
- ember-compatibility-helpers: 1.2.7(@babel/[email protected])
- transitivePeerDependencies:
- - '@babel/core'
- - supports-color
-
@@ -12626,17 +12593,6 @@ snapshots:
- walrus
- whiskers
- dependencies:
- babel-plugin-debug-macros: 0.2.0(@babel/[email protected])
- ember-cli-version-checker: 5.1.2
- find-up: 5.0.0
- fs-extra: 9.1.0
- semver: 5.7.2
- transitivePeerDependencies:
- - '@babel/core'
- - supports-color
-
dependencies:
'@embroider/addon-shim': 1.10.3
diff --git a/pnpm-workspace.yaml b/pnpm-workspace.yaml
index 87b42f746dc..d4e296d3e25 100644
--- a/pnpm-workspace.yaml
+++ b/pnpm-workspace.yaml
@@ -74,7 +74,6 @@ patchedDependencies:
"@warp-drive/[email protected]": "patches/@[email protected]"
- "ember-buffered-proxy": "patches/ember-buffered-proxy.patch"
"pikaday": "patches/pikaday.patch"
peerDependencyRules:
allowedVersions: