Move from browser-request to fetch (#9345)

matrix-org · Oct 12, 2022 · 8b54be6 · 8b54be6
1 parent ae883bb
commit 8b54be6
Show file tree

Hide file tree

Showing 50 changed files with 1,464 additions and 597 deletions.
diff --git a/__mocks__/browser-request.js b/__mocks__/browser-request.js
diff --git a/cypress/e2e/spotlight/spotlight.spec.ts b/cypress/e2e/spotlight/spotlight.spec.ts
@@ -124,7 +124,8 @@ Cypress.Commands.add("startDM", (name: string) => {
     cy.get(".mx_BasicMessageComposer_input")
         .should("have.focus")
         .type("Hey!{enter}");
-    cy.contains(".mx_EventTile_body", "Hey!");
+    // The DM room is created at this point, this can take a little bit of time
+    cy.contains(".mx_EventTile_body", "Hey!", { timeout: 30000 });
     cy.contains(".mx_RoomSublist[aria-label=People]", name);
 });
 
@@ -217,7 +218,7 @@ describe("Spotlight", () => {
     it("should find joined rooms", () => {
         cy.openSpotlightDialog().within(() => {
             cy.spotlightSearch().clear().type(room1Name);
-            cy.wait(1000); // wait for the dialog code to settle
+            cy.wait(3000); // wait for the dialog code to settle
             cy.spotlightResults().should("have.length", 1);
             cy.spotlightResults().eq(0).should("contain", room1Name);
             cy.spotlightResults().eq(0).click();
@@ -231,7 +232,7 @@ describe("Spotlight", () => {
         cy.openSpotlightDialog().within(() => {
             cy.spotlightFilter(Filter.PublicRooms);
             cy.spotlightSearch().clear().type(room1Name);
-            cy.wait(1000); // wait for the dialog code to settle
+            cy.wait(3000); // wait for the dialog code to settle
             cy.spotlightResults().should("have.length", 1);
             cy.spotlightResults().eq(0).should("contain", room1Name);
             cy.spotlightResults().eq(0).should("contain", "View");
@@ -246,7 +247,7 @@ describe("Spotlight", () => {
         cy.openSpotlightDialog().within(() => {
             cy.spotlightFilter(Filter.PublicRooms);
             cy.spotlightSearch().clear().type(room2Name);
-            cy.wait(1000); // wait for the dialog code to settle
+            cy.wait(3000); // wait for the dialog code to settle
             cy.spotlightResults().should("have.length", 1);
             cy.spotlightResults().eq(0).should("contain", room2Name);
             cy.spotlightResults().eq(0).should("contain", "Join");
@@ -262,7 +263,7 @@ describe("Spotlight", () => {
         cy.openSpotlightDialog().within(() => {
             cy.spotlightFilter(Filter.PublicRooms);
             cy.spotlightSearch().clear().type(room3Name);
-            cy.wait(1000); // wait for the dialog code to settle
+            cy.wait(3000); // wait for the dialog code to settle
             cy.spotlightResults().should("have.length", 1);
             cy.spotlightResults().eq(0).should("contain", room3Name);
             cy.spotlightResults().eq(0).should("contain", "View");
@@ -301,7 +302,7 @@ describe("Spotlight", () => {
         cy.openSpotlightDialog().within(() => {
             cy.spotlightFilter(Filter.People);
             cy.spotlightSearch().clear().type(bot1Name);
-            cy.wait(1000); // wait for the dialog code to settle
+            cy.wait(3000); // wait for the dialog code to settle
             cy.spotlightResults().should("have.length", 1);
             cy.spotlightResults().eq(0).should("contain", bot1Name);
             cy.spotlightResults().eq(0).click();
@@ -314,7 +315,7 @@ describe("Spotlight", () => {
         cy.openSpotlightDialog().within(() => {
             cy.spotlightFilter(Filter.People);
             cy.spotlightSearch().clear().type(bot2Name);
-            cy.wait(1000); // wait for the dialog code to settle
+            cy.wait(3000); // wait for the dialog code to settle
             cy.spotlightResults().should("have.length", 1);
             cy.spotlightResults().eq(0).should("contain", bot2Name);
             cy.spotlightResults().eq(0).click();
@@ -331,7 +332,7 @@ describe("Spotlight", () => {
         cy.openSpotlightDialog().within(() => {
             cy.spotlightFilter(Filter.People);
             cy.spotlightSearch().clear().type(bot2Name);
-            cy.wait(1000); // wait for the dialog code to settle
+            cy.wait(3000); // wait for the dialog code to settle
             cy.spotlightResults().should("have.length", 1);
             cy.spotlightResults().eq(0).should("contain", bot2Name);
             cy.spotlightResults().eq(0).click();
@@ -345,7 +346,7 @@ describe("Spotlight", () => {
             .type("Hey!{enter}");
 
         // Assert DM exists by checking for the first message and the room being in the room list
-        cy.contains(".mx_EventTile_body", "Hey!");
+        cy.contains(".mx_EventTile_body", "Hey!", { timeout: 30000 });
         cy.get(".mx_RoomSublist[aria-label=People]").should("contain", bot2Name);
 
         // Invite BotBob into existing DM with ByteBot
@@ -409,7 +410,7 @@ describe("Spotlight", () => {
         cy.openSpotlightDialog().within(() => {
             cy.spotlightFilter(Filter.People);
             cy.spotlightSearch().clear().type(bot2Name);
-            cy.wait(1000); // wait for the dialog code to settle
+            cy.wait(3000); // wait for the dialog code to settle
             cy.spotlightResults().should("have.length", 1);
             cy.spotlightResults().eq(0).should("contain", bot2Name);
             cy.get(".mx_SpotlightDialog_startGroupChat").should("contain", "Start a group chat");
@@ -431,7 +432,7 @@ describe("Spotlight", () => {
         cy.openSpotlightDialog().within(() => {
             cy.spotlightFilter(Filter.People);
             cy.spotlightSearch().clear().type(bot1Name);
-            cy.wait(1000); // wait for the dialog code to settle
+            cy.wait(3000); // wait for the dialog code to settle
             cy.get(".mx_Spinner").should("not.exist");
             cy.spotlightResults().should("have.length", 1);
         });

diff --git a/cypress/e2e/timeline/timeline.spec.ts b/cypress/e2e/timeline/timeline.spec.ts
@@ -91,11 +91,11 @@ describe("Timeline", () => {
 
     describe("useOnlyCurrentProfiles", () => {
         beforeEach(() => {
-            cy.uploadContent(OLD_AVATAR).then((url) => {
+            cy.uploadContent(OLD_AVATAR).then(({ content_uri: url }) => {
                 oldAvatarUrl = url;
                 cy.setAvatarUrl(url);
             });
-            cy.uploadContent(NEW_AVATAR).then((url) => {
+            cy.uploadContent(NEW_AVATAR).then(({ content_uri: url }) => {
                 newAvatarUrl = url;
             });
         });
@@ -271,7 +271,7 @@ describe("Timeline", () => {
             cy.get(".mx_RoomHeader_searchButton").click();
             cy.get(".mx_SearchBar_input input").type("Message{enter}");
 
-            cy.get(".mx_EventTile:not(.mx_EventTile_contextual)").find(".mx_EventTile_searchHighlight").should("exist");
+            cy.get(".mx_EventTile:not(.mx_EventTile_contextual) .mx_EventTile_searchHighlight").should("exist");
             cy.get(".mx_RoomView_searchResultsPanel").percySnapshotElement("Highlighted search results");
         });
 

diff --git a/cypress/support/bot.ts b/cypress/support/bot.ts
@@ -16,8 +16,6 @@ limitations under the License.
 
 /// <reference types="cypress" />
 
-import request from "browser-request";
-
 import type { ISendEventResponse, MatrixClient, Room } from "matrix-js-sdk/src/matrix";
 import { SynapseInstance } from "../plugins/synapsedocker";
 import Chainable = Cypress.Chainable;
@@ -86,7 +84,6 @@ Cypress.Commands.add("getBot", (synapse: SynapseInstance, opts: CreateBotOpts):
                 userId: credentials.userId,
                 deviceId: credentials.deviceId,
                 accessToken: credentials.accessToken,
-                request,
                 store: new win.matrixcs.MemoryStore(),
                 scheduler: new win.matrixcs.MatrixScheduler(),
                 cryptoStore: new win.matrixcs.MemoryCryptoStore(),

diff --git a/cypress/support/client.ts b/cypress/support/client.ts
@@ -16,9 +16,8 @@ limitations under the License.
 
 /// <reference types="cypress" />
 
-import type { FileType, UploadContentResponseType } from "matrix-js-sdk/src/http-api";
-import type { IAbortablePromise } from "matrix-js-sdk/src/@types/partials";
-import type { ICreateRoomOpts, ISendEventResponse, IUploadOpts } from "matrix-js-sdk/src/@types/requests";
+import type { FileType, Upload, UploadOpts } from "matrix-js-sdk/src/http-api";
+import type { ICreateRoomOpts, ISendEventResponse } from "matrix-js-sdk/src/@types/requests";
 import type { MatrixClient } from "matrix-js-sdk/src/client";
 import type { Room } from "matrix-js-sdk/src/models/room";
 import type { IContent } from "matrix-js-sdk/src/models/event";
@@ -90,10 +89,10 @@ declare global {
              *   can be sent to XMLHttpRequest.send (typically a File).  Under node.js,
              *   a a Buffer, String or ReadStream.
              */
-            uploadContent<O extends IUploadOpts>(
+            uploadContent(
                 file: FileType,
-                opts?: O,
-            ): IAbortablePromise<UploadContentResponseType<O>>;
+                opts?: UploadOpts,
+            ): Chainable<Awaited<Upload["promise"]>>;
             /**
              * Turn an MXC URL into an HTTP one. <strong>This method is experimental and
              * may change.</strong>
@@ -203,9 +202,9 @@ Cypress.Commands.add("setDisplayName", (name: string): Chainable<{}> => {
     });
 });
 
-Cypress.Commands.add("uploadContent", (file: FileType): Chainable<{}> => {
+Cypress.Commands.add("uploadContent", (file: FileType, opts?: UploadOpts): Chainable<Awaited<Upload["promise"]>> => {
     return cy.getClient().then(async (cli: MatrixClient) => {
-        return cli.uploadContent(file);
+        return cli.uploadContent(file, opts);
     });
 });
 

diff --git a/package.json b/package.json
@@ -65,7 +65,6 @@
     "@types/ua-parser-js": "^0.7.36",
     "await-lock": "^2.1.0",
     "blurhash": "^1.1.3",
-    "browser-request": "^0.3.3",
     "cheerio": "^1.0.0-rc.9",
     "classnames": "^2.2.6",
     "commonmark": "^0.29.3",
@@ -190,16 +189,16 @@
     "eslint-plugin-matrix-org": "^0.6.1",
     "eslint-plugin-react": "^7.28.0",
     "eslint-plugin-react-hooks": "^4.3.0",
+    "fetch-mock-jest": "^1.5.1",
     "fs-extra": "^10.0.1",
     "glob": "^7.1.6",
     "jest": "^27.4.0",
     "jest-canvas-mock": "^2.3.0",
     "jest-environment-jsdom": "^27.0.6",
-    "jest-fetch-mock": "^3.0.3",
     "jest-mock": "^27.5.1",
     "jest-raw-loader": "^1.0.1",
     "jest-sonar-reporter": "^2.0.0",
-    "matrix-mock-request": "^2.0.0",
+    "matrix-mock-request": "^2.5.0",
     "matrix-react-test-utils": "^0.2.3",
     "matrix-web-i18n": "^1.3.0",
     "postcss-scss": "^4.0.4",

diff --git a/src/AddThreepid.ts b/src/AddThreepid.ts
@@ -85,7 +85,7 @@ export default class AddThreepid {
             const identityAccessToken = await authClient.getAccessToken();
             return MatrixClientPeg.get().requestEmailToken(
                 emailAddress, this.clientSecret, 1,
-                undefined, undefined, identityAccessToken,
+                undefined, identityAccessToken,
             ).then((res) => {
                 this.sessionId = res.sid;
                 return res;
@@ -142,7 +142,7 @@ export default class AddThreepid {
             const identityAccessToken = await authClient.getAccessToken();
             return MatrixClientPeg.get().requestMsisdnToken(
                 phoneCountry, phoneNumber, this.clientSecret, 1,
-                undefined, undefined, identityAccessToken,
+                undefined, identityAccessToken,
             ).then((res) => {
                 this.sessionId = res.sid;
                 return res;