テスト - Twenty Documentation

SDK は、テストコードからアプリのビルド、デプロイ、インストール、アンインストールを可能にするプログラム用 API を提供します。 Vitest と型付き API クライアントを組み合わせることで、実際の Twenty サーバーに対してエンドツーエンドで動作を検証する統合テストを作成できます。

npm パッケージの使用

アプリで任意の npm パッケージをインストールして使用できます。ロジック関数とフロントコンポーネントはどちらも esbuild でバンドルされ、依存関係はすべて出力にインライン化されます—実行時に node_modules は不要です。

パッケージのインストール

yarn add axios

次に、コードでインポートします：

src/logic-functions/fetch-data.ts

import { defineLogicFunction } from 'twenty-sdk/define';
import axios from 'axios';

const handler = async (): Promise<any> => {
  const { data } = await axios.get('https://api.example.com/data');

  return { data };
};

export default defineLogicFunction({
  universalIdentifier: '...',
  name: 'fetch-data',
  description: 'Fetches data from an external API',
  timeoutSeconds: 10,
  handler,
});

フロントコンポーネントでも同様に機能します：

src/front-components/chart.tsx

import { defineFrontComponent } from 'twenty-sdk/define';
import { format } from 'date-fns';

const DateWidget = () => {
  return <p>Today is {format(new Date(), 'MMMM do, yyyy')}</p>;
};

export default defineFrontComponent({
  universalIdentifier: '...',
  name: 'date-widget',
  component: DateWidget,
});

バンドルの仕組み

ビルドステップでは esbuild を使用して、各ロジック関数および各フロントコンポーネントごとに自己完結した単一ファイルを生成します。インポートされたパッケージはすべてバンドルにインライン化されます。 ロジック関数は Node.js 環境で実行されます。 Node の組み込みモジュール（fs、path、crypto、http など）は利用可能で、インストールは不要です。 フロントコンポーネントは Web Worker で実行されます。 Node の組み込みモジュールは利用できません—ブラウザー環境で動作するブラウザー API と npm パッケージのみが使用できます。どちらの環境でも、twenty-client-sdk/core および twenty-client-sdk/metadata が事前提供モジュールとして利用可能です—これらはバンドルされず、実行時にサーバーによって解決されます。

セットアップ

スキャフォルドされたアプリにはすでに Vitest が含まれています。手動で設定する場合は、依存関係をインストールしてください：

yarn add -D vitest vite-tsconfig-paths

アプリのルートに vitest.config.ts を作成します：

vitest.config.ts

import tsconfigPaths from 'vite-tsconfig-paths';
import { defineConfig } from 'vitest/config';

export default defineConfig({
  plugins: [
    tsconfigPaths({
      projects: ['tsconfig.spec.json'],
      ignoreConfigErrors: true,
    }),
  ],
  test: {
    testTimeout: 120_000,
    hookTimeout: 120_000,
    include: ['src/**/*.integration-test.ts'],
    setupFiles: ['src/__tests__/setup-test.ts'],
    env: {
      TWENTY_API_URL: 'http://localhost:2020',
      TWENTY_API_KEY: 'your-api-key',
    },
  },
});

テストを実行する前にサーバーに到達可能であることを検証するセットアップファイルを作成します：

src/__tests__/setup-test.ts

import * as fs from 'fs';
import * as os from 'os';
import * as path from 'path';
import { beforeAll } from 'vitest';

const TWENTY_API_URL = process.env.TWENTY_API_URL ?? 'http://localhost:2020';
const TEST_CONFIG_DIR = path.join(os.tmpdir(), '.twenty-sdk-test');

beforeAll(async () => {
  // Verify the server is running
  const response = await fetch(`${TWENTY_API_URL}/healthz`);

  if (!response.ok) {
    throw new Error(
      `Twenty server is not reachable at ${TWENTY_API_URL}. ` +
        'Start the server before running integration tests.',
    );
  }

  // Write a temporary config for the SDK
  fs.mkdirSync(TEST_CONFIG_DIR, { recursive: true });

  fs.writeFileSync(
    path.join(TEST_CONFIG_DIR, 'config.json'),
    JSON.stringify({
      remotes: {
        local: {
          apiUrl: process.env.TWENTY_API_URL,
          apiKey: process.env.TWENTY_API_KEY,
        },
      },
      defaultRemote: 'local',
    }, null, 2),
  );
});

プログラム用 SDK API

twenty-sdk/cli サブパスは、テストコードから直接呼び出せる関数をエクスポートします：

関数	説明
`appBuild`	アプリをビルドし、必要に応じて tarball にパッケージ化
`appDeploy`	tarball をサーバーにアップロード
`appInstall`	アクティブなワークスペースにアプリをインストール
`appUninstall`	アクティブなワークスペースからアプリをアンインストール

各関数は、success: boolean と data または error のいずれかを含む結果オブジェクトを返します。

統合テストの作成

アプリをビルド、デプロイ、インストールし、その後ワークスペースに表示されることを検証する完全な例を次に示します：

src/__tests__/app-install.integration-test.ts

import { APPLICATION_UNIVERSAL_IDENTIFIER } from 'src/application-config';
import { appBuild, appDeploy, appInstall, appUninstall } from 'twenty-sdk/cli';
import { MetadataApiClient } from 'twenty-client-sdk/metadata';
import { afterAll, beforeAll, describe, expect, it } from 'vitest';

const APP_PATH = process.cwd();

describe('App installation', () => {
  beforeAll(async () => {
    const buildResult = await appBuild({
      appPath: APP_PATH,
      tarball: true,
      onProgress: (message: string) => console.log(`[build] ${message}`),
    });

    if (!buildResult.success) {
      throw new Error(`Build failed: ${buildResult.error?.message}`);
    }

    const deployResult = await appDeploy({
      tarballPath: buildResult.data.tarballPath!,
      onProgress: (message: string) => console.log(`[deploy] ${message}`),
    });

    if (!deployResult.success) {
      throw new Error(`Deploy failed: ${deployResult.error?.message}`);
    }

    const installResult = await appInstall({ appPath: APP_PATH });

    if (!installResult.success) {
      throw new Error(`Install failed: ${installResult.error?.message}`);
    }
  });

  afterAll(async () => {
    await appUninstall({ appPath: APP_PATH });
  });

  it('should find the installed app in the workspace', async () => {
    const metadataClient = new MetadataApiClient();

    const result = await metadataClient.query({
      findManyApplications: {
        id: true,
        name: true,
        universalIdentifier: true,
      },
    });

    const installedApp = result.findManyApplications.find(
      (app: { universalIdentifier: string }) =>
        app.universalIdentifier === APPLICATION_UNIVERSAL_IDENTIFIER,
    );

    expect(installedApp).toBeDefined();
  });
});

テストの実行

ローカルの Twenty サーバーが起動していることを確認し、次を実行します：

yarn test

また、開発中はウォッチモードでも実行できます：

yarn test:watch

型チェック

テストを実行せずに、アプリの型チェックのみを実行することもできます：

yarn twenty dev:typecheck

これは tsc --noEmit を実行し、型エラーを報告します。

GitHub Actions による CI

スキャフォルダーは、すぐに使える GitHub Actions ワークフローを .github/workflows/ci.yml に生成します。 main へのプッシュやプルリクエストのたびに、統合テストを自動実行します。ワークフローの内容:

コードをチェックアウトする
twentyhq/twenty/.github/actions/spawn-twenty-docker-image アクションを使って一時的な Twenty サーバーを起動する
yarn install --immutable で依存関係をインストールする
アクションの出力から注入された TWENTY_API_URL と TWENTY_API_KEY を用いて yarn test を実行する

.github/workflows/ci.yml

name: CI

on:
  push:
    branches:
      - main
  pull_request: {}

env:
  TWENTY_VERSION: latest

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Spawn Twenty instance
        id: twenty
        uses: twentyhq/twenty/.github/actions/spawn-twenty-docker-image@main
        with:
          twenty-version: ${{ env.TWENTY_VERSION }}
          github-token: ${{ secrets.GITHUB_TOKEN }}

      - name: Enable Corepack
        run: corepack enable

      - name: Setup Node.js
        uses: actions/setup-node@v4
        with:
          node-version-file: '.nvmrc'
          cache: 'yarn'

      - name: Install dependencies
        run: yarn install --immutable

      - name: Run integration tests
        run: yarn test
        env:
          TWENTY_API_URL: ${{ steps.twenty.outputs.server-url }}
          TWENTY_API_KEY: ${{ steps.twenty.outputs.access-token }}

シークレットを設定する必要はありません。spawn-twenty-docker-image アクションがランナー内で一時的な Twenty サーバーを直接起動し、接続情報を出力します。 GITHUB_TOKEN シークレットは GitHub によって自動的に提供されます。 latest の代わりに特定の Twenty バージョンを固定するには、ワークフローの先頭にある TWENTY_VERSION 環境変数を変更します。

​npm パッケージの使用

​パッケージのインストール

​バンドルの仕組み

​セットアップ

​プログラム用 SDK API

​統合テストの作成

​テストの実行

​型チェック

​GitHub Actions による CI