mirror of
https://github.com/balena-os/balena-supervisor.git
synced 2024-12-18 21:27:54 +00:00
Refactor MDNS resolver into a module
Also add integration tests for the resolver functionality to prevent regressions. Change-type: patch
This commit is contained in:
Felipe Lalanne
parent
ad52561de5
commit
6f02b17968
@ -40,13 +40,18 @@ services:
|
||||
MOCK_SYSTEMD_UNITS: openvpn.service avahi.socket
|
||||
|
||||
docker:
|
||||
image: docker:24-dind
|
||||
image: docker:dind
|
||||
stop_grace_period: 3s
|
||||
privileged: true
|
||||
environment:
|
||||
DOCKER_TLS_CERTDIR: ''
|
||||
command: --tls=false # --debug
|
||||
|
||||
mdns:
|
||||
image: ydkn/avahi:latest
|
||||
# This hostname should be resolved
|
||||
hostname: my-device
|
||||
|
||||
sut:
|
||||
# Build the supervisor code for development and testing
|
||||
build:
|
||||
@ -69,6 +74,7 @@ services:
|
||||
- balena-supervisor-sut
|
||||
- docker
|
||||
- mock-systemd
|
||||
- mdns
|
||||
stop_grace_period: 3s
|
||||
volumes:
|
||||
- dbus:/shared/dbus
|
||||
|
||||
141
src/app.ts
141
src/app.ts
@ -6,145 +6,8 @@ import { setDefaultAutoSelectFamilyAttemptTimeout } from 'net';
|
||||
// Increase the timeout for the happy eyeballs algorithm to 5000ms to avoid issues on slower networks
|
||||
setDefaultAutoSelectFamilyAttemptTimeout(5000);
|
||||
|
||||
import { NOTFOUND } from 'dns';
|
||||
import * as mdnsResolver from 'mdns-resolver';
|
||||
|
||||
class DnsLookupError extends Error {
|
||||
public constructor(public code: string = NOTFOUND) {
|
||||
super();
|
||||
}
|
||||
}
|
||||
|
||||
interface DnsLookupCallback {
|
||||
(err: any): void;
|
||||
(err: undefined | null, address: string, family: number): void;
|
||||
(
|
||||
err: undefined | null,
|
||||
addresses: Array<{ address: string; family: number }>,
|
||||
): void;
|
||||
}
|
||||
|
||||
interface DnsLookupOpts {
|
||||
verbatim: boolean;
|
||||
all: boolean;
|
||||
family: number;
|
||||
}
|
||||
|
||||
/*
|
||||
* =====================================================
|
||||
* NOTE: This is required since Alpine/musl-based images
|
||||
* do not support mDNS name resolution in the musl libs.
|
||||
*
|
||||
* In order to support .local mDNS names in development
|
||||
* and on openBalena setups, this extra code will perform
|
||||
* the lookup instead of passing it to the built-in
|
||||
* function.
|
||||
* ==================================================
|
||||
*/
|
||||
async function mdnsLookup(
|
||||
name: string,
|
||||
opts: Partial<DnsLookupOpts> | number | null | undefined,
|
||||
cb: DnsLookupCallback,
|
||||
) {
|
||||
// determine which resolvers to use...
|
||||
const getResolvers = () => {
|
||||
// logic to determine the families based on Node docs.
|
||||
// See: https://nodejs.org/api/dns.html#dns_dns_lookup_hostname_options_callback
|
||||
const families = (() => {
|
||||
// strictly defined...
|
||||
if (opts === 4 || opts === 6) {
|
||||
return [opts as number];
|
||||
}
|
||||
|
||||
// opts is passed, not a number and the `family` parameter is passed...
|
||||
if (opts && typeof opts !== 'number' && opts.family) {
|
||||
return [opts.family];
|
||||
}
|
||||
|
||||
// default to resolve both v4 and v6...
|
||||
return [4, 6];
|
||||
})();
|
||||
|
||||
// map them and return...
|
||||
return families.map(async (family) => {
|
||||
let address = '';
|
||||
try {
|
||||
address = await mdnsResolver.resolve(name, family === 6 ? 'AAAA' : 'A');
|
||||
} catch {
|
||||
/* noop */
|
||||
}
|
||||
|
||||
return { address, family };
|
||||
});
|
||||
};
|
||||
|
||||
// resolve the addresses...
|
||||
const results = await Promise.all(getResolvers());
|
||||
// remove any that didn't resolve...
|
||||
let allAddresses = results.filter((result) => result.address !== '');
|
||||
|
||||
// unless the results should be returned verbatim, sort them so v4 comes first...
|
||||
if (opts && typeof opts !== 'number' && !opts.verbatim) {
|
||||
allAddresses = allAddresses.sort((a, b) => a.family - b.family);
|
||||
}
|
||||
|
||||
// see if we resolved anything...
|
||||
if (allAddresses.length === 0) {
|
||||
// nothing! return a suitable error...
|
||||
return cb(new DnsLookupError());
|
||||
}
|
||||
|
||||
// all the addresses were requested...
|
||||
if (opts && typeof opts !== 'number' && opts.all) {
|
||||
return cb(null, allAddresses);
|
||||
}
|
||||
|
||||
// only a single address was requested...
|
||||
const [{ address: addr, family: fmly }] = allAddresses;
|
||||
return cb(null, addr, fmly);
|
||||
}
|
||||
|
||||
// This was originally wrapped in a do block in
|
||||
// coffeescript, and it's not clear now why that was the
|
||||
// case, so I'm going to maintain that behaviour
|
||||
(() => {
|
||||
// Make NodeJS RFC 3484 compliant for properly handling IPv6
|
||||
// See: https://github.com/nodejs/node/pull/14731
|
||||
// https://github.com/nodejs/node/pull/17793
|
||||
// We disable linting for the next line. The require call
|
||||
// is necesary for monkey-patching the dns module
|
||||
const dns = require('dns'); // eslint-disable-line
|
||||
const { lookup } = dns;
|
||||
|
||||
dns.lookup = (
|
||||
name: string,
|
||||
opts: Partial<DnsLookupOpts> | number | null | undefined,
|
||||
cb: DnsLookupCallback,
|
||||
) => {
|
||||
if (typeof cb !== 'function') {
|
||||
return lookup(name, { verbatim: true }, opts);
|
||||
}
|
||||
|
||||
// Try a regular dns lookup first
|
||||
return lookup(
|
||||
name,
|
||||
Object.assign({ verbatim: true }, opts),
|
||||
(error: any, address: string, family: number) => {
|
||||
if (error == null) {
|
||||
return cb(null, address, family);
|
||||
}
|
||||
|
||||
// If the regular lookup fails, we perform a mdns lookup if the
|
||||
// name ends with .local
|
||||
if (name && name.endsWith('.local')) {
|
||||
return mdnsLookup(name, opts, cb);
|
||||
}
|
||||
|
||||
return cb(error);
|
||||
},
|
||||
);
|
||||
};
|
||||
})();
|
||||
// Setup MDNS resolution
|
||||
import './mdns';
|
||||
|
||||
import Supervisor from './supervisor';
|
||||
import process from 'process';
|
||||
|
||||
139
src/mdns.ts
Normal file
139
src/mdns.ts
Normal file
@ -0,0 +1,139 @@
|
||||
import { NOTFOUND } from 'dns';
|
||||
import * as mdnsResolver from 'mdns-resolver';
|
||||
|
||||
class DnsLookupError extends Error {
|
||||
public constructor(public code: string = NOTFOUND) {
|
||||
super();
|
||||
}
|
||||
}
|
||||
|
||||
interface DnsLookupCallback {
|
||||
(err: any): void;
|
||||
(err: undefined | null, address: string, family: number): void;
|
||||
(
|
||||
err: undefined | null,
|
||||
addresses: Array<{ address: string; family: number }>,
|
||||
): void;
|
||||
}
|
||||
|
||||
interface DnsLookupOpts {
|
||||
verbatim: boolean;
|
||||
all: boolean;
|
||||
family: number;
|
||||
}
|
||||
|
||||
/*
|
||||
* =====================================================
|
||||
* NOTE: This is required since Alpine/musl-based images
|
||||
* do not support mDNS name resolution in the musl libs.
|
||||
*
|
||||
* In order to support .local mDNS names in development
|
||||
* and on openBalena setups, this extra code will perform
|
||||
* the lookup instead of passing it to the built-in
|
||||
* function.
|
||||
* ==================================================
|
||||
*/
|
||||
async function mdnsLookup(
|
||||
name: string,
|
||||
opts: Partial<DnsLookupOpts> | number | null | undefined,
|
||||
cb: DnsLookupCallback,
|
||||
) {
|
||||
// determine which resolvers to use...
|
||||
const getResolvers = () => {
|
||||
// logic to determine the families based on Node docs.
|
||||
// See: https://nodejs.org/api/dns.html#dns_dns_lookup_hostname_options_callback
|
||||
const families = (() => {
|
||||
// strictly defined...
|
||||
if (opts === 4 || opts === 6) {
|
||||
return [opts as number];
|
||||
}
|
||||
|
||||
// opts is passed, not a number and the `family` parameter is passed...
|
||||
if (opts && typeof opts !== 'number' && opts.family) {
|
||||
return [opts.family];
|
||||
}
|
||||
|
||||
// default to resolve both v4 and v6...
|
||||
return [4, 6];
|
||||
})();
|
||||
|
||||
// map them and return...
|
||||
return families.map(async (family) => {
|
||||
let address = '';
|
||||
try {
|
||||
address = await mdnsResolver.resolve(name, family === 6 ? 'AAAA' : 'A');
|
||||
} catch {
|
||||
/* noop */
|
||||
}
|
||||
|
||||
return { address, family };
|
||||
});
|
||||
};
|
||||
|
||||
// resolve the addresses...
|
||||
const results = await Promise.all(getResolvers());
|
||||
// remove any that didn't resolve...
|
||||
let allAddresses = results.filter((result) => result.address !== '');
|
||||
|
||||
// unless the results should be returned verbatim, sort them so v4 comes first...
|
||||
if (opts && typeof opts !== 'number' && !opts.verbatim) {
|
||||
allAddresses = allAddresses.sort((a, b) => a.family - b.family);
|
||||
}
|
||||
|
||||
// see if we resolved anything...
|
||||
if (allAddresses.length === 0) {
|
||||
// nothing! return a suitable error...
|
||||
return cb(new DnsLookupError());
|
||||
}
|
||||
|
||||
// all the addresses were requested...
|
||||
if (opts && typeof opts !== 'number' && opts.all) {
|
||||
return cb(null, allAddresses);
|
||||
}
|
||||
|
||||
// only a single address was requested...
|
||||
const [{ address: addr, family: fmly }] = allAddresses;
|
||||
return cb(null, addr, fmly);
|
||||
}
|
||||
|
||||
// This was originally wrapped in a do block in
|
||||
// coffeescript, and it's not clear now why that was the
|
||||
// case, so I'm going to maintain that behaviour
|
||||
(() => {
|
||||
// Make NodeJS RFC 3484 compliant for properly handling IPv6
|
||||
// See: https://github.com/nodejs/node/pull/14731
|
||||
// https://github.com/nodejs/node/pull/17793
|
||||
// We disable linting for the next line. The require call
|
||||
// is necesary for monkey-patching the dns module
|
||||
const dns = require('dns'); // eslint-disable-line
|
||||
const { lookup } = dns;
|
||||
|
||||
dns.lookup = (
|
||||
name: string,
|
||||
opts: Partial<DnsLookupOpts> | number | null | undefined,
|
||||
cb: DnsLookupCallback,
|
||||
) => {
|
||||
if (typeof cb !== 'function') {
|
||||
return lookup(name, { verbatim: true }, opts);
|
||||
}
|
||||
|
||||
// Try a regular dns lookup first
|
||||
return lookup(
|
||||
name,
|
||||
Object.assign({ verbatim: true }, opts),
|
||||
(error: any, address: string, family: number) => {
|
||||
if (error == null) {
|
||||
return cb(null, address, family);
|
||||
}
|
||||
|
||||
// If the regular lookup fails, we perform a mdns lookup if the
|
||||
// name ends with .local
|
||||
if (name && name.endsWith('.local')) {
|
||||
return mdnsLookup(name, opts, cb);
|
||||
}
|
||||
|
||||
return cb(error);
|
||||
},
|
||||
);
|
||||
};
|
||||
})();
|
||||
24
test/integration/mdns.spec.ts
Normal file
24
test/integration/mdns.spec.ts
Normal file
@ -0,0 +1,24 @@
|
||||
import { expect } from 'chai';
|
||||
import { promisify } from 'util';
|
||||
|
||||
import '~/src/mdns';
|
||||
|
||||
describe('MDNS', () => {
|
||||
it('resolves global domain names', async () => {
|
||||
const dns = require('dns'); // eslint-disable-line
|
||||
const lookup = promisify(dns.lookup);
|
||||
const res = await lookup('www.google.com', { all: true });
|
||||
expect(res).to.not.be.null;
|
||||
expect(res.length).to.be.greaterThan(0);
|
||||
expect(Object.keys(res[0])).to.deep.equal(['address', 'family']);
|
||||
});
|
||||
|
||||
it('resolves .local domain names', async () => {
|
||||
const dns = require('dns'); // eslint-disable-line
|
||||
const lookup = promisify(dns.lookup);
|
||||
const res = await lookup('my-device.local', { all: true });
|
||||
expect(res).to.not.be.null;
|
||||
expect(res.length).to.be.greaterThan(0);
|
||||
expect(Object.keys(res[0])).to.deep.equal(['address', 'family']);
|
||||
});
|
||||
});
|
||||
Loading…
Reference in New Issue
Block a user