fix(ts): ReadonlyURLSearchParams should extend URLSearchParams

[balazsorban44]

What?

Let the developer check the instance of ReadonlyURLSearchParams to match against URLSearchParams

Why?

useSearchParams()'s return type is ReadonlyURLSearchParams which implements all the methods of URLSearchParams, therefore its type should be extended from URLSearchParams as well. Deprecated methods are also implemented to throw an error, so no runtime behavior is being changed

How?

Mark the unavailable methods as @deprecated which will visually mark them in IDEs:

This is similar how ReadonlyHeaders extends Headers, added in: #49075

Slack thread

Closes NEXT-2305

[ijjk]

Tests Passed

[ijjk]

Stats from current PR

Default Build

General

	vercel/next.js canary	vercel/next.js fix/readonly-extends-urlsearchparams	Change
buildDuration	11.7s	11.7s	N/A
buildDurationCached	6s	4.9s	N/A
nodeModulesSize	200 MB	200 MB	N/A
nextStartRea..uration (ms)	426ms	428ms	N/A

Client Bundles (main, webpack)

	vercel/next.js canary	vercel/next.js fix/readonly-extends-urlsearchparams	Change
3f784ff6-HASH.js gzip	53.4 kB	53.4 kB	✓
423.HASH.js gzip	185 B	181 B	N/A
68-HASH.js gzip	29.9 kB	29.8 kB	N/A
framework-HASH.js gzip	45.2 kB	45.2 kB	✓
main-app-HASH.js gzip	238 B	240 B	N/A
main-HASH.js gzip	31.8 kB	31.8 kB	N/A
webpack-HASH.js gzip	1.7 kB	1.7 kB	✓
Overall change	100 kB	100 kB	✓

Legacy Client Bundles (polyfills)

	vercel/next.js canary	vercel/next.js fix/readonly-extends-urlsearchparams	Change
polyfills-HASH.js gzip	31 kB	31 kB	✓
Overall change	31 kB	31 kB	✓

Client Pages

	vercel/next.js canary	vercel/next.js fix/readonly-extends-urlsearchparams	Change
_app-HASH.js gzip	194 B	195 B	N/A
_error-HASH.js gzip	182 B	181 B	N/A
amp-HASH.js gzip	502 B	502 B	✓
css-HASH.js gzip	320 B	322 B	N/A
dynamic-HASH.js gzip	2.5 kB	2.5 kB	N/A
edge-ssr-HASH.js gzip	255 B	256 B	N/A
head-HASH.js gzip	350 B	349 B	N/A
hooks-HASH.js gzip	368 B	369 B	N/A
image-HASH.js gzip	4.18 kB	4.18 kB	N/A
index-HASH.js gzip	257 B	256 B	N/A
link-HASH.js gzip	2.61 kB	2.61 kB	N/A
routerDirect..HASH.js gzip	310 B	311 B	N/A
script-HASH.js gzip	384 B	383 B	N/A
withRouter-HASH.js gzip	306 B	308 B	N/A
1afbb74e6ecf..834.css gzip	106 B	106 B	✓
Overall change	608 B	608 B	✓

Client Build Manifests

	vercel/next.js canary	vercel/next.js fix/readonly-extends-urlsearchparams	Change
_buildManifest.js gzip	484 B	484 B	✓
Overall change	484 B	484 B	✓

Rendered Page Sizes

	vercel/next.js canary	vercel/next.js fix/readonly-extends-urlsearchparams	Change
index.html gzip	529 B	525 B	N/A
link.html gzip	542 B	538 B	N/A
withRouter.html gzip	523 B	521 B	N/A
Overall change	0 B	0 B	✓

Edge SSR bundle Size

	vercel/next.js canary	vercel/next.js fix/readonly-extends-urlsearchparams	Change
edge-ssr.js gzip	94 kB	94 kB	N/A
page.js gzip	150 kB	150 kB	N/A
Overall change	0 B	0 B	✓

Middleware size

	vercel/next.js canary	vercel/next.js fix/readonly-extends-urlsearchparams	Change
middleware-b..fest.js gzip	623 B	622 B	N/A
middleware-r..fest.js gzip	151 B	149 B	N/A
middleware.js gzip	37.6 kB	37.6 kB	N/A
edge-runtime..pack.js gzip	1.92 kB	1.92 kB	✓
Overall change	1.92 kB	1.92 kB	✓

Next Runtimes

	vercel/next.js canary	vercel/next.js fix/readonly-extends-urlsearchparams	Change
app-page-exp...dev.js gzip	170 kB	170 kB	N/A
app-page-exp..prod.js gzip	95.8 kB	95.8 kB	✓
app-page-tur..prod.js gzip	96.4 kB	96.4 kB	✓
app-page-tur..prod.js gzip	91 kB	91 kB	✓
app-page.run...dev.js gzip	142 kB	142 kB	N/A
app-page.run..prod.js gzip	90.3 kB	90.3 kB	✓
app-route-ex...dev.js gzip	22.2 kB	22.2 kB	✓
app-route-ex..prod.js gzip	14.9 kB	14.9 kB	✓
app-route-tu..prod.js gzip	14.9 kB	14.9 kB	✓
app-route-tu..prod.js gzip	14.5 kB	14.5 kB	✓
app-route.ru...dev.js gzip	21.7 kB	21.7 kB	✓
app-route.ru..prod.js gzip	14.5 kB	14.5 kB	✓
pages-api-tu..prod.js gzip	9.43 kB	9.43 kB	✓
pages-api.ru...dev.js gzip	9.7 kB	9.7 kB	✓
pages-api.ru..prod.js gzip	9.43 kB	9.43 kB	✓
pages-turbo...prod.js gzip	22 kB	22 kB	✓
pages.runtim...dev.js gzip	22.7 kB	22.7 kB	✓
pages.runtim..prod.js gzip	22 kB	22 kB	✓
server.runti..prod.js gzip	49.7 kB	49.7 kB	✓
Overall change	621 kB	621 kB	✓

Diff details

Diff for page.js

Diff too large to display

Diff for 68-HASH.js

Diff too large to display

Diff for app-page-exp..ntime.dev.js

Diff too large to display

Diff for app-page.runtime.dev.js

Diff too large to display

Commit: 3ce5b2a

[timneutkens]

This results in more code output right? The internal methods can't be minified whereas the function version can be minified

[balazsorban44]

I believe this should be an acceptable size change.

Generally, we should start using proper Errors everywhere to improve the codebase readability/type safety, etc.

[wyattjoh]

I'm with @balazsorban44 here in that improving the hygiene around error management, creation, is a huge area within the codebase that we could use some more rigid structure around. While we might have some minification losses, cases where we're creating error classes are few and far between.