Skip to content

Commit

Permalink
Fix race condition causing rare connection lock up.
Browse files Browse the repository at this point in the history
  • Loading branch information
@adriancable
adriancable committed Apr 21, 2022
1 parent 635489a commit 7c435f5
Show file tree
Hide file tree
Showing 3 changed files with 95 additions and 130 deletions.
2 changes: 1 addition & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
[![verified-by-homebridge](https://badgen.net/badge/homebridge/verified/purple)](https://github.com/homebridge/homebridge/wiki/Verified-Plugins)
[![Discord](https://img.shields.io/discord/432663330281226270?color=728ED5&logo=discord&label=discord)](https://discord.gg/j5WwJTB)

Nest plug-in for [Homebridge](https://github.com/nfarina/homebridge) using the native Nest API. See what's new in [release 4.6.5](https://github.com/chrisjshull/homebridge-nest/releases/tag/v4.6.5).
Nest plug-in for [Homebridge](https://github.com/nfarina/homebridge) using the native Nest API. See what's new in [release 4.6.6](https://github.com/chrisjshull/homebridge-nest/releases/tag/v4.6.6).

Integrate your Nest Thermostat, Temperature Sensors, Nest Protect, and Nest x Yale Lock devices into your HomeKit system. Both Nest Accounts (pre-August 2019) and Google Accounts are supported.

Expand Down
219 changes: 92 additions & 127 deletions lib/nest-connection.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,6 @@ const API_AUTH_FAIL_RETRY_DELAY_SECONDS = 15;
// Delay after authentication fail (long) before retrying
const API_AUTH_FAIL_RETRY_LONG_DELAY_SECONDS = 60 * 60;

// Interval between Nest subscribe requests
const API_SUBSCRIBE_DELAY_SECONDS = 0.1;

// Nest property updates are combined together if less than this time apart, to reduce network traffic
const API_PUSH_DEBOUNCE_SECONDS = 2;

Expand Down Expand Up @@ -98,11 +95,7 @@ class Connection {
this.legacyDeviceMap = {};
this.protobufBody = {};
this.lastProtobufCode = null;
this.pollTimes = {};
this.transcoderProcesses = [];
this.associatedStreamers = [];
this.preemptiveReauthTimer = null;
this.cancelObserve = null;
this.connectionFailures = 0;
this.pendingUpdates = [];
this.mergeUpdates = [];
Expand Down Expand Up @@ -436,14 +429,6 @@ class Connection {
});
}, (isGoogle ? API_GOOGLE_REAUTH_MINUTES : API_NEST_REAUTH_MINUTES) * 60 * 1000);

this.associatedStreamers.forEach(streamer => {
try {
streamer.onTheFlyReauthorize();
} catch (error) {
this.verbose('Warning: attempting to reauthorize with expired streamer', streamer);
}
});

return true;
}
}
Expand Down Expand Up @@ -515,56 +500,54 @@ class Connection {
return new Promise((res, rej) => {
let promiseCompleted = false;

const attempt = (func, errorText) => {
try {
func();
} catch(error) {
this.debug(errorText, error);
}
};

const cleanAndResolve = val => {
if (promiseCompleted) {
return;
}
promiseCompleted = true;

clearTimeout(this.timeoutTimer);
clearInterval(this.cancelObserveTimer);
clearInterval(this.pingTimer);
this.timeoutTimer = null;
this.cancelObserveTimer = null;
this.pingTimer = null;

try {
req.destroy();
} catch(error) {
// Ignore
}

try {
client.destroy();
} catch(error) {
// Ignore
}
attempt(() => req.removeAllListeners(), 'cleanAndReject: request remove listeners error -');
attempt(() => client.removeAllListeners(), 'cleanAndReject: client remove listeners error -');
attempt(() => req.destroy(), 'cleanAndReject: request destroy error -');
attempt(() => client.destroy(), 'cleanAndReject: client destroy error -');

if (!promiseCompleted) {
promiseCompleted = true;
res(val);
}
res(val);
};

const cleanAndReject = val => {
if (promiseCompleted) {
return;
}
promiseCompleted = true;

clearTimeout(this.timeoutTimer);
clearInterval(this.cancelObserveTimer);
clearInterval(this.pingTimer);
this.timeoutTimer = null;
this.cancelObserveTimer = null;
this.pingTimer = null;

try {
req.destroy();
} catch(error) {
// Ignore
}
attempt(() => req.removeAllListeners(), 'cleanAndResolve: request remove listeners error -');
attempt(() => client.removeAllListeners(), 'cleanAndResolve: client remove listeners error -');
attempt(() => req.destroy(), 'cleanAndResolve: request destroy error -');
attempt(() => client.destroy(), 'cleanAndResolve: client destroy error -');

try {
client.destroy();
} catch(error) {
// Ignore
}

if (!promiseCompleted) {
promiseCompleted = true;
rej(val);
}
rej(val);
};

const timeoutFunction = () => {
Expand Down Expand Up @@ -655,18 +638,6 @@ class Connection {
}
}, 1000);

// this.cancelObserve = () => req.close(http2.constants.NGHTTP2_CANCEL);
this.cancelObserve = () => {
req.close(http2.constants.NGHTTP2_CANCEL);
client.destroy();
};

/* req.on('response', (headers, flags) => {
for (const name in headers) {
console.log(`${name}: ${headers[name]}`);
}
}); */

req.on('data', data => {
if (this.timeoutTimer) {
clearTimeout(this.timeoutTimer);
Expand Down Expand Up @@ -1252,85 +1223,79 @@ class Connection {
return data;
}

dataTimerLoop(resolve, handler) {
async dataTimerLoop(resolve, handler) {
var notify = resolve || handler;
var apiLoopTimer;

this.updateData().then(data => {
if (data) {
this.verbose('API subscribe GET: got updated data');
notify(data);
}
}).catch(error => {
error.status = error.response && error.response.status;
if (!['ESOCKETTIMEDOUT','ECONNABORTED'].includes(error.code)) {
if (!error.status || error.status != 401) {
// 401 responses are normal when reauthentication is required - not actually a real "error"
this.error('Nest API call to subscribe to device settings updates returned an error: ' + (error.status || error.code || error));
// eslint-disable-next-line
while (true) {
try {
let data = await this.updateData();
if (data) {
this.verbose('API subscribe GET: got updated data');
notify(data);
}
if (error.status == 401 || error.status == 403 || ['ECONNREFUSED','ENETUNREACH'].includes(error.code)) {
// Token has probably expired, or transport endpoint has changed - re-authenticate
this.log('Reauthenticating on Nest service ...');
return this.auth().catch(() => {
this.log('Reauthentication failed, waiting for ' + API_AUTH_FAIL_RETRY_DELAY_SECONDS + ' seconds.');
return Promise.delay(API_AUTH_FAIL_RETRY_DELAY_SECONDS * 1000);
});
} else {
this.log('Retrying in ' + API_RETRY_DELAY_SECONDS + ' seconds.');
return Promise.delay(API_RETRY_DELAY_SECONDS * 1000);
} catch (error) {
error.status = error.response && error.response.status;
if (!['ESOCKETTIMEDOUT', 'ECONNABORTED'].includes(error.code)) {
if (!error.status || error.status != 401) {
// 401 responses are normal when reauthentication is required - not actually a real "error"
this.error('Nest API call to subscribe to device settings updates returned an error: ' + (error.status || error.code || error));
}
if (error.status == 401 || error.status == 403 || ['ECONNREFUSED', 'ENETUNREACH'].includes(error.code)) {
// Token has probably expired, or transport endpoint has changed - re-authenticate
this.log('Reauthenticating on Nest service ...');
try {
await this.auth();
} catch (error) {
this.log('Reauthentication failed, waiting for ' + API_AUTH_FAIL_RETRY_DELAY_SECONDS + ' seconds.');
await Promise.delay(API_AUTH_FAIL_RETRY_DELAY_SECONDS * 1000);
}
} else {
this.log('Retrying in ' + API_RETRY_DELAY_SECONDS + ' seconds.');
await Promise.delay(API_RETRY_DELAY_SECONDS * 1000);
}
}
}
}).finally(() => {
apiLoopTimer = setInterval(() => {
if (apiLoopTimer) {
clearInterval(apiLoopTimer);
}
this.dataTimerLoop(null, handler);
}, API_SUBSCRIBE_DELAY_SECONDS * 1000);
});
}
}

protobufDataTimerLoop(resolve, handler) {
var apiLoopTimer;

this.verbose('API observe POST: streaming request initiated');
this.updateProtobufData(resolve, handler).then(() => {
this.verbose('API observe POST: streaming request concluded');
// Token has probably expired, or transport endpoint has changed - re-authenticate
// console.log(this.lastProtobufCode);
// code 4: context timed out
// code 7: invalid authentication
// code 8: message quota exceeded
// code 13: internal error encountered
// code 14: socket closed / OS error
if (this.lastProtobufCode && this.lastProtobufCode.code == 13) {
this.error('API observe: internal error, waiting for ' + API_RETRY_DELAY_SECONDS + ' seconds, code', this.lastProtobufCode);
async protobufDataTimerLoop(resolve, handler) {
// eslint-disable-next-line
while (true) {
this.verbose('API observe POST: streaming request initiated');
try {
await this.updateProtobufData(resolve, handler);
this.verbose('API observe POST: streaming request concluded');
// Token has probably expired, or transport endpoint has changed - re-authenticate
// console.log(this.lastProtobufCode);
// code 4: context timed out
// code 7: invalid authentication
// code 8: message quota exceeded
// code 13: internal error encountered
// code 14: socket closed / OS error
if (this.lastProtobufCode && this.lastProtobufCode.code == 13) {
this.error('API observe: internal error, waiting for ' + API_RETRY_DELAY_SECONDS + ' seconds, code', this.lastProtobufCode);
await Promise.delay(API_RETRY_DELAY_SECONDS * 1000);
} else if (this.lastProtobufCode && this.lastProtobufCode.code == 7) { // Was != 4
this.log('Reauthenticating on Nest service ...');
try {
await this.auth();
} catch(error) {
this.log('Reauthentication failed, waiting for ' + API_AUTH_FAIL_RETRY_DELAY_SECONDS + ' seconds');
await Promise.delay(API_AUTH_FAIL_RETRY_DELAY_SECONDS * 1000);
}
} else {
this.verbose('API observe: resolving null, code', this.lastProtobufCode);
this.lastProtobufCode = null;
resolve(null);
}
} catch(error) {
this.error('API observe: error', error);
this.error('^^^^^ this message is for information only, it does not mean there is a problem, please do not file a ticket unless you actually have a problem with the function of the plug-in');
this.error('Retrying in ' + API_RETRY_DELAY_SECONDS + ' seconds.');
return Promise.delay(API_RETRY_DELAY_SECONDS * 1000);
} else if (this.lastProtobufCode && this.lastProtobufCode.code == 7) { // Was != 4
this.log('Reauthenticating on Nest service ...');
return this.auth().catch(() => {
this.log('Reauthentication failed, waiting for ' + API_AUTH_FAIL_RETRY_DELAY_SECONDS + ' seconds.');
return Promise.delay(API_AUTH_FAIL_RETRY_DELAY_SECONDS * 1000);
});
} else {
this.verbose('API observe: resolving null, code', this.lastProtobufCode);
this.lastProtobufCode = null;
return Promise.resolve(null);
}
}).catch(error => {
this.error('API observe: error', error);
this.error('^^^^^ this message is for information only, it does not mean there is a problem, please do not file a ticket unless you actually have a problem with the function of the plug-in');
this.error('Retrying in ' + API_RETRY_DELAY_SECONDS + ' seconds.');
return Promise.delay(API_RETRY_DELAY_SECONDS * 1000);
}).finally(() => {
this.verbose('API observe: setting issue timer.');
apiLoopTimer = setInterval(() => {
if (apiLoopTimer) {
clearInterval(apiLoopTimer);
}
this.protobufDataTimerLoop(null, handler);
}, API_SUBSCRIBE_DELAY_SECONDS * 1000);
});
}
}

subscribe(handler) {
Expand Down
4 changes: 2 additions & 2 deletions package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,15 +37,15 @@
"prepublishOnly": "npm run lint",
"preversion": "npm run lint"
},
"version": "4.6.5",
"version": "4.6.6",
"warnings": [
{
"code": "ENOTSUP",
"required": {
"node": ">=7.0.0",
"homebridge": ">=0.2.5"
},
"pkgid": "[email protected].5"
"pkgid": "[email protected].6"
}
]
}

0 comments on commit 7c435f5

Please sign in to comment.