Remove GoNEB migrator (#867)

* Remove GoNEB migrator. * changelog * Remove frontend pieces * Remove unused statuscodes * Linting * Remove warning about ts-comment
matrix-org · Dec 28, 2023 · 76a4209 · 76a4209
1 parent 67dfa44
commit 76a4209
Show file tree

Hide file tree

Showing 9 changed files with 8 additions and 327 deletions.
diff --git a/changelog.d/867.removal b/changelog.d/867.removal
@@ -0,0 +1 @@
+The GoNEB migrator is being removed in this release. Users wishing to migrate from GoNEB deployments should use <=5.0.0 and then upgrade.
diff --git a/src/Connections/GitlabRepo.ts b/src/Connections/GitlabRepo.ts
@@ -1,5 +1,3 @@
-// We need to instantiate some functions which are not directly called, which confuses typescript.
-/* eslint-disable @typescript-eslint/ban-ts-comment */
 import { UserTokenStore } from "../UserTokenStore";
 import { Appservice, Intent, StateEvent } from "matrix-bot-sdk";
 import { BotCommands, botCommand, compileBotCommands } from "../BotCommands";
@@ -752,7 +750,7 @@ ${data.description}`;
         let relation;
         const discussionWithThread = result.discussions.find(discussionId => this.discussionThreads.has(discussionId));
         if (discussionWithThread) {
-            const threadEventId = await this.discussionThreads.get(discussionWithThread)!.catch(_ => { /* already logged */ });
+            const threadEventId = await this.discussionThreads.get(discussionWithThread)?.catch(() => { /* already logged */ });
             if (threadEventId) {
                 relation = {
                     "m.relates_to": {
@@ -948,7 +946,7 @@ ${data.description}`;
     private async persistDiscussionThreads(): Promise<void> {
         const serialized: SerializedGitlabDiscussionThreads = [];
         for (const [discussionId, eventIdPromise] of this.discussionThreads.entriesAscending()) {
-            const eventId = await eventIdPromise.catch(_ => { /* logged elsewhere */ });
+            const eventId = await eventIdPromise.catch(() => { /* logged elsewhere */ });
             if (eventId) {
                 serialized.push({ discussionId, eventId });
             }

diff --git a/src/Widgets/BridgeWidgetApi.ts b/src/Widgets/BridgeWidgetApi.ts
@@ -10,16 +10,12 @@ import { ConnectionManager } from "../ConnectionManager";
 import BotUsersManager, {BotUser} from "../Managers/BotUsersManager";
 import { assertUserPermissionsInRoom, GetConnectionsResponseItem } from "../provisioning/api";
 import { Appservice, PowerLevelsEvent } from "matrix-bot-sdk";
-import { GoNebMigrator } from "./GoNebMigrator";
-import { StatusCodes } from "http-status-codes";
 import { GithubInstance } from '../github/GithubInstance';
 import { AllowedTokenTypes, TokenType, UserTokenStore } from '../UserTokenStore';
 
 const log = new Logger("BridgeWidgetApi");
 
 export class BridgeWidgetApi extends ProvisioningApi {
-    private readonly goNebMigrator?: GoNebMigrator;
-
     constructor(
         private adminRooms: Map<string, AdminRoom>,
         private readonly config: BridgeConfig,
@@ -60,45 +56,6 @@ export class BridgeWidgetApi extends ProvisioningApi {
         this.addRoute('get', '/v1/service/:service/auth', wrapHandler(this.getAuth));
         this.addRoute('get', '/v1/service/:service/auth/:state', wrapHandler(this.getAuthPoll));
         this.addRoute('post', '/v1/service/:service/auth/logout', wrapHandler(this.postAuthLogout));
-        this.baseRoute.use((err: unknown, _req: Express.Request, _res: Express.Response, _next: NextFunction) => {
-            // Needed until https://github.com/matrix-org/matrix-appservice-bridge/pull/465 lands.
-            // eslint-disable-next-line @typescript-eslint/no-explicit-any
-            (this as any).onError(err, _req, _res, _next);
-        });
-
-        if (this.config.goNebMigrator) {
-            this.goNebMigrator = new GoNebMigrator(
-                this.config.goNebMigrator.apiUrl,
-                this.config.goNebMigrator.serviceIds,
-                this.config.goNebMigrator.goNebBotPrefix,
-            );
-        }
-
-        this.addRoute("get", "/v1/:roomId/goNebConnections", wrapHandler(this.getGoNebConnections));
-    }
-
-    private async getGoNebConnections(req: ProvisioningRequest, res: Response) {
-        if (!this.goNebMigrator) {
-            res.status(StatusCodes.NO_CONTENT).send();
-            return;
-        }
-
-        const roomId = req.params.roomId;
-
-        if (!req.userId) {
-            throw Error('Cannot get connections without a valid userId');
-        }
-
-        const botUser = await this.getBotUserInRoom(roomId);
-        await assertUserPermissionsInRoom(req.userId, roomId, "read", botUser.intent);
-
-        const userIds = this.goNebMigrator.getGoNebUsersFromRoomMembers(
-            await botUser.intent.underlyingClient.getJoinedRoomMembers(roomId)
-        );
-
-        const connections = await this.goNebMigrator.getConnectionsForRoom(roomId, new Set(userIds));
-
-        res.send(connections);
     }
 
     private async getBotUserInRoom(roomId: string, serviceType?: string): Promise<BotUser> {

diff --git a/src/Widgets/GoNebMigrator.ts b/src/Widgets/GoNebMigrator.ts
diff --git a/src/config/Config.ts b/src/config/Config.ts
@@ -446,12 +446,6 @@ export interface BridgeConfigMetrics {
     port?: number;
 }
 
-export interface BridgeConfigGoNebMigrator {
-    apiUrl: string;
-    serviceIds?: string[];
-    goNebBotPrefix?: string;
-}
-
 export interface BridgeConfigSentry {
     dsn: string;
     environment?: string;
@@ -477,7 +471,6 @@ export interface BridgeConfigRoot {
     widgets?: BridgeWidgetConfigYAML;
     metrics?: BridgeConfigMetrics;
     listeners?: BridgeConfigListener[];
-    goNebMigrator?: BridgeConfigGoNebMigrator;
     sentry?: BridgeConfigSentry;
 }
 
@@ -531,9 +524,6 @@ export class BridgeConfig {
  'resources' may be any of ${ResourceTypeArray.join(', ')}`)
     public readonly listeners: BridgeConfigListener[];
 
-    @configKey("go-neb migrator configuration", true)
-    public readonly goNebMigrator?: BridgeConfigGoNebMigrator;
-
     @configKey("Configure Sentry error reporting", true)
     public readonly sentry?: BridgeConfigSentry;
 
@@ -603,7 +593,9 @@ export class BridgeConfig {
             this.queue.port = env?.CFG_QUEUE_POST ? parseInt(env?.CFG_QUEUE_POST, 10) : undefined;
         }
 
-        this.goNebMigrator = configData.goNebMigrator;
+        if ('goNebMigrator' in configData) {
+            log.warn(`The GoNEB migrator has been removed from this release. You should remove the 'goNebMigrator' from your config.`);
+        }
 
         // Listeners is a bit special
         this.listeners = configData.listeners || [];

diff --git a/web/BridgeAPI.ts b/web/BridgeAPI.ts
@@ -130,10 +130,6 @@ export class BridgeAPI {
         return this.request('GET', `/widgetapi/v1/${encodeURIComponent(roomId)}/connections`);
     }
 
-    async getGoNebConnectionsForRoom(roomId: string): Promise<any|undefined> {
-        return this.request('GET', `/widgetapi/v1/${encodeURIComponent(roomId)}/goNebConnections`);
-    }
-
     async getConnectionsForService<T extends GetConnectionsResponseItem >(roomId: string, service: string): Promise<GetConnectionsForServiceResponse<T>> {
         return this.request('GET', `/widgetapi/v1/${encodeURIComponent(roomId)}/connections/${encodeURIComponent(service)}`);
     }

diff --git a/web/components/roomConfig/FeedsConfig.tsx b/web/components/roomConfig/FeedsConfig.tsx
@@ -1,5 +1,5 @@
 import { FunctionComponent, createRef } from "preact";
-import { useCallback, useEffect, useState } from "preact/hooks"
+import { useCallback, useState } from "preact/hooks"
 import { BridgeConfig } from "../../BridgeAPI";
 import { FeedConnectionState, FeedResponseItem } from "../../../src/Connections/FeedConnection";
 import { ConnectionConfigurationProps, IRoomConfigText, RoomConfig } from "./RoomConfig";
@@ -93,20 +93,6 @@ const roomConfigText: IRoomConfigText = {
 const RoomConfigListItemFunc = (c: FeedResponseItem) => c.config.label || c.config.url;
 
 export const FeedsConfig: BridgeConfig = ({ api, roomId, showHeader }) => {
-    const [ goNebConnections, setGoNebConnections ] = useState(undefined);
-
-    useEffect(() => {
-        api.getGoNebConnectionsForRoom(roomId).then((res: any) => {
-            if (!res) return;
-            setGoNebConnections(res.feeds.map((config: any) => ({
-                config,
-            })));
-        }).catch(ex => {
-            console.warn("Failed to fetch go neb connections", ex);
-        });
-    }, [api, roomId]);
-
-    const compareConnections = useCallback((goNebConnection: FeedResponseItem, nativeConnection: FeedResponseItem) => goNebConnection.config.url === nativeConnection.config.url, []);
 
     return <RoomConfig<ServiceConfig, FeedResponseItem, FeedConnectionState>
         headerImg={FeedsIcon}
@@ -118,7 +104,5 @@ export const FeedsConfig: BridgeConfig = ({ api, roomId, showHeader }) => {
         text={roomConfigText}
         listItemName={RoomConfigListItemFunc}
         connectionConfigComponent={ConnectionConfiguration}
-        migrationCandidates={goNebConnections}
-        migrationComparator={compareConnections}
     />;
 };
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		The GoNEB migrator is being removed in this release. Users wishing to migrate from GoNEB deployments should use <=5.0.0 and then upgrade.