Skip to content

Use correct interface #912

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kibertoad merged 2 commits into from
Apr 10, 2026
+24 −24
Merged

Use correct interface #912

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c22eecd
Use correct interface
kibertoad Apr 10, 2026
046a56f
Fix latest msw
kibertoad Apr 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions packages/app/universal-testing-utils/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Reusable testing utilities that are potentially relevant for both backend and fr
import { buildRestContract } from '@lokalise/api-contracts'
import { sendByContract } from '@lokalise/frontend-http-client'
import { setupServer } from 'msw/node'
import { afterAll, afterEach, beforeEach, describe, expect, it } from 'vitest'
import { afterAll, afterEach, beforeAll, describe, expect, it } from 'vitest'
import wretch, { type Wretch } from 'wretch'
import { z } from 'zod/v4'
import { MswHelper } from '@lokalise/universal-testing-utils'
Expand All @@ -59,7 +59,7 @@ describe('MswHelper', () => {
const mswHelper = new MswHelper(BASE_URL)
const wretchClient = wretch(BASE_URL)

beforeEach(() => { server.listen({ onUnhandledRequest: 'error' }) })
beforeAll(() => { server.listen({ onUnhandledRequest: 'error' }) })
afterEach(() => { server.resetHandlers() })
afterAll(() => { server.close() })

Expand Down
2 changes: 1 addition & 1 deletion packages/app/universal-testing-utils/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@
"@lokalise/tsconfig": "^3.1.0",
"@vitest/coverage-v8": "^4.0.15",
"mockttp": "^4.2.1",
"msw": "^2.11.1",
"msw": "^2.13.2",
"rimraf": "^6.0.1",
"typescript": "5.9.3",
"vitest": "^4.0.15",
Expand Down
4 changes: 2 additions & 2 deletions packages/app/universal-testing-utils/src/MswHelper.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { mapRouteToPath } from '@lokalise/api-contracts'
import { sendByContract } from '@lokalise/frontend-http-client'
import { setupServer } from 'msw/node'
import { afterAll, afterEach, beforeEach, describe, expect, it } from 'vitest'
import { afterAll, afterEach, beforeAll, describe, expect, it } from 'vitest'
import wretch from 'wretch'
import {
getContract,
Expand All @@ -25,7 +25,7 @@ describe('MswHelper', () => {
const mswHelper = new MswHelper(BASE_URL)
const wretchClient = wretch(BASE_URL)

beforeEach(() => {
beforeAll(() => {
server.listen({ onUnhandledRequest: 'error' })
})
afterEach(() => {
Expand Down
38 changes: 19 additions & 19 deletions packages/app/universal-testing-utils/src/MswHelper.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ import {
type JsonBodyType,
type PathParams,
} from 'msw'
import type { SetupServerApi } from 'msw/node'
import type { SetupServer } from 'msw/node'
import type { ZodObject, z } from 'zod/v4'
import { formatSseResponse, type SseMockEvent } from './MockttpHelper.ts'

Expand Down Expand Up @@ -96,7 +96,7 @@ function joinURL(base: string, path: string): string {
}

export type MockEndpointParams<PathParamsSchema extends z.Schema | undefined> = {
server: SetupServerApi
server: SetupServer
contract:
| CommonRouteDefinition<any, PathParamsSchema, any, any, any, any, any, any>
| PayloadRouteDefinition<any, any, PathParamsSchema, any, any, any, any, any, any>
Expand Down Expand Up @@ -213,7 +213,7 @@ export class MswHelper {
any,
any
>,
server: SetupServerApi,
server: SetupServer,
params: PathParamsSchema extends z.Schema
? MswDualModeMockParams<
InferSchemaInput<PathParamsSchema>,
Expand Down Expand Up @@ -243,7 +243,7 @@ export class MswHelper {
Events,
any
>,
server: SetupServerApi,
server: SetupServer,
params: PathParamsSchema extends z.Schema
? MswSseMockParams<
InferSchemaInput<PathParamsSchema>,
Expand Down Expand Up @@ -280,14 +280,14 @@ export class MswHelper {
boolean,
any
>,
server: SetupServerApi,
server: SetupServer,
params: PathParamsSchema extends undefined
? MockParamsNoPath<InferSchemaInput<ResponseBodySchema>>
: MockParams<InferSchemaInput<PathParamsSchema>, InferSchemaInput<ResponseBodySchema>>,
): void

// Implementation
mockValidResponse(contract: any, server: SetupServerApi, params: any): void {
mockValidResponse(contract: any, server: SetupServer, params: any): void {
if ('isDualMode' in contract && contract.isDualMode) {
const { resolvedPath, method } = this.resolveStreamingPath(contract, params.pathParams)
const sseBody = formatSseResponse(params.events)
Expand Down Expand Up @@ -351,7 +351,7 @@ export class MswHelper {
any,
any
>,
server: SetupServerApi,
server: SetupServer,
params: MswDualModeMockParamsNoPath<
InferSchemaInput<RequestQuerySchema>,
InferSchemaInput<ResponseBodySchema>,
Expand All @@ -373,7 +373,7 @@ export class MswHelper {
Events,
any
>,
server: SetupServerApi,
server: SetupServer,
params: MswSseMockParamsNoPath<InferSchemaInput<RequestQuerySchema>, Events>,
): void

Expand Down Expand Up @@ -401,12 +401,12 @@ export class MswHelper {
boolean,
any
>,
server: SetupServerApi,
server: SetupServer,
params: MockParamsNoPath<InferSchemaInput<ResponseBodySchema>>,
): void

// Implementation
mockValidResponseWithAnyPath(contract: any, server: SetupServerApi, params: any): void {
mockValidResponseWithAnyPath(contract: any, server: SetupServer, params: any): void {
const pathParams = contract.requestPathParamsSchema
? Object.keys((contract.requestPathParamsSchema as ZodObject<any>).shape).reduce(
(acc, value) => {
Expand Down Expand Up @@ -438,7 +438,7 @@ export class MswHelper {
any,
any
>,
server: SetupServerApi,
server: SetupServer,
params: (PathParamsSchema extends z.Schema
? MockWithImplementationParams<any, any, any>
: MockWithImplementationParamsNoPath<any, any, any>) & {
Expand Down Expand Up @@ -476,14 +476,14 @@ export class MswHelper {
boolean,
any
>,
server: SetupServerApi,
server: SetupServer,
params: PathParamsSchema extends undefined
? MockWithImplementationParamsNoPath<any, any, any>
: MockWithImplementationParams<any, any, any>,
): void

// Implementation
mockValidResponseWithImplementation(contract: any, server: SetupServerApi, params: any): void {
mockValidResponseWithImplementation(contract: any, server: SetupServer, params: any): void {
if ('isDualMode' in contract && contract.isDualMode) {
const { resolvedPath, method } = this.resolveStreamingPath(contract, params.pathParams)
const sseBody = formatSseResponse(params.events)
Expand Down Expand Up @@ -539,7 +539,7 @@ export class MswHelper {
any,
any
>,
server: SetupServerApi,
server: SetupServer,
params: PathParamsSchema extends z.Schema
? MswDualModeMockParams<
InferSchemaInput<PathParamsSchema>,
Expand All @@ -555,14 +555,14 @@ export class MswHelper {
contract:
| CommonRouteDefinition<any, PathParamsSchema, any, any, any, any, any, any>
| PayloadRouteDefinition<any, any, PathParamsSchema, any, any, any, any, any, any>,
server: SetupServerApi,
server: SetupServer,
params: PathParamsSchema extends undefined
? MockParamsNoPath<InferSchemaInput<any>>
: MockParams<InferSchemaInput<PathParamsSchema>, InferSchemaInput<any>>,
): void

// Implementation
mockAnyResponse(contract: any, server: SetupServerApi, params: any): void {
mockAnyResponse(contract: any, server: SetupServer, params: any): void {
if ('isDualMode' in contract && contract.isDualMode) {
const { resolvedPath, method } = this.resolveStreamingPath(contract, params.pathParams)
const sseBody = formatSseResponse(params.events)
Expand Down Expand Up @@ -612,7 +612,7 @@ export class MswHelper {
any,
any
>,
server: SetupServerApi,
server: SetupServer,
params: (PathParamsSchema extends z.Schema
? { pathParams: InferSchemaInput<PathParamsSchema> }
: { pathParams?: undefined }) & {
Expand All @@ -638,7 +638,7 @@ export class MswHelper {
Events,
any
>,
server: SetupServerApi,
server: SetupServer,
params?: (PathParamsSchema extends z.Schema
? { pathParams: InferSchemaInput<PathParamsSchema> }
: { pathParams?: undefined }) &
Expand All @@ -649,7 +649,7 @@ export class MswHelper {
): SseEventController<Events>

// Implementation
mockSseStream(contract: any, server: SetupServerApi, params?: any): SseEventController<any> {
mockSseStream(contract: any, server: SetupServer, params?: any): SseEventController<any> {
const pathParams = params?.pathParams
const { resolvedPath, method } = this.resolveStreamingPath(contract, pathParams)
const encoder = new TextEncoder()
Expand Down
Loading