ELITE-496: pre auth util

Author: anicioalexandre

packages/authentication/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @baseapp-frontend/authentication
 
+## 2.1.2
+
+### Patch Changes
+
+- Add `preAuthenticateJWT` function to be used on the server side.
+- Deprecates the `usePreAuth` hook.
+- Updated dependencies
+  - @baseapp-frontend/utils@2.2.2
+
 ## 2.1.1
 
 ### Patch Changes

packages/authentication/__mocks__/fetchMock.ts

@@ -0,0 +1,3 @@
+module.exports = require('@baseapp-frontend/test/__mocks__/fetchMock.ts')
+
+export {}

packages/authentication/modules/access/index.ts

@@ -1,3 +1,5 @@
+export { default as preAuthenticateJWT } from './preAuthenticateJWT'
+
 export { default as useLogin } from './useLogin'
 export * from '../../utils/login'
 export type * from './useLogin/types'

packages/authentication/modules/access/preAuthenticateJWT/__tests__/preAuthenticateJWT.test.ts

@@ -0,0 +1,60 @@
+import preAuthenticateJWT from '..'
+
+global.fetch = jest.fn()
+
+const mockFetchResponse = (body = {}, ok = true, status = 200) => {
+  const fetchMock = global.fetch as jest.Mock
+  fetchMock.mockResolvedValueOnce({
+    ok,
+    status,
+    json: () => Promise.resolve(body),
+    headers: {
+      get: () => 'application/json',
+    },
+  })
+}
+
+describe('preAuthenticateJWT', () => {
+  beforeEach(() => {
+    process.env.NEXT_PUBLIC_API_BASE_URL = 'http://localhost:3000'
+    jest.clearAllMocks()
+  })
+
+  it('should throw an error if no token is provided', async () => {
+    await expect(preAuthenticateJWT()).rejects.toThrow('No token provided.')
+  })
+
+  it('should call fetch with the correct URL and headers', async () => {
+    const token = 'test-jwt-token'
+    const expectedUrl = 'http://localhost:3000/auth/pre-auth/jwt'
+    mockFetchResponse({ success: true })
+
+    await preAuthenticateJWT(token)
+
+    expect(fetch).toHaveBeenCalledWith(expectedUrl, {
+      method: 'POST',
+      body: JSON.stringify({ token }),
+      headers: {
+        Accept: 'application/json',
+        'Content-Type': 'application/json',
+      },
+    })
+  })
+
+  it('should return a response on successful pre-authentication', async () => {
+    const responseData = { success: true, details: 'User authenticated.' }
+    mockFetchResponse(responseData)
+
+    const response = await preAuthenticateJWT('valid-jwt-token')
+
+    expect(response).toEqual(responseData)
+  })
+
+  it('should handle network or server errors gracefully', async () => {
+    const errorMessage = 'Network error'
+    const fetchMock = global.fetch as jest.Mock
+    fetchMock.mockRejectedValueOnce(new Error(errorMessage))
+
+    await expect(preAuthenticateJWT('valid-jwt-token')).rejects.toThrow(errorMessage)
+  })
+})

packages/authentication/modules/access/preAuthenticateJWT/index.ts

@@ -0,0 +1,24 @@
+import { IJWTResponse, baseAppFetch } from '@baseapp-frontend/utils'
+
+const preAuthenticateJWT = async (token?: string) => {
+  try {
+    if (!token) {
+      throw new Error('No token provided.')
+    }
+
+    const response = await baseAppFetch<IJWTResponse>('/auth/pre-auth/jwt', {
+      method: 'POST',
+      body: { token },
+    })
+
+    if (response instanceof Response && !response.ok) {
+      throw new Error('Failed to pre-authenticate.')
+    }
+
+    return response
+  } catch (error) {
+    return Promise.reject(error)
+  }
+}
+
+export default preAuthenticateJWT

packages/authentication/modules/access/usePreAuth/index.ts

@@ -9,6 +9,10 @@ import { isJWTResponse } from '../../../utils/login'
 import { useSimpleTokenUser } from '../../user'
 import { IUsePreAuth } from './types'
 
+/**
+ * @deprecated
+ * Prefer using the `preAuthenticate` function on the server side.
+ */
 const usePreAuth = ({
   token,
   queryOptions = {},

packages/authentication/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@baseapp-frontend/authentication",
   "description": "Authentication modules.",
-  "version": "2.1.1",
+  "version": "2.1.2",
   "main": "./dist/index.ts",
   "module": "./dist/index.mjs",
   "scripts": {

packages/test/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @baseapp-frontend/test
 
+## 1.1.3
+
+### Patch Changes
+
+- Mock fetch Response on `Jest` tests.
+
 ## 1.1.2
 
 ### Patch Changes

packages/test/__mocks__/fetchMock.ts

@@ -0,0 +1,26 @@
+class MockResponse {
+  ok: boolean
+  status: number
+  body: any
+  headers: Map<string, string>
+
+  constructor(
+    body: any,
+    init?: { ok?: boolean; status?: number; headers?: Record<string, string> },
+  ) {
+    this.ok = init?.ok ?? true
+    this.status = init?.status ?? 200
+    this.body = body
+    this.headers = new Map(Object.entries(init?.headers || {}))
+  }
+
+  async json() {
+    return Promise.resolve(this.body)
+  }
+
+  async text() {
+    return Promise.resolve(JSON.stringify(this.body))
+  }
+}
+
+global.Response = MockResponse as any

packages/test/jest.config.ts

@@ -13,7 +13,7 @@ module.exports = {
     ],
     '^.+\\.[t|j]sx?$': 'babel-jest',
   },
-  setupFilesAfterEnv: ['<rootDir>/__mocks__/consoleMock.ts'],
+  setupFilesAfterEnv: ['<rootDir>/__mocks__/consoleMock.ts', '<rootDir>/__mocks__/fetchMock.ts'],
   moduleNameMapper: {
     '\\.(jpg|jpeg|png|gif|eot|otf|webp|svg|ttf|woff|woff2|mp4|webm|wav|mp3|m4a|aac|oga)$':
       '<rootDir>/__mocks__/fileMock.ts',

packages/test/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@baseapp-frontend/test",
   "description": "Test utils that extends React Testing Library.",
-  "version": "1.1.2",
+  "version": "1.1.3",
   "main": "./dist/index.ts",
   "module": "./dist/index.mjs",
   "scripts": {

packages/utils/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @baseapp-frontend/utils
 
+## 2.2.2
+
+### Patch Changes
+
+- Add generic response types to `baseAppFetch`.
+- Handle `!response.ok` on `getAccessToken`.
+- Add pre-auth endpoints to `SERVICES_WITHOUT_TOKEN`.
+
 ## 2.2.1
 
 ### Patch Changes

packages/utils/__mocks__/fetchMock.ts

@@ -0,0 +1,3 @@
+module.exports = require('@baseapp-frontend/test/__mocks__/fetchMock.ts')
+
+export {}

packages/utils/constants/axios.ts packages/utils/constants/fetch.ts

@@ -4,5 +4,6 @@ export const SERVICES_WITHOUT_TOKEN = [
   /\/register$/,
   /\/forgot-password$/,
   /\/forgot-password\/reset$/,
-  /\/users\/\d+\/pre-auth$/,
+  /\/auth\/pre-auth\/jwt$/,
+  /\/auth\/pre-auth\/auth-token$/,
 ]

packages/utils/functions/axios/createAxiosInstance/index.ts

@@ -2,9 +2,9 @@ import _axios from 'axios'
 import humps from 'humps'
 import Cookies from 'js-cookie'
 
-import { SERVICES_WITHOUT_TOKEN } from '../../../constants/axios'
 import { ACCESS_COOKIE_NAME, REFRESH_COOKIE_NAME } from '../../../constants/cookie'
 import { LOGOUT_EVENT } from '../../../constants/events'
+import { SERVICES_WITHOUT_TOKEN } from '../../../constants/fetch'
 import { TokenTypes } from '../../../constants/token'
 import { eventEmitter } from '../../events'
 import { buildQueryString } from '../../string'

packages/utils/functions/fetch/baseAppFetch/index.ts

@@ -1,14 +1,14 @@
 import humps from 'humps'
 import includes from 'lodash/includes'
 
-import { SERVICES_WITHOUT_TOKEN } from '../../../constants/axios'
 import { ACCESS_COOKIE_NAME, REFRESH_COOKIE_NAME } from '../../../constants/cookie'
 import { LOGOUT_EVENT } from '../../../constants/events'
+import { SERVICES_WITHOUT_TOKEN } from '../../../constants/fetch'
 import { TokenTypes } from '../../../constants/token'
 import { eventEmitter } from '../../events'
 import { buildQueryString } from '../../string'
 import { decodeJWT, getToken, isUserTokenValid, refreshAccessToken } from '../../token'
-import { BaseAppFetchOptions, RequestOptions } from './types'
+import { BaseAppFetch, RequestOptions } from './types'
 
 /**
  *
@@ -64,7 +64,7 @@ import { BaseAppFetchOptions, RequestOptions } from './types'
  *          })
  * ```
  */
-export const baseAppFetch = async (
+export const baseAppFetch: BaseAppFetch = async (
   path: `/${string}` | '',
   {
     accessCookieName = ACCESS_COOKIE_NAME,
@@ -78,7 +78,7 @@ export const baseAppFetch = async (
     stringifyBody = true,
     setContentType = true,
     ...options
-  }: BaseAppFetchOptions,
+  } = {},
 ) => {
   const url = `${baseUrl}${path}`
   const isAuthTokenRequired = !servicesWithoutToken.some((regex) => regex.test(path || ''))

packages/utils/functions/fetch/baseAppFetch/types.ts

@@ -37,3 +37,8 @@ export interface RequestOptions extends Omit<RequestInit, 'body' | 'headers'> {
 }
 
 export type BaseAppFetchOptions = RequestOptions & NextFetchOptions & Config
+
+export type BaseAppFetch = <TOutput = any>(
+  path: `/${string}` | '',
+  options: BaseAppFetchOptions,
+) => Promise<TOutput>

packages/utils/functions/token/getAccessToken/index.ts

@@ -16,6 +16,11 @@ export const getAccessToken = async (refreshToken: string) => {
         'Content-Type': 'application/json',
       },
     })
+
+    if (response instanceof Response && !response.ok) {
+      throw new Error('Failed to get access token.')
+    }
+
     const { access: accessToken } = (await response.json()) as IJWTResponse
 
     return accessToken

packages/utils/index.ts

@@ -1,4 +1,4 @@
-export * from './constants/axios'
+export * from './constants/fetch'
 export * from './constants/cookie'
 export * from './constants/django'
 export * from './constants/events'

packages/utils/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@baseapp-frontend/utils",
   "description": "Util functions, constants and types.",
-  "version": "2.2.1",
+  "version": "2.2.2",
   "main": "./dist/index.ts",
   "module": "./dist/index.mjs",
   "scripts": {