test/parallel/test-cluster-basic.js

// Copyright Joyent, Inc. and other Node contributors.
//
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to permit
// persons to whom the Software is furnished to do so, subject to the
// following conditions:
//
// The above copyright notice and this permission notice shall be included
// in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
// NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
// DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
// USE OR OTHER DEALINGS IN THE SOFTWARE.

'use strict';
const common = require('../common');

const assert = require('node:assert');
const cluster = require('node:cluster');
const { spawnSync } = require('node:child_process');

assert.strictEqual('NODE_UNIQUE_ID' in process.env, false,
                   `NODE_UNIQUE_ID (${process.env.NODE_UNIQUE_ID}) ` +
                   'should be removed on startup');

{
  const { status } = spawnSync(process.execPath, [
    '-e',
    `
      const { strictEqual } = require('node:assert');
      Object.setPrototypeOf(process.env, { NODE_UNIQUE_ID: 0 });
      strictEqual(require('cluster').isPrimary, true);
    `,
  ]);
  assert.strictEqual(status, 0);
}

function forEach(obj, fn) {
  Object.keys(obj).forEach((name, index) => {
    fn(obj[name], name, index);
  });
}


if (cluster.isWorker) {
  require('http').Server(common.mustNotCall()).listen(0, '127.0.0.1');
} else if (cluster.isPrimary) {

  const checks = {
    cluster: {
      events: {
        fork: false,
        online: false,
        listening: false,
        exit: false
      },
      equal: {
        fork: false,
        online: false,
        listening: false,
        exit: false
      }
    },

    worker: {
      events: {
        online: false,
        listening: false,
        exit: false
      },
      equal: {
        online: false,
        listening: false,
        exit: false
      },
      states: {
        none: false,
        online: false,
        listening: false,
        dead: false
      }
    }
  };

  const stateNames = Object.keys(checks.worker.states);

  // Check events, states, and emit arguments
  forEach(checks.cluster.events, common.mustCallAtLeast((bool, name, index) => {

    // Listen on event
    cluster.on(name, common.mustCall(function(/* worker */) {

      // Set event
      checks.cluster.events[name] = true;

      // Check argument
      checks.cluster.equal[name] = worker === arguments[0];

      // Check state
      const state = stateNames[index];
      checks.worker.states[state] = (state === worker.state);
    }));
  }));

  // Kill worker when listening
  cluster.on('listening', common.mustCall(() => {
    worker.kill();
  }));

  // Kill process when worker is killed
  cluster.on('exit', common.mustCall());

  // Create worker
  const worker = cluster.fork();
  assert.strictEqual(worker.id, 1);
  assert(worker instanceof cluster.Worker,
         'the worker is not a instance of the Worker constructor');

  // Check event
  forEach(checks.worker.events, common.mustCallAtLeast((bool, name, index) => {
    worker.on(name, common.mustCall(function() {
      // Set event
      checks.worker.events[name] = true;

      // Check argument
      checks.worker.equal[name] = (worker === this);

      switch (name) {
        case 'exit':
          assert.strictEqual(arguments[0], worker.process.exitCode);
          assert.strictEqual(arguments[1], worker.process.signalCode);
          assert.strictEqual(arguments.length, 2);
          break;

        case 'listening': {
          assert.strictEqual(arguments.length, 1);
          assert.strictEqual(Object.keys(arguments[0]).length, 4);
          assert.strictEqual(arguments[0].address, '127.0.0.1');
          assert.strictEqual(arguments[0].addressType, 4);
          assert(Object.hasOwn(arguments[0], 'fd'));
          assert.strictEqual(arguments[0].fd, undefined);
          const port = arguments[0].port;
          assert(Number.isInteger(port));
          assert(port >= 1);
          assert(port <= 65535);
          break;
        }
        default:
          assert.strictEqual(arguments.length, 0);
          break;
      }
    }));
  }));

  // Check all values
  process.on('exit', () => {
    // Check cluster events
    for (const [ name, check ] of Object.entries(checks.cluster.events)) {
      assert(check,
             `The cluster event "${name}" on the cluster object did not fire`);
    }

    // Check cluster event arguments
    for (const [ name, check ] of Object.entries(checks.cluster.equal)) {
      assert(check,
             `The cluster event "${name}" did not emit with correct argument`);
    }

    // Check worker states
    for (const [ name, check ] of Object.entries(checks.worker.states)) {
      assert(check,
             `The worker state "${name}" was not set to true`);
    }

    // Check worker events
    for (const [ name, check ] of Object.entries(checks.worker.events)) {
      assert(check,
             `The worker event "${name}" on the worker object did not fire`);
    }

    // Check worker event arguments
    for (const [ name, check ] of Object.entries(checks.worker.equal)) {
      assert(check,
             `The worker event "${name}" did not emit with correct argument`);
    }
  });

}