Merge pull request #207 from simonihmig/enhanced-flushDeprecations

Allow passing a custom handler to flushDeprecations

Author: mansona

README.md

@@ -60,7 +60,7 @@ addressing a single deprecation at a time, and prevents backsliding
 
 4. Run your test suite\* with `ember test --server`.
 5. Navigate to your tests (default: http://localhost:7357/)
-6. Run `deprecationWorkflow.flushDeprecations()` in your browsers console.
+6. Run `deprecationWorkflow.flushDeprecations()` in your browsers console. Or `flushDeprecations({ handler: 'log' })` if you want a different [handler](#handlers) than the default of `silence`.
 7. Copy the string output and overwrite the content of `app/deprecation-workflow.js`.
 
     In Chrome, use right click → "Copy string contents" to avoid escape characters.

addon/index.js

@@ -5,7 +5,7 @@ const LOG_LIMIT = 100;
 export default function setupDeprecationWorkflow(config) {
   self.deprecationWorkflow = self.deprecationWorkflow || {};
   self.deprecationWorkflow.deprecationLog = {
-    messages: {},
+    messages: new Set(),
   };
 
   registerDeprecationHandler((message, options, next) =>
@@ -53,12 +53,16 @@ export function detectWorkflow(config, message, options) {
   }
 }
 
-export function flushDeprecations() {
+export function flushDeprecations({ handler = 'silence' } = {}) {
   let messages = self.deprecationWorkflow.deprecationLog.messages;
   let logs = [];
 
-  for (let message in messages) {
-    logs.push(messages[message]);
+  for (let id of messages.values()) {
+    logs.push(
+      `    { handler: ${JSON.stringify(handler)}, matchId: ${JSON.stringify(
+        id,
+      )} }`,
+    );
   }
 
   let deprecations = logs.join(',\n') + '\n';
@@ -110,11 +114,7 @@ export function handleDeprecationWorkflow(config, message, options, next) {
 }
 
 export function deprecationCollector(message, options, next) {
-  let key = (options && options.id) || message;
-  let matchKey = options && key === options.id ? 'matchId' : 'matchMessage';
-
-  self.deprecationWorkflow.deprecationLog.messages[key] =
-    '    { handler: "silence", ' + matchKey + ': ' + JSON.stringify(key) + ' }';
+  self.deprecationWorkflow.deprecationLog.messages.add(options.id);
 
   next(message, options);
 }

tests/acceptance/flush-deprecations-test.js

@@ -10,7 +10,7 @@ module('flushDeprecations', function (hooks) {
   });
 
   hooks.afterEach(function () {
-    window.deprecationWorkflow.deprecationLog = { messages: {} };
+    window.deprecationWorkflow.deprecationLog = { messages: new Set() };
     window.Testem.handleConsoleMessage = originalWarn;
   });
 

tests/acceptance/workflow-config-test.js

@@ -12,7 +12,7 @@ module('workflow config', function (hooks) {
   });
 
   hooks.afterEach(function () {
-    window.deprecationWorkflow.deprecationLog = { messages: {} };
+    window.deprecationWorkflow.deprecationLog = { messages: new Set() };
     window.Testem.handleConsoleMessage = originalWarn;
   });
 

tests/unit/deprecation-collector-test.js

@@ -17,7 +17,7 @@ module('deprecationCollector', function (hooks) {
     originalConfig = self.deprecationWorkflow = {
       config: null,
       deprecationLog: {
-        messages: {},
+        messages: new Set(),
       },
     };
   });
@@ -50,10 +50,10 @@ module('deprecationCollector', function (hooks) {
       () => {},
     );
 
-    assert.deepEqual(self.deprecationWorkflow.deprecationLog.messages, {
-      first: '    { handler: "silence", matchId: "first" }',
-      second: '    { handler: "silence", matchId: "second" }',
-    });
+    assert.deepEqual(
+      self.deprecationWorkflow.deprecationLog.messages,
+      new Set(['first', 'second']),
+    );
   });
 
   test('should call next', function (assert) {
@@ -119,9 +119,9 @@ module('deprecationCollector', function (hooks) {
       () => {},
     );
 
-    assert.deepEqual(self.deprecationWorkflow.deprecationLog.messages, {
-      first: '    { handler: "silence", matchId: "first" }',
-      second: '    { handler: "silence", matchId: "second" }',
-    });
+    assert.deepEqual(
+      self.deprecationWorkflow.deprecationLog.messages,
+      new Set(['first', 'second']),
+    );
   });
 });

tests/unit/flush-deprecations-test.js

@@ -16,22 +16,22 @@ module('flushDeprecations', function (hooks) {
     originalConfig = self.deprecationWorkflow = {
       config: null,
       deprecationLog: {
-        messages: [],
+        messages: new Set(),
       },
     };
   });
 
   hooks.afterEach(function () {
     self.deprecationWorkflow.config = originalConfig;
-    self.deprecationWorkflow.deprecationLog = { messages: {} };
+    self.deprecationWorkflow.deprecationLog = { messages: new Set() };
     console.warn = originalWarn;
   });
 
-  test('calling flushDeprecations returns string of deprecations', function (assert) {
-    self.deprecationWorkflow.deprecationLog.messages = {
-      first: '    { handler: "silence", matchId: "first" }',
-      second: '    { handler: "silence", matchId: "second" }',
-    };
+  test('calling flushDeprecations returns workflow config', function (assert) {
+    self.deprecationWorkflow.deprecationLog.messages = new Set([
+      'first',
+      'second',
+    ]);
 
     let deprecationsPayload = flushDeprecations();
     assert.strictEqual(
@@ -43,6 +43,26 @@ setupDeprecationWorkflow({
     { handler: "silence", matchId: "first" },
     { handler: "silence", matchId: "second" }
   ]
+});`,
+    );
+  });
+
+  test('calling flushDeprecations with custom handler returns workflow config', function (assert) {
+    self.deprecationWorkflow.deprecationLog.messages = new Set([
+      'first',
+      'second',
+    ]);
+
+    let deprecationsPayload = flushDeprecations({ handler: 'log' });
+    assert.strictEqual(
+      deprecationsPayload,
+      `import setupDeprecationWorkflow from 'ember-cli-deprecation-workflow';
+
+setupDeprecationWorkflow({
+  workflow: [
+    { handler: "log", matchId: "first" },
+    { handler: "log", matchId: "second" }
+  ]
 });`,
     );
   });