Endless recursion on circular dependencies

[vectronic]

Hello,

I have an issue when using clear-module within a Mocha unit test: I get an endless recursion. However if I run it outside of a test I don't.

I have successfully used clear-module in tests before. It looks to be related to:

• upgrading to clear-module: "4.1.0" as the example below works with "3.1.0"
• clearing sshpk as this has circular dependencies defined

This works fine:

// demo.js
require('sshpk');
const clearModule = require('clear-module');
console.log('before');
clearModule('sshpk');
console.log('after');

produces:

% node demo.js
before
after

However if I run using mocha, it hangs on the call to clearModule:

require('sshpk');
const clearModule = require('clear-module');
console.log('before');
clearModule('sshpk');
console.log('after');

describe('yyy', () => {

    it('xxx', function () {
    });
});

produces:

% ./node_modules/.bin/mocha test/services/demo.spec.js
before

When I debug this I can see an endless recursion of clearing the sshpk modules which have a circular reference.

I am using node 12.6.0 and the following lib versions:

• "mocha": "7.1.0"
• "clear-module": "4.1.0" (previously 3.1.0 which worked)
• "sshpk": "1.16.1"

[vectronic]

UPDATE: If I use clear-module v3.2.0 it works, but with v4.0.0 it hangs.

[sindresorhus]

Probably related to ccd516c. You might want the clearModule.single() method.

// @omrilotan

[omrilotan]

I will issue a pull request this evening

[omrilotan]

I have reproduced the issue with the following steps:

• create a new npm project and install mocha, sshpk, clear-module

• Create a test file

const sshpk = require('sshpk');
const clear = require('clear-module');

describe('reproduce this issue', () => {
	it('Should not get stuck between Before and After', () => {
		console.log('Before');
		clear('sshpk');
		console.log('After');
	})
});

• Run tests, get stuck after 'Before'.
• Link the solution in Avoid exceeding maximum call stack size (circular) #14
• Run the tests with desired result

#14 should definitely resolve this issue

[vectronic]

Confirmed fixed for me - thanks!