Skip to content

Commit

Permalink
Revert "perf(ngcc): allow immediately reporting a stale lock file (#3…
Browse files Browse the repository at this point in the history 
…7250)" (#39435)

This reverts commit 561c0f8.

The original commit provided a quick escape from an already terminal
situation by killing the process if the PID in the lockfile was not
found in the list of processes running on the current machine.

But this broke use-cases where the node_modules was being shared between
multiple machines (or more commonly Docker containers on the same actual
machine).

Fixes #38875

PR Close #39435
  • Loading branch information
@petebacondarwin @alxhub
petebacondarwin authored and alxhub committed Oct 27, 2020
1 parent bf1caa7 commit 72e0c6b
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 104 deletions.
66 changes: 10 additions & 56 deletions packages/compiler-cli/ngcc/src/locking/async_locker.ts
View file
Expand Up @@ -60,68 +60,22 @@ export class AsyncLocker {
pid = newPid;
}
if (attempts === 0) {
// Check to see if the process identified by the PID is still running. Because the
// process *should* clean up after itself, we only check for a stale lock file when the
// PID changes and only once. This may mean you have to wait if the process is killed
// after the first check and isn't given the chance to clean up after itself.
if (!this.isProcessRunning(pid)) {
// try to re-lock one last time in case there was a race condition checking the process.
try {
return this.lockFile.write();
} catch (e2) {
if (e2.code !== 'EEXIST') {
throw e2;
}
}

// finally check that the lock was held by the same process this whole time.
const finalPid = this.lockFile.read();
if (finalPid === pid) {
throw new TimeoutError(this.lockFileMessage(
`Lock found, but no process with PID ${pid} seems to be running.`));
} else {
// attempts is still 0, but adjust the PID so the message below is correct.
pid = finalPid;
}
}

this.logger.info(this.lockFileMessage(
this.logger.info(
`Another process, with id ${pid}, is currently running ngcc.\n` +
`Waiting up to ${this.retryDelay * this.retryAttempts / 1000}s for it to finish.`));
`Waiting up to ${this.retryDelay * this.retryAttempts / 1000}s for it to finish.\n` +
`(If you are sure no ngcc process is running then you should delete the lock-file at ${
this.lockFile.path}.)`);
}
// The file is still locked by another process so wait for a bit and retry
await new Promise(resolve => setTimeout(resolve, this.retryDelay));
}
}
// If we fall out of the loop then we ran out of rety attempts
throw new TimeoutError(this.lockFileMessage(`Timed out waiting ${
this.retryAttempts * this.retryDelay /
1000}s for another ngcc process, with id ${pid}, to complete.`));
}

protected isProcessRunning(pid: string): boolean {
// let the normal logic run if this is not called with a valid PID
if (isNaN(+pid)) {
this.logger.debug(`Cannot check if invalid PID "${pid}" is running, a number is expected.`);
return true;
}

try {
process.kill(+pid, 0);
return true;
} catch (e) {
// If the process doesn't exist ESRCH will be thrown, if the error is not that, throw it.
if (e.code !== 'ESRCH') {
throw e;
}

return false;
}
}

private lockFileMessage(message: string): string {
return message +
`\n(If you are sure no ngcc process is running then you should delete the lock-file at ${
this.lockFile.path}.)`;
throw new TimeoutError(
`Timed out waiting ${
this.retryAttempts * this.retryDelay /
1000}s for another ngcc process, with id ${pid}, to complete.\n` +
`(If you are sure no ngcc process is running then you should delete the lock-file at ${
this.lockFile.path}.)`);
}
}
48 changes: 0 additions & 48 deletions packages/compiler-cli/ngcc/test/locking/async_locker_spec.ts
View file
Expand Up @@ -71,7 +71,6 @@ runInEachFileSystem(() => {
}
return lockFileContents;
});
spyOn(process, 'kill').and.returnValue();

const promise = locker.lock(async () => log.push('fn()'));
// The lock is now waiting on the lock-file becoming free, so no `fn()` in the log.
Expand All @@ -81,7 +80,6 @@ runInEachFileSystem(() => {
`(If you are sure no ngcc process is running then you should delete the lock-file at ${
lockFile.path}.)`
]]);
expect(process.kill).toHaveBeenCalledWith(188, 0);

lockFileContents = null;
// The lock-file has been removed, so we can create our own lock-file, call `fn()` and then
Expand All @@ -90,47 +88,6 @@ runInEachFileSystem(() => {
expect(log).toEqual(['write()', 'read() => 188', 'write()', 'fn()', 'remove()']);
});

it('should fail fast when waiting on a dead process', async () => {
const fs = getFileSystem();
const log: string[] = [];
const lockFile = new MockLockFile(fs, log);
const logger = new MockLogger();
const locker = new AsyncLocker(lockFile, logger, 100, 10);

let lockFileContents: string|null = '188';
spyOn(lockFile, 'write').and.callFake(() => {
log.push('write()');
if (lockFileContents) {
throw {code: 'EEXIST'};
}
});
spyOn(lockFile, 'read').and.callFake(() => {
log.push('read() => ' + lockFileContents);
if (lockFileContents === null) {
throw {code: 'ENOENT'};
}
return lockFileContents;
});
spyOn(process, 'kill').and.callFake(() => {
throw {code: 'ESRCH'};
});

const promise = locker.lock(async () => log.push('fn()'));
// The lock has already failed so no `fn()` in the log.
expect(log).toEqual(['write()', 'read() => 188', 'write()', 'read() => 188']);
expect(logger.logs.info).toEqual([]);
expect(process.kill).toHaveBeenCalledWith(188, 0);
// Check that a missing process errors out.
let error: Error;
await promise.catch(e => error = e);
expect(log).toEqual(['write()', 'read() => 188', 'write()', 'read() => 188']);
expect(error!.message)
.toEqual(
`Lock found, but no process with PID 188 seems to be running.\n` +
`(If you are sure no ngcc process is running then you should delete the lock-file at ${
lockFile.path}.)`);
});

it('should extend the retry timeout if the other process locking the file changes', async () => {
const fs = getFileSystem();
const log: string[] = [];
Expand All @@ -152,7 +109,6 @@ runInEachFileSystem(() => {
}
return lockFileContents;
});
spyOn(process, 'kill').and.returnValue();

const promise = locker.lock(async () => log.push('fn()'));
// The lock is now waiting on the lock-file becoming free, so no `fn()` in the log.
Expand All @@ -162,7 +118,6 @@ runInEachFileSystem(() => {
`(If you are sure no ngcc process is running then you should delete the lock-file at ${
lockFile.path}.)`
]]);
expect(process.kill).toHaveBeenCalledWith(188, 0);

lockFileContents = '444';
// The lock-file has been taken over by another process - wait for the next attempt
Expand All @@ -176,7 +131,6 @@ runInEachFileSystem(() => {
`(If you are sure no ngcc process is running then you should delete the lock-file at ${
lockFile.path}.)`]
]);
expect(process.kill).toHaveBeenCalledWith(444, 0);

lockFileContents = null;
// The lock-file has been removed, so we can create our own lock-file, call `fn()` and
Expand Down Expand Up @@ -209,13 +163,11 @@ runInEachFileSystem(() => {
}
return lockFileContents;
});
spyOn(process, 'kill').and.returnValue();

const promise = locker.lock(async () => log.push('fn()'));

// The lock is now waiting on the lock-file becoming free, so no `fn()` in the log.
expect(log).toEqual(['write()', 'read() => 188']);
expect(process.kill).toHaveBeenCalledWith(188, 0);
// Do not remove the lock-file and let the call to `lock()` timeout.
let error: Error;
await promise.catch(e => error = e);
Expand Down

0 comments on commit 72e0c6b

Please sign in to comment.