Issue 1498

data/redirects/types.ts

@@ -1 +1,2 @@
-export type Redirects = Array<{ bookId: string, pageId: string, pathname: string }>;
+export type RedirectsData = Array<{ bookId: string, pageId: string, pathname: string }>;
+export type Redirects = Array<{ from: string, to: string }>;

script/prerender/createRedirects.ts

@@ -1,6 +1,6 @@
 import fs from 'fs';
 import path from 'path';
-import { Redirects } from '../../data/redirects/types';
+import { RedirectsData } from '../../data/redirects/types';
 import { content } from '../../src/app/content/routes';
 import { makeUnifiedBookLoader } from '../../src/app/content/utils';
 import { findArchiveTreeNodeById } from '../../src/app/content/utils/archiveTreeUtils';
@@ -18,7 +18,7 @@ const createRedirects = async(archiveLoader: AppServices['archiveLoader'], osWeb
   const redirects: Array<{ from: string, to: string }> = [];
 
   for (const fileName of books) {
-    const bookRedirects: Redirects = await import(`${redirectsPath}/${fileName}`);
+    const bookRedirects: RedirectsData = await import(`${redirectsPath}/${fileName}`);
 
     for (const { bookId, pageId, pathname } of bookRedirects) {
       const configForBook: { defaultVersion: string } | undefined = config[bookId];

script/update-content-versions-and-check-for-archived-slugs.ts

@@ -2,7 +2,7 @@ import fs from 'fs';
 import isEqual from 'lodash/fp/isEqual';
 import path from 'path';
 import { argv } from 'yargs';
-import { Redirects } from '../data/redirects/types';
+import { RedirectsData } from '../data/redirects/types';
 import { content } from '../src/app/content/routes';
 import { LinkedArchiveTreeNode } from '../src/app/content/types';
 import { flattenArchiveTree } from '../src/app/content/utils';
@@ -46,7 +46,7 @@ async function updateRedirections(bookId: string, currentVersion: string, newVer
     });
 
   const redirectsBookPath = path.resolve(redirectsPath, bookId + '.json');
-  const redirects: Redirects = fs.existsSync(redirectsBookPath) ? await import(redirectsBookPath) : [];
+  const redirects: RedirectsData = fs.existsSync(redirectsBookPath) ? await import(redirectsBookPath) : [];
 
   const flatCurrentTree = flattenArchiveTree(currentTree);
 

src/app/content/hooks/index.ts

@@ -8,12 +8,14 @@ import searchHooks from '../search/hooks';
 import studyGuidesHooks from '../studyGuides/hooks';
 import locationChangeBody from './locationChange';
 import receiveContentBody from './receiveContent';
+import receivePageNotFoundId from './receivePageNotFoundId';
 
 export default [
   ...searchHooks,
   ...highlightHooks,
   ...studyGuidesHooks,
   ...practiceQuestionsHooks,
+  receivePageNotFoundId,
   routeHook(routes.content, locationChangeBody),
   actionHook(actions.receivePage, receiveContentBody),
 ];

src/app/content/hooks/receivePageNotFoundId.spec.ts

@@ -0,0 +1,67 @@
+import createTestServices from '../../../test/createTestServices';
+import createTestStore from '../../../test/createTestStore';
+import { MiddlewareAPI, Store } from '../../types';
+import { receivePageNotFoundId } from '../actions';
+
+const mockFetch = (valueToReturn: any, error?: any) => () => new Promise((resolve, reject) => {
+  if (error) {
+    reject(error);
+  }
+  resolve({ json: () => new Promise((res) => res(valueToReturn)) });
+});
+
+describe('receivePageNotFoundId hook', () => {
+  let hook: ReturnType<typeof import ('./receivePageNotFoundId').receivePageNotFoundIdHookBody>;
+  let store: Store;
+  let helpers: MiddlewareAPI & ReturnType<typeof createTestServices>;
+  let historyReplaceSpy: jest.SpyInstance;
+  let fetchBackup: any;
+
+  beforeEach(() => {
+    store = createTestStore();
+
+    helpers = {
+      ...createTestServices(),
+      dispatch: store.dispatch,
+      getState: store.getState,
+    };
+
+    helpers.history.location = {
+      pathname: '/books/physics/pages/1-introduction301',
+    } as any;
+
+    historyReplaceSpy = jest.spyOn(helpers.history, 'replace');
+
+    fetchBackup = (globalThis as any).fetch;
+
+    hook = require('./receivePageNotFoundId').receivePageNotFoundIdHookBody(helpers);
+  });
+
+  afterEach(() => {
+    (globalThis as any).fetch = fetchBackup;
+  });
+
+  it('checks for redirects when receivePageNotFoundId is dispatched and noops if path wasn\'t found', async() => {
+    (globalThis as any).fetch = mockFetch([{ from: 'asd', to: 'asd' }]);
+
+    await hook(receivePageNotFoundId('asdf'));
+
+    expect(historyReplaceSpy).not.toHaveBeenCalled();
+  });
+
+  it('noops if fetch fails', async() => {
+    (globalThis as any).fetch = mockFetch(undefined, 'error');
+
+    await hook(receivePageNotFoundId('asdf'));
+
+    expect(historyReplaceSpy).not.toHaveBeenCalled();
+  });
+
+  it('calls history.replace if redirect is found', async() => {
+    (globalThis as any).fetch = mockFetch([{ from: helpers.history.location.pathname, to: 'redirected' }]);
+
+    await hook(receivePageNotFoundId('asdf'));
+
+    expect(historyReplaceSpy).toHaveBeenCalledWith('redirected');
+  });
+});

src/app/content/hooks/receivePageNotFoundId.ts

@@ -0,0 +1,21 @@
+import { Redirects } from '../../../../data/redirects/types';
+import { ActionHookBody } from '../../types';
+import { actionHook } from '../../utils';
+import { receivePageNotFoundId } from '../actions';
+
+export const receivePageNotFoundIdHookBody: ActionHookBody<typeof receivePageNotFoundId> = (
+  services
+) => async() => {
+  const redirects: Redirects = await fetch('/rex/redirects.json')
+    .then((res) => res.json())
+    .catch(() => []);
+
+  for (const {from, to} of redirects) {
+    if (from === services.history.location.pathname) {
+      services.history.replace(to);
+      return;
+    }
+  }
+};
+
+export default actionHook(receivePageNotFoundId, receivePageNotFoundIdHookBody);

src/redirects.development.json

@@ -0,0 +1,3 @@
+[
+  { "from": "/books/physics/pages/1-introduction301", "to": "/books/physics/pages/1-introduction" }
+]

src/setupProxy.js

@@ -2,7 +2,6 @@
  * this file is shared between webpack-dev-server and the pre-renderer
  */
 const url = require('url');
-const util = require('util');
 const fs = require('fs');
 const path = require('path');
 const proxy = require('http-proxy-middleware');
@@ -166,6 +165,19 @@ function stubEnvironment(app) {
   });
 }
 
+function stubRedirects(app) {
+  app.use((req, res, next) => {
+    const  {pathname} = url.parse(req.url);
+
+    if (pathname === '/rex/redirects.json') {
+      const redirectsFile = path.join(__dirname, 'redirects.development.json');
+      sendFile(res, redirectsFile);
+    } else {
+      next();
+    }
+  });
+}
+
 function setupProxy(app) {
   if (!ARCHIVE_URL) { throw new Error('ARCHIVE_URL configuration must be defined'); }
   if (!OS_WEB_URL) { throw new Error('OS_WEB_URL configuration must be defined'); }
@@ -176,6 +188,7 @@ function setupProxy(app) {
   highlightsProxy(app);
   osWebApiProxy(app);
   stubEnvironment(app);
+  stubRedirects(app);
 
   if (!SKIP_OS_WEB_PROXY) {
     osWebProxy(app);