Provide dedicated error message for when a token is marked as disabled due to inactivity

[andrea-sdl]

Description

This PR adds support for the new unauthorized error for inactive tokens.

Changelog Description

Adds support for the disabled token due to inactivity error so that it shows a dedicated error message.

Pull request checklist

• Update SETUP.md with any new environmental variables.
• Update the documentation.
• Manually test the relevant changes.
• Follow the pull request checklist
• Add/update automated tests as needed.

New release checklist

• Automated tests pass.
• The Preparing for release checklist is completed.

Steps to Test

1. Check out PR.
2. Run npm run build
3. Run VIP_PROXY="" API_HOST=http://localhost:4000 node ./dist/bin/vip app list with a token that is disabled due to inactivity
4. Check the error message is 'Unauthorized: Your token has been disabled due to inactivity, please logout with vip logout then try again.'
5. Repeat the same test with a valid token and an expired token, to ensure previous behavior hasn't changed.

[github-actions]

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

OpenSSF Scorecard

Package	Version	Score	Details

Scanned Files

[mjangda]

Left some minor wording changes, otherwise this is great.

[mjangda]

Is the in check actually necessary since we have ??

Suggested change

	if ( 'result' in networkError && networkError.result?.code === 'token-disabled-inactivity' ) {
	if ( networkError.result?.code === 'token-disabled-inactivity' ) {

[andrea-sdl]

@mjangda We need the result in to make TS aware we're using the class ServerError instead of ServerParseError from the Apollo Client.

import { ServerError } from '../utils';
import { ServerParseError } from '../http';
export interface ErrorResponse {
    graphQLErrors?: ReadonlyArray<GraphQLError>;
    networkError?: Error | ServerError | ServerParseError;
    [....]
}

If we use your code the type checker will error out with

 Property 'result' does not exist on type 'ServerParseError'.

42    if ( networkError.result?.code === 'token-disabled-inactivity' ) {

[mjangda]

Interesting, thank you for explaining that.

Maybe we should make the check more obvious to indicate that?

Suggested change

	if ( 'result' in networkError && networkError.result?.code === 'token-disabled-inactivity' ) {
	if ( networkError instanceof ServerError && networkError.result?.code === 'token-disabled-inactivity' ) {

[andrea-sdl]

This doesn't work either (I tested before landing with the result in) since we're checking against a type (ServerError) and not a class.

> tsc

src/lib/api.ts:43:33 - error TS2359: The right-hand side of an 'instanceof' expression must be either of type 'any', a class, function, or other type assignable to the 'Function' interface type, or an object type with a 'Symbol.hasInstance' method.

43    if ( networkError instanceof ServerError && networkError.result?.code === 'token-disabled-inactivity' ) {
                                   ~~~~~~~~~~~

src/lib/api.ts:43:61 - error TS2339: Property 'result' does not exist on type 'ServerError | ServerParseError'.
  Property 'result' does not exist on type 'ServerParseError'.

43    if ( networkError instanceof ServerError && networkError.result?.code === 'token-disabled-inactivity' ) {
                                                               ~~~~~~


Found 2 errors in the same file, starting at: src/lib/api.ts:43

What we can do, if we want to improve the readability, is to have a isServerError function with the same check @mjangda

something like

function isServerError(networkError){
return 'result' in networkError;
}

[mjangda]

Even more interesting :)

I think the readability would be nice improvement but it's very minor.

[andrea-sdl]

Added in 0d8eefe . For future reference here's also the docs around using in operator narrowing: https://www.typescriptlang.org/docs/handbook/2/narrowing.html#the-in-operator-narrowing

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud