Skip to content

add support for external hostname options to be an array #64

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
arj03 merged 3 commits into from
Dec 22, 2020
Merged

add support for external hostname options to be an array #64

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3204ed8
add support for external hostname options to be an array
austinfrey Dec 20, 2020
04b4511
use helper functions and treat all external values as arrays when for…
austinfrey Dec 21, 2020
3826c39
refactor to remove helper functions in ws/net stringify method
austinfrey Dec 22, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 20 additions & 8 deletions compose.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,14 +102,26 @@ module.exports = function (ary, wrap) {
},
parse: parse,
stringify: function (scope) {
var none
var _ary = ary.map(function (e) {
var v = e.stringify(scope)
if(!v) none = true
else return v
})
if(none) return
return SE.stringify(_ary)
var _ary = []
var v = proto.stringify(scope)
if(!v) return
else {
// if true, more than one hostname needs to be updated
if (v.split(';').length > 1) {
var addresses = v.split(';')
addresses.forEach(a => {
_ary.push(a)
})
}
else _ary.push(v)
}
return _ary.map(e => {
var singleAddr = [e].concat(trans.map(t => {
return t.stringify(scope)
}))

return SE.stringify(singleAddr)
}).join(';')
}
}
}
Expand Down
13 changes: 9 additions & 4 deletions plugins/net.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,10 +120,15 @@ module.exports = ({ scope = 'device', host, port, external, allowHalfOpen, pause
return null
}

// Remove IPv6 scopeid suffix, if any, e.g. `%wlan0`
resultHost = resultHost.replace(/(\%\w+)$/, '')

return toAddress(resultHost, port)
// convert to an array for easier formatting
if (isString(resultHost)) {
resultHost = [resultHost]
}

return resultHost.map((h) => {
// Remove IPv6 scopeid suffix, if any, e.g. `%wlan0`
return toAddress(h.replace(/(\%\w+)$/, ''), port)
}).join(';')
}
}
}
Expand Down
20 changes: 13 additions & 7 deletions plugins/ws.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,19 +130,25 @@ module.exports = function (opts = {}) {

const port = opts.server ? opts.server.address().port : opts.port
const externalHost = targetScope === 'public' && opts.external
const resultHost = externalHost || opts.host || scopes.host(targetScope)
let resultHost = externalHost || opts.host || scopes.host(targetScope)

if (resultHost == null) {
// The device has no network interface for a given `targetScope`.
return null
}

return URL.format({
protocol: secure ? 'wss' : 'ws',
slashes: true,
hostname: resultHost,
port: (secure ? port == 443 : port == 80) ? undefined : port
})
if (typeof resultHost === 'string') {
resultHost = [resultHost]
}

return resultHost.map((h) => {
return URL.format({

@arj03 arj03 Dec 21, 2020

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we move this into a helper function?

@austinfrey austinfrey Dec 21, 2020

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@arj03 i refactored a bit. was not sure where to put these helpers exactly so if they should live somewhere else, let me know. the change is to treat all external values as an array so if it comes in as a string, put it in an array, this cut down of some duplication.

@arj03 arj03 Dec 22, 2020

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Much better. I think you can actually leave out the function now.

@austinfrey austinfrey Dec 22, 2020

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ahh! I like that better as well. Thanks :)

protocol: secure ? 'wss' : 'ws',
slashes: true,
hostname: h,
port: (secure ? port == 443 : port == 80) ? undefined : port
})
}).join(';')
},
parse: function (str) {
var addr = URL.parse(str)
Expand Down
129 changes: 129 additions & 0 deletions test/plugs.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -460,3 +460,132 @@ tape('multiple scopes different hosts', function(t) {

t.end()
})

tape('net: external is a string', function (t) {
var net = Net({
external: 'domain.de',
scope: 'public',
port: '9966',
server: {
key: null,
address: function () { return {port: 9966}}
}})
t.equal(net.stringify('public'), 'net:domain.de:9966')
t.equal(net.stringify('local'), null)
t.equal(net.stringify('device'), null)
t.end()
})

tape('net: external is an array', function (t) {
var net = Net({
external: ['domain.de', 'funtime.net'],
scope: 'public',
port: '9966',
server: {
key: null,
address: function () { return {port: 9966}}
}})
t.equal(net.stringify('public'), 'net:domain.de:9966;net:funtime.net:9966')
t.equal(net.stringify('local'), null)
t.equal(net.stringify('device'), null)
t.end()
})

tape('net: external is an array w/ a single entry & shs transform', function (t) {
var net = Net({
external: ['domain.de'],
scope: 'public',
port: '9966',
server: {
key: null,
address: function () { return {port: 9966}}
}})
var combined = Compose([net, shs])
t.equal(
combined.stringify('public'),
'net:domain.de:9966~shs:+y42DK+BGzqvU00EWMKiyj4fITskSm+Drxq1Dt2s3Yw='
)
t.end()
})

tape('net: external is an array w/ multiple entries & shs transform', function (t) {
var net = Net({
external: ['domain.de', 'funtime.net'],
scope: 'public',
port: '9966',
server: {
key: null,
address: function () { return {port: 9966}}
}})
var combined = Compose([net, shs])
t.equal(
combined.stringify('public'),
'net:domain.de:9966~shs:+y42DK+BGzqvU00EWMKiyj4fITskSm+Drxq1Dt2s3Yw=;net:funtime.net:9966~shs:+y42DK+BGzqvU00EWMKiyj4fITskSm+Drxq1Dt2s3Yw='
)
t.end()
})

tape('ws: external is a string', function (t) {
var ws = Ws({
external: 'domain.de',
scope: 'public',
port: '9966',
server: {
key: null,
address: function () { return {port: 9966}}
}})
t.equal(ws.stringify('public'), 'ws://domain.de:9966')
t.equal(ws.stringify('local'), null)
t.equal(ws.stringify('device'), null)
t.end()
})


tape('ws: external is an array', function (t) {
var ws = Ws({
external: ['domain.de', 'funtime.net'],
scope: 'public',
port: '9966',
server: {
key: null,
address: function () { return {port: 9966}}
}})
t.equal(ws.stringify('public'), 'ws://domain.de:9966;ws://funtime.net:9966')
t.equal(ws.stringify('local'), null)
t.equal(ws.stringify('device'), null)
t.end()
})

tape('ws: external is an array w/ a single entry & shs transform', function (t) {
var ws = Ws({
external: ['domain.de'],
scope: 'public',
port: '9966',
server: {
key: null,
address: function () { return {port: 9966}}
}})
var combined = Compose([ws, shs])
t.equal(
combined.stringify('public'),
'ws://domain.de:9966~shs:+y42DK+BGzqvU00EWMKiyj4fITskSm+Drxq1Dt2s3Yw='
)
t.end()
})

tape('ws: external is an array w/ multiple entries & shs transform', function (t) {
var ws = Ws({
external: ['domain.de', 'funtime.net'],
scope: 'public',
port: '9966',
server: {
key: null,
address: function () { return {port: 9966}}
}})
var combined = Compose([ws, shs])
t.equal(
combined.stringify('public'),
'ws://domain.de:9966~shs:+y42DK+BGzqvU00EWMKiyj4fITskSm+Drxq1Dt2s3Yw=;ws://funtime.net:9966~shs:+y42DK+BGzqvU00EWMKiyj4fITskSm+Drxq1Dt2s3Yw='
)
t.end()
})