Replace timekeeper with @sinonjs/fake-timers

Author: Turbo87

package.json

@@ -64,6 +64,7 @@
     "@glimmer/tracking": "1.0.4",
     "@percy/cli": "1.0.0-beta.71",
     "@percy/ember": "3.0.0",
+    "@sinonjs/fake-timers": "8.1.0",
     "@zestia/ember-auto-focus": "4.2.0",
     "broccoli-asset-rev": "3.0.0",
     "ember-a11y-testing": "5.0.0",
@@ -127,7 +128,6 @@
     "qunit": "2.17.2",
     "qunit-console-grouper": "0.3.0",
     "qunit-dom": "2.0.0",
-    "timekeeper": "2.2.0",
     "webpack": "5.65.0"
   },
   "resolutions": {

tests/components/download-graph-test.js

@@ -8,16 +8,17 @@ import { hbs } from 'ember-cli-htmlbars';
 import { dropTask } from 'ember-concurrency';
 import window from 'ember-window-mock';
 import { setupWindowMock } from 'ember-window-mock/test-support';
-import timekeeper from 'timekeeper';
 
 import { setupRenderingTest } from 'cargo/tests/helpers';
 
 import { toChartData } from '../../components/download-graph';
 import ChartJsLoader from '../../services/chartjs';
+import { setupFakeTimers } from '../helpers/fake-timers';
 
 module('Component | DownloadGraph', function (hooks) {
   setupRenderingTest(hooks);
   setupWindowMock(hooks);
+  setupFakeTimers(hooks, '2020-12-30T12:34:56Z');
 
   test('happy path', async function (assert) {
     this.data = exampleData();
@@ -81,8 +82,6 @@ module('Component | DownloadGraph', function (hooks) {
 
   module('toChartData()', function () {
     test('converts raw download data to Chart.js format', function (assert) {
-      timekeeper.travel(new Date('2020-12-30T12:34:56Z'));
-
       let data = exampleData();
       let result = toChartData(data);
       assert.matchJson(result, {

tests/helpers/fake-timers.js

@@ -0,0 +1,15 @@
+import FakeTimers from '@sinonjs/fake-timers';
+
+export function setupFakeTimers(hooks, now = '2017-11-20T12:00:00') {
+  hooks.beforeEach(function () {
+    this.clock = FakeTimers.install({
+      now: Date.parse(now),
+      toFake: ['Date'],
+      shouldAdvanceTime: true,
+    });
+  });
+
+  hooks.afterEach(function () {
+    this.clock?.uninstall();
+  });
+}

tests/helpers/setup-mirage.js

@@ -1,23 +1,19 @@
 import setupMirage from 'ember-cli-mirage/test-support/setup-mirage';
 import window from 'ember-window-mock';
 import { setupWindowMock } from 'ember-window-mock/test-support';
-import timekeeper from 'timekeeper';
+
+import { setupFakeTimers } from './fake-timers';
 
 export default function (hooks) {
   setupMirage(hooks);
   setupWindowMock(hooks);
+  setupFakeTimers(hooks, '2017-11-20T12:00:00');
 
   // To have deterministic visual tests, the seed has to be constant
   hooks.beforeEach(function () {
-    timekeeper.travel(new Date('2017-11-20T12:00:00'));
-
     this.authenticateAs = user => {
       this.server.create('mirage-session', { user });
       window.localStorage.setItem('isLoggedIn', '1');
     };
   });
-
-  hooks.afterEach(function () {
-    timekeeper.reset();
-  });
 }

tests/mirage/me/tokens/create-test.js

@@ -1,7 +1,6 @@
 import { module, test } from 'qunit';
 
 import fetch from 'fetch';
-import timekeeper from 'timekeeper';
 
 import { setupTest } from '../../../helpers';
 import setupMirage from '../../../helpers/setup-mirage';
@@ -11,7 +10,7 @@ module('Mirage | PUT /api/v1/me/tokens', function (hooks) {
   setupMirage(hooks);
 
   test('creates a new API token', async function (assert) {
-    timekeeper.freeze(new Date('2017-11-20T11:23:45Z'));
+    this.clock.setSystemTime(new Date('2017-11-20T11:23:45Z'));
 
     let user = this.server.create('user');
     this.server.create('mirage-session', { user });

tests/models/version-test.js

@@ -2,11 +2,13 @@ import { setupTest } from 'ember-qunit';
 import { module, test } from 'qunit';
 
 import setupMirage from 'ember-cli-mirage/test-support/setup-mirage';
-import timekeeper from 'timekeeper';
+
+import { setupFakeTimers } from '../helpers/fake-timers';
 
 module('Model | Version', function (hooks) {
   setupTest(hooks);
   setupMirage(hooks);
+  setupFakeTimers(hooks);
 
   hooks.beforeEach(function () {
     this.store = this.owner.lookup('service:store');
@@ -21,16 +23,16 @@ module('Model | Version', function (hooks) {
     let crateRecord = await store.findRecord('crate', crate.name);
     let versions = (await crateRecord.versions).toArray();
 
-    timekeeper.travel(new Date('2010-06-16T21:40:45Z'));
+    this.clock.setSystemTime(new Date('2010-06-16T21:40:45Z'));
     assert.true(versions[0].isNew);
 
-    timekeeper.travel(new Date('2010-06-23T21:40:45Z'));
+    this.clock.setSystemTime(new Date('2010-06-23T21:40:45Z'));
     assert.true(versions[0].isNew);
 
-    timekeeper.travel(new Date('2010-06-24T21:40:45Z'));
+    this.clock.setSystemTime(new Date('2010-06-24T21:40:45Z'));
     assert.false(versions[0].isNew);
 
-    timekeeper.travel(new Date('2014-06-24T21:40:45Z'));
+    this.clock.setSystemTime(new Date('2014-06-24T21:40:45Z'));
     assert.false(versions[0].isNew);
   });
 

yarn.lock

@@ -2050,6 +2050,20 @@
   resolved "https://registry.yarnpkg.com/@simple-dom/void-map/-/void-map-1.4.0.tgz#f15f07568fe1076740407266aa5e6eac249bc78c"
   integrity sha512-VDhLEyVCbuhOBBgHol9ShzIv9O8UCzdXeH4FoXu2DOcu/nnvTjLTck+BgXsCLv5ynDiUdoqsREEVFnoyPpFKVw==
 
+"@sinonjs/commons@^1.7.0":
+  version "1.8.3"
+  resolved "https://registry.yarnpkg.com/@sinonjs/commons/-/commons-1.8.3.tgz#3802ddd21a50a949b6721ddd72da36e67e7f1b2d"
+  integrity sha512-xkNcLAn/wZaX14RPlwizcKicDk9G3F8m2nU3L7Ukm5zBgTwiT0wsoFAHx9Jq56fJA1z/7uKGtCRu16sOUCLIHQ==
+  dependencies:
+    type-detect "4.0.8"
+
+"@sinonjs/[email protected]":
+  version "8.1.0"
+  resolved "https://registry.yarnpkg.com/@sinonjs/fake-timers/-/fake-timers-8.1.0.tgz#3fdc2b6cb58935b21bfb8d1625eb1300484316e7"
+  integrity sha512-OAPJUAtgeINhh/TAlUID4QTs53Njm7xzddaVlEs/SXwgtiD1tW22zAB/W1wdqfrpmikgaWQ9Fw6Ws+hsiRm5Vg==
+  dependencies:
+    "@sinonjs/commons" "^1.7.0"
+
 "@tootallnate/once@1":
   version "1.1.2"
   resolved "https://registry.yarnpkg.com/@tootallnate/once/-/once-1.1.2.tgz#ccb91445360179a04e7fe6aff78c00ffc1eeaf82"
@@ -13704,11 +13718,6 @@ time-zone@^1.0.0:
   resolved "https://registry.yarnpkg.com/time-zone/-/time-zone-1.0.0.tgz#99c5bf55958966af6d06d83bdf3800dc82faec5d"
   integrity sha1-mcW/VZWJZq9tBtg73zgA3IL67F0=
 
-[email protected]:
-  version "2.2.0"
-  resolved "https://registry.yarnpkg.com/timekeeper/-/timekeeper-2.2.0.tgz#9645731fce9e3280a18614a57a9d1b72af3ca368"
-  integrity sha512-W3AmPTJWZkRwu+iSNxPIsLZ2ByADsOLbbLxe46UJyWj3mlYLlwucKiq+/dPm0l9wTzqoF3/2PH0AGFCebjq23A==
-
 timers-browserify@^2.0.4:
   version "2.0.12"
   resolved "https://registry.yarnpkg.com/timers-browserify/-/timers-browserify-2.0.12.tgz#44a45c11fbf407f34f97bccd1577c652361b00ee"
@@ -13935,6 +13944,11 @@ type-check@~0.3.2:
   dependencies:
     prelude-ls "~1.1.2"
 
+[email protected]:
+  version "4.0.8"
+  resolved "https://registry.yarnpkg.com/type-detect/-/type-detect-4.0.8.tgz#7646fb5f18871cfbb7749e69bd39a6388eb7450c"
+  integrity sha512-0fr/mIH1dlO+x7TlcMy+bIDqKPsw/70tVyeHW787goQjhmqaZe10uwLujubK9q9Lg6Fiho1KUKDYz0Z7k7g5/g==
+
 type-fest@^0.11.0:
   version "0.11.0"
   resolved "https://registry.yarnpkg.com/type-fest/-/type-fest-0.11.0.tgz#97abf0872310fed88a5c466b25681576145e33f1"