Skip to content

Resolve infinite redirects, broken redirects for same paths with different params #85

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from
Open

Resolve infinite redirects, broken redirects for same paths with different params #85

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
73ec730
throw up error for same-path-same-params redirects
joshpensky Sep 13, 2021
96b6f27
relocate infinite logic to validateRoute
joshpensky Sep 13, 2021
95a644b
remove example, update errors
joshpensky Sep 13, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 12 additions & 7 deletions package/src/Guard.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import React, { useCallback, useContext, useEffect, useMemo } from 'react';
import { __RouterContext as RouterContext } from 'react-router';
import { matchPath, Redirect, Route } from 'react-router-dom';
import { Redirect, Route } from 'react-router-dom';
import { ErrorPageContext, FromRouteContext, GuardContext, LoadingPageContext } from './contexts';
import { usePrevious, useStateRef, useStateWhenMounted } from './hooks';
import renderPage from './renderPage';
Expand Down Expand Up @@ -133,8 +133,17 @@ const Guard: React.FunctionComponent<GuardProps> = ({ children, component, meta,
const { props, redirect } = await resolveAllGuards();
pageProps = props;
routeRedirect = redirect;

// If there's a redirect, determine if it'll be infinite and throw error if so
if (routeRedirect) {
const redirectPath =
typeof routeRedirect === 'string' ? routeRedirect : routeRedirect.pathname;
Comment on lines +139 to +140
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
const redirectPath =
typeof routeRedirect === 'string' ? routeRedirect : routeRedirect.pathname;
const redirectPath = routeRedirect?.pathname || routeRedirect;

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh that's actually a TypeScript thing! routeRedirect can either be an object or string, so we need to type-check it first before accessing the pathname property

There's also this way to write it if it's preferable!:

let redirectPath: string | undefined;
if (typeof routeRedirect === 'string') {
  redirectPath = routeRedirect;
} else {
  redirectPath = routeRedirect.pathname;
}

if (redirectPath === routeProps.location.pathname) {
throw new Error('rrg/infinite-redirect');
}
}
} catch (error) {
routeError = error.message || 'Not found.';
routeError = error.message || 'rrg/error';
}

if (currentRequests === getValidationsRequested()) {
Expand Down Expand Up @@ -171,11 +180,7 @@ const Guard: React.FunctionComponent<GuardProps> = ({ children, component, meta,
} else if (routeError) {
return renderPage(ErrorPage, { ...routeProps, error: routeError });
} else if (routeRedirect) {
const pathToMatch = typeof routeRedirect === 'string' ? routeRedirect : routeRedirect.pathname;
const { path, isExact: exact } = routeProps.match;
if (pathToMatch && !matchPath(pathToMatch, { path, exact })) {
return <Redirect to={routeRedirect} />;
}
return <Redirect to={routeRedirect} />;
}
return (
<RouterContext.Provider value={{ ...routeProps, ...pageProps }}>
Expand Down