Rename Master to Leader (#323)

* Builds but test cases fail due to redis connection error? * Added ECONNREFUSED match case in 'can provide an error if connection failed' test cases Co-authored-by: Charlie Roth <charlieroth4@icloud.com>
actionhero · Feb 20, 2020 · fd436ef · fd436ef
1 parent c3e90ec
commit fd436ef
Show file tree

Hide file tree

Showing 16 changed files with 82 additions and 80 deletions.
diff --git a/README.md b/README.md
@@ -158,8 +158,8 @@ async function boot() {
   scheduler.on("poll", () => {
     console.log("scheduler polling");
   });
-  scheduler.on("master", () => {
-    console.log("scheduler became master");
+  scheduler.on("leader", () => {
+    console.log("scheduler became leader");
   });
   scheduler.on("error", error => {
     console.log(`scheduler error >> ${error}`);
@@ -379,7 +379,8 @@ If you know the name of a worker that should be removed, you can also call `awai
 
 You may want to use node-resque to schedule jobs every minute/hour/day, like a distributed CRON system. There are a number of excellent node packages to help you with this, like [node-schedule](https://github.com/tejasmanohar/node-schedule) and [node-cron](https://github.com/ncb000gt/node-cron). Node-resque makes it possible for you to use the package of your choice to schedule jobs with.
 
-Assuming you are running node-resque across multiple machines, you will need to ensure that only one of your processes is actually scheduling the jobs. To help you with this, you can inspect which of the scheduler processes is currently acting as master, and flag only the master scheduler process to run the schedule. A full example can be found at [/examples/scheduledJobs.ts](https://github.com/actionhero/node-resque/blob/master/examples/scheduledJobs.ts), but the relevant section is:
+
+Assuming you are running node-resque across multiple machines, you will need to ensure that only one of your processes is actually scheduling the jobs. To help you with this, you can inspect which of the scheduler processes is currently acting as leader, and flag only the master scheduler process to run the schedule. A full example can be found at [/examples/scheduledJobs.ts](https://github.com/actionhero/node-resque/blob/master/examples/scheduledJobs.ts), but the relevant section is:
 
 ```javascript
 const NodeResque = require("node-resque");
@@ -393,7 +394,7 @@ schedule.scheduleJob("10,20,30,40,50 * * * * *", async () => {
   // do this job every 10 seconds, CRON style
   // we want to ensure that only one instance of this job is scheduled in our environment at once,
   // no matter how many schedulers we have running
-  if (scheduler.master) {
+  if (scheduler.leader) {
     console.log(">>> enqueuing a job");
     await queue.enqueue("time", "ticktock", new Date().toString());
   }

diff --git a/__tests__/core/connection.ts b/__tests__/core/connection.ts
@@ -1,6 +1,6 @@
 import * as Ioredis from "ioredis";
-import specHelper from "../utils/specHelper";
 import { Connection } from "../../src/index";
+import specHelper from "../utils/specHelper";
 
 describe("connection", () => {
   beforeAll(async () => {
@@ -31,7 +31,7 @@ describe("connection", () => {
         connection.connect();
 
         connection.on("error", error => {
-          expect(error.message).toMatch(/ENOTFOUND|ETIMEDOUT/);
+          expect(error.message).toMatch(/ENOTFOUND|ETIMEDOUT|ECONNREFUSED/);
           connection.end();
           resolve();
         });

diff --git a/__tests__/core/queue.ts b/__tests__/core/queue.ts
@@ -1,5 +1,5 @@
-import specHelper from "../utils/specHelper";
 import { Queue, Worker } from "../../src/index";
+import specHelper from "../utils/specHelper";
 let queue;
 
 describe("queue", () => {
@@ -37,7 +37,7 @@ describe("queue", () => {
         queue.connect();
 
         queue.on("error", error => {
-          expect(error.message).toMatch(/ENOTFOUND|ETIMEDOUT/);
+          expect(error.message).toMatch(/ENOTFOUND|ETIMEDOUT|ECONNREFUSED/);
           queue.end();
           resolve();
         });

diff --git a/__tests__/core/scheduler.ts b/__tests__/core/scheduler.ts
@@ -1,5 +1,5 @@
+import { Queue, Scheduler, Worker } from "../../src/index";
 import specHelper from "../utils/specHelper";
-import { Scheduler, Queue, Worker } from "../../src/index";
 
 let scheduler;
 let queue;
@@ -42,12 +42,12 @@ describe("scheduler", () => {
         brokenScheduler.on("poll", () => {
           throw new Error("Should not emit poll");
         });
-        brokenScheduler.on("master", () => {
-          throw new Error("Should not emit master");
+        brokenScheduler.on("leader", () => {
+          throw new Error("Should not emit leader");
         });
 
         brokenScheduler.on("error", async error => {
-          expect(error.message).toMatch(/ENOTFOUND|ETIMEDOUT/);
+          expect(error.message).toMatch(/ENOTFOUND|ETIMEDOUT|ECONNREFUSED/);
           await brokenScheduler.end();
           done();
         });
@@ -65,7 +65,7 @@ describe("scheduler", () => {
         await specHelper.cleanup();
       });
 
-      test("should only have one master, and can failover", async () => {
+      test("should only have one leader, and can failover", async () => {
         const shedulerOne = new Scheduler({
           connection: specHelper.connectionDetails,
           name: "scheduler_1",
@@ -85,15 +85,15 @@ describe("scheduler", () => {
         await new Promise(resolve => {
           setTimeout(resolve, specHelper.timeout * 2);
         });
-        expect(shedulerOne.master).toBe(true);
-        expect(shedulerTwo.master).toBe(false);
+        expect(shedulerOne.leader).toBe(true);
+        expect(shedulerTwo.leader).toBe(false);
         await shedulerOne.end();
 
         await new Promise(resolve => {
           setTimeout(resolve, specHelper.timeout * 2);
         });
-        expect(shedulerOne.master).toBe(false);
-        expect(shedulerTwo.master).toBe(true);
+        expect(shedulerOne.leader).toBe(false);
+        expect(shedulerTwo.leader).toBe(true);
         await shedulerTwo.end();
       });
     });

diff --git a/__tests__/core/worker.ts b/__tests__/core/worker.ts
@@ -1,5 +1,5 @@
+import { Queue, Worker } from "../../src/index";
 import specHelper from "../utils/specHelper";
-import { Worker, Queue } from "../../src/index";
 
 const jobs = {
   add: {
@@ -79,7 +79,7 @@ describe("worker", () => {
       );
 
       worker.on("error", async error => {
-        expect(error.message).toMatch(/ENOTFOUND|ETIMEDOUT/);
+        expect(error.message).toMatch(/ENOTFOUND|ETIMEDOUT|ECONNREFUSED/);
         await worker.end();
         done();
       });

diff --git a/__tests__/utils/specHelper.ts b/__tests__/utils/specHelper.ts
@@ -4,7 +4,7 @@ const queue = 'test_queue'
 const pkg = 'ioredis'
 const NodeResque = require('../../src/index')
 
-const SpecHeloer = {
+const SpecHelper = {
   pkg: pkg,
   namespace: namespace,
   queue: queue,
@@ -89,4 +89,4 @@ const SpecHeloer = {
   }
 }
 
-export default SpecHeloer
+export default SpecHelper
diff --git a/examples/docker/README.md b/examples/docker/README.md
@@ -25,7 +25,7 @@ node-resque-producer_1  | adding jobs @ Mon Feb 17 2020 04:12:44 GMT+0000 (Coord
 node-resque-producer_1  | adding jobs @ Mon Feb 17 2020 04:12:45 GMT+0000 (Coordinated Universal Time)
 node-resque-producer_1  | adding jobs @ Mon Feb 17 2020 04:12:46 GMT+0000 (Coordinated Universal Time)
 node-resque-worker_1    | worker check in @ 1581912766
-node-resque-worker_1    | scheduler became master
+node-resque-worker_1    | scheduler became leader
 node-resque-worker_1    | scheduler polling
 node-resque-worker_1    | scheduler working timestamp 1581912700
 node-resque-worker_1    | scheduler enqueuing job 1581912700 >> {"class":"subtract","queue":"math","args":[2,1]}

diff --git a/examples/docker/worker/worker.js b/examples/docker/worker/worker.js
@@ -84,8 +84,8 @@ async function boot() {
   scheduler.on("poll", () => {
     console.log("scheduler polling");
   });
-  scheduler.on("master", () => {
-    console.log("scheduler became master");
+  scheduler.on("leader", () => {
+    console.log("scheduler became leader");
   });
   scheduler.on("error", error => {
     console.log(`scheduler error >> ${error}`);

diff --git a/examples/example.ts b/examples/example.ts
@@ -1,6 +1,6 @@
 #!/usr/bin/env ts-node
 
-import { Worker, Scheduler, Queue } from "./../src/index";
+import { Queue, Scheduler, Worker } from "./../src/index";
 // In your projects: import { Worker, Scheduler, Queue } from "node-resque";
 
 async function boot() {
@@ -137,8 +137,8 @@ async function boot() {
   scheduler.on("poll", () => {
     console.log("scheduler polling");
   });
-  scheduler.on("master", () => {
-    console.log("scheduler became master");
+  scheduler.on("leader", () => {
+    console.log("scheduler became leader");
   });
   scheduler.on("error", error => {
     console.log(`scheduler error >> ${error}`);

diff --git a/examples/retry.ts b/examples/retry.ts
@@ -1,6 +1,6 @@
 #!/usr/bin/env ts-node
 
-import { Worker, Scheduler, Queue } from "./../src/index";
+import { Queue, Scheduler, Worker } from "./../src/index";
 // In your projects: import { Worker, Scheduler, Queue } from "node-resque";
 
 // ////////////////////////
@@ -109,8 +109,8 @@ async function boot() {
   scheduler.on("poll", () => {
     console.log("scheduler polling");
   });
-  scheduler.on("master", () => {
-    console.log("scheduler became master");
+  scheduler.on("leader", () => {
+    console.log("scheduler became leader");
   });
   scheduler.on("error", error => {
     console.log(`scheduler error >> ${error}`);

diff --git a/examples/scheduledJobs.ts b/examples/scheduledJobs.ts
@@ -1,11 +1,10 @@
 #!/usr/bin/env ts-node
 
-import { Scheduler, Queue, Worker } from "./../src/index";
 // In your projects: import { Worker, Scheduler, Queue } from "node-resque";
-
 // We'll use https://github.com/tejasmanohar/node-schedule for this example,
 // but there are many other excelent node scheduling projects
 import * as schedule from "node-schedule";
+import { Queue, Scheduler, Worker } from "./../src/index";
 
 // ////////////////////////
 // SET UP THE CONNECTION //
@@ -97,8 +96,8 @@ async function boot() {
   scheduler.on("poll", () => {
     console.log("scheduler polling");
   });
-  scheduler.on("master", () => {
-    console.log("scheduler became master");
+  scheduler.on("leader", () => {
+    console.log("scheduler became leader");
   });
   scheduler.on("error", error => {
     console.log(`scheduler error >> ${error}`);
@@ -123,7 +122,7 @@ async function boot() {
     // do this job every 10 seconds, cron style
     // we want to ensure that only one instance of this job is scheduled in our enviornment at once,
     // no matter how many schedulers we have running
-    if (scheduler.master) {
+    if (scheduler.leader) {
       console.log(">>> enquing a job");
       await queue.enqueue("time", "ticktock", [new Date().toString()]);
     }

diff --git a/examples/stuckWorker.ts b/examples/stuckWorker.ts
@@ -105,8 +105,8 @@ async function boot() {
   scheduler.on("poll", () => {
     console.log("scheduler polling");
   });
-  scheduler.on("master", () => {
-    console.log("scheduler became master");
+  scheduler.on("leader", () => {
+    console.log("scheduler became leader");
   });
   scheduler.on("error", error => {
     console.log(`scheduler error >> ${error}`);

diff --git a/src/core/queue.ts b/src/core/queue.ts
@@ -1,10 +1,10 @@
-import * as os from "os";
 import { EventEmitter } from "events";
+import * as os from "os";
+import { ErrorPayload } from "../types/errorPayload";
+import { Jobs } from "../types/jobs";
+import { ConnectionOptions } from "../types/options";
 import { Connection } from "./connection";
 import { RunPlugins } from "./pluginRunner";
-import { ConnectionOptions } from "../types/options";
-import { Jobs } from "../types/jobs";
-import { ErrorPayload } from "../types/errorPayload";
 
 function arrayify(o) {
   if (Array.isArray(o)) {