From 816249a48a537258647486d90f097a08a551e5bc Mon Sep 17 00:00:00 2001
From: Thomas Rittson <31796059+eliykat@users.noreply.github.com>
Date: Wed, 11 Aug 2021 13:00:04 +1000
Subject: [PATCH] Use cdk-virtual-scroll for long cipher lists (#1001)

* Use cdk-virtual-scroll for cipher lists

* add trackBy, reorder dom

* Undo merge conflict error

* Fix layout, increase scrolling buffer

* fix linting

* Remove unused infinite-scroll directives for Send

* Add back refresh method

* Update jslib

* Fix itemSize and min/maxBufferPx directives

* Move refresh() into base class

* Use cipherListVirtualScroll strategy

* fix linting

* Update to use latest virtual-scroll strategy

* Update jslib
---
 jslib                                |  2 +-
 src/app/app.module.ts                |  6 ++++--
 src/app/send/send.component.html     |  3 +--
 src/app/vault/ciphers.component.html | 28 +++++++++++++---------------
 src/app/vault/ciphers.component.ts   |  9 ++++-----
 src/scss/base.scss                   | 18 +++++++++++++++---
 6 files changed, 38 insertions(+), 28 deletions(-)

diff --git a/jslib b/jslib
index 23309d33e2..c70c8ecc24 160000
--- a/jslib
+++ b/jslib
@@ -1 +1 @@
-Subproject commit 23309d33e2a335574ed898d6543040372d41526a
+Subproject commit c70c8ecc247cb92e1f867630031fd5cdf124bcd3
diff --git a/src/app/app.module.ts b/src/app/app.module.ts
index 741f0564e7..4a0bd7f5ab 100644
--- a/src/app/app.module.ts
+++ b/src/app/app.module.ts
@@ -1,12 +1,12 @@
 import 'zone.js/dist/zone';
 
 import { ToasterModule } from 'angular2-toaster';
-import { InfiniteScrollModule } from 'ngx-infinite-scroll';
 
 import { AppRoutingModule } from './app-routing.module';
 import { ServicesModule } from './services.module';
 
 import { DragDropModule } from '@angular/cdk/drag-drop';
+import { ScrollingModule } from '@angular/cdk/scrolling';
 import { DatePipe } from '@angular/common';
 import { NgModule } from '@angular/core';
 import { FormsModule, ReactiveFormsModule } from '@angular/forms';
@@ -36,6 +36,7 @@ import { ApiActionDirective } from 'jslib-angular/directives/api-action.directiv
 import { AutofocusDirective } from 'jslib-angular/directives/autofocus.directive';
 import { BlurClickDirective } from 'jslib-angular/directives/blur-click.directive';
 import { BoxRowDirective } from 'jslib-angular/directives/box-row.directive';
+import { CipherListVirtualScroll } from 'jslib-angular/directives/cipherListVirtualScroll.directive';
 import { FallbackSrcDirective } from 'jslib-angular/directives/fallback-src.directive';
 import { SelectCopyDirective } from 'jslib-angular/directives/select-copy.directive';
 import { StopClickDirective } from 'jslib-angular/directives/stop-click.directive';
@@ -164,10 +165,10 @@ registerLocaleData(localeZhTw, 'zh-TW');
         BrowserModule,
         DragDropModule,
         FormsModule,
-        InfiniteScrollModule,
         ReactiveFormsModule,
         ServicesModule,
         ToasterModule.forRoot(),
+        ScrollingModule,
     ],
     declarations: [
         A11yTitleDirective,
@@ -179,6 +180,7 @@ registerLocaleData(localeZhTw, 'zh-TW');
         BlurClickDirective,
         BoxRowDirective,
         CalloutComponent,
+        CipherListVirtualScroll,
         CiphersComponent,
         CollectionsComponent,
         ColorPasswordPipe,
diff --git a/src/app/send/send.component.html b/src/app/send/send.component.html
index 8c14ea75d2..e4740c902d 100644
--- a/src/app/send/send.component.html
+++ b/src/app/send/send.component.html
@@ -39,8 +39,7 @@
             </div>
         </div>
         <div class="content">
-            <div class="list" *ngIf="filteredSends.length" infiniteScroll [infiniteScrollDistance]="1"
-                [infiniteScrollContainer]="'#items .content'" [fromRoot]="true" (scrolled)="loadMore()">
+            <div class="list" *ngIf="filteredSends.length">
                 <a *ngFor="let s of filteredSends" appStopClick (click)="selectSend(s.id)"
                     title="{{'viewItem' | i18n}}" (contextmenu)="viewSendMenu(s)"
                     [ngClass]="{'active': s.id === sendId}" class="flex-list-item">
diff --git a/src/app/vault/ciphers.component.html b/src/app/vault/ciphers.component.html
index 5b87432d11..c9210d1ace 100644
--- a/src/app/vault/ciphers.component.html
+++ b/src/app/vault/ciphers.component.html
@@ -6,13 +6,11 @@
     </div>
 </div>
 <div class="content">
-    <ng-container *ngIf="(isPaging() ? pagedCiphers : ciphers) as filteredCiphers">
-        <div class="list" *ngIf="filteredCiphers.length" infiniteScroll [infiniteScrollDistance]="1"
-            [infiniteScrollContainer]="'#items .content'" [fromRoot]="true" [infiniteScrollDisabled]="!isPaging()"
-            (scrolled)="loadMore()">
-            <a *ngFor="let c of filteredCiphers" appStopClick (click)="selectCipher(c)"
+    <cdk-virtual-scroll-viewport itemSize="42" minBufferPx="400" maxBufferPx="600" *ngIf="ciphers.length">
+        <div class="list">
+            <a *cdkVirtualFor="let c of ciphers; trackBy: trackByFn" appStopClick (click)="selectCipher(c)"
                 (contextmenu)="rightClickCipher(c)" href="#" title="{{'viewItem' | i18n}}"
-                [ngClass]="{'active': c.id === activeCipherId}" class="flex-list-item">
+                [ngClass]="{'active': c.id === activeCipherId}" class="flex-list-item virtual-scroll-item">
                 <app-vault-icon [cipher]="c"></app-vault-icon>
                 <div class="flex-cipher-list-item">
                     <span class="text">
@@ -30,15 +28,15 @@
                 </div>
             </a>
         </div>
-        <div class="no-items" *ngIf="!filteredCiphers.length">
-            <i class="fa fa-spinner fa-spin fa-3x" *ngIf="!loaded" aria-hidden="true"></i>
-            <ng-container *ngIf="loaded">
-                <i class="fa fa-frown-o fa-4x" aria-hidden="true"></i>
-                <p>{{'noItemsInList' | i18n}}</p>
-                <button (click)="addCipher()" class="btn block primary link">{{'addItem' | i18n}}</button>
-            </ng-container>
-        </div>
-    </ng-container>
+    </cdk-virtual-scroll-viewport>
+    <div class="no-items" *ngIf="!ciphers.length">
+        <i class="fa fa-spinner fa-spin fa-3x" *ngIf="!loaded" aria-hidden="true"></i>
+        <ng-container *ngIf="loaded">
+            <i class="fa fa-frown-o fa-4x" aria-hidden="true"></i>
+            <p>{{'noItemsInList' | i18n}}</p>
+            <button (click)="addCipher()" class="btn block primary link">{{'addItem' | i18n}}</button>
+        </ng-container>
+    </div>
 </div>
 <div class="footer">
     <button appBlurClick (click)="addCipher()" (contextmenu)="addCipherOptions()" 
diff --git a/src/app/vault/ciphers.component.ts b/src/app/vault/ciphers.component.ts
index cc16d1bb6b..c9c1cff4e0 100644
--- a/src/app/vault/ciphers.component.ts
+++ b/src/app/vault/ciphers.component.ts
@@ -1,16 +1,15 @@
 import { Component } from '@angular/core';
 
-import { SearchService } from 'jslib-common/abstractions/search.service';
-
 import { CiphersComponent as BaseCiphersComponent } from 'jslib-angular/components/ciphers.component';
 
+import { CipherView } from 'jslib-common/models/view/cipherView';
+
 @Component({
     selector: 'app-vault-ciphers',
     templateUrl: 'ciphers.component.html',
 })
 export class CiphersComponent extends BaseCiphersComponent {
-    constructor(searchService: SearchService) {
-        super(searchService);
-        this.pageSize = 250;
+    trackByFn(index: number, c: CipherView) {
+        return c.id;
     }
 }
diff --git a/src/scss/base.scss b/src/scss/base.scss
index 0300dc8460..803181b021 100644
--- a/src/scss/base.scss
+++ b/src/scss/base.scss
@@ -79,16 +79,16 @@ textarea {
     resize: vertical;
 }
 
-div:not(.modal)::-webkit-scrollbar {
+div:not(.modal)::-webkit-scrollbar, .cdk-virtual-scroll-viewport::-webkit-scrollbar {
     width: 10px;
     height: 10px;
 }
 
-div:not(.modal)::-webkit-scrollbar-track {
+div:not(.modal)::-webkit-scrollbar-track, .cdk-virtual-scroll-viewport::-webkit-scrollbar-track {
     background-color: transparent;
 }
 
-div:not(.modal)::-webkit-scrollbar-thumb {
+div:not(.modal)::-webkit-scrollbar-thumb, .cdk-virtual-scroll-viewport::-webkit-scrollbar-thumb {
     border-radius: 10px;
     margin-right: 1px;
 
@@ -102,3 +102,15 @@ div:not(.modal)::-webkit-scrollbar-thumb {
         }
     }
 }
+
+// cdk-virtual-scroll
+.cdk-virtual-scroll-viewport {
+    width: 100%;
+    height: 100%;
+    overflow-y: auto;
+    overflow-x: hidden;
+}
+
+.cdk-virtual-scroll-content-wrapper {
+    width: 100%;
+}