Tweaked more log messages

Author: leob

.gitignore

@@ -8,3 +8,4 @@ vendor/
 .phpunit.result.cache
 yarn-error.log
 .DS_Store
+_*

js-src/Channel.ts

@@ -3,6 +3,8 @@ import { Channel as BaseChannel } from 'laravel-echo/src/channel/channel';
 import { PresenceChannel } from "laravel-echo/src/channel";
 import { Websocket } from "./Websocket";
 
+const LOG_PREFIX = '[LE-AG-Channel]';
+
 /**
  * This class represents a Pusher channel.
  */
@@ -45,20 +47,26 @@ export class Channel extends BaseChannel implements PresenceChannel {
      * Subscribe to a Pusher channel.
      */
     subscribe(): any {
+        this.options["debug"] && console.log(`${LOG_PREFIX} subscribe for channel ${this.name} ...`);
+
         this.socket.subscribe(this)
     }
 
     /**
      * Unsubscribe from a Pusher channel.
      */
     unsubscribe(): void {
+        this.options["debug"] && console.log(`${LOG_PREFIX} unsubscribe for channel ${this.name} ...`);
+
         this.socket.unsubscribe(this);
     }
 
     /**
      * Listen for an event on the channel instance.
      */
-    listen(event: string, callback: Function): Channel {
+    listen(event: string, callback: Function): this {
+        this.options["debug"] && console.log(`${LOG_PREFIX} listen to ${event} for channel ${this.name} ...`);
+
         this.on(this.eventFormatter.format(event), callback);
 
         return this;
@@ -67,7 +75,9 @@ export class Channel extends BaseChannel implements PresenceChannel {
     /**
      * Stop listening for an event on the channel instance.
      */
-    stopListening(event: string, callback?: Function): Channel {
+    stopListening(event: string, callback?: Function): this {
+        this.options["debug"] && console.log(`${LOG_PREFIX} stop listening to ${event} for channel ${this.name} ...`);
+
         this.socket.unbindEvent(this, event, callback)
 
         return this;
@@ -76,7 +86,9 @@ export class Channel extends BaseChannel implements PresenceChannel {
     /**
      * Register a callback to be called anytime a subscription succeeds.
      */
-    subscribed(callback: Function): Channel {
+    subscribed(callback: Function): this {
+        this.options["debug"] && console.log(`${LOG_PREFIX} subscribed for channel ${this.name} ...`);
+
         this.on('subscription_succeeded', () => {
             callback();
         });
@@ -87,7 +99,9 @@ export class Channel extends BaseChannel implements PresenceChannel {
     /**
      * Register a callback to be called anytime a subscription error occurs.
      */
-    error(callback: Function): Channel {
+    error(callback: Function): this {
+        this.options["debug"] && console.log(`${LOG_PREFIX} error for channel ${this.name} ...`);
+
         this.on('error', (status) => {
             callback(status);
         });
@@ -99,12 +113,14 @@ export class Channel extends BaseChannel implements PresenceChannel {
      * Bind a channel to an event.
      */
     on(event: string, callback: Function): Channel {
+        this.options["debug"] && console.log(`${LOG_PREFIX} on ${event} for channel ${this.name} ...`);
+
         this.socket.bind(this, event, callback)
 
         return this;
     }
 
-    whisper(event: string, data: object): Channel {
+    whisper(event: string, data: object): this {
         let channel = this.name;
         let formattedEvent = "client-" + event;
         this.socket.send({
@@ -116,7 +132,7 @@ export class Channel extends BaseChannel implements PresenceChannel {
         return this;
     }
 
-    here(callback: Function): Channel {
+    here(callback: Function): this {
         // TODO: implement
 
         return this
@@ -125,7 +141,7 @@ export class Channel extends BaseChannel implements PresenceChannel {
     /**
      * Listen for someone joining the channel.
      */
-    joining(callback: Function): Channel {
+    joining(callback: Function): this {
         // TODO: implement
 
         return this
@@ -134,9 +150,11 @@ export class Channel extends BaseChannel implements PresenceChannel {
     /**
      * Listen for someone leaving the channel.
      */
-    leaving(callback: Function): Channel {
+    leaving(callback: Function): this {
         // TODO: implement
 
         return this
     }
 }
+
+export { PresenceChannel };

js-src/Connector.ts

@@ -4,6 +4,8 @@ import {Channel} from "./Channel";
 
 export const broadcaster = (options: object): Connector => new Connector(options);
 
+const LOG_PREFIX = '[LE-AG-Connector]';
+
 export class Connector extends BaseConnector {
     /**
      * The Socket.io connection instance.
@@ -15,10 +17,19 @@ export class Connector extends BaseConnector {
      */
     channels: { [name: string]: Channel } = {};
 
+    /**
+     * Create a new class instance.
+     */
+    constructor(options: any) {
+        super(options);
+    }
+
     /**
      * Create a fresh Socket.io connection.
      */
     connect(): void {
+        this.options.debug && console.log(LOG_PREFIX + 'Connect ...' );
+
         this.socket = new Websocket(this.options);
 
         return;
@@ -103,6 +114,8 @@ export class Connector extends BaseConnector {
      * Disconnect socket connection.
      */
     disconnect(): void {
+        this.options.debug && console.log(LOG_PREFIX + 'Disconnect ...' );
+
         this.socket.close();
     }
 }

js-src/Websocket.ts

@@ -5,7 +5,7 @@ export type Options = { authEndpoint: string, host: string, bearerToken: string,
 
 export type MessageBody = { event: string, channel?: string, data: object };
 
-const LOG_PREFIX = '[AG-WS]';
+const LOG_PREFIX = '[LE-AG-Websocket]';
 
 export class Websocket {
     buffer: Array<object> = [];
@@ -27,11 +27,22 @@ export class Websocket {
 
     private pingInterval: NodeJS.Timeout;
 
+    constructor(options: Options) {
+        this.options = options;
+
+        this.connect(this.options.host);
+
+        return this;
+    }
+
     private connect(host: string): void {
+
         if (!host) {
             this.options.debug && console.error(LOG_PREFIX + `Cannont connect without host !`);
+
             return;
         }
+
         this.options.debug && console.log(LOG_PREFIX + `Trying to connect to ${host}...` );
 
         this.websocket = new WebSocket(host);
@@ -132,14 +143,6 @@ export class Websocket {
         });
     }
 
-    constructor(options: Options) {
-        this.options = options;
-
-        this.connect(this.options.host);
-
-        return this;
-    }
-
     protected parseMessage(body: string): MessageBody {
         try {
             return JSON.parse(body);
@@ -181,6 +184,8 @@ export class Websocket {
         if (this.getSocketId()) {
             this.actuallySubscribe(channel);
         } else {
+            this.options.debug && console.log(`${LOG_PREFIX} subscribe - push channel backlog for channel ${channel.name}`);
+
             this.channelBacklog.push(channel);
         }
     }
@@ -225,6 +230,8 @@ export class Websocket {
     }
 
     unsubscribe(channel: Channel): void {
+        this.options.debug && console.log(`${LOG_PREFIX} unsubscribe for channel ${channel.name}`);
+
         this.send({
             event: 'unsubscribe',
             data: {
@@ -238,10 +245,14 @@ export class Websocket {
     }
 
     on(event: string, callback: Function = null): void {
+        this.options.debug && console.log(`${LOG_PREFIX} on event ${event} ...`);
+
         this.internalListeners[event] = callback;
     }
 
     bind(channel: Channel, event: string, callback: Function): void {
+        this.options.debug && console.log(`${LOG_PREFIX} bind event ${event} for channel ${channel.name} ...`);
+
         if (!this.listeners[channel.name]) {
             this.listeners[channel.name] = {};
         }
@@ -250,6 +261,8 @@ export class Websocket {
     }
 
     unbindEvent(channel: Channel, event: string, callback: Function = null): void {
+        this.options.debug && console.log(`${LOG_PREFIX} unbind event ${event} for channel ${channel.name} ...`);
+
         if (this.internalListeners[event] && (callback === null || this.internalListeners[event] === callback)) {
             delete this.internalListeners[event];
         }