edx / frontend-auth
100%

DEFAULT BRANCH: master
Repo Added
Files 10
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst

LAST BUILD ON BRANCH master
branch: master
CHANGE BRANCH
x

671

push

travis-ci

web-flow 
feat: anonymous access (#82)

This PR allows unauthenticated requests to be made though the apiClient. There are breaking behavior changes. There are also breaking API changes as well as new functionality contained in this refactor.

**New functionality:**

- `getAuthenticatedUser`: a function that gets the jwt token and returns user information. It will return null if the user is not authenticated. It will not perform a redirect, unlike `ensureAuthenticatedUser`.
- `isPublic` and `isCsrfExempt` options have been added to request configuration for axios requests (get, post, patch, etc). Setting these to true will prevent frontend-auth from attempting to refresh the jwt access token or a csrf token respectively.

BREAKING CHANGE: (Behavior Change) Frontend-auth intercepts outbound requests and attempts to refresh the jwt token if it does not exist or is expired. In the case of a 401 response indicating that the user is logged out, frontend auth will not redirect the user to login, and will allow the outbound request to proceed. Prior behavior: Upon receiving a 401 response, frontend-auth would block the request and redirect the user to login.

`ensureAuthenticatedUser` continues to redirect if the user is logged out.

**API Changes**

- `getAuthenticatedAPIClient` has been renamed to `getAuthenticatedApiClient`. Note the capitalization changes: API  > Api.
- `redirectToLogout` (formerly `apiClient.logout`)
- `redirectToLogin` (formerly `apiClient.login`)
- `ensureAuthenticatedUser` (formerly `apiClient.ensureAuthenticatedUser`)

See the updated README for more details.

58 of 58 branches covered (100.0%)

Branch coverage included in aggregate %.

142 of 142 new or added lines in 6 files covered. (100.0%)

203 of 203 relevant lines covered (100.0%)

21.53 hits per line

Relevant lines Covered
203 RELEVANT LINES 203 COVERED LINES
21.53 HITS PER LINE
Source Files on master
Coverage ∆ File Lines Relevant Covered Missed Hits/Line Branch Hits Branch Misses

Recent builds

Builds Branch Commit Type Ran Committer Via Coverage
671 master feat: anonymous access (#82) This PR allows unauthenticated requests to be made though the apiClient. There are breaking behavior changes. There are also breaking API changes as well as new functionality contained in this refactor. **New funct... push web-flow travis-ci pending completion  
602 master feat: refactor csrf and jwt roken refreshing and tests BREAKING CHANGE: frontend-logging is no longer a direct dependency of this package. As a result you must make sure it is configured prior to calling getAuthenticatedAPIClient. In all likeliho... push web-flow travis-ci pending completion  
531 master build: upgrade node version push web-flow travis-ci pending completion  
495 master Merge pull request #76 from edx/robrap/ARCH-948-clean-up fix: clean-up research for null refresh token push web-flow travis-ci pending completion  
489 master Merge pull request #74 from edx/robrap/ARCH-948-fix-ensure-authentication ARCH-948: fix: refactor ensurePublicOrAuthenticationAndCookies push web-flow travis-ci pending completion  
461 master Merge pull request #73 from edx/robrap/ARCH-948-more-refresh-token-changes ARCH-948: fix: throw error for missing refresh token push web-flow travis-ci pending completion  
425 master Merge pull request #68 from edx/robrap/ARCH-948-alternate-read-cookies ARCH-948: alternate read cookies push web-flow travis-ci pending completion  
414 master Merge pull request #53 from edx/renovate/react-monorepo chore(deps): update react monorepo to v16.9.0 push web-flow travis-ci pending completion  
393 master Merge pull request #64 from edx/djoy/update_readme_with_example docs(readme): adding example usage push web-flow travis-ci pending completion  
392 master Merge pull request #62 from edx/renovate/pin-dependencies chore(deps): pin dependencies push web-flow travis-ci pending completion  
See All Builds (519)