ufal/discojuice-not-popped-up (#515)

* Use cookie to popup discojuice login.

* Added Cookie Service into tests

* Close discojuice if it is popped up

* Do not import commands in the constants file.

* commands must be imported in the e2e.ts

Author: milanmajchrak

cypress/support/commands.ts

@@ -118,6 +118,8 @@ Cypress.Commands.add('login', login);
  * @param password password to login as
  */
 function loginViaForm(email: string, password: string): void {
+    cy.wait(500);
+    cy.get('.discojuice_close').should('exist').click();
     // Enter email
     cy.get('ds-log-in [data-test="email"]').type(email);
     // Enter password
@@ -226,12 +228,6 @@ export const loginProcess = {
 };
 
 export const createItemProcess = {
-  typeCollectionName() {
-    cy.get('.modal-body input[type = "search"]').type(TEST_COLLECTION_NAME);
-  },
-  selectCollection() {
-    cy.get('.modal-body .scrollable-menu button[title = "' + TEST_COLLECTION_NAME + '"]').eq(0).click();
-  },
   checkLocalHasCMDIVisibility() {
     cy.get('#traditionalpageone form div[role = "group"] label[for = "local_hasCMDI"]').should('be.visible');
   },

src/aai/aai.js

@@ -95,6 +95,8 @@
               case 'local':
                 // DiscoJuice.UI.setScreen(opts.localauth);
                 // jQuery('input#login').focus();
+                // Use cookie to toggle discojuice popup.
+                setCookie('SHOW_DISCOJUICE_POPUP', false, 1)
                 window.location = window.location.origin + (namespace === '' ? namespace : '/' + namespace) + "/login?redirectUrl=" + window.location.href;
                 break;
               //case 'saml':
@@ -118,6 +120,15 @@
         return djc;
       } //if jQuery(selector)
     };
+
+    // Set a cookie
+    function setCookie(name, value, daysToExpire) {
+      var expirationDate = new Date();
+      expirationDate.setDate(expirationDate.getDate() + daysToExpire);
+
+      var cookieString = name + '=' + value + ';expires=' + expirationDate.toUTCString() + ';path=/';
+      document.cookie = cookieString;
+    }
   }
 
   if (!window.aai) {

src/app/shared/log-in/container/log-in-container.component.spec.ts

@@ -23,6 +23,8 @@ import { RouterMock } from '../../mocks/router.mock';
 import { createSuccessfulRemoteDataObject$ } from '../../remote-data.utils';
 import { ConfigurationProperty } from '../../../core/shared/configuration-property.model';
 import { ActivatedRoute, Router } from '@angular/router';
+import { CookieService } from '../../../core/services/cookie.service';
+import { CookieServiceMock } from '../../mocks/cookie.service.mock';
 
 describe('LogInContainerComponent', () => {
 
@@ -82,6 +84,7 @@ describe('LogInContainerComponent', () => {
             }
           } },
         { provide: Router, useValue: new RouterMock() },
+        { provide: CookieService, useClass: CookieServiceMock },
         LogInContainerComponent
       ],
       schemas: [

src/app/shared/log-in/log-in.component.spec.ts

@@ -28,6 +28,8 @@ import { ConfigurationDataService } from '../../core/data/configuration-data.ser
 import { createSuccessfulRemoteDataObject$ } from '../remote-data.utils';
 import { ConfigurationProperty } from '../../core/shared/configuration-property.model';
 import { RouterStub } from '../testing/router.stub';
+import { CookieService } from '../../core/services/cookie.service';
+import { CookieServiceMock } from '../mocks/cookie.service.mock';
 
 describe('LogInComponent', () => {
 
@@ -99,6 +101,7 @@ describe('LogInComponent', () => {
         { provide: ConfigurationDataService, useValue: configurationDataService },
         provideMockStore({ initialState }),
         { provide: ThemeService, useValue: getMockThemeService() },
+        { provide: CookieService, useClass: CookieServiceMock },
         LogInComponent
       ],
       schemas: [

src/app/shared/log-in/methods/password/log-in-password.component.spec.ts

@@ -23,6 +23,8 @@ import { ActivatedRoute , Router} from '@angular/router';
 import { RouterMock } from '../../../mocks/router.mock';
 import { createSuccessfulRemoteDataObject$ } from '../../../remote-data.utils';
 import { ConfigurationProperty } from '../../../../core/shared/configuration-property.model';
+import { CookieService } from '../../../../core/services/cookie.service';
+import { CookieServiceMock } from '../../../mocks/cookie.service.mock';
 
 describe('LogInPasswordComponent', () => {
   const uiUrl = 'localhost:4000';
@@ -99,6 +101,7 @@ describe('LogInPasswordComponent', () => {
             }
           } },
         { provide: Router, useValue: new RouterMock() },
+        { provide: CookieService, useClass: CookieServiceMock },
         provideMockStore({ initialState }),
       ],
       schemas: [

src/app/shared/log-in/methods/password/log-in-password.component.ts

@@ -25,7 +25,9 @@ import { ActivatedRoute , Router} from '@angular/router';
 import { getBaseUrl } from '../../../clarin-shared-util';
 import { ConfigurationProperty } from '../../../../core/shared/configuration-property.model';
 import { ConfigurationDataService } from '../../../../core/data/configuration-data.service';
+import { CookieService } from '../../../../core/services/cookie.service';
 
+export const SHOW_DISCOJUICE_POPUP_CACHE_NAME = 'SHOW_DISCOJUICE_POPUP';
 /**
  * /users/sign-in
  * @class LogInPasswordComponent
@@ -101,6 +103,7 @@ export class LogInPasswordComponent implements OnInit {
     private route: ActivatedRoute,
     protected router: Router,
     protected configurationService: ConfigurationDataService,
+    protected storage: CookieService,
   ) {
     this.authMethod = injectedAuthMethodModel;
   }
@@ -110,6 +113,7 @@ export class LogInPasswordComponent implements OnInit {
    * @method ngOnInit
    */
   public async ngOnInit() {
+    this.initializeDiscoJuiceCache();
     this.redirectUrl = '';
     // set formGroup
     this.form = this.formBuilder.group({
@@ -171,10 +175,18 @@ export class LogInPasswordComponent implements OnInit {
     }
   }
 
+
+  /**
+   * Toggle Discojuice login. Show it every time except the case when the user click
+   * on the `local` button in the discojuice box.
+   * @private
+   */
   private toggleDiscojuiceLogin() {
-    if (isEmpty(this.route.snapshot.queryParams?.redirectUrl)) {
+    // Popup cache is set to false in the `aai.js` when the user clicks on `local` button
+    if (this.storage.get(SHOW_DISCOJUICE_POPUP_CACHE_NAME) === true) {
       this.popUpDiscoJuiceLogin();
     }
+    this.storage.set(SHOW_DISCOJUICE_POPUP_CACHE_NAME, true);
   }
 
   /**
@@ -243,4 +255,15 @@ export class LogInPasswordComponent implements OnInit {
       document?.getElementById('clarin-signon-discojuice')?.click();
     }, 250);
   }
+
+  /**
+   * Set SHOW_DISCOJUICE_POPUP_CACHE_NAME to true because the discojuice login must be popped up on init
+   * if it is loaded for the first time.
+   * @private
+   */
+  private initializeDiscoJuiceCache() {
+    if (isEmpty(this.storage.get(SHOW_DISCOJUICE_POPUP_CACHE_NAME))) {
+      this.storage.set(SHOW_DISCOJUICE_POPUP_CACHE_NAME, true);
+    }
+  }
 }