OpenCloud
/
element-web
mirror of https://github.com/vector-im/element-web
1
0
Fork 0
Code Issues Releases Wiki Activity

convert integrations manager utils to Typescript 

Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>
pull/21833/head
Michael Telatynski 2020-07-17 13:38:08 +01:00
parent 7453f8dd07
commit c0e78b56b1
3 changed files with 82 additions and 78 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/@types/global.d.ts vendored
View File

@ -23,6 +23,7 @@ import RebrandListener from "../RebrandListener";
import { RoomListStore2 } from "../stores/room-list/RoomListStore2"; import { RoomListStore2 } from "../stores/room-list/RoomListStore2";
import { PlatformPeg } from "../PlatformPeg"; import { PlatformPeg } from "../PlatformPeg";
import RoomListLayoutStore from "../stores/room-list/RoomListLayoutStore"; import RoomListLayoutStore from "../stores/room-list/RoomListLayoutStore";
import {IntegrationManagers} from "../integrations/IntegrationManagers";
declare global { declare global {
interface Window { interface Window {
@ -39,11 +40,12 @@ declare global {
mx_RoomListStore2: RoomListStore2; mx_RoomListStore2: RoomListStore2;
mx_RoomListLayoutStore: RoomListLayoutStore; mx_RoomListLayoutStore: RoomListLayoutStore;
mxPlatformPeg: PlatformPeg; mxPlatformPeg: PlatformPeg;
mxIntegrationManagers: typeof IntegrationManagers;
} }
// workaround for https://github.com/microsoft/TypeScript/issues/30933 // workaround for https://github.com/microsoft/TypeScript/issues/30933
interface ObjectConstructor { interface ObjectConstructor {
fromEntries?(xs: [string|number|symbol, any][]): object fromEntries?(xs: [string|number|symbol, any][]): object;
} }
interface Document { interface Document {

33
src/integrations/IntegrationManagerInstance.js → src/integrations/IntegrationManagerInstance.ts
View File

@ -14,32 +14,34 @@ See the License for the specific language governing permissions and
limitations under the License. limitations under the License.
*/ */
import type {Room} from "matrix-js-sdk/src/models/room";
import ScalarAuthClient from "../ScalarAuthClient"; import ScalarAuthClient from "../ScalarAuthClient";
import * as sdk from "../index";
import {dialogTermsInteractionCallback, TermsNotSignedError} from "../Terms"; import {dialogTermsInteractionCallback, TermsNotSignedError} from "../Terms";
import type {Room} from "matrix-js-sdk";
import Modal from '../Modal'; import Modal from '../Modal';
import url from 'url'; import url from 'url';
import SettingsStore from "../settings/SettingsStore"; import SettingsStore from "../settings/SettingsStore";
import IntegrationManager from "../components/views/settings/IntegrationManager";
import {IntegrationManagers} from "./IntegrationManagers"; import {IntegrationManagers} from "./IntegrationManagers";
export const KIND_ACCOUNT = "account"; export enum Kind {
export const KIND_CONFIG = "config"; Account = "account",
export const KIND_HOMESERVER = "homeserver"; Config = "config",
Homeserver = "homeserver",
}
export class IntegrationManagerInstance { export class IntegrationManagerInstance {
apiUrl: string; public readonly apiUrl: string;
uiUrl: string; public readonly uiUrl: string;
kind: string; public readonly kind: string;
id: string; // only applicable in some cases 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.kind = kind;
this.apiUrl = apiUrl; this.apiUrl = apiUrl;
this.uiUrl = uiUrl; this.uiUrl = uiUrl;
this.id = id;
// Per the spec: UI URL is optional.
if (!this.uiUrl) this.uiUrl = this.apiUrl;
} }
get name(): string { get name(): string {
@ -51,19 +53,18 @@ export class IntegrationManagerInstance {
const parsed = url.parse(this.apiUrl); const parsed = url.parse(this.apiUrl);
parsed.pathname = ''; parsed.pathname = '';
parsed.path = ''; parsed.path = '';
return parsed.format(); return url.format(parsed);
} }
getScalarClient(): ScalarAuthClient { getScalarClient(): ScalarAuthClient {
return new ScalarAuthClient(this.apiUrl, this.uiUrl); 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<void> {
if (!SettingsStore.getValue("integrationProvisioning")) { if (!SettingsStore.getValue("integrationProvisioning")) {
return IntegrationManagers.sharedInstance().showDisabledDialog(); return IntegrationManagers.sharedInstance().showDisabledDialog();
} }
const IntegrationManager = sdk.getComponent("views.settings.IntegrationManager");
const dialog = Modal.createTrackedDialog( const dialog = Modal.createTrackedDialog(
'Integration Manager', '', IntegrationManager, 'Integration Manager', '', IntegrationManager,
{loading: true}, 'mx_IntegrationManager', {loading: true}, 'mx_IntegrationManager',

123
src/integrations/IntegrationManagers.js → src/integrations/IntegrationManagers.ts
View File

@ -14,71 +14,77 @@ See the License for the specific language governing permissions and
limitations under the License. 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 SdkConfig from '../SdkConfig';
import * as sdk from "../index";
import Modal from '../Modal'; import Modal from '../Modal';
import {IntegrationManagerInstance, KIND_ACCOUNT, KIND_CONFIG, KIND_HOMESERVER} from "./IntegrationManagerInstance"; import {IntegrationManagerInstance, Kind} from "./IntegrationManagerInstance";
import type {MatrixClient, MatrixEvent, Room} from "matrix-js-sdk"; 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 WidgetUtils from "../utils/WidgetUtils";
import {MatrixClientPeg} from "../MatrixClientPeg"; import {MatrixClientPeg} from "../MatrixClientPeg";
import SettingsStore from "../settings/SettingsStore"; import SettingsStore from "../settings/SettingsStore";
import url from 'url';
const KIND_PREFERENCE = [ const KIND_PREFERENCE = [
// Ordered: first is most preferred, last is least preferred. // Ordered: first is most preferred, last is least preferred.
KIND_ACCOUNT, Kind.Account,
KIND_HOMESERVER, Kind.Homeserver,
KIND_CONFIG, Kind.Config,
]; ];
export class IntegrationManagers { export class IntegrationManagers {
static _instance; private static instance;
static sharedInstance(): IntegrationManagers { private managers: IntegrationManagerInstance[] = [];
if (!IntegrationManagers._instance) { private client: MatrixClient;
IntegrationManagers._instance = new IntegrationManagers(); 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() { constructor() {
this._compileManagers(); this.compileManagers();
} }
startWatching(): void { startWatching(): void {
this.stopWatching(); this.stopWatching();
this._client = MatrixClientPeg.get(); this.client = MatrixClientPeg.get();
this._client.on("accountData", this._onAccountData); this.client.on("accountData", this.onAccountData);
this._client.on("WellKnown.client", this._setupHomeserverManagers); this.client.on("WellKnown.client", this.setupHomeserverManagers);
this._compileManagers(); this.compileManagers();
} }
stopWatching(): void { stopWatching(): void {
if (!this._client) return; if (!this.client) return;
this._client.removeListener("accountData", this._onAccountData); this.client.removeListener("accountData", this.onAccountData);
this._client.removeListener("WellKnown.client", this._setupHomeserverManagers); this.client.removeListener("WellKnown.client", this.setupHomeserverManagers);
} }
_compileManagers() { private compileManagers() {
this._managers = []; this.managers = [];
this._setupConfiguredManager(); this.setupConfiguredManager();
this._setupAccountManagers(); this.setupAccountManagers();
} }
_setupConfiguredManager() { private setupConfiguredManager() {
const apiUrl = SdkConfig.get()['integrations_rest_url']; const apiUrl: string = SdkConfig.get()['integrations_rest_url'];
const uiUrl = SdkConfig.get()['integrations_ui_url']; const uiUrl: string = SdkConfig.get()['integrations_ui_url'];
if (apiUrl && uiUrl) { if (apiUrl && uiUrl) {
this._managers.push(new IntegrationManagerInstance(KIND_CONFIG, apiUrl, uiUrl)); this.managers.push(new IntegrationManagerInstance(Kind.Config, apiUrl, uiUrl));
this._primaryManager = null; // reset primary this.primaryManager = null; // reset primary
} }
} }
_setupHomeserverManagers = async (discoveryResponse) => { private setupHomeserverManagers = async (discoveryResponse) => {
console.log("Updating homeserver-configured integration managers..."); console.log("Updating homeserver-configured integration managers...");
if (discoveryResponse && discoveryResponse['m.integrations']) { if (discoveryResponse && discoveryResponse['m.integrations']) {
let managers = discoveryResponse['m.integrations']['managers']; let managers = discoveryResponse['m.integrations']['managers'];
@ -88,26 +94,26 @@ export class IntegrationManagers {
// Clear out any known managers for the homeserver // Clear out any known managers for the homeserver
// TODO: Log out of the scalar clients // 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 // Now add all the managers the homeserver wants us to have
for (const hsManager of managers) { for (const hsManager of managers) {
if (!hsManager["api_url"]) continue; if (!hsManager["api_url"]) continue;
this._managers.push(new IntegrationManagerInstance( this.managers.push(new IntegrationManagerInstance(
KIND_HOMESERVER, Kind.Homeserver,
hsManager["api_url"], hsManager["api_url"],
hsManager["ui_url"], // optional hsManager["ui_url"], // optional
)); ));
} }
this._primaryManager = null; // reset primary this.primaryManager = null; // reset primary
} else { } else {
console.log("Homeserver has no integration managers"); console.log("Homeserver has no integration managers");
} }
}; };
_setupAccountManagers() { private setupAccountManagers() {
if (!this._client || !this._client.getUserId()) return; // not logged in if (!this.client || !this.client.getUserId()) return; // not logged in
const widgets = WidgetUtils.getIntegrationManagerWidgets(); const widgets = WidgetUtils.getIntegrationManagerWidgets();
widgets.forEach(w => { widgets.forEach(w => {
const data = w.content['data']; const data = w.content['data'];
@ -117,30 +123,29 @@ export class IntegrationManagers {
const apiUrl = data['api_url']; const apiUrl = data['api_url'];
if (!apiUrl || !uiUrl) return; if (!apiUrl || !uiUrl) return;
const manager = new IntegrationManagerInstance(KIND_ACCOUNT, apiUrl, uiUrl); const manager = new IntegrationManagerInstance(Kind.Account, apiUrl, uiUrl, w['id'] || w['state_key'] || '');
manager.id = w['id'] || w['state_key'] || ''; this.managers.push(manager);
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') { if (ev.getType() === 'm.widgets') {
this._compileManagers(); this.compileManagers();
} }
}; };
hasManager(): boolean { hasManager(): boolean {
return this._managers.length > 0; return this.managers.length > 0;
} }
getOrderedManagers(): IntegrationManagerInstance[] { getOrderedManagers(): IntegrationManagerInstance[] {
const ordered = []; const ordered = [];
for (const kind of KIND_PREFERENCE) { 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 (!managers || !managers.length) continue;
if (kind === KIND_ACCOUNT) { if (kind === Kind.Account) {
// Order by state_keys (IDs) // Order by state_keys (IDs)
managers.sort((a, b) => a.id.localeCompare(b.id)); managers.sort((a, b) => a.id.localeCompare(b.id));
} }
@ -152,17 +157,16 @@ export class IntegrationManagers {
getPrimaryManager(): IntegrationManagerInstance { getPrimaryManager(): IntegrationManagerInstance {
if (this.hasManager()) { if (this.hasManager()) {
if (this._primaryManager) return this._primaryManager; if (this.primaryManager) return this.primaryManager;
this._primaryManager = this.getOrderedManagers()[0]; this.primaryManager = this.getOrderedManagers()[0];
return this._primaryManager; return this.primaryManager;
} else { } else {
return null; return null;
} }
} }
openNoManagerDialog(): void { openNoManagerDialog(): void {
const IntegrationsImpossibleDialog = sdk.getComponent("dialogs.IntegrationsImpossibleDialog");
Modal.createTrackedDialog('Integrations impossible', '', IntegrationsImpossibleDialog); Modal.createTrackedDialog('Integrations impossible', '', IntegrationsImpossibleDialog);
} }
@ -171,11 +175,10 @@ export class IntegrationManagers {
return this.showDisabledDialog(); return this.showDisabledDialog();
} }
if (this._managers.length === 0) { if (this.managers.length === 0) {
return this.openNoManagerDialog(); return this.openNoManagerDialog();
} }
const TabbedIntegrationManagerDialog = sdk.getComponent("views.dialogs.TabbedIntegrationManagerDialog");
Modal.createTrackedDialog( Modal.createTrackedDialog(
'Tabbed Integration Manager', '', TabbedIntegrationManagerDialog, 'Tabbed Integration Manager', '', TabbedIntegrationManagerDialog,
{room, screen, integrationId}, 'mx_TabbedIntegrationManagerDialog', {room, screen, integrationId}, 'mx_TabbedIntegrationManagerDialog',
@ -183,7 +186,6 @@ export class IntegrationManagers {
} }
showDisabledDialog(): void { showDisabledDialog(): void {
const IntegrationsDisabledDialog = sdk.getComponent("dialogs.IntegrationsDisabledDialog");
Modal.createTrackedDialog('Integrations disabled', '', IntegrationsDisabledDialog); Modal.createTrackedDialog('Integrations disabled', '', IntegrationsDisabledDialog);
} }
@ -202,15 +204,14 @@ export class IntegrationManagers {
* @returns {Promise<IntegrationManagerInstance>} Resolves to an integration manager instance, * @returns {Promise<IntegrationManagerInstance>} Resolves to an integration manager instance,
* or null if none was found. * or null if none was found.
*/ */
async tryDiscoverManager(domainName: string): IntegrationManagerInstance { async tryDiscoverManager(domainName: string): Promise<IntegrationManagerInstance> {
console.log("Looking up integration manager via .well-known"); console.log("Looking up integration manager via .well-known");
if (domainName.startsWith("http:") || domainName.startsWith("https:")) { if (domainName.startsWith("http:") || domainName.startsWith("https:")) {
// trim off the scheme and just use the domain // trim off the scheme and just use the domain
const url = url.parse(domainName); domainName = url.parse(domainName).host;
domainName = url.host;
} }
let wkConfig; let wkConfig: object;
try { try {
const result = await fetch(`https://${domainName}/.well-known/matrix/integrations`); const result = await fetch(`https://${domainName}/.well-known/matrix/integrations`);
wkConfig = await result.json(); wkConfig = await result.json();
@ -232,7 +233,7 @@ export class IntegrationManagers {
} }
// All discovered managers are per-user managers // 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)"); console.log("Got an integration manager (untested)");
// We don't test the manager because the caller may need to do extra // We don't test the manager because the caller may need to do extra
@ -244,4 +245,4 @@ export class IntegrationManagers {
} }
// For debugging // For debugging
global.mxIntegrationManagers = IntegrationManagers; window.mxIntegrationManagers = IntegrationManagers;