feat: flushDeprecations merges detected deprecations with existing config

Currently calling flushDeprecations() is destructive in that it ignores any existing config. Users would need to merge the detected deprecations with their existing config manually. Which is error prone, and does not scale for very large monorepos.

This change is doing the merge automatically. Only minor drawback is that we need to serialize the merged config with `JSON.serialize`, so it is getting returned as e.g. `{ "handler": "silence", "matchId": "test" }` instead of `{ handler: 'silence', matchId: 'test' }`. But when using prettier, this will get auto-fixed anyway, so I think the trade-offs are positive here.

Author: simonihmig

addon/index.js

@@ -14,18 +14,10 @@ export default function setupDeprecationWorkflow(config) {
 
   registerDeprecationHandler(deprecationCollector);
 
-  self.deprecationWorkflow.flushDeprecations = flushDeprecations;
+  self.deprecationWorkflow.flushDeprecations = (options) =>
+    flushDeprecations({ config, ...options });
 }
 
-let preamble = `import setupDeprecationWorkflow from 'ember-cli-deprecation-workflow';
-
-setupDeprecationWorkflow({
-  workflow: [
-`;
-
-let postamble = `  ]
-});`;
-
 function matchesWorkflow(matcher, value) {
   return (
     (typeof matcher === 'string' && matcher === value) ||
@@ -53,21 +45,25 @@ export function detectWorkflow(config, message, options) {
   }
 }
 
-export function flushDeprecations({ handler = 'silence' } = {}) {
+export function flushDeprecations({ handler = 'silence', config = {} } = {}) {
   let messages = self.deprecationWorkflow.deprecationLog.messages;
-  let logs = [];
-
-  for (let id of messages.values()) {
-    logs.push(
-      `    { handler: ${JSON.stringify(handler)}, matchId: ${JSON.stringify(
-        id,
-      )} }`,
-    );
-  }
+  let existing = config.workflow ?? [];
+  let collected = messages
+    .values()
+    .filter((matchId) => !existing.some((entry) => entry.matchId === matchId))
+    .map((matchId) => ({
+      handler,
+      matchId,
+    }));
+
+  let mergedConfig = {
+    ...config,
+    workflow: [...existing, ...collected],
+  };
 
-  let deprecations = logs.join(',\n') + '\n';
+  return `import setupDeprecationWorkflow from 'ember-cli-deprecation-workflow';
 
-  return preamble + deprecations + postamble;
+setupDeprecationWorkflow(${JSON.stringify(mergedConfig, undefined, 2)});`;
 }
 
 export function handleDeprecationWorkflow(config, message, options, next) {

tests/acceptance/flush-deprecations-test.js

@@ -1,6 +1,7 @@
 import { deprecate } from '@ember/debug';
 import { module } from 'qunit';
 import test from '../helpers/debug-test';
+import { config } from 'dummy/deprecation-workflow';
 
 let originalWarn;
 
@@ -56,12 +57,19 @@ module('flushDeprecations', function (hooks) {
       deprecationsPayload,
       `import setupDeprecationWorkflow from 'ember-cli-deprecation-workflow';
 
-setupDeprecationWorkflow({
-  workflow: [
-    { handler: "silence", matchId: "test" },
-    { handler: "silence", matchId: "log-strict" }
-  ]
-});`,
+setupDeprecationWorkflow(${JSON.stringify(
+        {
+          ...config,
+          workflow: [
+            ...config.workflow,
+            { handler: 'silence', matchId: 'test' },
+            // this one is already present in the existing config, so don't expect another entry, as we deduplicate
+            // { handler: 'silence', matchId: 'log-strict' },
+          ],
+        },
+        undefined,
+        2,
+      )});`,
     );
   });
 });

tests/dummy/app/deprecation-workflow.js

@@ -1,6 +1,7 @@
 import setupDeprecationWorkflow from 'ember-cli-deprecation-workflow';
 
-setupDeprecationWorkflow({
+// We export this here to be able to import from our own tests
+export const config = {
   throwOnUnhandled: true,
   workflow: [
     /*
@@ -26,4 +27,6 @@ setupDeprecationWorkflow({
 
     { matchMessage: 'throw-strict', handler: 'throw' },
   ],
-});
+};
+
+setupDeprecationWorkflow(config);

tests/unit/flush-deprecations-test.js

@@ -34,16 +34,18 @@ module('flushDeprecations', function (hooks) {
     ]);
 
     let deprecationsPayload = flushDeprecations();
+    let expectedConfig = {
+      workflow: [
+        { handler: 'silence', matchId: 'first' },
+        { handler: 'silence', matchId: 'second' },
+      ],
+    };
+
     assert.strictEqual(
       deprecationsPayload,
       `import setupDeprecationWorkflow from 'ember-cli-deprecation-workflow';
 
-setupDeprecationWorkflow({
-  workflow: [
-    { handler: "silence", matchId: "first" },
-    { handler: "silence", matchId: "second" }
-  ]
-});`,
+setupDeprecationWorkflow(${JSON.stringify(expectedConfig, undefined, 2)});`,
     );
   });
 
@@ -54,16 +56,89 @@ setupDeprecationWorkflow({
     ]);
 
     let deprecationsPayload = flushDeprecations({ handler: 'log' });
+    let expectedConfig = {
+      workflow: [
+        { handler: 'log', matchId: 'first' },
+        { handler: 'log', matchId: 'second' },
+      ],
+    };
+
+    assert.strictEqual(
+      deprecationsPayload,
+      `import setupDeprecationWorkflow from 'ember-cli-deprecation-workflow';
+
+setupDeprecationWorkflow(${JSON.stringify(expectedConfig, undefined, 2)});`,
+    );
+  });
+
+  test('calling flushDeprecations with existing config and no deprecations returns original config', function (assert) {
+    let config = {
+      throwOnUnhandled: true,
+      workflow: [{ handler: 'log', matchId: 'existing' }],
+    };
+    self.deprecationWorkflow.deprecationLog.messages = new Set([]);
+
+    let deprecationsPayload = flushDeprecations({ config });
+    assert.strictEqual(
+      deprecationsPayload,
+      `import setupDeprecationWorkflow from 'ember-cli-deprecation-workflow';
+
+setupDeprecationWorkflow(${JSON.stringify(config, undefined, 2)});`,
+    );
+  });
+
+  test('calling flushDeprecations with existing config returns augmented config', function (assert) {
+    let config = {
+      throwOnUnhandled: true,
+      workflow: [{ handler: 'log', matchId: 'existing' }],
+    };
+    self.deprecationWorkflow.deprecationLog.messages = new Set([
+      'first',
+      'second',
+    ]);
+
+    let deprecationsPayload = flushDeprecations({ config });
+    let expectedConfig = {
+      throwOnUnhandled: true,
+      workflow: [
+        { handler: 'log', matchId: 'existing' },
+        { handler: 'silence', matchId: 'first' },
+        { handler: 'silence', matchId: 'second' },
+      ],
+    };
+    assert.strictEqual(
+      deprecationsPayload,
+      `import setupDeprecationWorkflow from 'ember-cli-deprecation-workflow';
+
+setupDeprecationWorkflow(${JSON.stringify(expectedConfig, undefined, 2)});`,
+    );
+  });
+
+  test('calling flushDeprecations with existing config does not override existing deprecations', function (assert) {
+    let config = {
+      throwOnUnhandled: true,
+      workflow: [{ handler: 'log', matchId: 'existing' }],
+    };
+    self.deprecationWorkflow.deprecationLog.messages = new Set([
+      'first',
+      'second',
+      'existing',
+    ]);
+
+    let deprecationsPayload = flushDeprecations({ config });
+    let expectedConfig = {
+      throwOnUnhandled: true,
+      workflow: [
+        { handler: 'log', matchId: 'existing' },
+        { handler: 'silence', matchId: 'first' },
+        { handler: 'silence', matchId: 'second' },
+      ],
+    };
     assert.strictEqual(
       deprecationsPayload,
       `import setupDeprecationWorkflow from 'ember-cli-deprecation-workflow';
 
-setupDeprecationWorkflow({
-  workflow: [
-    { handler: "log", matchId: "first" },
-    { handler: "log", matchId: "second" }
-  ]
-});`,
+setupDeprecationWorkflow(${JSON.stringify(expectedConfig, undefined, 2)});`,
     );
   });
 });