MockAgent: MockResponseCallbackOptions given to replyOptionsCallback is a totally wrong type

[jonahsnider]

Bug Description

Reproducible By

import * as undici from 'undici';

const mockAgent = new undici.MockAgent();
mockAgent.disableNetConnect();
undici.setGlobalDispatcher(mockAgent);

const mockPool = mockAgent.get('https://example.com');

mockPool
  .intercept({
    path: '/',
  })
  .reply((request) => {
    console.log(request);

    return { statusCode: 200 };
  });

await undici.request('https://example.com/', {
  headers: {
    authorization: 'Bearer 123',
  },
});

Expected Behavior

The types should be correct.

Logs & Screenshots

Actual value:

{
  headers: { authorization: 'Bearer 123' },
  origin: 'https://example.com',
  path: '/',
  method: 'GET'
}

Expected value:

undici/types/mock-interceptor.d.ts

Line 26 in 1822ee6

reply<TData extends object = object>(replyOptionsCallback: MockInterceptor.MockReplyOptionsCallback<TData>): MockScope<TData>;

undici/types/mock-interceptor.d.ts

Lines 85 to 87 in 1822ee6

	export type MockReplyOptionsCallback<TData extends object = object> = (
	opts: MockResponseCallbackOptions
	) => { statusCode: number, data?: TData | Buffer | string, responseOptions?: MockResponseOptions }

undici/types/mock-interceptor.d.ts

Lines 72 to 79 in 1822ee6

	export interface MockResponseCallbackOptions {
	path: string;
	origin: string;
	method: string;
	body?: BodyInit | Dispatcher.DispatchOptions['body'];
	headers: Headers | Record<string, string>;
	maxRedirections: number;
	}

Environment

Darwin 21.5.0 Darwin Kernel Version 21.5.0: Tue Apr 26 21:08:37 PDT 2022; root:xnu-8020.121.3~4/RELEASE_ARM64_T6000 arm64

{
  node: '16.15.1',
  v8: '9.4.146.24-node.21',
  uv: '1.43.0',
  zlib: '1.2.11',
  brotli: '1.0.9',
  ares: '1.18.1',
  modules: '93',
  nghttp2: '1.47.0',
  napi: '8',
  llhttp: '6.0.4',
  openssl: '1.1.1o+quic',
  cldr: '40.0',
  icu: '70.1',
  tz: '2021a3',
  unicode: '14.0',
  ngtcp2: '0.1.0-DEV',
  nghttp3: '0.1.0-DEV'
}

Additional context

[mcollina]

Thanks for reporting! Would you like to send a Pull Request to address this issue? Remember to add unit tests.

[sidwebworks]

@mcollina if you want I can take this issue?

[mcollina]

go for it!

[merojosa]

@mcollina, I'm currently trying to fix this issue. I reproduced the code and, indeed,reply is receiving the following:

{
  headers: { authorization: 'Bearer 123' },
  origin: 'https://example.com',
  path: '/',
  method: 'GET'
}

However, the type for the callback says that it can have these options:

export interface MockResponseCallbackOptions {
  path: string;
  origin: string;
  method: string;
  body?: BodyInit | Dispatcher.DispatchOptions['body'];
  headers: Headers | Record<string, string>;
  maxRedirections: number;
}

maxRedirections and body are not been returned. I already checked the documentation and don't see any particular example or explanation regarding if it's posible to get the body and maxRedirections.

So I want to check if this is a mismatch between the type and what reply can receive in its parameters or there is a bug with MockAgent.

[mcollina]

in this library, the types come after JS, so the js code is the source of truth.

[merojosa]

@mcollina you can close this issue 👍

[metcoder95]

Closed by #2951