@ticketmaster/allure-mock

@ticketmaster/allure-mock

Allure common mocking solution library.

This library is a collection of shared mocking middlewares to mock shared services inside an Allure project.

Usage

1. Install dependencies

First, you need to install the dependencies.

yarn add @ticketmaster/allure-mock -D

2. Create the mock server creator

If you don't already have one, you have to create a function to instantiate a mock server. This function will be called later if we need to mock calls.

We recommend to put this file at the root of your src folder and call it middleware.ts.

// src/middleware.ts

import { NextRequest, NextResponse } from "next/server";
import createMiddleware from "next-intl/middleware";
import { AVAILABLE_LOCALES, DEFAULT_LOCALE } from "./config";
import {
  applicationsMockApi,
  identityMockApi,
} from "@ticketmaster/allure-mock";

export function middleware(request: NextRequest) {
const handleI18nRouting = createIntlMiddleware({
  locales: AVAILABLE_LOCALES,
  defaultLocale: DEFAULT_LOCALE,
  localeDetection: true,
});

const response = handleI18nRouting(request);

export const config = {
  matcher: [
    "/((?!_next).*)", // do not localize next.js paths
    `/api/v1/:path*`, // Limit the middleware to paths starting with `/api/v1`
  ],
};

export function middleware(req: NextRequest) {
  if (process.env.NODE_ENV === "development") {
    const { pathname } = request.nextUrl;
    const endpointsMap: {
      [key: string]: (nextRequest: NextRequest) => Promise<NextResponse>;
    } = {
      "/applications": applicationsMockApi,
      "/sessions/logout": identityMockApi,
      "/systems": identityMockApi,
      "/token/refresh": identityMockApi,
      "/token/verify": identityMockApi,
    };

    if (pathname.startsWith("/api/v1")) {
      const path = pathname.split("/api/v1");
      const endpoint = path.length > 0 ? path[1] : "";

      for (const [key, value] of Object.entries(endpointsMap)) {
        if (endpoint.match(key)) {
          return value(request);
        }
      }
    }
  }

  return NextResponse.next();
}