Skip to content
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.

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

feat(guards): allow guards to return a value instead of calling next #343

Merged
merged 1 commit into from
Jul 21, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
122 changes: 122 additions & 0 deletions __tests__/guards/guardToPromiseFn.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -110,4 +110,126 @@ describe('guardToPromiseFn', () => {
expect(err).toBe(error)
}
})

describe('no next argument', () => {
it('rejects if returns false', async () => {
expect.assertions(1)
try {
await guardToPromiseFn((to, from) => false, to, from)()
} catch (err) {
expect(err).toMatchObject({
from,
to,
type: ErrorTypes.NAVIGATION_ABORTED,
})
}
})

it('resolves no value is returned', async () => {
await expect(
guardToPromiseFn((to, from) => {}, to, from)()
).resolves.toEqual(undefined)
})

it('resolves if true is returned', async () => {
await expect(
guardToPromiseFn((to, from) => true, to, from)()
).resolves.toEqual(undefined)
})

it('rejects if false is returned', async () => {
expect.assertions(1)
try {
await guardToPromiseFn((to, from) => false, to, from)()
} catch (err) {
expect(err).toMatchObject({
from,
to,
type: ErrorTypes.NAVIGATION_ABORTED,
})
}
})

it('rejects if async false is returned', async () => {
expect.assertions(1)
try {
await guardToPromiseFn(async (to, from) => false, to, from)()
} catch (err) {
expect(err).toMatchObject({
from,
to,
type: ErrorTypes.NAVIGATION_ABORTED,
})
}
})

it('rejects if a string location is returned', async () => {
expect.assertions(1)
try {
await guardToPromiseFn((to, from) => '/new', to, from)()
} catch (err) {
expect(err).toMatchObject({
from: to,
to: '/new',
type: ErrorTypes.NAVIGATION_GUARD_REDIRECT,
})
}
})

it('rejects if an object location is returned', async () => {
expect.assertions(1)
let redirectTo = { path: '/new' }
try {
await guardToPromiseFn((to, from) => redirectTo, to, from)()
} catch (err) {
expect(err).toMatchObject({
from: to,
to: redirectTo,
type: ErrorTypes.NAVIGATION_GUARD_REDIRECT,
})
}
})

it('rejects if an error is returned', async () => {
expect.assertions(1)
let error = new Error('nope')
try {
await guardToPromiseFn((to, from) => error, to, from)()
} catch (err) {
expect(err).toBe(error)
}
})

it('rejects if guard rejects a Promise', async () => {
expect.assertions(1)
let error = new Error('nope')
try {
await guardToPromiseFn(
async (to, from) => {
throw error
},
to,
from
)()
} catch (err) {
expect(err).toBe(error)
}
})

it('rejects if guard throws an error', async () => {
expect.assertions(1)
let error = new Error('nope')
try {
await guardToPromiseFn(
(to, from) => {
throw error
},
to,
from
)()
} catch (err) {
expect(err).toBe(error)
}
})
})
})
7 changes: 5 additions & 2 deletions src/navigationGuards.ts
Original file line number Diff line number Diff line change
Expand Up @@ -128,14 +128,17 @@ export function guardToPromiseFn(
}

// wrapping with Promise.resolve allows it to work with both async and sync guards
Promise.resolve(
let guardCall = Promise.resolve(
guard.call(
instance,
to,
from,
__DEV__ ? canOnlyBeCalledOnce(next, to, from) : next
)
).catch(err => reject(err))
)

if (guard.length < 3) guardCall.then(next)
guardCall.catch(err => reject(err))
})
}

Expand Down