fix: throws on unsupported option path

[is2ei]

Refs: #1011

undici.request accepts path option but the type definition omits path.
POC: https://github.com/is2ei/POC-nodejs-undici-1011
code:

undici/index.js

Lines 63 to 75 in d7eac3e

	if (opts && opts.path != null) {
	if (typeof opts.path !== 'string') {
	throw new InvalidArgumentError('invalid opts.path')
	}
	url = new URL(opts.path, util.parseOrigin(url))
	} else {
	if (!opts) {
	opts = typeof url === 'object' ? url : {}
	}
	url = util.parseURL(url)
	}

[ronag]

path is already part of these through extending parent structure. What is the problem you are trying to solve?

[is2ei]

@ronag
Thanks for your comment. I basically try to solve 2 problems related to #1011.

1. wrong type definition
2. document for undici.request lacks some information.

When using TypeScript, you can not pass the path option to undici.request because the type definition omits the path option. But when using JavaScript, you can pass the path option to undici.request and it works. So I fixed the type definition.

undici/index.js

Lines 63 to 68 in d7eac3e

	if (opts && opts.path != null) {
	if (typeof opts.path !== 'string') {
	throw new InvalidArgumentError('invalid opts.path')
	}
	url = new URL(opts.path, util.parseOrigin(url))

Also, I found method option is documented even though DispatchOptions already has it. I guess the difference is method is mandatory in DispatchOptions but optional in undici.request option. path option has the same situation so I documented it.

undici/types/api.d.ts

Lines 13 to 17 in d7eac3e

	/** Performs an HTTP request. */
	declare function request(
	url: string | URL | UrlObject,
	options?: { dispatcher?: Dispatcher } & Omit<Dispatcher.RequestOptions, 'origin' | 'path' | 'method'> & Partial<Pick<Dispatcher.RequestOptions, 'method'>>,
	): Promise<Dispatcher.ResponseData>;

[ronag]

When using TypeScript, you can not pass the path option to undici.request because the type definition omits the path option. But when using JavaScript, you can pass the path option to undici.request and it works. So I fixed the type definition.

I think the typescript version is correct and reflects intended/recommended usage.

Whether or not the javascript version should allow it is up for discussion. Maybe we should throw?

[is2ei]

@ronag

Maybe we should throw?

Ok. I'll try.

[codecov-commenter]

Codecov Report

Merging #1282 (46451d9) into main (d7eac3e) will decrease coverage by 0.00%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##             main    #1282      +/-   ##
==========================================
- Coverage   94.11%   94.11%   -0.01%     
==========================================
  Files          44       44              
  Lines        4098     4096       -2     
==========================================
- Hits         3857     3855       -2     
  Misses        241      241              

Impacted Files	Coverage Δ
index.js	100.00% <100.00%> (ø)

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d7eac3e...46451d9. Read the comment docs.

[is2ei]

@ronag
I changed the code. Could you review it?
I basically agree with your opinion, but I'd be worried if it would be a breaking change.

[hebertcisco]

I saw that your pull request has conflicts, have you tried to resolve these conflicts?

[hebertcisco]

I saw that your pull request has conflicts, have you tried to resolve these conflicts?

[hebertcisco]

@ronag What do you think of this pull request and the changes made to it? Would it be mergeable and adequate?

[is2ei]

@hebertcisco
I fixed the conflict, but it looks path option is actually used now.
Do we still need this change?

[mcollina]

I think this can be closed, thanks!