Inability to serve multiple prefixed root URL's about fastify-static HOT 9 CLOSED

decided this was the wrong solution

@coreyfarrell please moderate your tone, an aggressive behavior is not welcomed.

from fastify-static.

This is a bug.

Nope, this is the correct behavior of the API, you are adding multiple times the same decorator.

I'll release very soon the new version of Fastify, which will have hasReplyDecorator, so we can check it directly inside fastify-static if a specific decorator has already been added.

In any case, the main issue will be that a user will get an "unpredictable" behavior from reply.sendFile because it will work only for the first registered static plugin.

The best solution would be register the two instances of fastify-static in two different plugins (which is the main idea behind the Fastify's plugin architecture), in this way there will be no conflicts.

// first plugin
fastify.register((instance, opts, next) => {
  instance.register(require('fastify-static'), {
	root: path.join(__dirname, 'node_modules'),
	prefix: '/node_modules/'
  })
  // here `reply.sendFile` refers to 'node_modules' files
  next()
})

// second plugin
fastify.register((instance, opts, next) => {
  instance.register(require('fastify-static'), {
	root: path.join(__dirname, 'html/myapp'),
	prefix: '/myapp/'
  })
  // here `reply.sendFile` refers to 'html/myapp' files
  next()
})

from fastify-static.

If there is time, it’d be nice to have the official solution documented in the readme: I don’t understand how and where one can do a reply.sendFile() that considers both example directories.

I’d also find it useful if it were possible to merge multiple local directories into the same online directory. Local directories that are mentioned later would provide fallbacks for earlier local directories.

from fastify-static.

@rauschma would you mind to open an issue about this "merging" functionality? I don't know see how that could work.

from fastify-static.

Nice catch! Thanks!

This is a bug. Would you mind to send a PR?

from fastify-static.

I've created an option with docs and a test to ensure this can be dealt with, I don't think it can be fixed another way.

from fastify-static.

from fastify-static.

#63 adds an option to disable the reply decorator per instance of fastify-static. This allows fastify-static to be added multiple times in the same plugin context but requires explicitly choosing no more than one to provide reply.sendFile. I'm aware you can put each fastify-static into a separate plugin context but then you don't get reply.sendFile in the global context. I saw hasReplyDecorator in the code, decided this was the wrong solution for this module since each reply.sendFile can have different settings so the conflict must be resolved explicitly.

// first plugin
fastify.register((instance, opts, next) => {
  instance.register(require('fastify-static'), {
	root: path.join(__dirname, 'node_modules'),
	prefix: '/node_modules/'
  })
  // here `reply.sendFile` refers to 'node_modules' files
  next()
})

// second plugin
fastify.register((instance, opts, next) => {
  instance.register(require('fastify-static'), {
	root: path.join(__dirname, 'html/myapp'),
	prefix: '/myapp/'
  })
  // here `reply.sendFile` refers to 'html/myapp' files
  next()
})

// here `reply.sendFile` is undefined.

from fastify-static.

This information should be extracted from the document or README.

from fastify-static.