feat: support http redirect code in transition hook plugin

rename guard to transtionhookexecutor
namecheap · Dec 20, 2024 · d787c16 · d787c16
1 parent 94da1da
commit d787c16
Show file tree

Hide file tree

Showing 11 changed files with 174 additions and 112 deletions.
diff --git a/ilc/client/Client.js b/ilc/client/Client.js
@@ -26,7 +26,7 @@ import Router from './ClientRouter';
 import initIlcState from './initIlcState';
 import I18n from './i18n';
 
-import GuardManager from './GuardManager';
+import TransitionHooksExecutor from './TransitionHooksExecutor';
 import ParcelApi from './ParcelApi';
 import { BundleLoader } from './BundleLoader';
 import { registerApplications } from './registerSpaApps';
@@ -62,7 +62,7 @@ export class Client {
 
     #router;
 
-    #guardManager;
+    #transitionHooksExecutor;
 
     #urlProcessor;
 
@@ -114,7 +114,7 @@ export class Client {
             singleSpa,
             this.#transitionManager.handlePageTransition.bind(this.#transitionManager),
         );
-        this.#guardManager = new GuardManager(
+        this.#transitionHooksExecutor = new TransitionHooksExecutor(
             this.#router,
             this.#pluginManager,
             this.#onCriticalInternalError.bind(this),
@@ -268,7 +268,7 @@ export class Client {
     }
 
     #configure() {
-        addNavigationHook((url) => (this.#guardManager.hasAccessTo(url) ? url : null));
+        addNavigationHook((url) => (this.#transitionHooksExecutor.hasAccessTo(url) ? url : null));
         addNavigationHook((url) => this.#urlProcessor.process(url));
 
         // TODO: window.ILC.importLibrary - calls bootstrap function with props (if supported), and returns exposed API

diff --git a/ilc/client/GuardManager.js → ilc/client/TransitionHooksExecutor.js b/ilc/client/GuardManager.js → ilc/client/TransitionHooksExecutor.js
@@ -1,7 +1,10 @@
-import errors from '../common/guard/errors';
+import { TransitionHookError } from '../common/guard/errors';
 import actionTypes from '../common/guard/actionTypes';
 
-export default class GuardManager {
+/**
+ * Executes ILC Transition plugin's hooks
+ */
+export default class TransitionHooksExecutor {
     #router;
     #transitionHooksPlugin;
     #errorHandler;
@@ -58,7 +61,7 @@ export default class GuardManager {
                         this.#logger.info(
                             `ILC: Redirect from "${route.reqUrl}" to "${
                                 action.newLocation
-                            }" due to the Route Guard with index #${hooks.indexOf(hook)}`,
+                            }" due to the Transition Hook with index #${hooks.indexOf(hook)}`,
                         );
                         this.#router.navigateToUrl(action.newLocation);
                     });
@@ -68,7 +71,7 @@ export default class GuardManager {
                 const hookIndex = hooks.indexOf(hook);
 
                 this.#errorHandler(
-                    new errors.GuardTransitionHookError({
+                    new TransitionHookError({
                         message: `An error has occurred while executing "${hookIndex}" transition hook for the following URL: "${url}".`,
                         data: {
                             hookIndex,

diff --git a/ilc/client/GuardManager.spec.js → ilc/client/TransitionHooksExecutor.spec.js b/ilc/client/GuardManager.spec.js → ilc/client/TransitionHooksExecutor.spec.js
@@ -1,11 +1,11 @@
 import chai from 'chai';
 import sinon from 'sinon';
 
-import errors from '../common/guard/errors';
+import { TransitionHookError } from '../common/guard/errors';
 import actionTypes from '../common/guard/actionTypes';
-import GuardManager from './GuardManager';
+import TransitionHooksExecutor from './TransitionHooksExecutor';
 
-describe('GuardManager', () => {
+describe('TransitionHooksExecutor', () => {
     let clock;
 
     const route = Object.freeze({
@@ -68,9 +68,9 @@ describe('GuardManager', () => {
             transitionHooksPlugin.getTransitionHooks.returns(hooks);
             router.match.returns({ specialRole: 404 });
 
-            const guardManager = new GuardManager(router, pluginManager, errorHandler, logger);
+            const transitionHooksExecutor = new TransitionHooksExecutor(router, pluginManager, errorHandler, logger);
 
-            chai.expect(guardManager.hasAccessTo('/router/does/not/have/route')).to.be.true;
+            chai.expect(transitionHooksExecutor.hasAccessTo('/router/does/not/have/route')).to.be.true;
         });
 
         it(`if none of hooks returns "${actionTypes.stopNavigation}" or "${actionTypes.redirect}" action types`, () => {
@@ -85,9 +85,9 @@ describe('GuardManager', () => {
             transitionHooksPlugin.getTransitionHooks.returns(hooks);
             router.match.returns(route);
 
-            const guardManager = new GuardManager(router, pluginManager, errorHandler, logger);
+            const transitionHooksExecutor = new TransitionHooksExecutor(router, pluginManager, errorHandler, logger);
 
-            chai.expect(guardManager.hasAccessTo(url)).to.be.true;
+            chai.expect(transitionHooksExecutor.hasAccessTo(url)).to.be.true;
 
             for (const hook of hooks) {
                 sinon.assert.calledOnceWithExactly(hook, {
@@ -113,12 +113,12 @@ describe('GuardManager', () => {
             transitionHooksPlugin.getTransitionHooks.returns(hooks);
             router.match.returns(route);
 
-            const guardManager = new GuardManager(router, pluginManager, errorHandler, logger);
+            const transitionHooksExecutor = new TransitionHooksExecutor(router, pluginManager, errorHandler, logger);
 
-            chai.expect(guardManager.hasAccessTo(url)).to.be.false;
+            chai.expect(transitionHooksExecutor.hasAccessTo(url)).to.be.false;
             sinon.assert.calledOnce(errorHandler);
             chai.expect(errorHandler.getCall(0).args[0]).to.have.property('cause', error);
-            chai.expect(errorHandler.getCall(0).args[0]).to.be.instanceOf(errors.GuardTransitionHookError);
+            chai.expect(errorHandler.getCall(0).args[0]).to.be.instanceOf(TransitionHookError);
             chai.expect(errorHandler.getCall(0).args[0].data).to.be.eql({
                 hookIndex: 1,
                 url,
@@ -150,9 +150,9 @@ describe('GuardManager', () => {
             transitionHooksPlugin.getTransitionHooks.returns(hooks);
             router.match.returns(route);
 
-            const guardManager = new GuardManager(router, pluginManager, errorHandler, logger);
+            const transitionHooksExecutor = new TransitionHooksExecutor(router, pluginManager, errorHandler, logger);
 
-            chai.expect(guardManager.hasAccessTo(url)).to.be.false;
+            chai.expect(transitionHooksExecutor.hasAccessTo(url)).to.be.false;
             sinon.assert.calledOnceWithExactly(
                 logger.info,
                 `ILC: Stopped navigation due to the Route Guard with index #${1}`,
@@ -183,9 +183,9 @@ describe('GuardManager', () => {
             transitionHooksPlugin.getTransitionHooks.returns(hooks);
             router.match.returns(route);
 
-            const guardManager = new GuardManager(router, pluginManager, errorHandler, logger);
+            const transitionHooksExecutor = new TransitionHooksExecutor(router, pluginManager, errorHandler, logger);
 
-            chai.expect(guardManager.hasAccessTo(url)).to.be.false;
+            chai.expect(transitionHooksExecutor.hasAccessTo(url)).to.be.false;
             sinon.assert.notCalled(router.navigateToUrl);
 
             for (const hook of [hooks[0], hooks[1]]) {
@@ -204,7 +204,7 @@ describe('GuardManager', () => {
 
             sinon.assert.calledWithExactly(
                 logger.info,
-                `ILC: Redirect from "${route.reqUrl}" to "${url}" due to the Route Guard with index #${1}`,
+                `ILC: Redirect from "${route.reqUrl}" to "${url}" due to the Transition Hook with index #${1}`,
             );
             sinon.assert.calledWithExactly(router.navigateToUrl, url);
         });

diff --git a/ilc/common/guard/errors.js b/ilc/common/guard/errors.js
diff --git a/ilc/common/guard/errors.ts b/ilc/common/guard/errors.ts
@@ -0,0 +1,8 @@
+import { extendError } from '../utils';
+
+export const TransitionError = extendError('TransitionError', { defaultData: {} });
+
+export const TransitionHookError = extendError('TransitionHookError', {
+    parent: TransitionError,
+    defaultData: {},
+});
diff --git a/ilc/package-lock.json b/ilc/package-lock.json
diff --git a/ilc/package.json b/ilc/package.json
@@ -35,7 +35,7 @@
     "fast-glob": "^3.3.2",
     "fastify": "^2.15.3",
     "http-status-codes": "^2.3.0",
-    "ilc-plugins-sdk": "^2.1.0",
+    "ilc-plugins-sdk": "^2.2.0",
     "ilc-sdk": "^5.2.4",
     "is-url": "^1.2.4",
     "js-cookie": "^2.2.1",

diff --git a/ilc/server/GuardManager.js b/ilc/server/GuardManager.js