feat: add tests for the refresh method

Author: aklkv

.DS_Store

@@ -8,7 +8,7 @@ node_modules/
 # misc
 npm-debug.log*
 yarn-error.log
-.DS_Store
+/.DS_Store
 
 # yarn
 .pnp.*
@@ -17,4 +17,4 @@ yarn-error.log
 !.yarn/plugins
 !.yarn/releases
 !.yarn/sdks
-!.yarn/versions
+!.yarn/versions

.gitignore

@@ -0,0 +1,11 @@
+import Route from '@ember/routing/route';
+
+let count = 0;
+
+export default class extends Route {
+  model() {
+    return {
+      count: count++,
+    };
+  }
+}

test-app/app/routes/application.js

@@ -1,4 +1,7 @@
 <h1>Ember Engines Demo</h1>
+<span class='global-refresh-counter'>
+  {{@model.count}}
+</span>
 
 <LinkTo @route="routeless-engine-demo" class="routeless-engine">Routeless Engine</LinkTo> |
 <LinkTo @route="routable-engine-demo" class="routeable-engine">Routeable Engine</LinkTo> |

test-app/app/templates/application.hbs

@@ -1,3 +1,30 @@
-<div class="hello-name" ...attributes>
-  Hello, {{@name}}!
+<div class='hello-name' ...attributes>
+  <span class='greeting'>
+    Hello,
+    {{@name}}!
+  </span>
+
+  <button
+    class='refresh'
+    type='button'
+    {{on 'click' this.refresh}}
+  >
+    Refresh
+  </button>
+
+  <button
+    class='refresh-route'
+    type='button'
+    {{on 'click' this.refreshRoute}}
+  >
+    Refresh Route
+  </button>
+
+  <button
+    class='refresh-external'
+    type='button'
+    {{on 'click' this.refreshExternal}}
+  >
+    Refresh External
+  </button>
 </div>

test-app/lib/ember-blog/addon/components/hello-name.hbs

@@ -1,9 +1,14 @@
-import { later, cancel } from '@ember/runloop';
 import Component from '@glimmer/component';
+import { later, cancel } from '@ember/runloop';
 import { tracked } from '@glimmer/tracking';
+import { action } from '@ember/object';
+import { inject as service } from '@ember/service';
 
 export default class extends Component {
+  @service router;
+
   @tracked name = this.args.name;
+  @tracked clickCount = 0;
 
   constructor() {
     super(...arguments);
@@ -20,4 +25,23 @@ export default class extends Component {
     cancel(this._later);
     super.willDestroy(...arguments);
   }
+
+  @action click() {
+    this.clickCount++;
+  }
+
+  @action
+  refresh() {
+    this.router.refresh();
+  }
+
+  @action
+  refreshRoute() {
+    this.router.refresh('new');
+  }
+
+  @action
+  refreshExternal() {
+    this.router.refreshExternal('home');
+  }
 }

test-app/lib/ember-blog/addon/components/hello-name.js

@@ -0,0 +1,19 @@
+import { inject as service } from '@ember/service';
+import Route from '@ember/routing/route';
+
+let count = 0;
+
+export default class extends Route {
+  @service exampleService;
+
+  model() {
+    // cause a service to be instantiated, so that our tests can
+    // confirm that it gets cleaned up
+    this.exampleService;
+
+    return {
+      name: 'Derek Zoolander',
+      count: count++,
+    };
+  }
+}

test-app/lib/ember-blog/addon/routes/new.js

@@ -1,6 +1,10 @@
 <div class="engine">
   New Route!!
 
+  <span class="route-refresh-counter">
+    {{@model.count}}
+  </span>
+
   <HelloWorld class="routable-hello-world" />
 
   <button class="trigger-transition-to" type="button" {{on "click" this.goAway}}>Go Away!</button>

test-app/lib/ember-blog/addon/templates/new.hbs

@@ -0,0 +1,48 @@
+import { module, test } from 'qunit';
+import { setupApplicationTest } from 'ember-qunit';
+import { visit, find, click } from '@ember/test-helpers';
+
+module('Acceptance | routeless engine demo', function (hooks) {
+  setupApplicationTest(hooks);
+
+  module('Engine Router Service Refresh Method', function () {
+    test('refresh without params triggers refresh with current route', async function (assert) {
+      await visit('/routable-engine-demo/ember-blog/new');
+
+      let counter = await find('.route-refresh-counter').textContent;
+      assert.dom('.route-refresh-counter').hasText(counter);
+      await click('.refresh');
+
+      counter = parseInt(counter, 10);
+      counter = ++counter;
+      counter = counter.toString();
+      assert.dom('.route-refresh-counter').hasText(counter);
+    });
+
+    test('refresh with params triggers refresh on provided route', async function (assert) {
+      await visit('/routable-engine-demo/ember-blog/new');
+
+      let counter = await find('.route-refresh-counter').textContent;
+      assert.dom('.route-refresh-counter').hasText(counter);
+      await click('.refresh-route');
+
+      counter = parseInt(counter, 10);
+      counter = ++counter;
+      counter = counter.toString();
+      assert.dom('.route-refresh-counter').hasText(counter);
+    });
+
+    test('refresh external route', async function (assert) {
+      await visit('/routable-engine-demo/ember-blog/new');
+
+      let counter = await find('.route-refresh-counter').textContent;
+      assert.dom('.global-refresh-counter').hasText(counter);
+      await click('.refresh-external');
+
+      counter = parseInt(counter, 10);
+      counter = ++counter;
+      counter = counter.toString();
+      assert.dom('.global-refresh-counter').hasText(counter);
+    });
+  });
+});