Node.js v25.0.0 ドキュメンテーション

警告: エラーを無視しないでください！#

ドメインのエラーハンドラは、エラーが発生したときにプロセスをシャットダウンすることの代替にはなりません。

JavaScript で throw が機能するまさにその性質上、参照のリークや、その他の未定義の不安定な状態を作り出すことなく、安全に「中断したところから再開する」方法はほとんどありません。

スローされたエラーに対応する最も安全な方法は、プロセスをシャットダウンすることです。もちろん、通常の Web サーバでは、多くの接続が開いている可能性があり、誰かによって引き起こされたエラーのためにそれらを突然シャットダウンすることは合理的ではありません。

より良いアプローチは、エラーを引き起こしたリクエストにエラーレスポンスを送信し、他のリクエストは通常の時間内に終了させ、そのワーカーで新しいリクエストのリッスンを停止することです。

このように、domain の使用はクラスタモジュールと密接に関連しています。なぜなら、プライマリプロセスはワーカーがエラーに遭遇したときに新しいワーカーをフォークできるからです。複数のマシンにスケールする Node.js プログラムの場合、終端プロキシやサービスレジストリが障害を検知し、それに応じて対応できます。

例えば、これは良いアイデアではありません。

// XXX WARNING! BAD IDEA!

const d = require('node:domain').create();
d.on('error', (er) => {
  // The error won't crash the process, but what it does is worse!
  // Though we've prevented abrupt process restarting, we are leaking
  // a lot of resources if this ever happens.
  // This is no better than process.on('uncaughtException')!
  console.log(`error, but oh well ${er.message}`);
});
d.run(() => {
  require('node:http').createServer((req, res) => {
    handleRequest(req, res);
  }).listen(PORT);
}); copy

ドメインのコンテキストと、プログラムを複数のワーカープロセスに分離する回復力を利用することで、より適切に対応し、はるかに高い安全性でエラーを処理できます。

// Much better!

const cluster = require('node:cluster');
const PORT = +process.env.PORT || 1337;

if (cluster.isPrimary) {
  // A more realistic scenario would have more than 2 workers,
  // and perhaps not put the primary and worker in the same file.
  //
  // It is also possible to get a bit fancier about logging, and
  // implement whatever custom logic is needed to prevent DoS
  // attacks and other bad behavior.
  //
  // See the options in the cluster documentation.
  //
  // The important thing is that the primary does very little,
  // increasing our resilience to unexpected errors.

  cluster.fork();
  cluster.fork();

  cluster.on('disconnect', (worker) => {
    console.error('disconnect!');
    cluster.fork();
  });

} else {
  // the worker
  //
  // This is where we put our bugs!

  const domain = require('node:domain');

  // See the cluster documentation for more details about using
  // worker processes to serve requests. How it works, caveats, etc.

  const server = require('node:http').createServer((req, res) => {
    const d = domain.create();
    d.on('error', (er) => {
      console.error(`error ${er.stack}`);

      // We're in dangerous territory!
      // By definition, something unexpected occurred,
      // which we probably didn't want.
      // Anything can happen now! Be very careful!

      try {
        // Make sure we close down within 30 seconds
        const killtimer = setTimeout(() => {
          process.exit(1);
        }, 30000);
        // But don't keep the process open just for that!
        killtimer.unref();

        // Stop taking new requests.
        server.close();

        // Let the primary know we're dead. This will trigger a
        // 'disconnect' in the cluster primary, and then it will fork
        // a new worker.
        cluster.worker.disconnect();

        // Try to send an error to the request that triggered the problem
        res.statusCode = 500;
        res.setHeader('content-type', 'text/plain');
        res.end('Oops, there was a problem!\n');
      } catch (er2) {
        // Oh well, not much we can do at this point.
        console.error(`Error sending 500! ${er2.stack}`);
      }
    });

    // Because req and res were created before this domain existed,
    // we need to explicitly add them.
    // See the explanation of implicit vs explicit binding below.
    d.add(req);
    d.add(res);

    // Now run the handler function in the domain.
    d.run(() => {
      handleRequest(req, res);
    });
  });
  server.listen(PORT);
}

// This part is not important. Just an example routing thing.
// Put fancy application logic here.
function handleRequest(req, res) {
  switch (req.url) {
    case '/error':
      // We do some async stuff, and then...
      setTimeout(() => {
        // Whoops!
        flerb.bark();
      }, timeout);
      break;
    default:
      res.end('ok');
  }
} copy

Error オブジェクトへの追加#

Error オブジェクトがドメインを介してルーティングされるたびに、いくつかの追加フィールドがそれに付加されます。

• error.domain 最初にエラーを処理したドメイン。
• error.domainEmitter エラーオブジェクトとともに 'error' イベントを発生させたイベントエミッタ。
• error.domainBound ドメインにバインドされ、最初の引数としてエラーが渡されたコールバック関数。
• error.domainThrown エラーがスローされたか、発生したか、バインドされたコールバック関数に渡されたかを示すブール値。

暗黙的なバインディング#

ドメインが使用されている場合、すべての新しい EventEmitter オブジェクト（Stream オブジェクト、リクエスト、レスポンスなどを含む）は、作成時のアクティブなドメインに暗黙的にバインドされます。

さらに、低レベルのイベントループリクエスト（fs.open() やその他のコールバックを受け取るメソッドなど）に渡されるコールバックは、自動的にアクティブなドメインにバインドされます。それらがスローした場合、ドメインがエラーをキャッチします。

過度のメモリ使用を防ぐために、Domain オブジェクト自体はアクティブなドメインの子として暗黙的に追加されません。もしそうなっていたら、リクエストオブジェクトとレスポンスオブジェクトが適切にガベージコレクションされるのを妨げることがあまりにも簡単になってしまいます。

Domain オブジェクトを親 Domain の子としてネストするには、明示的に追加する必要があります。

暗黙的なバインディングは、スローされたエラーと 'error' イベントを Domain の 'error' イベントにルーティングしますが、EventEmitter を Domain に登録はしません。暗黙的なバインディングは、スローされたエラーと 'error' イベントのみを処理します。

明示的なバインディング#

時々、使用中のドメインが特定のイベントエミッタに使用されるべきものではないことがあります。あるいは、イベントエミッタがあるドメインのコンテキストで作成されたが、代わりに他のドメインにバインドされるべきである場合もあります。

例えば、HTTP サーバ用に 1 つのドメインが使用されているが、リクエストごとに別のドメインを使用したい場合などです。

それは明示的なバインディングによって可能です。

// Create a top-level domain for the server
const domain = require('node:domain');
const http = require('node:http');
const serverDomain = domain.create();

serverDomain.run(() => {
  // Server is created in the scope of serverDomain
  http.createServer((req, res) => {
    // Req and res are also created in the scope of serverDomain
    // however, we'd prefer to have a separate domain for each request.
    // create it first thing, and add req and res to it.
    const reqd = domain.create();
    reqd.add(req);
    reqd.add(res);
    reqd.on('error', (er) => {
      console.error('Error', er, req.url);
      try {
        res.writeHead(500);
        res.end('Error occurred, sorry.');
      } catch (er2) {
        console.error('Error sending 500', er2, req.url);
      }
    });
  }).listen(1337);
}); copy

domain.create()#

• 戻り値: <Domain>

クラス: Domain#

• 継承元: <EventEmitter>

Domain クラスは、エラーとキャッチされなかった例外をアクティブな Domain オブジェクトにルーティングする機能をカプセル化します。

キャッチしたエラーを処理するには、その 'error' イベントをリッスンします。

const d = domain.create();

function readSomeFile(filename, cb) {
  fs.readFile(filename, 'utf8', d.bind((er, data) => {
    // If this throws, it will also be passed to the domain.
    return cb(er, data ? JSON.parse(data) : null);
  }));
}

d.on('error', (er) => {
  // An error occurred somewhere. If we throw it now, it will crash the program
  // with the normal line number and stack message.
}); copy

const d = domain.create();

function readSomeFile(filename, cb) {
  fs.readFile(filename, 'utf8', d.intercept((data) => {
    // Note, the first argument is never passed to the
    // callback since it is assumed to be the 'Error' argument
    // and thus intercepted by the domain.

    // If this throws, it will also be passed to the domain
    // so the error-handling logic can be moved to the 'error'
    // event on the domain instead of being repeated throughout
    // the program.
    return cb(null, JSON.parse(data));
  }));
}

d.on('error', (er) => {
  // An error occurred somewhere. If we throw it now, it will crash the program
  // with the normal line number and stack message.
}); copy

const domain = require('node:domain');
const fs = require('node:fs');
const d = domain.create();
d.on('error', (er) => {
  console.error('Caught error!', er);
});
d.run(() => {
  process.nextTick(() => {
    setTimeout(() => { // Simulating some various async stuff
      fs.open('non-existent file', 'r', (er, fd) => {
        if (er) throw er;
        // proceed...
      });
    }, 100);
  });
}); copy

ドメインと Promise#

Node.js 8.0.0 以降、Promise のハンドラは .then() または .catch() の呼び出し自体が行われたドメイン内で実行されます。

const d1 = domain.create();
const d2 = domain.create();

let p;
d1.run(() => {
  p = Promise.resolve(42);
});

d2.run(() => {
  p.then((v) => {
    // running in d2
  });
}); copy

コールバックは domain.bind(callback) を使用して特定のドメインにバインドすることができます。

const d1 = domain.create();
const d2 = domain.create();

let p;
d1.run(() => {
  p = Promise.resolve(42);
});

d2.run(() => {
  p.then(p.domain.bind((v) => {
    // running in d1
  }));
}); copy

ドメインは Promise のエラーハンドリングメカニズムに干渉しません。つまり、未処理の Promise のリジェクトに対して 'error' イベントは発生しません。