v2.6.0 Add cache control string to the router

[marhalpert]

This pull request introduces a new feature to support cache control headers in responses and updates.

Cache Control Feature:

• README.md: Added cacheControlString option to the router configuration to allow passing cache directives.
• lib/middleware/cache-control.js: Implemented new middleware to set the Cache-Control header in responses.
• lib/router.js:
  • Imported the new responseCacheControl middleware.
  • Added cacheControlString to the handler configuration and included the middleware in the handler stack if cacheControlString is provided.

Version Update:

• package.json: Updated the package version from 2.5.32 to 2.6.0.

Usage

const TTL = 60 * 10 // 10 minutes
const mount = (router: RouterAbstraction): void => {
  router.get({
    url: `${basePath}/program-configuration`,
    operationId: 'programConfigurationRead',
    isPublic: true,
    schema: programConfigurationReadSchema,
    preHandlers: [],
    handlers: [programConfigurationReadHandler],
    summary: 'Read programConfiguration',
    description: 'Get programConfiguration',
    cacheControlString: `public, max-age=${TTL}`,
  })
}

before

after

[henryshen-le]

Can you add a test for this? I think theres a test file with some examples. Or I can add one for you.

[marhalpert]

I will add the test later todat

[henryshen-le]

Would it be better to abstract away the syntax and make it easier to use, e.g.

Suggested change

	cacheControlString?: string;
	cacheControl?: {
	type: 'public', // More options can be added when required
	TTLInSeconds: number,
	}

[marhalpert]

I don't think we should, this would limit it too much, the spec is very wide and has many options that can be combined in different ways.

https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control

[nguyenchr]

I wonder if we should do something to check the res.status?
e.g. only set it if it's 2xx