[ACA-4679] Added code changes and env variables to enable DownloadPrompt and FileAutoDownload features on ACA (#3127)

* [ACA-4679] Added docker variables, app.config.json.tpl config and additional code for enabling non-responsive file preview download and file auto download features in ACA

* [ACA-4679] Added defaults for downloadPrompt for viewer and fileAutoDownload features. Updated variable names from 'nonResponsiveDialog' to 'downloadPrompt'

* [ACA-4679] Added unit test cases for FileAutoDownloadService

* [ACA-4679] Updated env variable references from NonResponsiveDialog to DownloadPrompt

* [ACA-4679] Added missing licence header on new files

* [ACA-4679] Added env variable configuration for GithubActions jobs

* [ACA-4679] Added env variable configuration for GithubActions jobs

* [ACA-4679] Removed unneeded env variable configuration for GithubActions jobs

* [ACA-4679] Updated .env file configuration in README.md

projects/aca-shared/src/lib/components/document-base-page/document-base-page.component.ts

@@ -45,6 +45,7 @@ import {
 } from '@alfresco/aca-shared/store';
 import { AppExtensionService } from '../../services/app.extension.service';
 import { isLibrary, isLocked } from '../../utils/node.utils';
+import { AcaFileAutoDownloadService } from '../../services/aca-file-auto-download.service';
 
 /* eslint-disable @angular-eslint/directive-class-suffix */
 @Directive()
@@ -71,7 +72,12 @@ export abstract class PageComponent implements OnInit, OnDestroy, OnChanges {
 
   protected subscriptions: Subscription[] = [];
 
-  protected constructor(protected store: Store<AppStore>, protected extensions: AppExtensionService, protected content: DocumentBasePageService) {}
+  protected constructor(
+    protected store: Store<AppStore>,
+    protected extensions: AppExtensionService,
+    protected content: DocumentBasePageService,
+    private fileAutoDownloadService: AcaFileAutoDownloadService = null
+  ) {}
 
   ngOnInit() {
     this.extensions
@@ -133,15 +139,19 @@ export abstract class PageComponent implements OnInit, OnDestroy, OnChanges {
 
   showPreview(node: MinimalNodeEntity, extras?: ViewNodeExtras) {
     if (node && node.entry) {
-      let id: string;
-
-      if (node.entry.nodeType === 'app:filelink') {
-        id = node.entry.properties['cm:destination'];
+      if (this.fileAutoDownloadService?.shouldFileAutoDownload(node.entry?.content?.sizeInBytes)) {
+        this.fileAutoDownloadService.autoDownloadFile(node);
       } else {
-        id = (node as any).entry.nodeId || (node as any).entry.guid || node.entry.id;
-      }
+        let id: string;
 
-      this.store.dispatch(new ViewNodeAction(id, extras));
+        if (node.entry.nodeType === 'app:filelink') {
+          id = node.entry.properties['cm:destination'];
+        } else {
+          id = (node as any).entry.nodeId || (node as any).entry.guid || node.entry.id;
+        }
+
+        this.store.dispatch(new ViewNodeAction(id, extras));
+      }
     }
   }
 

projects/aca-shared/src/lib/services/aca-file-auto-download.service.spec.ts

@@ -0,0 +1,82 @@
+/*!
+ * Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
+ *
+ * Alfresco Example Content Application
+ *
+ * This file is part of the Alfresco Example Content Application.
+ * If the software was purchased under a paid Alfresco license, the terms of
+ * the paid license agreement will prevail. Otherwise, the software is
+ * provided under the following open source license terms:
+ *
+ * The Alfresco Example Content Application is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * The Alfresco Example Content Application is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * from Hyland Software. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+import { TestBed } from '@angular/core/testing';
+import { AcaFileAutoDownloadService, initialState, LibTestingModule } from '@alfresco/aca-shared';
+import { MatDialog } from '@angular/material/dialog';
+import { AppConfigService } from '@alfresco/adf-core';
+import { FileAutoDownloadComponent } from '@alfresco/adf-content-services';
+import { provideMockStore } from '@ngrx/store/testing';
+
+describe('AcaFileAutoDownloadService', () => {
+  let service: AcaFileAutoDownloadService;
+  let appConfig: AppConfigService;
+
+  const mockDialogRef = {
+    open: jasmine.createSpy('open')
+  };
+
+  beforeEach(() => {
+    TestBed.configureTestingModule({
+      imports: [LibTestingModule],
+      providers: [provideMockStore({ initialState }), { provide: MatDialog, useValue: mockDialogRef }]
+    });
+
+    service = TestBed.inject(AcaFileAutoDownloadService);
+    appConfig = TestBed.inject(AppConfigService);
+  });
+
+  it('shouldFileAutoDownload should return true if fileSize exceeds configured threshold and file auto download is enabled', () => {
+    appConfig.config.viewer = {
+      enableFileAutoDownload: true,
+      fileAutoDownloadSizeThresholdInMB: 10
+    };
+    const shouldAutDownloadFlag = service.shouldFileAutoDownload(11000000);
+    expect(shouldAutDownloadFlag).toBe(true);
+  });
+
+  it('shouldFileAutoDownload should return false if fileSize does not exceeds configured threshold and file auto download is enabled', () => {
+    appConfig.config.viewer = {
+      enableFileAutoDownload: true,
+      fileAutoDownloadSizeThresholdInMB: 10
+    };
+    const shouldAutDownloadFlag = service.shouldFileAutoDownload(500000);
+    expect(shouldAutDownloadFlag).toBe(false);
+  });
+
+  it('shouldFileAutoDownload should return false if fileSize exceeds configured threshold but file auto download is disabled', () => {
+    appConfig.config.viewer = {
+      enableFileAutoDownload: false,
+      fileAutoDownloadSizeThresholdInMB: 10
+    };
+    const shouldAutDownloadFlag = service.shouldFileAutoDownload(11000000);
+    expect(shouldAutDownloadFlag).toBe(false);
+  });
+
+  it('autoDownloadFile should open FileAutoDownload dialog when called', () => {
+    const nodeEntity: any = { entry: { isFile: true } };
+    service.autoDownloadFile(nodeEntity);
+    expect(mockDialogRef.open).toHaveBeenCalledWith(FileAutoDownloadComponent, { disableClose: true, data: nodeEntity });
+  });
+});

projects/aca-shared/src/lib/services/aca-file-auto-download.service.ts

@@ -0,0 +1,51 @@
+/*!
+ * Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
+ *
+ * Alfresco Example Content Application
+ *
+ * This file is part of the Alfresco Example Content Application.
+ * If the software was purchased under a paid Alfresco license, the terms of
+ * the paid license agreement will prevail. Otherwise, the software is
+ * provided under the following open source license terms:
+ *
+ * The Alfresco Example Content Application is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * The Alfresco Example Content Application is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * from Hyland Software. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+import { Injectable } from '@angular/core';
+import { MatDialog } from '@angular/material/dialog';
+import { AppConfigService } from '@alfresco/adf-core';
+import { NodeEntry } from '@alfresco/js-api';
+import { FileAutoDownloadComponent } from '@alfresco/adf-content-services';
+
+const BYTES_TO_MB_CONVERSION_VALUE = 1048576;
+
+@Injectable({
+  providedIn: 'root'
+})
+export class AcaFileAutoDownloadService {
+  constructor(private dialog: MatDialog, private appConfig: AppConfigService) {}
+
+  public shouldFileAutoDownload(fileSizeInBytes: number): boolean {
+    const sizeInMB = fileSizeInBytes / BYTES_TO_MB_CONVERSION_VALUE;
+
+    const fileAutoDownloadFlag: boolean = this.appConfig.get('viewer.enableFileAutoDownload', true);
+    const sizeThreshold: number = this.appConfig.get('viewer.fileAutoDownloadSizeThresholdInMB', 15);
+
+    return fileAutoDownloadFlag && sizeInMB && sizeInMB > sizeThreshold;
+  }
+
+  public autoDownloadFile(node: NodeEntry) {
+    this.dialog.open(FileAutoDownloadComponent, { disableClose: true, data: node });
+  }
+}