PrivateCoffee/element-web
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 3

Fix export type "Current timeline" to match its behaviour to its name (#11426)

Browse source 
* Fix export type "Current timeline" to match its behaviour to its name

* Iterate tests
This commit is contained in:
Michael Telatynski 2023-08-18 12:58:58 +01:00 committed by GitHub
parent 4a5b686aaa
commit ff9d4905d5
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 108 additions and 65 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
src/utils/exportUtils/Exporter.ts
View file

@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
import { MatrixEvent, Room, Direction } from "matrix-js-sdk/src/matrix";
import { Direction, MatrixEvent, Room } from "matrix-js-sdk/src/matrix";
import { saveAs } from "file-saver";
import { logger } from "matrix-js-sdk/src/logger";
import sanitizeFilename from "sanitize-filename";
@ -135,9 +135,6 @@ export default abstract class Exporter {
// when export type is LastNMessages
limit = this.exportOptions.numberOfMessages!;
break;
case ExportType.Timeline:
limit = 40;
break;
default:
limit = 10 ** 8;
}
@ -148,9 +145,12 @@ export default abstract class Exporter {
const eventMapper = this.room.client.getEventMapper();
let prevToken: string | null = null;
let limit = this.getLimit();
const events: MatrixEvent[] = [];
let events: MatrixEvent[] = [];
if (this.exportType === ExportType.Timeline) {
events = this.room.getLiveTimeline().getEvents();
} else {
let limit = this.getLimit();
while (limit) {
const eventsPerCrawl = Math.min(limit, 1000);
const res = await this.room.client.createMessagesRequest(
@ -198,8 +198,7 @@ export default abstract class Exporter {
prevToken = res.end ?? null;
}
// Reverse the events so that we preserve the order
for (let i = 0; i < Math.floor(events.length / 2); i++) {
[events[i], events[events.length - i - 1]] = [events[events.length - i - 1], events[i]];
events.reverse();
}
const decryptionPromises = events

68
test/utils/exportUtils/HTMLExport-test.ts
View file

@ -152,9 +152,10 @@ describe("HTMLExport", () => {
const stubOptions: IExportOptions = {
attachmentsIncluded: false,
maxSize: 50000000,
numberOfMessages: 40,
};
const stubRoom = mkStubRoom("!myroom:example.org", roomName, client);
const exporter = new HTMLExporter(stubRoom, ExportType.Timeline, stubOptions, () => {});
const exporter = new HTMLExporter(stubRoom, ExportType.LastNMessages, stubOptions, () => {});
expect(exporter.destinationFileName).toMatchSnapshot();
@ -203,10 +204,11 @@ describe("HTMLExport", () => {
const exporter = new HTMLExporter(
room,
ExportType.Timeline,
ExportType.LastNMessages,
{
attachmentsIncluded: false,
maxSize: 1_024 * 1_024,
numberOfMessages: 40,
},
() => {},
);
@ -234,10 +236,11 @@ describe("HTMLExport", () => {
const exporter = new HTMLExporter(
room,
ExportType.Timeline,
ExportType.LastNMessages,
{
attachmentsIncluded: false,
maxSize: 1_024 * 1_024,
numberOfMessages: 40,
},
() => {},
);
@ -264,10 +267,11 @@ describe("HTMLExport", () => {
const exporter = new HTMLExporter(
room,
ExportType.Timeline,
ExportType.LastNMessages,
{
attachmentsIncluded: false,
maxSize: 1_024 * 1_024,
numberOfMessages: 40,
},
() => {},
);
@ -287,10 +291,11 @@ describe("HTMLExport", () => {
const exporter = new HTMLExporter(
room,
ExportType.Timeline,
ExportType.LastNMessages,
{
attachmentsIncluded: false,
maxSize: 1_024 * 1_024,
numberOfMessages: 40,
},
() => {},
);
@ -321,10 +326,11 @@ describe("HTMLExport", () => {
const exporter = new HTMLExporter(
room,
ExportType.Timeline,
ExportType.LastNMessages,
{
attachmentsIncluded: false,
maxSize: 1_024 * 1_024,
numberOfMessages: 40,
},
() => {},
);
@ -342,10 +348,11 @@ describe("HTMLExport", () => {
const exporter = new HTMLExporter(
room,
ExportType.Timeline,
ExportType.LastNMessages,
{
attachmentsIncluded: false,
maxSize: 1_024 * 1_024,
numberOfMessages: 40,
},
() => {},
);
@ -364,10 +371,11 @@ describe("HTMLExport", () => {
const exporter = new HTMLExporter(
room,
ExportType.Timeline,
ExportType.LastNMessages,
{
attachmentsIncluded: true,
maxSize: 1_024 * 1_024,
numberOfMessages: 40,
},
() => {},
);
@ -392,10 +400,11 @@ describe("HTMLExport", () => {
const exporter = new HTMLExporter(
room,
ExportType.Timeline,
ExportType.LastNMessages,
{
attachmentsIncluded: true,
maxSize: 1_024 * 1_024,
numberOfMessages: 40,
},
() => {},
);
@ -426,10 +435,11 @@ describe("HTMLExport", () => {
const exporter = new HTMLExporter(
room,
ExportType.Timeline,
ExportType.LastNMessages,
{
attachmentsIncluded: true,
maxSize: 1_024 * 1_024,
numberOfMessages: 40,
},
() => {},
);
@ -451,10 +461,11 @@ describe("HTMLExport", () => {
const exporter = new HTMLExporter(
room,
ExportType.Timeline,
ExportType.LastNMessages,
{
attachmentsIncluded: false,
maxSize: 1_024 * 1_024,
numberOfMessages: 40,
},
() => {},
);
@ -535,10 +546,11 @@ describe("HTMLExport", () => {
const exporter = new HTMLExporter(
room,
ExportType.Timeline,
ExportType.LastNMessages,
{
attachmentsIncluded: false,
maxSize: 1_024 * 1_024,
numberOfMessages: 40,
},
() => {},
);
@ -551,4 +563,36 @@ describe("HTMLExport", () => {
expect(html).not.toContain(`${topic}`);
expect(html).toContain(`Topic: ${escapeHtml(topic)}`);
});
it("should not make /messages requests when exporting 'Current Timeline'", async () => {
client.createMessagesRequest.mockRejectedValue(new Error("Should never be called"));
room.addLiveEvents([
new MatrixEvent({
event_id: `$eventId`,
type: EventType.RoomMessage,
sender: client.getSafeUserId(),
origin_server_ts: 123456789,
content: {
msgtype: "m.text",
body: `testing testing`,
},
}),
]);
const exporter = new HTMLExporter(
room,
ExportType.Timeline,
{
attachmentsIncluded: false,
maxSize: 1_024 * 1_024,
},
() => {},
);
await exporter.export();
const file = getMessageFile(exporter);
expect(await file.text()).toContain("testing testing");
expect(client.createMessagesRequest).not.toHaveBeenCalled();
});
});