コンポーネント間通信

複数のコンポーネントで構成される Blocklet アプリケーションでは、コンポーネント同士が安全かつ確実に通信できることが不可欠です。Blocklet SDK は、この目的のために特別に設計された高レベルのユーティリティ component.call を提供します。このメソッドは、サービスディスカバリ、リクエスト署名、自動リトライを処理することで、コンポーネント間の API 呼び出しを簡素化します。

このアプローチは、動的ポートや Docker ネットワーキングといった基盤環境の複雑さを抽象化し、すべての通信が認証されることを保証するため、直接的な HTTP リクエストよりも堅牢です。

セキュアな API 呼び出しの実行

コンポーネント間通信の主要なメソッドは component.call です。これは HTTP クライアント (axios) のラッパーとして機能しますが、呼び出し元コンポーネントのアイデンティティを検証するために必要な認証ヘッダーを自動的に挿入します。

基本的な使用法

これは、あるコンポーネントが 'user-service' という名前の別のコンポーネントの API エンドポイントを呼び出す基本的な例です。

Calling another component

import component from '@blocklet/sdk/component';

async function getUserProfile(userId) {
  try {
    const response = await component.call({
      name: 'user-service', // ターゲットコンポーネントの名前、DID、またはタイトル
      method: 'GET',
      path: `/api/users/${userId}`,
    });

    console.log('User Profile:', response.data);
    return response.data;
  } catch (error) {
    console.error('Failed to call user-service:', error.message);
  }
}

仕組み

component.call 関数は、いくつかの主要なステップを通じて通信プロセスを効率化します：

1. サービスディスカバリ

   アプリケーションのコンポーネントレジストリでターゲットコンポーネント（例：'user-service'）を検索し、その現在の場所とメタデータを見つけます。

2. エンドポイント解決

   コンポーネントに到達するための正しい内部 URL を構築し、Docker コンテナネットワーキングなどの複雑さを自動的に処理します。

3. リクエスト署名

   リクエストを送信する前に、特別な x-component-* ヘッダーを自動的に追加します。これらのヘッダーには、呼び出し元コンポーネントの秘密鍵を使用して生成された署名が含まれており、そのアイデンティティを証明します。

4. API 呼び出し

   設定されたメソッド、パス、データを使用して HTTP リクエストを実行します。

5. 自動リトライ

   一時的なサーバーエラー（例：5xx ステータスコード）によりリクエストが失敗した場合、遅延を増やしながら（指数バックオフ）、リクエストを数回自動的に再試行します。

このフローにより、通信の信頼性と安全性の両方が保証されます。受信側コンポーネントは、セッションミドルウェアを使用して署名を検証し、リクエストを認可できます。

call のパラメータ

component.call 関数は、次のプロパティを持つオプションオブジェクトを受け入れます：

戻り値

この関数は、data、status、headers などのプロパティを含む AxiosResponse オブジェクトに解決される Promise を返します。

高度な使用法

リトライ動作のカスタマイズ

component.call に 2 番目の引数を渡すことで、自動リトライロジックをカスタマイズできます。これは、エンドポイントの特定の信頼性要件に合わせて調整するのに役立ちます。

Custom Retry Options

import component from '@blocklet/sdk/component';

const callOptions = {
  name: 'data-processor',
  method: 'POST',
  path: '/api/process',
  data: { job: 'some-long-job' },
};

const retryOptions = {
  retries: 5,       // 合計で 5 回試行
  minTimeout: 1000, // リトライ間隔は最低 1 秒
  factor: 2,        // 失敗するたびに待機時間を 2 倍にする
};

async function processData() {
  const response = await component.call(callOptions, retryOptions);
  return response.data;
}

retryOptions オブジェクトは、次のプロパティを持つことができます：

ストリーム応答の処理

ストリームを返すエンドポイント（例：大きなファイルのダウンロード）の場合、responseType: 'stream' を設定できます。これにより、応答全体をメモリにバッファリングすることなく、データが到着したときに処理できます。

Streaming a File

import fs from 'fs';
import component from '@blocklet/sdk/component';

async function downloadBackup() {
  const response = await component.call({
    name: 'backup-service',
    method: 'GET',
    path: '/api/export',
    responseType: 'stream',
  });

  const writer = fs.createWriteStream('backup.zip');
  response.data.pipe(writer);

  return new Promise((resolve, reject) => {
    writer.on('finish', resolve);
    writer.on('error', reject);
  });
}

component.call を使用することで、堅牢で安全なマルチコンポーネントアプリケーションを簡単に構築できます。次の論理的なステップは、これらの着信呼び出しを検証してコンポーネントの API エンドポイントを保護する方法を学ぶことです。詳細については、セッションミドルウェアガイドを参照してください。