Skip to content

Add method to parse host, port, and protocol from URL #100

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

Open
vartanbeno wants to merge 3 commits into
base: develop
Choose a base branch
from
Open

Add method to parse host, port, and protocol from URL #100

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
e90091d
Add method to get host, port, and secure flag from URL
vartanbeno Mar 16, 2020
846628c
parseURL for every API
vartanbeno Mar 16, 2020
f85ccc0
Assume https by default, add test cases
vartanbeno Mar 17, 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
8 changes: 8 additions & 0 deletions lib/asset.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ var
co = require('co'),

request = require('./request'),
url = require('./url'),
validation = require('./validation');

const
Expand Down Expand Up @@ -41,6 +42,13 @@ module.exports = function (assetOptions, ensureAuthHeaders, self) {
// apply additional optional settings if supplied
settings = validation.applyOptionalParameters(assetOptions, settings);

const result = url.parseURL(settings.host);
if (!validation.isEmpty(result)) {
settings.host = result.host;
settings.port = result.port;
settings.secure = result.secure;
}

// ensure request is setup
req = new request.Request(settings);
req.on(EVENT_REQUEST, (data) => (self.emit(EVENT_REQUEST, data)));
Expand Down
8 changes: 8 additions & 0 deletions lib/campaign.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ var
co = require('co'),
fs = require('fs'),
request = require('./request'),
url = require('./url'),
validation = require('./validation');

const
Expand Down Expand Up @@ -40,6 +41,13 @@ module.exports = function (campaignOptions, ensureAuthHeaders, self) {
// apply additional optional settings if supplied
settings = validation.applyOptionalParameters(campaignOptions, settings);

const result = url.parseURL(settings.host);
if (!validation.isEmpty(result)) {
settings.host = result.host;
settings.port = result.port;
settings.secure = result.secure;
}

// ensure request is setup
req = new request.Request(settings);
req.on(EVENT_REQUEST, (data) => (self.emit(EVENT_REQUEST, data)));
Expand Down
8 changes: 8 additions & 0 deletions lib/claim.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ var
co = require('co'),

request = require('./request'),
url = require('./url'),
validation = require('./validation');

const
Expand Down Expand Up @@ -39,6 +40,13 @@ module.exports = function (claimOptions, ensureAuthHeaders, self) {
// apply additional optional settings if supplied
settings = validation.applyOptionalParameters(claimOptions, settings);

const result = url.parseURL(settings.host);
if (!validation.isEmpty(result)) {
settings.host = result.host;
settings.port = result.port;
settings.secure = result.secure;
}

// ensure request is setup
req = new request.Request(settings);
req.on(EVENT_REQUEST, (data) => (self.emit(EVENT_REQUEST, data)));
Expand Down
8 changes: 8 additions & 0 deletions lib/content.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ var
co = require('co'),

request = require('./request'),
url = require('./url'),
validation = require('./validation');

const
Expand Down Expand Up @@ -45,6 +46,13 @@ module.exports = function (contentOptions, ensureAuthHeaders, self) {
// apply additional optional settings if supplied
settings = validation.applyOptionalParameters(contentOptions, settings);

const result = url.parseURL(settings.host);
if (!validation.isEmpty(result)) {
settings.host = result.host;
settings.port = result.port;
settings.secure = result.secure;
}

// ensure request is setup
req = new request.Request(settings);
req.on(EVENT_REDIRECT, (data) => (self.emit(EVENT_REDIRECT, data)));
Expand Down
8 changes: 8 additions & 0 deletions lib/device.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ var
co = require('co'),

request = require('./request'),
url = require('./url'),
validation = require('./validation');

const
Expand Down Expand Up @@ -41,6 +42,13 @@ module.exports = function (deviceOptions, ensureAuthHeaders, self) {
// apply additional optional settings if supplied
settings = validation.applyOptionalParameters(deviceOptions, settings);

const result = url.parseURL(settings.host);
if (!validation.isEmpty(result)) {
settings.host = result.host;
settings.port = result.port;
settings.secure = result.secure;
}

// ensure request is setup
req = new request.Request(settings);
req.on(EVENT_REQUEST, (data) => (self.emit(EVENT_REQUEST, data)));
Expand Down
8 changes: 8 additions & 0 deletions lib/key.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ var
co = require('co'),

request = require('./request'),
url = require('./url'),
validation = require('./validation');

const
Expand Down Expand Up @@ -58,6 +59,13 @@ module.exports = function (keyOptions, clientId, secret, self) {
// apply additional optional settings if supplied
settings = validation.applyOptionalParameters(keyOptions, settings);

const result = url.parseURL(settings.host);
if (!validation.isEmpty(result)) {
settings.host = result.host;
settings.port = result.port;
settings.secure = result.secure;
}

// ensure request is setup
req = new request.Request(settings);
req.on(EVENT_REQUEST, (data) => (self.emit(EVENT_REQUEST, data)));
Expand Down
8 changes: 8 additions & 0 deletions lib/location.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ var
co = require('co'),

request = require('./request'),
url = require('./url'),
validation = require('./validation');

const
Expand Down Expand Up @@ -39,6 +40,13 @@ module.exports = function (locationOptions, ensureAuthHeaders, self) {
// apply additional optional settings if supplied
settings = validation.applyOptionalParameters(locationOptions, settings);

const result = url.parseURL(settings.host);
if (!validation.isEmpty(result)) {
settings.host = result.host;
settings.port = result.port;
settings.secure = result.secure;
}

// ensure request is setup
req = new request.Request(settings);
req.on(EVENT_REQUEST, (data) => (self.emit(EVENT_REQUEST, data)));
Expand Down
8 changes: 8 additions & 0 deletions lib/music.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ var
co = require('co'),

request = require('./request'),
url = require('./url'),
validation = require('./validation');

const
Expand Down Expand Up @@ -43,6 +44,13 @@ module.exports = function (musicOptions, ensureAuthHeaders, self) {
// apply additional optional settings if supplied
settings = validation.applyOptionalParameters(musicOptions, settings);

const result = url.parseURL(settings.host);
if (!validation.isEmpty(result)) {
settings.host = result.host;
settings.port = result.port;
settings.secure = result.secure;
}

// ensure request is setup
req = new request.Request(settings);
req.on(EVENT_REQUEST, (data) => (self.emit(EVENT_REQUEST, data)));
Expand Down
8 changes: 8 additions & 0 deletions lib/playback.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ var
co = require('co'),

request = require('./request'),
url = require('./url'),
validation = require('./validation');

const
Expand Down Expand Up @@ -39,6 +40,13 @@ module.exports = function (playbackOptions, ensureAuthHeaders, self) {
// apply additional optional settings if supplied
settings = validation.applyOptionalParameters(playbackOptions, settings);

const result = url.parseURL(settings.host);
if (!validation.isEmpty(result)) {
settings.host = result.host;
settings.port = result.port;
settings.secure = result.secure;
}

// ensure request is setup
req = new request.Request(settings);
req.on(EVENT_REQUEST, (data) => (self.emit(EVENT_REQUEST, data)));
Expand Down
8 changes: 8 additions & 0 deletions lib/player.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ var
co = require('co'),
events = require('events'),
io = require('socket.io-client'),
url = require('./url'),
validation = require('./validation');

let
Expand Down Expand Up @@ -46,6 +47,13 @@ module.exports = function (playerOptions, ensureAuthHeaders, self) {
// apply additional optional settings if supplied
settings = validation.applyOptionalParameters(playerOptions, settings);

const result = url.parseURL(settings.host);
if (!validation.isEmpty(result)) {
settings.host = result.host;
settings.port = result.port;
settings.secure = result.secure;
}

self.settings = () => (settings);

self.connect = (options, socketEventSubscriber) => co(function *() {
Expand Down
8 changes: 8 additions & 0 deletions lib/provision.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ var
co = require('co'),

request = require('./request'),
url = require('./url'),
validation = require('./validation');

const
Expand Down Expand Up @@ -42,6 +43,13 @@ module.exports = function (provisionOptions, ensureAuthHeaders, self) {
// apply additional optional settings if supplied
settings = validation.applyOptionalParameters(provisionOptions, settings);

const result = url.parseURL(settings.host);
if (!validation.isEmpty(result)) {
settings.host = result.host;
settings.port = result.port;
settings.secure = result.secure;
}

// ensure request is setup
req = new request.Request(settings);
req.on(EVENT_REQUEST, (data) => (self.emit(EVENT_REQUEST, data)));
Expand Down
8 changes: 8 additions & 0 deletions lib/relationship.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ var
co = require('co'),

request = require('./request'),
url = require('./url'),
validation = require('./validation');

const
Expand Down Expand Up @@ -39,6 +40,13 @@ module.exports = function (relationshipsOptions, ensureAuthHeaders, self) {
// apply additional optional settings if supplied
settings = validation.applyOptionalParameters(relationshipsOptions, settings);

const result = url.parseURL(settings.host);
if (!validation.isEmpty(result)) {
settings.host = result.host;
settings.port = result.port;
settings.secure = result.secure;
}

// ensure request is setup
req = new request.Request(settings);
req.on(EVENT_REQUEST, (data) => (self.emit(EVENT_REQUEST, data)));
Expand Down
8 changes: 8 additions & 0 deletions lib/settings.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ var
co = require('co'),

request = require('./request'),
url = require('./url'),
validation = require('./validation');

const
Expand Down Expand Up @@ -39,6 +40,13 @@ module.exports = function (settingsOptions, ensureAuthHeaders, self) {
// apply additional optional settings if supplied
settings = validation.applyOptionalParameters(settingsOptions, settings);

const result = url.parseURL(settings.host);
if (!validation.isEmpty(result)) {
settings.host = result.host;
settings.port = result.port;
settings.secure = result.secure;
}

// ensure request is setup
req = new request.Request(settings);
req.on(EVENT_REQUEST, (data) => (self.emit(EVENT_REQUEST, data)));
Expand Down
49 changes: 49 additions & 0 deletions lib/url.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
const { URL } = require('url');

const PROTOCOL_HTTP = 'http:';
const PROTOCOL_HTTPS = 'https:';

/**
* Parse the input (URL string) to get its hostname, port, and protocol.
* In the case that it's not parsable and it throws an error, return an empty object.
* We do this to preserve backward compatibility.
* Note: this method assumes you are using either HTTP or HTTPS protocols. It assumes HTTPS if protocol isn't provided.
* @param {String} input The URL.
* @param {Object} output An object containing host, port, and secure properties.
* @returns {Object} The object containing valid host, port, and secure keys based on the input.
*/
const parseURL = (input) => {
Copy link

@fvnilo fvnilo Mar 16, 2020

Choose a reason for hiding this comment

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

As mentionned in the global comments, I think here I would handle the case of not specifying a protocol.

const output = {};

if (typeof(input) !== 'string') {
return output;
}

input = input.trim();
if (input === '') {
return output;
}

if (!input.startsWith(PROTOCOL_HTTP) && !input.startsWith(PROTOCOL_HTTPS)) {
input = PROTOCOL_HTTPS + input;
Copy link

@fvnilo fvnilo Mar 17, 2020

Choose a reason for hiding this comment

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

Shouldn't you add a // in the middle here?

Copy link
Contributor Author

@vartanbeno vartanbeno Mar 17, 2020

Choose a reason for hiding this comment

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

It doesn't seem to be required by the url module to parse the input. On second thought though, I'll add it since most people expect https:// instead of just https:.

}

let url;
try {
url = new URL(input);
} catch (e) {
Copy link

@fvnilo fvnilo Mar 17, 2020

Choose a reason for hiding this comment

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

Would it be useful to log a warning, you think?

return output;
}

const { hostname, port, protocol } = url;

output.host = hostname;
output.port = port;
output.secure = protocol === PROTOCOL_HTTPS;

return output;
};

module.exports = {
parseURL
};
Loading