feature: gritty: client: get rid of mock-require

Author: coderaiser

client/gritty.js

@@ -3,14 +3,14 @@
 require('@xterm/xterm/css/xterm.css');
 
 const {FitAddon} = require('@xterm/addon-fit');
-const {WebglAddon} = require('@xterm/addon-webgl');
+const {WebglAddon: _WebglAddon} = require('@xterm/addon-webgl');
 const currify = require('currify');
 const {tryCatch} = require('try-catch');
 
 const wrap = require('wraptile');
 
 const {io} = require('socket.io-client');
-const {Terminal} = require('@xterm/xterm');
+const {Terminal: _Terminal} = require('@xterm/xterm');
 
 const getEl = require('./get-el');
 const getHost = require('./get-host');
@@ -47,10 +47,16 @@ function gritty(element, options = {}) {
         command,
         autoRestart,
         cwd,
+        connect,
+        Terminal = _Terminal,
+        WebglAddon = _WebglAddon,
     } = options;
 
     const env = getEnv(options.env || {});
-    const socket = connect(prefix, socketPath);
+    
+    const socket = doConnect(prefix, socketPath, {
+        connect,
+    });
 
     return createTerminal(el, {
         env,
@@ -59,12 +65,26 @@ function gritty(element, options = {}) {
         autoRestart,
         socket,
         fontFamily,
+        Terminal,
+        WebglAddon,
     });
 }
 
-function createTerminal(terminalContainer, {env, cwd, command, autoRestart, socket, fontFamily}) {
+function createTerminal(terminalContainer, overrides) {
+    const {
+        env,
+        cwd,
+        command,
+        autoRestart,
+        socket,
+        fontFamily,
+        Terminal,
+        WebglAddon,
+    } = overrides;
+    
     const fitAddon = new FitAddon();
     const webglAddon = new WebglAddon();
+    
     const terminal = new Terminal({
         scrollback: 1000,
         tabStopWidth: 4,
@@ -145,12 +165,13 @@ function _onWindowResize(fitAddon) {
     tryCatch(fit);
 }
 
-function connect(prefix, socketPath) {
+function doConnect(prefix, socketPath, overrides = {}) {
+    const {connect = io.connect} = overrides;
     const href = getHost();
     const FIVE_SECONDS = 5000;
 
     const path = `${socketPath}/socket.io`;
-    const socket = io.connect(href + prefix, {
+    const socket = connect(href + prefix, {
         'max reconnection attempts': 2 ** 32,
         'reconnection limit': FIVE_SECONDS,
         path,

test/client/gritty.js

@@ -1,19 +1,12 @@
 'use strict';
 
-const noop = () => {};
 const {test, stub} = require('supertape');
 
 require('css-modules-require-hook/preset');
 
 globalThis.document = {};
 globalThis.self = {};
-globalThis.addEventListener= stub();
-
-const mock = require('mock-require');
-
-const connect = stub().returns({
-    on: stub(),
-});
+globalThis.addEventListener = stub();
 
 const open = stub();
 const focus = stub();
@@ -31,19 +24,10 @@ const Terminal = stub().returns({
 
 Terminal.applyAddon = stub();
 
-mock('socket.io-client/dist/socket.io', {
-    connect,
-});
-
-mock('@xterm/xterm', {
-    Terminal,
-});
-
-mock('@xterm/xterm-addong-webl', {
-    WebglAddon: noop,
-});
-
 const gritty = require('../../client/gritty');
+const connect = stub().returns({
+    on: stub(),
+});
 
 const {
     _onConnect,
@@ -58,14 +42,19 @@ const {
 test('gritty: Terminal: new', (t) => {
     before();
 
-    gritty();
+    gritty(null, {
+        connect,
+        Terminal,
+        WebglAddon: stub(),
+    });
     t.ok(Terminal.calledWithNew(), 'should have been called with new');
     after();
 
     t.end();
 });
 
 test('gritty: Terminal: args', (t) => {
+    const WebglAddon = stub();
     before();
 
     const args = {
@@ -75,7 +64,11 @@ test('gritty: Terminal: args', (t) => {
         allowProposedApi: true,
     };
 
-    gritty();
+    gritty(null, {
+        connect,
+        Terminal,
+        WebglAddon,
+    });
 
     t.calledWith(Terminal, [args], 'should have been called with args');
 
@@ -88,6 +81,7 @@ test('gritty: Terminal: args: fontFamily', (t) => {
 
     const fontFamily = 'Droid Sans Mono';
     const el = {};
+    const WebglAddon = stub();
 
     const args = {
         scrollback: 1000,
@@ -98,6 +92,9 @@ test('gritty: Terminal: args: fontFamily', (t) => {
 
     gritty(el, {
         fontFamily,
+        connect,
+        Terminal,
+        WebglAddon,
     });
 
     t.calledWith(Terminal, [args], 'should have been called with args');
@@ -108,10 +105,15 @@ test('gritty: Terminal: args: fontFamily', (t) => {
 
 test('gritty: Terminal: open', (t) => {
     const el = {};
+    const WebglAddon = stub();
 
     before();
 
-    gritty(el);
+    gritty(el, {
+        connect,
+        Terminal,
+        WebglAddon,
+    });
     t.calledWith(open, [el], 'should have been called');
     after();
 
@@ -120,10 +122,15 @@ test('gritty: Terminal: open', (t) => {
 
 test('gritty: Terminal: focus', (t) => {
     const el = {};
+    const WebglAddon = stub();
 
     before();
 
-    gritty(el);
+    gritty(el, {
+        connect,
+        Terminal,
+        WebglAddon,
+    });
     t.calledWithNoArgs(focus, 'should have been called');
     after();