feat: added ability to conveniently get hostname from client/server A…

…PI of the Transition hooks plugin (#305)
namecheap · May 31, 2021 · 13c193c · 13c193c
1 parent e48834c
commit 13c193c
Show file tree

Hide file tree

Showing 5 changed files with 38 additions and 26 deletions.
diff --git a/ilc/client/GuardManager.js b/ilc/client/GuardManager.js
@@ -34,10 +34,12 @@ export default class GuardManager {
                     route: {
                         meta: route.meta,
                         url: route.reqUrl,
+                        hostname: window.location.hostname,
                     },
                     prevRoute: {
                         meta: prevRoute.meta,
                         url: prevRoute.reqUrl,
+                        hostname: window.location.hostname,
                     },
                     navigate: this.#router.navigateToUrl,
                 });

diff --git a/ilc/client/GuardManager.spec.js b/ilc/client/GuardManager.spec.js
@@ -93,8 +93,8 @@ describe('GuardManager', () => {
 
             for (const hook of hooks) {
                 sinon.assert.calledOnceWithExactly(hook, {
-                    route: {meta: route.meta, url: route.reqUrl},
-                    prevRoute: {meta: prevRoute.meta, url: prevRoute.reqUrl},
+                    route: {meta: route.meta, url: route.reqUrl, hostname: window.location.hostname},
+                    prevRoute: {meta: prevRoute.meta, url: prevRoute.reqUrl, hostname: window.location.hostname},
                     navigate: router.navigateToUrl
                 });
             }
@@ -129,8 +129,8 @@ describe('GuardManager', () => {
 
             for (const hook of [hooks[0], hooks[1]]) {
                 sinon.assert.calledOnceWithExactly(hook, {
-                    route: {meta: route.meta, url: route.reqUrl},
-                    prevRoute: {meta: prevRoute.meta, url: prevRoute.reqUrl},
+                    route: {meta: route.meta, url: route.reqUrl, hostname: window.location.hostname},
+                    prevRoute: {meta: prevRoute.meta, url: prevRoute.reqUrl, hostname: window.location.hostname},
                     navigate: router.navigateToUrl
                 });
             }
@@ -159,8 +159,8 @@ describe('GuardManager', () => {
 
             for (const hook of [hooks[0], hooks[1]]) {
                 sinon.assert.calledOnceWithExactly(hook, {
-                    route: {meta: route.meta, url: route.reqUrl},
-                    prevRoute: {meta: prevRoute.meta, url: prevRoute.reqUrl},
+                    route: {meta: route.meta, url: route.reqUrl, hostname: window.location.hostname},
+                    prevRoute: {meta: prevRoute.meta, url: prevRoute.reqUrl, hostname: window.location.hostname},
                     navigate: router.navigateToUrl
                 });
             }
@@ -189,8 +189,8 @@ describe('GuardManager', () => {
 
             for (const hook of [hooks[0], hooks[1]]) {
                 sinon.assert.calledOnceWithExactly(hook, {
-                    route: {meta: route.meta, url: route.reqUrl},
-                    prevRoute: {meta: prevRoute.meta, url: prevRoute.reqUrl},
+                    route: {meta: route.meta, url: route.reqUrl, hostname: window.location.hostname},
+                    prevRoute: {meta: prevRoute.meta, url: prevRoute.reqUrl, hostname: window.location.hostname},
                     navigate: router.navigateToUrl
                 });
             }

diff --git a/ilc/server/GuardManager.js b/ilc/server/GuardManager.js
@@ -8,8 +8,12 @@ class GuardManager {
         this.#transitionHooksPlugin = pluginManager.getTransitionHooksPlugin();
     }
 
-    async redirectTo(log, req) {
-        const route = req.router.getRoute();
+    /**
+     * @param {FastifyRequest} req
+     * @return {Promise<null|*>}
+     */
+    async redirectTo(req) {
+        const route = req.raw.router.getRoute();
 
         if (route.specialRole !== null) {
             return null;
@@ -27,9 +31,10 @@ class GuardManager {
                     route: {
                         meta: route.meta,
                         url: route.reqUrl,
+                        hostname: req.hostname,
                     },
-                    log,
-                    req,
+                    log: req.log,
+                    req: req.raw,
                 });
 
                 if (action.type === actionTypes.redirect && action.newLocation) {

diff --git a/ilc/server/GuardManager.spec.js b/ilc/server/GuardManager.spec.js
@@ -99,18 +99,23 @@ describe('GuardManager', () => {
             debug: () => { },
             trace: () => { },
         });
-        const req = Object.freeze({
+        const rawReq = Object.freeze({
             router: {
                 getRoute: () => route,
             },
         });
+        const req = {
+            raw: rawReq,
+            log,
+            hostname: 'test.com'
+        };
 
         describe('should have access to a provided URL', () => {
             it('if transition hooks are non existent', async () => {
                 pluginManager.getTransitionHooksPlugin.returns(transitionHooksPlugin);
                 transitionHooksPlugin.getTransitionHooks.returns([]);
 
-                const redirectTo = await new GuardManager(pluginManager).redirectTo(log, req);
+                const redirectTo = await new GuardManager(pluginManager).redirectTo(req);
 
                 chai.expect(redirectTo).to.be.null;
             });
@@ -122,12 +127,12 @@ describe('GuardManager', () => {
                 const route = Object.freeze({
                     specialRole: 404,
                 });
-                const req = Object.freeze({
+                const rawReq = Object.freeze({
                     router: {
                         getRoute: () => route,
                     },
                 });
-                const redirectTo = await new GuardManager(pluginManager).redirectTo(log, req);
+                const redirectTo = await new GuardManager(pluginManager).redirectTo({...req, raw: rawReq});
 
                 chai.expect(redirectTo).to.be.null;
             });
@@ -141,12 +146,12 @@ describe('GuardManager', () => {
                 pluginManager.getTransitionHooksPlugin.returns(transitionHooksPlugin);
                 transitionHooksPlugin.getTransitionHooks.returns(hooks);
 
-                const redirectTo = await new GuardManager(pluginManager).redirectTo(log, req);
+                const redirectTo = await new GuardManager(pluginManager).redirectTo(req);
 
                 for (const hook of hooks) {
                     chai.expect(hook.calledOnceWith({
-                        route: {meta: route.meta, url: route.reqUrl},
-                        req,
+                        route: {meta: route.meta, url: route.reqUrl, hostname: req.hostname},
+                        req: rawReq,
                         log,
                     })).to.be.true;
                 }
@@ -168,7 +173,7 @@ describe('GuardManager', () => {
                 pluginManager.getTransitionHooksPlugin.returns(transitionHooksPlugin);
                 transitionHooksPlugin.getTransitionHooks.returns(hooks);
 
-                await chai.expect(new GuardManager(pluginManager).redirectTo(log, req)).to.eventually.be.rejected.then((rejectedError) => {
+                await chai.expect(new GuardManager(pluginManager).redirectTo(req)).to.eventually.be.rejected.then((rejectedError) => {
                     chai.expect(rejectedError).to.be.instanceOf(errors.GuardTransitionHookError);
                     chai.expect(rejectedError.data).to.be.eql({
                         hookIndex: 1,
@@ -178,8 +183,8 @@ describe('GuardManager', () => {
 
                 for (const hook of [hooks[0], hooks[1]]) {
                     chai.expect(hook.calledOnceWith({
-                        route: {meta: route.meta, url: route.reqUrl},
-                        req,
+                        route: {meta: route.meta, url: route.reqUrl, hostname: req.hostname},
+                        req: rawReq,
                         log,
                     })).to.be.true;
                 }
@@ -201,12 +206,12 @@ describe('GuardManager', () => {
                 pluginManager.getTransitionHooksPlugin.returns(transitionHooksPlugin);
                 transitionHooksPlugin.getTransitionHooks.returns(hooks);
 
-                const redirectTo = await new GuardManager(pluginManager).redirectTo(log, req);
+                const redirectTo = await new GuardManager(pluginManager).redirectTo(req);
 
                 for (const hook of [hooks[0], hooks[1]]) {
                     chai.expect(hook.calledOnceWith({
-                        route: {meta: route.meta, url: route.reqUrl},
-                        req,
+                        route: {meta: route.meta, url: route.reqUrl, hostname: req.hostname},
+                        req: rawReq,
                         log,
                     })).to.be.true;
                 }

diff --git a/ilc/server/app.js b/ilc/server/app.js
@@ -73,7 +73,7 @@ module.exports = (registryService, pluginManager) => {
         req.raw.registryConfig = registryConfig;
         req.raw.router = new ServerRouter(req.log, req.raw, unlocalizedUrl);
 
-        const redirectTo = await guardManager.redirectTo(req.log, req.raw);
+        const redirectTo = await guardManager.redirectTo(req);
 
         if (redirectTo) {
             res.redirect(urlProcessor.process(i18n.localizeUrl(registryConfig.settings.i18n, redirectTo, {