Added documentation for CPUs and memory, fixes #25 (#27) (#28)

* refactor: Accept a single object parameter options instead of 3 different positional parameters

* fix: Move 100000 to Runner.ts

* docs: Updated documentation about CPUs and memory for worker

* docs: Added example for options in worker

* feat: v0.1.6

Co-authored-by: Rahil Kabani <[email protected]>

Co-authored-by: Rahil Kabani <[email protected]>

Author: roerohan

README.md

@@ -182,8 +182,21 @@ import { Worker } from 'code-executor';
 const worker = new Worker('myExecutor', 'redis://127.0.0.1:6379');
 ```
 
-You can create a new `Worker` object and listen with the same `name` and `redis` string you passed to the master class. There is another optional parameter called `folderPath`, which we will discuss later.
-<br />
+You can create a new `Worker` object and listen with the same `name` and `redis` string you passed to the master class. There is another optional parameter called `options`, which is an object that may consist of the following parameters:
+
+- `folderPath`, _string_: Will be discusses later.
+- `memory`, _number_: The amount of memory assigned to every Docker container spawned by this worker, in MB. The default is 0 (no limit).
+- `CPUs`, _number_: The number of CPUs assigned to every Docker container spawned by this worker. The default is 0.5.
+
+For example, you could pass these values to the constructor.
+
+```js
+const worker = new Worker('myExecutor', 'redis://127.0.0.1:6379', {
+  folderPath: '/tmp/myFolder',
+  memory: 100,
+  CPUs: 1,
+});
+```
 
 An object of the `Worker` class has the following important functions:
 

examples/worker.ts

@@ -2,9 +2,13 @@ import { Worker, languages } from '../src/CodeExecutor';
 import logger from '../src/utils/logger';
 
 /**
-  * name, redis, folderPath ( path to mount, default /tmp/code-exec ),
+  * name, redis, options
+  *
+  * Options:
+  *
+  * folderPath ( path to mount, default /tmp/code-exec ),
   * memory (in MB, default 0, ie no limit),
-  * CPUs (no. of CPUs, default 0.5)
+  * CPUs (no. of CPUs, default 0.5),
 */
 const worker = new Worker('myExecutor', 'redis://127.0.0.1:6379');
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "code-executor",
-  "version": "0.1.5",
+  "version": "0.1.6",
   "description": "A CLI/library to execute code against test cases in various languages and obtain relevant results.",
   "main": "dist/src/CodeExecutor.js",
   "keywords": [

src/Runner.ts

@@ -50,8 +50,8 @@ export default class Runner {
             promisesToKeep.push(this.docker.run(tag, ['bash', '/start.sh', `${i}`, `${timeout}`], null, {
                 HostConfig: {
                     CpuPeriod: 100000,
-                    CpuQuota: CPUs * 100000,
-                    Memory: memory,
+                    CpuQuota: CPUs * 1000000,
+                    Memory: memory * 1000000,
                     NetworkMode: 'none',
                     AutoRemove: true,
                     Mounts: [{

src/Worker.ts

@@ -4,7 +4,7 @@ import Bull from 'bull';
 import Runner from './Runner';
 import Builder from './Builder';
 
-import { Code, Result } from './models/models';
+import { Code, Result, WorkerOptions } from './models/models';
 import logger from './utils/logger';
 
 export default class Worker {
@@ -22,13 +22,16 @@ export default class Worker {
 
     private CPUs?: number;
 
-    constructor(name: string, redis: string, folderPath?: string, memory?: number, CPUs?: number) {
+    constructor(name: string, redis: string, options?: WorkerOptions) {
         this.docker = new Docker();
         this.runner = new Runner(this.docker);
         this.builder = new Builder(this.docker);
         this.queue = new Bull(name, redis);
+
+        const { folderPath, memory, CPUs } = options;
+
         this.folderPath = folderPath || '/tmp/code-exec';
-        this.memory = (memory || 0) * 1000000;
+        this.memory = memory || 0;
         this.CPUs = CPUs || 0.5;
     }
 

src/models/models.ts

@@ -29,3 +29,9 @@ export interface Result {
     id: string;
     tests: Tests[];
 }
+
+export interface WorkerOptions {
+    folderPath?: string;
+    memory?: number;
+    CPUs?: number;
+}