fix: add guard for unsupported versions (#86)

* chore: Drop support for node 14 * fix: specify packageManager so that corepack plays nicely * chore: add `@ember/string` * chore: remove volta * fix: add warning message for ember-source below v4.1 * fix: conditional tests
villander · Nov 15, 2023 · 1620514 · 1620514
1 parent 623ce49
commit 1620514
Show file tree

Hide file tree

Showing 7 changed files with 12,940 additions and 17,887 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -22,7 +22,7 @@ jobs:
       - name: Install Node
         uses: actions/setup-node@v3
         with:
-          node-version: 14.x
+          node-version: 18.x
           cache: yarn
 
       - name: Install Dependencies
@@ -48,7 +48,7 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
-          node-version: 14.x
+          node-version: 18.x
           cache: yarn
 
       - name: Install Dependencies
@@ -86,12 +86,12 @@ jobs:
       - name: Install Node
         uses: actions/setup-node@v3
         with:
-          node-version: 14.x
+          node-version: 18.x
           cache: yarn
 
       - name: Install Dependencies
         run: until yarn install --frozen-lockfile; do echo "Retrying yarn"; done
 
       - name: Run Tests
         run: ./node_modules/.bin/ember try:one ${{ matrix.try-scenario }}
-        working-directory: test-app
+        working-directory: test-app
diff --git a/ember-engines-router-service/package.json b/ember-engines-router-service/package.json
@@ -36,7 +36,8 @@
     "start": "rollup --config --watch"
   },
   "dependencies": {
-    "@embroider/addon-shim": "^1.8.4"
+    "@embroider/addon-shim": "^1.8.4",
+    "@embroider/macros": "^1.13.2"
   },
   "devDependencies": {
     "@babel/core": "^7.20.7",
@@ -55,8 +56,11 @@
     "prettier": "^2.8.1",
     "rollup": "^3.8.1"
   },
+  "peerDependencies": {
+    "ember-source": "^3.28.0 || ^4.0.0"
+  },
   "engines": {
-    "node": "14.* || 16.* || >= 18"
+    "node": "16.* || 18.* || >= 20"
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org"
@@ -85,8 +89,5 @@
       "./initializers/ember-engines-router-service.js": "./dist/_app_/initializers/ember-engines-router-service.js",
       "./services/engine-router-service.js": "./dist/_app_/services/engine-router-service.js"
     }
-  },
-  "volta": {
-    "extends": "../package.json"
   }
 }
diff --git a/ember-engines-router-service/src/services/engine-router-service.js b/ember-engines-router-service/src/services/engine-router-service.js
@@ -5,10 +5,14 @@ import { action, computed } from '@ember/object';
 import { reads } from '@ember/object/computed';
 import { getOwner } from '@ember/application';
 import Evented from '@ember/object/evented';
+import { macroCondition, dependencySatisfies } from '@embroider/macros';
 import { namespaceEngineRouteName } from '../utils/namespace-engine-route-name';
 import { getRootOwner } from '../utils/root-owner';
 import { resemblesURL } from '../utils/resembles-url';
 
+const warningMessage =
+  'Refresh method is not available in ember-source below v4.1';
+
 export default class EngineRouterService extends Service.extend(Evented) {
   constructor(...args) {
     super(...args);
@@ -66,21 +70,29 @@ export default class EngineRouterService extends Service.extend(Evented) {
   }
 
   refresh(routeName = this.currentRouteName, ...args) {
-    if (resemblesURL(routeName)) {
-      return this.externalRouter.refresh(routeName);
+    if (macroCondition(dependencySatisfies('ember-source', '>= 4.1.0'))) {
+      if (resemblesURL(routeName)) {
+        return this.externalRouter.refresh(routeName);
+      }
+
+      return this.externalRouter.refresh(
+        namespaceEngineRouteName(this._mountPoint, routeName),
+        ...args
+      );
+    } else {
+      assert(warningMessage);
     }
-
-    return this.externalRouter.refresh(
-      namespaceEngineRouteName(this._mountPoint, routeName),
-      ...args
-    );
   }
 
   refreshExternal(routeName, ...args) {
-    return this.externalRouter.refresh(
-      this.getExternalRouteName(routeName),
-      ...args
-    );
+    if (macroCondition(dependencySatisfies('ember-source', '>= 4.1.0'))) {
+      return this.externalRouter.refresh(
+        this.getExternalRouteName(routeName),
+        ...args
+      );
+    } else {
+      assert(warningMessage);
+    }
   }
 
   transitionTo(routeName, ...args) {

diff --git a/package.json b/package.json
@@ -54,8 +54,5 @@
     },
     "npm": false
   },
-  "volta": {
-    "node": "14.21.2",
-    "yarn": "1.22.19"
-  }
+  "packageManager": "yarn@1.22.9"
 }
diff --git a/test-app/package.json b/test-app/package.json
@@ -35,7 +35,9 @@
     "@babel/eslint-parser": "^7.19.1",
     "@ember/legacy-built-in-components": "0.4.1",
     "@ember/optional-features": "^2.0.0",
+    "@ember/string": "^3.1.1",
     "@ember/test-helpers": "^2.9.3",
+    "@embroider/macros": "^1.13.2",
     "@embroider/test-setup": "^2.0.2",
     "@glimmer/component": "^1.1.2",
     "@glimmer/tracking": "^1.1.2",
@@ -75,12 +77,9 @@
     "webpack": "^5.75.0"
   },
   "engines": {
-    "node": "14.* || 16.* || >= 18"
+    "node": "16.* || 18.* || >= 20"
   },
   "ember": {
     "edition": "octane"
-  },
-  "volta": {
-    "extends": "../package.json"
   }
 }
diff --git a/test-app/tests/acceptance/routeable-engine-demo-refresh-test.js b/test-app/tests/acceptance/routeable-engine-demo-refresh-test.js
@@ -1,43 +1,50 @@
 import { module, test } from 'qunit';
 import { setupApplicationTest } from 'ember-qunit';
 import { visit, find, click } from '@ember/test-helpers';
+import { macroCondition, dependencySatisfies } from '@embroider/macros';
 
-module('Acceptance | Engine Router Service | Refresh Method', function (hooks) {
-  setupApplicationTest(hooks);
+if (macroCondition(dependencySatisfies('ember-source', '>= 4.1.0'))) {
+  module(
+    'Acceptance | Engine Router Service | Refresh Method',
+    function (hooks) {
+      setupApplicationTest(hooks);
 
-  test('refresh without params triggers refresh with current route', async function (assert) {
-    await visit('/routable-engine-demo/ember-blog/new');
+      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;
-    await click('.refresh');
+        let counter = await find('.route-refresh-counter').textContent;
 
-    counter = parseInt(counter, 10);
-    counter = ++counter;
-    counter = counter.toString();
-    assert.dom('.route-refresh-counter').hasText(counter);
-  });
+        await click('.refresh');
 
-  test('refresh with params triggers refresh on provided route', async function (assert) {
-    await visit('/routable-engine-demo/ember-blog/new');
+        counter = parseInt(counter, 10);
+        counter = ++counter;
+        counter = counter.toString();
+        assert.dom('.route-refresh-counter').hasText(counter);
+      });
 
-    let counter = await find('.route-refresh-counter').textContent;
-    await click('.refresh-route');
+      test('refresh with params triggers refresh on provided route', async function (assert) {
+        await visit('/routable-engine-demo/ember-blog/new');
 
-    counter = parseInt(counter, 10);
-    counter = ++counter;
-    counter = counter.toString();
-    assert.dom('.route-refresh-counter').hasText(counter);
-  });
+        let counter = await find('.route-refresh-counter').textContent;
+        await click('.refresh-route');
 
-  test('refresh external route', async function (assert) {
-    await visit('/routable-engine-demo/ember-blog/new');
+        counter = parseInt(counter, 10);
+        counter = ++counter;
+        counter = counter.toString();
+        assert.dom('.route-refresh-counter').hasText(counter);
+      });
 
-    let counter = await find('.route-refresh-counter').textContent;
-    await click('.refresh-external');
+      test('refresh external route', async function (assert) {
+        await visit('/routable-engine-demo/ember-blog/new');
 
-    counter = parseInt(counter, 10);
-    counter = ++counter;
-    counter = counter.toString();
-    assert.dom('.global-refresh-counter').hasText(counter);
-  });
-});
+        let counter = await find('.route-refresh-counter').textContent;
+        await click('.refresh-external');
+
+        counter = parseInt(counter, 10);
+        counter = ++counter;
+        counter = counter.toString();
+        assert.dom('.global-refresh-counter').hasText(counter);
+      });
+    }
+  );
+}