Merge pull request #1 from 4success/master

adding custom authorizer

Author: michaelaguiar

js-src/Websocket.ts

@@ -1,7 +1,35 @@
 import {Channel} from "./Channel";
 import {AxiosResponse} from "axios";
 
-export type Options = { authEndpoint: string, host: string };
+export type ChannelAuthorizationCallback = (
+    error: Error | null,
+    authData: any | null
+) => void;
+
+export interface DeprecatedChannelAuthorizer {
+    authorize(socketId: string, channelName: string, callback: ChannelAuthorizationCallback): void;
+}
+
+export interface ChannelAuthorizerGenerator {
+    (
+        channel: Channel,
+        options: DeprecatedAuthorizerOptions
+    ): DeprecatedChannelAuthorizer;
+}
+
+export interface DeprecatedAuthOptions {
+    params?: any;
+    headers?: any;
+}
+
+export interface DeprecatedAuthorizerOptions {
+    authTransport: 'ajax' | 'jsonp';
+    authEndpoint: string;
+    auth?: DeprecatedAuthOptions;
+}
+
+export type Options = { authEndpoint: string, host: string, authorizer?: DeprecatedChannelAuthorizer };
+
 export type MessageBody = { event: string, channel?: string, data: object };
 
 export class Websocket {
@@ -58,7 +86,7 @@ export class Websocket {
             }
         }
 
-        this.on('whoami', ({ socket_id: socketId }) => {
+        this.on('whoami', ({socket_id: socketId}) => {
             this.socketId = socketId
 
             console.log(`just set socketId to ${socketId}`)
@@ -88,24 +116,10 @@ export class Websocket {
         return this
     }
 
-    protected parseMessage(body: string): MessageBody {
-        try {
-            return JSON.parse(body)
-        } catch (error) {
-            console.error(error)
-
-            return undefined
-        }
-    }
-
     getSocketId(): string {
         return this.socketId
     }
 
-    private socketIsReady(): boolean {
-        return this.websocket.readyState === this.websocket.OPEN
-    }
-
     send(message: object): void {
         if (this.socketIsReady()) {
             this.websocket.send(JSON.stringify(message))
@@ -115,7 +129,7 @@ export class Websocket {
         this.buffer.push(message)
     }
 
-    close (): void {
+    close(): void {
         this.internalListeners = {}
 
         clearInterval(this.pingInterval)
@@ -132,39 +146,6 @@ export class Websocket {
         }
     }
 
-    private actuallySubscribe(channel: Channel): void {
-        if (channel.name.startsWith('private-') || channel.name.startsWith('presence-')) {
-            console.log(`Sending auth request for channel ${channel.name}`)
-
-            axios.post(this.options.authEndpoint, {
-                socket_id: this.getSocketId(),
-                channel_name: channel.name,
-            }).then((response: AxiosResponse) => {
-                console.log(`Subscribing to channels ${channel.name}`)
-
-                this.send({
-                    event: 'subscribe',
-                    data: {
-                        channel: channel.name,
-                        ... response.data
-                    },
-                })
-            }).catch((error) => {
-                console.log(`Auth request for channel ${channel.name} failed`)
-                console.error(error)
-            })
-        } else {
-            console.log(`Subscribing to channels ${channel.name}`)
-
-            this.send({
-                event: 'subscribe',
-                data: {
-                    channel: channel.name,
-                },
-            })
-        }
-    }
-
     unsubscribe(channel: Channel): void {
         this.send({
             event: 'unsubscribe',
@@ -195,4 +176,71 @@ export class Websocket {
             delete this.internalListeners[event]
         }
     }
+
+    protected parseMessage(body: string): MessageBody {
+        try {
+            return JSON.parse(body)
+        } catch (error) {
+            console.error(error)
+
+            return undefined
+        }
+    }
+
+    private socketIsReady(): boolean {
+        return this.websocket.readyState === this.websocket.OPEN
+    }
+
+    private actuallySubscribe(channel: Channel): void {
+        if (channel.name.startsWith('private-') || channel.name.startsWith('presence-')) {
+            console.log(`Sending auth request for channel ${channel.name}`)
+
+            if (this.options.authorizer) {
+                this.options.authorizer.authorize(this.getSocketId(), channel.name, (error, authData) => {
+                    if (!error) {
+                        console.log(`Subscribing to channels ${channel.name}`)
+
+                        this.send({
+                            event: 'subscribe',
+                            data: {
+                                channel: channel.name,
+                                ...authData
+                            },
+                        })
+                    } else {
+                        console.log(`Auth request for channel ${channel.name} failed`)
+                        console.error(error)
+                    }
+                })
+            } else {
+                axios.post(this.options.authEndpoint, {
+                    socket_id: this.getSocketId(),
+                    channel_name: channel.name,
+                }).then((response: AxiosResponse) => {
+                    console.log(`Subscribing to channels ${channel.name}`)
+
+                    this.send({
+                        event: 'subscribe',
+                        data: {
+                            channel: channel.name,
+                            ...response.data
+                        },
+                    })
+                }).catch((error) => {
+                    console.log(`Auth request for channel ${channel.name} failed`)
+                    console.error(error)
+                })
+            }
+
+        } else {
+            console.log(`Subscribing to channels ${channel.name}`)
+
+            this.send({
+                event: 'subscribe',
+                data: {
+                    channel: channel.name,
+                },
+            })
+        }
+    }
 }