feat(ws): add ws provider and setup

adonisjs · Dec 12, 2016 · 783f111 · 783f111
1 parent 0ce3aef
commit 783f111
Show file tree

Hide file tree

Showing 5 changed files with 74 additions and 2 deletions.
diff --git a/app/Ws/kernel.js b/app/Ws/kernel.js
@@ -0,0 +1,40 @@
+'use strict'
+
+const Ws = use('Ws')
+
+/*
+|--------------------------------------------------------------------------
+| Global Middleware
+|--------------------------------------------------------------------------
+|
+| Global middleware are executed on every websocket request handshake and
+| must be defined inside below array.
+|
+*/
+const globalMiddleware = [
+  'Adonis/Middleware/AuthInit'
+]
+
+/*
+|--------------------------------------------------------------------------
+| Named Middleware
+|--------------------------------------------------------------------------
+|
+| Named middleware are key/value pairs. Keys are later used on websocket
+| channels.
+|
+*/
+const namedMiddleware = {
+  auth: 'Adonis/Middleware/Auth'
+}
+
+/*
+|--------------------------------------------------------------------------
+| Register Middleware
+|--------------------------------------------------------------------------
+|
+| Here we finally register our defined middleware to Middleware provider.
+|
+*/
+Ws.global(globalMiddleware)
+Ws.named(namedMiddleware)
diff --git a/app/Ws/socket.js b/app/Ws/socket.js
@@ -0,0 +1,17 @@
+'use strict'
+
+/*
+|-----------------------------------------------------------------------------
+| Web Socket
+|-----------------------------------------------------------------------------
+|
+| WebSocket provider makes it so simple for you to write realtime applications
+| with the power of channels and dynamic rooms. Make use of this file to
+| define channels and bind controllers next to them.
+|
+|
+| @example
+| Ws.channel('/chat', 'ChatController')
+*/
+
+const Ws = use('Ws')
diff --git a/bootstrap/app.js b/bootstrap/app.js
@@ -28,7 +28,8 @@ const providers = [
   'adonis-lucid/providers/LucidProvider',
   'adonis-lucid/providers/FactoryProvider',
   'adonis-middleware/providers/AppMiddlewareProvider',
-  'adonis-auth/providers/AuthManagerProvider'
+  'adonis-auth/providers/AuthManagerProvider',
+  'adonis-websocket/providers/WsProvider'
 ]
 
 /*
@@ -74,7 +75,8 @@ const aliases = {
   Middleware: 'Adonis/Src/Middleware',
   Route: 'Adonis/Src/Route',
   Schema: 'Adonis/Src/Schema',
-  View: 'Adonis/Src/View'
+  View: 'Adonis/Src/View',
+  Ws: 'Adonis/Addons/Ws'
 }
 
 /*

diff --git a/bootstrap/http.js b/bootstrap/http.js
@@ -68,6 +68,18 @@ module.exports = function (callback) {
       use(Helpers.makeNameSpace('Http', 'kernel'))
       use(Helpers.makeNameSpace('Http', 'routes'))
 
+      /*
+      |--------------------------------------------------------------------------
+      | Load Websocket Channels And Middleware
+      |--------------------------------------------------------------------------
+      |
+      | Websocket channels defination should be loaded before firing the Http
+      | server.
+      |
+      */
+      use(Helpers.makeNameSpace('Ws', 'kernel'))
+      use(Helpers.makeNameSpace('Ws', 'socket'))
+
       /*
       |--------------------------------------------------------------------------
       | Load Database Factory

diff --git a/package.json b/package.json
@@ -19,6 +19,7 @@
     "adonis-framework": "^3.0.7",
     "adonis-lucid": "^3.0.11",
     "adonis-middleware": "^1.0.10",
+    "adonis-websocket": "^1.0.1",
     "standard": "^8.6.0",
     "youch": "^1.0.1"
   },