From 7453f8dd071b525b522bca525bc331d26866849b Mon Sep 17 00:00:00 2001 From: Michael Telatynski <7t3chguy@gmail.com> Date: Fri, 17 Jul 2020 13:25:28 +0100 Subject: [PATCH 1/2] Fix `this` context in _setupHomeserverManagers for IntegrationManagers Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> --- src/integrations/IntegrationManagers.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/integrations/IntegrationManagers.js b/src/integrations/IntegrationManagers.js index 5fd28d7c54..c2cdeb5209 100644 --- a/src/integrations/IntegrationManagers.js +++ b/src/integrations/IntegrationManagers.js @@ -78,7 +78,7 @@ export class IntegrationManagers { } } - async _setupHomeserverManagers(discoveryResponse) { + _setupHomeserverManagers = async (discoveryResponse) => { console.log("Updating homeserver-configured integration managers..."); if (discoveryResponse && discoveryResponse['m.integrations']) { let managers = discoveryResponse['m.integrations']['managers']; @@ -104,7 +104,7 @@ export class IntegrationManagers { } else { console.log("Homeserver has no integration managers"); } - } + }; _setupAccountManagers() { if (!this._client || !this._client.getUserId()) return; // not logged in From c0e78b56b15956c522cdb84079146f6dd42052b5 Mon Sep 17 00:00:00 2001 From: Michael Telatynski <7t3chguy@gmail.com> Date: Fri, 17 Jul 2020 13:38:08 +0100 Subject: [PATCH 2/2] convert integrations manager utils to Typescript Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> --- src/@types/global.d.ts | 4 +- ...tance.js => IntegrationManagerInstance.ts} | 33 ++--- ...tionManagers.js => IntegrationManagers.ts} | 123 +++++++++--------- 3 files changed, 82 insertions(+), 78 deletions(-) rename src/integrations/{IntegrationManagerInstance.js => IntegrationManagerInstance.ts} (82%) rename src/integrations/{IntegrationManagers.js => IntegrationManagers.ts} (63%) diff --git a/src/@types/global.d.ts b/src/@types/global.d.ts index 2d895e12eb..9424cdcd17 100644 --- a/src/@types/global.d.ts +++ b/src/@types/global.d.ts @@ -23,6 +23,7 @@ import RebrandListener from "../RebrandListener"; import { RoomListStore2 } from "../stores/room-list/RoomListStore2"; import { PlatformPeg } from "../PlatformPeg"; import RoomListLayoutStore from "../stores/room-list/RoomListLayoutStore"; +import {IntegrationManagers} from "../integrations/IntegrationManagers"; declare global { interface Window { @@ -39,11 +40,12 @@ declare global { mx_RoomListStore2: RoomListStore2; mx_RoomListLayoutStore: RoomListLayoutStore; mxPlatformPeg: PlatformPeg; + mxIntegrationManagers: typeof IntegrationManagers; } // workaround for https://github.com/microsoft/TypeScript/issues/30933 interface ObjectConstructor { - fromEntries?(xs: [string|number|symbol, any][]): object + fromEntries?(xs: [string|number|symbol, any][]): object; } interface Document { diff --git a/src/integrations/IntegrationManagerInstance.js b/src/integrations/IntegrationManagerInstance.ts similarity index 82% rename from src/integrations/IntegrationManagerInstance.js rename to src/integrations/IntegrationManagerInstance.ts index 3ffe1e5401..85748db3c2 100644 --- a/src/integrations/IntegrationManagerInstance.js +++ b/src/integrations/IntegrationManagerInstance.ts @@ -14,32 +14,34 @@ See the License for the specific language governing permissions and limitations under the License. */ +import type {Room} from "matrix-js-sdk/src/models/room"; + import ScalarAuthClient from "../ScalarAuthClient"; -import * as sdk from "../index"; import {dialogTermsInteractionCallback, TermsNotSignedError} from "../Terms"; -import type {Room} from "matrix-js-sdk"; import Modal from '../Modal'; import url from 'url'; import SettingsStore from "../settings/SettingsStore"; +import IntegrationManager from "../components/views/settings/IntegrationManager"; import {IntegrationManagers} from "./IntegrationManagers"; -export const KIND_ACCOUNT = "account"; -export const KIND_CONFIG = "config"; -export const KIND_HOMESERVER = "homeserver"; +export enum Kind { + Account = "account", + Config = "config", + Homeserver = "homeserver", +} export class IntegrationManagerInstance { - apiUrl: string; - uiUrl: string; - kind: string; - id: string; // only applicable in some cases + public readonly apiUrl: string; + public readonly uiUrl: string; + public readonly kind: string; + public readonly id: string; // only applicable in some cases - constructor(kind: string, apiUrl: string, uiUrl: string) { + // Per the spec: UI URL is optional. + constructor(kind: string, apiUrl: string, uiUrl: string = apiUrl, id?: string) { this.kind = kind; this.apiUrl = apiUrl; this.uiUrl = uiUrl; - - // Per the spec: UI URL is optional. - if (!this.uiUrl) this.uiUrl = this.apiUrl; + this.id = id; } get name(): string { @@ -51,19 +53,18 @@ export class IntegrationManagerInstance { const parsed = url.parse(this.apiUrl); parsed.pathname = ''; parsed.path = ''; - return parsed.format(); + return url.format(parsed); } getScalarClient(): ScalarAuthClient { return new ScalarAuthClient(this.apiUrl, this.uiUrl); } - async open(room: Room = null, screen: string = null, integrationId: string = null): void { + async open(room: Room = null, screen: string = null, integrationId: string = null): Promise { if (!SettingsStore.getValue("integrationProvisioning")) { return IntegrationManagers.sharedInstance().showDisabledDialog(); } - const IntegrationManager = sdk.getComponent("views.settings.IntegrationManager"); const dialog = Modal.createTrackedDialog( 'Integration Manager', '', IntegrationManager, {loading: true}, 'mx_IntegrationManager', diff --git a/src/integrations/IntegrationManagers.js b/src/integrations/IntegrationManagers.ts similarity index 63% rename from src/integrations/IntegrationManagers.js rename to src/integrations/IntegrationManagers.ts index c2cdeb5209..cf934521c0 100644 --- a/src/integrations/IntegrationManagers.js +++ b/src/integrations/IntegrationManagers.ts @@ -14,71 +14,77 @@ See the License for the specific language governing permissions and limitations under the License. */ +import type {MatrixClient} from "matrix-js-sdk/src/client"; +import type {MatrixEvent} from "matrix-js-sdk/src/models/event"; +import type {Room} from "matrix-js-sdk/src/models/room"; + import SdkConfig from '../SdkConfig'; -import * as sdk from "../index"; import Modal from '../Modal'; -import {IntegrationManagerInstance, KIND_ACCOUNT, KIND_CONFIG, KIND_HOMESERVER} from "./IntegrationManagerInstance"; -import type {MatrixClient, MatrixEvent, Room} from "matrix-js-sdk"; +import {IntegrationManagerInstance, Kind} from "./IntegrationManagerInstance"; +import IntegrationsImpossibleDialog from "../components/views/dialogs/IntegrationsImpossibleDialog"; +import TabbedIntegrationManagerDialog from "../components/views/dialogs/TabbedIntegrationManagerDialog"; +import IntegrationsDisabledDialog from "../components/views/dialogs/IntegrationsDisabledDialog"; import WidgetUtils from "../utils/WidgetUtils"; import {MatrixClientPeg} from "../MatrixClientPeg"; import SettingsStore from "../settings/SettingsStore"; +import url from 'url'; const KIND_PREFERENCE = [ // Ordered: first is most preferred, last is least preferred. - KIND_ACCOUNT, - KIND_HOMESERVER, - KIND_CONFIG, + Kind.Account, + Kind.Homeserver, + Kind.Config, ]; export class IntegrationManagers { - static _instance; + private static instance; - static sharedInstance(): IntegrationManagers { - if (!IntegrationManagers._instance) { - IntegrationManagers._instance = new IntegrationManagers(); + private managers: IntegrationManagerInstance[] = []; + private client: MatrixClient; + private primaryManager: IntegrationManagerInstance; + + public static sharedInstance(): IntegrationManagers { + if (!IntegrationManagers.instance) { + IntegrationManagers.instance = new IntegrationManagers(); } - return IntegrationManagers._instance; + return IntegrationManagers.instance; } - _managers: IntegrationManagerInstance[] = []; - _client: MatrixClient; - _primaryManager: IntegrationManagerInstance; - constructor() { - this._compileManagers(); + this.compileManagers(); } startWatching(): void { this.stopWatching(); - this._client = MatrixClientPeg.get(); - this._client.on("accountData", this._onAccountData); - this._client.on("WellKnown.client", this._setupHomeserverManagers); - this._compileManagers(); + this.client = MatrixClientPeg.get(); + this.client.on("accountData", this.onAccountData); + this.client.on("WellKnown.client", this.setupHomeserverManagers); + this.compileManagers(); } stopWatching(): void { - if (!this._client) return; - this._client.removeListener("accountData", this._onAccountData); - this._client.removeListener("WellKnown.client", this._setupHomeserverManagers); + if (!this.client) return; + this.client.removeListener("accountData", this.onAccountData); + this.client.removeListener("WellKnown.client", this.setupHomeserverManagers); } - _compileManagers() { - this._managers = []; - this._setupConfiguredManager(); - this._setupAccountManagers(); + private compileManagers() { + this.managers = []; + this.setupConfiguredManager(); + this.setupAccountManagers(); } - _setupConfiguredManager() { - const apiUrl = SdkConfig.get()['integrations_rest_url']; - const uiUrl = SdkConfig.get()['integrations_ui_url']; + private setupConfiguredManager() { + const apiUrl: string = SdkConfig.get()['integrations_rest_url']; + const uiUrl: string = SdkConfig.get()['integrations_ui_url']; if (apiUrl && uiUrl) { - this._managers.push(new IntegrationManagerInstance(KIND_CONFIG, apiUrl, uiUrl)); - this._primaryManager = null; // reset primary + this.managers.push(new IntegrationManagerInstance(Kind.Config, apiUrl, uiUrl)); + this.primaryManager = null; // reset primary } } - _setupHomeserverManagers = async (discoveryResponse) => { + private setupHomeserverManagers = async (discoveryResponse) => { console.log("Updating homeserver-configured integration managers..."); if (discoveryResponse && discoveryResponse['m.integrations']) { let managers = discoveryResponse['m.integrations']['managers']; @@ -88,26 +94,26 @@ export class IntegrationManagers { // Clear out any known managers for the homeserver // TODO: Log out of the scalar clients - this._managers = this._managers.filter(m => m.kind !== KIND_HOMESERVER); + this.managers = this.managers.filter(m => m.kind !== Kind.Homeserver); // Now add all the managers the homeserver wants us to have for (const hsManager of managers) { if (!hsManager["api_url"]) continue; - this._managers.push(new IntegrationManagerInstance( - KIND_HOMESERVER, + this.managers.push(new IntegrationManagerInstance( + Kind.Homeserver, hsManager["api_url"], hsManager["ui_url"], // optional )); } - this._primaryManager = null; // reset primary + this.primaryManager = null; // reset primary } else { console.log("Homeserver has no integration managers"); } }; - _setupAccountManagers() { - if (!this._client || !this._client.getUserId()) return; // not logged in + private setupAccountManagers() { + if (!this.client || !this.client.getUserId()) return; // not logged in const widgets = WidgetUtils.getIntegrationManagerWidgets(); widgets.forEach(w => { const data = w.content['data']; @@ -117,30 +123,29 @@ export class IntegrationManagers { const apiUrl = data['api_url']; if (!apiUrl || !uiUrl) return; - const manager = new IntegrationManagerInstance(KIND_ACCOUNT, apiUrl, uiUrl); - manager.id = w['id'] || w['state_key'] || ''; - this._managers.push(manager); + const manager = new IntegrationManagerInstance(Kind.Account, apiUrl, uiUrl, w['id'] || w['state_key'] || ''); + this.managers.push(manager); }); - this._primaryManager = null; // reset primary + this.primaryManager = null; // reset primary } - _onAccountData = (ev: MatrixEvent): void => { + private onAccountData = (ev: MatrixEvent): void => { if (ev.getType() === 'm.widgets') { - this._compileManagers(); + this.compileManagers(); } }; hasManager(): boolean { - return this._managers.length > 0; + return this.managers.length > 0; } getOrderedManagers(): IntegrationManagerInstance[] { const ordered = []; for (const kind of KIND_PREFERENCE) { - const managers = this._managers.filter(m => m.kind === kind); + const managers = this.managers.filter(m => m.kind === kind); if (!managers || !managers.length) continue; - if (kind === KIND_ACCOUNT) { + if (kind === Kind.Account) { // Order by state_keys (IDs) managers.sort((a, b) => a.id.localeCompare(b.id)); } @@ -152,17 +157,16 @@ export class IntegrationManagers { getPrimaryManager(): IntegrationManagerInstance { if (this.hasManager()) { - if (this._primaryManager) return this._primaryManager; + if (this.primaryManager) return this.primaryManager; - this._primaryManager = this.getOrderedManagers()[0]; - return this._primaryManager; + this.primaryManager = this.getOrderedManagers()[0]; + return this.primaryManager; } else { return null; } } openNoManagerDialog(): void { - const IntegrationsImpossibleDialog = sdk.getComponent("dialogs.IntegrationsImpossibleDialog"); Modal.createTrackedDialog('Integrations impossible', '', IntegrationsImpossibleDialog); } @@ -171,11 +175,10 @@ export class IntegrationManagers { return this.showDisabledDialog(); } - if (this._managers.length === 0) { + if (this.managers.length === 0) { return this.openNoManagerDialog(); } - const TabbedIntegrationManagerDialog = sdk.getComponent("views.dialogs.TabbedIntegrationManagerDialog"); Modal.createTrackedDialog( 'Tabbed Integration Manager', '', TabbedIntegrationManagerDialog, {room, screen, integrationId}, 'mx_TabbedIntegrationManagerDialog', @@ -183,7 +186,6 @@ export class IntegrationManagers { } showDisabledDialog(): void { - const IntegrationsDisabledDialog = sdk.getComponent("dialogs.IntegrationsDisabledDialog"); Modal.createTrackedDialog('Integrations disabled', '', IntegrationsDisabledDialog); } @@ -202,15 +204,14 @@ export class IntegrationManagers { * @returns {Promise} Resolves to an integration manager instance, * or null if none was found. */ - async tryDiscoverManager(domainName: string): IntegrationManagerInstance { + async tryDiscoverManager(domainName: string): Promise { console.log("Looking up integration manager via .well-known"); if (domainName.startsWith("http:") || domainName.startsWith("https:")) { // trim off the scheme and just use the domain - const url = url.parse(domainName); - domainName = url.host; + domainName = url.parse(domainName).host; } - let wkConfig; + let wkConfig: object; try { const result = await fetch(`https://${domainName}/.well-known/matrix/integrations`); wkConfig = await result.json(); @@ -232,7 +233,7 @@ export class IntegrationManagers { } // All discovered managers are per-user managers - const manager = new IntegrationManagerInstance(KIND_ACCOUNT, widget["data"]["api_url"], widget["url"]); + const manager = new IntegrationManagerInstance(Kind.Account, widget["data"]["api_url"], widget["url"]); console.log("Got an integration manager (untested)"); // We don't test the manager because the caller may need to do extra @@ -244,4 +245,4 @@ export class IntegrationManagers { } // For debugging -global.mxIntegrationManagers = IntegrationManagers; +window.mxIntegrationManagers = IntegrationManagers;