DEV: Refactor DeprecationCollector and expand deprecation ID handling (#86)

* DEV: Refactor `DeprecationCollector` and expand deprecation ID handling

Replaced `DEPRECATION_WORKFLOW` usage in `DeprecationCollector` with the
`DeprecationWorkflow` module and removed unused `#configById` map for a
cleaner implementation. Enhanced the `discourse_deprecation_ids.yml` file
to include native array extension deprecations.

Introduce fallback behavior in `DeprecationCollector` to support older
versions of core where `DeprecationWorkflow.shouldSilence` is undefined.
A temporary `#configById` map is used to handle silenced deprecations
until version `v3.6.0.beta2-dev`. Includes TODOs for cleanup post-update.

Author: megothss

assets/javascripts/discourse/services/deprecation-collector.js

@@ -1,7 +1,7 @@
 import { registerDeprecationHandler } from "@ember/debug";
 import { cancel } from "@ember/runloop";
 import Service, { service } from "@ember/service";
-import DEPRECATION_WORKFLOW from "discourse/deprecation-workflow";
+import DeprecationWorkflow from "discourse/deprecation-workflow";
 import discourseDebounce from "discourse/lib/debounce";
 import { bind } from "discourse/lib/decorators";
 import { registerDeprecationHandler as registerDiscourseDeprecationHandler } from "discourse/lib/deprecated";
@@ -30,8 +30,14 @@ export default class DeprecationCollector extends Service {
     super(...arguments);
     handler = this.track;
 
-    for (const c of DEPRECATION_WORKFLOW) {
-      this.#configById.set(c.matchId, c.handler);
+    // TODO (discourse.native-array-extensions) remove the map and related code once we get to v3.6.0.beta2-dev and can
+    //   also update .discourse-compatibility accordingly.
+    // populate the map if the `shouldSilence` is not defined in the deprecation workflow. it means the plugin is
+    // deployed with an older version of core.
+    if (!DeprecationWorkflow.shouldSilence) {
+      for (const c of DeprecationWorkflow) {
+        this.#configById.set(c.matchId, c.handler);
+      }
     }
 
     document.addEventListener("visibilitychange", this.handleVisibilityChanged);
@@ -59,8 +65,15 @@ export default class DeprecationCollector extends Service {
 
   @bind
   track(message, options) {
-    if (this.#configById.get(options.id) === "silence") {
-      return;
+    // TODO (discourse.native-array-extensions) keep only `if (DeprecationWorkflow.shouldSilence(options.id))` once we get to v3.6.0.beta2-dev
+    if (DeprecationWorkflow.shouldSilence) {
+      if (DeprecationWorkflow.shouldSilence(options.id)) {
+        return;
+      }
+    } else {
+      if (this.#configById.get(options.id) === "silence") {
+        return;
+      }
     }
 
     if (identifySource()?.type === "browser-extension") {

deprecation-finder/update_discourse_core_deprecations.mjs

@@ -25,7 +25,60 @@ const EXCLUDED_DIR_PATTERNS = [
   "/discourse/plugins/",
 ];
 const filesToDebug = [];
-const idsToInclude = ["discourse.post-stream-widget-overrides"];
+const idsToInclude = [
+  "discourse.native-array-extensions.[]",
+  "discourse.native-array-extensions.addObject",
+  "discourse.native-array-extensions.addObjects",
+  "discourse.native-array-extensions.addObserver",
+  "discourse.native-array-extensions.any",
+  "discourse.native-array-extensions.beginPropertyChanges",
+  "discourse.native-array-extensions.cacheFor",
+  "discourse.native-array-extensions.clear",
+  "discourse.native-array-extensions.compact",
+  "discourse.native-array-extensions.decrementProperty",
+  "discourse.native-array-extensions.endPropertyChanges",
+  "discourse.native-array-extensions.filterBy",
+  "discourse.native-array-extensions.findBy",
+  "discourse.native-array-extensions.get",
+  "discourse.native-array-extensions.getEach",
+  "discourse.native-array-extensions.getProperties",
+  "discourse.native-array-extensions.hasObserverFor",
+  "discourse.native-array-extensions.incrementProperty",
+  "discourse.native-array-extensions.init",
+  "discourse.native-array-extensions.insertAt",
+  "discourse.native-array-extensions.invoke",
+  "discourse.native-array-extensions.isAny",
+  "discourse.native-array-extensions.isEvery",
+  "discourse.native-array-extensions.mapBy",
+  "discourse.native-array-extensions.notifyPropertyChange",
+  "discourse.native-array-extensions.objectAt",
+  "discourse.native-array-extensions.objectsAt",
+  "discourse.native-array-extensions.popObject",
+  "discourse.native-array-extensions.pushObject",
+  "discourse.native-array-extensions.pushObjects",
+  "discourse.native-array-extensions.reject",
+  "discourse.native-array-extensions.rejectBy",
+  "discourse.native-array-extensions.removeAt",
+  "discourse.native-array-extensions.removeObject",
+  "discourse.native-array-extensions.removeObjects",
+  "discourse.native-array-extensions.removeObserver",
+  "discourse.native-array-extensions.replace",
+  "discourse.native-array-extensions.reverseObjects",
+  "discourse.native-array-extensions.set",
+  "discourse.native-array-extensions.setEach",
+  "discourse.native-array-extensions.setObjects",
+  "discourse.native-array-extensions.setProperties",
+  "discourse.native-array-extensions.shiftObject",
+  "discourse.native-array-extensions.sortBy",
+  "discourse.native-array-extensions.toArray",
+  "discourse.native-array-extensions.toggleProperty",
+  "discourse.native-array-extensions.uniq",
+  "discourse.native-array-extensions.uniqBy",
+  "discourse.native-array-extensions.unshiftObject",
+  "discourse.native-array-extensions.unshiftObjects",
+  "discourse.native-array-extensions.without",
+  "discourse.post-stream-widget-overrides",
+];
 
 async function isExcludedDir(filePath) {
   return EXCLUDED_DIR_PATTERNS.some((pattern) => filePath.includes(pattern));

lib/deprecation_collector/deprecation-ids.yml

@@ -59,6 +59,57 @@ discourse_deprecation_ids:
 - discourse.markdown-it.whitelist
 - discourse.modal-controllers
 - discourse.models-store
+- discourse.native-array-extensions.[]
+- discourse.native-array-extensions.addObject
+- discourse.native-array-extensions.addObjects
+- discourse.native-array-extensions.addObserver
+- discourse.native-array-extensions.any
+- discourse.native-array-extensions.beginPropertyChanges
+- discourse.native-array-extensions.cacheFor
+- discourse.native-array-extensions.clear
+- discourse.native-array-extensions.compact
+- discourse.native-array-extensions.decrementProperty
+- discourse.native-array-extensions.endPropertyChanges
+- discourse.native-array-extensions.filterBy
+- discourse.native-array-extensions.findBy
+- discourse.native-array-extensions.get
+- discourse.native-array-extensions.getEach
+- discourse.native-array-extensions.getProperties
+- discourse.native-array-extensions.hasObserverFor
+- discourse.native-array-extensions.incrementProperty
+- discourse.native-array-extensions.init
+- discourse.native-array-extensions.insertAt
+- discourse.native-array-extensions.invoke
+- discourse.native-array-extensions.isAny
+- discourse.native-array-extensions.isEvery
+- discourse.native-array-extensions.mapBy
+- discourse.native-array-extensions.notifyPropertyChange
+- discourse.native-array-extensions.objectAt
+- discourse.native-array-extensions.objectsAt
+- discourse.native-array-extensions.popObject
+- discourse.native-array-extensions.pushObject
+- discourse.native-array-extensions.pushObjects
+- discourse.native-array-extensions.reject
+- discourse.native-array-extensions.rejectBy
+- discourse.native-array-extensions.removeAt
+- discourse.native-array-extensions.removeObject
+- discourse.native-array-extensions.removeObjects
+- discourse.native-array-extensions.removeObserver
+- discourse.native-array-extensions.replace
+- discourse.native-array-extensions.reverseObjects
+- discourse.native-array-extensions.set
+- discourse.native-array-extensions.setEach
+- discourse.native-array-extensions.setObjects
+- discourse.native-array-extensions.setProperties
+- discourse.native-array-extensions.shiftObject
+- discourse.native-array-extensions.sortBy
+- discourse.native-array-extensions.toArray
+- discourse.native-array-extensions.toggleProperty
+- discourse.native-array-extensions.uniq
+- discourse.native-array-extensions.uniqBy
+- discourse.native-array-extensions.unshiftObject
+- discourse.native-array-extensions.unshiftObjects
+- discourse.native-array-extensions.without
 - discourse.nav-item.built-list-site-settings
 - discourse.navigation-category-controller
 - discourse.number-field