Support passing AwilixContainer explicitly (#126)

README.md

@@ -3,7 +3,7 @@
 [![NPM Version][npm-image]][npm-url]
 [![Build Status](https://github.com/fastify/fastify-awilix/workflows/ci/badge.svg)](https://github.com/fastify/fastify-awilix/actions)
 
-Dependency injection support for fastify framework, using [awilix](https://github.com/jeffijoe/awilix)
+Dependency injection support for fastify framework, using [awilix](https://github.com/jeffijoe/awilix).
 
 ## Getting started
 
@@ -26,7 +26,11 @@ app.register(fastifyAwilixPlugin, { disposeOnClose: true, disposeOnResponse: tru
 Then, register some modules for injection:
 
 ```js
-const { diContainer } = require('@fastify/awilix')
+const { 
+  diContainer, // this is an alias for diContainerProxy
+  diContainerClassic, // this instance will be used for `injectionMode = 'CLASSIC'`
+  diContainerProxy // this instance will be used by default
+} = require('@fastify/awilix')
 const { asClass, asFunction, Lifetime } = require('awilix')
 
 // Code from the previous example goes here
@@ -74,6 +78,10 @@ app.post('/', async (req, res) => {
 
 ## Plugin options
 
+`injectionMode` - whether to use PROXY or CLASSIC injection mode. See [awilix documentation](https://www.npmjs.com/package/awilix#injection-modes) for details. Default is 'PROXY'.
+
+`container` - pre-created AwilixContainer instance that should be used by the plugin. By default plugin uses its own instance. Note that you can't specify both `injectionMode` and `container` parameters at the same time.
+
 `disposeOnClose` - automatically invoke configured `dispose` for app-level `diContainer` hooks when the fastify instance is closed.
 Disposal is triggered within `onClose` fastify hook.
 Default value is `true`
@@ -178,18 +186,6 @@ await app.register(fastifyAwilixPlugin, { asyncInit: true, asyncDispose: true, e
 await app.ready()
 ```
 
-## Using classic injection mode
-
-If you prefer [classic injection](https://github.com/jeffijoe/awilix#injection-modes), you can use it like this:
-
-```javascript
-const { fastifyAwilixPlugin } = require('@fastify/awilix/lib/classic')
-const fastify = require('fastify')
-
-app = fastify({ logger: true })
-app.register(fastifyAwilixPlugin, { disposeOnClose: true, disposeOnResponse: true })
-```
-
 ## Advanced DI configuration
 
 For more advanced use-cases, check the official [awilix documentation](https://github.com/jeffijoe/awilix)

lib/fastifyAwilixPlugin.js

@@ -4,13 +4,31 @@ const awilix = require('awilix')
 const { AwilixManager } = require('awilix-manager')
 const fp = require('fastify-plugin')
 
-const diContainer = awilix.createContainer({
+const diContainerProxy = awilix.createContainer({
   injectionMode: 'PROXY',
 })
 
+const diContainerClassic = awilix.createContainer({
+  injectionMode: 'CLASSIC',
+})
+
 function plugin(fastify, opts, next) {
+  if (opts.container && opts.injectionMode) {
+    return next(
+      new Error(
+        'If you are passing pre-created container explicitly, you cannot specify injection mode',
+      ),
+    )
+  }
+
+  const resolvedContainer = opts.container
+    ? opts.container
+    : opts.injectionMode === 'CLASSIC'
+      ? diContainerClassic
+      : diContainerProxy
+
   const awilixManager = new AwilixManager({
-    diContainer,
+    diContainer: resolvedContainer,
     asyncDispose: opts.asyncDispose,
     asyncInit: opts.asyncInit,
     eagerInject: opts.eagerInject,
@@ -19,11 +37,11 @@ function plugin(fastify, opts, next) {
   const disposeOnClose = opts.disposeOnClose === true || opts.disposeOnClose === undefined
 
   fastify.decorate('awilixManager', awilixManager)
-  fastify.decorate('diContainer', diContainer)
+  fastify.decorate('diContainer', resolvedContainer)
   fastify.decorateRequest('diScope', null)
 
   fastify.addHook('onRequest', (request, reply, done) => {
-    request.diScope = diContainer.createScope()
+    request.diScope = resolvedContainer.createScope()
     done()
   })
 
@@ -65,6 +83,8 @@ const fastifyAwilixPlugin = fp(plugin, {
 })
 
 module.exports = {
-  diContainer,
+  diContainer: diContainerProxy,
+  diContainerProxy,
+  diContainerClassic,
   fastifyAwilixPlugin,
 }

lib/index.d.ts

@@ -20,6 +20,8 @@ declare module 'fastify' {
 export type FastifyAwilixOptions = {
   disposeOnResponse?: boolean
   disposeOnClose?: boolean
+  injectionMode?: 'PROXY' | 'CLASSIC'
+  container?: AwilixContainer<Cradle>
   asyncInit?: boolean
   asyncDispose?: boolean
   eagerInject?: boolean
@@ -28,3 +30,5 @@ export type FastifyAwilixOptions = {
 export const fastifyAwilixPlugin: FastifyPluginCallback<NonNullable<FastifyAwilixOptions>>
 
 export const diContainer: AwilixContainer<Cradle>
+export const diContainerClassic: AwilixContainer<Cradle>
+export const diContainerProxy: AwilixContainer<Cradle>

lib/index.js

@@ -1,8 +1,15 @@
 'use strict'
 
-const { diContainer, fastifyAwilixPlugin } = require('./fastifyAwilixPlugin')
+const {
+  diContainer,
+  fastifyAwilixPlugin,
+  diContainerProxy,
+  diContainerClassic,
+} = require('./fastifyAwilixPlugin')
 
 module.exports = {
   diContainer,
+  diContainerClassic,
+  diContainerProxy,
   fastifyAwilixPlugin,
 }

lib/index.test-d.ts

@@ -1,12 +1,16 @@
 import { asValue, AwilixContainer } from 'awilix'
 import fastify, { FastifyInstance } from 'fastify'
-import { diContainer, FastifyAwilixOptions, fastifyAwilixPlugin, Cradle, RequestCradle } from './index'
-import { diContainer as diContainerClassic } from './classic'
+import { diContainer, diContainerClassic, FastifyAwilixOptions, fastifyAwilixPlugin, Cradle, RequestCradle } from './index'
 
 import { expectAssignable, expectNotType, expectType } from 'tsd'
 
 expectAssignable<FastifyAwilixOptions>({})
 expectAssignable<FastifyAwilixOptions>({ disposeOnClose: false })
+expectAssignable<FastifyAwilixOptions>({ container: diContainer })
+expectAssignable<FastifyAwilixOptions>({ container: diContainerClassic })
+expectAssignable<FastifyAwilixOptions>({ injectionMode: 'CLASSIC' })
+expectAssignable<FastifyAwilixOptions>({ injectionMode: 'PROXY' })
+
 expectAssignable<FastifyAwilixOptions>({ disposeOnResponse: false })
 expectAssignable<FastifyAwilixOptions>({ asyncInit: false, asyncDispose: false })
 expectAssignable<FastifyAwilixOptions>({ asyncInit: true, asyncDispose: true })

package.json

@@ -33,11 +33,11 @@
     "@types/node": "^20.8.6",
     "awilix": "^10.0.1",
     "eslint": "^8.51.0",
-    "eslint-config-prettier": "^9.0.0",
-    "eslint-plugin-prettier": "^5.0.1",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-prettier": "^5.1.3",
     "fastify": "^4.24.2",
     "jest": "^29.7.0",
-    "prettier": "^3.0.3",
+    "prettier": "^3.2.5",
     "tsd": "^0.30.0"
   },
   "homepage": "http://github.com/fastify/fastify-awilix",

test/awilixManager.spec.js

@@ -2,12 +2,7 @@
 
 const { asClass } = require('awilix')
 const fastify = require('fastify')
-const { diContainer, fastifyAwilixPlugin } = require('../lib')
-
-const {
-  diContainer: diContainerClassic,
-  fastifyAwilixPlugin: fastifyAwilixPluginClassic,
-} = require('../lib/classic')
+const { diContainer, diContainerClassic, fastifyAwilixPlugin } = require('../lib')
 
 let isInittedGlobal = false
 let isDisposedGlobal = false
@@ -32,20 +27,18 @@ class AsyncInitSetClass {
 
 const variations = [
   {
-    name: 'PROXY',
-    plugin: fastifyAwilixPlugin,
+    injectionMode: 'PROXY',
     container: diContainer,
   },
   {
-    name: 'CLASSIC',
-    plugin: fastifyAwilixPluginClassic,
+    injectionMode: 'CLASSIC',
     container: diContainerClassic,
   },
 ]
 
 describe('awilixManager', () => {
   variations.forEach((variation) => {
-    describe(variation.name, () => {
+    describe(variation.injectionMode, () => {
       let app
       beforeEach(() => {
         isInittedGlobal = false
@@ -66,10 +59,13 @@ describe('awilixManager', () => {
           asClass(InitSetClass, {
             lifetime: 'SINGLETON',
             eagerInject: true,
-          })
+          }),
         )
         app = fastify({ logger: false })
-        await app.register(variation.plugin, { eagerInject: true })
+        await app.register(fastifyAwilixPlugin, {
+          eagerInject: true,
+          injectionMode: variation.injectionMode,
+        })
         await app.ready()
 
         expect(isInittedGlobal).toBe(true)
@@ -81,10 +77,13 @@ describe('awilixManager', () => {
           asClass(AsyncInitSetClass, {
             lifetime: 'SINGLETON',
             asyncInit: 'init',
-          })
+          }),
         )
         app = fastify({ logger: false })
-        await app.register(variation.plugin, { asyncInit: true })
+        await app.register(fastifyAwilixPlugin, {
+          asyncInit: true,
+          injectionMode: variation.injectionMode,
+        })
         await app.ready()
 
         expect(isInittedGlobal).toBe(true)
@@ -96,10 +95,13 @@ describe('awilixManager', () => {
           asClass(AsyncInitSetClass, {
             lifetime: 'SINGLETON',
             asyncDispose: 'dispose',
-          })
+          }),
         )
         app = fastify({ logger: false })
-        await app.register(variation.plugin, { asyncDispose: true })
+        await app.register(fastifyAwilixPlugin, {
+          asyncDispose: true,
+          injectionMode: variation.injectionMode,
+        })
         await app.ready()
         await app.close()