mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2026-06-28 22:30:01 +00:00
Typings for continuation-local-storage
This commit is contained in:
heycalmdown
466
continuation-local-storage/continuation-local-storage-tests.ts
Normal file
466
continuation-local-storage/continuation-local-storage-tests.ts
Normal file
@@ -0,0 +1,466 @@
|
||||
import * as cls from 'continuation-local-storage';
|
||||
|
||||
import EventEmitter = NodeJS.EventEmitter;
|
||||
|
||||
class Test {
|
||||
test(topic: string, callback: (t: Test) => any): any {}
|
||||
plan(n: number): any {}
|
||||
equal(a: any, b: any, c?: any): any {}
|
||||
ok(a: any, b: any): any {}
|
||||
notOk(a: any, b: any): any {}
|
||||
comment(a: any): any {}
|
||||
end(): any {}
|
||||
doesNotThrow(a: any): any {}
|
||||
throws(a: any): any {}
|
||||
}
|
||||
|
||||
function test(topic: string, callback: (t: Test) => any) {
|
||||
}
|
||||
|
||||
// from test/async-context.tap.js
|
||||
test("asynchronously propagating state with local-context-domains", function (t) {
|
||||
t.plan(2);
|
||||
|
||||
var namespace = cls.createNamespace('namespace');
|
||||
// t.ok(process.namespaces.namespace, "namespace has been created");
|
||||
|
||||
namespace.run(function () {
|
||||
namespace.set('test', 1337);
|
||||
t.equal(namespace.get('test'), 1337, "namespace is working");
|
||||
});
|
||||
});
|
||||
|
||||
// from test/async-no-run-queue-multiple.tap.js
|
||||
|
||||
test("minimized test case that caused #6011 patch to fail", function (t) {
|
||||
t.plan(3);
|
||||
|
||||
console.log('+');
|
||||
// when the flaw was in the patch, commenting out this line would fix things:
|
||||
process.nextTick(function () { console.log('!'); });
|
||||
|
||||
var n = cls.createNamespace("test");
|
||||
t.ok(!n.get('state'), "state should not yet be visible");
|
||||
|
||||
n.run(function () {
|
||||
n.set('state', true);
|
||||
t.ok(n.get('state'), "state should be visible");
|
||||
|
||||
process.nextTick(function () {
|
||||
t.ok(n.get('state'), "state should be visible");
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
// from test/bind-emitter.tap.js
|
||||
test("event emitters bound to CLS context", function (t) {
|
||||
t.plan(13);
|
||||
|
||||
t.test("handler registered in context, emit out of context", function (t) {
|
||||
t.plan(1);
|
||||
|
||||
var n = cls.createNamespace('in')
|
||||
, ee = new EventEmitter()
|
||||
;
|
||||
|
||||
n.run(function () {
|
||||
n.set('value', 'hello');
|
||||
n.bindEmitter(ee);
|
||||
ee.on('event', function () {
|
||||
t.equal(n.get('value'), 'hello', "value still set in EE.");
|
||||
cls.destroyNamespace('in');
|
||||
});
|
||||
});
|
||||
|
||||
ee.emit('event');
|
||||
});
|
||||
|
||||
t.test("once handler registered in context", function (t) {
|
||||
t.plan(1);
|
||||
|
||||
var n = cls.createNamespace('inOnce')
|
||||
, ee = new EventEmitter()
|
||||
;
|
||||
|
||||
n.run(function () {
|
||||
n.set('value', 'hello');
|
||||
n.bindEmitter(ee);
|
||||
ee.once('event', function () {
|
||||
t.equal(n.get('value'), 'hello', "value still set in EE.");
|
||||
cls.destroyNamespace('inOnce');
|
||||
});
|
||||
});
|
||||
|
||||
ee.emit('event');
|
||||
});
|
||||
|
||||
t.test("handler registered out of context, emit in context", function (t) {
|
||||
t.plan(1);
|
||||
|
||||
var n = cls.createNamespace('out')
|
||||
, ee = new EventEmitter()
|
||||
;
|
||||
|
||||
ee.on('event', function () {
|
||||
t.equal(n.get('value'), 'hello', "value still set in EE.");
|
||||
cls.destroyNamespace('out');
|
||||
});
|
||||
|
||||
n.run(function () {
|
||||
n.set('value', 'hello');
|
||||
n.bindEmitter(ee);
|
||||
|
||||
ee.emit('event');
|
||||
});
|
||||
});
|
||||
|
||||
t.test("once handler registered out of context", function (t) {
|
||||
t.plan(1);
|
||||
|
||||
var n = cls.createNamespace('outOnce')
|
||||
, ee = new EventEmitter()
|
||||
;
|
||||
|
||||
ee.once('event', function () {
|
||||
t.equal(n.get('value'), 'hello', "value still set in EE.");
|
||||
cls.destroyNamespace('outOnce');
|
||||
});
|
||||
|
||||
n.run(function () {
|
||||
n.set('value', 'hello');
|
||||
n.bindEmitter(ee);
|
||||
|
||||
ee.emit('event');
|
||||
});
|
||||
});
|
||||
|
||||
t.test("handler registered out of context, emit out of context", function (t) {
|
||||
t.plan(1);
|
||||
|
||||
var n = cls.createNamespace('out')
|
||||
, ee = new EventEmitter()
|
||||
;
|
||||
|
||||
ee.on('event', function () {
|
||||
t.equal(n.get('value'), undefined, "no context.");
|
||||
cls.destroyNamespace('out');
|
||||
});
|
||||
|
||||
n.run(function () {
|
||||
n.set('value', 'hello');
|
||||
n.bindEmitter(ee);
|
||||
});
|
||||
|
||||
ee.emit('event');
|
||||
});
|
||||
|
||||
t.test("once handler registered out of context on Readable", function (t) {
|
||||
var Readable = require('stream').Readable;
|
||||
|
||||
if (Readable) {
|
||||
t.plan(12);
|
||||
|
||||
var n = cls.createNamespace('outOnceReadable')
|
||||
, re = new Readable()
|
||||
;
|
||||
|
||||
re._read = function () {};
|
||||
|
||||
t.ok(n.name, "namespace has a name");
|
||||
t.equal(n.name, 'outOnceReadable', "namespace has a name");
|
||||
|
||||
re.once('data', function (data: any) {
|
||||
t.equal(n.get('value'), 'hello', "value still set in EE");
|
||||
t.equal(data, 'blah', "emit still works");
|
||||
cls.destroyNamespace('outOnceReadable');
|
||||
});
|
||||
|
||||
n.run(function () {
|
||||
n.set('value', 'hello');
|
||||
|
||||
t.notOk(re.emit.__wrapped, "emit is not wrapped");
|
||||
t.notOk(re.on.__wrapped, "on is not wrapped");
|
||||
t.notOk(re.addListener.__wrapped, "addListener is not wrapped");
|
||||
|
||||
n.bindEmitter(re);
|
||||
|
||||
t.ok(re.emit.__wrapped, "emit is wrapped");
|
||||
t.ok(re.on.__wrapped, "on is wrapped");
|
||||
t.ok(re.addListener.__wrapped, "addListener is wrapped");
|
||||
|
||||
t.equal(typeof re._events.data, 'function', 'only the one data listener');
|
||||
t.notOk(re._events.data['context@outOnceReadable'], "context isn't on listener");
|
||||
|
||||
re.emit('data', 'blah');
|
||||
});
|
||||
}
|
||||
else {
|
||||
t.comment("this test requires node 0.10+");
|
||||
t.end();
|
||||
}
|
||||
});
|
||||
|
||||
t.test("emitter with newListener that removes handler", function (t) {
|
||||
t.plan(3);
|
||||
|
||||
var n = cls.createNamespace('newListener')
|
||||
, ee = new EventEmitter()
|
||||
;
|
||||
|
||||
// add monkeypatching to ee
|
||||
n.bindEmitter(ee);
|
||||
|
||||
function listen() {
|
||||
ee.on('data', function (chunk: any) {
|
||||
t.equal(chunk, 'chunk', 'listener still works');
|
||||
});
|
||||
}
|
||||
|
||||
ee.on('newListener', function handler(event: any) {
|
||||
if (event !== 'data') return;
|
||||
|
||||
this.removeListener('newListener', handler);
|
||||
t.notOk(this.listeners('newListener').length, 'newListener was removed');
|
||||
process.nextTick(listen);
|
||||
});
|
||||
|
||||
ee.on('drain', function (chunk: any) {
|
||||
process.nextTick(function () {
|
||||
ee.emit('data', chunk);
|
||||
});
|
||||
});
|
||||
|
||||
ee.on('data', function (chunk: any) {
|
||||
t.equal(chunk, 'chunk', 'got data event');
|
||||
cls.destroyNamespace('newListener');
|
||||
});
|
||||
|
||||
ee.emit('drain', 'chunk');
|
||||
});
|
||||
|
||||
t.test("handler registered in context on Readable", function (t) {
|
||||
var Readable = require('stream').Readable;
|
||||
|
||||
if (Readable) {
|
||||
t.plan(12);
|
||||
|
||||
var n = cls.createNamespace('outOnReadable')
|
||||
, re = new Readable()
|
||||
;
|
||||
|
||||
re._read = function () {};
|
||||
|
||||
t.ok(n.name, "namespace has a name");
|
||||
t.equal(n.name, 'outOnReadable', "namespace has a name");
|
||||
|
||||
n.run(function () {
|
||||
n.set('value', 'hello');
|
||||
|
||||
n.bindEmitter(re);
|
||||
|
||||
t.ok(re.emit.__wrapped, "emit is wrapped");
|
||||
t.ok(re.on.__wrapped, "on is wrapped");
|
||||
t.ok(re.addListener.__wrapped, "addListener is wrapped");
|
||||
|
||||
re.on('data', function (data: any) {
|
||||
t.equal(n.get('value'), 'hello', "value still set in EE");
|
||||
t.equal(data, 'blah', "emit still works");
|
||||
cls.destroyNamespace('outOnReadable');
|
||||
});
|
||||
});
|
||||
|
||||
t.ok(re.emit.__wrapped, "emit is still wrapped");
|
||||
t.ok(re.on.__wrapped, "on is still wrapped");
|
||||
t.ok(re.addListener.__wrapped, "addListener is still wrapped");
|
||||
|
||||
t.equal(typeof re._events.data, 'function', 'only the one data listener');
|
||||
t.ok(re._events.data['cls@contexts']['context@outOnReadable'],
|
||||
"context is bound to listener");
|
||||
|
||||
re.emit('data', 'blah');
|
||||
}
|
||||
else {
|
||||
t.comment("this test requires node 0.10+");
|
||||
t.end();
|
||||
}
|
||||
});
|
||||
|
||||
t.test("handler added but used entirely out of context", function (t) {
|
||||
t.plan(2);
|
||||
|
||||
var n = cls.createNamespace('none')
|
||||
, ee = new EventEmitter()
|
||||
;
|
||||
|
||||
n.run(function () {
|
||||
n.set('value', 'hello');
|
||||
n.bindEmitter(ee);
|
||||
});
|
||||
|
||||
ee.on('event', function () {
|
||||
t.ok(n, "n is set");
|
||||
t.notOk(n.get('value'), "value shouldn't be visible");
|
||||
cls.destroyNamespace('none');
|
||||
});
|
||||
|
||||
ee.emit('event');
|
||||
});
|
||||
|
||||
t.test("handler added but no listeners registered", function (t) {
|
||||
t.plan(3);
|
||||
|
||||
var http = require('http')
|
||||
, n = cls.createNamespace('no_listener')
|
||||
;
|
||||
|
||||
// only fails on Node < 0.10
|
||||
var server = http.createServer(function (req: any, res: any) {
|
||||
n.bindEmitter(req);
|
||||
|
||||
t.doesNotThrow(function () {
|
||||
req.emit('event');
|
||||
});
|
||||
|
||||
res.writeHead(200, {"Content-Length" : 4});
|
||||
res.end('WORD');
|
||||
});
|
||||
server.listen(8080);
|
||||
|
||||
http.get('http://localhost:8080/', function (res: any) {
|
||||
t.equal(res.statusCode, 200, "request came back OK");
|
||||
|
||||
res.setEncoding('ascii');
|
||||
res.on('data', function (body: any) {
|
||||
t.equal(body, 'WORD');
|
||||
|
||||
server.close();
|
||||
cls.destroyNamespace('no_listener');
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
t.test("listener with parameters added but not bound to context", function (t) {
|
||||
t.plan(2);
|
||||
|
||||
var ee = new EventEmitter()
|
||||
, n = cls.createNamespace('param_list')
|
||||
;
|
||||
|
||||
function sent(value: any) {
|
||||
t.equal(value, 3, "sent value is correct");
|
||||
cls.destroyNamespace('param_list');
|
||||
}
|
||||
|
||||
ee.on('send', sent);
|
||||
n.bindEmitter(ee);
|
||||
t.doesNotThrow(function () {
|
||||
ee.emit('send', 3);
|
||||
});
|
||||
});
|
||||
|
||||
t.test("listener that throws doesn't leave removeListener wrapped", function (t) {
|
||||
t.plan(4);
|
||||
|
||||
var ee = new EventEmitter()
|
||||
, n = cls.createNamespace('kaboom')
|
||||
;
|
||||
|
||||
n.bindEmitter(ee);
|
||||
|
||||
function kaboom() {
|
||||
throw new Error('whoops');
|
||||
}
|
||||
|
||||
n.run(function () {
|
||||
ee.on('bad', kaboom);
|
||||
|
||||
t.throws(function () { ee.emit('bad'); });
|
||||
t.equal(typeof ee.removeListener, 'function', 'removeListener is still there');
|
||||
// t.notOk(ee.removeListener.__wrapped, "removeListener got unwrapped");
|
||||
// t.equal(ee._events.bad, kaboom, "listener isn't still bound");
|
||||
cls.destroyNamespace('kaboom');
|
||||
});
|
||||
});
|
||||
|
||||
t.test("emitter bound to multiple namespaces handles them correctly", function (t) {
|
||||
t.plan(8);
|
||||
|
||||
var ee = new EventEmitter()
|
||||
, ns1 = cls.createNamespace('1')
|
||||
, ns2 = cls.createNamespace('2')
|
||||
;
|
||||
|
||||
// emulate an incoming data emitter
|
||||
setTimeout(function () {
|
||||
ee.emit('data', 'hi');
|
||||
}, 10);
|
||||
|
||||
t.doesNotThrow(function () { ns1.bindEmitter(ee); });
|
||||
t.doesNotThrow(function () { ns2.bindEmitter(ee); });
|
||||
|
||||
ns1.run(function () {
|
||||
ns2.run(function () {
|
||||
ns1.set('name', 'tom1');
|
||||
ns2.set('name', 'tom2');
|
||||
|
||||
t.doesNotThrow(function () { ns1.bindEmitter(ee); });
|
||||
t.doesNotThrow(function () { ns2.bindEmitter(ee); });
|
||||
|
||||
ns1.run(function () {
|
||||
process.nextTick(function () {
|
||||
t.equal(ns1.get('name'), 'tom1', "ns1 value correct");
|
||||
t.equal(ns2.get('name'), 'tom2', "ns2 value correct");
|
||||
|
||||
ns1.set('name', 'bob');
|
||||
ns2.set('name', 'alice');
|
||||
|
||||
ee.on('data', function () {
|
||||
t.equal(ns1.get('name'), 'bob', "ns1 value bound onto emitter");
|
||||
t.equal(ns2.get('name'), 'alice', "ns2 value bound onto emitter");
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
|
||||
// from test/bind.tap.js
|
||||
|
||||
// multiple contexts in use
|
||||
test("simple tracer built on contexts", function (t) {
|
||||
var tracer = cls.createNamespace('tracer');
|
||||
|
||||
class Trace {
|
||||
harvester: any;
|
||||
constructor(harvester: any) {
|
||||
this.harvester = harvester;
|
||||
}
|
||||
runHandler(callback: any) {
|
||||
var wrapped = tracer.bind(function () {
|
||||
callback();
|
||||
this.harvester.emit('finished', tracer.get('transaction'));
|
||||
}.bind(this));
|
||||
wrapped();
|
||||
}
|
||||
}
|
||||
|
||||
t.plan(6);
|
||||
|
||||
var harvester = new EventEmitter();
|
||||
var trace = new Trace(harvester);
|
||||
|
||||
harvester.on('finished', function (transaction: any) {
|
||||
t.ok(transaction, "transaction should have been passed in");
|
||||
t.equal(transaction.status, 'ok', "transaction should have finished OK");
|
||||
// t.equal(Object.keys(process.namespaces).length, 1, "Should only have one namespace.");
|
||||
});
|
||||
|
||||
trace.runHandler(function inScope() {
|
||||
t.ok(tracer.active, "tracer should have an active context");
|
||||
tracer.set('transaction', {status : 'ok'});
|
||||
t.ok(tracer.get('transaction'), "can retrieve newly-set value");
|
||||
t.equal(tracer.get('transaction').status, 'ok', "value should be correct");
|
||||
});
|
||||
});
|
||||
33
continuation-local-storage/index.d.ts
vendored
Normal file
33
continuation-local-storage/index.d.ts
vendored
Normal file
@@ -0,0 +1,33 @@
|
||||
// Type definitions for continuation-local-storage v3.2.0
|
||||
// Project: https://github.com/othiym23/node-continuation-local-storage
|
||||
// Definitions by: Jang-Ho Hwang <https://github.com/rath>, Kei Son <https://github.com/heycalmdown>
|
||||
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
||||
|
||||
/// <reference types="node" />
|
||||
|
||||
declare module ContinuationLocalStorage {
|
||||
type Context = any;
|
||||
|
||||
interface Namespace {
|
||||
active(): Context;
|
||||
set<T>(key: string, value: T): T;
|
||||
get(key: string): any;
|
||||
run(callback: any): void;
|
||||
runAndReturn(callback: any): any;
|
||||
bind(callback: any, context?: Context): any;
|
||||
bindEmitter(emitter: NodeJS.EventEmitter): any;
|
||||
createContext(): Context;
|
||||
name: string;
|
||||
context: Context;
|
||||
}
|
||||
function createNamespace(name: string): Namespace;
|
||||
function getNamespace(name: string): Namespace;
|
||||
function destroyNamespace(name: string): void;
|
||||
function reset(): void;
|
||||
}
|
||||
|
||||
// declare namespace process {
|
||||
// var namespaces: ContinuationLocalStorage.Namespace[];
|
||||
// }
|
||||
|
||||
export = ContinuationLocalStorage;
|
||||
20
continuation-local-storage/tsconfig.json
Normal file
20
continuation-local-storage/tsconfig.json
Normal file
@@ -0,0 +1,20 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"module": "commonjs",
|
||||
"moduleResolution": "node",
|
||||
"target": "es6",
|
||||
"noImplicitAny": true,
|
||||
"strictNullChecks": true,
|
||||
"baseUrl": "../",
|
||||
"typeRoots": [
|
||||
"../"
|
||||
],
|
||||
"types": [],
|
||||
"noEmit": true,
|
||||
"forceConsistentCasingInFileNames": true
|
||||
},
|
||||
"files": [
|
||||
"index.d.ts",
|
||||
"continuation-local-storage-tests.ts"
|
||||
]
|
||||
}
|
||||
Reference in New Issue
Block a user