Dir is not cleaned when I hit ctrl+c

[JanBednarik]

I'm using tmp package in unit tests with tmp.setGracefulCleanup();. I'm creating temp directory for tests with unsafeCleanup = true.

It works fine if I don't hit ctrl+c to interrupt tests. Then the temp dir is not deleted. How can I get it deleted automatically in this case?

[silkentrance]

@JanBednarik Please provide additional information: OS, tmp version, node version etc.

Could you also give us a link to your repository, so that we may look at the code directly?

[silkentrance]

@JanBednarik ping

[silkentrance]

@JanBednarik do you work under windows?

For reference:
https://stackoverflow.com/questions/10021373/what-is-the-windows-equivalent-of-process-onsigint-in-node-js
https://stackoverflow.com/questions/20165605/detecting-ctrlc-in-node-js

[JanBednarik]

Versions:
OS X Sierra 10.12.5
Node LTS 6.11.0
tmp 0.0.31
jest 20.0.3

Should cleanup work with ctrl+c? Maybe it's somehow related to Jest test runner. I'll try to prepare some simple failing case.

[JanBednarik]

@silkentrance Here is an example:

File: package.json

{
  "name": "tmptest",
  "scripts": {
    "test": "jest"
  },
  "dependencies": {
    "jest": "20.0.4",
    "tmp": "0.0.31"
  }
}

File: main.test.js

'use strict';

const tmp = require('tmp');

tmp.setGracefulCleanup();

test('main', done =>
    tmp.dir({ template: 'tmp-XXXXXX' }, (err, path) => {
        console.log(`dir: ${path}\npress ctrl+c`);
        setTimeout(done, 3000);
    })
);

Run:

$ npm install
$ npm test

And interrupt the test with ctrl+c.

[silkentrance]

@JanBednarik thank your very much. I think that I have found the problem. There exists a SIGINT event and tmp should be listening on that, too. The only problem is that under Windows one must take a different approach. I will look into this.

[davidshepherd7]

This package might be helpful. It's supposed to allow you to run code no matter how the process exits. It has Windows tests so presumably it works on Windows too.

[silkentrance]

@davidshepherd7 the package looks good. I will try that.

[silkentrance]

@davidshepherd7 I tried signal-exit, but to no avail so far. In addition, it also installs listeners for SIGHUP which I believe is not what we want as most user code uses this to implement some way of applying changes to the configuration etc. And we do not want to clean up existing tmp files or directories prematurely.

https://stackoverflow.com/questions/10021373/what-is-the-windows-equivalent-of-process-onsigint-in-node-js

[silkentrance]

@JanBednarik perhaps you want to try the https://github.com/raszi/node-tmp/tree/gh-121 branch

If you do not know already, you can configure the tmp dependency so that it will point to that branch. See https://docs.npmjs.com/files/package.json#git-urls-as-dependencies and https://docs.npmjs.com/files/package.json#github-urls for more information.

I would appreciate it if you'd provide us with a report of your experience with that branch.
I myself tested this on OSX so it might work for you, too.

[silkentrance]

@JanBednarik since you are using jest, the branch also incorporates a fix for the problem with jest's inband sandboxing and tmp installing its process.exit listeners multiple times. See #129 and #125.

[cythrauL]

same problem,
OSX Sierra: 10.13.1
tmp version: 0.0.33
node version: v8.9.1

Also using a custom dir, postfix and prefix.

[dustinjohnson13]

The provided branch gh-121 works perfectly for me with CTRL-C for both files and directories. Thanks!

[silkentrance]

@JanBednarik @cythrauL @davidshepherd7 the current solution, which calls upon process.exit(0) needs to be revised. Upon SIGINT the process should at least exist with a non zero (0) exit code.

[silkentrance]

I have added one more commit to fix the tests for this issue. They seem to work, at least under OS X.

[silkentrance]

Tests work fine on travis, but fail on appveyor. It seems as if the tests do not terminate the external processes as one would expected. Fricking windows platform.

[stephanebachelier]

Any update ?

[sheerun]

We could do it ourselves if tmp exposed method like .forceCleanup() that removes all temporary directories created so far. Many tools like jest expose global teardown hooks.

[silkentrance]

The fix in branch gh-121 is working, however, the tests will not work under windows as we are having problems with simulating the CTRL-C there. And there are some conflicts that need to be resolved first prior to merging this to master. If I find the time, I can at least prepare everything so that it can be merged to master, disabling the tests on windows for now.

[silkentrance]

I am giving up on support for SIGINT on Windows. This platform just sucks as node will never
invoke the SIGINT listener using standard kill(signal) mechanisms, which actually works just fine on POSIX based platforms such as OSX and Linux.

And I am not inclined to add any support for invoking a "PowerShell" script that will terminate the external process in our tests.

The current state is that it will work fine on both OSX and Linux.

[silkentrance]

On travis the tests for this still fail, locally (OSX) they will succeed, working on that issue.