feat: handle duplicates in addMiddlewareToStack

Author: Julien-R44

src/code_transformer/main.ts

@@ -73,6 +73,20 @@ export class CodeTransformer {
 
     const middleware = `() => import('${middlewareEntry.path}')`
 
+    /**
+     * Delete the existing middleware if it exists
+     */
+    const existingMiddleware = arrayLiteralExpression
+      .getElements()
+      .findIndex((element) => element.getText() === middleware)
+
+    if (existingMiddleware !== -1) {
+      arrayLiteralExpression.removeElement(existingMiddleware)
+    }
+
+    /**
+     * Add the middleware to the top or bottom of the array
+     */
     if (middlewareEntry.position === 'before') {
       arrayLiteralExpression.insertElement(0, middleware)
     } else {
@@ -100,6 +114,15 @@ export class CodeTransformer {
       throw new Error('The argument of the named middleware call is not an object literal.')
     }
 
+    /**
+     * Check if property is already defined. If so, remove it
+     */
+    const existingProperty = namedMiddlewareObject.getProperty(middlewareEntry.name)
+    if (existingProperty) existingProperty.remove()
+
+    /**
+     * Add the named middleware
+     */
     const middleware = `${middlewareEntry.name}: () => import('${middlewareEntry.path}')`
     namedMiddlewareObject!.insertProperty(0, middleware)
   }
@@ -185,6 +208,9 @@ export class CodeTransformer {
      * Add each variable validation
      */
     for (const [variable, validation] of Object.entries(definition.variables)) {
+      /**
+       * Check if the variable is already defined. If so, remove it
+       */
       const existingProperty = objectLiteralExpression.getProperty(variable)
       if (existingProperty) existingProperty.remove()
 

tests/__snapshots__/code_transformer.spec.ts.cjs

@@ -274,3 +274,23 @@ export default defineConfig({
 })
 "`
 
+exports[`Code transformer | addMiddlewareToStack > override duplicates when adding named middelware 1`] = `"import router from '@adonisjs/core/services/router'
+import server from '@adonisjs/core/services/server'
+
+server.errorHandler(() => import('#exceptions/handler'))
+
+server.use([
+  () => import('#middleware/container_bindings_middleware'),
+  () => import('@adonisjs/session/session_middleware'),
+])
+
+router.use([
+  () => import('@adonisjs/core/bodyparser_middleware'),
+  () => import('@adonisjs/shield/shield_middleware'),
+])
+
+export const middleware = router.named({
+  auth: () => import('#foo/bar3.js')
+})
+"`
+

tests/code_transformer.spec.ts

@@ -87,6 +87,44 @@ test.group('Code transformer | addMiddlewareToStack', (group) => {
     assert.fileContains('start/kernel.ts', `auth: () => import('#foo/bar.js')`)
     assert.fileContains('start/kernel.ts', `rand: () => import('@adonisjs/random_middleware')`)
   })
+
+  test('override duplicates when adding router/server middleware', async ({ assert, fs }) => {
+    const transformer = new CodeTransformer(fs.baseUrl)
+
+    await transformer.addMiddlewareToStack('router', [
+      { path: '@adonisjs/core/bodyparser_middleware' },
+    ])
+
+    await transformer.addMiddlewareToStack('server', [
+      { path: '#middleware/container_bindings_middleware' },
+    ])
+
+    const file = await fs.contents('start/kernel.ts')
+    const occurrences = (
+      file.match(/() => import\('@adonisjs\/core\/bodyparser_middleware'\)/g) || []
+    ).length
+
+    const occurrences2 = (
+      file.match(/() => import\('#middleware\/container_bindings_middleware'\)/g) || []
+    ).length
+
+    assert.equal(occurrences, 1)
+    assert.equal(occurrences2, 1)
+  })
+
+  test('override duplicates when adding named middelware', async ({ assert, fs }) => {
+    const transformer = new CodeTransformer(fs.baseUrl)
+
+    await transformer.addMiddlewareToStack('named', [{ name: 'auth', path: '#foo/bar.js' }])
+
+    await transformer.addMiddlewareToStack('named', [
+      { name: 'auth', path: '#foo/bar2.js' },
+      { name: 'auth', path: '#foo/bar3.js' },
+    ])
+
+    const file = await fs.contents('start/kernel.ts')
+    assert.snapshot(file).match()
+  })
 })
 
 test.group('Code transformer | defineEnvValidations', (group) => {