Skip to main content
SDK предоставляет программные API, которые позволяют собирать, разворачивать, устанавливать и удалять ваше приложение из тестового кода. В сочетании с Vitest и типизированными клиентами API вы можете писать интеграционные тесты, которые проверяют, что ваше приложение работает сквозным образом на реальном сервере Twenty.

Использование пакетов npm

Вы можете устанавливать и использовать любые пакеты npm в своём приложении. И логические функции, и компоненты фронтенда собираются с помощью esbuild, который встраивает их зависимости в выходной файл — каталоги node_modules во время выполнения не нужны.

Установка пакета

Затем импортируйте его в своём коде:
src/logic-functions/fetch-data.ts
То же самое работает для компонентов фронтенда:
src/front-components/chart.tsx

Как работает бандлинг

Этап сборки использует esbuild для создания одного самодостаточного файла на каждую логическую функцию и на каждый компонент фронтенда. Импортированные пакеты встраиваются в бандл, за исключением перечисленных ниже. Логические функции выполняются в среде Node.js. Встроенные модули Node (fs, path, crypto, http и т. д.) доступны и не требуют установки. Компоненты фронтенда выполняются в Web Worker. Встроенные модули Node недоступны — доступны только пакеты npm, работающие в браузерной среде. Обратите внимание, что в песочнице реализован частичный DOM, поэтому пакет может успешно собраться, но все равно завершиться с ошибкой во время выполнения; см. раздел Текущие ограничения. В обеих средах доступны как предварительно предоставленные модули twenty-client-sdk/core и twenty-client-sdk/metadata — они не включаются в бандл, а подставляются сервером во время выполнения. Фронтенд‑компоненты также могут совместно использовать зависимости через общий бандл зависимостей. Пакеты, перечисленные в поле frontComponentSharedDependencies файла package.json приложения, один раз собираются в отдельный файл и загружаются из него во время выполнения вместо внедрения в каждый компонент, поэтому компонент, который импортирует только общие пакеты, практически не содержит собственного кода зависимостей.

Настройка

Приложение, созданное скэффолдером, уже включает Vitest. Если вы настраиваете его вручную, установите зависимости:
Создайте vitest.config.ts в корне вашего приложения:
vitest.config.ts
Создайте глобальный файл настройки, который проверяет, что сервер доступен, записывает тестовую конфигурацию для SDK (~/.twenty/config.test.json) и выполняет синхронизацию приложения перед запуском тестов:
src/__tests__/global-setup.ts

Программные API SDK

Подпуть twenty-sdk/cli экспортирует функции, которые можно вызывать напрямую из тестового кода: Каждая функция возвращает объект результата с success: boolean и либо data, либо error.

Написание интеграционного теста

Полный пример, который собирает, разворачивает и устанавливает приложение, а затем проверяет, что оно появляется в рабочем пространстве:
src/__tests__/app-install.integration-test.ts

Запуск тестов

Убедитесь, что ваш локальный сервер Twenty запущен, затем:
Или в режиме наблюдения во время разработки:

Проверка типов

Вы также можете запустить проверку типов для своего приложения без запуска тестов:
Это запускает tsc --noEmit для tsconfig.json вашего приложения и сообщает о любых ошибках типов. Сгенерированные с помощью скэффолдера приложения также поставляются со скриптом yarn typecheck, который проверяет и тестовые файлы (tsconfig.spec.json).

CI с GitHub Actions

Скэффолдер генерирует готовый к использованию рабочий процесс в .github/workflows/ci.yml. При каждом пуше в main и каждом pull request он запускает эфемерный сервер Twenty в раннере (через экшен twentyhq/twenty/.github/actions/spawn-twenty-app-dev-test), затем выполняет yarn lint, yarn typecheck, yarn test:unit и yarn test с TWENTY_API_URL / TWENTY_API_KEY, указывающими на этот сервер. Секреты не требуются, и вы можете зафиксировать версию сервера через переменную окружения TWENTY_VERSION в начале рабочего процесса. См. раздел Публикация → Автоматизированный CI/CD для полного пошагового руководства по трем сгенерированным рабочим процессам (ci.yml, конвейер деплоя cd.yml и publish.yml для публикации в npm).