Use new location metadata fields #1002
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,25 +1,162 @@ | ||
| import { CUSTOM_ELEMENTS_SCHEMA } from '@angular/core'; | ||
| import { TestBed, ComponentFixture } from '@angular/core/testing'; | ||
| import { ApiService } from '@shared/services/api/api.service'; | ||
| import { MessageService } from '@shared/services/message/message.service'; | ||
| import { EditService } from '@core/services/edit/edit.service'; | ||
| import { ProfileService } from '@shared/services/profile/profile.service'; | ||
| import { PrLocationPipe } from '@shared/pipes/pr-location.pipe'; | ||
| import { LocationPickerComponent } from './location-picker.component'; | ||
|
|
||
| const fakeGoogleMaps = { | ||
| LatLng: class { | ||
| constructor(public input: unknown) {} | ||
| }, | ||
| places: { | ||
| Autocomplete: class { | ||
| setFields(): void {} | ||
| addListener(): void {} | ||
| getPlace(): unknown { | ||
| return null; | ||
| } | ||
| }, | ||
| }, | ||
| }; | ||
|
|
||
| const buildAddressComponents = ( | ||
| overrides: Partial< | ||
| Record<string, { long_name: string; short_name: string }> | ||
| > = {}, | ||
| ): google.maps.GeocoderAddressComponent[] => { | ||
| const defaults: Record<string, { long_name: string; short_name: string }> = { | ||
| street_number: { long_name: '55', short_name: '55' }, | ||
| route: { long_name: 'Rue Plumet', short_name: 'Rue Plumet' }, | ||
| locality: { long_name: 'Paris', short_name: 'Paris' }, | ||
| postal_code: { long_name: '75007', short_name: '75007' }, | ||
| administrative_area_level_1: { | ||
| long_name: 'Ile-de-France', | ||
| short_name: 'IDF', | ||
| }, | ||
| country: { long_name: 'France', short_name: 'FR' }, | ||
| }; | ||
| const merged = { ...defaults, ...overrides }; | ||
| return Object.entries(merged) | ||
| .filter(([, value]) => value !== undefined) | ||
| .map(([type, value]) => ({ | ||
| long_name: value.long_name, | ||
| short_name: value.short_name, | ||
| types: [type], | ||
| })) as google.maps.GeocoderAddressComponent[]; | ||
| }; | ||
|
|
||
| const buildPlace = ( | ||
| overrides: Partial<google.maps.places.PlaceResult> = {}, | ||
| addressOverrides: | ||
| | Parameters<typeof buildAddressComponents>[0] | ||
| | undefined = undefined, | ||
| ): google.maps.places.PlaceResult => | ||
| ({ | ||
| name: "Jean Valjean's House", | ||
| address_components: buildAddressComponents(addressOverrides), | ||
| geometry: { | ||
| location: { | ||
| lat: () => 48.83, | ||
| lng: () => 2.3, | ||
| }, | ||
| }, | ||
| ...overrides, | ||
| }) as unknown as google.maps.places.PlaceResult; | ||
|
cecilia-donnelly marked this conversation as resolved.
|
||
|
|
||
| describe('LocationPickerComponent', () => { | ||
| let fixture: ComponentFixture<LocationPickerComponent>; | ||
| let component: LocationPickerComponent; | ||
| const testWindow = window as unknown as { google?: unknown }; | ||
| let previousGoogle: unknown; | ||
| let hadGoogle = false; | ||
|
|
||
| beforeAll(() => { | ||
| hadGoogle = 'google' in testWindow; | ||
| previousGoogle = testWindow.google; | ||
| testWindow.google = { maps: fakeGoogleMaps }; | ||
| }); | ||
|
|
||
| afterAll(() => { | ||
| if (hadGoogle) { | ||
| testWindow.google = previousGoogle; | ||
| } else { | ||
| delete testWindow.google; | ||
| } | ||
| }); | ||
|
|
||
| beforeEach(async () => { | ||
| await TestBed.configureTestingModule({ | ||
| declarations: [LocationPickerComponent], | ||
| providers: [ | ||
| { provide: ApiService, useValue: {} }, | ||
| { provide: MessageService, useValue: {} }, | ||
| { provide: EditService, useValue: {} }, | ||
| { provide: ProfileService, useValue: {} }, | ||
| { provide: PrLocationPipe, useValue: { transform: () => ({}) } }, | ||
| ], | ||
| schemas: [CUSTOM_ELEMENTS_SCHEMA], | ||
| }).compileComponents(); | ||
|
|
||
| fixture = TestBed.createComponent(LocationPickerComponent); | ||
| component = fixture.componentInstance; | ||
| }); | ||
|
|
||
| describe('createLocnFromPlace', () => { | ||
| it('populates the spec-aligned fields', () => { | ||
| const locn = component.createLocnFromPlace(buildPlace()); | ||
|
|
||
| expect(locn.sublocation).toBe('55 Rue Plumet'); | ||
| expect(locn.city).toBe('Paris'); | ||
| expect(locn.adminOneName).toBe('Ile-de-France'); | ||
| expect(locn.country).toBe('France'); | ||
| expect(locn.postalCode).toBe('75007'); | ||
| expect(locn.latitude).toBe(48.83); | ||
| expect(locn.longitude).toBe(2.3); | ||
| }); | ||
|
|
||
| it('does not write deprecated legacy fields', () => { | ||
| const locn = component.createLocnFromPlace(buildPlace()); | ||
|
|
||
| expect(locn.streetNumber).toBeUndefined(); | ||
| expect(locn.streetName).toBeUndefined(); | ||
|
cecilia-donnelly marked this conversation as resolved.
|
||
| expect(locn.locality).toBeUndefined(); | ||
| expect(locn.countryCode).toBeUndefined(); | ||
| expect(locn.adminOneCode).toBeUndefined(); | ||
| expect(locn.adminTwoName).toBeUndefined(); | ||
| expect(locn.adminTwoCode).toBeUndefined(); | ||
| }); | ||
|
|
||
| it('sets sublocation to null when no street number or street name is available', () => { | ||
| const locn = component.createLocnFromPlace( | ||
| buildPlace({}, { street_number: undefined, route: undefined }), | ||
| ); | ||
|
|
||
| expect(locn.sublocation).toBeNull(); | ||
| }); | ||
|
|
||
| it('falls back to streetName alone when streetNumber is absent', () => { | ||
| const locn = component.createLocnFromPlace( | ||
| buildPlace({}, { street_number: undefined }), | ||
| ); | ||
|
|
||
| expect(locn.sublocation).toBe('Rue Plumet'); | ||
| }); | ||
|
|
||
| it('writes name when the place name does not include the sublocation', () => { | ||
| const locn = component.createLocnFromPlace(buildPlace()); | ||
|
|
||
| expect(locn.name).toBe("Jean Valjean's House"); | ||
| }); | ||
|
|
||
| it('omits name when the place name already matches the sublocation', () => { | ||
| const locn = component.createLocnFromPlace( | ||
| buildPlace({ name: '55 Rue Plumet' }), | ||
| ); | ||
|
|
||
| expect(locn.name).toBeUndefined(); | ||
| }); | ||
| }); | ||
| }); | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -229,32 +229,32 @@ export class LocationPickerComponent implements OnInit, AfterViewInit { | |
|
|
||
| createLocnFromPlace(place: google.maps.places.PlaceResult) { | ||
| const addr = place.address_components; | ||
| const streetNumber = getComponentName(addr, 'street_number'); | ||
| const streetName = getComponentName(addr, 'route'); | ||
| const sublocation = | ||
| [streetNumber, streetName].filter(Boolean).join(' ') || null; | ||
|
cecilia-donnelly marked this conversation as resolved.
|
||
| const locn: LocnVOData = { | ||
| latitude: place.geometry.location.lat(), | ||
| longitude: place.geometry.location.lng(), | ||
| postalCode: getComponentName(addr, 'postal_code'), | ||
| adminOneName: getComponentName(addr, 'administrative_area_level_1'), | ||
| country: getComponentName(addr, 'country'), | ||
| sublocation, | ||
| city: getComponentName(addr, 'locality'), | ||
| }; | ||
|
|
||
| if (place.name && (!sublocation || !place.name.includes(sublocation))) { | ||
| locn.name = place.name; | ||
| } | ||
|
|
||
| return locn; | ||
|
|
||
| function getComponentName( | ||
| addressComponents: google.maps.GeocoderAddressComponent[], | ||
| type: string, | ||
| ) { | ||
| const component = find(addressComponents, (c) => c.types.includes(type)); | ||
| return component ? component.long_name : null; | ||
|
Member
There was a problem hiding this comment. What was the short name?
Member
There was a problem hiding this comment. @slifty is going to figure out if we want to keep that after all.
Contributor
Author
There was a problem hiding this comment. The idea is that short vs long name isn't part of the new location specification, and so we just use the long name now because it's the only thing that will exist in the future. Short name might have been "CA" when long name was "California" |
||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.