[ADF-1443] Refactor Download directive (#4028)

* [ADF-1443] Refactor Download directive

* [ADF-1443] Node Download Directive now accepts single node and an array as input

* [ADF-1443] Fix Unit tests

* [ADF-1443] Fix unit test related to viewer component

lib/core/dialogs/dialog.module.ts

@@ -0,0 +1,43 @@
+/*!
+ * @license
+ * Copyright 2016 Alfresco Software, Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { CommonModule } from '@angular/common';
+import { NgModule } from '@angular/core';
+
+import { MaterialModule } from '../material.module';
+import { DownloadZipDialogComponent } from './download-zip.dialog';
+import { TranslateModule } from '@ngx-translate/core';
+import { PipeModule } from '../pipes/pipe.module';
+
+@NgModule({
+    imports: [
+        CommonModule,
+        MaterialModule,
+        TranslateModule.forChild(),
+        PipeModule
+    ],
+    declarations: [
+        DownloadZipDialogComponent
+    ],
+    exports: [
+        DownloadZipDialogComponent
+    ],
+    entryComponents: [
+        DownloadZipDialogComponent
+    ]
+})
+export class DialogModule {}

lib/core/dialogs/download-zip.dialog.html

@@ -0,0 +1,10 @@
+<h1 matDialogTitle>{{ 'CORE.DIALOG.DOWNLOAD_ZIP.TITLE' | translate }}</h1>
+<div mat-dialog-content>
+    <mat-progress-bar color="primary" mode="indeterminate"></mat-progress-bar>
+</div>
+<div mat-dialog-actions>
+    <span class="adf-spacer"></span>
+    <button mat-button color="primary" id="cancel-button" (click)="cancelDownload()">
+        {{ 'CORE.DIALOG.DOWNLOAD_ZIP.ACTIONS.CANCEL' | translate }}
+    </button>
+</div>

lib/core/dialogs/download-zip.dialog.scss

@@ -0,0 +1,5 @@
+.adf-spacer { flex: 1 1 auto; }
+
+.adf-download-zip-dialog .mat-dialog-actions .mat-button-wrapper {
+    text-transform: uppercase;
+}

lib/core/dialogs/download-zip.dialog.spec.ts

@@ -0,0 +1,149 @@
+/*!
+ * @license
+ * Copyright 2016 Alfresco Software, Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { TestBed } from '@angular/core/testing';
+import { ComponentFixture } from '@angular/core/testing';
+import { MatDialogRef, MAT_DIALOG_DATA } from '@angular/material';
+import { DownloadZipDialogComponent } from './download-zip.dialog';
+import { setupTestBed } from '../testing/setupTestBed';
+import { CoreTestingModule } from '../testing/core.testing.module';
+import { DownloadZipService } from '../services/download-zip.service';
+import { of } from 'rxjs';
+
+describe('DownloadZipDialogComponent', () => {
+
+    let fixture: ComponentFixture<DownloadZipDialogComponent>;
+    let component: DownloadZipDialogComponent;
+    let element: HTMLElement;
+    let downloadZipService: DownloadZipService;
+    let dialogRef = {
+        close: jasmine.createSpy('close')
+    };
+
+    let dataMock = {
+        nodeIds: [
+            '123'
+        ]
+    };
+
+    let pendingDownloadEntry = {
+        entry: {
+            bytesAdded: 0,
+            filesAdded: 0,
+            id: '5bfb0907',
+            status: 'PENDING',
+            totalBytes: 0,
+            totalFiles: 0
+        }
+    };
+
+    setupTestBed({
+        imports: [CoreTestingModule],
+        providers: [
+            { provide: MatDialogRef, useValue: dialogRef },
+            { provide: MAT_DIALOG_DATA, useValue: dataMock }
+        ]
+    });
+
+    beforeEach(() => {
+        dialogRef.close.calls.reset();
+        fixture = TestBed.createComponent(DownloadZipDialogComponent);
+        downloadZipService = TestBed.get(DownloadZipService);
+        component = fixture.componentInstance;
+        element = fixture.nativeElement;
+    });
+
+    afterEach(() => {
+        fixture.destroy();
+    });
+
+    it('should call downloadZip when it is not cancelled', () => {
+        component.cancelled = false;
+        spyOn(component, 'downloadZip');
+
+        component.ngOnInit();
+
+        expect(component.downloadZip).toHaveBeenCalledWith(['123']);
+    });
+
+    it('should not call downloadZip when it is cancelled', () => {
+        component.cancelled = true;
+        spyOn(component, 'downloadZip');
+
+        component.ngOnInit();
+
+        expect(component.downloadZip).not.toHaveBeenCalled();
+    });
+
+    it('should not call downloadZip when it contains zero nodeIds', () => {
+        component.data = {
+            nodeIds: []
+        };
+        spyOn(component, 'downloadZip');
+
+        component.ngOnInit();
+
+        expect(component.downloadZip).not.toHaveBeenCalled();
+    });
+
+    it('should call cancelDownload when CANCEL button is clicked', () => {
+        fixture.detectChanges();
+        spyOn(component, 'cancelDownload').and.callThrough();
+
+        const cancelButton: HTMLButtonElement = <HTMLButtonElement> element.querySelector('#cancel-button');
+        cancelButton.click();
+
+        expect(component.cancelDownload).toHaveBeenCalled();
+    });
+
+    it('should call createDownload when component is initialize', () => {
+        const createDownloadSpy = spyOn(downloadZipService, 'createDownload').and.returnValue(of(pendingDownloadEntry));
+        fixture.detectChanges();
+        expect(createDownloadSpy).toHaveBeenCalled();
+    });
+
+    it('should close dialog when download is completed', () => {
+        component.download('fakeUrl', 'fileName');
+        spyOn(downloadZipService, 'cancelDownload');
+        fixture.detectChanges();
+        expect(dialogRef.close).toHaveBeenCalled();
+    });
+
+    it('should close dialog when download is cancelled', () => {
+        fixture.detectChanges();
+        component.download('url', 'filename');
+        spyOn(downloadZipService, 'cancelDownload');
+        component.cancelDownload();
+        expect(dialogRef.close).toHaveBeenCalled();
+    });
+
+    it('should interrupt download when cancel button is clicked', () => {
+        spyOn(component, 'downloadZip');
+        spyOn(component, 'download');
+        spyOn(component, 'cancelDownload').and.callThrough();
+
+        fixture.detectChanges();
+
+        expect(component.downloadZip).toHaveBeenCalled();
+
+        const cancelButton: HTMLButtonElement = <HTMLButtonElement> element.querySelector('#cancel-button');
+        cancelButton.click();
+
+        expect(component.cancelDownload).toHaveBeenCalled();
+        expect(component.download).not.toHaveBeenCalled();
+    });
+});

lib/core/dialogs/download-zip.dialog.ts

@@ -0,0 +1,110 @@
+/*!
+ * @license
+ * Copyright 2016 Alfresco Software, Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { Component, Inject, OnInit, ViewEncapsulation } from '@angular/core';
+import { MAT_DIALOG_DATA, MatDialogRef } from '@angular/material';
+import { DownloadEntry, MinimalNodeEntity } from 'alfresco-js-api';
+import { LogService } from '../services/log.service';
+import { DownloadZipService } from '../services/download-zip.service';
+
+@Component({
+    selector: 'adf-download-zip-dialog',
+    templateUrl: './download-zip.dialog.html',
+    styleUrls: ['./download-zip.dialog.scss'],
+    host: { 'class': 'adf-download-zip-dialog' },
+    encapsulation: ViewEncapsulation.None
+})
+export class DownloadZipDialogComponent implements OnInit {
+
+    // flag for async threads
+    cancelled = false;
+    downloadId: string;
+
+    constructor(private dialogRef: MatDialogRef<DownloadZipDialogComponent>,
+                @Inject(MAT_DIALOG_DATA)
+                public data: any,
+                private logService: LogService,
+                private downloadZipService: DownloadZipService) {
+    }
+
+    ngOnInit() {
+        if (this.data && this.data.nodeIds && this.data.nodeIds.length > 0) {
+            if (!this.cancelled) {
+                this.downloadZip(this.data.nodeIds);
+            } else {
+                this.logService.log('Cancelled');
+            }
+        }
+    }
+
+    cancelDownload() {
+        this.cancelled = true;
+        this.downloadZipService.cancelDownload(this.downloadId);
+        this.dialogRef.close(false);
+    }
+
+    downloadZip(nodeIds: string[]) {
+        if (nodeIds && nodeIds.length > 0) {
+
+            this.downloadZipService.createDownload({ nodeIds }).subscribe((data: DownloadEntry) => {
+                if (data && data.entry && data.entry.id) {
+                    const url = this.downloadZipService.getContentUrl(data.entry.id, true);
+
+                    this.downloadZipService.getNode(data.entry.id).subscribe((downloadNode: MinimalNodeEntity) => {
+                        this.logService.log(downloadNode);
+                        const fileName = downloadNode.entry.name;
+                        this.downloadId = data.entry.id;
+                        this.waitAndDownload(data.entry.id, url, fileName);
+                    });
+                }
+            });
+        }
+    }
+
+    waitAndDownload(downloadId: string, url: string, fileName: string) {
+        if (this.cancelled) {
+            return;
+        }
+
+        this.downloadZipService.getDownload(downloadId).subscribe((downloadEntry: DownloadEntry) => {
+            if (downloadEntry.entry) {
+                if (downloadEntry.entry.status === 'DONE') {
+                    this.download(url, fileName);
+                } else {
+                    setTimeout(() => {
+                        this.waitAndDownload(downloadId, url, fileName);
+                    }, 1000);
+                }
+            }
+        });
+    }
+
+    download(url: string, fileName: string) {
+        if (url && fileName) {
+            const link = document.createElement('a');
+
+            link.style.display = 'none';
+            link.download = fileName;
+            link.href = url;
+
+            document.body.appendChild(link);
+            link.click();
+            document.body.removeChild(link);
+        }
+        this.dialogRef.close(true);
+    }
+}

lib/core/dialogs/index.ts

@@ -0,0 +1,18 @@
+/*!
+ * @license
+ * Copyright 2016 Alfresco Software, Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export * from './public-api';

lib/core/dialogs/public-api.ts

@@ -0,0 +1,20 @@
+/*!
+ * @license
+ * Copyright 2016 Alfresco Software, Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export * from './download-zip.dialog';
+
+export * from './dialog.module';