Merge branch 'develop' into kerry/fix/21997/map-thread-display

t3chguy · web-flow · commit b9ee1a350ca2 · 2022-05-03T09:50:14.000+01:00
diff --git a/.github/codecov.yml b/.github/codecov.yml
diff --git a/.github/workflows/sonarqube.yml b/.github/workflows/sonarqube.yml
@@ -0,0 +1,47 @@
+name: SonarQube
+on:
+  workflow_run:
+    workflows: [ "Tests" ]
+    types:
+      - completed
+jobs:
+  sonarqube:
+    name: SonarQube
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0  # Shallow clones should be disabled for a better relevancy of analysis
+
+      # There's a 'download artifact' action, but it hasn't been updated for the workflow_run action
+      # (https://github.com/actions/download-artifact/issues/60) so instead we get this mess:
+      - name: Download Coverage Report
+        uses: actions/github-script@v3.1.0
+        if: github.event.workflow_run.conclusion == 'success'
+        with:
+          script: |
+            const artifacts = await github.actions.listWorkflowRunArtifacts({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                run_id: ${{ github.event.workflow_run.id }},
+            });
+            const matchArtifact = artifacts.data.artifacts.filter((artifact) => {
+                return artifact.name == "coverage"
+            })[0];
+            const download = await github.actions.downloadArtifact({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                artifact_id: matchArtifact.id,
+                archive_format: 'zip',
+            });
+            const fs = require('fs');
+            fs.writeFileSync('${{github.workspace}}/coverage.zip', Buffer.from(download.data));
+      - name: Extract Coverage Report
+        run: unzip -d coverage coverage.zip && rm coverage.zip
+        if: github.event.workflow_run.conclusion == 'success'
+
+      - name: SonarCloud Scan
+        uses: SonarSource/sonarcloud-github-action@master
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}  # Needed to get PR information, if any
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
diff --git a/.github/workflows/static_analysis.yaml b/.github/workflows/static_analysis.yaml
@@ -87,16 +87,3 @@ jobs:
 
       - name: Run Linter
         run: "yarn run lint:style"
-
-  sonarqube:
-    name: "SonarQube"
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-        with:
-          fetch-depth: 0 # Shallow clones should be disabled for a better relevancy of analysis
-      - name: SonarCloud Scan
-        uses: SonarSource/sonarcloud-github-action@master
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -11,16 +11,11 @@ env:
   PR_NUMBER: ${{ github.event.pull_request.number }}
 jobs:
   jest:
-    name: Jest with Codecov
+    name: Jest
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
         uses: actions/checkout@v2
-        with:
-          # If this is a pull request, make sure we check out its head rather than the
-          # automatically generated merge commit, so that the coverage diff excludes
-          # unrelated changes in the base branch
-          ref: ${{ github.event_name == 'pull_request' && github.event.pull_request.head.sha || '' }}
 
       - name: Yarn cache
         uses: actions/setup-node@v3
@@ -31,11 +26,12 @@ jobs:
         run: "./scripts/ci/install-deps.sh --ignore-scripts"
 
       - name: Run tests with coverage
-        run: "yarn coverage"
+        run: "yarn coverage --ci"
 
-      - name: Upload coverage
-        uses: codecov/codecov-action@v2
+      - name: Upload Artifact
+        uses: actions/upload-artifact@v2
         with:
-          fail_ci_if_error: false
-          verbose: true
-          override_commit: ${{ github.event_name == 'pull_request' && github.event.pull_request.head.sha || '' }}
+          name: coverage
+          path: |
+            coverage
+            !coverage/lcov-report
diff --git a/package.json b/package.json
@@ -184,6 +184,7 @@
     "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": "^1.2.3",
     "matrix-react-test-utils": "^0.2.3",
     "matrix-web-i18n": "^1.2.0",
@@ -233,9 +234,14 @@
       "<rootDir>/src/**/*.{js,ts,tsx}"
     ],
     "coverageReporters": [
-      "text",
-      "json"
-    ]
+      "text-summary",
+      "lcov"
+    ],
+    "testResultsProcessor": "jest-sonar-reporter"
+  },
+  "jestSonar": {
+    "reportPath": "coverage",
+    "sonar56x": true
   },
   "typings": "./lib/index.d.ts"
 }
diff --git a/sonar-project.properties b/sonar-project.properties
@@ -14,3 +14,9 @@ sonar.organization=matrix-org
 sonar.sources=src,res
 sonar.tests=test,cypress
 sonar.exclusions=__mocks__,docs
+
+sonar.typescript.tsconfigPath=./tsconfig.json
+sonar.javascript.lcov.reportPaths=coverage/lcov.info
+sonar.coverage.exclusions=spec/*.ts
+sonar.testExecutionReportPaths=coverage/test-report.xml
+sonar.genericcoverage.unitTestReportPaths=coverage/test-report.xml
diff --git a/src/components/views/location/Map.tsx b/src/components/views/location/Map.tsx
@@ -51,8 +51,8 @@ const useMapWithStyle = ({ id, centerGeoUri, onError, interactive, bounds }) =>
             try {
                 const coords = parseGeoUri(centerGeoUri);
                 map.setCenter({ lon: coords.longitude, lat: coords.latitude });
-            } catch (error) {
-                logger.error('Could not set map center', centerGeoUri);
+            } catch (_error) {
+                logger.error('Could not set map center');
             }
         }
     }, [map, centerGeoUri]);
@@ -65,8 +65,8 @@ const useMapWithStyle = ({ id, centerGeoUri, onError, interactive, bounds }) =>
                     [bounds.east, bounds.north],
                 );
                 map.fitBounds(lngLatBounds, { padding: 100, maxZoom: 15 });
-            } catch (error) {
-                logger.error('Invalid map bounds', error);
+            } catch (_error) {
+                logger.error('Invalid map bounds');
             }
         }
     }, [map, bounds]);
diff --git a/src/linkify-matrix.ts b/src/linkify-matrix.ts
@@ -225,6 +225,8 @@ export const options = {
         rel: 'noreferrer noopener',
     },
 
+    ignoreTags: ['pre', 'code'],
+
     className: 'linkified',
 
     target: function(href: string, type: Type | string): string {
diff --git a/test/components/stub-component.js b/test/components/stub-component.js
diff --git a/test/components/views/dialogs/ForwardDialog-test.tsx b/test/components/views/dialogs/ForwardDialog-test.tsx
@@ -17,32 +17,59 @@ limitations under the License.
 import React from "react";
 import { mount } from "enzyme";
 import { act } from "react-dom/test-utils";
+import { MatrixEvent, EventType } from "matrix-js-sdk/src/matrix";
 
-import * as TestUtils from "../../../test-utils";
 import { MatrixClientPeg } from "../../../../src/MatrixClientPeg";
+import ForwardDialog from "../../../../src/components/views/dialogs/ForwardDialog";
 import DMRoomMap from "../../../../src/utils/DMRoomMap";
 import { RoomPermalinkCreator } from "../../../../src/utils/permalinks/Permalinks";
-import ForwardDialog from "../../../../src/components/views/dialogs/ForwardDialog";
+import {
+    getMockClientWithEventEmitter,
+    mkEvent,
+    mkMessage,
+    mkStubRoom,
+} from "../../../test-utils";
 
 describe("ForwardDialog", () => {
     const sourceRoom = "!111111111111111111:example.org";
-    const defaultMessage = TestUtils.mkMessage({
+    const aliceId = "@alice:example.org";
+    const defaultMessage = mkMessage({
         room: sourceRoom,
-        user: "@alice:example.org",
+        user: aliceId,
         msg: "Hello world!",
         event: true,
     });
-    const defaultRooms = ["a", "A", "b"].map(name => TestUtils.mkStubRoom(name, name));
+    const accountDataEvent = new MatrixEvent({
+        type: EventType.Direct,
+        sender: aliceId,
+        content: {},
+    });
+    const mockClient = getMockClientWithEventEmitter({
+        getUserId: jest.fn().mockReturnValue(aliceId),
+        isGuest: jest.fn().mockReturnValue(false),
+        getVisibleRooms: jest.fn().mockReturnValue([]),
+        getRoom: jest.fn(),
+        getAccountData: jest.fn().mockReturnValue(accountDataEvent),
+        getPushActionsForEvent: jest.fn(),
+        mxcUrlToHttp: jest.fn().mockReturnValue(''),
+        isRoomEncrypted: jest.fn().mockReturnValue(false),
+        getProfileInfo: jest.fn().mockResolvedValue({
+            displayname: 'Alice',
+        }),
+        decryptEventIfNeeded: jest.fn(),
+        sendEvent: jest.fn(),
+    });
+    const defaultRooms = ["a", "A", "b"].map(name => mkStubRoom(name, name, mockClient));
 
     const mountForwardDialog = async (message = defaultMessage, rooms = defaultRooms) => {
-        const client = MatrixClientPeg.get();
-        client.getVisibleRooms = jest.fn().mockReturnValue(rooms);
+        mockClient.getVisibleRooms.mockReturnValue(rooms);
+        mockClient.getRoom.mockImplementation(roomId => rooms.find(room => room.roomId === roomId));
 
         let wrapper;
         await act(async () => {
             wrapper = mount(
                 <ForwardDialog
-                    matrixClient={client}
+                    matrixClient={mockClient}
                     event={message}
                     permalinkCreator={new RoomPermalinkCreator(undefined, sourceRoom)}
                     onFinished={jest.fn()}
@@ -57,9 +84,14 @@ describe("ForwardDialog", () => {
     };
 
     beforeEach(() => {
-        TestUtils.stubClient();
         DMRoomMap.makeShared();
-        MatrixClientPeg.get().getUserId = jest.fn().mockReturnValue("@bob:example.org");
+        jest.clearAllMocks();
+        mockClient.getUserId.mockReturnValue("@bob:example.org");
+        mockClient.sendEvent.mockReset();
+    });
+
+    afterAll(() => {
+        jest.spyOn(MatrixClientPeg, 'get').mockRestore();
     });
 
     it("shows a preview with us as the sender", async () => {
@@ -91,7 +123,7 @@ describe("ForwardDialog", () => {
         // Make sendEvent require manual resolution so we can see the sending state
         let finishSend;
         let cancelSend;
-        MatrixClientPeg.get().sendEvent = jest.fn(() => new Promise((resolve, reject) => {
+        mockClient.sendEvent.mockImplementation(() => new Promise((resolve, reject) => {
             finishSend = resolve;
             cancelSend = reject;
         }));
@@ -135,7 +167,7 @@ describe("ForwardDialog", () => {
     });
 
     it("can render replies", async () => {
-        const replyMessage = TestUtils.mkEvent({
+        const replyMessage = mkEvent({
             type: "m.room.message",
             room: "!111111111111111111:example.org",
             user: "@alice:example.org",
@@ -156,9 +188,9 @@ describe("ForwardDialog", () => {
     });
 
     it("disables buttons for rooms without send permissions", async () => {
-        const readOnlyRoom = TestUtils.mkStubRoom("a", "a");
+        const readOnlyRoom = mkStubRoom("a", "a", mockClient);
         readOnlyRoom.maySendMessage = jest.fn().mockReturnValue(false);
-        const rooms = [readOnlyRoom, TestUtils.mkStubRoom("b", "b")];
+        const rooms = [readOnlyRoom, mkStubRoom("b", "b", mockClient)];
 
         const wrapper = await mountForwardDialog(undefined, rooms);
 
diff --git a/test/components/views/location/Map-test.tsx b/test/components/views/location/Map-test.tsx
@@ -101,7 +101,7 @@ describe('<Map />', () => {
             const logSpy = jest.spyOn(logger, 'error').mockImplementation();
             getComponent({ centerGeoUri: '123 Sesame Street' });
             expect(mockMap.setCenter).not.toHaveBeenCalled();
-            expect(logSpy).toHaveBeenCalledWith('Could not set map center', '123 Sesame Street');
+            expect(logSpy).toHaveBeenCalledWith('Could not set map center');
         });
 
         it('updates map center when centerGeoUri prop changes', () => {
@@ -133,7 +133,7 @@ describe('<Map />', () => {
             const bounds = { north: 'a', south: 'b', east: 42, west: 41 };
             getComponent({ bounds });
             expect(mockMap.fitBounds).not.toHaveBeenCalled();
-            expect(logSpy).toHaveBeenCalledWith('Invalid map bounds', new Error('Invalid LngLat object: (41, NaN)'));
+            expect(logSpy).toHaveBeenCalledWith('Invalid map bounds');
         });
 
         it('updates map bounds when bounds prop changes', () => {
diff --git a/test/components/views/messages/TextualBody-test.tsx b/test/components/views/messages/TextualBody-test.tsx
@@ -216,6 +216,26 @@ describe("<TextualBody />", () => {
                 '</span></span></span>');
         });
 
+        it("linkification is not applied to code blocks", () => {
+            const ev = mkEvent({
+                type: "m.room.message",
+                room: "room_id",
+                user: "sender",
+                content: {
+                    body: "Visit `https://matrix.org/`\n```\nhttps://matrix.org/\n```",
+                    msgtype: "m.text",
+                    format: "org.matrix.custom.html",
+                    formatted_body: "<p>Visit <code>https://matrix.org/</code></p>\n<pre>https://matrix.org/\n</pre>\n",
+                },
+                event: true,
+            });
+
+            const wrapper = getComponent({ mxEvent: ev }, matrixClient);
+            expect(wrapper.text()).toBe("Visit https://matrix.org/\n1https://matrix.org/\n\n");
+            const content = wrapper.find(".mx_EventTile_body");
+            expect(content.html()).toMatchSnapshot();
+        });
+
         // If pills were rendered within a Portal/same shadow DOM then it'd be easier to test
         it("pills get injected correctly into the DOM", () => {
             const ev = mkEvent({
diff --git a/test/components/views/messages/__snapshots__/TextualBody-test.tsx.snap b/test/components/views/messages/__snapshots__/TextualBody-test.tsx.snap
@@ -1,5 +1,12 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
+exports[`<TextualBody /> renders formatted m.text correctly linkification is not applied to code blocks 1`] = `
+"<span class=\\"mx_EventTile_body markdown-body\\" dir=\\"auto\\"><p>Visit <code>https://matrix.org/</code></p>
+<div class=\\"mx_EventTile_pre_container\\"><pre class=\\"mx_EventTile_collapsedCodeBlock\\"><span class=\\"mx_EventTile_lineNumbers\\"><span>1</span></span><code>https://matrix.org/
+</code><span></span></pre><span class=\\"mx_EventTile_button mx_EventTile_copyButton \\"></span></div>
+</span>"
+`;
+
 exports[`<TextualBody /> renders formatted m.text correctly pills do not appear in code blocks 1`] = `
 "<span class=\\"mx_EventTile_body markdown-body\\" dir=\\"auto\\"><p><code>@room</code></p>
 <div class=\\"mx_EventTile_pre_container\\"><pre class=\\"mx_EventTile_collapsedCodeBlock\\"><span class=\\"mx_EventTile_lineNumbers\\"><span>1</span></span><code>@room
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -51,8 +51,8 @@ const useMapWithStyle = ({ id, centerGeoUri, onError, interactive, bounds }) =>`
`51`	`51`	`try {`
`52`	`52`	`const coords = parseGeoUri(centerGeoUri);`
`53`	`53`	`map.setCenter({ lon: coords.longitude, lat: coords.latitude });`
`54`		`- } catch (error) {`
`55`		`- logger.error('Could not set map center', centerGeoUri);`
	`54`	`+ } catch (_error) {`
	`55`	`+ logger.error('Could not set map center');`
`56`	`56`	`}`
`57`	`57`	`}`
`58`	`58`	`}, [map, centerGeoUri]);`
`@@ -65,8 +65,8 @@ const useMapWithStyle = ({ id, centerGeoUri, onError, interactive, bounds }) =>`
`65`	`65`	`[bounds.east, bounds.north],`
`66`	`66`	`);`
`67`	`67`	`map.fitBounds(lngLatBounds, { padding: 100, maxZoom: 15 });`
`68`		`- } catch (error) {`
`69`		`- logger.error('Invalid map bounds', error);`
	`68`	`+ } catch (_error) {`
	`69`	`+ logger.error('Invalid map bounds');`
`70`	`70`	`}`
`71`	`71`	`}`
`72`	`72`	`}, [map, bounds]);`