How to launch Temporal in tests of a Typescript Yarn app?

pramodbiligiri · June 15, 2023, 11:07am

Hi,
I want to launch Temporal as part of a unit/integration testsuite setUp method in Typescript and stop it at the end of the testsuite. Let’s say I’m using the Mocha testing framework. Are there any code samples for this?

Or is it recommended to launch temporal via TestContainers or something like that?

bergundy · June 15, 2023, 1:50pm

The TypeScript SDK, as all other SDKs, comes with a testing package.
The testing package for TypeScript will automatically download, start, and stop a development server for you.
There are two different types of development servers:

One using temporal CLI’s dev server
One using the a pre-compiled, standalone version of Java SDK’s time skipping test server

The CLI based server is started with createLocal and is guaranteed to have the same behavior as the “real” Temporal server because its built from the same codebase. It uses an in memory database to avoid persisting state between test runs.

The time skipping server is started with createTimeSkipping and is an alternative, lightweight implementation of Temporal, use this server if you need to test workflows that take a long time as the server will automatically skip time when the workflow is “idle”.

See the dev guide for examples and the tests in the samples repo (there are more in there, I selected one that uses mocha):

github.com

temporalio/samples-typescript/blob/main/activities-examples/src/mocha/workflows.test.ts

import { ActivityFailure, ApplicationFailure, Client, WorkflowFailedError } from '@temporalio/client';
import { Runtime, DefaultLogger, Worker } from '@temporalio/worker';
import { TestWorkflowEnvironment } from '@temporalio/testing';
import assert from 'assert';
import axios from 'axios';
import { after, afterEach, before, describe, it } from 'mocha';
import sinon from 'sinon';
import { v4 as uuid } from 'uuid';
import * as activities from '../activities';
import { httpWorkflow } from '../workflows';
import { WorkflowCoverage } from '@temporalio/nyc-test-coverage';

const workflowCoverage = new WorkflowCoverage();

describe('example workflow', async function () {
  let shutdown: () => Promise<void>;
  let execute: () => ReturnType<typeof httpWorkflow>;
  let getClient: () => Client;

  this.slow(10_000);

This file has been truncated. show original

pramodbiligiri · June 20, 2023, 10:33am

Wow, thanks. This is fantastic. Looks like I’d missed this part of the documentation.

Topic		Replies	Views
Unit test cases for nodejs application in temporal Server Deployment typescript-sdk	1	458	July 19, 2023
Integration Testing With Temporal Using Nodejs/Js Community Support general-impl	2	613	February 5, 2022
Fork Temporal SDK Typescript Community Support typescript-sdk	2	762	August 10, 2022
Error building workflows when executing test with jest Community Support typescript-sdk	2	1005	March 4, 2024
Temporal integrtaion with Serverless workflow with type script sdk Community Support typescript-sdk	2	375	December 6, 2023

How to launch Temporal in tests of a Typescript Yarn app?

Related topics