Convert tests to ESM

Convert all the tests to ESM (`.mjs`) in preparation for Chai 5, which drops support for CommonJS. - replace `require` with `import` throughout. - create a global `chai` object to replace the old `chai = require('chai')`. - rename tests from '.js' to '.mjs'.
zooniverse · Jan 11, 2024 · ab39c84 · ab39c84
1 parent e4c8770
commit ab39c84
Show file tree

Hide file tree

Showing 8 changed files with 36 additions and 65 deletions.
diff --git a/test/client.js → test/client.mjs b/test/client.js → test/client.mjs
@@ -1,13 +1,7 @@
-var MockPrimus, SugarClient, chai, expect,
-  hasProp = {}.hasOwnProperty;
+import SugarClient from '../lib/client.js';
+import MockPrimus from './support/mock_primus.js';
 
-chai = require('chai');
-
-expect = chai.expect;
-
-SugarClient = require('../lib/client');
-
-MockPrimus = require('./support/mock_primus');
+const hasProp = {}.hasOwnProperty;
 
 describe('SugarClient', function() {
   var callback1, callback2, originalConsole, sessionClient, setupEvents, userClient;

diff --git a/test/index.js → test/index.mjs b/test/index.js → test/index.mjs
@@ -1,3 +1,10 @@
+import RedisClient from '../lib/redis_client.js';
+import * as baseChai from 'chai';
+import chaiAsPromised from 'chai-as-promised';
+import chaiHttp from 'chai-http';
+import chaiSpies from 'chai-spies';
+import chaiChanges from 'chai-changes';
+
 process.env.NEW_RELIC_ENABLED = false;
 
 process.env.NEW_RELIC_NO_CONFIG_FILE = true;
@@ -14,20 +21,19 @@ process.env.SUGAR_TALK_PASSWORD = 'testPass';
 
 process.env.PANOPTES_HOST = 'http://sugar_test.panoptes';
 
-const RedisClient = require('../lib/redis_client');
-
 const redis = new RedisClient();
 redis.connect();
 
-const chai = require('chai');
-
-chai.use(require('chai-as-promised'));
-
-chai.use(require('chai-http'));
-
-chai.use(require('chai-spies'));
+const chai = {
+  ...baseChai,
+  ...baseChai.use(chaiAsPromised),
+  ...baseChai.use(chaiHttp),
+  ...baseChai.use(chaiSpies),
+  ...baseChai.use(chaiChanges)
+};
 
-chai.use(require('chai-changes'));
+global.chai = chai;
+global.expect = baseChai.expect;
 
 beforeEach(function() {
   return redis.flushAll();

diff --git a/test/panoptes.js → test/panoptes.mjs b/test/panoptes.js → test/panoptes.mjs
@@ -1,10 +1,6 @@
-const chai = require('chai');
-const jwt = require('jsonwebtoken');
-const Sentry = require('@sentry/node');
-
-const expect = chai.expect;
-
-const Panoptes = require('../lib/panoptes');
+import jwt from 'jsonwebtoken';
+import * as Sentry from '@sentry/node';
+import Panoptes from '../lib/panoptes.js';
 
 describe('Panoptes', function() {
   return describe('#authenticator', function() {
@@ -28,7 +24,7 @@ describe('Panoptes', function() {
       jwt.verify = chai.spy(() => {
         throw new Error('invalid token');
       });
-      Sentry.captureException = chai.spy();
+      chai.spy.on(Sentry, 'captureException');
       return Panoptes.authenticator(1, 'invalid_auth').then(function(response) {
         expect(response.status).to.equal(401);
         expect(response.success).to.be.false;

diff --git a/test/presence.js → test/presence.mjs b/test/presence.js → test/presence.mjs
@@ -1,12 +1,6 @@
-var Presence, chai, expect, presence;
+import Presence from '../lib/presence.js';
 
-chai = require('chai');
-
-expect = chai.expect;
-
-Presence = require('../lib/presence');
-
-presence = new Presence();
+let presence = new Presence();
 
 describe('Presence', function() {
   var active, activeOn, createSamples, inactive;

diff --git a/test/pub_sub.js → test/pub_sub.mjs b/test/pub_sub.js → test/pub_sub.mjs
@@ -1,12 +1,6 @@
-var PubSub, chai, expect, pubSub;
+import PubSub from '../lib/pub_sub.js';
 
-chai = require('chai');
-
-expect = chai.expect;
-
-PubSub = require('../lib/pub_sub');
-
-pubSub = new PubSub();
+let pubSub = new PubSub();
 
 describe('PubSub', function() {
   var subscribeTo, thennableSpy;

diff --git a/test/server.js → test/server.mjs b/test/server.js → test/server.mjs
@@ -1,11 +1,6 @@
-var SugarServer, chai, expect;
-const jwt = require('jsonwebtoken');
-
-chai = require('chai');
-
-expect = chai.expect;
-
-SugarServer = require('./support/sugar_server');
+import jwt from 'jsonwebtoken';
+import URL from 'url';
+import SugarServer from './support/sugar_server.js';
 
 describe('Server', function() {
   var client, sugar;

diff --git a/test/server_http_api.js → test/server_http_api.mjs b/test/server_http_api.js → test/server_http_api.mjs
@@ -1,11 +1,6 @@
-const chai = require('chai');
-const jwt = require('jsonwebtoken');
-
-const expect = chai.expect;
-
-const URL = require('url');
-
-const SugarServer = require('./support/sugar_server');
+import jwt from 'jsonwebtoken';
+import URL from 'url';
+import SugarServer from './support/sugar_server.js';
 
 describe('Server HTTP API', function() {
   let sugar = null;

diff --git a/test/server_socket_api.js → test/server_socket_api.mjs b/test/server_socket_api.js → test/server_socket_api.mjs
@@ -1,9 +1,6 @@
-const chai = require('chai');
-const jwt = require('jsonwebtoken');
-
-const expect = chai.expect;
-
-const SugarServer = require('./support/sugar_server');
+import jwt from 'jsonwebtoken';
+import URL from 'url';
+import SugarServer from './support/sugar_server.js';
 
 describe('Server Socket API', function() {
   var client, sugar;