PrivateCoffee/element-web
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 4

Unit tests for parseGeoUri (#7395)

Browse source
This commit is contained in:
Andy Balaam 2021-12-16 14:20:55 +00:00 committed by GitHub
parent 8f3ea97729
commit 9a8265429c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 184 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

44
src/components/views/messages/MLocationBody.tsx
View file

@ -45,7 +45,7 @@ export default class MLocationBody extends React.Component<IBodyProps, IState> {
const loc = content[LOCATION_EVENT_TYPE.name];
const uri = loc ? loc.uri : content['geo_uri'];
this.coords = this.parseGeoUri(uri);
this.coords = parseGeoUri(uri);
this.state = {
error: undefined,
};
@ -53,27 +53,6 @@ export default class MLocationBody extends React.Component<IBodyProps, IState> {
this.description = loc?.description ?? content['body'];
}
private parseGeoUri = (uri: string): GeolocationCoordinates => {
const m = uri.match(/^\s*geo:(.*?)\s*$/);
if (!m) return;
const parts = m[1].split(';');
const coords = parts[0].split(',');
let uncertainty: number;
for (const param of parts.slice(1)) {
const m = param.match(/u=(.*)/);
if (m) uncertainty = parseFloat(m[1]);
}
return {
latitude: parseFloat(coords[0]),
longitude: parseFloat(coords[1]),
altitude: parseFloat(coords[2]),
accuracy: uncertainty,
altitudeAccuracy: undefined,
heading: undefined,
speed: undefined,
};
};
componentDidMount() {
const config = SdkConfig.get();
const coordinates = new maplibregl.LngLat(this.coords.longitude, this.coords.latitude);
@ -116,3 +95,24 @@ export default class MLocationBody extends React.Component<IBodyProps, IState> {
</div>;
}
}
export function parseGeoUri(uri: string): GeolocationCoordinates {
const m = uri.match(/^\s*geo:(.*?)\s*$/);
if (!m) return;
const parts = m[1].split(';');
const coords = parts[0].split(',');
let uncertainty: number;
for (const param of parts.slice(1)) {
const m = param.match(/u=(.*)/);
if (m) uncertainty = parseFloat(m[1]);
}
return {
latitude: parseFloat(coords[0]),
longitude: parseFloat(coords[1]),
altitude: parseFloat(coords[2]),
accuracy: uncertainty,
altitudeAccuracy: undefined,
heading: undefined,
speed: undefined,
};
}

162
test/components/views/messages/MLocationBody-test.tsx Normal file
View file

@ -0,0 +1,162 @@
/*
Copyright 2021 The Matrix.org Foundation C.I.C.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
import sdk from "../../../skinned-sdk";
import { parseGeoUri } from "../../../../src/components/views/messages/MLocationBody";
sdk.getComponent("views.messages.MLocationBody");
describe("MLocationBody", () => {
describe("parseGeoUri", () => {
it("fails if the supplied URI is empty", () => {
expect(parseGeoUri("")).toBeFalsy();
});
// We use some examples from the spec, but don't check semantics
// like two textually-different URIs being equal, since we are
// just a humble parser.
// Note: we do not understand geo URIs with percent-encoded coords
// or accuracy. It is RECOMMENDED in the spec never to percent-encode
// these, but it is permitted, and we will fail to parse in that case.
it("rfc5870 6.1 Simple 3-dimensional", () => {
expect(parseGeoUri("geo:48.2010,16.3695,183")).toEqual(
{
latitude: 48.2010,
longitude: 16.3695,
altitude: 183,
accuracy: undefined,
altitudeAccuracy: undefined,
heading: undefined,
speed: undefined,
},
);
});
it("rfc5870 6.2 Explicit CRS and accuracy", () => {
expect(parseGeoUri("geo:48.198634,16.371648;crs=wgs84;u=40")).toEqual(
{
latitude: 48.198634,
longitude: 16.371648,
altitude: NaN, // TODO: should be undefined
accuracy: 40,
altitudeAccuracy: undefined,
heading: undefined,
speed: undefined,
},
);
});
it("rfc5870 6.4 Negative longitude and explicit CRS", () => {
expect(parseGeoUri("geo:90,-22.43;crs=WGS84")).toEqual(
{
latitude: 90,
longitude: -22.43,
altitude: NaN, // TODO: should be undefined
accuracy: undefined,
altitudeAccuracy: undefined,
heading: undefined,
speed: undefined,
},
);
});
it("rfc5870 6.4 Integer lat and lon", () => {
expect(parseGeoUri("geo:90,46")).toEqual(
{
latitude: 90,
longitude: 46,
altitude: NaN, // TODO: should be undefined
accuracy: undefined,
altitudeAccuracy: undefined,
heading: undefined,
speed: undefined,
},
);
});
it("rfc5870 6.4 Percent-encoded param value", () => {
expect(parseGeoUri("geo:66,30;u=6.500;FOo=this%2dthat")).toEqual(
{
latitude: 66,
longitude: 30,
altitude: NaN, // TODO: should be undefined
accuracy: 6.500,
altitudeAccuracy: undefined,
heading: undefined,
speed: undefined,
},
);
});
it("rfc5870 6.4 Unknown param", () => {
expect(parseGeoUri("geo:66.0,30;u=6.5;foo=this-that>")).toEqual(
{
latitude: 66.0,
longitude: 30,
altitude: NaN, // TODO: should be undefined
accuracy: 6.5,
altitudeAccuracy: undefined,
heading: undefined,
speed: undefined,
},
);
});
it("rfc5870 6.4 Multiple unknown params", () => {
expect(parseGeoUri("geo:70,20;foo=1.00;bar=white")).toEqual(
{
latitude: 70,
longitude: 20,
altitude: NaN, // TODO: should be undefined
accuracy: undefined,
altitudeAccuracy: undefined,
heading: undefined,
speed: undefined,
},
);
});
it("Negative latitude", () => {
expect(parseGeoUri("geo:-7.5,20")).toEqual(
{
latitude: -7.5,
longitude: 20,
altitude: NaN, // TODO: should be undefined
accuracy: undefined,
altitudeAccuracy: undefined,
heading: undefined,
speed: undefined,
},
);
});
it("Zero altitude is not unknown", () => {
expect(parseGeoUri("geo:-7.5,-20,0")).toEqual(
{
latitude: -7.5,
longitude: -20,
altitude: 0,
accuracy: undefined,
altitudeAccuracy: undefined,
heading: undefined,
speed: undefined,
},
);
});
});
});