File

src/app/modules/shared/services/navigation-helper/navigation-helper.service.ts

Index

Properties
Methods
Accessors

Constructor

constructor(router: Router, activatedRoute: ActivatedRoute, cacheService: CacheService, utilService: UtilService)
Parameters :
Name Type Optional
router Router No
activatedRoute ActivatedRoute No
cacheService CacheService No
utilService UtilService No

Methods

Public clearHistory
clearHistory()
Returns : void
emitFullScreenEvent
emitFullScreenEvent(value)
Parameters :
Name Optional
value No
Returns : void
Public getDesktopPreviousUrl
getDesktopPreviousUrl()
Returns : UrlHistory
Public getPageLoadTime
getPageLoadTime()
Returns : number
Public getPreviousUrl
getPreviousUrl()

returns PreviousUrl

  1. First fetches from _history property.
  2. From session if _history is not present, for reload case.
  3. if both are not present then default explore is returned.
Returns : UrlHistory
goBack
goBack()
Returns : void
handleContentManagerOnFullscreen
handleContentManagerOnFullscreen(value)
Parameters :
Name Optional
value No
Returns : void
handlePrevNavigation
handlePrevNavigation()
Returns : void
initialize
initialize()

initialize storeUrlHistory function to store routing history. Add callback function for window.onunload to store previous url.

Returns : void
navigateToLastUrl
navigateToLastUrl()
Returns : void
Public navigateToPreviousUrl
navigateToPreviousUrl(defaultUrl: string)

Navigates to previous Url moved logic to subject subscription to prevent, multiple navigation if user click close multiple time before navigation trigers

Parameters :
Name Type Optional Default value
defaultUrl string No '/explore'
Returns : void
Public navigateToResource
navigateToResource(defaultUrl: string)
Parameters :
Name Type Optional Default value
defaultUrl string No '/explore'
Returns : void
Public navigateToWorkSpace
navigateToWorkSpace(defaultUrl: string)
Parameters :
Name Type Optional Default value
defaultUrl string No '/resources'
Returns : void
popHistory
popHistory()
Returns : void
setNavigationUrl
setNavigationUrl(navigationUrl?: UrlHistory)
Parameters :
Name Type Optional
navigationUrl UrlHistory Yes
Returns : void
storeResourceCloseUrl
storeResourceCloseUrl()
Returns : void
Private storeUrlHistory
storeUrlHistory()

Stores routing history

Returns : void
storeWorkSpaceCloseUrl
storeWorkSpaceCloseUrl()
Returns : void

Properties

Private _history
Type : Array<UrlHistory>
Default value : []

Stores routing history, if query param changed in same url only latest copy will be stored rest ignored

Private _resourceCloseUrl
Type : UrlHistory
Private _workspaceCloseUrl
Type : UrlHistory

Stores workspaceCloseUrl

Public activatedRoute
Type : ActivatedRoute
Public cacheService
Type : CacheService
Private cacheServiceName
Type : string
Default value : 'previousUrl'

Name used to store previous url in session

Public contentFullScreenEvent
Default value : new EventEmitter<any>()
handleCMvisibility
Default value : new EventEmitter<any>()
navigateToPreviousUrl$
Default value : new Subject
Private pageEndTime
Type : any
Private pageStartTime
Type : any
previousNavigationUrl
Public router
Type : Router
Static singletonInstance
Type : NavigationHelperService
Public utilService
Type : UtilService

Accessors

history
gethistory()

returns routing history

Returns : Array<UrlHistory>
import { Injectable, EventEmitter } from '@angular/core';
import { Router, NavigationEnd, ActivatedRoute, NavigationStart } from '@angular/router';
import { CacheService } from '../../../shared/services/cache-service/cache.service';
import * as _ from 'lodash-es';
import { UtilService } from '../util/util.service';
import { Subject, asyncScheduler } from 'rxjs';
import { throttleTime } from 'rxjs/operators';

interface UrlHistory {
  url: string;
  queryParams?: any;
}
@Injectable()
export class NavigationHelperService {
  // Workaround for issue https://github.com/angular/angular/issues/12889
  // Dependency injection creates new instance each time if used in router sub-modules
  static singletonInstance: NavigationHelperService;

  private _resourceCloseUrl: UrlHistory;
  /**
   * Stores workspaceCloseUrl
   */
  private _workspaceCloseUrl: UrlHistory;
  /**
   * Stores routing history, if query param changed in same url only latest copy will be stored rest ignored
   */
  private _history: Array<UrlHistory> = [];

  navigateToPreviousUrl$ = new Subject;

  private pageStartTime: any;

  private pageEndTime: any;
  /**
   * Name used to store previous url in session
   */
  private cacheServiceName = 'previousUrl';
  public contentFullScreenEvent = new EventEmitter<any>();
  handleCMvisibility = new EventEmitter<any>();
  previousNavigationUrl;

  constructor(
    public router: Router,
    public activatedRoute: ActivatedRoute,
    public cacheService: CacheService,
    public utilService: UtilService
  ) {
    this.handlePrevNavigation();
    if (!NavigationHelperService.singletonInstance) {
      NavigationHelperService.singletonInstance = this;
    }
    return NavigationHelperService.singletonInstance;
  }
  /**
   * Stores routing history
   * @memberof NavigationHelperService
   */
  private storeUrlHistory(): void {
    this.router.events.subscribe(e => {
      if (e instanceof NavigationStart) {
        this.pageStartTime = Date.now();
      } else if (e instanceof NavigationEnd) {
        const urlAfterRedirects = e;
        const queryParams = this.activatedRoute.root.children[this.activatedRoute.root.children.length - 1].snapshot.queryParams;
        const url = urlAfterRedirects.url.split('?')[0];
        let history: UrlHistory;
        if (_.isEmpty(queryParams)) {
          history = {url};
        } else {
          history = {url, queryParams};
        }
        const previousUrl = this._history.pop();
        if (previousUrl === undefined || (previousUrl && previousUrl.url === history.url )) {
          this._history.push(history);
        } else {
          this._history.push(previousUrl, history);
        }
      }
    });
  }
  storeResourceCloseUrl() {
    this._resourceCloseUrl = this._history[this._history.length - 1];
  }
  storeWorkSpaceCloseUrl() {
    this._workspaceCloseUrl = this.history[this._history.length - 1];
  }
  public navigateToResource(defaultUrl: string = '/explore') {
    if (this._resourceCloseUrl && this._resourceCloseUrl.url) {
      if (this._resourceCloseUrl.queryParams) {
        this.router.navigate([this._resourceCloseUrl.url], {queryParams: this._resourceCloseUrl.queryParams});
      } else {
        this.router.navigate([this._resourceCloseUrl.url]);
      }
    } else {
      this.router.navigateByUrl(defaultUrl);
    }
  }

  public getPageLoadTime() {
     this.pageEndTime = Date.now();
     const loadTime = (this.pageEndTime - this.pageStartTime) / 1000;
     return loadTime;
  }

  public navigateToWorkSpace(defaultUrl: string = '/resources') {
    if (this._workspaceCloseUrl && this._workspaceCloseUrl.url) {
      if (this._workspaceCloseUrl.queryParams) {
        this.router.navigate([this._workspaceCloseUrl.url], {queryParams: this._workspaceCloseUrl.queryParams});
        this._workspaceCloseUrl = undefined;
      } else {
        this.router.navigate([this._workspaceCloseUrl.url]);
        this._workspaceCloseUrl = undefined;
      }
    } else {
      this.router.navigate([defaultUrl]);
    }
  }
  /**
   * returns routing history
   */
  get history(): Array<UrlHistory> {
    return this._history;
  }
  /**
   * initialize storeUrlHistory function to store routing history.
   * Add callback function for window.onunload to store previous url.
   */
  initialize() {
    this.pageStartTime = Date.now();
    this.storeUrlHistory();
    window.onunload = () => {
      if (this.history[this._history.length - 2]) {
        this.cacheService.set(this.cacheServiceName, this.history[this._history.length - 2]);
      }
    };
  }
  /**
   * returns PreviousUrl
   * 1. First fetches from _history property.
   * 2. From session if _history is not present, for reload case.
   * 3. if both are not present then default explore is returned.
   */
  public getPreviousUrl(): UrlHistory {
    const previousUrl = this.history[this._history.length - 2];
    const sessionUrl = this.cacheService.get(this.cacheServiceName);
    if (previousUrl) {
      return previousUrl;
    } else if (sessionUrl) {
      return sessionUrl;
    } else {
      return {url: '/explore'};
    }
  }
  /**
   * Navigates to previous Url
   * moved logic to subject subscription to prevent,
   * multiple navigation if user click close multiple time before navigation trigers
   */
  public navigateToPreviousUrl(defaultUrl: string = '/explore') {
    this.navigateToPreviousUrl$.next(defaultUrl);
  }
  handlePrevNavigation() {
    this.navigateToPreviousUrl$.pipe(
      throttleTime(250, asyncScheduler, { leading: true, trailing: false }))
    .subscribe(defaultUrl => {
      const previousUrl = this.getPreviousUrl();
      this._history.pop(); // popping current url
      this._history.pop(); // popping previous url as am navigating to same url it will be added again
      if (previousUrl.url === '/explore') {
        this.router.navigate([defaultUrl]);
      } else {
        if (previousUrl.queryParams) {
          this.router.navigate([previousUrl.url], { queryParams: previousUrl.queryParams });
        } else {
          this.router.navigate([previousUrl.url]);
        }
      }
    });
  }

  /* Returns previous URL for the desktop */
  public getDesktopPreviousUrl(): UrlHistory {
    const previousUrl = this.history[this._history.length - 2];
    if (previousUrl) {
      return previousUrl;
    } else {
      return { url: '/' };
    }
  }

  /* Used In Desktop for navigating to back page */
  goBack() {
    const previousUrl = this.getDesktopPreviousUrl();
    const redirectToExplore = [
      '/profile'
    ];
    this.history.pop();
    if (_.includes(previousUrl.url, '/search') && previousUrl.queryParams) {
      this.utilService.updateSearchKeyword(previousUrl.queryParams.key);
    }

    if (_.includes(redirectToExplore, this.router.url)) {
      this.router.navigate(['/explore']);
    } else if (previousUrl.queryParams) {
      this.router.navigate([previousUrl.url], { queryParams: previousUrl.queryParams });
    } else {
      this.router.navigate([previousUrl.url]);
    }
  }

  public clearHistory() {
    this._history = [];
  }

  emitFullScreenEvent(value) {
    this.contentFullScreenEvent.emit(value);
  }

  handleContentManagerOnFullscreen(value) {
    this.handleCMvisibility.emit(value);
  }

  setNavigationUrl(navigationUrl?: UrlHistory) {
    const urlToNavigate = navigationUrl ? navigationUrl : this.getPreviousUrl();
    if (urlToNavigate && !(_.includes(urlToNavigate.url, 'create-managed-user') || _.includes(urlToNavigate.url, 'choose-managed-user'))) {
      this.previousNavigationUrl = urlToNavigate;
    }
  }

  navigateToLastUrl() {
    if (this.previousNavigationUrl) {
      if (this.previousNavigationUrl.queryParams) {
        this.router.navigate([this.previousNavigationUrl.url], {queryParams: this.previousNavigationUrl.queryParams});
      } else {
        this.router.navigate([this.previousNavigationUrl.url]);
      }
    } else {
      this.router.navigate(['/resources']);
    }
  }

  popHistory() {
    this.history.pop();
  }

}

results matching ""

    No results matching ""