dcp-client 4.4.9-0 → 4.4.10-0

package/docs/CODEOWNERS

@@ -1,18 +1,9 @@
-# @file    CODEOWNERS - Defines who develops and maintains a feature, and own
-#          the resulting files or directories in the repository.
-#
-#          See https://docs.gitlab.com/ee/user/project/code_owners.html
-#
-# @author  Bryan Hoang <bryan@distributive.network>
-# @date    August 2022
-
-# Username mapping:
-# @wesgarland -> Wes Garland <wes@distributive.network>
-
-
-[]
+# @file   CODEOWNERS - machine-generated via dcp-docs-wes
+# @author wes@people
 
 [Brandon]
+/publish-docs.sh @BChristieDistributive
+/catalog-info.yaml @BChristieDistributive
 
 [Eddie]
 /package-lock.json @eroosenmaallen
@@ -21,36 +12,6 @@
 /dist/dcp-client-bundle.js @eroosenmaallen @wesgarland
 
 [Wes]
-/ns-map.js @wesgarland
-/lib/ @wesgarland
-/README.md @wesgarland
-/.npmrc @wesgarland
-/dist/ @wesgarland
-/favicon.ico @wesgarland
-/etc/ @wesgarland
-/test-pseudo-root/ @wesgarland
-/windows-registry.js @wesgarland
-/dcp-client.css @wesgarland
-/assets/ @wesgarland
-/build/ @wesgarland
-/tests/ @wesgarland
-/.npmignore @wesgarland
-/bin/ @wesgarland
-/.eslintrc.json @wesgarland
-/index.js @wesgarland
-/libexec/ @wesgarland
-/.tidelift @wesgarland
-/LICENSE.md @wesgarland
-/docs/ @wesgarland
-/cors-proxy.html @wesgarland
-/.gitlab-ci.yml @wesgarland
-/.gitignore @wesgarland
-/init-common.js @wesgarland
-/dcp-client.js @wesgarland
-/cjs2-shim.js @wesgarland
-/examples/ @wesgarland
-/templates/ @wesgarland
-/generated/ @wesgarland
 /templates/ @wesgarland
 /assets/ @wesgarland
 /test-pseudo-root/ @wesgarland
@@ -61,8 +22,33 @@
 /docs/ @wesgarland
 /lib/ @wesgarland
 /libexec/ @wesgarland
-/dist/ @wesgarland
+/dist/dcp-client-bundle.js.map @wesgarland
+/dist/dcp-modal-style.css @wesgarland
 /bin/ @wesgarland
+/.eslintrc.json @wesgarland
+/.git @wesgarland
+/.gitignore @wesgarland
+/.gitlab-ci.yml @wesgarland
+/.npmignore @wesgarland
+/.npmrc @wesgarland
+/.tidelift @wesgarland
+/LICENSE.md @wesgarland
+/README.md @wesgarland
+/cjs2-shim.js @wesgarland
+/cors-proxy.html @wesgarland
+/dcp-client.css @wesgarland
+/dcp-client.js @wesgarland
+/dcp-support.py @wesgarland
+/favicon.ico @wesgarland
+/fs-basic.py @wesgarland
+/generated/ @wesgarland
+/index.js @wesgarland
+/index.py @wesgarland
+/init-common.js @wesgarland
+/licenses/ @wesgarland
+/ns-map.js @wesgarland
+/test-helpers/ @wesgarland
+/windows-registry.js @wesgarland
 
 [Wes or Eddie]
 /package.json @wesgarland @eroosenmaallen

package/examples/nodejs/remote-data/simple-job-remote-data-pattern.js

@@ -0,0 +1,121 @@
+#! /usr/bin/env node
+/**
+ * @file    simple-job-remote-data-pattern.js
+ *
+ *          Simple NodeJS application showing how to use RemoteDataPattern class that works for slices which their uri's has similar patterns
+ *          For more information please refer to:
+ *          https://gitlab.com/Distributed-Compute-Protocol/dcp-docs-wes/-/blob/wip/scheduler/remote-storage.md#data-movement
+ * 
+ *          *********************************** NOTE 1 ***********************************
+ *          Your keystore should be placed in your home directory in .dcp/default.keystore.
+ *          When using the dcp-client API in NodeJS, this keystore will be used for communicating over DCP.
+ * 
+ *          *********************************** NOTE 2 ***********************************
+ *          Executing Job with DCP Worker
+ * 
+ *          Run the following commands in your terminal:
+ *          ```
+ *          npm add --global dcp-worker
+ *          dcp-worker --allowedOrigins http://localhost:<port number>
+ *          ```
+ *            
+ * @author  Nazila Akhavan <nazila@distributive.network>
+ * @author  Kevin Yu       <kevin@distributive.network>
+ * @date    Sep. 2021, June 2024
+ */
+
+'use strict';
+
+const http = require('http');
+const port = 1234;
+
+/**
+ * Setup server to serve JSON serialized input data at api-endpoint
+ * 
+ * @returns {void} 
+ */
+function startBackendServer()
+{
+  const server = http.createServer((req, res) => {
+    // Set appropriate headers so workers on web can fetch data
+    res.setHeader('Access-Control-Allow-Origin', '*');
+
+    if (req.url === '/slice-1.json')
+    {
+      res.setHeader('Content-Type', 'application/json');
+      const data = { value: 'foo' };
+      res.end(JSON.stringify(data));
+    }
+    else if (req.url === '/slice-2.json')
+    {
+      res.setHeader('Content-Type', 'application/json');
+      const data = { value: 'bar' };
+      res.end(JSON.stringify(data));
+    }
+    else
+    {
+      res.statusCode = 404;
+      res.end('Not Found');
+    }
+  });
+
+  server.listen(port, () => {
+    console.log(`Remote data available at http://localhost:${port}/`);
+  });
+}
+
+/**
+ * Setup event listeners for jobs
+ *
+ * @param {object} job - the job handle object
+ * @returns {void} 
+ */
+function addJobEventListeners(job)
+{
+  // Log the job's assigned id.
+  job.on('accepted', ({ id }) => console.log(`Job accepted with id ${id}`));
+
+  // Log returned slice results
+  job.on('result', (result) => console.log('Received result:', result));
+}
+
+/**
+ * Main function to deploy a job with remote work function
+ *
+ * @returns {void} 
+ */
+async function main()
+{
+  const compute = require('dcp/compute');
+  
+  // Start up server to host slice data  
+  startBackendServer();
+  
+  // Prevents repeating URI’s that have the similar pattern and allow passing the pattern and the number of slices.
+  // https://docs.dcp.dev/advanced/data-uri.html
+  const { RemoteDataPattern } = require('dcp/compute');
+
+  // URL where the work function is located
+  const remoteData = new RemoteDataPattern(`http://localhost:${port}/slice-{slice}.json`, 2);
+
+  // Creates a Job for the distributed computer. 
+  // https://docs.dcp.dev/specs/compute-api.html#compute-for
+  const job = compute.for(
+    remoteData,
+    (datum) => {
+      // If a progress event is not emitted within 30 seconds, 
+      // the scheduler will throw an ENOPROGRESS error.
+      progress(1);
+      return datum.value.toUpperCase();
+    },
+  );
+
+  // Listen for job emitted events
+  addJobEventListeners(job);
+
+  // Deploy job
+  const results = await job.exec(compute.marketValue);
+  console.log('Job completed, here are the results: ', Array.from(results));
+}
+ 
+require('../../..').init().then(main).catch(console.error).finally(process.exit);

package/examples/nodejs/remote-data/simple-job-remote-function.js

@@ -0,0 +1,111 @@
+#! /usr/bin/env node
+/**
+ * @file    simple-job-remote-function.js
+ *
+ *          Simple NodeJS application showing how to implement a simple remote work-function.
+ *           
+ *          *********************************** NOTE 1 ***********************************
+ *          Your keystore should be placed in your home directory in .dcp/default.keystore.
+ *          When using the dcp-client API in NodeJS, this keystore will be used for communicating over DCP.
+ *            
+ *          *********************************** NOTE 2 ***********************************
+ *          Executing Job with DCP Worker
+ * 
+ *          Run the following commands in your terminal:
+ *          ```
+ *          npm add --global dcp-worker
+ *          dcp-worker --allowedOrigins http://localhost:<port number>
+ *          ```
+ *
+ * @author  Kevin Yu <kevin@distributive.network>
+ * @date    June 2024
+ */
+
+'use strict';
+
+const http = require('http');
+const port = 1234;
+
+/**
+ * Setup server to serve a work function at api-endpoint
+ * 
+ * @returns {void} 
+ */
+function startBackendServer()
+{
+  const server = http.createServer((req, res) => {
+    // Set appropriate headers to allow cross-origin requests
+    res.setHeader('Access-Control-Allow-Origin', '*');
+
+    if (req.url === '/')
+    {
+      // Define work function as string
+      const workerFunction = `
+      (datum) => {
+        // If a progress event is not emitted within 30 seconds, 
+        // the scheduler will throw an ENOPROGRESS error.
+        progress(1);
+        return datum * 2;
+      }`;
+    
+      res.setHeader('Content-Type', 'application/javascript');
+      res.end(workerFunction);
+    }
+    else
+    {
+      res.statusCode = 404;
+      res.end('Not Found');
+    }
+  });
+
+  server.listen(port, () => {
+    console.log(`Work Function available at http://localhost:${port}/`);
+  });
+}
+
+/**
+ * Setup event listeners for jobs
+ *
+ * @param {object} job - the job handle object
+ * @returns {void} 
+ */
+function addJobEventListeners(job)
+{
+  // Log the job's assigned id.
+  job.on('accepted', ({ id }) => console.log(`Job accepted with id ${id}`));
+
+  // Log returned slice results
+  job.on('result', (result) => console.log('Received result:', result));
+}
+
+/**
+ * Main function to deploy a job with remote work function
+ *
+ * @returns {void} 
+ */
+async function main()
+{
+  const compute = require('dcp/compute');
+  
+  // Start up server to host work function
+  startBackendServer();
+
+  // URL where the work function is located
+  const remoteWorkFunction = new URL(`http://localhost:${port}/`);
+
+  // Creates a Job for the distributed computer. 
+  // https://docs.dcp.dev/specs/compute-api.html#compute-for
+  const job = compute.for(
+    [1, 2, 3, 4],
+    remoteWorkFunction,
+  );
+
+  // Listen for job emitted events
+  addJobEventListeners(job);
+
+  // Deploy job
+  const results = await job.exec(compute.marketRate);
+  console.log('Job completed, here are the results: ', Array.from(results));
+}
+
+require('../../..').init().then(main);

package/examples/nodejs/remote-data/simple-job-remote-input.js

@@ -0,0 +1,127 @@
+#! /usr/bin/env node
+/**
+ * @file    simple-job-remote-input.js 
+ *          
+ *          Sample NodeJS application showing how to deploy a simple DCP job with remote input data 
+ *          that is serialized with either json or kvin (https://github.com/wesgarland/kvin).
+ *
+ *          *********************************** NOTE 1 ***********************************
+ *          Your keystore should be placed in your home directory in .dcp/default.keystore.
+ *          When using the dcp-client API in NodeJS, this keystore will be used for communicating over DCP.
+ * 
+ *          *********************************** NOTE 2 ***********************************
+ *          Executing Job with DCP Worker
+ * 
+ *          Run the following commands in your terminal:
+ *          ```
+ *          npm add --global dcp-worker
+ *          dcp-worker --allowedOrigins http://localhost:<port number>
+ *          ```
+ * 
+ * @author  Nazila Akhavan <nazila@distributive.network>
+ * @author  Kevin Yu       <kevin@distributive.network>
+ * @date    June 2024
+ */
+
+'use strict';
+
+// Serialization library for JavaScript types for transmission over a network
+const kvin = require('kvin');
+const http = require('http');
+const portA = 1234;
+const portB = 2345;
+
+/**
+ * Setup server to serve JSON serialized input data at api-endpoint
+ * 
+ * @returns {void} 
+ */
+function startBackendServerA()
+{
+  const serverA = http.createServer((req, res) => {
+    // Set appropriate headers so workers on web can fetch data
+    res.setHeader('Access-Control-Allow-Origin', '*');
+    res.setHeader('Content-Type', 'application/json');
+    
+    const data = { value: 'foo' };
+    res.end(JSON.stringify(data));
+  });
+  
+  serverA.listen(portA, () => {
+    console.log(`Remote data available at http://localhost:${portA}/`);
+  });
+}
+
+/**
+ * Setup server to serve KVIN serialized input data at api-endpoint
+ * 
+ * @returns {void} 
+ */
+function startBackendServerB()
+{
+  const serverB = http.createServer((req, res) => {
+    // Set appropriate headers so workers on web can fetch data
+    res.setHeader('Access-Control-Allow-Origin', '*');
+    res.setHeader('Content-Type', 'application/x-kvin');
+
+    const data = { value: 'bar' };
+    res.end(kvin.serialize(data));
+  });
+
+  serverB.listen(portB, () => {
+    console.log(`Remote data available at http://localhost:${portB}/`);
+  });
+}
+
+/**
+ * Setup event listeners for jobs
+ *
+ * @param {object} job - the job handle object
+ * @returns {void} 
+ */
+function addJobEventListeners(job)
+{
+  // Log the job's assigned id.
+  job.on('accepted', ({ id }) => console.log(`Job accepted with id ${id}`));
+
+  // Log returned slice results
+  job.on('result', (result) => console.log('Received result:', result));
+}
+
+/**
+ * Main function to deploy a job with remote work function
+ *
+ * @returns {void} 
+ */
+async function main()
+{
+  const compute = require('dcp/compute');
+
+  // Start up server to host slice data  
+  startBackendServerA();
+  startBackendServerB();
+
+  // Fetched remote input data
+  const remoteData = [new URL(`http://localhost:${portA}/`), new URL(`http://localhost:${portB}/`)];
+
+  // Creates a Job for the distributed computer. 
+  // https://docs.dcp.dev/specs/compute-api.html#compute-for
+  const job = compute.for(
+    remoteData,
+    (datum) => {
+      // If a progress event is not emitted within 30 seconds, 
+      // the scheduler will throw an ENOPROGRESS error.
+      progress(1);
+      return datum.value.toUpperCase();
+    },
+  );
+
+  // Listen for job emitted events
+  addJobEventListeners(job);
+
+  // Deploy job
+  const results = await job.exec(compute.marketValue);
+  console.log('Job completed, here are the results: ', Array.from(results));
+}
+
+require('../../..').init().then(main);

package/examples/nodejs/simple-job-es6.mjs

@@ -0,0 +1,60 @@
+#! /usr/bin/env node
+/**
+ * @file    simple-job-es6.mjs
+ * 
+ *          Sample NodeJS application showing how to deploy a simple DCP job using ES6 modules.
+ *
+ *          *********************************** NOTE ***********************************
+ *          Your keystore should be placed in your home directory in .dcp/default.keystore.
+ *          When using the dcp-client API in NodeJS, this keystore will be used for communicating over DCP.
+ * 
+ * @author  Kevin Yu <kevin@distributive.network>
+ * @date    June 2024
+ */
+
+import { init } from '../../index.js';
+
+/**
+ * Setup event listeners for jobs
+ *
+ * @param {object} job - the job handle object
+ * @returns {void} 
+ */
+function addJobEventListeners(job) 
+{
+  // Log the job's assigned id.
+  job.on('accepted', ({ id }) => console.log(`Job accepted with id ${id}`));
+
+  // Log returned slice results
+  job.on('result', (result) => console.log('Received result:', result));
+}
+
+/**
+ * Main function to deploy a job
+ *
+ * @returns {void} 
+ */
+async function main() 
+{
+  const { compute } = await init();
+
+  // Creates a Job for the distributed computer.
+  // https://docs.dcp.dev/specs/compute-api.html#compute-for
+  const job = compute.for(
+    [1, 2, 3, 4],
+    (datum) => {
+      // If a progress event is not emitted within 30 seconds,
+      // the scheduler will throw an ENOPROGRESS error.
+      progress(1);
+      return datum * 2;
+    });
+
+  // Listen for job emitted events
+  addJobEventListeners(job);
+
+  // Deploys the job 
+  const results = await job.exec();
+  console.log(results);
+}
+
+await main();

package/examples/nodejs/simple-job.js

@@ -0,0 +1,62 @@
+#! /usr/bin/env node
+/**
+ * @file    simple-job.js 
+ *          
+ *          Sample NodeJS application showing how to deploy a simple DCP job.
+ *
+ *          *********************************** NOTE ***********************************
+ *          Your keystore should be placed in your home directory in .dcp/default.keystore.
+ *          When using the dcp-client API in NodeJS, this keystore will be used for communicating over DCP.
+* 
+ * @author  Wes Garland <wes@distributive.network>
+ * @author  Kevin Yu    <kevin@distributive.network>
+ * @date    Aug 2019, April 2020, June 2024
+ */
+
+'use strict';
+
+/**
+ * Setup event listeners for jobs
+ *
+ * @param {object} job - the job handle object
+ * @returns {void} 
+ */
+function addJobEventListeners(job)
+{
+  // Log the job's assigned id.
+  job.on('accepted', ({ id }) => console.log(`Job accepted with id ${id}`));
+
+  // Log returned slice results
+  job.on('result', (result) => console.log('Received result:', result));
+}
+
+/**
+ * Main function to deploy a job
+ *
+ * @returns {void} 
+ */
+async function main()
+{
+  const compute = require('dcp/compute');
+
+  // Creates a Job for the distributed computer. 
+  // https://docs.dcp.dev/specs/compute-api.html#compute-for
+  const job = compute.for(
+    [1,2,3,4],
+    (datum) => {
+      // If a progress event is not emitted within 30 seconds, 
+      // the scheduler will throw an ENOPROGRESS error.
+      progress(1);
+      return datum * 2;
+    },
+  );
+
+  // Listen for job emitted events
+  addJobEventListeners(job);
+  
+  // Deploys the job 
+  const results = await job.exec(compute.marketRate);
+  console.log('Job completed, here are the results: ', Array.from(results));
+}
+
+require('../../').init().then(main);