refactor: use @boringnode/transmit and change how we define routes

Author: RomainLanz

index.ts

@@ -8,6 +8,5 @@
  */
 
 export { configure } from './configure.js'
-export { Transmit } from './src/transmit.js'
 export { defineConfig } from './src/define_config.js'
 export { stubsRoot } from './stubs/main.js'

package.json

@@ -18,6 +18,7 @@
     ".": "./build/index.js",
     "./transports": "./build/transports.js",
     "./transmit_provider": "./build/providers/transmit_provider.js",
+    "./controllers/*": "./build/controllers/*.js",
     "./services/main": "./build/services/transmit.js",
     "./types": "./build/src/types/main.js"
   },
@@ -39,17 +40,15 @@
     "version": "npm run build"
   },
   "dependencies": {
-    "@boringnode/bus": "^0.5.0",
-    "@poppinss/matchit": "^3.1.2",
-    "@poppinss/utils": "^6.7.2",
-    "emittery": "^1.0.3"
+    "@boringnode/transmit": "^0.1.1"
   },
   "devDependencies": {
     "@adonisjs/assembler": "^7.2.3",
     "@adonisjs/core": "^6.3.1",
     "@adonisjs/eslint-config": "^1.3.0",
     "@adonisjs/prettier-config": "^1.3.0",
     "@adonisjs/tsconfig": "^1.3.0",
+    "@boringnode/bus": "^0.6.0",
     "@japa/assert": "2.1.0",
     "@japa/runner": "3.1.1",
     "@swc/core": "1.4.11",

providers/transmit_provider.ts

@@ -8,16 +8,17 @@
  */
 
 import '../src/types/extended.js'
-import { Transmit } from '../src/transmit.js'
+import { TransmitAdonisAdapter } from '../src/transmit.js'
 import type { ApplicationService } from '@adonisjs/core/types'
-import type { TransmitConfig } from '../src/types/main.js'
 import type { Transport } from '@boringnode/bus/types/main'
+import type { TransmitConfig } from '@boringnode/transmit/types'
 
 export default class TransmitProvider {
   constructor(protected app: ApplicationService) {}
 
   register() {
     this.app.container.singleton('transmit', async () => {
+      const router = await this.app.container.make('router')
       const config = this.app.config.get<TransmitConfig>('transmit', {})
 
       let transport: Transport | null = null
@@ -26,52 +27,10 @@ export default class TransmitProvider {
         transport = config.transport.driver()
       }
 
-      return new Transmit(config, transport)
+      return new TransmitAdonisAdapter(config, router, transport)
     })
   }
 
-  async boot() {
-    const router = await this.app.container.make('router')
-    const transmit = await this.app.container.make('transmit')
-    const config = this.app.config.get<TransmitConfig>('transmit', {})
-
-    const registerRoute = router.get('__transmit/events', (ctx) => {
-      transmit.$createStream(ctx)
-    })
-
-    const subscribeRoute = router.post('__transmit/subscribe', async (ctx) => {
-      const uid = ctx.request.input('uid')
-      const channel = ctx.request.input('channel')
-
-      const success = await transmit.$subscribeToChannel(uid, channel, ctx)
-
-      if (!success) {
-        return ctx.response.badRequest()
-      }
-
-      return ctx.response.noContent()
-    })
-
-    const unsubscribeRoute = router.post('__transmit/unsubscribe', (ctx) => {
-      const uid = ctx.request.input('uid')
-      const channel = ctx.request.input('channel')
-
-      const success = transmit.$unsubscribeFromChannel(uid, channel, ctx)
-
-      if (!success) {
-        return ctx.response.badRequest()
-      }
-
-      return ctx.response.noContent()
-    })
-
-    if (config.routeHandlerModifier) {
-      config.routeHandlerModifier(registerRoute)
-      config.routeHandlerModifier(subscribeRoute)
-      config.routeHandlerModifier(unsubscribeRoute)
-    }
-  }
-
   async shutdown() {
     const transmit = await this.app.container.make('transmit')
 

services/transmit.ts

@@ -8,9 +8,9 @@
  */
 
 import app from '@adonisjs/core/services/app'
-import { Transmit } from '../src/transmit.js'
+import { TransmitAdonisAdapter } from '../src/transmit.js'
 
-let transmit: Transmit
+let transmit: TransmitAdonisAdapter
 
 await app.booted(async () => {
   transmit = await app.container.make('transmit')

src/controllers/event_stream_controller.ts

@@ -0,0 +1,31 @@
+/*
+ * @adonisjs/transmit
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import { RuntimeException } from '@poppinss/utils'
+import transmit from '../../services/transmit.js'
+import type { HttpContext } from '@adonisjs/core/http'
+
+export default class EventStreamController {
+  handle(ctx: HttpContext) {
+    const uid = ctx.request.input('uid')
+
+    if (!uid) {
+      throw new RuntimeException('Missing required field "uid" in the request body')
+    }
+
+    const stream = transmit.createStream({
+      uid,
+      context: ctx,
+      request: ctx.request.request,
+      response: ctx.response.response,
+    })
+
+    return ctx.response.stream(stream)
+  }
+}

src/controllers/subscribe_controller.ts

@@ -0,0 +1,30 @@
+/*
+ * @adonisjs/transmit
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import transmit from '../../services/transmit.js'
+import type { HttpContext } from '@adonisjs/core/http'
+
+export default class SubscribeController {
+  async handle(ctx: HttpContext) {
+    const uid = ctx.request.input('uid')
+    const channel = ctx.request.input('channel')
+
+    const success = await transmit.subscribe({
+      uid,
+      channel,
+      context: ctx,
+    })
+
+    if (!success) {
+      return ctx.response.badRequest()
+    }
+
+    return ctx.response.noContent()
+  }
+}

src/controllers/unsubscribe_controller.ts

@@ -0,0 +1,30 @@
+/*
+ * @adonisjs/transmit
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import transmit from '../../services/transmit.js'
+import type { HttpContext } from '@adonisjs/core/http'
+
+export default class UnsubscribeController {
+  async handle(ctx: HttpContext) {
+    const uid = ctx.request.input('uid')
+    const channel = ctx.request.input('channel')
+
+    const success = await transmit.unsubscribe({
+      uid,
+      channel,
+      context: ctx,
+    })
+
+    if (!success) {
+      return ctx.response.badRequest()
+    }
+
+    return ctx.response.noContent
+  }
+}

src/define_config.ts

@@ -7,7 +7,7 @@
  * file that was distributed with this source code.
  */
 
-import type { TransmitConfig } from './types/main.js'
+import { TransmitConfig } from '@boringnode/transmit/types'
 
 export function defineConfig<T extends TransmitConfig>(config: T): T {
   if (config.transport && typeof config.transport.channel === 'undefined') {