@kitsuyui/intended-rollback

Provide intended rollback feature for testing.

Installation

NPM

1$ npm install @kitsuyui/intended-rollback

Yarn

1$ yarn add @kitsuyui/intended-rollback

pnpm

1$ pnpm add @kitsuyui/intended-rollback

Usage

Following example is for prisma. But you can use this library for any other libraries.

1import { Prisma, PrismaClient } from '...'
2import { intendedRollback } from '@kitsuyui/intended-rollback'
3
4export const prismaIntendedRollback = async <T>(
5  prisma: PrismaClient,
6  rollback: boolean,
7  innerBlock: (prisma: Prisma.TransactionClient) => Promise<T>,
8): Promise<Result<T>> => {
9  const wrapped = wrapWithRollback<PrismaClient, Prisma.TransactionClient, T>(
10    async (prisma, callback) => await prisma.$transaction(callback),
11  )
12  return await wrapped(prisma, rollback, innerBlock)
13}

1import { Prisma, PrismaClient } from '...'
2import { prismaIntendedRollback } from '...'
3
4const rollback = process.env.NODE_ENV === 'test'
5const result = await prismaIntendedRollback(
6  prisma,
7  rollback,
8  async (prisma) => await createUser(prisma, { email, password }),
9)
10if (result.success) {
11  const user = result.content
12  console.log(`User created successfully. ID: ${user.id}`)
13  if (result.rollback.intended) {
14    console.log(
15      'Rollback for testing purposes. No actual data changes were made.',
16    )
17  }
18} else {
19  // When the error is not from this library, you can throw it.
20  throw result.error
21}

License

MIT