getCurrentRoute linkmanager

client/luigi-client.d.ts

@@ -449,6 +449,17 @@ export declare interface LinkManager {
    * LuigiClient.linkManager().preserveQueryParams(false).navigate('/projects/xy/foobar');
    */
   preserveQueryParams: (preserve: boolean) => this;
+
+  /**
+  * Gets the luigi route associated with the current micro frontend.
+  * @returns {promise} a promise which resolves to a String value specifying the current luigi route 
+  * @since NEXTRELEASE
+  * @example
+  * LuigiClient.linkManager().getCurrentRoute();
+  * LuigiClient.linkManager().fromContext('project').getCurrentRoute();
+  * LuigiClient.linkManager().fromVirtualTreeRoot().getCurrentRoute();
+  */
+  getCurrentRoute : () =>  Promise<string>;
 }
 
 export declare interface StorageManager {

client/src/linkManager.js

@@ -423,4 +423,53 @@ export class linkManager extends LuigiClientBase {
     this.options.preserveQueryParams = preserve;
     return this;
   }
+
+  /**
+  * Gets the luigi route associated with the current micro frontend.
+  * @returns {promise} a promise which resolves to a String value specifying the current luigi route 
+  * @since NEXTRELEASE
+  * @example
+  * LuigiClient.linkManager().getCurrentRoute();
+  * LuigiClient.linkManager().fromContext('project').getCurrentRoute();
+  * LuigiClient.linkManager().fromVirtualTreeRoot().getCurrentRoute();
+  */
+  getCurrentRoute() {
+    const currentId = helpers.getRandomId();
+
+    const currentRoutePromise = this.getPromise('getCurrentRoute') || {};
+    currentRoutePromise[currentId] = {
+      resolveFn: function() {},
+      then: function(resolveFn) {
+        this.resolveFn = resolveFn;
+      }
+    };
+
+    this.setPromise('getCurrentRoute', currentRoutePromise);
+
+    helpers.addEventListener(
+      'luigi.navigation.currentRoute.answer', (e, listenerId) => {
+
+        const data = e.data.data;
+        const currentRoutePromise = this.getPromise('getCurrentRoute') || {};
+
+        if (data.correlationId === currentId ) {
+          if (currentRoutePromise[data.correlationId]) {
+            currentRoutePromise[data.correlationId].resolveFn(data.route);
+            delete currentRoutePromise[data.correlationId];
+            this.setPromise('getCurrentRoute', currentRoutePromise);
+          }
+          helpers.removeEventListener(listenerId);
+        }
+        helpers.removeEventListener(listenerId);
+    });
+
+    helpers.sendPostMessageToLuigiCore({
+      msg: 'luigi.navigation.currentRoute',
+      data: Object.assign(this.options, {
+        id: currentId,
+      })
+    });
+
+    return currentRoutePromise[currentId];
+  }
 }

core/src/App.svelte

@@ -415,7 +415,9 @@
 
   const buildPath = (params, srcNode, srcNodePathParams) => {
     const localNode = srcNode || currentNode;
-    const localPathParams = srcNodePathParams || pathParams;
+    const localPathParams = GenericHelpers.isEmptyObject(srcNodePathParams)
+      ? pathParams
+      : srcNodePathParams;
     let localNavPath = navigationPath;
     if (srcNode) {
       let parent = srcNode.parent;
@@ -441,6 +443,21 @@
         getSubPath(node, localPathParams),
         params.link
       );
+
+      // boolean predicate, changes the path only if getCurrentPath function used
+      const isGetCurrentPathRequired =
+        !GenericHelpers.isEmptyObject(localPathParams) &&
+        !path.includes('virtualSegment_') &&
+        !params.link &&
+        params.getCurrentPath &&
+        Object.keys(localPathParams)[0].includes('virtualSegment_');
+      if (isGetCurrentPathRequired) {
+        let virtualPath = '';
+        Object.entries(localPathParams).forEach((virtualParam) => {
+          virtualPath += '/' + virtualParam[1];
+        });
+        path = virtualPath;
+      }
     } else if (params.fromParent) {
       // from direct parent
       path = Routing.concatenatePath(
@@ -462,10 +479,11 @@
       const node = [...localNavPath]
         .reverse()
         .find((n) => navigationContext === n.navigationContext);
-      path = Routing.concatenatePath(
-        getSubPath(node, localPathParams),
-        params.link
-      );
+      const pathUpToContext = getSubPath(node, localPathParams);
+      const fullPath = getSubPath(localNode, localPathParams);
+      path = params.getCurrentPath
+        ? fullPath.substring(pathUpToContext.length)
+        : Routing.concatenatePath(pathUpToContext, params.link);
     } else if (params.intent) {
       path = RoutingHelpers.getIntentPath(params.link);
     } else if (params.relative) {
@@ -474,6 +492,11 @@
         getSubPath(localNode, localPathParams),
         params.link
       );
+    } else {
+      // retrieve path for getCurrentPath method when no options used 
+      if (params.getCurrentPath) {
+        path = getSubPath(localNode, localPathParams);
+      }
     }
     if (params.nodeParams && Object.keys(params.nodeParams).length > 0) {
       path += path.includes('?') ? '&' : '?';
@@ -1291,20 +1314,24 @@
         const isSpecial = newTab || modal || splitView || drawer;
 
         const resolveRemotePromise = () => {
-          const remotePromise = GenericHelpers.getRemotePromise(e.data.remotePromiseId);
+          const remotePromise = GenericHelpers.getRemotePromise(
+            e.data.remotePromiseId
+          );
           if (remotePromise) {
             remotePromise.doResolve();
           }
         };
 
         const rejectRemotePromise = () => {
-          const remotePromise = GenericHelpers.getRemotePromise(e.data.remotePromiseId);
+          const remotePromise = GenericHelpers.getRemotePromise(
+            e.data.remotePromiseId
+          );
           if (remotePromise) {
             remotePromise.doReject();
           }
         };
 
-        const checkResolve = checkLocationChange => {
+        const checkResolve = (checkLocationChange) => {
           if (!checkLocationChange || previousUrl !== window.location.href) {
             resolveRemotePromise();
           } else {
@@ -1428,6 +1455,25 @@
         }
       }
 
+      // handle getCurrentRoute message coming from client
+      if ('luigi.navigation.currentRoute' === e.data.msg) {
+        const srcNode = iframe.luigi.currentNode;
+        const srcPathParams = iframe.luigi.pathParams;
+        const data = e.data.data;
+        data.getCurrentPath = true;
+        const path = buildPath(data, srcNode, srcPathParams);
+
+        // send answer back to client
+        const message = {
+          msg: 'luigi.navigation.currentRoute.answer',
+          data: {
+            route: path,
+            correlationId: data.id,
+          },
+        };
+        IframeHelpers.sendMessageToIframe(iframe, message);
+      }
+
       if ('luigi.auth.tokenIssued' === e.data.msg) {
         sendAuthDataToClient(e.data.authData);
       }

core/src/utilities/helpers/generic-helpers.js

@@ -52,7 +52,16 @@ class GenericHelpersClass {
    * @returns {boolean}
    */
   isObject(objectToCheck) {
-    return objectToCheck && typeof objectToCheck === 'object' && !Array.isArray(objectToCheck);
+    return !!(objectToCheck && typeof objectToCheck === 'object' && !Array.isArray(objectToCheck));
+  }
+
+  /**
+   * Check if object is empty
+   * @param item object to check
+   * @returns {boolean}
+   */
+  isEmptyObject(item) {
+    return this.isObject(item) && Object.keys(item).length === 0;
   }
 
   /**

core/test/utilities/helpers/generic-helpers.spec.js

@@ -81,6 +81,15 @@ describe('Generic-helpers', () => {
     assert.equal(GenericHelpers.isObject(12345), false);
   });
 
+  it('isEmptyObject', () => {
+    const obj = { foo: 'bar' };
+    const obj2 = {};
+    const obj3 = undefined;
+    assert.equal(GenericHelpers.isEmptyObject(obj), false);
+    assert.equal(GenericHelpers.isEmptyObject(obj2), true);
+    assert.equal(GenericHelpers.isEmptyObject(obj3), false);
+  });
+
   it('removeInternalProperties', () => {
     const input = {
       some: true,

test/e2e-test-application/e2e/tests/1-angular/luigi-client-link-manager-features-4.spec.js

@@ -333,4 +333,92 @@ describe('Luigi Client linkManager Webcomponent, Drawer', () => {
       });
     });
   });
+
+  describe('getCurrentRoute', () => {
+    let $iframeBody;
+    beforeEach(() => {
+      // "clear" variables to make sure they are not reused and throw error in case something goes wrong
+      $iframeBody = undefined;
+      cy.visitLoggedIn('/');
+    });
+
+    it('with fromContext option', () => {
+      const routeToCheck = '/projects/pr1/users/groups/avengers';
+      const routeFromContext = '/users/groups/avengers';
+      cy.visitLoggedIn(routeToCheck);
+
+      cy.expectPathToBe(routeToCheck);
+
+      cy.getIframeBody().then(result => {
+        $iframeBody = result;
+        cy.wrap($iframeBody).contains('This is a dynamic node with');
+
+        cy.wrap($iframeBody)
+          .find('[data-testid="curr-button"]')
+          .click();
+
+        cy.wrap($iframeBody)
+          .find('[data-testid="curr-button"]')
+          .click();
+
+        cy.wrap($iframeBody)
+          .find('[data-testid="curr-text"]')
+          .should('contain', routeFromContext);
+      });
+    });
+
+    it('with fromVirtualTree option', () => {
+      const routeToCheck = '/projects/pr1/developers';
+      const routeVirtual = '/internal/virtualTree';
+      cy.visitLoggedIn(routeToCheck);
+      cy.expectPathToBe(routeToCheck);
+
+      cy.getIframeBody().then(result => {
+        $iframeBody = result;
+        cy.wrap($iframeBody).contains('Developers content.');
+
+        cy.wrap($iframeBody)
+          .find('[data-testid="goToVirtualTree"]')
+          .click();
+
+        cy.expectPathToBe(routeToCheck + routeVirtual);
+
+        cy.wrap($iframeBody)
+          .find('[data-testid="curr-link-virtualtree"]')
+          .click();
+
+        cy.wrap($iframeBody)
+          .find('[data-testid="curr-link-virtualtree"]')
+          .click();
+
+        cy.wrap($iframeBody)
+          .find('[data-testid="curr-text-virtualtree"]')
+          .should('contain', routeVirtual);
+      });
+    });
+
+    it('with no option', () => {
+      const routeToCheck = '/projects/pr2/settings';
+      cy.visitLoggedIn(routeToCheck);
+      cy.expectPathToBe(routeToCheck);
+
+      cy.getIframeBody().then(result => {
+        $iframeBody = result;
+        // cy.wrap($iframeBody)
+        //   .contains('Developers content.')
+
+        cy.wrap($iframeBody)
+          .find('[data-testid="curr-link-no-option"]')
+          .click();
+
+        cy.wrap($iframeBody)
+          .find('[data-testid="curr-link-no-option"]')
+          .click();
+
+        cy.wrap($iframeBody)
+          .find('[data-testid="curr-text-no-option"]')
+          .should('contain', routeToCheck);
+      });
+    });
+  });
 });

test/e2e-test-application/src/app/project/developers/developers.component.html

@@ -7,7 +7,7 @@ <h3 class="fd-section__title">Developers</h3>
       <p>
         Developers content.
       </p>
-      <a routerLink="/internal/virtualTree"
+      <a routerLink="/internal/virtualTree" data-testid="goToVirtualTree"
         >Navigate internaly using Angular router and LuigiClient's withoutSync to
         /internal/virtualTree</a
       >

test/e2e-test-application/src/app/project/settings/settings.component.html

@@ -136,6 +136,32 @@ <h3 class="fd-layout-panel__title">Navigate</h3>
     </div>
     <div class="fd-layout-panel__body">
       <ul class="fd-list">
+        <li class="fd-list__item">
+          <a
+            href="javascript:void(0)"
+            data-testid="curr-link-virtualtree"
+            class="fd-link"
+            (click)="getCurrentRouteFromVirtualTree()"
+            >getCurrentRoute fromVirtualTreeRoot</a
+          >
+          <app-code-snippet
+            data="linkManager().fromVirtualTreeRoot().getCurrentRoute().then(...)"
+          ></app-code-snippet>
+          <p data-testid="curr-text-virtualtree">{{currentRouteVirtual}}</p>
+        </li>
+        <li class="fd-list__item">
+          <a
+            href="javascript:void(0)"
+            data-testid="curr-link-no-option"
+            class="fd-link"
+            (click)="getCurrentRoute()"
+            >getCurrentRoute</a
+          >
+          <app-code-snippet
+            data="linkManager().getCurrentRoute().then(...)"
+          ></app-code-snippet>
+          <p data-testid="curr-text-no-option">{{currentRoute}}</p>
+        </li>
         <li class="fd-list__item">
           <a
             href="javascript:void(0)"
@@ -256,6 +282,7 @@ <h3 class="fd-layout-panel__title">Navigate</h3>
         <li class="fd-list__item">
           <a
             href="javascript:void(0)"
+            data-testid="fromcontext-settings-link"
             class="fd-link"
             (click)="
               linkManager()

test/e2e-test-application/src/app/project/settings/settings.component.ts

@@ -31,6 +31,8 @@ export class SettingsComponent implements OnInit {
   lcSubscription: Subscription;
   preservedViewCallbackContext: any;
   private testFeatureToggleActive = false;
+  currentRouteVirtual: string;
+  currentRoute: string;
 
   constructor(
     private activatedRoute: ActivatedRoute,
@@ -90,4 +92,21 @@ export class SettingsComponent implements OnInit {
     // that will be handed over to previous view
     linkManager().goBack(this.callbackValue);
   }
+
+  getCurrentRouteFromVirtualTree() {
+    linkManager()
+      .fromVirtualTreeRoot()
+      .getCurrentRoute()
+      .then(route => {
+        this.currentRouteVirtual = route;
+      });
+  }
+
+  getCurrentRoute() {
+    linkManager()
+      .getCurrentRoute()
+      .then(route => {
+        this.currentRoute = route;
+      });
+  }
 }