2022-05-27 10:30:13 +00:00
|
|
|
/*
|
|
|
|
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.
|
|
|
|
*/
|
|
|
|
|
2022-10-12 17:59:10 +00:00
|
|
|
import fetchMock from "fetch-mock-jest";
|
2022-12-09 12:28:29 +00:00
|
|
|
import { UpdateCheckStatus } from "matrix-react-sdk/src/BasePlatform";
|
|
|
|
import { MatrixClientPeg } from "matrix-react-sdk/src/MatrixClientPeg";
|
2022-05-27 10:30:13 +00:00
|
|
|
|
2022-12-09 12:28:29 +00:00
|
|
|
import WebPlatform from "../../../../src/vector/platform/WebPlatform";
|
2022-05-27 10:30:13 +00:00
|
|
|
|
2022-10-12 17:59:10 +00:00
|
|
|
fetchMock.config.overwriteRoutes = true;
|
|
|
|
|
2022-12-09 12:28:29 +00:00
|
|
|
describe("WebPlatform", () => {
|
2022-05-27 10:30:13 +00:00
|
|
|
beforeEach(() => {
|
|
|
|
jest.clearAllMocks();
|
|
|
|
});
|
|
|
|
|
2022-12-09 12:28:29 +00:00
|
|
|
it("returns human readable name", () => {
|
2022-05-27 10:30:13 +00:00
|
|
|
const platform = new WebPlatform();
|
2022-12-09 12:28:29 +00:00
|
|
|
expect(platform.getHumanReadableName()).toEqual("Web Platform");
|
2022-05-27 10:30:13 +00:00
|
|
|
});
|
|
|
|
|
2022-12-09 12:28:29 +00:00
|
|
|
it("registers service worker", () => {
|
2022-10-13 08:22:34 +00:00
|
|
|
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
|
2022-07-11 12:22:37 +00:00
|
|
|
// @ts-ignore - mocking readonly object
|
|
|
|
navigator.serviceWorker = { register: jest.fn() };
|
|
|
|
new WebPlatform();
|
|
|
|
expect(navigator.serviceWorker.register).toHaveBeenCalled();
|
|
|
|
});
|
|
|
|
|
2022-09-30 17:27:59 +00:00
|
|
|
it("should call reload on window location object", () => {
|
|
|
|
delete window.location;
|
|
|
|
window.location = {
|
|
|
|
reload: jest.fn(),
|
|
|
|
} as unknown as Location;
|
|
|
|
|
|
|
|
const platform = new WebPlatform();
|
|
|
|
expect(window.location.reload).not.toHaveBeenCalled();
|
|
|
|
platform.reload();
|
|
|
|
expect(window.location.reload).toHaveBeenCalled();
|
|
|
|
});
|
|
|
|
|
|
|
|
it("should call reload to install update", () => {
|
|
|
|
delete window.location;
|
|
|
|
window.location = {
|
|
|
|
reload: jest.fn(),
|
|
|
|
} as unknown as Location;
|
|
|
|
|
|
|
|
const platform = new WebPlatform();
|
|
|
|
expect(window.location.reload).not.toHaveBeenCalled();
|
|
|
|
platform.installUpdate();
|
|
|
|
expect(window.location.reload).toHaveBeenCalled();
|
|
|
|
});
|
|
|
|
|
|
|
|
describe("getDefaultDeviceDisplayName", () => {
|
2022-12-09 12:28:29 +00:00
|
|
|
it.each([
|
|
|
|
[
|
|
|
|
"https://develop.element.io/#/room/!foo:bar",
|
|
|
|
"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) " +
|
|
|
|
"Chrome/105.0.0.0 Safari/537.36",
|
|
|
|
"develop.element.io: Chrome on macOS",
|
|
|
|
],
|
|
|
|
])("%s & %s = %s", (url, userAgent, result) => {
|
2022-09-30 17:27:59 +00:00
|
|
|
delete window.navigator;
|
|
|
|
window.navigator = { userAgent } as unknown as Navigator;
|
|
|
|
delete window.location;
|
|
|
|
window.location = { href: url } as unknown as Location;
|
|
|
|
const platform = new WebPlatform();
|
|
|
|
expect(platform.getDefaultDeviceDisplayName()).toEqual(result);
|
|
|
|
});
|
|
|
|
});
|
|
|
|
|
2022-12-09 12:28:29 +00:00
|
|
|
describe("notification support", () => {
|
2022-05-27 10:30:13 +00:00
|
|
|
const mockNotification = {
|
|
|
|
requestPermission: jest.fn(),
|
2022-12-09 12:28:29 +00:00
|
|
|
permission: "notGranted",
|
2022-10-13 08:22:34 +00:00
|
|
|
};
|
2022-05-27 10:30:13 +00:00
|
|
|
beforeEach(() => {
|
2022-10-13 08:22:34 +00:00
|
|
|
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
|
2022-05-27 10:30:13 +00:00
|
|
|
// @ts-ignore
|
|
|
|
window.Notification = mockNotification;
|
2022-12-09 12:28:29 +00:00
|
|
|
mockNotification.permission = "notGranted";
|
2022-05-27 10:30:13 +00:00
|
|
|
});
|
|
|
|
|
2022-12-09 12:28:29 +00:00
|
|
|
it("supportsNotifications returns false when platform does not support notifications", () => {
|
2022-10-13 08:22:34 +00:00
|
|
|
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
|
2022-05-27 10:30:13 +00:00
|
|
|
// @ts-ignore
|
|
|
|
window.Notification = undefined;
|
|
|
|
expect(new WebPlatform().supportsNotifications()).toBe(false);
|
|
|
|
});
|
|
|
|
|
2022-12-09 12:28:29 +00:00
|
|
|
it("supportsNotifications returns true when platform supports notifications", () => {
|
2022-05-27 10:30:13 +00:00
|
|
|
expect(new WebPlatform().supportsNotifications()).toBe(true);
|
|
|
|
});
|
2022-07-11 12:22:37 +00:00
|
|
|
|
2022-12-09 12:28:29 +00:00
|
|
|
it("maySendNotifications returns true when notification permissions are not granted", () => {
|
2022-05-27 10:30:13 +00:00
|
|
|
expect(new WebPlatform().maySendNotifications()).toBe(false);
|
|
|
|
});
|
|
|
|
|
2022-12-09 12:28:29 +00:00
|
|
|
it("maySendNotifications returns true when notification permissions are granted", () => {
|
|
|
|
mockNotification.permission = "granted";
|
2022-05-27 10:30:13 +00:00
|
|
|
expect(new WebPlatform().maySendNotifications()).toBe(true);
|
|
|
|
});
|
|
|
|
|
2022-12-09 12:28:29 +00:00
|
|
|
it("requests notification permissions and returns result ", async () => {
|
|
|
|
mockNotification.requestPermission.mockImplementation((callback) => callback("test"));
|
2022-05-27 10:30:13 +00:00
|
|
|
|
|
|
|
const platform = new WebPlatform();
|
|
|
|
const result = await platform.requestNotificationPermission();
|
2022-12-09 12:28:29 +00:00
|
|
|
expect(result).toEqual("test");
|
2022-05-27 10:30:13 +00:00
|
|
|
});
|
|
|
|
});
|
|
|
|
|
2022-12-09 12:28:29 +00:00
|
|
|
describe("app version", () => {
|
2022-05-27 10:30:13 +00:00
|
|
|
const envVersion = process.env.VERSION;
|
2022-12-09 12:28:29 +00:00
|
|
|
const prodVersion = "1.10.13";
|
2022-05-27 10:30:13 +00:00
|
|
|
|
|
|
|
beforeEach(() => {
|
2022-12-09 12:28:29 +00:00
|
|
|
jest.spyOn(MatrixClientPeg, "userRegisteredWithinLastHours").mockReturnValue(false);
|
2022-10-13 08:22:34 +00:00
|
|
|
});
|
2022-05-27 10:30:13 +00:00
|
|
|
|
|
|
|
afterAll(() => {
|
|
|
|
process.env.VERSION = envVersion;
|
|
|
|
});
|
|
|
|
|
2022-12-09 12:28:29 +00:00
|
|
|
it("should return true from canSelfUpdate()", async () => {
|
2022-05-27 10:30:13 +00:00
|
|
|
const platform = new WebPlatform();
|
|
|
|
const result = await platform.canSelfUpdate();
|
|
|
|
expect(result).toBe(true);
|
|
|
|
});
|
|
|
|
|
2022-12-09 12:28:29 +00:00
|
|
|
it("getAppVersion returns normalized app version", async () => {
|
2022-05-27 10:30:13 +00:00
|
|
|
process.env.VERSION = prodVersion;
|
|
|
|
const platform = new WebPlatform();
|
|
|
|
|
|
|
|
const version = await platform.getAppVersion();
|
|
|
|
expect(version).toEqual(prodVersion);
|
|
|
|
|
|
|
|
process.env.VERSION = `v${prodVersion}`;
|
|
|
|
const version2 = await platform.getAppVersion();
|
|
|
|
// v prefix removed
|
|
|
|
expect(version2).toEqual(prodVersion);
|
|
|
|
|
|
|
|
process.env.VERSION = `version not like semver`;
|
|
|
|
const notSemverVersion = await platform.getAppVersion();
|
|
|
|
expect(notSemverVersion).toEqual(`version not like semver`);
|
|
|
|
});
|
|
|
|
|
2022-12-09 12:28:29 +00:00
|
|
|
describe("pollForUpdate()", () => {
|
|
|
|
it(
|
|
|
|
"should return not available and call showNoUpdate when current version " +
|
|
|
|
"matches most recent version",
|
|
|
|
async () => {
|
|
|
|
process.env.VERSION = prodVersion;
|
|
|
|
fetchMock.getOnce("/version", prodVersion);
|
|
|
|
const platform = new WebPlatform();
|
|
|
|
|
|
|
|
const showUpdate = jest.fn();
|
|
|
|
const showNoUpdate = jest.fn();
|
|
|
|
const result = await platform.pollForUpdate(showUpdate, showNoUpdate);
|
|
|
|
|
|
|
|
expect(result).toEqual({ status: UpdateCheckStatus.NotAvailable });
|
|
|
|
expect(showUpdate).not.toHaveBeenCalled();
|
|
|
|
expect(showNoUpdate).toHaveBeenCalled();
|
|
|
|
},
|
|
|
|
);
|
|
|
|
|
|
|
|
it("should strip v prefix from versions before comparing", async () => {
|
2022-05-27 10:30:13 +00:00
|
|
|
process.env.VERSION = prodVersion;
|
2022-10-12 17:59:10 +00:00
|
|
|
fetchMock.getOnce("/version", `v${prodVersion}`);
|
2022-05-27 10:30:13 +00:00
|
|
|
const platform = new WebPlatform();
|
2022-07-11 12:22:37 +00:00
|
|
|
|
2022-05-27 10:30:13 +00:00
|
|
|
const showUpdate = jest.fn();
|
|
|
|
const showNoUpdate = jest.fn();
|
|
|
|
const result = await platform.pollForUpdate(showUpdate, showNoUpdate);
|
2022-07-11 12:22:37 +00:00
|
|
|
|
2022-05-27 10:30:13 +00:00
|
|
|
// versions only differ by v prefix, no update
|
|
|
|
expect(result).toEqual({ status: UpdateCheckStatus.NotAvailable });
|
|
|
|
expect(showUpdate).not.toHaveBeenCalled();
|
|
|
|
expect(showNoUpdate).toHaveBeenCalled();
|
|
|
|
});
|
2022-07-11 12:22:37 +00:00
|
|
|
|
2022-12-09 12:28:29 +00:00
|
|
|
it(
|
|
|
|
"should return ready and call showUpdate when current version " + "differs from most recent version",
|
|
|
|
async () => {
|
|
|
|
process.env.VERSION = "0.0.0"; // old version
|
|
|
|
fetchMock.getOnce("/version", prodVersion);
|
|
|
|
const platform = new WebPlatform();
|
|
|
|
|
|
|
|
const showUpdate = jest.fn();
|
|
|
|
const showNoUpdate = jest.fn();
|
|
|
|
const result = await platform.pollForUpdate(showUpdate, showNoUpdate);
|
|
|
|
|
|
|
|
expect(result).toEqual({ status: UpdateCheckStatus.Ready });
|
|
|
|
expect(showUpdate).toHaveBeenCalledWith("0.0.0", prodVersion);
|
|
|
|
expect(showNoUpdate).not.toHaveBeenCalled();
|
|
|
|
},
|
|
|
|
);
|
|
|
|
|
|
|
|
it("should return ready without showing update when user registered in last 24", async () => {
|
|
|
|
process.env.VERSION = "0.0.0"; // old version
|
|
|
|
jest.spyOn(MatrixClientPeg, "userRegisteredWithinLastHours").mockReturnValue(true);
|
2022-10-12 17:59:10 +00:00
|
|
|
fetchMock.getOnce("/version", prodVersion);
|
2022-05-27 10:30:13 +00:00
|
|
|
const platform = new WebPlatform();
|
2022-07-11 12:22:37 +00:00
|
|
|
|
2022-05-27 10:30:13 +00:00
|
|
|
const showUpdate = jest.fn();
|
|
|
|
const showNoUpdate = jest.fn();
|
|
|
|
const result = await platform.pollForUpdate(showUpdate, showNoUpdate);
|
2022-07-11 12:22:37 +00:00
|
|
|
|
2022-05-27 10:30:13 +00:00
|
|
|
expect(result).toEqual({ status: UpdateCheckStatus.Ready });
|
|
|
|
expect(showUpdate).not.toHaveBeenCalled();
|
|
|
|
expect(showNoUpdate).not.toHaveBeenCalled();
|
|
|
|
});
|
2022-07-11 12:22:37 +00:00
|
|
|
|
2022-12-09 12:28:29 +00:00
|
|
|
it("should return error when version check fails", async () => {
|
2022-10-12 17:59:10 +00:00
|
|
|
fetchMock.getOnce("/version", { throws: "oups" });
|
2022-05-27 10:30:13 +00:00
|
|
|
const platform = new WebPlatform();
|
2022-07-11 12:22:37 +00:00
|
|
|
|
2022-05-27 10:30:13 +00:00
|
|
|
const showUpdate = jest.fn();
|
|
|
|
const showNoUpdate = jest.fn();
|
|
|
|
const result = await platform.pollForUpdate(showUpdate, showNoUpdate);
|
2022-07-11 12:22:37 +00:00
|
|
|
|
2022-12-09 12:28:29 +00:00
|
|
|
expect(result).toEqual({ status: UpdateCheckStatus.Error, detail: "Unknown Error" });
|
2022-05-27 10:30:13 +00:00
|
|
|
expect(showUpdate).not.toHaveBeenCalled();
|
|
|
|
expect(showNoUpdate).not.toHaveBeenCalled();
|
|
|
|
});
|
|
|
|
});
|
|
|
|
});
|
|
|
|
});
|