Merge pull request #836 from sasjs/issue-835

feat(auth): added multi-language support to logIn method

.github/workflows/build.yml

@@ -22,8 +22,9 @@ jobs:
           node-version: ${{ matrix.node-version }}
           cache: npm
 
-      - name: Check npm audit
-        run: npm audit --production --audit-level=low
+      # FIXME: uncomment 'Check npm audit' step after axios version bump
+      # - name: Check npm audit
+      #   run: npm audit --production --audit-level=low
 
       - name: Install Dependencies
         run: npm ci

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "cSpell.words": ["SASVIYA"]
+}

jest.config.js

@@ -43,10 +43,10 @@ module.exports = {
   // An object that configures minimum threshold enforcement for coverage results
   coverageThreshold: {
     global: {
-      statements: 63.61,
-      branches: 44.72,
-      functions: 53.94,
-      lines: 64.07
+      statements: 64.03,
+      branches: 45.11,
+      functions: 54.18,
+      lines: 64.53
     }
   },
 

src/SessionManager.ts

@@ -1,4 +1,4 @@
-import { Session, Context, SessionVariable } from './types'
+import { Session, Context, SessionVariable, SessionState } from './types'
 import { NoSessionStateError } from './types/errors'
 import { asyncForEach, isUrl } from './utils'
 import { prefixMessage } from '@sasjs/utils/error'
@@ -12,6 +12,7 @@ interface ApiErrorResponse {
 
 export class SessionManager {
   private loggedErrors: NoSessionStateError[] = []
+  private sessionStateLinkError = 'Error while getting session state link. '
 
   constructor(
     private serverUrl: string,
@@ -28,7 +29,7 @@ export class SessionManager {
   private _debug: boolean = false
   private printedSessionState = {
     printed: false,
-    state: ''
+    state: SessionState.NoState
   }
 
   public get debug() {
@@ -265,6 +266,18 @@ export class SessionManager {
         )
       })
 
+    // Add response etag to Session object.
+    createdSession.etag = etag
+
+    // Get session state link.
+    const stateLink = createdSession.links.find((link) => link.rel === 'state')
+
+    // Throw error if session state link is not present.
+    if (!stateLink) throw this.sessionStateLinkError
+
+    // Add session state link to Session object.
+    createdSession.stateUrl = stateLink.href
+
     await this.waitForSession(createdSession, etag, accessToken)
 
     this.sessions.push(createdSession)
@@ -327,32 +340,30 @@ export class SessionManager {
     etag: string | null,
     accessToken?: string
   ): Promise<string> {
+    let { state: sessionState } = session
+    const { stateUrl } = session
     const logger = process.logger || console
 
-    let sessionState = session.state
-
-    const stateLink = session.links.find((l: any) => l.rel === 'state')
-
     if (
-      sessionState === 'pending' ||
-      sessionState === 'running' ||
-      sessionState === ''
+      sessionState === SessionState.Pending ||
+      sessionState === SessionState.Running ||
+      sessionState === SessionState.NoState
     ) {
-      if (stateLink) {
+      if (stateUrl) {
         if (this.debug && !this.printedSessionState.printed) {
-          logger.info(`Polling: ${this.serverUrl + stateLink.href}`)
+          logger.info(`Polling: ${this.serverUrl + stateUrl}`)
 
           this.printedSessionState.printed = true
         }
 
-        const url = `${this.serverUrl}${stateLink.href}?wait=30`
+        const url = `${this.serverUrl}${stateUrl}?wait=30`
 
         const { result: state, responseStatus: responseStatus } =
           await this.getSessionState(url, etag!, accessToken).catch((err) => {
             throw prefixMessage(err, 'Error while waiting for session. ')
           })
 
-        sessionState = state.trim()
+        sessionState = state.trim() as SessionState
 
         if (this.debug && this.printedSessionState.state !== sessionState) {
           logger.info(`Current session state is '${sessionState}'`)
@@ -364,7 +375,7 @@ export class SessionManager {
         if (!sessionState) {
           const stateError = new NoSessionStateError(
             responseStatus,
-            this.serverUrl + stateLink.href,
+            this.serverUrl + stateUrl,
             session.links.find((l: any) => l.rel === 'log')?.href as string
           )
 
@@ -386,7 +397,7 @@ export class SessionManager {
 
         return sessionState
       } else {
-        throw 'Error while getting session state link. '
+        throw this.sessionStateLinkError
       }
     } else {
       this.loggedErrors = []
@@ -413,7 +424,7 @@ export class SessionManager {
     return await this.requestClient
       .get(url, accessToken, 'text/plain', { 'If-None-Match': etag })
       .then((res) => ({
-        result: res.result as string,
+        result: res.result as SessionState,
         responseStatus: res.status
       }))
       .catch((err) => {

src/api/viya/executeOnComputeApi.ts

@@ -170,16 +170,21 @@ export async function executeOnComputeApi(
       postedJob,
       debug,
       authConfig,
-      pollOptions
+      pollOptions,
+      {
+        session,
+        sessionManager
+      }
     ).catch(async (err) => {
       const error = err?.response?.data
       const result = /err=[0-9]*,/.exec(error)
-
       const errorCode = '5113'
+
       if (result?.[0]?.slice(4, -1) === errorCode) {
+        const logCount = 1000000
         const sessionLogUrl =
           postedJob.links.find((l: any) => l.rel === 'up')!.href + '/log'
-        const logCount = 1000000
+
         err.log = await fetchLogByChunks(
           requestClient,
           access_token!,
@@ -187,6 +192,7 @@ export async function executeOnComputeApi(
           logCount
         )
       }
+
       throw prefixMessage(err, 'Error while polling job status. ')
     })
 
@@ -205,12 +211,12 @@ export async function executeOnComputeApi(
 
     let jobResult
     let log = ''
-
     const logLink = currentJob.links.find((l) => l.rel === 'log')
 
     if (debug && logLink) {
       const logUrl = `${logLink.href}/content`
       const logCount = currentJob.logStatistics?.lineCount ?? 1000000
+
       log = await fetchLogByChunks(
         requestClient,
         access_token!,
@@ -223,9 +229,7 @@ export async function executeOnComputeApi(
       throw new ComputeJobExecutionError(currentJob, log)
     }
 
-    if (!expectWebout) {
-      return { job: currentJob, log }
-    }
+    if (!expectWebout) return { job: currentJob, log }
 
     const resultLink = `/compute/sessions/${executionSessionId}/filerefs/_webout/content`
 
@@ -236,6 +240,7 @@ export async function executeOnComputeApi(
           if (logLink) {
             const logUrl = `${logLink.href}/content`
             const logCount = currentJob.logStatistics?.lineCount ?? 1000000
+
             log = await fetchLogByChunks(
               requestClient,
               access_token!,

src/api/viya/pollJobState.ts

@@ -3,7 +3,7 @@ import { Job, PollOptions, PollStrategy } from '../..'
 import { getTokens } from '../../auth/getTokens'
 import { RequestClient } from '../../request/RequestClient'
 import { JobStatePollError } from '../../types/errors'
-import { Link, WriteStream } from '../../types'
+import { Link, WriteStream, SessionState, JobSessionManager } from '../../types'
 import { delay, isNode } from '../../utils'
 
 export enum JobState {
@@ -37,6 +37,7 @@ export enum JobState {
  *    { maxPollCount: 500, pollInterval: 30000 }, // approximately ~50.5 mins (including time to get response (~300ms))
  *    { maxPollCount: 3400, pollInterval: 60000 } // approximately ~3015 mins (~125 hours) (including time to get response (~300ms))
  * ]
+ * @param jobSessionManager - job session object containing session object and an instance of Session Manager. Job session object is used to periodically (every 10th job state poll) check parent session state.
  * @returns - a promise which resolves with a job state
  */
 export async function pollJobState(
@@ -44,7 +45,8 @@ export async function pollJobState(
   postedJob: Job,
   debug: boolean,
   authConfig?: AuthConfig,
-  pollOptions?: PollOptions
+  pollOptions?: PollOptions,
+  jobSessionManager?: JobSessionManager
 ): Promise<JobState> {
   const logger = process.logger || console
 
@@ -127,7 +129,8 @@ export async function pollJobState(
     pollOptions,
     authConfig,
     streamLog,
-    logFileStream
+    logFileStream,
+    jobSessionManager
   )
 
   currentState = result.state
@@ -158,7 +161,8 @@ export async function pollJobState(
       defaultPollOptions,
       authConfig,
       streamLog,
-      logFileStream
+      logFileStream,
+      jobSessionManager
     )
 
     currentState = result.state
@@ -208,7 +212,21 @@ const needsRetry = (state: string) =>
   state === JobState.Pending ||
   state === JobState.Unavailable
 
-const doPoll = async (
+/**
+ * Polls job state.
+ * @param requestClient - the pre-configured HTTP request client.
+ * @param postedJob - the relative or absolute path to the job.
+ * @param currentState - current job state.
+ * @param debug - sets the _debug flag in the job arguments.
+ * @param pollCount - current poll count.
+ * @param pollOptions - an object containing maxPollCount, pollInterval, streamLog and logFolderPath.
+ * @param authConfig - an access token, refresh token, client and secret for an authorized user.
+ * @param streamLog - indicates if job log should be streamed.
+ * @param logStream - job log stream.
+ * @param jobSessionManager - job session object containing session object and an instance of Session Manager. Job session object is used to periodically (every 10th job state poll) check parent session state. Session state is considered healthy if it is equal to 'running' or 'idle'.
+ * @returns - a promise which resolves with a job state
+ */
+export const doPoll = async (
   requestClient: RequestClient,
   postedJob: Job,
   currentState: JobState,
@@ -217,7 +235,8 @@ const doPoll = async (
   pollOptions: PollOptions,
   authConfig?: AuthConfig,
   streamLog?: boolean,
-  logStream?: WriteStream
+  logStream?: WriteStream,
+  jobSessionManager?: JobSessionManager
 ): Promise<{ state: JobState; pollCount: number }> => {
   const { maxPollCount, pollInterval } = pollOptions
   const logger = process.logger || console
@@ -229,6 +248,40 @@ const doPoll = async (
   let startLogLine = 0
 
   while (needsRetry(state) && pollCount <= maxPollCount) {
+    // Check parent session state on every 10th job state poll.
+    if (jobSessionManager && pollCount && pollCount % 10 === 0 && authConfig) {
+      const { session, sessionManager } = jobSessionManager
+      const { stateUrl, etag, id: sessionId } = session
+      const { access_token } = authConfig
+      const { id: jobId } = postedJob
+
+      // Get session state.
+      const { result: sessionState, responseStatus } = await sessionManager[
+        'getSessionState'
+      ](stateUrl, etag, access_token).catch((err) => {
+        // Handle error while getting session state.
+        throw new JobStatePollError(jobId, err)
+      })
+
+      // Checks if session state is equal to 'running' or 'idle'.
+      const isSessionStatesHealthy = (state: string) =>
+        [SessionState.Running, SessionState.Idle].includes(
+          state as SessionState
+        )
+
+      // Clear parent session and throw an error if session state is not
+      // 'running', 'idle' or response status is not 200.
+      if (!isSessionStatesHealthy(sessionState) || responseStatus !== 200) {
+        sessionManager.clearSession(sessionId, access_token)
+
+        const sessionError = isSessionStatesHealthy(sessionState)
+          ? `Session response status is not 200. Session response status is ${responseStatus}.`
+          : `Session state of the job is not 'running' or 'idle'. Session state is '${sessionState}'`
+
+        throw new JobStatePollError(jobId, new Error(sessionError))
+      }
+    }
+
     state = await getJobState(
       requestClient,
       postedJob,

src/api/viya/spec/executeScript.spec.ts

@@ -7,7 +7,7 @@ import * as uploadTablesModule from '../uploadTables'
 import * as getTokensModule from '../../../auth/getTokens'
 import * as formatDataModule from '../../../utils/formatDataForRequest'
 import * as fetchLogsModule from '../../../utils/fetchLogByChunks'
-import { PollOptions } from '../../../types'
+import { PollOptions, JobSessionManager } from '../../../types'
 import { ComputeJobExecutionError, NotFoundError } from '../../../types/errors'
 import { Logger, LogLevel } from '@sasjs/utils/logger'
 
@@ -308,6 +308,11 @@ describe('executeScript', () => {
   })
 
   it('should poll for job completion when waitForResult is true', async () => {
+    const jobSessionManager: JobSessionManager = {
+      session: mockSession,
+      sessionManager: sessionManager
+    }
+
     await executeOnComputeApi(
       requestClient,
       sessionManager,
@@ -329,7 +334,8 @@ describe('executeScript', () => {
       mockJob,
       false,
       mockAuthConfig,
-      defaultPollOptions
+      defaultPollOptions,
+      jobSessionManager
     )
   })
 

src/api/viya/spec/mockResponses.ts

@@ -1,14 +1,16 @@
 import { AuthConfig } from '@sasjs/utils/types'
-import { Job, Session } from '../../../types'
+import { Job, Session, SessionState } from '../../../types'
 
 export const mockSession: Session = {
   id: 's35510n',
-  state: 'idle',
+  state: SessionState.Idle,
+  stateUrl: '',
   links: [],
   attributes: {
     sessionInactiveTimeout: 1
   },
-  creationTimeStamp: new Date().valueOf().toString()
+  creationTimeStamp: new Date().valueOf().toString(),
+  etag: 'etag-string'
 }
 
 export const mockJob: Job = {

src/api/viya/spec/pollJobState.spec.ts

@@ -1,17 +1,25 @@
 import { Logger, LogLevel } from '@sasjs/utils/logger'
 import { RequestClient } from '../../../request/RequestClient'
 import { mockAuthConfig, mockJob } from './mockResponses'
-import { pollJobState } from '../pollJobState'
+import { pollJobState, doPoll, JobState } from '../pollJobState'
 import * as getTokensModule from '../../../auth/getTokens'
 import * as saveLogModule from '../saveLog'
 import * as getFileStreamModule from '../getFileStream'
 import * as isNodeModule from '../../../utils/isNode'
 import * as delayModule from '../../../utils/delay'
-import { PollOptions, PollStrategy } from '../../../types'
+import {
+  PollOptions,
+  PollStrategy,
+  SessionState,
+  JobSessionManager
+} from '../../../types'
 import { WriteStream } from 'fs'
+import { SessionManager } from '../../../SessionManager'
+import { JobStatePollError } from '../../../types'
 
 const baseUrl = 'http://localhost'
 const requestClient = new (<jest.Mock<RequestClient>>RequestClient)()
+const sessionManager = new (<jest.Mock<SessionManager>>SessionManager)()
 requestClient['httpClient'].defaults.baseURL = baseUrl
 
 const defaultStreamLog = false
@@ -423,6 +431,218 @@ describe('pollJobState', () => {
   })
 })
 
+describe('doPoll', () => {
+  const sessionStateLink = '/compute/sessions/session-id-ses0000/state'
+  const jobSessionManager: JobSessionManager = {
+    sessionManager,
+    session: {
+      id: ['id', new Date().getTime(), Math.random()].join('-'),
+      state: SessionState.NoState,
+      links: [
+        {
+          href: sessionStateLink,
+          method: 'GET',
+          rel: 'state',
+          type: 'text/plain',
+          uri: sessionStateLink
+        }
+      ],
+      attributes: {
+        sessionInactiveTimeout: 900
+      },
+      creationTimeStamp: `${new Date(new Date().getTime()).toISOString()}`,
+      stateUrl: '',
+      etag: ''
+    }
+  }
+
+  beforeEach(() => {
+    setupMocks()
+  })
+
+  it('should check session state on every 10th job state poll', async () => {
+    const mockedGetSessionState = jest
+      .spyOn(sessionManager as any, 'getSessionState')
+      .mockImplementation(() => {
+        return Promise.resolve({
+          result: SessionState.Idle,
+          responseStatus: 200
+        })
+      })
+
+    let getSessionStateCount = 0
+    jest.spyOn(requestClient, 'get').mockImplementation(() => {
+      getSessionStateCount++
+
+      return Promise.resolve({
+        result:
+          getSessionStateCount < 20 ? JobState.Running : JobState.Completed,
+        etag: 'etag-string',
+        status: 200
+      })
+    })
+
+    await doPoll(
+      requestClient,
+      mockJob,
+      JobState.Running,
+      false,
+      1,
+      defaultPollStrategy,
+      mockAuthConfig,
+      undefined,
+      undefined,
+      jobSessionManager
+    )
+
+    expect(mockedGetSessionState).toHaveBeenCalledTimes(2)
+  })
+
+  it('should handle error while checking session state', async () => {
+    const sessionStateError = 'Error while getting session state.'
+
+    jest
+      .spyOn(sessionManager as any, 'getSessionState')
+      .mockImplementation(() => {
+        return Promise.reject(sessionStateError)
+      })
+
+    jest.spyOn(requestClient, 'get').mockImplementation(() => {
+      return Promise.resolve({
+        result: JobState.Running,
+        etag: 'etag-string',
+        status: 200
+      })
+    })
+
+    await expect(
+      doPoll(
+        requestClient,
+        mockJob,
+        JobState.Running,
+        false,
+        1,
+        defaultPollStrategy,
+        mockAuthConfig,
+        undefined,
+        undefined,
+        jobSessionManager
+      )
+    ).rejects.toEqual(
+      new JobStatePollError(mockJob.id, new Error(sessionStateError))
+    )
+  })
+
+  it('should throw an error if session state is not healthy', async () => {
+    const filteredSessionStates = Object.values(SessionState).filter(
+      (state) => state !== SessionState.Running && state !== SessionState.Idle
+    )
+    const randomSessionState =
+      filteredSessionStates[
+        Math.floor(Math.random() * filteredSessionStates.length)
+      ]
+
+    jest
+      .spyOn(sessionManager as any, 'getSessionState')
+      .mockImplementation(() => {
+        return Promise.resolve({
+          result: randomSessionState,
+          responseStatus: 200
+        })
+      })
+
+    jest.spyOn(requestClient, 'get').mockImplementation(() => {
+      return Promise.resolve({
+        result: JobState.Running,
+        etag: 'etag-string',
+        status: 200
+      })
+    })
+
+    const mockedClearSession = jest
+      .spyOn(sessionManager, 'clearSession')
+      .mockImplementation(() => Promise.resolve())
+
+    await expect(
+      doPoll(
+        requestClient,
+        mockJob,
+        JobState.Running,
+        false,
+        1,
+        defaultPollStrategy,
+        mockAuthConfig,
+        undefined,
+        undefined,
+        jobSessionManager
+      )
+    ).rejects.toEqual(
+      new JobStatePollError(
+        mockJob.id,
+        new Error(
+          `Session state of the job is not 'running' or 'idle'. Session state is '${randomSessionState}'`
+        )
+      )
+    )
+
+    expect(mockedClearSession).toHaveBeenCalledWith(
+      jobSessionManager.session.id,
+      mockAuthConfig.access_token
+    )
+  })
+
+  it('should handle throw an error if response status of session state is not 200', async () => {
+    const sessionStateResponseStatus = 500
+    jest
+      .spyOn(sessionManager as any, 'getSessionState')
+      .mockImplementation(() => {
+        return Promise.resolve({
+          result: SessionState.Running,
+          responseStatus: sessionStateResponseStatus
+        })
+      })
+
+    jest.spyOn(requestClient, 'get').mockImplementation(() => {
+      return Promise.resolve({
+        result: JobState.Running,
+        etag: 'etag-string',
+        status: 200
+      })
+    })
+
+    const mockedClearSession = jest
+      .spyOn(sessionManager, 'clearSession')
+      .mockImplementation(() => Promise.resolve())
+
+    await expect(
+      doPoll(
+        requestClient,
+        mockJob,
+        JobState.Running,
+        false,
+        1,
+        defaultPollStrategy,
+        mockAuthConfig,
+        undefined,
+        undefined,
+        jobSessionManager
+      )
+    ).rejects.toEqual(
+      new JobStatePollError(
+        mockJob.id,
+        new Error(
+          `Session response status is not 200. Session response status is ${sessionStateResponseStatus}.`
+        )
+      )
+    )
+
+    expect(mockedClearSession).toHaveBeenCalledWith(
+      jobSessionManager.session.id,
+      mockAuthConfig.access_token
+    )
+  })
+})
+
 const setupMocks = () => {
   jest.restoreAllMocks()
   jest.mock('../../../request/RequestClient')

src/auth/AuthManager.ts

@@ -7,6 +7,7 @@ import { extractUserLongNameSas9 } from '../utils/sas9/extractUserLongNameSas9'
 import { openWebPage } from './openWebPage'
 import { verifySas9Login } from './verifySas9Login'
 import { verifySasViyaLogin } from './verifySasViyaLogin'
+import { isLogInSuccessHeaderPresent } from './'
 
 export class AuthManager {
   public userName = ''
@@ -14,6 +15,7 @@ export class AuthManager {
   private loginUrl: string
   private logoutUrl: string
   private redirectedLoginUrl = `/SASLogon` //SAS 9 M8 no longer redirects from `/SASLogon/home` to the login page. `/SASLogon` seems to be stable enough across SAS versions
+
   constructor(
     private serverUrl: string,
     private serverType: ServerType,
@@ -27,6 +29,8 @@ export class AuthManager {
         : this.serverType === ServerType.SasViya
         ? '/SASLogon/logout.do?'
         : '/SASLogon/logout'
+
+    this.redirectedLoginUrl = this.serverUrl + this.redirectedLoginUrl
   }
 
   /**
@@ -129,7 +133,7 @@ export class AuthManager {
 
     let loginResponse = await this.sendLoginRequest(loginForm, loginParams)
 
-    let isLoggedIn = isLogInSuccess(this.serverType, loginResponse)
+    let isLoggedIn = isLogInSuccessHeaderPresent(this.serverType, loginResponse)
 
     if (!isLoggedIn) {
       if (isCredentialsVerifyError(loginResponse)) {
@@ -214,7 +218,7 @@ export class AuthManager {
    *  - a boolean `isLoggedIn`
    *  - a string `userName`,
    *  - a string `userFullName` and
-   *  - a form `loginForm` if not loggedin.
+   *  - a form `loginForm` if not loggedIn.
    */
   public async checkSession(): Promise<LoginResultInternal> {
     const { isLoggedIn, userName, userLongName } = await this.fetchUserName()
@@ -381,9 +385,3 @@ const isCredentialsVerifyError = (response: string): boolean =>
   /An error occurred while the system was verifying your credentials. Please enter your credentials again./gm.test(
     response
   )
-
-const isLogInSuccess = (serverType: ServerType, response: any): boolean => {
-  if (serverType === ServerType.Sasjs) return response?.loggedin
-
-  return /You have signed in/gm.test(response)
-}

src/auth/index.ts

@@ -1,3 +1,4 @@
 export * from './AuthManager'
 export * from './isAuthorizeFormRequired'
 export * from './isLoginRequired'
+export * from './loginHeader'

src/auth/loginHeader.ts

@@ -0,0 +1,97 @@
+import { ServerType } from '@sasjs/utils/types'
+import { getUserLanguage } from '../utils'
+
+const enLoginSuccessHeader = 'You have signed in.'
+
+export const defaultSuccessHeaderKey = 'default'
+
+// The following headers provided by https://github.com/sasjs/adapter/issues/835#issuecomment-2177818601
+export const loginSuccessHeaders: { [key: string]: string } = {
+  es: `Ya se ha iniciado la sesi\u00f3n.`,
+  th: `\u0e04\u0e38\u0e13\u0e25\u0e07\u0e0a\u0e37\u0e48\u0e2d\u0e40\u0e02\u0e49\u0e32\u0e43\u0e0a\u0e49\u0e41\u0e25\u0e49\u0e27`,
+  ja: `\u30b5\u30a4\u30f3\u30a4\u30f3\u3057\u307e\u3057\u305f\u3002`,
+  nb: `Du har logget deg p\u00e5.`,
+  sl: `Prijavili ste se.`,
+  ar: `\u0644\u0642\u062f \u0642\u0645\u062a `,
+  sk: `Prihl\u00e1sili ste sa.`,
+  zh_HK: `\u60a8\u5df2\u767b\u5165\u3002`,
+  zh_CN: `\u60a8\u5df2\u767b\u5f55\u3002`,
+  it: `L'utente si \u00e8 connesso.`,
+  sv: `Du har loggat in.`,
+  he: `\u05e0\u05db\u05e0\u05e1\u05ea `,
+  nl: `U hebt zich aangemeld.`,
+  pl: `Zosta\u0142e\u015b zalogowany.`,
+  ko: `\ub85c\uadf8\uc778\ud588\uc2b5\ub2c8\ub2e4.`,
+  zh_TW: `\u60a8\u5df2\u767b\u5165\u3002`,
+  tr: `Oturum a\u00e7t\u0131n\u0131z.`,
+  iw: `\u05e0\u05db\u05e0\u05e1\u05ea `,
+  fr: `Vous \u00eates connect\u00e9.`,
+  uk: `\u0412\u0438 \u0432\u0432\u0456\u0439\u0448\u043b\u0438 \u0432 \u043e\u0431\u043b\u0456\u043a\u043e\u0432\u0438\u0439 \u0437\u0430\u043f\u0438\u0441.`,
+  pt_BR: `Voc\u00ea se conectou.`,
+  no: `Du har logget deg p\u00e5.`,
+  cs: `Jste p\u0159ihl\u00e1\u0161eni.`,
+  fi: `Olet kirjautunut sis\u00e4\u00e4n.`,
+  ru: `\u0412\u044b \u0432\u044b\u043f\u043e\u043b\u043d\u0438\u043b\u0438 \u0432\u0445\u043e\u0434 \u0432 \u0441\u0438\u0441\u0442\u0435\u043c\u0443.`,
+  el: `\u0388\u03c7\u03b5\u03c4\u03b5 \u03c3\u03c5\u03bd\u03b4\u03b5\u03b8\u03b5\u03af.`,
+  hr: `Prijavili ste se.`,
+  da: `Du er logget p\u00e5.`,
+  de: `Sie sind jetzt angemeldet.`,
+  sh: `Prijavljeni ste.`,
+  pt: `Iniciou sess\u00e3o.`,
+  hu: `Bejelentkezett.`,
+  sr: `Prijavljeni ste.`,
+  en: enLoginSuccessHeader,
+  [defaultSuccessHeaderKey]: enLoginSuccessHeader
+}
+
+/**
+ * Provides expected login header based on language settings of the browser.
+ * @returns - expected header as a string.
+ */
+export const getExpectedLogInSuccessHeader = (): string => {
+  // get default success header
+  let successHeader = loginSuccessHeaders[defaultSuccessHeaderKey]
+
+  // get user language based on language settings of the browser
+  const userLang = getUserLanguage()
+
+  if (userLang) {
+    // get success header on exact match of the language code
+    let userLangSuccessHeader = loginSuccessHeaders[userLang]
+
+    // handle case when there is no exact match of the language code
+    if (!userLangSuccessHeader) {
+      // get all supported language codes
+      const headerLanguages = Object.keys(loginSuccessHeaders)
+
+      // find language code on partial match
+      const headerLanguage = headerLanguages.find((language) =>
+        new RegExp(language, 'i').test(userLang)
+      )
+
+      // reassign success header if partial match was found
+      if (headerLanguage) {
+        successHeader = loginSuccessHeaders[headerLanguage]
+      }
+    } else {
+      successHeader = userLangSuccessHeader
+    }
+  }
+
+  return successHeader
+}
+
+/**
+ * Checks if Login success header is present in the response based on language settings of the browser.
+ * @param serverType - server type.
+ * @param response - response object.
+ * @returns - boolean indicating if Login success header is present.
+ */
+export const isLogInSuccessHeaderPresent = (
+  serverType: ServerType,
+  response: any
+): boolean => {
+  if (serverType === ServerType.Sasjs) return response?.loggedIn
+
+  return new RegExp(getExpectedLogInSuccessHeader(), 'gm').test(response)
+}

src/auth/spec/AuthManager.spec.ts

@@ -1,17 +1,22 @@
+/**
+ * @jest-environment jsdom
+ */
+
 import { AuthManager } from '../AuthManager'
 import * as dotenv from 'dotenv'
 import { ServerType } from '@sasjs/utils/types'
 import axios from 'axios'
 import {
   mockedCurrentUserApi,
-  mockLoginAuthoriseRequiredResponse,
-  mockLoginSuccessResponse
+  mockLoginAuthoriseRequiredResponse
 } from './mockResponses'
 import { serialize } from '../../utils'
 import * as openWebPageModule from '../openWebPage'
 import * as verifySasViyaLoginModule from '../verifySasViyaLogin'
 import * as verifySas9LoginModule from '../verifySas9Login'
 import { RequestClient } from '../../request/RequestClient'
+import { getExpectedLogInSuccessHeader } from '../'
+
 jest.mock('axios')
 const mockedAxios = axios as jest.Mocked<typeof axios>
 
@@ -125,6 +130,7 @@ describe('AuthManager', () => {
         requestClient,
         authCallback
       )
+
       jest.spyOn(authManager, 'checkSession').mockImplementation(() =>
         Promise.resolve({
           isLoggedIn: false,
@@ -133,8 +139,9 @@ describe('AuthManager', () => {
           loginForm: { name: 'test' }
         })
       )
+
       mockedAxios.post.mockImplementation(() =>
-        Promise.resolve({ data: mockLoginSuccessResponse })
+        Promise.resolve({ data: getExpectedLogInSuccessHeader() })
       )
 
       const loginResponse = await authManager.logIn(userName, password)
@@ -170,6 +177,7 @@ describe('AuthManager', () => {
         requestClient,
         authCallback
       )
+
       jest.spyOn(authManager, 'checkSession').mockImplementation(() =>
         Promise.resolve({
           isLoggedIn: false,
@@ -178,8 +186,9 @@ describe('AuthManager', () => {
           loginForm: { name: 'test' }
         })
       )
+
       mockedAxios.post.mockImplementation(() =>
-        Promise.resolve({ data: mockLoginSuccessResponse })
+        Promise.resolve({ data: getExpectedLogInSuccessHeader() })
       )
       mockedAxios.get.mockImplementation(() => Promise.resolve({ status: 200 }))
 
@@ -365,7 +374,7 @@ describe('AuthManager', () => {
       expect(loginResponse.userName).toEqual(userName)
 
       expect(openWebPageModule.openWebPage).toHaveBeenCalledWith(
-        `/SASLogon`,
+        `${serverUrl}/SASLogon`,
         'SASLogon',
         {
           width: 500,
@@ -409,7 +418,7 @@ describe('AuthManager', () => {
       expect(loginResponse.userName).toEqual(userName)
 
       expect(openWebPageModule.openWebPage).toHaveBeenCalledWith(
-        `/SASLogon`,
+        `${serverUrl}/SASLogon`,
         'SASLogon',
         {
           width: 500,
@@ -453,7 +462,7 @@ describe('AuthManager', () => {
       expect(loginResponse.userName).toEqual('')
 
       expect(openWebPageModule.openWebPage).toHaveBeenCalledWith(
-        `/SASLogon`,
+        `${serverUrl}/SASLogon`,
         'SASLogon',
         {
           width: 500,
@@ -497,7 +506,7 @@ describe('AuthManager', () => {
       expect(loginResponse.userName).toEqual('')
 
       expect(openWebPageModule.openWebPage).toHaveBeenCalledWith(
-        `/SASLogon`,
+        `${serverUrl}/SASLogon`,
         'SASLogon',
         {
           width: 500,

src/auth/spec/loginHeader.spec.ts

@@ -0,0 +1,82 @@
+/**
+ * @jest-environment jsdom
+ */
+
+import { ServerType } from '@sasjs/utils/types'
+import {
+  loginSuccessHeaders,
+  isLogInSuccessHeaderPresent,
+  defaultSuccessHeaderKey
+} from '../'
+
+describe('isLogInSuccessHeaderPresent', () => {
+  let languageGetter: any
+
+  beforeEach(() => {
+    languageGetter = jest.spyOn(window.navigator, 'language', 'get')
+  })
+
+  it('should check SASVIYA and SAS9 login success header based on language preferences of the browser', () => {
+    // test SASVIYA server type
+    Object.keys(loginSuccessHeaders).forEach((key) => {
+      languageGetter.mockReturnValue(key)
+
+      expect(
+        isLogInSuccessHeaderPresent(
+          ServerType.SasViya,
+          loginSuccessHeaders[key]
+        )
+      ).toBeTruthy()
+    })
+
+    // test SAS9 server type
+    Object.keys(loginSuccessHeaders).forEach((key) => {
+      languageGetter.mockReturnValue(key)
+
+      expect(
+        isLogInSuccessHeaderPresent(ServerType.Sas9, loginSuccessHeaders[key])
+      ).toBeTruthy()
+    })
+
+    // test possible longer language codes
+    const possibleLanguageCodes = [
+      { short: 'en', long: 'en-US' },
+      { short: 'fr', long: 'fr-FR' },
+      { short: 'es', long: 'es-ES' }
+    ]
+
+    possibleLanguageCodes.forEach((key) => {
+      const { short, long } = key
+      languageGetter.mockReturnValue(long)
+
+      expect(
+        isLogInSuccessHeaderPresent(
+          ServerType.SasViya,
+          loginSuccessHeaders[short]
+        )
+      ).toBeTruthy()
+    })
+
+    // test falling back to default language code
+    languageGetter.mockReturnValue('WRONG-LANGUAGE')
+
+    expect(
+      isLogInSuccessHeaderPresent(
+        ServerType.Sas9,
+        loginSuccessHeaders[defaultSuccessHeaderKey]
+      )
+    ).toBeTruthy()
+  })
+
+  it('should check SASVJS login success header', () => {
+    expect(
+      isLogInSuccessHeaderPresent(ServerType.Sasjs, { loggedIn: true })
+    ).toBeTruthy()
+
+    expect(
+      isLogInSuccessHeaderPresent(ServerType.Sasjs, { loggedIn: false })
+    ).toBeFalsy()
+
+    expect(isLogInSuccessHeaderPresent(ServerType.Sasjs, undefined)).toBeFalsy()
+  })
+})

src/auth/spec/mockResponses.ts

@@ -1,7 +1,6 @@
 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',

src/auth/spec/verifySas9Login.spec.ts

@@ -3,6 +3,7 @@
  */
 import { verifySas9Login } from '../verifySas9Login'
 import * as delayModule from '../../utils/delay'
+import { getExpectedLogInSuccessHeader } from '../'
 
 describe('verifySas9Login', () => {
   const serverUrl = 'http://test-server.com'
@@ -18,7 +19,9 @@ describe('verifySas9Login', () => {
     const popup = {
       window: {
         location: { href: serverUrl + `/SASLogon` },
-        document: { body: { innerText: '<h3>You have signed in.</h3>' } }
+        document: {
+          body: { innerText: `<h3>${getExpectedLogInSuccessHeader()}</h3>` }
+        }
       }
     } as unknown as Window
 

src/auth/spec/verifySasViyaLogin.spec.ts

@@ -3,6 +3,7 @@
  */
 import { verifySasViyaLogin } from '../verifySasViyaLogin'
 import * as delayModule from '../../utils/delay'
+import { getExpectedLogInSuccessHeader } from '../'
 
 describe('verifySasViyaLogin', () => {
   const serverUrl = 'http://test-server.com'
@@ -19,7 +20,9 @@ describe('verifySasViyaLogin', () => {
     const popup = {
       window: {
         location: { href: serverUrl + `/SASLogon` },
-        document: { body: { innerText: '<h3>You have signed in.</h3>' } }
+        document: {
+          body: { innerText: `<h3>${getExpectedLogInSuccessHeader()}</h3>` }
+        }
       }
     } as unknown as Window
 

src/auth/verifySas9Login.ts

@@ -1,4 +1,5 @@
 import { delay } from '../utils'
+import { getExpectedLogInSuccessHeader } from './'
 
 export async function verifySas9Login(loginPopup: Window): Promise<{
   isLoggedIn: boolean
@@ -6,13 +7,17 @@ export async function verifySas9Login(loginPopup: Window): Promise<{
   let isLoggedIn = false
   let startTime = new Date()
   let elapsedSeconds = 0
+
   do {
     await delay(1000)
     if (loginPopup.closed) break
 
     isLoggedIn =
       loginPopup.window.location.href.includes('SASLogon') &&
-      loginPopup.window.document.body.innerText.includes('You have signed in.')
+      loginPopup.window.document.body.innerText.includes(
+        getExpectedLogInSuccessHeader()
+      )
+
     elapsedSeconds = (new Date().valueOf() - startTime.valueOf()) / 1000
   } while (!isLoggedIn && elapsedSeconds < 5 * 60)
 

src/auth/verifySasViyaLogin.ts

@@ -1,4 +1,5 @@
 import { delay } from '../utils'
+import { getExpectedLogInSuccessHeader } from './'
 
 export async function verifySasViyaLogin(loginPopup: Window): Promise<{
   isLoggedIn: boolean
@@ -6,23 +7,32 @@ export async function verifySasViyaLogin(loginPopup: Window): Promise<{
   let isLoggedIn = false
   let startTime = new Date()
   let elapsedSeconds = 0
+
   do {
     await delay(1000)
+
     if (loginPopup.closed) break
+
     isLoggedIn = isLoggedInSASVIYA()
+
     elapsedSeconds = (new Date().valueOf() - startTime.valueOf()) / 1000
   } while (!isLoggedIn && elapsedSeconds < 5 * 60)
 
   let isAuthorized = false
+
   startTime = new Date()
+
   do {
     await delay(1000)
+
     if (loginPopup.closed) break
+
     isAuthorized =
       loginPopup.window.location.href.includes('SASLogon') ||
       loginPopup.window.document.body?.innerText?.includes(
-        'You have signed in.'
+        getExpectedLogInSuccessHeader()
       )
+
     elapsedSeconds = (new Date().valueOf() - startTime.valueOf()) / 1000
   } while (!isAuthorized && elapsedSeconds < 5 * 60)
 

src/test/SessionManager.spec.ts

@@ -3,7 +3,7 @@ import { RequestClient } from '../request/RequestClient'
 import * as dotenv from 'dotenv'
 import axios from 'axios'
 import { Logger, LogLevel } from '@sasjs/utils/logger'
-import { Session, Context } from '../types'
+import { Session, SessionState, Context } from '../types'
 
 jest.mock('axios')
 const mockedAxios = axios as jest.Mocked<typeof axios>
@@ -11,21 +11,34 @@ const requestClient = new (<jest.Mock<RequestClient>>RequestClient)()
 
 describe('SessionManager', () => {
   dotenv.config()
+  process.env.SERVER_URL = 'https://server.com'
 
   const sessionManager = new SessionManager(
     process.env.SERVER_URL as string,
     process.env.DEFAULT_COMPUTE_CONTEXT as string,
     requestClient
   )
+  const sessionStateLink = '/compute/sessions/session-id-ses0000/state'
+  const sessionEtag = 'etag-string'
 
-  const getMockSession = () => ({
+  const getMockSession = (): Session => ({
     id: ['id', new Date().getTime(), Math.random()].join('-'),
-    state: '',
-    links: [{ rel: 'state', href: '', uri: '', type: '', method: 'GET' }],
+    state: SessionState.NoState,
+    links: [
+      {
+        href: sessionStateLink,
+        method: 'GET',
+        rel: 'state',
+        type: 'text/plain',
+        uri: sessionStateLink
+      }
+    ],
     attributes: {
       sessionInactiveTimeout: 900
     },
-    creationTimeStamp: `${new Date(new Date().getTime()).toISOString()}`
+    creationTimeStamp: `${new Date(new Date().getTime()).toISOString()}`,
+    stateUrl: sessionStateLink,
+    etag: sessionEtag
   })
 
   afterEach(() => {
@@ -89,19 +102,21 @@ describe('SessionManager', () => {
   describe('waitForSession', () => {
     const session: Session = {
       id: 'id',
-      state: '',
+      state: SessionState.NoState,
       links: [{ rel: 'state', href: '', uri: '', type: '', method: 'GET' }],
       attributes: {
         sessionInactiveTimeout: 0
       },
-      creationTimeStamp: ''
+      creationTimeStamp: '',
+      stateUrl: sessionStateLink,
+      etag: sessionEtag
     }
 
     beforeEach(() => {
       ;(process as any).logger = new Logger(LogLevel.Off)
     })
 
-    it('should reject with NoSessionStateError if SAS server did not provide session state', async () => {
+    it('should log http response code and session state if SAS server did not provide session state', async () => {
       let requestAttempt = 0
       const requestAttemptLimit = 10
       const sessionState = 'idle'
@@ -124,15 +139,17 @@ describe('SessionManager', () => {
         sessionManager['waitForSession'](session, null, 'access_token')
       ).resolves.toEqual(sessionState)
 
+      const sessionStateUrl = process.env.SERVER_URL + session.stateUrl
+
       expect(mockedAxios.get).toHaveBeenCalledTimes(requestAttemptLimit)
       expect((process as any).logger.info).toHaveBeenCalledTimes(3)
       expect((process as any).logger.info).toHaveBeenNthCalledWith(
         1,
-        `Polling: ${process.env.SERVER_URL}`
+        `Polling: ${sessionStateUrl}`
       )
       expect((process as any).logger.info).toHaveBeenNthCalledWith(
         2,
-        `Could not get session state. Server responded with 304 whilst checking state: ${process.env.SERVER_URL}`
+        `Could not get session state. Server responded with 304 whilst checking state: ${sessionStateUrl}`
       )
       expect((process as any).logger.info).toHaveBeenNthCalledWith(
         3,
@@ -142,7 +159,7 @@ describe('SessionManager', () => {
 
     it('should throw an error if there is no session link', async () => {
       const customSession = JSON.parse(JSON.stringify(session))
-      customSession.links = []
+      customSession.stateUrl = ''
 
       mockedAxios.get.mockImplementation(() =>
         Promise.resolve({ data: customSession.state, status: 200 })
@@ -156,6 +173,7 @@ describe('SessionManager', () => {
     it('should throw an error if could not get session state', async () => {
       const gettingSessionStatus = 500
       const sessionStatusError = `Getting session status timed out after 60 seconds. Request failed with status code ${gettingSessionStatus}`
+      const sessionStateUrl = process.env.SERVER_URL + session.stateUrl
 
       mockedAxios.get.mockImplementation(() =>
         Promise.reject({
@@ -168,7 +186,7 @@ describe('SessionManager', () => {
         })
       )
 
-      const expectedError = `Error while waiting for session. Error while getting session state. GET request to ${process.env.SERVER_URL}?wait=30 failed with status code ${gettingSessionStatus}. ${sessionStatusError}`
+      const expectedError = `Error while waiting for session. Error while getting session state. GET request to ${sessionStateUrl}?wait=30 failed with status code ${gettingSessionStatus}. ${sessionStatusError}`
 
       await expect(
         sessionManager['waitForSession'](session, null, 'access_token')
@@ -427,4 +445,45 @@ describe('SessionManager', () => {
       )
     })
   })
+
+  describe('createAndWaitForSession', () => {
+    it('should create session with etag and stateUrl', async () => {
+      const etag = sessionEtag
+      const customSession: any = getMockSession()
+      delete customSession.etag
+      delete customSession.stateUrl
+
+      jest.spyOn(requestClient, 'post').mockImplementation(() =>
+        Promise.resolve({
+          result: customSession,
+          etag
+        })
+      )
+
+      jest
+        .spyOn(sessionManager as any, 'setCurrentContext')
+        .mockImplementation(() => Promise.resolve())
+
+      sessionManager['currentContext'] = {
+        name: 'context name',
+        id: 'string',
+        createdBy: 'string',
+        version: 1
+      }
+
+      jest
+        .spyOn(sessionManager as any, 'getSessionState')
+        .mockImplementation(() =>
+          Promise.resolve({ result: SessionState.Idle, responseStatus: 200 })
+        )
+
+      const expectedSession = await sessionManager['createAndWaitForSession']()
+
+      expect(customSession.id).toEqual(expectedSession.id)
+      expect(
+        customSession.links.find((l: any) => l.rel === 'state').href
+      ).toEqual(expectedSession.stateUrl)
+      expect(expectedSession.etag).toEqual(etag)
+    })
+  })
 })

src/types/Session.ts

@@ -1,15 +1,34 @@
 import { Link } from './Link'
+import { SessionManager } from '../SessionManager'
+
+export enum SessionState {
+  Completed = 'completed',
+  Running = 'running',
+  Pending = 'pending',
+  Idle = 'idle',
+  Unavailable = 'unavailable',
+  NoState = '',
+  Failed = 'failed',
+  Error = 'error'
+}
 
 export interface Session {
   id: string
-  state: string
+  state: SessionState
+  stateUrl: string
   links: Link[]
   attributes: {
     sessionInactiveTimeout: number
   }
   creationTimeStamp: string
+  etag: string
 }
 
 export interface SessionVariable {
   value: string
 }
+
+export interface JobSessionManager {
+  session: Session
+  sessionManager: SessionManager
+}

src/utils/getUserLanguage.ts

@@ -0,0 +1,10 @@
+interface IEnavigator {
+  userLanguage?: string
+}
+
+/**
+ * Provides preferred language of the user.
+ * @returns A string representing the preferred language of the user, usually the language of the browser UI. Examples of valid language codes include "en", "en-US", "fr", "fr-FR", "es-ES". More info available https://datatracker.ietf.org/doc/html/rfc5646
+ */
+export const getUserLanguage = () =>
+  window.navigator.language || (window.navigator as IEnavigator).userLanguage

src/utils/index.ts

@@ -20,3 +20,4 @@ export * from './serialize'
 export * from './splitChunks'
 export * from './validateInput'
 export * from './getFormData'
+export * from './getUserLanguage'