@sockethub/platform-irc 4.0.0-alpha.10 → 4.0.0-alpha.11

package/src/index.test.ts

@@ -45,7 +45,12 @@ describe("Initialize IRC Platform", () => {
     let platform;
     beforeEach(() => {
         platform = new IRC({
-            debug: () => {},
+            log: {
+                error: () => {},
+                warn: () => {},
+                info: () => {},
+                debug: () => {},
+            },
             updateActor: function async() {
                 return Promise.resolve();
             },
@@ -84,7 +89,6 @@ describe("Initialize IRC Platform", () => {
             connectTimeoutMs: 30000,
             persist: true,
             requireCredentials: ["connect", "update"],
-            initialized: false,
         });
     });
 
@@ -247,7 +251,7 @@ describe("Initialize IRC Platform", () => {
             });
 
             it("disconnect()", (done) => {
-                expect(platform.config.initialized).toEqual(true);
+                expect(platform.isInitialized()).toEqual(true);
                 let cleanupCalled = false;
                 platform.cleanup = (cb) => {
                     cleanupCalled = true;
@@ -259,16 +263,16 @@ describe("Initialize IRC Platform", () => {
                         actor: actor,
                     },
                     () => {
-                    expect(platform.config.initialized).toEqual(true);
+                    expect(platform.isInitialized()).toEqual(true);
                     expect(cleanupCalled).toEqual(true);
                     done();
                 });
             });
 
             it("cleanup()", (done) => {
-                expect(platform.config.initialized).toEqual(true);
+                expect(platform.isInitialized()).toEqual(true);
                 platform.cleanup(() => {
-                    expect(platform.config.initialized).toEqual(false);
+                    expect(platform.isInitialized()).toEqual(false);
                     done();
                 });
             });

package/src/index.ts

@@ -77,12 +77,11 @@ interface IrcSocketOptions {
  * @param {object} cfg a unique config object for this instance
  */
 export default class IRC implements PersistentPlatformInterface {
-    debug: Logger;
+    private readonly log: Logger;
     credentialsHash: string;
     config: PersistentPlatformConfig = {
         persist: true,
         requireCredentials: ["connect", "update"],
-        initialized: false,
         connectTimeoutMs: 30000,
     };
     private readonly updateActor: PlatformUpdateActor;
@@ -90,13 +89,14 @@ export default class IRC implements PersistentPlatformInterface {
     private irc2as: typeof IrcToActivityStreams;
     private forceDisconnect = false;
     private clientConnecting = false;
+    private initialized = false;
     private client: typeof IrcSocket;
     private jobQueue = []; // list of handlers to confirm when message delivery confirmed
     private channels = new Set();
     private handledActors = new Set();
 
     constructor(session: PlatformSession) {
-        this.debug = session.debug;
+        this.log = session.log;
         this.sendToClient = session.sendToClient;
         this.updateActor = session.updateActor;
     }
@@ -146,6 +146,14 @@ export default class IRC implements PersistentPlatformInterface {
         return PlatformIrcSchema;
     }
 
+    /**
+     * Returns whether the platform is ready to handle jobs.
+     * For IRC, this means we have successfully connected to the server.
+     */
+    isInitialized(): boolean {
+        return this.initialized;
+    }
+
     /**
      * Function: connect
      *
@@ -196,13 +204,13 @@ export default class IRC implements PersistentPlatformInterface {
      *
      */
     join(job: ActivityStream, done: PlatformCallback) {
-        this.debug(`join() called for ${job.actor.id}`);
+        this.log.debug(`join() called for ${job.actor.id}`);
         this.getClient(job.actor.id, false, (err, client) => {
             if (err) {
                 return done(err);
             }
             if (this.channels.has(job.target.name)) {
-                this.debug(`channel ${job.target.name} already joined`);
+                this.log.debug(`channel ${job.target.name} already joined`);
                 return done();
             }
             // join channel
@@ -210,7 +218,7 @@ export default class IRC implements PersistentPlatformInterface {
                 this.hasJoined(job.target.name);
                 done();
             });
-            this.debug(`sending join ${job.target.name}`);
+            this.log.debug(`sending join ${job.target.name}`);
             client.raw(["JOIN", job.target.name]);
             client.raw(`PING ${job.actor.name}`);
         });
@@ -243,7 +251,7 @@ export default class IRC implements PersistentPlatformInterface {
      *
      */
     leave(job: ActivityStream, done: PlatformCallback) {
-        this.debug(`leave() called for ${job.actor.name}`);
+        this.log.debug(`leave() called for ${job.actor.name}`);
         this.getClient(job.actor.id, false, (err, client) => {
             if (err) {
                 return done(err);
@@ -287,7 +295,7 @@ export default class IRC implements PersistentPlatformInterface {
      *
      */
     send(job: ActivityStream, done: PlatformCallback) {
-        this.debug(
+        this.log.debug(
             `send() called for ${job.actor.id} target: ${job.target.id}`,
         );
         this.getClient(job.actor.id, false, async (err, client) => {
@@ -398,13 +406,13 @@ export default class IRC implements PersistentPlatformInterface {
         credentials: PlatformIrcCredentialsObject,
         done: PlatformCallback,
     ) {
-        this.debug(`update() called for ${job.actor.id}`);
+        this.log.debug(`update() called for ${job.actor.id}`);
         this.getClient(job.actor.id, false, (err, client) => {
             if (err) {
                 return done(err);
             }
             if (job.object.type === "address") {
-                this.debug(
+                this.log.debug(
                     `changing nick from ${job.actor.name} to ${job.target.name}`,
                 );
                 this.handledActors.add(job.target.id);
@@ -423,7 +431,7 @@ export default class IRC implements PersistentPlatformInterface {
                 client.raw(["NICK", job.target.name]);
             } else if (job.object.type === "topic") {
                 // update topic
-                this.debug(`changing topic in channel ${job.target.name}`);
+                this.log.debug(`changing topic in channel ${job.target.name}`);
                 this.jobQueue.push(done);
                 client.raw(["topic", job.target.name, job.object.content]);
             } else {
@@ -487,14 +495,16 @@ export default class IRC implements PersistentPlatformInterface {
      *
      */
     query(job: ActivityStream, done: PlatformCallback) {
-        this.debug(`query() called for ${job.actor.id}`);
+        this.log.debug(`query() called for ${job.actor.id}`);
         this.getClient(job.actor.id, false, (err, client) => {
             if (err) {
                 return done(err);
             }
 
             if (job.object.type === "attendance") {
-                this.debug(`query() - sending NAMES for ${job.target.name}`);
+                this.log.debug(
+                    `query() - sending NAMES for ${job.target.name}`,
+                );
                 client.raw(["NAMES", job.target.name]);
                 done();
             } else {
@@ -520,13 +530,13 @@ export default class IRC implements PersistentPlatformInterface {
      *  }
      */
     disconnect(job: ActivityStream, done: PlatformCallback) {
-        this.debug(`disconnect called for ${job.actor.id}`);
+        this.log.debug(`disconnect called for ${job.actor.id}`);
         this.cleanup(done);
     }
 
     cleanup(done: PlatformCallback) {
-        this.debug("cleanup() called");
-        this.config.initialized = false;
+        this.log.debug("cleanup() called");
+        this.initialized = false;
         this.forceDisconnect = true;
         if (typeof this.client === "object") {
             if (typeof this.client.end === "function") {
@@ -551,7 +561,7 @@ export default class IRC implements PersistentPlatformInterface {
     }
 
     private hasJoined(channel: string) {
-        this.debug(`joined ${channel}`);
+        this.log.debug(`joined ${channel}`);
         // keep track of channels joined
         if (!this.channels.has(channel)) {
             this.channels.add(channel);
@@ -559,7 +569,7 @@ export default class IRC implements PersistentPlatformInterface {
     }
 
     private hasLeft(channel: string) {
-        this.debug(`left ${channel}`);
+        this.log.debug(`left ${channel}`);
         // keep track of channels left
         if (this.channels.has(channel)) {
             this.channels.delete(channel);
@@ -571,7 +581,9 @@ export default class IRC implements PersistentPlatformInterface {
         credentials: PlatformIrcCredentialsObject | false,
         cb: GetClientCallback,
     ) {
-        this.debug(`getClient called, connecting: ${this.clientConnecting}`);
+        this.log.debug(
+            `getClient called, connecting: ${this.clientConnecting}`,
+        );
         if (this.client) {
             this.handledActors.add(key);
             return cb(null, this.client);
@@ -581,7 +593,9 @@ export default class IRC implements PersistentPlatformInterface {
             // client is in the process of connecting, wait
             setTimeout(() => {
                 if (this.client) {
-                    this.debug(`resolving delayed getClient call for ${key}`);
+                    this.log.debug(
+                        `resolving delayed getClient call for ${key}`,
+                    );
                     this.handledActors.add(key);
                     return cb(null, this.client);
                 }
@@ -598,13 +612,13 @@ export default class IRC implements PersistentPlatformInterface {
 
         this.ircConnect(credentials, (err, client) => {
             if (err) {
-                this.config.initialized = false;
+                this.initialized = false;
                 return cb(err);
             }
             this.handledActors.add(key);
             this.client = client;
             this.registerListeners(credentials.object.server);
-            this.config.initialized = true;
+            this.initialized = true;
             return cb(null, client);
         });
     }
@@ -645,7 +659,7 @@ export default class IRC implements PersistentPlatformInterface {
             module_options.capabilities = { requires: ["sasl"] };
         }
 
-        this.debug(
+        this.log.debug(
             `attempting to connect to ${module_options.server}:${module_options.port} transport: ${
                 is_secure ? "secure" : "clear"
             } sasl: ${is_sasl}`,
@@ -669,17 +683,17 @@ export default class IRC implements PersistentPlatformInterface {
         };
 
         client.once("error", (err: string) => {
-            this.debug(`irc client 'error' occurred. `, err);
+            this.log.debug(`irc client 'error' occurred. `, err);
             forceDisconnect("error connecting to server.");
         });
 
         client.once("close", () => {
-            this.debug(`irc client 'close' event fired.`);
+            this.log.debug(`irc client 'close' event fired.`);
             forceDisconnect("connection to server closed.");
         });
 
         client.once("timeout", () => {
-            this.debug("timeout occurred, force-disconnect");
+            this.log.debug("timeout occurred, force-disconnect");
             forceDisconnect("connection timeout to server.");
         });
 
@@ -694,7 +708,7 @@ export default class IRC implements PersistentPlatformInterface {
                 return cb("force disconnect active, aborting connect.");
             }
 
-            this.debug(
+            this.log.debug(
                 `connected to ${module_options.server} capabilities: `,
                 capabilities,
             );
@@ -703,16 +717,16 @@ export default class IRC implements PersistentPlatformInterface {
     }
 
     private completeJob(err?: string) {
-        this.debug(`completing job, queue count: ${this.jobQueue.length}`);
+        this.log.debug(`completing job, queue count: ${this.jobQueue.length}`);
         const done = this.jobQueue.shift();
         if (typeof done === "function") {
             done(err);
         } else if (this.jobQueue.length === 0) {
-            this.debug(
+            this.log.debug(
                 "WARNING: job completion event received with an empty job queue.",
             );
         } else {
-            this.debug(
+            this.log.debug(
                 `WARNING: job completion found non-function in queue (${typeof done}), ${this.jobQueue.length} items remain.`,
             );
         }
@@ -732,32 +746,33 @@ export default class IRC implements PersistentPlatformInterface {
             ) {
                 this.completeJob();
             } else {
-                this.debug(`calling sendToClient for ${asObject.actor.id}`, [
-                    ...this.handledActors.keys(),
-                ]);
+                this.log.debug(
+                    `calling sendToClient for ${asObject.actor.id}`,
+                    [...this.handledActors.keys()],
+                );
                 this.sendToClient(asObject);
             }
         });
 
         this.irc2as.events.on("unprocessed", (s: string) => {
-            this.debug(`unprocessed irc message:> ${s}`);
+            this.log.debug(`unprocessed irc message:> ${s}`);
         });
 
         // The generated eslint error expects that the `error` event is propagating an Error object
         // however for irc2as this event delivers an AS object of type `error`.
 
         this.irc2as.events.on("error", (asObject: ActivityStream) => {
-            this.debug(`message error response ${asObject.object.content}`);
+            this.log.debug(`message error response ${asObject.object.content}`);
             this.completeJob(asObject.object.content);
         });
 
         this.irc2as.events.on("pong", (timestamp: string) => {
-            this.debug(`received PONG at ${timestamp}`);
+            this.log.debug(`received PONG at ${timestamp}`);
             this.completeJob();
         });
 
         this.irc2as.events.on("ping", (timestamp: string) => {
-            this.debug(`received PING at ${timestamp}`);
+            this.log.debug(`received PING at ${timestamp}`);
             this.client.raw("PONG");
         });
     }