mirror of
https://github.com/balena-io/balena-cli.git
synced 2024-12-19 05:37:51 +00:00
tunnel: Refactor to improve log output
Improve the log output and error handling in the tunnel command code. Signed-off-by: Rich Bayliss <rich@balena.io> Change-type: patch
This commit is contained in:
Rich Bayliss
parent
4b7e0a19eb
commit
f72b556d92
@ -1,5 +1,5 @@
|
||||
/*
|
||||
Copyright 2016-2017 Balena
|
||||
Copyright 2019 Balena
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
@ -18,7 +18,7 @@ import * as _ from 'lodash';
|
||||
import { CommandDefinition } from 'capitano';
|
||||
import { stripIndent } from 'common-tags';
|
||||
import { isArray } from 'util';
|
||||
import { createServer } from 'net';
|
||||
import { Socket, Server, createServer } from 'net';
|
||||
import { tunnelConnectionToDevice } from '../utils/tunnel';
|
||||
|
||||
interface Args {
|
||||
@ -29,14 +29,32 @@ interface Options {
|
||||
port: string | string[];
|
||||
}
|
||||
|
||||
class DeviceIsOfflineError extends Error {
|
||||
uuid: string;
|
||||
constructor(uuid: string) {
|
||||
super(`Device '${uuid}' is offline`);
|
||||
this.uuid = uuid;
|
||||
}
|
||||
}
|
||||
class InvalidPortMappingError extends Error {
|
||||
constructor(mapping: string) {
|
||||
super(`'${mapping}' is not a valid port mapping.`);
|
||||
}
|
||||
}
|
||||
|
||||
class NoPortsDefinedError extends Error {
|
||||
constructor() {
|
||||
super('No ports have been provided.');
|
||||
}
|
||||
}
|
||||
|
||||
const isValidPort = (port: number) => {
|
||||
const MAX_PORT_VALUE = Math.pow(2, 16) - 1;
|
||||
return port > 0 && port <= MAX_PORT_VALUE;
|
||||
};
|
||||
|
||||
export const tunnel: CommandDefinition<Args, Options> = {
|
||||
signature: 'tunnel [uuid]',
|
||||
signature: 'tunnel <uuid>',
|
||||
description: 'Tunnel local ports to your balenaOS device',
|
||||
help: stripIndent`
|
||||
Use this command to open local ports which tunnel to listening ports on your balenaOS device.
|
||||
@ -79,74 +97,145 @@ export const tunnel: CommandDefinition<Args, Options> = {
|
||||
const logger = new Logger();
|
||||
const balena = await import('balena-sdk');
|
||||
const sdk = balena.fromSharedOptions();
|
||||
return Bluebird.try(() => {
|
||||
logger.logInfo(`Tunnel to ${params.uuid}`);
|
||||
|
||||
const ports =
|
||||
typeof options.port !== 'string' && isArray(options.port)
|
||||
? (options.port as string[])
|
||||
: [options.port as string];
|
||||
const logConnection = (
|
||||
fromHost: string,
|
||||
fromPort: number,
|
||||
localAddress: string,
|
||||
localPort: number,
|
||||
deviceAddress: string,
|
||||
devicePort: number,
|
||||
err?: Error,
|
||||
) => {
|
||||
const logMessage = `${fromHost}:${fromPort} => ${localAddress}:${localPort} ===> ${deviceAddress}:${devicePort}`;
|
||||
|
||||
const localListeners = _.chain(ports)
|
||||
.map(mapping => {
|
||||
const regexResult = /^([0-9]+)(?:$|\:(?:([\w\:\.]+)\:|)([0-9]+))$/.exec(
|
||||
mapping,
|
||||
);
|
||||
if (err) {
|
||||
logger.logError(`${logMessage} :: ${err.message}`);
|
||||
} else {
|
||||
logger.logLogs(logMessage);
|
||||
}
|
||||
};
|
||||
|
||||
if (regexResult === null) {
|
||||
throw new InvalidPortMappingError(mapping);
|
||||
logger.logInfo(`Tunnel to ${params.uuid}`);
|
||||
|
||||
if (options.port === undefined) {
|
||||
throw new NoPortsDefinedError();
|
||||
}
|
||||
|
||||
const ports =
|
||||
typeof options.port !== 'string' && isArray(options.port)
|
||||
? (options.port as string[])
|
||||
: [options.port as string];
|
||||
|
||||
return Bluebird.try(() =>
|
||||
sdk.models.device
|
||||
.get(params.uuid)
|
||||
.then(device => {
|
||||
if (!device.is_online) {
|
||||
throw new DeviceIsOfflineError(params.uuid);
|
||||
}
|
||||
|
||||
// grab the groups
|
||||
let [, remotePort, localHost, localPort] = regexResult;
|
||||
|
||||
// default bind to localhost
|
||||
if (localHost == undefined) {
|
||||
localHost = 'localhost';
|
||||
}
|
||||
|
||||
// default use same port number locally as remote
|
||||
if (localPort == undefined) {
|
||||
localPort = remotePort;
|
||||
}
|
||||
|
||||
return {
|
||||
localPort: parseInt(localPort),
|
||||
localHost,
|
||||
remotePort: parseInt(remotePort),
|
||||
};
|
||||
})
|
||||
.map(({ localPort, localHost, remotePort }) => {
|
||||
return tunnelConnectionToDevice(params.uuid, remotePort, sdk)
|
||||
.then(handler => {
|
||||
logger.logInfo(
|
||||
`- tunnelling ${localHost}:${localPort} to remote:${remotePort}`,
|
||||
const localListeners = _.chain(ports)
|
||||
.map(mapping => {
|
||||
const regexResult = /^([0-9]+)(?:$|\:(?:([\w\:\.]+)\:|)([0-9]+))$/.exec(
|
||||
mapping,
|
||||
);
|
||||
return createServer(handler)
|
||||
.on('connection', connection => {
|
||||
logger.logLogs(
|
||||
`[${new Date().toISOString()}] => ${
|
||||
connection.remotePort
|
||||
} => ${
|
||||
connection.localAddress
|
||||
}:${localPort} => ${remotePort}`,
|
||||
);
|
||||
})
|
||||
.on('error', err => {
|
||||
console.error(err);
|
||||
throw err;
|
||||
})
|
||||
.listen(localPort, localHost);
|
||||
})
|
||||
.catch((err: Error) => {
|
||||
console.error(err);
|
||||
});
|
||||
})
|
||||
.value();
|
||||
|
||||
return Bluebird.all(localListeners).then(() => {
|
||||
logger.logInfo('Waiting for connections...');
|
||||
});
|
||||
}).nodeify(done);
|
||||
if (regexResult === null) {
|
||||
throw new InvalidPortMappingError(mapping);
|
||||
}
|
||||
|
||||
// grab the groups
|
||||
let [, remotePort, localAddress, localPort] = regexResult;
|
||||
|
||||
if (
|
||||
!isValidPort(parseInt(localPort)) ||
|
||||
!isValidPort(parseInt(remotePort))
|
||||
) {
|
||||
throw new InvalidPortMappingError(mapping);
|
||||
}
|
||||
|
||||
// default bind to localAddress
|
||||
if (localAddress == undefined) {
|
||||
localAddress = 'localhost';
|
||||
}
|
||||
|
||||
// default use same port number locally as remote
|
||||
if (localPort == undefined) {
|
||||
localPort = remotePort;
|
||||
}
|
||||
|
||||
return {
|
||||
localPort: parseInt(localPort),
|
||||
localAddress,
|
||||
remotePort: parseInt(remotePort),
|
||||
};
|
||||
})
|
||||
.map(({ localPort, localAddress, remotePort }) => {
|
||||
return tunnelConnectionToDevice(params.uuid, remotePort, sdk)
|
||||
.then(handler =>
|
||||
createServer((client: Socket) => {
|
||||
return handler(client)
|
||||
.then(() => {
|
||||
logConnection(
|
||||
client.remoteAddress,
|
||||
client.remotePort,
|
||||
client.localAddress,
|
||||
client.localPort,
|
||||
device.vpn_address || '',
|
||||
remotePort,
|
||||
);
|
||||
})
|
||||
.catch(err =>
|
||||
logConnection(
|
||||
client.remoteAddress,
|
||||
client.remotePort,
|
||||
client.localAddress,
|
||||
client.localPort,
|
||||
device.vpn_address || '',
|
||||
remotePort,
|
||||
err,
|
||||
),
|
||||
);
|
||||
}),
|
||||
)
|
||||
.then(
|
||||
server =>
|
||||
new Bluebird.Promise<Server>((resolve, reject) => {
|
||||
server.on('error', reject);
|
||||
server.listen(localPort, localAddress, () => {
|
||||
resolve(server);
|
||||
});
|
||||
}),
|
||||
)
|
||||
.then(() => {
|
||||
logger.logInfo(
|
||||
` - tunnelling ${localAddress}:${localPort} to device:${remotePort}`,
|
||||
);
|
||||
|
||||
return true;
|
||||
})
|
||||
.catch((err: Error) => {
|
||||
logger.logWarn(
|
||||
` - not tunnelling ${localAddress}:${localPort} to device:${remotePort}, failed ${JSON.stringify(
|
||||
err.message,
|
||||
)}`,
|
||||
);
|
||||
|
||||
return false;
|
||||
});
|
||||
})
|
||||
.value();
|
||||
|
||||
return Bluebird.all(localListeners);
|
||||
})
|
||||
.then(results => {
|
||||
if (!results.includes(true)) {
|
||||
throw new Error('No ports are valid for tunnelling');
|
||||
}
|
||||
|
||||
logger.logInfo('Waiting for connections...');
|
||||
}),
|
||||
).nodeify(done);
|
||||
},
|
||||
};
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
/*
|
||||
Copyright 2016-2017 Balena
|
||||
Copyright 2019 Balena
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
@ -16,8 +16,26 @@ limitations under the License.
|
||||
import * as Bluebird from 'bluebird';
|
||||
import { BalenaSDK } from 'balena-sdk';
|
||||
import { Socket } from 'net';
|
||||
import { TypedError } from 'typed-error';
|
||||
|
||||
class UnableToConnectError extends Error {}
|
||||
const PROXY_CONNECT_TIMEOUT_MS = 10000;
|
||||
|
||||
class UnableToConnectError extends TypedError {
|
||||
status: string;
|
||||
statusCode: string;
|
||||
constructor(statusCode: string, status: string) {
|
||||
super(`Unable to connect: ${statusCode} ${status}`);
|
||||
this.status = status;
|
||||
this.statusCode = statusCode;
|
||||
}
|
||||
}
|
||||
|
||||
class RemoteSocketNotListening extends TypedError {
|
||||
port: number;
|
||||
constructor(port: number) {
|
||||
super(`Device is not listening on port ${port}`);
|
||||
}
|
||||
}
|
||||
|
||||
export const tunnelConnectionToDevice = (
|
||||
uuid: string,
|
||||
@ -34,35 +52,29 @@ export const tunnelConnectionToDevice = (
|
||||
password: token,
|
||||
};
|
||||
|
||||
return (client: Socket): void => {
|
||||
return (client: Socket): Bluebird<void> =>
|
||||
openPortThroughProxy(vpnUrl, 3128, auth, uuid, port)
|
||||
.then(remote => {
|
||||
client.pipe(remote);
|
||||
remote.pipe(client);
|
||||
|
||||
remote.on('error', err => {
|
||||
console.error('Remote: ' + err);
|
||||
client.end();
|
||||
});
|
||||
|
||||
client.on('error', err => {
|
||||
console.error('Client: ' + err);
|
||||
remote.end();
|
||||
});
|
||||
|
||||
remote.on('close', () => {
|
||||
client.end();
|
||||
});
|
||||
|
||||
client.on('close', () => {
|
||||
remote.end();
|
||||
});
|
||||
})
|
||||
.tapCatch(err => {
|
||||
console.error(err);
|
||||
.tapCatch(() => {
|
||||
client.end();
|
||||
});
|
||||
};
|
||||
});
|
||||
};
|
||||
|
||||
@ -85,6 +97,7 @@ const openPortThroughProxy = (
|
||||
|
||||
return new Bluebird.Promise<Socket>((resolve, reject) => {
|
||||
const proxyTunnel = new Socket();
|
||||
proxyTunnel.on('error', reject);
|
||||
proxyTunnel.connect(proxyPort, proxyServer, () => {
|
||||
const proxyConnectionHandler = (data: Buffer) => {
|
||||
proxyTunnel.removeListener('data', proxyConnectionHandler);
|
||||
@ -92,16 +105,20 @@ const openPortThroughProxy = (
|
||||
const [, httpStatusCode, ...httpMessage] = httpStatus.split(' ');
|
||||
|
||||
if (parseInt(httpStatusCode) === 200) {
|
||||
proxyTunnel.setTimeout(0);
|
||||
resolve(proxyTunnel);
|
||||
} else {
|
||||
console.error(
|
||||
`Connection failed. ${httpStatusCode} ${httpMessage.join(' ')}`,
|
||||
reject(
|
||||
new UnableToConnectError(httpStatusCode, httpMessage.join(' ')),
|
||||
);
|
||||
reject(new UnableToConnectError());
|
||||
}
|
||||
};
|
||||
|
||||
proxyTunnel.on('timeout', () => {
|
||||
reject(new RemoteSocketNotListening(devicePort));
|
||||
});
|
||||
proxyTunnel.on('data', proxyConnectionHandler);
|
||||
proxyTunnel.setTimeout(PROXY_CONNECT_TIMEOUT_MS);
|
||||
proxyTunnel.write(httpHeaders.join('\r\n').concat('\r\n\r\n'));
|
||||
});
|
||||
});
|
||||
|
||||
Loading…
Reference in New Issue
Block a user