concurrency.js 0.0.1 → 0.0.3-beta

package/.github/ISSUE_TEMPLATE/bug-report-ticket.md

@@ -0,0 +1,38 @@
+---
+name: Bug report ticket
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

package/.github/ISSUE_TEMPLATE/feature-request-ticket.md

@@ -0,0 +1,43 @@
+---
+name: Feature request ticket
+about: Suggest an idea for this project
+title: "[FEATURE] Feature summary description here"
+labels: ''
+assignees: ganeshkbhat
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**Details**
+Any relevant steps
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots or wireframe to help explain your feature.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

package/.github/ISSUE_TEMPLATE/general-request-ticket.md

@@ -0,0 +1,20 @@
+---
+name: General Request ticket
+about: Suggest any other than issue or bug or feature or idea for this project
+title: "[REQUEST] Request summary"
+labels: ''
+assignees: ''
+
+---
+
+**Please describe your request.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternatives you've considered.
+
+**Additional context**
+Add any other context or screenshots about the request here.

package/.github/ISSUE_TEMPLATE/security-report-ticket.md

@@ -0,0 +1,51 @@
+---
+name: Security Vulnerability / Bug report ticket
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the Security vulnerability / bug**
+A clear and concise description of what the bug is.
+
+**Security Vulerability**
+Describe the security vulnerability.
+
+**Security Vulerability Impact**
+Describe the security vulnerability impact.
+
+**Security Vulerability Detection or How To Reproduce**
+Describe how the security vulnerability can be detected or reprduced.
+
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**How To Rectify the Security Vulerability Issue**
+Describe How To Rectify the Security Vulerability Issue.
+
+Eg: Upgrade package, code section change, feature, changing defaults, etc.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

package/README.md

@@ -1,2 +1,119 @@
-# concurrency
+# concurrency.js
+
 npm module to work with concurrency - worker threads and worker processes easily using simple functions and script files
+
+Find the demos in the [demos folder](./demos)
+
+#### Cluster Methods
+
+
+`_concurrencyClusters(filename = __filename, num = cpus().length, options = {}, greet = false)`
+
+```
+
+const path = require("path");
+let { _concurrencyClusters } = require("concurrency.js");
+
+function concurrency() {
+    return new Promise(function (resolve, reject) {
+        _concurrencyClusters(
+            path.join("C:\\Users\\GB\\Documents\\projects\\requireurl\\concurrency\\src\\worker.cluster.js"),
+            8,
+            {
+                data: {
+                    data: "Testing parent data",
+                    url: "https://www.google.com"
+                },
+                childData: "Test data from child"
+            }
+        ).then((d) => {
+            console.log("Data fetched", JSON.stringify(d));
+            resolve(d);
+        }).catch((e) => {
+            console.log(e.toString());
+            reject(e);
+        });
+    });
+}
+concurrency();
+
+```
+
+#### Process Methods
+
+
+`_concurrencyProcesses(filename = __filename, options = {}, greet = false)`
+
+```
+
+const path = require("path");
+let { _concurrencyProcesses } = require("concurrency.js");
+_concurrencyProcesses(
+    path.join(
+    "C:\\Users\\GB\\Documents\\projects\\requireurl\\concurrency\\src\\worker.process.js"),
+    {
+        data: {
+            message: "Testing data",
+            url: "https://www.google.com"
+        }
+    },
+    true
+    ).then((d) => { console.log("Data fetched: ", JSON.stringify(d)); })
+    .catch((e) => { console.log(e.toString()); setTimeout(() => { process.exit(e); }, 5000) })
+
+```
+
+#### Threads Methods
+
+
+`_concurrencyThreads(filename = __filename, options = {}, greet = false)`
+
+```
+
+const path = require("path");
+let { _concurrencyThreads } = require("concurrency.js");
+_concurrencyThreads(
+    __filename,
+    {
+        data: {
+            url: "https://www.google.com",
+            data: "Testing data"
+        },
+        childData: "Testing child data"
+    },
+    true
+).then((d) => console.log(JSON.stringify(d)));
+
+```
+
+#### Thread Async Methods
+
+
+`_concurrencyThreadsAsync(command, options)`
+
+
+```
+
+const path = require("path");
+let { _concurrencyThreadsAsync } = require("concurrency.js");
+
+let threads = _concurrencyThreadsAsync(
+    "C:\\Users\\GB\\Documents\\projects\\requireurl\\concurrency\\demos\\demos.threads.js",
+    {
+        data: {
+            data: "Testing parent data",
+            url: "https://www.google.com"
+        },
+        childData: "Test data from child"
+    }
+);
+
+```
+
+### Contributions
+
+Contributions, Feature Improvements, Bugs, and Issues are invited. [raising an issue](https://github.com/ganeshkbhat/concurrency.js/issues)
+
+# License
+
+[MIT License](./LICENSE)

package/demos/cluster.js

@@ -0,0 +1,22 @@
+
+const path = require("path");
+const { _concurrencyClusters } = require("../index.js");
+
+
+async function cluster() {
+    let filename = "C:\\Users\\GB\\Documents\\projects\\requireurl\\concurrency\\src\\worker.cluster.js";
+    return _concurrencyClusters(
+        path.join(filename),
+        // __filename,
+        8,
+        {
+            data: {
+                url: "https://www.google.com",
+                message: "Testing parent data"
+            },
+            childData: "Test data from child"
+        }
+    )
+}
+
+module.exports = cluster;

package/demos/demos.cluster.js

@@ -0,0 +1,66 @@
+
+const path = require("path");
+let { _concurrencyClusters } = require("../index.js");
+
+
+// console.log(_concurrencyClusters(
+//     path.join("C:\\Users\\GB\\Documents\\projects\\requireurl\\concurrency\\src\\worker.process.js"),
+//     8,
+//     { url: "https://www.google.com", data: "Testing parent data", childData: "Test data from child" }
+// ).then((d) => {
+//     console.log("Data fetched", JSON.stringify(d));
+// }).catch((e) => {
+//     console.log(e.toString());
+// }))
+
+
+
+
+// async function concurrency() {
+//     let result = await _concurrencyClusters(
+//         path.join("C:\\Users\\GB\\Documents\\projects\\requireurl\\concurrency\\src\\worker.cluster.js"),
+//         8,
+//         { url: "https://www.google.com", data: "Testing parent data", childData: "Test data from child" }
+//     )
+//     console.log(result);
+// }
+
+// function concurrency() {
+//     _concurrencyClusters(
+//         path.join("C:\\Users\\GB\\Documents\\projects\\requireurl\\concurrency\\src\\worker.cluster.js"),
+//         8,
+//         { url: "https://www.google.com", data: "Testing parent data", childData: "Test data from child" }
+//     ).then((d) => {
+//         console.log("Data fetched", JSON.stringify(d));
+//     }).catch((e) => {
+//         console.log(e.toString());
+//     })
+// }
+
+function concurrency() {
+    let filename = "C:\\Users\\GB\\Documents\\projects\\requireurl\\concurrency\\src\\worker.cluster.js";
+    return new Promise(function (resolve, reject) {
+        _concurrencyClusters(
+            path.join(filename),
+            8,
+            {
+                data: {
+                    message: "Testing parent data",
+                    url: "https://www.google.com",
+                },
+                childData: "Test data from child"
+            }
+        ).then((d) => {
+            console.log("Data fetched", JSON.stringify(d));
+            resolve(d);
+        }).catch((e) => {
+            console.log(e.toString());
+            reject(e);
+        });
+    });
+}
+
+concurrency();
+
+setTimeout(() => console.log(`demo.cluster.js: run file PID ${process.pid}: Interval 2: 10000 `, process.pid), 10000);
+setTimeout(() => console.log(`demo.cluster.js: Closing process ${process.pid}: Timeout 1: 10000 `, process.exit()), 20000);

package/demos/demos.js

@@ -0,0 +1,21 @@
+/**
+ * 
+ * Package: concurrency.js
+ * Author: Ganesh B
+ * Description: npm module to work with concurrency - worker threads and worker processes easily using simple functions and script files
+ * Install: npm i concurrency.js --save
+ * Github: https://github.com/ganeshkbhat/concurrency
+ * npmjs Link: https://www.npmjs.com/package/
+ * File: index.js
+ * File Description: 
+ * 
+*/
+
+/* eslint no-console: 0 */
+
+'use strict';
+
+
+let { _concurrencyThreads, _concurrencyProcesses, _concurrencyClusters, _concurrencyThreadsAsync } = require("../index.js");
+console.log(_concurrencyThreads, _concurrencyProcesses, _concurrencyClusters, _concurrencyThreadsAsync);
+

package/demos/demos.process.js

@@ -0,0 +1,37 @@
+/**
+ * 
+ * Package: concurrency.js
+ * Author: Ganesh B
+ * Description: npm module to work with concurrency - worker threads and worker processes easily using simple functions and script files
+ * Install: npm i concurrency.js --save
+ * Github: https://github.com/ganeshkbhat/concurrency
+ * npmjs Link: https://www.npmjs.com/package/
+ * File: demo.processes.js
+ * File Description: 
+ * 
+*/
+
+/* eslint no-console: 0 */
+
+'use strict';
+
+
+const path = require("path");
+let { _concurrencyProcesses } = require("../index.js");
+
+let filename = "C:\\Users\\GB\\Documents\\projects\\requireurl\\concurrency\\src\\worker.process.js";
+_concurrencyProcesses(
+    path.join(filename), {
+    data: {
+        message: "Testing data",
+        url: "https://www.google.com"
+    }
+}, true).then((d) => {
+    console.log("Data fetched: ", JSON.stringify(d));
+}).catch((e) => {
+    console.log(e.toString()); setTimeout(() => { process.exit(e); }, 5000)
+});
+
+setTimeout(() => console.log(`demo.processes.js: Run file PID ${process.pid}: Interval 2: 10000 `, process.pid), 10000);
+setTimeout(() => console.log(`demo.processes.js: Closing process ${process.pid}: Timeout 1: 10000 `, process.exit()), 20000);
+

package/demos/demos.threads.async.js

@@ -0,0 +1,22 @@
+
+
+const path = require("path");
+let { _concurrencyThreadsAsync } = require("../index.js");
+
+let filename = "C:\\Users\\GB\\Documents\\projects\\requireurl\\concurrency\\demos\\demos.threads.js";
+
+let threads = _concurrencyThreadsAsync(filename, {
+    data: {
+        message: "Testing parent data",
+        url: "https://www.google.com"
+    },
+    childData: "Test data from child"
+});
+
+console.log(` STDOUT: console.log(threads.stderr); console.log(threads.stdout); `);
+
+console.log(threads.stderr);
+console.log(threads.stdout);
+
+// setTimeout(() => console.log(`demo.cluster.js: run file PID ${process.pid}: Interval 2: 10000 `, process.pid), 10000);
+// setTimeout(() => console.log(`demo.cluster.js: Closing process ${process.pid}: Timeout 1: 10000 `, process.exit()), 20000);

package/demos/demos.threads.js

@@ -0,0 +1,40 @@
+/**
+ * 
+ * Package: concurrency.js
+ * Author: Ganesh B
+ * Description: npm module to work with concurrency - worker threads and worker processes easily using simple functions and script files
+ * Install: npm i concurrency.js --save
+ * Github: https://github.com/ganeshkbhat/concurrency
+ * npmjs Link: https://www.npmjs.com/package/
+ * File: demo.threads.js
+ * File Description: 
+ * 
+*/
+
+/* eslint no-console: 0 */
+
+'use strict';
+
+const path = require("path");
+let { _concurrencyThreads } = require("../index.js");
+
+// _concurrencyThreads(path.join("C:\\Users\\GB\\Documents\\projects\\requireurl\\concurrency\\src\\worker.threads.js"), { data: { url: "https://www.google.com", message: "Testing data" } });
+
+
+_concurrencyThreads(__filename, {
+    data: {
+        url: "https://www.google.com",
+        message: "Testing data"
+    },
+    childData: "Testing child data"
+}, true).then((d) => console.log(JSON.stringify(d)))
+// .catch((e) => { console.log(e.toString()); setTimeout(() => {process.exit(e);}, 5000) })
+
+// setTimeout(() => {
+//     console.log(`demo.threads.js: Closing process ${process.pid}: Timeout 1: 20000 `, __filename);
+//     process.exit(0);
+// }, 20000);
+
+setTimeout(() => console.log(`demo.processes.js: Run file PID ${process.pid}: Interval 2: 10000 `, process.pid), 10000);
+setTimeout(() => console.log(`demo.processes.js: Closing process ${process.pid}: Timeout 1: 10000 `, process.exit()), 20000);
+

package/index.js

@@ -1,9 +1,9 @@
 /**
  * 
- * Package: 
+ * Package: concurrency.js
  * Author: Ganesh B
- * Description: 
- * Install: npm i  --save
+ * Description: npm module to work with concurrency - worker threads and worker processes easily using simple functions and script files
+ * Install: npm i concurrency.js --save
  * Github: https://github.com/ganeshkbhat/concurrency
  * npmjs Link: https://www.npmjs.com/package/
  * File: index.js
@@ -16,3 +16,20 @@
 'use strict';
 
 
+const { _concurrencyThreads } = require("./src/worker.threads.js");
+const { _concurrencyProcesses } = require("./src/worker.process.js");
+const { _concurrencyClusters } = require("./src/worker.cluster.js");
+const { _concurrencyThreadsAsync } = require("./src/worker.thread.async.js");
+
+
+module.exports._concurrencyThreads = _concurrencyThreads;
+module.exports._concurrencyProcesses = _concurrencyProcesses;
+module.exports._concurrencyClusters = _concurrencyClusters;
+module.exports._concurrencyThreadsAsync = _concurrencyThreadsAsync;
+
+module.exports.default = {
+    _concurrencyThreads,
+    _concurrencyProcesses,
+    _concurrencyClusters,
+    _concurrencyThreadsAsync
+};

package/index.mjs

@@ -1,12 +1,12 @@
 /**
  * 
- * Package: 
+ * Package: concurrency.js
  * Author: Ganesh B
- * Description: 
- * Install: npm i  --save
+ * Description: npm module to work with concurrency - worker threads and worker processes easily using simple functions and script files
+ * Install: npm i concurrency.js --save
  * Github: https://github.com/ganeshkbhat/concurrency
  * npmjs Link: https://www.npmjs.com/package/
- * File: index.js
+ * File: index.mjs
  * File Description: 
  * 
 */
@@ -15,3 +15,7 @@
 
 'use strict';
 
+import { _concurrencyThreads, _concurrencyProcesses, _concurrencyThreadsAsync, _concurrencyThreadsAsync } from "./index.js";
+
+export { _concurrencyThreads, _concurrencyProcesses, _concurrencyClusters, _concurrencyThreadsAsync };
+export default _concurrencyProcesses;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "concurrency.js",
-  "version": "0.0.1",
-  "description": "npm module to work with concurrency - worker threads and worker processes easily using simple functions and script files",
+  "version": "0.0.3-beta",
+  "description": "npm module to work with concurrency - worker threads and worker processes (currrently only fork method) easily using simple functions and script files",
   "main": "index.js",
   "directories": {
     "test": "test"
@@ -12,15 +12,21 @@
   },
   "devDependencies": {
     "chai": "^4.3.6",
-    "mocha": "^10.1.0",
-    "nsp": "^3.2.1",
-    "nsp-api": "^1.0.3",
-    "safe-regex": "^2.1.1",
-    "sinon": "^14.0.1",
+    "mocha": "^10.0.0",
+    "npm-check": "^6.0.1",
+    "sinon": "^14.0.0",
     "unimported": "^1.22.0"
   },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ganeshkbhat/concurrency.git"
+  },
+  "bugs": {
+    "url": "https://github.com/ganeshkbhat/concurrency/issues"
+  },
+  "homepage": "https://github.com/ganeshkbhat/concurrency#readme",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "mocha --reporter spec --recursive --timeout 60000"
   },
   "author": "Ganesh B",
   "license": "MIT"