chore(refactor): split up and add tests for core functionality

src/auth/getAccessToken.ts

@@ -0,0 +1,49 @@
+import { SasAuthResponse } from '@sasjs/utils'
+import * as NodeFormData from 'form-data'
+import { RequestClient } from '../request/RequestClient'
+
+/**
+ * Exchanges the auth code for an access token for the given client.
+ * @param requestClient - the pre-configured HTTP request client
+ * @param clientId - the client ID to authenticate with.
+ * @param clientSecret - the client secret to authenticate with.
+ * @param authCode - the auth code received from the server.
+ */
+export async function getAccessToken(
+  requestClient: RequestClient,
+  clientId: string,
+  clientSecret: string,
+  authCode: string
+): Promise<SasAuthResponse> {
+  const url = '/SASLogon/oauth/token'
+  let token
+  if (typeof Buffer === 'undefined') {
+    token = btoa(clientId + ':' + clientSecret)
+  } else {
+    token = Buffer.from(clientId + ':' + clientSecret).toString('base64')
+  }
+  const headers = {
+    Authorization: 'Basic ' + token
+  }
+
+  let formData
+  if (typeof FormData === 'undefined') {
+    formData = new NodeFormData()
+  } else {
+    formData = new FormData()
+  }
+  formData.append('grant_type', 'authorization_code')
+  formData.append('code', authCode)
+
+  const authResponse = await requestClient
+    .post(
+      url,
+      formData,
+      undefined,
+      'multipart/form-data; boundary=' + (formData as any)._boundary,
+      headers
+    )
+    .then((res) => res.result as SasAuthResponse)
+
+  return authResponse
+}

src/auth/getTokens.ts

@@ -0,0 +1,40 @@
+import {
+  AuthConfig,
+  isAccessTokenExpiring,
+  isRefreshTokenExpiring,
+  hasTokenExpired
+} from '@sasjs/utils'
+import { RequestClient } from '../request/RequestClient'
+import { refreshTokens } from './refreshTokens'
+
+/**
+ * Returns the auth configuration, refreshing the tokens if necessary.
+ * @param requestClient - the pre-configured HTTP request client
+ * @param authConfig - an object containing a client ID, secret, access token and refresh token
+ */
+export async function getTokens(
+  requestClient: RequestClient,
+  authConfig: AuthConfig
+): Promise<AuthConfig> {
+  const logger = process.logger || console
+  let { access_token, refresh_token, client, secret } = authConfig
+  if (
+    isAccessTokenExpiring(access_token) ||
+    isRefreshTokenExpiring(refresh_token)
+  ) {
+    if (hasTokenExpired(refresh_token)) {
+      const error =
+        'Unable to obtain new access token. Your refresh token has expired.'
+      logger.error(error)
+      throw new Error(error)
+    }
+    logger.info('Refreshing access and refresh tokens.')
+    ;({ access_token, refresh_token } = await refreshTokens(
+      requestClient,
+      client,
+      secret,
+      refresh_token
+    ))
+  }
+  return { access_token, refresh_token, client, secret }
+}

src/auth/refreshTokens.ts

@@ -0,0 +1,49 @@
+import { SasAuthResponse } from '@sasjs/utils/types'
+import { prefixMessage } from '@sasjs/utils/error'
+import * as NodeFormData from 'form-data'
+import { RequestClient } from '../request/RequestClient'
+
+/**
+ * Exchanges the refresh token for an access token for the given client.
+ * @param requestClient - the pre-configured HTTP request client
+ * @param clientId - the client ID to authenticate with.
+ * @param clientSecret - the client secret to authenticate with.
+ * @param authCode - the refresh token received from the server.
+ */
+export async function refreshTokens(
+  requestClient: RequestClient,
+  clientId: string,
+  clientSecret: string,
+  refreshToken: string
+) {
+  const url = '/SASLogon/oauth/token'
+  let token
+  token =
+    typeof Buffer === 'undefined'
+      ? btoa(clientId + ':' + clientSecret)
+      : Buffer.from(clientId + ':' + clientSecret).toString('base64')
+
+  const headers = {
+    Authorization: 'Basic ' + token
+  }
+
+  const formData =
+    typeof FormData === 'undefined' ? new NodeFormData() : new FormData()
+  formData.append('grant_type', 'refresh_token')
+  formData.append('refresh_token', refreshToken)
+
+  const authResponse = await requestClient
+    .post<SasAuthResponse>(
+      url,
+      formData,
+      undefined,
+      'multipart/form-data; boundary=' + (formData as any)._boundary,
+      headers
+    )
+    .then((res) => res.result)
+    .catch((err) => {
+      throw prefixMessage(err, 'Error while refreshing tokens')
+    })
+
+  return authResponse
+}

src/auth/spec/getTokens.spec.ts

@@ -0,0 +1,79 @@
+import { AuthConfig } from '@sasjs/utils'
+import * as refreshTokensModule from '../refreshTokens'
+import { generateToken, mockAuthResponse } from './mockResponses'
+import { getTokens } from '../getTokens'
+import { RequestClient } from '../../request/RequestClient'
+
+const requestClient = new (<jest.Mock<RequestClient>>RequestClient)()
+
+describe('getTokens', () => {
+  it('should attempt to refresh tokens if the access token is expiring', async () => {
+    setupMocks()
+    const access_token = generateToken(30)
+    const refresh_token = generateToken(86400000)
+    const authConfig: AuthConfig = {
+      access_token,
+      refresh_token,
+      client: 'cl13nt',
+      secret: 's3cr3t'
+    }
+
+    await getTokens(requestClient, authConfig)
+
+    expect(refreshTokensModule.refreshTokens).toHaveBeenCalledWith(
+      requestClient,
+      authConfig.client,
+      authConfig.secret,
+      authConfig.refresh_token
+    )
+  })
+
+  it('should attempt to refresh tokens if the refresh token is expiring', async () => {
+    setupMocks()
+    const access_token = generateToken(86400000)
+    const refresh_token = generateToken(30)
+    const authConfig: AuthConfig = {
+      access_token,
+      refresh_token,
+      client: 'cl13nt',
+      secret: 's3cr3t'
+    }
+
+    await getTokens(requestClient, authConfig)
+
+    expect(refreshTokensModule.refreshTokens).toHaveBeenCalledWith(
+      requestClient,
+      authConfig.client,
+      authConfig.secret,
+      authConfig.refresh_token
+    )
+  })
+
+  it('should throw an error if the refresh token has already expired', async () => {
+    setupMocks()
+    const access_token = generateToken(86400000)
+    const refresh_token = generateToken(-36000)
+    const authConfig: AuthConfig = {
+      access_token,
+      refresh_token,
+      client: 'cl13nt',
+      secret: 's3cr3t'
+    }
+    const expectedError =
+      'Unable to obtain new access token. Your refresh token has expired.'
+
+    const error = await getTokens(requestClient, authConfig).catch((e) => e)
+
+    expect(error.message).toEqual(expectedError)
+  })
+})
+
+const setupMocks = () => {
+  jest.restoreAllMocks()
+  jest.mock('../../request/RequestClient')
+  jest.mock('../refreshTokens')
+
+  jest
+    .spyOn(refreshTokensModule, 'refreshTokens')
+    .mockImplementation(() => Promise.resolve(mockAuthResponse))
+}

src/auth/spec/mockResponses.ts

@@ -1,2 +1,24 @@
+import { SasAuthResponse } from '@sasjs/utils/types'
+
 export const mockLoginAuthoriseRequiredResponse = `<form id="application_authorization" action="/SASLogon/oauth/authorize" method="POST"><input type="hidden" name="X-Uaa-Csrf" value="2nfuxIn6WaOURWL7tzTXCe"/>`
 export const mockLoginSuccessResponse = `You have signed in`
+
+export const mockAuthResponse: SasAuthResponse = {
+  access_token: 'acc355',
+  refresh_token: 'r3fr35h',
+  id_token: 'id',
+  token_type: 'bearer',
+  expires_in: new Date().valueOf(),
+  scope: 'default',
+  jti: 'test'
+}
+
+export const generateToken = (timeToLiveSeconds: number): string => {
+  const exp =
+    new Date(new Date().getTime() + timeToLiveSeconds * 1000).getTime() / 1000
+  const header = 'eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9'
+  const payload = Buffer.from(JSON.stringify({ exp })).toString('base64')
+  const signature = '4-iaDojEVl0pJQMjrbM1EzUIfAZgsbK_kgnVyVxFSVo'
+  const token = `${header}.${payload}.${signature}`
+  return token
+}

src/auth/spec/refreshTokens.spec.ts

@@ -0,0 +1,75 @@
+import { AuthConfig } from '@sasjs/utils'
+import * as NodeFormData from 'form-data'
+import { generateToken, mockAuthResponse } from './mockResponses'
+import { RequestClient } from '../../request/RequestClient'
+import { refreshTokens } from '../refreshTokens'
+
+const requestClient = new (<jest.Mock<RequestClient>>RequestClient)()
+
+describe('refreshTokens', () => {
+  it('should attempt to refresh tokens', async () => {
+    setupMocks()
+    const access_token = generateToken(30)
+    const refresh_token = generateToken(30)
+    const authConfig: AuthConfig = {
+      access_token,
+      refresh_token,
+      client: 'cl13nt',
+      secret: 's3cr3t'
+    }
+    jest
+      .spyOn(requestClient, 'post')
+      .mockImplementation(() =>
+        Promise.resolve({ result: mockAuthResponse, etag: '' })
+      )
+    const token = Buffer.from(
+      authConfig.client + ':' + authConfig.secret
+    ).toString('base64')
+
+    await refreshTokens(
+      requestClient,
+      authConfig.client,
+      authConfig.secret,
+      authConfig.refresh_token
+    )
+
+    expect(requestClient.post).toHaveBeenCalledWith(
+      '/SASLogon/oauth/token',
+      expect.any(NodeFormData),
+      undefined,
+      expect.stringContaining('multipart/form-data; boundary='),
+      {
+        Authorization: 'Basic ' + token
+      }
+    )
+  })
+
+  it('should handle errors while refreshing tokens', async () => {
+    setupMocks()
+    const access_token = generateToken(30)
+    const refresh_token = generateToken(30)
+    const authConfig: AuthConfig = {
+      access_token,
+      refresh_token,
+      client: 'cl13nt',
+      secret: 's3cr3t'
+    }
+    jest
+      .spyOn(requestClient, 'post')
+      .mockImplementation(() => Promise.reject('Token Error'))
+
+    const error = await refreshTokens(
+      requestClient,
+      authConfig.client,
+      authConfig.secret,
+      authConfig.refresh_token
+    ).catch((e) => e)
+
+    expect(error).toContain('Error while refreshing tokens')
+  })
+})
+
+const setupMocks = () => {
+  jest.restoreAllMocks()
+  jest.mock('../../request/RequestClient')
+}

src/auth/tokens.ts

@@ -1,122 +0,0 @@
-import {
-  AuthConfig,
-  isAccessTokenExpiring,
-  isRefreshTokenExpiring,
-  SasAuthResponse
-} from '@sasjs/utils'
-import * as NodeFormData from 'form-data'
-import { RequestClient } from '../request/RequestClient'
-
-/**
- * Exchanges the auth code for an access token for the given client.
- * @param requestClient - the pre-configured HTTP request client
- * @param clientId - the client ID to authenticate with.
- * @param clientSecret - the client secret to authenticate with.
- * @param authCode - the auth code received from the server.
- */
-export async function getAccessToken(
-  requestClient: RequestClient,
-  clientId: string,
-  clientSecret: string,
-  authCode: string
-): Promise<SasAuthResponse> {
-  const url = '/SASLogon/oauth/token'
-  let token
-  if (typeof Buffer === 'undefined') {
-    token = btoa(clientId + ':' + clientSecret)
-  } else {
-    token = Buffer.from(clientId + ':' + clientSecret).toString('base64')
-  }
-  const headers = {
-    Authorization: 'Basic ' + token
-  }
-
-  let formData
-  if (typeof FormData === 'undefined') {
-    formData = new NodeFormData()
-  } else {
-    formData = new FormData()
-  }
-  formData.append('grant_type', 'authorization_code')
-  formData.append('code', authCode)
-
-  const authResponse = await requestClient
-    .post(
-      url,
-      formData,
-      undefined,
-      'multipart/form-data; boundary=' + (formData as any)._boundary,
-      headers
-    )
-    .then((res) => res.result as SasAuthResponse)
-
-  return authResponse
-}
-
-/**
- * Returns the auth configuration, refreshing the tokens if necessary.
- * @param requestClient - the pre-configured HTTP request client
- * @param authConfig - an object containing a client ID, secret, access token and refresh token
- */
-export async function getTokens(
-  requestClient: RequestClient,
-  authConfig: AuthConfig
-): Promise<AuthConfig> {
-  const logger = process.logger || console
-  let { access_token, refresh_token, client, secret } = authConfig
-  if (
-    isAccessTokenExpiring(access_token) ||
-    isRefreshTokenExpiring(refresh_token)
-  ) {
-    logger.info('Refreshing access and refresh tokens.')
-    ;({ access_token, refresh_token } = await refreshTokens(
-      requestClient,
-      client,
-      secret,
-      refresh_token
-    ))
-  }
-  return { access_token, refresh_token, client, secret }
-}
-
-/**
- * Exchanges the refresh token for an access token for the given client.
- * @param requestClient - the pre-configured HTTP request client
- * @param clientId - the client ID to authenticate with.
- * @param clientSecret - the client secret to authenticate with.
- * @param authCode - the refresh token received from the server.
- */
-export async function refreshTokens(
-  requestClient: RequestClient,
-  clientId: string,
-  clientSecret: string,
-  refreshToken: string
-) {
-  const url = '/SASLogon/oauth/token'
-  let token
-  if (typeof Buffer === 'undefined') {
-    token = btoa(clientId + ':' + clientSecret)
-  } else {
-    token = Buffer.from(clientId + ':' + clientSecret).toString('base64')
-  }
-  const headers = {
-    Authorization: 'Basic ' + token
-  }
-
-  const formData =
-    typeof FormData === 'undefined' ? new NodeFormData() : new FormData()
-  formData.append('grant_type', 'refresh_token')
-  formData.append('refresh_token', refreshToken)
-
-  const authResponse = await requestClient
-    .post<SasAuthResponse>(
-      url,
-      formData,
-      undefined,
-      'multipart/form-data; boundary=' + (formData as any)._boundary,
-      headers
-    )
-    .then((res) => res.result)
-
-  return authResponse
-}