matrix/matrix-react-sdk
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-react-sdk.git synced 2025-08-07 21:23:00 +03:00
Code Activity

Extract location utils from components (#8152)

Browse Source 
* 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
2022-03-25 15:36:22 +01:00
committed by GitHub
parent 0d513b3a2d
commit 1397652f52
20 changed files with 496 additions and 350 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
test/components/views/location/LocationPicker-test.tsx
View File

@@ -29,10 +29,9 @@ import { LocationShareType } from "../../../../src/components/views/location/sha
import MatrixClientContext from '../../../../src/contexts/MatrixClientContext';
import { MatrixClientPeg } from '../../../../src/MatrixClientPeg';
import { findById, findByTestId, mockPlatformPeg } from '../../../test-utils';
import { findMapStyleUrl } from '../../../../src/components/views/location/findMapStyleUrl';
import { LocationShareError } from '../../../../src/components/views/location/LocationShareErrors';
import { findMapStyleUrl, LocationShareError } from '../../../../src/utils/location';
jest.mock('../../../../src/components/views/location/findMapStyleUrl', () => ({
jest.mock('../../../../src/utils/location/findMapStyleUrl', () => ({
findMapStyleUrl: jest.fn().mockReturnValue('tileserver.com'),
}));

2
test/components/views/location/LocationShareMenu-test.tsx
View File

@@ -35,7 +35,7 @@ import { findByTagAndTestId, flushPromises } from '../../../test-utils';
import Modal from '../../../../src/Modal';
import { DEFAULT_DURATION_MS } from '../../../../src/components/views/location/LiveDurationDropdown';
jest.mock('../../../../src/components/views/location/findMapStyleUrl', () => ({
jest.mock('../../../../src/utils/location/findMapStyleUrl', () => ({
findMapStyleUrl: jest.fn().mockReturnValue('test'),
}));

2
test/components/views/location/MapError-test.tsx
View File

@@ -19,7 +19,7 @@ import { mount } from 'enzyme';
import '../../../skinned-sdk';
import { MapError } from '../../../../src/components/views/location/MapError';
import { LocationShareError } from '../../../../src/components/views/location/LocationShareErrors';
import { LocationShareError } from '../../../../src/utils/location';
describe('<MapError />', () => {
const defaultProps = {

222
test/components/views/messages/MLocationBody-test.tsx
View File

@@ -26,200 +26,27 @@ import {
M_TIMESTAMP,
} from "matrix-js-sdk/src/@types/location";
import { TEXT_NODE_TYPE } from "matrix-js-sdk/src/@types/extensible_events";
import { MatrixEvent } from "matrix-js-sdk/src/models/event";
import maplibregl from 'maplibre-gl';
import { logger } from 'matrix-js-sdk/src/logger';
import sdk from "../../../skinned-sdk";
import MLocationBody, {
createMapSiteLink,
isSelfLocation,
parseGeoUri,
} from "../../../../src/components/views/messages/MLocationBody";
import MatrixClientContext from "../../../../src/contexts/MatrixClientContext";
import { RoomPermalinkCreator } from "../../../../src/utils/permalinks/Permalinks";
import { MediaEventHelper } from "../../../../src/utils/MediaEventHelper";
import { getTileServerWellKnown } from "../../../../src/utils/WellKnownUtils";
import SdkConfig from "../../../../src/SdkConfig";
import { makeLocationEvent } from "../../../test-utils/location";
jest.mock("../../../../src/utils/WellKnownUtils", () => ({
getTileServerWellKnown: jest.fn(),
}));
let EVENT_ID = 0;
function nextId(): string {
EVENT_ID++;
return EVENT_ID.toString();
}
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: 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,
},
);
});
});
describe("createMapSiteLink", () => {
it("returns null if event does not contain geouri", () => {
expect(createMapSiteLink(nonLocationEvent())).toBeNull();
});
it("returns OpenStreetMap link if event contains m.location", () => {
expect(
createMapSiteLink(modernLocationEvent("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(oldLocationEvent("geo:51.5076,-0.1276")),
).toEqual(
"https://www.openstreetmap.org/" +
"?mlat=51.5076&mlon=-0.1276" +
"#map=16/51.5076/-0.1276",
);
});
});
describe("isSelfLocation", () => {
it("Returns true for a full m.asset event", () => {
const content = makeLocationContent("", '0');
@@ -271,7 +98,7 @@ describe("MLocationBody", () => {
on: jest.fn(),
off: jest.fn(),
};
const defaultEvent = modernLocationEvent("geo:51.5076,-0.1276", LocationAssetType.Pin);
const defaultEvent = makeLocationEvent("geo:51.5076,-0.1276", LocationAssetType.Pin);
const defaultProps = {
mxEvent: defaultEvent,
highlights: [],
@@ -318,48 +145,3 @@ describe("MLocationBody", () => {
});
});
});
function oldLocationEvent(geoUri: string): MatrixEvent {
return new MatrixEvent(
{
"event_id": nextId(),
"type": M_LOCATION.name,
"content": {
"body": "Something about where I am",
"msgtype": "m.location",
"geo_uri": geoUri,
},
},
);
}
function modernLocationEvent(geoUri: string, assetType?: LocationAssetType): MatrixEvent {
return new MatrixEvent(
{
"event_id": nextId(),
"type": M_LOCATION.name,
"content": makeLocationContent(
`Found at ${geoUri} at 2021-12-21T12:22+0000`,
geoUri,
252523,
"Human-readable label",
assetType,
),
},
);
}
function nonLocationEvent(): MatrixEvent {
return new MatrixEvent(
{
"event_id": nextId(),
"type": "some.event.type",
"content": {
"m.relates_to": {
"rel_type": "m.reference",
"event_id": "$mypoll",
},
},
},
);
}