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.

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

New places api support #47085

Open
wants to merge 21 commits into
base: main
Choose a base branch
from
249 −227
Open

New places api support #47085

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
21 commits
Select commit Hold shift click to select a range
04ea3a8
new places api support
rojiphil Aug 7, 2024
6425853
pass fields as property
rojiphil Aug 8, 2024
4836de6
Merge branch 'Expensify:main' into new-places-api-support
rojiphil Aug 11, 2024
4692371
Merge branch 'Expensify:main' into new-places-api-support
rojiphil Sep 19, 2024
43d5dba
update rectangle object for locationbias
rojiphil Sep 21, 2024
67cc635
Merge branch 'Expensify:main' into new-places-api-support
rojiphil Sep 21, 2024
9a75de7
Merge branch 'Expensify:main' into new-places-api-support
rojiphil Sep 27, 2024
0e52dc9
Merge branch 'Expensify:main' into new-places-api-support
rojiphil Sep 29, 2024
ae0ef58
using longText and shortText prettier fix
rojiphil Oct 3, 2024
b396dd8
Merge branch 'Expensify:main' into new-places-api-support
rojiphil Oct 3, 2024
0c07e99
use newer version for the autocomplete library
rojiphil Oct 4, 2024
4379632
updated package-lock
rojiphil Oct 4, 2024
18d79b0
lint fix
rojiphil Oct 4, 2024
8f05d04
ts fix
rojiphil Oct 4, 2024
0ad4459
using useOnyx instead of withOnyx - eslint error fix
rojiphil Oct 4, 2024
2a070f6
Merge branch 'Expensify:main' into new-places-api-support
rojiphil Oct 4, 2024
5b133e8
Merge branch 'Expensify:main' into new-places-api-support
rojiphil Oct 11, 2024
805eb47
Merge branch 'Expensify:main' into new-places-api-support
rojiphil Oct 28, 2024
f9e2ddc
Merge branch 'Expensify:main' into new-places-api-support
rojiphil Nov 20, 2024
4b60132
Merge branch 'Expensify:main' into new-places-api-support
rojiphil Dec 9, 2024
56dac53
Merge branch 'Expensify:main' into new-places-api-support
rojiphil Dec 24, 2024
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
Prev Previous commit
Next Next commit
using longText and shortText prettier fix
  • Loading branch information
@rojiphil
rojiphil committed Oct 3, 2024
commit ae0ef58a311784daa3ad70e517eef4fecc414752
24 changes: 12 additions & 12 deletions src/components/AddressSearch/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 105,7 @@
);
const shouldShowCurrentLocationButton = canUseCurrentLocation && searchValue.trim().length === 0 && isFocused;
const saveLocationDetails = (autocompleteData: GooglePlaceData, details: GooglePlaceDetail | null) => {
const addressComponents = details?.addressComponents;

Check failure on line 108 in src/components/AddressSearch/index.tsx

View workflow job for this annotation

GitHub Actions / Changed files ESLint check 

Unsafe assignment of an `any` value

Check failure on line 108 in src/components/AddressSearch/index.tsx

View workflow job for this annotation

GitHub Actions / typecheck 

Property 'addressComponents' does not exist on type 'GooglePlaceDetail'. Did you mean 'address_components'?
if (!addressComponents) {
// When there are details, but no address_components, this indicates that some predefined options have been passed
// to this component which don't match the usual properties coming from auto-complete. In that case, only a limited
Expand All @@ -113,8 113,8 @@
if (details) {
onPress?.({
address: autocompleteData.description ?? '',
lat: details.location?.latitude ?? details.geometry.location?.lat ?? 0,

Check failure on line 116 in src/components/AddressSearch/index.tsx

View workflow job for this annotation

GitHub Actions / Changed files ESLint check 

Unsafe assignment of an `any` value

Check failure on line 116 in src/components/AddressSearch/index.tsx

View workflow job for this annotation

GitHub Actions / Changed files ESLint check 

Unsafe member access .latitude on an `error` typed value

Check failure on line 116 in src/components/AddressSearch/index.tsx

View workflow job for this annotation

GitHub Actions / typecheck 

Property 'location' does not exist on type 'GooglePlaceDetail'.
lng: details.location?.longitude ?? details.geometry.location?.lng ?? 0,

Check failure on line 117 in src/components/AddressSearch/index.tsx

View workflow job for this annotation

GitHub Actions / Changed files ESLint check 

Unsafe assignment of an `any` value

Check failure on line 117 in src/components/AddressSearch/index.tsx

View workflow job for this annotation

GitHub Actions / Changed files ESLint check 

Unsafe member access .longitude on an `error` typed value

Check failure on line 117 in src/components/AddressSearch/index.tsx

View workflow job for this annotation

GitHub Actions / typecheck 

Property 'location' does not exist on type 'GooglePlaceDetail'.
name: autocompleteData?.structured_formatting?.main_text ?? details?.name ?? '',
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

details.name isn't the same as it was in the old API, the format here is places/<id> so not really good to use here. The next closest thing is details?. shortFormattedAddress

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In this context, the details.name is not used from old API. Instead, it indicates a predefined option i.e. saved places in our app. So, I think we need to keep
details.name

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't understand what you mean, can you show me? The way I understand this code, the value in autocompleteData.structured_formatting.main_text in the new API is most similar to details.name from the old api. However, details.name is no longer a good fallback, as in the new API, it does not contain a short version of the address, but something else entirely

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't understand what you mean, can you show me?

Please find the test video that demonstrates the use of predefined places. This is the reason why I think we need to keep details.name.

47085-predefined-places.mp4

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hm ok. Can you take a look at how this is utilized when changing your address on the profile settings page as well? I wonder if we need different values in the two places.

});
}
Expand All @@ -133,29 133,29 @@
administrative_area_level_1: state,
administrative_area_level_2: stateFallback,
country: countryPrimary,
} = GooglePlacesUtils.getAddressComponents(addressComponents, {

Check failure on line 136 in src/components/AddressSearch/index.tsx

View workflow job for this annotation

GitHub Actions / Changed files ESLint check 

Unsafe argument of type `any` assigned to a parameter of type `AddressComponent[]`
// eslint-disable-next-line @typescript-eslint/naming-convention
street_number: 'long_name',
route: 'long_name',
subpremise: 'long_name',
locality: 'long_name',
sublocality: 'long_name',
street_number: 'longText',
route: 'longText',
subpremise: 'longText',
locality: 'longText',
sublocality: 'longText',
// eslint-disable-next-line @typescript-eslint/naming-convention
postal_town: 'long_name',
postal_town: 'longText',
// eslint-disable-next-line @typescript-eslint/naming-convention
postal_code: 'long_name',
postal_code: 'longText',
// eslint-disable-next-line @typescript-eslint/naming-convention
administrative_area_level_1: 'short_name',
administrative_area_level_1: 'shortText',
// eslint-disable-next-line @typescript-eslint/naming-convention
administrative_area_level_2: 'long_name',
country: 'short_name',
administrative_area_level_2: 'longText',
country: 'shortText',
});

// The state's iso code (short_name) is needed for the StatePicker component but we also
// need the state's full name (long_name) when we render the state in a TextInput.
// need the state's full name (longText) when we render the state in a TextInput.
const {administrative_area_level_1: longStateName} = GooglePlacesUtils.getAddressComponents(addressComponents, {

Check failure on line 156 in src/components/AddressSearch/index.tsx

View workflow job for this annotation

GitHub Actions / Changed files ESLint check 

Unsafe argument of type `any` assigned to a parameter of type `AddressComponent[]`
// eslint-disable-next-line @typescript-eslint/naming-convention
administrative_area_level_1: 'long_name',
administrative_area_level_1: 'longText',
});

// Make sure that the order of keys remains such that the country is always set above the state.
Expand Down Expand Up @@ -186,9 186,9 @@
city: locality || postalTown || sublocality || cityAutocompleteFallback,
zipCode,

lat: details.location?.latitude ?? details.geometry.location?.lat ?? 0,

Check failure on line 189 in src/components/AddressSearch/index.tsx

View workflow job for this annotation

GitHub Actions / Changed files ESLint check 

Unsafe assignment of an `any` value

Check failure on line 189 in src/components/AddressSearch/index.tsx

View workflow job for this annotation

GitHub Actions / Changed files ESLint check 

Unsafe member access .latitude on an `error` typed value

Check failure on line 189 in src/components/AddressSearch/index.tsx

View workflow job for this annotation

GitHub Actions / typecheck 

Property 'location' does not exist on type 'GooglePlaceDetail'.
lng: details.location?.longitude ?? details.geometry.location?.lng ?? 0,

Check failure on line 190 in src/components/AddressSearch/index.tsx

View workflow job for this annotation

GitHub Actions / Changed files ESLint check 

Unsafe assignment of an `any` value

Check failure on line 190 in src/components/AddressSearch/index.tsx

View workflow job for this annotation

GitHub Actions / typecheck 

Property 'location' does not exist on type 'GooglePlaceDetail'.
address: autocompleteData.description || details.formattedAddress || '',

Check failure on line 191 in src/components/AddressSearch/index.tsx

View workflow job for this annotation

GitHub Actions / typecheck 

Property 'formattedAddress' does not exist on type 'GooglePlaceDetail'. Did you mean 'formatted_address'?
};

// If the address is not in the US, use the full length state name since we're displaying the address's
Expand All @@ -210,9 210,9 @@

// Some edge-case addresses may lack both street_number and route in the API response, resulting in an empty "values.street"
// We are setting up a fallback to ensure "values.street" is populated with a relevant value
if (!values.street && details.adrFormatAddress) {

Check failure on line 213 in src/components/AddressSearch/index.tsx

View workflow job for this annotation

GitHub Actions / typecheck 

Property 'adrFormatAddress' does not exist on type 'GooglePlaceDetail'.
const streetAddressRegex = /<span class="street-address">([^<]*)<\/span>/;
const adrAddress = details.adrFormatAddress.match(streetAddressRegex);

Check failure on line 215 in src/components/AddressSearch/index.tsx

View workflow job for this annotation

GitHub Actions / typecheck 

Property 'adrFormatAddress' does not exist on type 'GooglePlaceDetail'.
const streetAddressFallback = adrAddress ? adrAddress?.[1] : null;
if (streetAddressFallback) {
values.street = streetAddressFallback;
Expand Down Expand Up @@ -476,7 476,7 @@
}
placeholder=""
listViewDisplayed
fields={CONST.GOOGLE_PLACES_API.FIELDS_MASK}

Check failure on line 479 in src/components/AddressSearch/index.tsx

View workflow job for this annotation

GitHub Actions / typecheck 

Type '{ children: Element; disableScroll: true; fetchDetails: true; suppressDefaultStyles: true; enablePoweredByContainer: false; predefinedPlaces: PredefinedPlace[]; ... 18 more ...; isNewPlacesAPI: true; }' is not assignable to type 'IntrinsicAttributes & GooglePlacesAutocompleteProps & RefAttributes<GooglePlacesAutocompleteRef>'.
isNewPlacesAPI
>
<LocationErrorMessage
Expand Down
14 changes: 7 additions & 7 deletions src/components/AddressSearch/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,14 30,14 @@ type PredefinedPlace = Place & {
type LocationBias = {
rectangle: {
low: {
latitude: number,
longitude: number,
},
latitude: number;
longitude: number;
};
high: {
latitude: number,
longitude: number,
}
}
latitude: number;
longitude: number;
};
};
};

type AddressSearchProps = {
Expand Down
6 changes: 3 additions & 3 deletions src/hooks/useLocationBias.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 48,7 @@ export default function useLocationBias(allWaypoints: WaypointCollection, userLo
const north = maxLat < 90 ? maxLat : 90;
const east = maxLng < 180 ? maxLng : 180;

if(latitudes.length === 0 || longitudes.length === 0) {
if (latitudes.length === 0 || longitudes.length === 0) {
return undefined;
}
const rectangularBoundary = {
Expand All @@ -60,8 60,8 @@ export default function useLocationBias(allWaypoints: WaypointCollection, userLo
high: {
latitude: north,
longitude: east,
}
}
},
},
};
return rectangularBoundary;
}, [userLocation, allWaypoints]);
Expand Down
10 changes: 4 additions & 6 deletions src/libs/GooglePlacesUtils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 1,6 @@
type AddressComponent = {
// eslint-disable-next-line @typescript-eslint/naming-convention
long_name: string;
// eslint-disable-next-line @typescript-eslint/naming-convention
short_name: string;
longText: string;
shortText: string;
types: string[];
};
type FieldsToExtract = Record<string, Exclude<keyof AddressComponent, 'types'>>;
Expand All @@ -11,8 9,8 @@ type FieldsToExtract = Record<string, Exclude<keyof AddressComponent, 'types'>>;
* Finds an address component by type, and returns the value associated to key. Each address component object
* inside the addressComponents array has the following structure:
* [{
* long_name: "New York",
* short_name: "New York",
* longText: "New York",
* shortText: "New York",
* types: [ "locality", "political" ]
* }]
*/
Expand Down
232 changes: 116 additions & 116 deletions tests/perf-test/GooglePlacesUtils.perf-test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,142 4,142 @@ import * as GooglePlacesUtils from '@src/libs/GooglePlacesUtils';

const addressComponents: GooglePlacesUtils.AddressComponent[] = [
{
long_name: 'Bushwick',
short_name: 'Bushwick',
longText: 'Bushwick',
shortText: 'Bushwick',
types: ['neighborhood', 'political'],
},
{
long_name: 'Brooklyn',
short_name: 'Brooklyn',
longText: 'Brooklyn',
shortText: 'Brooklyn',
types: ['sublocality_level_1', 'sublocality', 'political'],
},
{
long_name: 'New York',
short_name: 'NY',
longText: 'New York',
shortText: 'NY',
types: ['administrative_area_level_1', 'political'],
},
{
long_name: 'United States',
short_name: 'US',
longText: 'United States',
shortText: 'US',
types: ['country', 'political'],
},
{
long_name: '11206',
short_name: '11206',
longText: '11206',
shortText: '11206',
types: ['postal_code'],
},
{
long_name: 'United Kingdom',
short_name: 'UK',
longText: 'United Kingdom',
shortText: 'UK',
types: ['country', 'political'],
},
];

const bigObjectToFind: GooglePlacesUtils.FieldsToExtract = {
sublocality: 'long_name',
administrative_area_level_1: 'short_name',
postal_code: 'long_name',
'doesnt-exist': 'long_name',
s1ublocality: 'long_name',
a1dministrative_area_level_1: 'short_name',
p1ostal_code: 'long_name',
'1doesnt-exist': 'long_name',
s2ublocality: 'long_name',
a2dministrative_area_level_1: 'short_name',
p2ostal_code: 'long_name',
'2doesnt-exist': 'long_name',
s3ublocality: 'long_name',
a3dministrative_area_level_1: 'short_name',
p3ostal_code: 'long_name',
'3doesnt-exist': 'long_name',
s4ublocality: 'long_name',
a4dministrative_area_level_1: 'short_name',
p4ostal_code: 'long_name',
'4doesnt-exist': 'long_name',
s5ublocality: 'long_name',
a5dministrative_area_level_1: 'short_name',
p5ostal_code: 'long_name',
'5doesnt-exist': 'long_name',
s6ublocality: 'long_name',
a6dministrative_area_level_1: 'short_name',
p6ostal_code: 'long_name',
'6doesnt-exist': 'long_name',
s7ublocality: 'long_name',
a7dministrative_area_level_1: 'short_name',
p7ostal_code: 'long_name',
'7doesnt-exist': 'long_name',
s8ublocality: 'long_name',
a8dministrative_area_level_1: 'short_name',
p8ostal_code: 'long_name',
'8doesnt-exist': 'long_name',
s9ublocality: 'long_name',
a9dministrative_area_level_1: 'short_name',
p9ostal_code: 'long_name',
'9doesnt-exist': 'long_name',
s10ublocality: 'long_name',
a10dministrative_area_level_1: 'short_name',
p10ostal_code: 'long_name',
'10doesnt-exist': 'long_name',
s11ublocality: 'long_name',
a11dministrative_area_level_1: 'short_name',
p11ostal_code: 'long_name',
'11doesnt-exist': 'long_name',
s12ublocality: 'long_name',
a12dministrative_area_level_1: 'short_name',
p12ostal_code: 'long_name',
'12doesnt-exist': 'long_name',
s13ublocality: 'long_name',
a13dministrative_area_level_1: 'short_name',
p13ostal_code: 'long_name',
'13doesnt-exist': 'long_name',
s14ublocality: 'long_name',
a14dministrative_area_level_1: 'short_name',
p14ostal_code: 'long_name',
'14doesnt-exist': 'long_name',
s15ublocality: 'long_name',
a15dministrative_area_level_1: 'short_name',
p15ostal_code: 'long_name',
'15doesnt-exist': 'long_name',
s16ublocality: 'long_name',
a16dministrative_area_level_1: 'short_name',
p16ostal_code: 'long_name',
'16doesnt-exist': 'long_name',
s17ublocality: 'long_name',
a17dministrative_area_level_1: 'short_name',
p17ostal_code: 'long_name',
'17doesnt-exist': 'long_name',
s18ublocality: 'long_name',
a18dministrative_area_level_1: 'short_name',
p18ostal_code: 'long_name',
'18doesnt-exist': 'long_name',
s19ublocality: 'long_name',
a19dministrative_area_level_1: 'short_name',
p19ostal_code: 'long_name',
'19doesnt-exist': 'long_name',
s20ublocality: 'long_name',
a20dministrative_area_level_1: 'short_name',
p20ostal_code: 'long_name',
'20doesnt-exist': 'long_name',
s21ublocality: 'long_name',
a21dministrative_area_level_1: 'short_name',
p21ostal_code: 'long_name',
'21doesnt-exist': 'long_name',
s22ublocality: 'long_name',
a22dministrative_area_level_1: 'short_name',
p22ostal_code: 'long_name',
'22doesnt-exist': 'long_name',
s23ublocality: 'long_name',
a23dministrative_area_level_1: 'short_name',
p23ostal_code: 'long_name',
'23doesnt-exist': 'long_name',
s24ublocality: 'long_name',
a24dministrative_area_level_1: 'short_name',
p24ostal_code: 'long_name',
'24doesnt-exist': 'long_name',
s25ublocality: 'long_name',
a25dministrative_area_level_1: 'short_name',
p25ostal_code: 'long_name',
'25doesnt-exist': 'long_name',
sublocality: 'longText',
administrative_area_level_1: 'shortText',
postal_code: 'longText',
'doesnt-exist': 'longText',
s1ublocality: 'longText',
a1dministrative_area_level_1: 'shortText',
p1ostal_code: 'longText',
'1doesnt-exist': 'longText',
s2ublocality: 'longText',
a2dministrative_area_level_1: 'shortText',
p2ostal_code: 'longText',
'2doesnt-exist': 'longText',
s3ublocality: 'longText',
a3dministrative_area_level_1: 'shortText',
p3ostal_code: 'longText',
'3doesnt-exist': 'longText',
s4ublocality: 'longText',
a4dministrative_area_level_1: 'shortText',
p4ostal_code: 'longText',
'4doesnt-exist': 'longText',
s5ublocality: 'longText',
a5dministrative_area_level_1: 'shortText',
p5ostal_code: 'longText',
'5doesnt-exist': 'longText',
s6ublocality: 'longText',
a6dministrative_area_level_1: 'shortText',
p6ostal_code: 'longText',
'6doesnt-exist': 'longText',
s7ublocality: 'longText',
a7dministrative_area_level_1: 'shortText',
p7ostal_code: 'longText',
'7doesnt-exist': 'longText',
s8ublocality: 'longText',
a8dministrative_area_level_1: 'shortText',
p8ostal_code: 'longText',
'8doesnt-exist': 'longText',
s9ublocality: 'longText',
a9dministrative_area_level_1: 'shortText',
p9ostal_code: 'longText',
'9doesnt-exist': 'longText',
s10ublocality: 'longText',
a10dministrative_area_level_1: 'shortText',
p10ostal_code: 'longText',
'10doesnt-exist': 'longText',
s11ublocality: 'longText',
a11dministrative_area_level_1: 'shortText',
p11ostal_code: 'longText',
'11doesnt-exist': 'longText',
s12ublocality: 'longText',
a12dministrative_area_level_1: 'shortText',
p12ostal_code: 'longText',
'12doesnt-exist': 'longText',
s13ublocality: 'longText',
a13dministrative_area_level_1: 'shortText',
p13ostal_code: 'longText',
'13doesnt-exist': 'longText',
s14ublocality: 'longText',
a14dministrative_area_level_1: 'shortText',
p14ostal_code: 'longText',
'14doesnt-exist': 'longText',
s15ublocality: 'longText',
a15dministrative_area_level_1: 'shortText',
p15ostal_code: 'longText',
'15doesnt-exist': 'longText',
s16ublocality: 'longText',
a16dministrative_area_level_1: 'shortText',
p16ostal_code: 'longText',
'16doesnt-exist': 'longText',
s17ublocality: 'longText',
a17dministrative_area_level_1: 'shortText',
p17ostal_code: 'longText',
'17doesnt-exist': 'longText',
s18ublocality: 'longText',
a18dministrative_area_level_1: 'shortText',
p18ostal_code: 'longText',
'18doesnt-exist': 'longText',
s19ublocality: 'longText',
a19dministrative_area_level_1: 'shortText',
p19ostal_code: 'longText',
'19doesnt-exist': 'longText',
s20ublocality: 'longText',
a20dministrative_area_level_1: 'shortText',
p20ostal_code: 'longText',
'20doesnt-exist': 'longText',
s21ublocality: 'longText',
a21dministrative_area_level_1: 'shortText',
p21ostal_code: 'longText',
'21doesnt-exist': 'longText',
s22ublocality: 'longText',
a22dministrative_area_level_1: 'shortText',
p22ostal_code: 'longText',
'22doesnt-exist': 'longText',
s23ublocality: 'longText',
a23dministrative_area_level_1: 'shortText',
p23ostal_code: 'longText',
'23doesnt-exist': 'longText',
s24ublocality: 'longText',
a24dministrative_area_level_1: 'shortText',
p24ostal_code: 'longText',
'24doesnt-exist': 'longText',
s25ublocality: 'longText',
a25dministrative_area_level_1: 'shortText',
p25ostal_code: 'longText',
'25doesnt-exist': 'longText',
};

/**
Expand Down
Loading
Loading