Merge pull request #443 from machty/mf-throw_on_error_perform_helper

Add onError parameter to perform helper

Author: maxfierke

addon/helpers/perform.js

@@ -1,8 +1,38 @@
 import { helper } from '@ember/component/helper';
+import { assert } from '@ember/debug';
 import { taskHelperClosure } from 'ember-concurrency/-private/helpers';
 
+function maybeReportError(onError) {
+  return function (e) {
+    if (typeof onError === 'function') {
+      onError(e);
+    } else if (onError === null) {
+      // Do nothing
+    } else {
+      assert(
+        `The onError argument passed to the \`perform\` helper should be a function or null; you passed ${onError}`,
+        false
+      );
+    }
+  };
+}
+
 export function performHelper(args, hash) {
-  return taskHelperClosure('perform', 'perform', args, hash);
+  let perform = taskHelperClosure('perform', 'perform', args, hash);
+
+  if (hash && typeof hash.onError !== 'undefined') {
+    return function (...innerArgs) {
+      try {
+        let taskInstance = perform(...innerArgs);
+        return taskInstance.catch(maybeReportError(hash.onError));
+        // eslint-disable-next-line no-empty
+      } catch {
+        maybeReportError(hash.onError);
+      }
+    };
+  } else {
+    return perform;
+  }
 }
 
 export default helper(performHelper);

tests/integration/helpers/perform-test.js

@@ -35,4 +35,66 @@ module('Integration | helpers | perform', function (hooks) {
 
     assert.ok(true);
   });
+
+  test('can pass onError=null to have it swallow errors thrown from task', async function (assert) {
+    assert.expect(1);
+
+    this.owner.register(
+      'component:test-swallow-error',
+      Component.extend({
+        errorGeneratingTask: task(function* () {
+          throw new Error('You should not see me!');
+        }),
+      })
+    );
+
+    this.owner.register(
+      'template:components/test-swallow-error',
+      hbs`
+      <button {{on 'click' (perform this.errorGeneratingTask onError=null)}}>
+        I create an error!
+      </button>
+    `
+    );
+
+    await render(hbs`<TestSwallowError />`);
+
+    await click('button');
+
+    assert.ok(true);
+  });
+
+  test('can pass onError=someFn to have it call someFn(e)', async function (assert) {
+    assert.expect(2);
+
+    let error = null;
+
+    this.owner.register(
+      'component:test-swallow-error',
+      Component.extend({
+        errorGeneratingTask: task(function* () {
+          throw new Error('You should not see me!');
+        }),
+        errorReport(e) {
+          error = e;
+        },
+      })
+    );
+
+    this.owner.register(
+      'template:components/test-swallow-error',
+      hbs`
+      <button {{on 'click' (perform this.errorGeneratingTask onError=this.errorReport)}}>
+        I create an error!
+      </button>
+    `
+    );
+
+    await render(hbs`<TestSwallowError />`);
+
+    await click('button');
+
+    assert.ok(true);
+    assert.ok(error instanceof Error);
+  });
 });