Skip to content

Commit

Permalink
Fixes #28 - Make cookie handling pluggable.
Browse files Browse the repository at this point in the history 
Updated cookie handling to call custom functions for both storage and retrieval.
Added test cases.
Updated TypeScript definitions.

Signed-off-by: Simone Bordet <[email protected]>
  • Loading branch information
@sbordet
sbordet committed Dec 14, 2021
1 parent 99c5f2a commit 5d4a17e
Show file tree
Hide file tree
Showing 5 changed files with 263 additions and 129 deletions.
6 changes: 6 additions & 0 deletions cometd-nodejs-client.d.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,15 @@ export interface HttpProxy {
excludes?: string[];
}

export interface Cookies {
storeCookie?(uri: any, header: string, callback: (failure: Error | null, cookie: any) => void): void;
retrieveCookies?(context: any, uri: any, callback: (failure: Error | null, cookies: string[]) => void): void;
}

export interface Options {
logLevel?: 'debug' | 'info';
httpProxy?: HttpProxy;
cookies?: Cookies;
}

export function adapt(options?: Options): void;
202 changes: 131 additions & 71 deletions cometd-nodejs-client.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,17 +56,82 @@ module.exports = {
return /^https/i.test(uri.protocol);
}

function _storeServerCookie(uri, header, callback) {
if (options && options.cookies && options.cookies.storeCookie) {
options.cookies.storeCookie(uri, header, callback);
} else {
const host = uri.hostname;
let jar = _globalCookies[host];
if (jar === undefined) {
_globalCookies[host] = jar = {};
}
const parts = header.split(';');
// Ignore domain, path, expiration, etc.
const nameValue = parts[0].trim();
const equal = nameValue.indexOf('=');
if (equal > 0) {
const name = nameValue.substring(0, equal);
jar[name] = nameValue;
}
callback();
}
}

function _retrieveServerCookies(context, uri, callback) {
if (options && options.cookies && options.cookies.retrieveCookies) {
options.cookies.retrieveCookies(context, uri, callback);
} else {
let globalCookies = context && context.cookieStore;
if (!globalCookies) {
globalCookies = _globalCookies;
}
let cookies = [];
const jar = globalCookies[uri.hostname];
if (jar) {
for (let name in jar) {
if (jar.hasOwnProperty(name)) {
cookies.push(jar[name]);
}
}
}
callback(null, cookies);
}
}

function _asyncForEach(array, index, operation, callback) {
while (index < array.length) {
let complete = false;
let proceed = false;
operation(array[index], () => {
complete = true;
if (proceed) {
++index;
_asyncForEach(array, index, operation, callback);
}
});
if (complete) {
++index;
} else {
proceed = true;
break;
}
}
if (index === array.length) {
callback();
}
}

// Bare minimum XMLHttpRequest implementation that works with CometD.
window.XMLHttpRequest = function() {
const _localCookies = {};
let _config;
let _request;

function _storeCookie(cookieStore, value) {
function _storeCookie(value) {
const host = _config.hostname;
let jar = cookieStore[host];
let jar = _localCookies[host];
if (jar === undefined) {
cookieStore[host] = jar = {};
_localCookies[host] = jar = {};
}
const cookies = value.split(';');
for (let i = 0; i < cookies.length; ++i) {
Expand All @@ -78,16 +143,13 @@ module.exports = {
}
}

function _concatCookies(cookieStore) {
let cookies = '';
const jar = cookieStore[_config.hostname];
function _retrieveCookies() {
const cookies = [];
const jar = _localCookies[_config.hostname];
if (jar) {
for (let name in jar) {
if (jar.hasOwnProperty(name)) {
if (cookies) {
cookies += '; ';
}
cookies += jar[name];
cookies.push(jar[name]);
}
}
}
Expand Down Expand Up @@ -144,83 +206,81 @@ module.exports = {

this.setRequestHeader = (name, value) => {
if (/^cookie$/i.test(name)) {
_storeCookie(_localCookies, value)
_storeCookie(value);
} else {
_config.headers[name] = value;
}
};

this.send = data => {
let globalCookies = this.context && this.context.cookieStore;
if (!globalCookies) {
globalCookies = _globalCookies;
}
const cookies1 = _concatCookies(globalCookies);
const cookies2 = _concatCookies(_localCookies);
const delim = (cookies1 && cookies2) ? '; ' : '';
const cookies = cookies1 + delim + cookies2;
if (cookies) {
_config.headers['Cookie'] = cookies;
}
_retrieveServerCookies(this.context, _config, (x, cookies) => {
const cookies1 = x ? '' : cookies.join('; ');
const cookies2 = _retrieveCookies().join('; ');
const delim = (cookies1 && cookies2) ? '; ' : '';
const allCookies = cookies1 + delim + cookies2;
if (allCookies) {
_config.headers['Cookie'] = allCookies;
}

const http = _secure(_config) ? https : httpc;
_request = http.request(_config, response => {
let success = false;
this.status = response.statusCode;
this.statusText = response.statusMessage;
this.readyState = window.XMLHttpRequest.HEADERS_RECEIVED;
const headers = response.headers;
for (let name in headers) {
if (headers.hasOwnProperty(name)) {
if (/^set-cookie$/i.test(name)) {
const header = headers[name];
for (let i = 0; i < header.length; ++i) {
const whole = header[i];
const parts = whole.split(';');
const cookie = parts[0];
_storeCookie(globalCookies, cookie);
const http = _secure(_config) ? https : httpc;
_request = http.request(_config, response => {
let success = false;
this.status = response.statusCode;
this.statusText = response.statusMessage;
this.readyState = window.XMLHttpRequest.HEADERS_RECEIVED;
const setCookies = [];
const headers = response.headers;
for (let name in headers) {
if (headers.hasOwnProperty(name)) {
if (/^set-cookie$/i.test(name)) {
const header = headers[name];
setCookies.push.apply(setCookies, header);
}
}
}
}
response.on('data', chunk => {
this.readyState = window.XMLHttpRequest.LOADING;
this.responseText += chunk;
});
response.on('end', () => {
success = true;
this.readyState = window.XMLHttpRequest.DONE;
if (this.onload) {
this.onload();
}
_asyncForEach(setCookies, 0, (element, callback) => {
_storeServerCookie(_config, element, callback);
}, () => {
response.on('data', chunk => {
this.readyState = window.XMLHttpRequest.LOADING;
this.responseText += chunk;
});
response.on('end', () => {
success = true;
this.readyState = window.XMLHttpRequest.DONE;
if (this.onload) {
this.onload();
}
});
response.on('close', () => {
if (!success) {
this.readyState = window.XMLHttpRequest.DONE;
if (this.onerror) {
this.onerror();
}
}
});
});
});
response.on('close', () => {
if (!success) {
['abort', 'aborted', 'error'].forEach(event => {
_request.on(event, x => {
this.readyState = window.XMLHttpRequest.DONE;
if (this.onerror) {
this.onerror();
if (x) {
const error = x.message;
if (error) {
this.statusText = error;
}
}
}
});
});
['abort', 'aborted', 'error'].forEach(event => {
_request.on(event, x => {
this.readyState = window.XMLHttpRequest.DONE;
if (x) {
const error = x.message;
if (error) {
this.statusText = error;
if (this.onerror) {
this.onerror(x);
}
}
if (this.onerror) {
this.onerror(x);
}
});
});
if (data) {
_request.write(data);
}
_request.end();
});
if (data) {
_request.write(data);
}
_request.end();
};

this.abort = () => {
Expand Down
11 changes: 7 additions & 4 deletions package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
"url": "https://github.com/cometd/cometd-nodejs-client.git"
},
"scripts": {
"test": "tsc && mocha --exit"
"test": "mocha --exit --require ts-node/register --extension ts --extension js"
},
"dependencies": {
"cometd": ">=3.1.2",
Expand All @@ -28,9 +28,12 @@
"ws": ">=7.2.0"
},
"devDependencies": {
"mocha": "latest",
"typescript": "latest",
"@types/mocha": "latest",
"@types/node": "latest",
"@types/mocha": "latest"
"@types/tough-cookie": "^4.0.1",
"mocha": "latest",
"tough-cookie": "latest",
"ts-node": "latest",
"typescript": "latest"
}
}
Loading

0 comments on commit 5d4a17e

Please sign in to comment.