Extract location utils from components (#8152)
* extract util functions from MLocationBody Signed-off-by: Kerry Archibald <kerrya@element.io> * disassemble mlocationbody Signed-off-by: Kerry Archibald <kerrya@element.io> * tidy and add copyrights Signed-off-by: Kerry Archibald <kerrya@element.io> * move types and utils from components/location to utils Signed-off-by: Kerry Archibald <kerrya@element.io> * i18n Signed-off-by: Kerry Archibald <kerrya@element.io> * empty line Signed-off-by: Kerry Archibald <kerrya@element.io>
This commit is contained in:
Kerry
GitHub
parent
0d513b3a2d
commit
1397652f52
20 changed files with 496 additions and 350 deletions
28
test/utils/location/locationEventGeoUri-test.ts
Normal file
28
test/utils/location/locationEventGeoUri-test.ts
Normal file
|
|
@ -0,0 +1,28 @@
|
|||
/*
|
||||
Copyright 2022 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 { locationEventGeoUri } from "../../../src/utils/location";
|
||||
import { makeLegacyLocationEvent, makeLocationEvent } from "../../test-utils/location";
|
||||
|
||||
describe('locationEventGeoUri()', () => {
|
||||
it('returns m.location uri when available', () => {
|
||||
expect(locationEventGeoUri(makeLocationEvent("geo:51.5076,-0.1276"))).toEqual("geo:51.5076,-0.1276");
|
||||
});
|
||||
|
||||
it('returns legacy uri when m.location content not found', () => {
|
||||
expect(locationEventGeoUri(makeLegacyLocationEvent("geo:51.5076,-0.1276"))).toEqual("geo:51.5076,-0.1276");
|
||||
});
|
||||
});
|
||||
47
test/utils/location/map-test.ts
Normal file
47
test/utils/location/map-test.ts
Normal file
|
|
@ -0,0 +1,47 @@
|
|||
/*
|
||||
Copyright 2022 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 { createMapSiteLink } from "../../../src/utils/location";
|
||||
import { mkMessage } from "../../test-utils";
|
||||
import { makeLegacyLocationEvent, makeLocationEvent } from "../../test-utils/location";
|
||||
|
||||
describe("createMapSiteLink", () => {
|
||||
it("returns null if event does not contain geouri", () => {
|
||||
expect(createMapSiteLink(mkMessage({
|
||||
room: '1', user: '@sender:server', event: true,
|
||||
}))).toBeNull();
|
||||
});
|
||||
|
||||
it("returns OpenStreetMap link if event contains m.location", () => {
|
||||
expect(
|
||||
createMapSiteLink(makeLocationEvent("geo:51.5076,-0.1276")),
|
||||
).toEqual(
|
||||
"https://www.openstreetmap.org/" +
|
||||
"?mlat=51.5076&mlon=-0.1276" +
|
||||
"#map=16/51.5076/-0.1276",
|
||||
);
|
||||
});
|
||||
|
||||
it("returns OpenStreetMap link if event contains geo_uri", () => {
|
||||
expect(
|
||||
createMapSiteLink(makeLegacyLocationEvent("geo:51.5076,-0.1276")),
|
||||
).toEqual(
|
||||
"https://www.openstreetmap.org/" +
|
||||
"?mlat=51.5076&mlon=-0.1276" +
|
||||
"#map=16/51.5076/-0.1276",
|
||||
);
|
||||
});
|
||||
});
|
||||
157
test/utils/location/parseGeoUri-test.ts
Normal file
157
test/utils/location/parseGeoUri-test.ts
Normal file
|
|
@ -0,0 +1,157 @@
|
|||
/*
|
||||
Copyright 2022 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 { parseGeoUri } from "../../../src/utils/location/parseGeoUri";
|
||||
|
||||
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: 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: 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: 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: 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: 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: 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: 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,
|
||||
},
|
||||
);
|
||||
});
|
||||
});
|
||||
Loading…
Add table
Add a link
Reference in a new issue