harperdb 3.1.3 → 3.1.4

package/node_modules/fastify-static/test/static.test.js

@@ -18,11 +18,9 @@ const proxyquire = require('proxyquire')
 const fastifyStatic = require('../')
 
 const indexContent = fs.readFileSync('./test/static/index.html').toString('utf8')
-const index2Content = fs.readFileSync('./test/static2/index.html').toString('utf8')
 const foobarContent = fs.readFileSync('./test/static/foobar.html').toString('utf8')
 const deepContent = fs.readFileSync('./test/static/deep/path/for/test/purpose/foo.html').toString('utf8')
 const innerIndex = fs.readFileSync('./test/static/deep/path/for/test/index.html').toString('utf8')
-const barContent = fs.readFileSync('./test/static2/bar.html').toString('utf8')
 
 const GENERIC_RESPONSE_CHECK_COUNT = 5
 function genericResponseChecks (t, response) {
@@ -490,52 +488,6 @@ t.test('register /static/', t => {
   })
 })
 
-t.test('register /static and /static2', t => {
-  t.plan(3)
-
-  const pluginOptions = {
-    root: [path.join(__dirname, '/static'), path.join(__dirname, '/static2')],
-    prefix: '/static'
-  }
-  const fastify = Fastify()
-  fastify.register(fastifyStatic, pluginOptions)
-
-  t.tearDown(fastify.close.bind(fastify))
-
-  fastify.listen(0, err => {
-    t.error(err)
-
-    fastify.server.unref()
-
-    t.test('/static/index.html', t => {
-      t.plan(4 + GENERIC_RESPONSE_CHECK_COUNT)
-      simple.concat({
-        method: 'GET',
-        url: 'http://localhost:' + fastify.server.address().port + '/static/index.html'
-      }, (err, response, body) => {
-        t.error(err)
-        t.strictEqual(response.statusCode, 200)
-        t.notStrictEqual(body.toString(), index2Content)
-        t.strictEqual(body.toString(), indexContent)
-        genericResponseChecks(t, response)
-      })
-    })
-
-    t.test('/static/bar.html', t => {
-      t.plan(3 + GENERIC_RESPONSE_CHECK_COUNT)
-      simple.concat({
-        method: 'GET',
-        url: 'http://localhost:' + fastify.server.address().port + '/static/bar.html'
-      }, (err, response, body) => {
-        t.error(err)
-        t.strictEqual(response.statusCode, 200)
-        t.strictEqual(body.toString(), barContent)
-        genericResponseChecks(t, response)
-      })
-    })
-  })
-})
-
 t.test('payload.filename is set', t => {
   t.plan(3)
 
@@ -544,7 +496,7 @@ t.test('payload.filename is set', t => {
     prefix: '/static/'
   }
   const fastify = Fastify()
-  let gotFilename
+  var gotFilename
   fastify.register(fastifyStatic, pluginOptions)
   fastify.addHook('onSend', function (req, reply, payload, next) {
     gotFilename = payload.filename
@@ -946,7 +898,7 @@ t.test('maxAge option', t => {
 })
 
 t.test('errors', t => {
-  t.plan(11)
+  t.plan(5)
 
   t.test('no root', t => {
     t.plan(1)
@@ -988,66 +940,6 @@ t.test('errors', t => {
       })
   })
 
-  t.test('root is an empty array', t => {
-    t.plan(1)
-    const pluginOptions = { root: [] }
-    const fastify = Fastify({ logger: false })
-    fastify.register(fastifyStatic, pluginOptions)
-      .ready(err => {
-        t.equal(err.constructor, Error)
-      })
-  })
-
-  t.test('root array does not contain strings', t => {
-    t.plan(1)
-    const pluginOptions = { root: [1] }
-    const fastify = Fastify({ logger: false })
-    fastify.register(fastifyStatic, pluginOptions)
-      .ready(err => {
-        t.equal(err.constructor, Error)
-      })
-  })
-
-  t.test('root array does not contain an absolute path', t => {
-    t.plan(1)
-    const pluginOptions = { root: ['./my/path'] }
-    const fastify = Fastify({ logger: false })
-    fastify.register(fastifyStatic, pluginOptions)
-      .ready(err => {
-        t.equal(err.constructor, Error)
-      })
-  })
-
-  t.test('root array path is not a directory', t => {
-    t.plan(1)
-    const pluginOptions = { root: [__filename] }
-    const fastify = Fastify({ logger: false })
-    fastify.register(fastifyStatic, pluginOptions)
-      .ready(err => {
-        t.equal(err.constructor, Error)
-      })
-  })
-
-  t.test('all root array paths must be valid', t => {
-    t.plan(1)
-    const pluginOptions = { root: [path.join(__dirname, '/static'), 1] }
-    const fastify = Fastify({ logger: false })
-    fastify.register(fastifyStatic, pluginOptions)
-      .ready(err => {
-        t.equal(err.constructor, Error)
-      })
-  })
-
-  t.test('duplicate root paths are not allowed', t => {
-    t.plan(1)
-    const pluginOptions = { root: [path.join(__dirname, '/static'), path.join(__dirname, '/static')] }
-    const fastify = Fastify({ logger: false })
-    fastify.register(fastifyStatic, pluginOptions)
-      .ready(err => {
-        t.equal(err.constructor, Error)
-      })
-  })
-
   t.test('setHeaders is not a function', t => {
     t.plan(1)
     const pluginOptions = { root: __dirname, setHeaders: 'headers' }
@@ -1560,41 +1452,6 @@ t.test('register with wildcard "**/index.html"', t => {
   })
 })
 
-t.test('register with wildcard "**/index.html" on multiple root paths', t => {
-  t.plan(2)
-
-  const pluginOptions = {
-    root: [path.join(__dirname, '/static'), path.join(__dirname, '/static2')],
-    wildcard: '**/*.js'
-  }
-  const fastify = Fastify()
-  fastify.register(fastifyStatic, pluginOptions)
-
-  fastify.get('/*', (request, reply) => {
-    reply.send({ hello: 'world' })
-  })
-
-  t.tearDown(fastify.close.bind(fastify))
-
-  fastify.listen(0, err => {
-    t.error(err)
-
-    fastify.server.unref()
-
-    t.test('/index.html', t => {
-      t.plan(2 + GENERIC_ERROR_RESPONSE_CHECK_COUNT)
-      simple.concat({
-        method: 'GET',
-        url: 'http://localhost:' + fastify.server.address().port + '/index.html'
-      }, (err, response, body) => {
-        t.error(err)
-        t.strictEqual(response.statusCode, 200)
-        genericErrorResponseChecks(t, response)
-      })
-    })
-  })
-})
-
 t.test('register with wildcard "**/foo.*"', t => {
   t.plan(8)
 
@@ -2253,90 +2110,6 @@ t.test('trailing slash behavior with redirect = false', t => {
   })
 })
 
-t.test('if dotfiles are properly served according to plugin options', t => {
-  t.plan(3)
-  const exampleContents = fs.readFileSync(path.join(__dirname, 'static', '.example'), { encoding: 'utf8' }).toString()
-
-  t.test('freely serve dotfiles', (t) => {
-    t.plan(4)
-    const fastify = Fastify()
-
-    const pluginOptions = {
-      root: path.join(__dirname, 'static'),
-      prefix: '/static/',
-      dotfiles: 'allow'
-    }
-
-    fastify.register(fastifyStatic, pluginOptions)
-
-    t.teardown(fastify.close.bind(fastify))
-    fastify.listen(0, (err) => {
-      t.error(err)
-
-      simple.concat({
-        method: 'GET',
-        url: 'http://localhost:' + fastify.server.address().port + '/static/.example'
-      }, (err, response, body) => {
-        t.error(err)
-        t.strictEqual(response.statusCode, 200)
-        t.strictEqual(body.toString(), exampleContents)
-      })
-    })
-  })
-
-  t.test('ignore dotfiles', (t) => {
-    t.plan(3)
-    const fastify = Fastify()
-
-    const pluginOptions = {
-      root: path.join(__dirname, 'static'),
-      prefix: '/static/',
-      dotfiles: 'ignore'
-    }
-
-    fastify.register(fastifyStatic, pluginOptions)
-
-    t.teardown(fastify.close.bind(fastify))
-    fastify.listen(0, (err) => {
-      t.error(err)
-
-      simple.concat({
-        method: 'GET',
-        url: 'http://localhost:' + fastify.server.address().port + '/static/.example'
-      }, (err, response, body) => {
-        t.error(err)
-        t.strictEqual(response.statusCode, 404)
-      })
-    })
-  })
-
-  t.test('deny requests to serve a dotfile', (t) => {
-    t.plan(3)
-    const fastify = Fastify()
-
-    const pluginOptions = {
-      root: path.join(__dirname, 'static'),
-      prefix: '/static/',
-      dotfiles: 'deny'
-    }
-
-    fastify.register(fastifyStatic, pluginOptions)
-
-    t.teardown(fastify.close.bind(fastify))
-    fastify.listen(0, (err) => {
-      t.error(err)
-
-      simple.concat({
-        method: 'GET',
-        url: 'http://localhost:' + fastify.server.address().port + '/static/.example'
-      }, (err, response, body) => {
-        t.error(err)
-        t.strictEqual(response.statusCode, 403)
-      })
-    })
-  })
-})
-
 t.test('register with failing glob handler', t => {
   const fastifyStatic = proxyquire.noCallThru()('../', {
     glob: function globStub (pattern, options, cb) {
@@ -2510,35 +2283,3 @@ t.test('routes use default errorHandler when fastify.errorHandler is not defined
     })
   })
 })
-
-t.test('precent encoded URLs in glob mode', t => {
-  t.plan(4)
-
-  const fastify = Fastify({})
-
-  fastify.register(fastifyStatic, {
-    root: path.join(__dirname, 'static'),
-    prefix: '/static',
-    wildcard: true
-  })
-
-  t.tearDown(fastify.close.bind(fastify))
-
-  fastify.listen(0, (err) => {
-    t.error(err)
-    fastify.server.unref()
-
-    simple.concat({
-      method: 'GET',
-      url: 'http://localhost:' + fastify.server.address().port + '/static/a .md',
-      followRedirect: false
-    }, (err, response, body) => {
-      t.error(err)
-      t.strictEquals(response.statusCode, 200)
-      t.strictEquals(
-        fs.readFileSync(path.join(__dirname, 'static', 'a .md'), 'utf-8'),
-        body.toString()
-      )
-    })
-  })
-})

package/node_modules/fastify-static/test/types/index.ts

@@ -6,7 +6,7 @@ const options: FastifyStaticOptions = {
   acceptRanges: true,
   cacheControl: true,
   decorateReply: true,
-  dotfiles: 'allow',
+  dotfiles: true,
   etag: true,
   extensions: ['.js'],
   immutable: true,
@@ -42,15 +42,3 @@ appWithHttp2
       reply.sendFile('some-file-name')
     })
   })
-
-const multiRootAppWithImplicitHttp = fastify()
-options.root = ['']
-
-multiRootAppWithImplicitHttp
-  .register(fastifyStatic, options)
-  .after(() => {
-    multiRootAppWithImplicitHttp.get('/', (request, reply) => {
-      reply.sendFile('some-file-name')
-    })
-  })
-  

package/node_modules/find-my-way/.taprc

@@ -1,4 +1,7 @@
-esm: false
 ts: false
 jsx: false
 flow: false
+branches: 90
+functions: 90
+lines: 90
+statements: 90

package/node_modules/find-my-way/README.md

@@ -36,7 +36,7 @@ server.listen(3000, err => {
 <a name="api"></a>
 ## API
 <a name="constructor"></a>
-#### FindMyway([options])
+#### FindMyWay([options])
 Instance a new router.<br>
 You can pass a default route with the option `defaultRoute`.
 ```js
@@ -96,6 +96,37 @@ const router = require('find-my-way')({
 })
 ```
 
+You can assign a `buildPrettyMeta` function to sanitize a route's `store` object to use with the `prettyPrint` functions. This function should accept a single object and return an object.
+
+```js
+
+const privateKey = new Symbol('private key')
+const store = { token: '12345', [privateKey]: 'private value' }
+
+const router = require('find-my-way')({
+  buildPrettyMeta: route => {
+    const cleanMeta = Object.assign({}, route.store)
+
+    // remove private properties
+    Object.keys(cleanMeta).forEach(k => {
+      if (typeof k === 'symbol') delete cleanMeta[k]
+    })
+
+    return cleanMeta // this will show up in the pretty print output!
+  }
+})
+
+store[privateKey] = 'private value'
+router.on('GET', '/hello_world', (req, res) => {}, store)
+
+router.prettyPrint()
+
+//└── / (-)
+//    └── hello_world (GET)
+//        • (token) "12345"
+
+```
+
 ## Constraints
 
 `find-my-way` supports restricting handlers to only match certain requests for the same path. This can be used to support different versions of the same route that conform to a [semver](#semver) based versioning strategy, or restricting some routes to only be available on hosts. `find-my-way` has the semver based versioning strategy and a regex based hostname constraint strategy built in.
@@ -282,6 +313,12 @@ router.on('GET', '/example/at/:hour(^\\d{2})h:minute(^\\d{2})m', (req, res, para
 ```
 In this case as parameter separator it's possible to use whatever character is not matched by the regular expression.
 
+The last parameter can be made optional if you add a question mark ("?") at the end of the parameters name.
+```js
+router.on('GET', '/example/posts/:id?', (req, res, params) => {}))
+```
+In this case you can request `/example/posts` as well as `/example/posts/1`. The optional param will be undefined if not specified.
+
 Having a route with multiple parameters may affect negatively the performance, so prefer single parameter approach whenever possible, especially on routes which are on the hot path of your application.
 
 <a name="match-order"></a>
@@ -409,18 +446,71 @@ router.find('GET', '/example', { host: 'fastify.io', version: '1.x' })
 ```
 
 <a name="pretty-print"></a>
-#### prettyPrint()
+#### prettyPrint([{ commonPrefix: false, includeMeta: true || [] }])
 Prints the representation of the internal radix tree, useful for debugging.
+
 ```js
 findMyWay.on('GET', '/test', () => {})
 findMyWay.on('GET', '/test/hello', () => {})
-findMyWay.on('GET', '/hello/world', () => {})
+findMyWay.on('GET', '/testing', () => {})
+findMyWay.on('GET', '/testing/:param', () => {})
+findMyWay.on('PUT', '/update', () => {})
 
 console.log(findMyWay.prettyPrint())
 // └── /
-//   ├── test (GET)
-//   │   └── /hello (GET)
-//   └── hello/world (GET)
+//     ├── test (GET)
+//     │   ├── /hello (GET)
+//     │   └── ing (GET)
+//     │       └── /:param (GET)
+//     └── update (PUT)
+```
+
+`prettyPrint` accepts an optional setting to use the internal routes array
+to render the tree.
+
+```js
+console.log(findMyWay.prettyPrint({ commonPrefix: false }))
+// └── / (-)
+//     ├── test (GET)
+//     │   └── /hello (GET)
+//     ├── testing (GET)
+//     │   └── /:param (GET)
+//     └── update (PUT)
+```
+
+To include a display of the `store` data passed to individual routes, the 
+option `includeMeta` may be passed. If set to `true` all items will be
+displayed, this can also be set to an array specifying which keys (if
+present) should be displayed. This information can be further sanitized
+by specifying a `buildPrettyMeta` function which consumes and returns
+an object.
+
+```js
+findMyWay.on('GET', '/test', () => {}, { onRequest: () => {}, authIDs => [1,2,3] })
+findMyWay.on('GET', '/test/hello', () => {}, { token: 'df123-4567' })
+findMyWay.on('GET', '/testing', () => {})
+findMyWay.on('GET', '/testing/:param', () => {})
+findMyWay.on('PUT', '/update', () => {})
+
+console.log(findMyWay.prettyPrint({ commonPrefix: false, includeMeta: ['onRequest'] }))
+// └── /
+//     ├── test (GET)
+//     │   • (onRequest) "anonymous()"
+//     │   ├── /hello (GET)
+//     │   └── ing (GET)
+//     │       └── /:param (GET)
+//     └── update (PUT)
+
+console.log(findMyWay.prettyPrint({ commonPrefix: true, includeMeta: true }))
+// └── / (-)
+//     ├── test (GET)
+//     │   • (onRequest) "anonymous()"
+//     │   • (authIDs) [1,2,3]
+//     │   └── /hello (GET)
+//     │       • (token) "df123-4567"
+//     ├── testing (GET)
+//     │   └── /:param (GET)
+//     └── update (PUT)
 ```
 
 <a name="routes"></a>

package/node_modules/find-my-way/index.d.ts

@@ -57,17 +57,17 @@ declare namespace Router {
     store: any
   ) => void;
 
-  interface ConstraintStrategy<V extends HTTPVersion> {
+  interface ConstraintStrategy<V extends HTTPVersion, T = string> {
     name: string,
     mustMatchWhenDerived?: boolean,
     storage() : {
-      get(version: String) : Handler<V> | null,
-      set(version: String, store: Handler<V>) : void,
-      del(version: String) : void,
+      get(value: T) : Handler<V> | null,
+      set(value: T, handler: Handler<V>) : void,
+      del(value: T) : void,
       empty() : void
     },
     validate(value: unknown): void,
-    deriveConstraint<Context>(req: Req<V>, ctx?: Context) : String,
+    deriveConstraint<Context>(req: Req<V>, ctx?: Context) : T,
   }
 
   interface Config<V extends HTTPVersion> {
@@ -154,6 +154,7 @@ declare namespace Router {
 
     reset(): void;
     prettyPrint(): string;
+    prettyPrint(opts: { commonPrefix?: boolean, includeMeta?: boolean | (string | symbol)[]  }): string;
 
     all: ShortHandRoute<V>;