Merge pull request #4886 from matrix-org/travis/room-list/logs-1

turt2live · web-flow · commit 95bc4a6f44df · 2020-07-02T16:41:49.000-06:00
Remove a bunch of noisy logging from the room list
diff --git a/src/stores/room-list/RoomListStore2.ts b/src/stores/room-list/RoomListStore2.ts
@@ -101,8 +101,6 @@ export class RoomListStore2 extends AsyncStore<ActionPayload> {
                 console.warn(`${activeRoomId} is current in RVS but missing from client - clearing sticky room`);
                 this.algorithm.stickyRoom = null;
             } else if (activeRoom !== this.algorithm.stickyRoom) {
-                // TODO: Remove debug: https://github.com/vector-im/riot-web/issues/14035
-                console.log(`Changing sticky room to ${activeRoomId}`);
                 this.algorithm.stickyRoom = activeRoom;
             }
         }
@@ -299,8 +297,6 @@ export class RoomListStore2 extends AsyncStore<ActionPayload> {
     private async handleRoomUpdate(room: Room, cause: RoomUpdateCause): Promise<any> {
         const shouldUpdate = await this.algorithm.handleRoomUpdate(room, cause);
         if (shouldUpdate) {
-            // TODO: Remove debug: https://github.com/vector-im/riot-web/issues/14035
-            console.log(`[DEBUG] Room "${room.name}" (${room.roomId}) triggered by ${cause} requires list update`);
             this.emit(LISTS_UPDATE_EVENT, this);
         }
     }
@@ -367,8 +363,6 @@ export class RoomListStore2 extends AsyncStore<ActionPayload> {
     }
 
     private onAlgorithmListUpdated = () => {
-        // TODO: Remove debug: https://github.com/vector-im/riot-web/issues/14035
-        console.log("Underlying algorithm has triggered a list update - refiring");
         this.emit(LISTS_UPDATE_EVENT, this);
     };
 
@@ -408,17 +402,13 @@ export class RoomListStore2 extends AsyncStore<ActionPayload> {
     }
 
     public addFilter(filter: IFilterCondition): void {
-        // TODO: Remove debug: https://github.com/vector-im/riot-web/issues/14035
-        console.log("Adding filter condition:", filter);
         this.filterConditions.push(filter);
         if (this.algorithm) {
             this.algorithm.addFilterCondition(filter);
         }
     }
 
     public removeFilter(filter: IFilterCondition): void {
-        // TODO: Remove debug: https://github.com/vector-im/riot-web/issues/14035
-        console.log("Removing filter condition:", filter);
         const idx = this.filterConditions.indexOf(filter);
         if (idx >= 0) {
             this.filterConditions.splice(idx, 1);
diff --git a/src/stores/room-list/algorithms/Algorithm.ts b/src/stores/room-list/algorithms/Algorithm.ts
@@ -272,9 +272,6 @@ export class Algorithm extends EventEmitter {
                 }
             }
             newMap[tagId] = allowedRoomsInThisTag;
-
-            // TODO: Remove debug: https://github.com/vector-im/riot-web/issues/14035
-            console.log(`[DEBUG] ${newMap[tagId].length}/${rooms.length} rooms filtered into ${tagId}`);
         }
 
         const allowedRooms = Object.values(newMap).reduce((rv, v) => { rv.push(...v); return rv; }, <Room[]>[]);
@@ -310,9 +307,6 @@ export class Algorithm extends EventEmitter {
         if (filteredRooms.length > 0) {
             this.filteredRooms[tagId] = filteredRooms;
         }
-
-        // TODO: Remove debug: https://github.com/vector-im/riot-web/issues/14035
-        console.log(`[DEBUG] ${filteredRooms.length}/${rooms.length} rooms filtered into ${tagId}`);
     }
 
     protected tryInsertStickyRoomToFilterSet(rooms: Room[], tagId: TagID) {
@@ -351,8 +345,6 @@ export class Algorithm extends EventEmitter {
         }
 
         if (!this._cachedStickyRooms || !updatedTag) {
-            // TODO: Remove debug: https://github.com/vector-im/riot-web/issues/14035
-            console.log(`Generating clone of cached rooms for sticky room handling`);
             const stickiedTagMap: ITagMap = {};
             for (const tagId of Object.keys(this.cachedRooms)) {
                 stickiedTagMap[tagId] = this.cachedRooms[tagId].map(r => r); // shallow clone
@@ -363,8 +355,6 @@ export class Algorithm extends EventEmitter {
         if (updatedTag) {
             // Update the tag indicated by the caller, if possible. This is mostly to ensure
             // our cache is up to date.
-            // TODO: Remove debug: https://github.com/vector-im/riot-web/issues/14035
-            console.log(`Replacing cached sticky rooms for ${updatedTag}`);
             this._cachedStickyRooms[updatedTag] = this.cachedRooms[updatedTag].map(r => r); // shallow clone
         }
 
@@ -373,8 +363,6 @@ export class Algorithm extends EventEmitter {
         // we might have updated from the cache is also our sticky room.
         const sticky = this._stickyRoom;
         if (!updatedTag || updatedTag === sticky.tag) {
-            // TODO: Remove debug: https://github.com/vector-im/riot-web/issues/14035
-            console.log(`Inserting sticky room ${sticky.room.roomId} at position ${sticky.position} in ${sticky.tag}`);
             this._cachedStickyRooms[sticky.tag].splice(sticky.position, 0, sticky.room);
         }
 
@@ -466,13 +454,9 @@ export class Algorithm extends EventEmitter {
         // Split out the easy rooms first (leave and invite)
         const memberships = splitRoomsByMembership(rooms);
         for (const room of memberships[EffectiveMembership.Invite]) {
-            // TODO: Remove debug: https://github.com/vector-im/riot-web/issues/14035
-            console.log(`[DEBUG] "${room.name}" (${room.roomId}) is an Invite`);
             newTags[DefaultTagID.Invite].push(room);
         }
         for (const room of memberships[EffectiveMembership.Leave]) {
-            // TODO: Remove debug: https://github.com/vector-im/riot-web/issues/14035
-            console.log(`[DEBUG] "${room.name}" (${room.roomId}) is Historical`);
             newTags[DefaultTagID.Archived].push(room);
         }
 
@@ -483,11 +467,7 @@ export class Algorithm extends EventEmitter {
             let inTag = false;
             if (tags.length > 0) {
                 for (const tag of tags) {
-                    // TODO: Remove debug: https://github.com/vector-im/riot-web/issues/14035
-                    console.log(`[DEBUG] "${room.name}" (${room.roomId}) is tagged as ${tag}`);
                     if (!isNullOrUndefined(newTags[tag])) {
-                        // TODO: Remove debug: https://github.com/vector-im/riot-web/issues/14035
-                        console.log(`[DEBUG] "${room.name}" (${room.roomId}) is tagged with VALID tag ${tag}`);
                         newTags[tag].push(room);
                         inTag = true;
                     }
@@ -497,9 +477,6 @@ export class Algorithm extends EventEmitter {
             if (!inTag) {
                 // TODO: Determine if DM and push there instead: https://github.com/vector-im/riot-web/issues/14236
                 newTags[DefaultTagID.Untagged].push(room);
-
-                // TODO: Remove debug: https://github.com/vector-im/riot-web/issues/14035
-                console.log(`[DEBUG] "${room.name}" (${room.roomId}) is Untagged`);
             }
         }
 
diff --git a/src/stores/room-list/algorithms/list-ordering/ImportanceAlgorithm.ts b/src/stores/room-list/algorithms/list-ordering/ImportanceAlgorithm.ts
@@ -87,9 +87,6 @@ export class ImportanceAlgorithm extends OrderingAlgorithm {
 
     public constructor(tagId: TagID, initialSortingAlgorithm: SortAlgorithm) {
         super(tagId, initialSortingAlgorithm);
-
-        // TODO: Remove debug: https://github.com/vector-im/riot-web/issues/14035
-        console.log(`[RoomListDebug] Constructed an ImportanceAlgorithm for ${tagId}`);
     }
 
     // noinspection JSMethodCanBeStatic
diff --git a/src/stores/room-list/algorithms/list-ordering/NaturalAlgorithm.ts b/src/stores/room-list/algorithms/list-ordering/NaturalAlgorithm.ts
@@ -28,9 +28,6 @@ export class NaturalAlgorithm extends OrderingAlgorithm {
 
     public constructor(tagId: TagID, initialSortingAlgorithm: SortAlgorithm) {
         super(tagId, initialSortingAlgorithm);
-
-        // TODO: Remove debug: https://github.com/vector-im/riot-web/issues/14035
-        console.log(`[RoomListDebug] Constructed a NaturalAlgorithm for ${tagId}`);
     }
 
     public async setRooms(rooms: Room[]): Promise<any> {
diff --git a/src/stores/room-list/filters/CommunityFilterCondition.ts b/src/stores/room-list/filters/CommunityFilterCondition.ts
@@ -52,8 +52,6 @@ export class CommunityFilterCondition extends EventEmitter implements IFilterCon
         const beforeRoomIds = this.roomIds;
         this.roomIds = (await GroupStore.getGroupRooms(this.community.groupId)).map(r => r.roomId);
         if (arrayHasDiff(beforeRoomIds, this.roomIds)) {
-            // TODO: Remove debug: https://github.com/vector-im/riot-web/issues/14035
-            console.log("Updating filter for group: ", this.community.groupId);
             this.emit(FILTER_CHANGED);
         }
     };
diff --git a/src/stores/room-list/filters/NameFilterCondition.ts b/src/stores/room-list/filters/NameFilterCondition.ts
@@ -41,8 +41,6 @@ export class NameFilterCondition extends EventEmitter implements IFilterConditio
 
     public set search(val: string) {
         this._search = val;
-        // TODO: Remove debug: https://github.com/vector-im/riot-web/issues/14035
-        console.log("Updating filter for room name search:", this._search);
         this.emit(FILTER_CHANGED);
     }
 

Original file line number	Diff line number	Diff line change
`@@ -101,8 +101,6 @@ export class RoomListStore2 extends AsyncStore<ActionPayload> {`
`101`	`101`	console.warn(`${activeRoomId} is current in RVS but missing from client - clearing sticky room`);
`102`	`102`	`this.algorithm.stickyRoom = null;`
`103`	`103`	`} else if (activeRoom !== this.algorithm.stickyRoom) {`
`104`		`- // TODO: Remove debug: https://github.com/vector-im/riot-web/issues/14035`
`105`		- console.log(`Changing sticky room to ${activeRoomId}`);
`106`	`104`	`this.algorithm.stickyRoom = activeRoom;`
`107`	`105`	`}`
`108`	`106`	`}`
`@@ -299,8 +297,6 @@ export class RoomListStore2 extends AsyncStore<ActionPayload> {`
`299`	`297`	`private async handleRoomUpdate(room: Room, cause: RoomUpdateCause): Promise<any> {`
`300`	`298`	`const shouldUpdate = await this.algorithm.handleRoomUpdate(room, cause);`
`301`	`299`	`if (shouldUpdate) {`
`302`		`- // TODO: Remove debug: https://github.com/vector-im/riot-web/issues/14035`
`303`		- console.log(`[DEBUG] Room "${room.name}" (${room.roomId}) triggered by ${cause} requires list update`);
`304`	`300`	`this.emit(LISTS_UPDATE_EVENT, this);`
`305`	`301`	`}`
`306`	`302`	`}`
`@@ -367,8 +363,6 @@ export class RoomListStore2 extends AsyncStore<ActionPayload> {`
`367`	`363`	`}`
`368`	`364`
`369`	`365`	`private onAlgorithmListUpdated = () => {`
`370`		`- // TODO: Remove debug: https://github.com/vector-im/riot-web/issues/14035`
`371`		`- console.log("Underlying algorithm has triggered a list update - refiring");`
`372`	`366`	`this.emit(LISTS_UPDATE_EVENT, this);`
`373`	`367`	`};`
`374`	`368`
`@@ -408,17 +402,13 @@ export class RoomListStore2 extends AsyncStore<ActionPayload> {`
`408`	`402`	`}`
`409`	`403`
`410`	`404`	`public addFilter(filter: IFilterCondition): void {`
`411`		`- // TODO: Remove debug: https://github.com/vector-im/riot-web/issues/14035`
`412`		`- console.log("Adding filter condition:", filter);`
`413`	`405`	`this.filterConditions.push(filter);`
`414`	`406`	`if (this.algorithm) {`
`415`	`407`	`this.algorithm.addFilterCondition(filter);`
`416`	`408`	`}`
`417`	`409`	`}`
`418`	`410`
`419`	`411`	`public removeFilter(filter: IFilterCondition): void {`
`420`		`- // TODO: Remove debug: https://github.com/vector-im/riot-web/issues/14035`
`421`		`- console.log("Removing filter condition:", filter);`
`422`	`412`	`const idx = this.filterConditions.indexOf(filter);`
`423`	`413`	`if (idx >= 0) {`
`424`	`414`	`this.filterConditions.splice(idx, 1);`
Original file line number	Diff line number	Diff line change
`@@ -272,9 +272,6 @@ export class Algorithm extends EventEmitter {`
`272`	`272`	`}`
`273`	`273`	`}`
`274`	`274`	`newMap[tagId] = allowedRoomsInThisTag;`
`275`		`-`
`276`		`- // TODO: Remove debug: https://github.com/vector-im/riot-web/issues/14035`
`277`		- console.log(`[DEBUG] ${newMap[tagId].length}/${rooms.length} rooms filtered into ${tagId}`);
`278`	`275`	`}`
`279`	`276`
`280`	`277`	`const allowedRooms = Object.values(newMap).reduce((rv, v) => { rv.push(...v); return rv; }, <Room[]>[]);`
`@@ -310,9 +307,6 @@ export class Algorithm extends EventEmitter {`
`310`	`307`	`if (filteredRooms.length > 0) {`
`311`	`308`	`this.filteredRooms[tagId] = filteredRooms;`
`312`	`309`	`}`
`313`		`-`
`314`		`- // TODO: Remove debug: https://github.com/vector-im/riot-web/issues/14035`
`315`		- console.log(`[DEBUG] ${filteredRooms.length}/${rooms.length} rooms filtered into ${tagId}`);
`316`	`310`	`}`
`317`	`311`
`318`	`312`	`protected tryInsertStickyRoomToFilterSet(rooms: Room[], tagId: TagID) {`
`@@ -351,8 +345,6 @@ export class Algorithm extends EventEmitter {`
`351`	`345`	`}`
`352`	`346`
`353`	`347`	`if (!this._cachedStickyRooms \|\| !updatedTag) {`
`354`		`- // TODO: Remove debug: https://github.com/vector-im/riot-web/issues/14035`
`355`		- console.log(`Generating clone of cached rooms for sticky room handling`);
`356`	`348`	`const stickiedTagMap: ITagMap = {};`
`357`	`349`	`for (const tagId of Object.keys(this.cachedRooms)) {`
`358`	`350`	`stickiedTagMap[tagId] = this.cachedRooms[tagId].map(r => r); // shallow clone`
`@@ -363,8 +355,6 @@ export class Algorithm extends EventEmitter {`
`363`	`355`	`if (updatedTag) {`
`364`	`356`	`// Update the tag indicated by the caller, if possible. This is mostly to ensure`
`365`	`357`	`// our cache is up to date.`
`366`		`- // TODO: Remove debug: https://github.com/vector-im/riot-web/issues/14035`
`367`		- console.log(`Replacing cached sticky rooms for ${updatedTag}`);
`368`	`358`	`this._cachedStickyRooms[updatedTag] = this.cachedRooms[updatedTag].map(r => r); // shallow clone`
`369`	`359`	`}`
`370`	`360`
`@@ -373,8 +363,6 @@ export class Algorithm extends EventEmitter {`
`373`	`363`	`// we might have updated from the cache is also our sticky room.`
`374`	`364`	`const sticky = this._stickyRoom;`
`375`	`365`	`if (!updatedTag \|\| updatedTag === sticky.tag) {`
`376`		`- // TODO: Remove debug: https://github.com/vector-im/riot-web/issues/14035`
`377`		- console.log(`Inserting sticky room ${sticky.room.roomId} at position ${sticky.position} in ${sticky.tag}`);
`378`	`366`	`this._cachedStickyRooms[sticky.tag].splice(sticky.position, 0, sticky.room);`
`379`	`367`	`}`
`380`	`368`
`@@ -466,13 +454,9 @@ export class Algorithm extends EventEmitter {`
`466`	`454`	`// Split out the easy rooms first (leave and invite)`
`467`	`455`	`const memberships = splitRoomsByMembership(rooms);`
`468`	`456`	`for (const room of memberships[EffectiveMembership.Invite]) {`
`469`		`- // TODO: Remove debug: https://github.com/vector-im/riot-web/issues/14035`
`470`		- console.log(`[DEBUG] "${room.name}" (${room.roomId}) is an Invite`);
`471`	`457`	`newTags[DefaultTagID.Invite].push(room);`
`472`	`458`	`}`
`473`	`459`	`for (const room of memberships[EffectiveMembership.Leave]) {`
`474`		`- // TODO: Remove debug: https://github.com/vector-im/riot-web/issues/14035`
`475`		- console.log(`[DEBUG] "${room.name}" (${room.roomId}) is Historical`);
`476`	`460`	`newTags[DefaultTagID.Archived].push(room);`
`477`	`461`	`}`
`478`	`462`
`@@ -483,11 +467,7 @@ export class Algorithm extends EventEmitter {`
`483`	`467`	`let inTag = false;`
`484`	`468`	`if (tags.length > 0) {`
`485`	`469`	`for (const tag of tags) {`
`486`		`- // TODO: Remove debug: https://github.com/vector-im/riot-web/issues/14035`
`487`		- console.log(`[DEBUG] "${room.name}" (${room.roomId}) is tagged as ${tag}`);
`488`	`470`	`if (!isNullOrUndefined(newTags[tag])) {`
`489`		`- // TODO: Remove debug: https://github.com/vector-im/riot-web/issues/14035`
`490`		- console.log(`[DEBUG] "${room.name}" (${room.roomId}) is tagged with VALID tag ${tag}`);
`491`	`471`	`newTags[tag].push(room);`
`492`	`472`	`inTag = true;`
`493`	`473`	`}`
`@@ -497,9 +477,6 @@ export class Algorithm extends EventEmitter {`
`497`	`477`	`if (!inTag) {`
`498`	`478`	`// TODO: Determine if DM and push there instead: https://github.com/vector-im/riot-web/issues/14236`
`499`	`479`	`newTags[DefaultTagID.Untagged].push(room);`
`500`		`-`
`501`		`- // TODO: Remove debug: https://github.com/vector-im/riot-web/issues/14035`
`502`		- console.log(`[DEBUG] "${room.name}" (${room.roomId}) is Untagged`);
`503`	`480`	`}`
`504`	`481`	`}`
`505`	`482`
Original file line number	Diff line number	Diff line change
`@@ -87,9 +87,6 @@ export class ImportanceAlgorithm extends OrderingAlgorithm {`
`87`	`87`
`88`	`88`	`public constructor(tagId: TagID, initialSortingAlgorithm: SortAlgorithm) {`
`89`	`89`	`super(tagId, initialSortingAlgorithm);`
`90`		`-`
`91`		`- // TODO: Remove debug: https://github.com/vector-im/riot-web/issues/14035`
`92`		- console.log(`[RoomListDebug] Constructed an ImportanceAlgorithm for ${tagId}`);
`93`	`90`	`}`
`94`	`91`
`95`	`92`	`// noinspection JSMethodCanBeStatic`
Original file line number	Diff line number	Diff line change
`@@ -28,9 +28,6 @@ export class NaturalAlgorithm extends OrderingAlgorithm {`
`28`	`28`
`29`	`29`	`public constructor(tagId: TagID, initialSortingAlgorithm: SortAlgorithm) {`
`30`	`30`	`super(tagId, initialSortingAlgorithm);`
`31`		`-`
`32`		`- // TODO: Remove debug: https://github.com/vector-im/riot-web/issues/14035`
`33`		- console.log(`[RoomListDebug] Constructed a NaturalAlgorithm for ${tagId}`);
`34`	`31`	`}`
`35`	`32`
`36`	`33`	`public async setRooms(rooms: Room[]): Promise<any> {`
Original file line number	Diff line number	Diff line change
`@@ -52,8 +52,6 @@ export class CommunityFilterCondition extends EventEmitter implements IFilterCon`
`52`	`52`	`const beforeRoomIds = this.roomIds;`
`53`	`53`	`this.roomIds = (await GroupStore.getGroupRooms(this.community.groupId)).map(r => r.roomId);`
`54`	`54`	`if (arrayHasDiff(beforeRoomIds, this.roomIds)) {`
`55`		`- // TODO: Remove debug: https://github.com/vector-im/riot-web/issues/14035`
`56`		`- console.log("Updating filter for group: ", this.community.groupId);`
`57`	`55`	`this.emit(FILTER_CHANGED);`
`58`	`56`	`}`
`59`	`57`	`};`
Original file line number	Diff line number	Diff line change
`@@ -41,8 +41,6 @@ export class NameFilterCondition extends EventEmitter implements IFilterConditio`
`41`	`41`
`42`	`42`	`public set search(val: string) {`
`43`	`43`	`this._search = val;`
`44`		`- // TODO: Remove debug: https://github.com/vector-im/riot-web/issues/14035`
`45`		`- console.log("Updating filter for room name search:", this._search);`
`46`	`44`	`this.emit(FILTER_CHANGED);`
`47`	`45`	`}`
`48`	`46`