Skip to content
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.

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

Implementation of URLSearchParams Methods #50043

Closed
wants to merge 9 commits into from
Closed
Show file tree
Hide file tree
Changes from 5 commits
Commits
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
2 changes: 1 addition & 1 deletion packages/react-native/Libraries/Blob/URL.js
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ export class URL {

get searchParams(): URLSearchParams {
if (this._searchParamsInstance == null) {
this._searchParamsInstance = new URLSearchParams();
this._searchParamsInstance = new URLSearchParams(this.search);
}
return this._searchParamsInstance;
}
Expand Down
129 changes: 98 additions & 31 deletions packages/react-native/Libraries/Blob/URLSearchParams.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,60 +11,127 @@
// Small subset from whatwg-url: https://github.com/jsdom/whatwg-url/tree/master/src
// The reference code bloat comes from Unicode issues with URLs, so those won't work here.
export class URLSearchParams {
_searchParams: Array<[string, string]> = [];
_searchParams: Map<string, string[]> = new Map();

constructor(params?: Record<string, string>) {
if (typeof params === 'object') {
Object.keys(params).forEach(key => this.append(key, params[key]));
constructor(params?: Record<string, string> | string | [string, string][]) {
// URLSearchParams("key1=value1&key2=value2");
if (typeof params === 'string') {
params
.replace(/^\?/, '')
.split('&')
.forEach(pair => {
if (!pair) return;

Check warning on line 23 in packages/react-native/Libraries/Blob/URLSearchParams.js

View workflow job for this annotation

GitHub Actions / test_js (22)

Expected { after 'if' condition

Check warning on line 23 in packages/react-native/Libraries/Blob/URLSearchParams.js

View workflow job for this annotation

GitHub Actions / test_js (20)

Expected { after 'if' condition

Check warning on line 23 in packages/react-native/Libraries/Blob/URLSearchParams.js

View workflow job for this annotation

GitHub Actions / test_js (18)

Expected { after 'if' condition
const [key, value] = pair.split('=').map(decodeURIComponent);
this.append(key, value);
});
}

//URLSearchParams([["key1", "value1"], ["key2", "value2"]]);
else if (Array.isArray(params)) {
params.forEach(([key, value]) => this.append(key, value));
}
//URLSearchParams({ key1: "value1", key2: "value2" });
else if (typeof params === 'object') {
Object.entries(params).forEach(([key, value]) => this.append(key, value));
}
}

append(key: string, value: string): void {
this._searchParams.push([key, value]);
if (!this._searchParams.has(key)) {
this._searchParams.set(key, [value]); // Initialize with an array if key is missing
} else {
this._searchParams.get(key)?.push(value); // Else push the value to the array
}
}

delete(name: string): void {
this._searchParams.delete(name);
}

get(name: string): string | null {
const values = this._searchParams.get(name);
return values ? values[0] : null;
}

getAll(name: string): string[] {
return this._searchParams.get(name) ?? [];
}

delete(name: string): empty {
throw new Error('URLSearchParams.delete is not implemented');
has(name: string): boolean {
return this._searchParams.has(name);
}

get(name: string): empty {
throw new Error('URLSearchParams.get is not implemented');
set(name: string, value: string): void {
this._searchParams.set(name, [value]);
}

getAll(name: string): empty {
throw new Error('URLSearchParams.getAll is not implemented');
keys(name: string): Iterator<string> {
return this._searchParams.keys();
}

has(name: string): empty {
throw new Error('URLSearchParams.has is not implemented');
values(name: string): Iterator<string> {
function* generateValues(params: Map<string, string[]>): Iterator<string> {
for (const valueArray of params.values()) {
for (const value of valueArray) {
yield value;
}
}
}
return generateValues(this._searchParams);
}

entries(name: string): Iterator<[string, string]> {
function* generateEntries(
params: Map<string, string[]>,
): Iterator<[string, string]> {
for (const [key, values] of params) {
for (const value of values) {
yield [key, value];
}
}
}

return generateEntries(this._searchParams);
}

set(name: string, value: string): empty {
throw new Error('URLSearchParams.set is not implemented');
forEach(
callback: (value: string, key: string, searchParams: this) => void,
): void {
for (const [key, values] of this._searchParams) {
for (const value of values) {
callback(value, key, this);
}
}
}

sort(): empty {
throw new Error('URLSearchParams.sort is not implemented');
sort(): void {
this._searchParams = new Map(
[...this._searchParams.entries()].sort(([a], [b]) => a.localeCompare(b)),
);
}

// $FlowFixMe[unsupported-syntax]
[Symbol.iterator](): Iterator<[string, string]> {
return this._searchParams[Symbol.iterator]();
const entries: [string, string][] = [];

for (const [key, values] of this._searchParams) {
for (const value of values) {
entries.push([key, value]);
}
}

return entries[Symbol.iterator]();
}

toString(): string {
if (this._searchParams.length === 0) {
return '';
}
const last = this._searchParams.length - 1;
return this._searchParams.reduce((acc, curr, index) => {
return (
acc +
encodeURIComponent(curr[0]) +
'=' +
encodeURIComponent(curr[1]) +
(index === last ? '' : '&')
);
}, '');
return Array.from(this._searchParams.entries())
.map(([key, values]) =>
values
.map(
value => `${encodeURIComponent(key)}=${encodeURIComponent(value)}`,
)
.join('&'),
)
.join('&');
}
}
17 changes: 10 additions & 7 deletions packages/react-native/Libraries/Blob/URLSearchParams.js.flow
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,17 @@

declare export class URLSearchParams {
_searchParams: Array<[string, string]>;
constructor(params?: Record<string, string>): void;
constructor(params?: Record<string, string> |string|Array<[string, string]> ): void;
append(key: string, value: string): void;
delete(name: string): empty;
get(name: string): empty;
getAll(name: string): empty;
has(name: string): empty;
set(name: string, value: string): empty;
sort(): empty;
delete(name: string): void;
get(name: string): string;
getAll(name: string): Array<string>;
has(name: string): boolean;
set(name: string, value: string): void;
sort(): void;
@@iterator(): Iterator<[string, string]>;
toString(): string;
keys(): Iterator<string>;
values(): Iterator<string>;
entries(): Iterator<[string, string]>;
}
69 changes: 69 additions & 0 deletions packages/react-native/Libraries/Blob/__tests__/URL-test.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@

const URL = require('../URL').URL;

const URLSearchParams = require('../URL').URLSearchParams;

describe('URL', function () {
it('should pass Mozilla Dev Network examples', () => {
const a = new URL('/', 'https://developer.mozilla.org');
Expand Down Expand Up @@ -52,5 +54,72 @@ describe('URL', function () {
expect(url.pathname).toBe('/docs/path');
expect(url.port).toBe('8080');
expect(url.search).toBe('?query=testQuery&key=value');

// Test searchParams
const searchParams = url.searchParams;
expect(searchParams.get('query')).toBe('testQuery');
expect(searchParams.get('key')).toBe('value');

const paramsFromString = new URLSearchParams(
'?param1=value1&param2=value2',
);
expect(paramsFromString.get('param1')).toBe('value1');
expect(paramsFromString.get('param2')).toBe('value2');

const paramsFromObject = new URLSearchParams({
user: 'john',
age: '30',
active: 'true',
});

expect(paramsFromObject.get('user')).toBe('john');
expect(paramsFromObject.get('age')).toBe('30');
expect(paramsFromObject.get('active')).toBe('true');

const valuesArray = Array.from(paramsFromObject.values());
expect(valuesArray).toEqual(['john', '30', 'true']);
const entriesArray = Array.from(paramsFromObject.entries());
expect(entriesArray).toEqual([
['user', 'john'],
['age', '30'],
['active', 'true'],
]);

// URLSearchParams: Empty
const emptyParams = new URLSearchParams('');
expect([...emptyParams.entries()]).toEqual([]);

// URLSearchParams: Array (for multiple values of the same key)
const paramsFromArray = new URLSearchParams([
['key1', 'value1'],
['key1', 'value2'],
['key2', 'value3'],
]);
expect(paramsFromArray.getAll('key1')).toEqual(['value1', 'value2']);
expect(paramsFromArray.get('key2')).toBe('value3');

// Manipulating existing search params in the URL
const urlParams = url.searchParams;
expect(urlParams.get('query')).toBe('testQuery');
expect(urlParams.get('key')).toBe('value');

// Adding a new param
urlParams.append('newKey', 'newValue');
expect(urlParams.get('newKey')).toBe('newValue');

// Deleting a param
urlParams.delete('key');
expect(urlParams.get('key')).toBeNull();

// Checking if a param exists
expect(urlParams.has('query')).toBe(true);
expect(urlParams.has('key')).toBe(false);

// Sorting URLSearchParams
const unsortedParams = new URLSearchParams(
'?z=last&b=second&c=third&a=first',
);
unsortedParams.sort();
expect(unsortedParams.toString()).toBe('a=first&b=second&c=third&z=last');
});
});
Original file line number Diff line number Diff line change
Expand Up @@ -1303,16 +1303,21 @@ declare export class URL {

exports[`public API should not change unintentionally Libraries/Blob/URLSearchParams.js.flow 1`] = `
"declare export class URLSearchParams {
constructor(params?: Record<string, string>): void;
constructor(
params?: Record<string, string> | string | Array<[string, string]>
): void;
append(key: string, value: string): void;
delete(name: string): empty;
get(name: string): empty;
getAll(name: string): empty;
has(name: string): empty;
set(name: string, value: string): empty;
sort(): empty;
delete(name: string): void;
get(name: string): string;
getAll(name: string): Array<string>;
has(name: string): boolean;
set(name: string, value: string): void;
sort(): void;
@@iterator(): Iterator<[string, string]>;
toString(): string;
keys(): Iterator<string>;
values(): Iterator<string>;
entries(): Iterator<[string, string]>;
}
"
`;
Expand Down
1 change: 1 addition & 0 deletions packages/rn-tester/js/examples/Urls/UrlExample.js
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ function URLComponent(props: Props) {
<RNTesterText testID="URL-pathname">{`pathname: ${parsedUrl.pathname}`}</RNTesterText>
<RNTesterText testID="URL-port">{`port: ${parsedUrl.port}`}</RNTesterText>
<RNTesterText testID="URL-search">{`search: ${parsedUrl.search}`}</RNTesterText>
<RNTesterText testID="URL-search-params">{`searchParams: ${parsedUrl.searchParams.toString()}`}</RNTesterText>
</View>
);
}
Expand Down
Loading