Merge 3e8c160 into f92c7f9

README.md

@@ -288,6 +288,30 @@ These are the available config options for the middleware functions. All config
 }
 ```
 
+## Advanced features
+
+In certain situations you may want to have an id available in the scope of an arbitrary function, e.g. in a code that acts as a background job. In this case you may use the `runWithId()` function:
+
+```js
+const rTracer = require('cls-rtracer')
+
+rTracer.runWithId(() => {
+  console.log(rTracer.id()) // id is available here
+  setInterval(() => {
+    console.log(rTracer.id()) // and here
+  }, 1000)
+})
+
+// you may override id by providing the 2nd argument
+rTracer.runWithId(() => {
+  // ...
+}, 42) // 42 is the id override here
+
+// async/await syntax is also supported, as `runWithId()`
+// returns the result of `fn`
+await rTracer.runWithId(myAsyncFn)
+```
+
 ## Troubleshooting
 
 To avoid weird behavior:

index.d.ts

@@ -13,8 +13,6 @@ export interface IHapiPlugin<T> {
   register: (server: any, options: T) => void | Promise<void>
 }
 
-export declare const id: () => string | undefined
-
 export declare const expressMiddleware: (
   options?: IOptions,
 ) => (
@@ -43,3 +41,7 @@ export declare const koaV1Middleware: (
 ) => GeneratorFunction
 
 export declare const hapiPlugin: IHapiPlugin<IOptions>
+
+export declare const runWithId: (fn: Function, id?: any) => any
+
+export declare const id: () => string | undefined

index.js

@@ -6,6 +6,7 @@ const {
   koaMiddleware,
   koaV1Middleware,
   hapiPlugin,
+  runWithId,
   id
 } = require('./src/middleware')
 
@@ -15,5 +16,6 @@ module.exports = {
   koaMiddleware,
   koaV1Middleware,
   hapiPlugin,
+  runWithId,
   id
 }

src/middleware.js

@@ -14,6 +14,7 @@ const wrapHttpEmitters = (req, res) => {
 
 /**
  * Generates a request tracer middleware for Express.
+ *
  * @param {Object} options possible options
  * @param {boolean} options.useHeader respect request header flag
  *                                    (default: `false`)
@@ -40,6 +41,7 @@ const expressMiddleware = ({
 
 /**
  * Generates a request tracer middleware for Koa v2.
+ *
  * @param {Object} options possible options
  * @param {boolean} options.useHeader respect request header flag
  *                                    (default: `false`)
@@ -66,6 +68,7 @@ const koaMiddleware = ({
 
 /**
  * Generates a request tracer middleware for Koa v1.
+ *
  * @param {Object} options possible options
  * @param {boolean} options.useHeader respect request header flag
  *                                    (default: `false`)
@@ -96,7 +99,8 @@ const koaV1Middleware = ({
 const pluginName = 'cls-rtracer'
 
 /**
- * A request tracer plugin for Hapi
+ * A request tracer plugin for Hapi.
+ *
  * @type {{once: boolean, name: string, register: hapiPlugin.register}}
  */
 const hapiPlugin = ({
@@ -126,6 +130,17 @@ const hapiPlugin = ({
   }
 })
 
+/**
+ * Runs the given function in scope of the id.
+ *
+ * @param {Function} fn function to run
+ * @param {*} id optional id to be available in the function
+ */
+const runWithId = (fn, id) => {
+  id = id || uuidv1()
+  return als.run(id, fn)
+}
+
 /**
  * Returns request tracer id or `undefined` in case if the call is made from
  * an outside CLS context.
@@ -138,5 +153,6 @@ module.exports = {
   koaMiddleware,
   koaV1Middleware,
   hapiPlugin,
+  runWithId,
   id
 }

tests/runwithid.test.js

@@ -0,0 +1,36 @@
+/* global describe, test, expect */
+'use strict'
+
+const { runWithId, id } = require('../src/middleware')
+
+describe('runWithId', () => {
+  test('runs function in scope of generated id', (done) => {
+    expect(id()).toBeUndefined()
+
+    runWithId(() => {
+      const availableId = id()
+      expect(availableId.length).toBeGreaterThan(0)
+
+      setTimeout(() => {
+        expect(id()).toEqual(availableId)
+        done()
+      }, 0)
+    })
+  })
+
+  test('runs function in scope of overriden id', () => {
+    runWithId(() => {
+      expect(id()).toEqual(42)
+    }, 42)
+  })
+
+  test('supports awaiting the function', (done) => {
+    async function asyncFn () {
+      await runWithId(() => {
+        expect(id()).toEqual(42)
+      }, 42)
+    }
+
+    asyncFn().then(done).catch(done)
+  })
+})