GIT_TRACE: true cause process to crash

[maloguertin]

I am using husky to run lint-staged and everything is going fine until I tried to commit using Atom's git gui. This led me to investigate as to what was causing this issue until I finally found the culprit. For some reason Atom's git module adds GIT_TRACE:true to the process.env which causes the process to crash.

If I change

var cmd = spawn(bits[0], args, {
        cwd: module.exports.cwd
    });

for

var cmd = spawn(bits[0], args, {
        cwd: module.exports.cwd,
        env: Object.assign({}, process.env, {GIT_TRACE: false})
    });

then everything runs correctly.

Now this might not be a staged-git-files specific problem but I need to investigate more in order to find what the correct behavior should be.

[maloguertin]

from https://git-scm.com/book/en/v2/Git-Internals-Environment-Variables

Want to really know what Git is up to? Git has a fairly complete set of traces embedded, and all you need to do is turn them on. The possible values of these variables are as follows:

“true”, “1”, or “2” – the trace category is written to stderr.

An absolute path starting with / – the trace output will be written to that file.

GIT_TRACE controls general traces, which don’t fit into any specific category. This includes the expansion of aliases, and delegation to other sub-programs.

Since the code checks for stderr to return an error even if err is null:

  run(command, function(err, stdout, stderr) {
                if (err || stderr) {
                    callback(err || new Error(stderr));
                } else {
                    callback(null, stdoutToResultsObject(stdout));
                }
            });

it means it will always fail when GIT_TRACE is true.

I would be open to do a PR but there might be different ways to go about it.

[mcwhittemore]

@maloguertin - This sounds like a good solution. I'd love to accept a PR with some tests creating it and fixing the problem if you have the time. Thanks for the detailed research.

[maloguertin]

@mcwhittemore I'll try to look into it!