Error Handling

[shaun-pendrigh]

In 4.0.0 when the QuickBooks API call had an error the error result used to contain an authResponse with a json property containing the error detail like this.

 "json": {
      "Fault": {
        "Error": [{ "Message": "Result Set Big Error", "Detail": "Result Set Big Error : Report too large, please customize", "code": "10100", "element": "ReportName" }],
        "type": "ValidationFault"
      },
      "time": "2024-06-24T10:19:14.384-07:00"
    },

On 4.2.0 the json is empty.

"json": null,

Is there a different way to get the QuickBooks error detail? This is critical for me to correctly handle the failure in my application. Thanks

[rajeshgupta723]

Hi @shaun-pendrigh

QBO API error codes ref:
https://developer.intuit.com/app/developer/qbo/docs/develop/troubleshooting/error-codes

Error code=10100 indicates Result Set Big | The result for the query is too large.

You may want to either use pagination, or request for a smaller payload response e.g. by specifying smaller date range in the API request.
I'll check why the response is returning json as null in this case.

Thanks
Rajesh

https://developer.intuit.com/app/developer/qbo/docs/learn/explore-the-quickbooks-online-api/data-queries#server-response

[rajeshgupta723]

Hi @shaun-pendrigh

I've created a new candidate branch release-4.2.1 and raised this PR: #189

Could you please review if this fixes your issues, are you able to get json response when API returns fault?
If yes, please approve my PR.

Thanks,
Rajesh

[shaun-pendrigh]

Thanks @rajeshgupta723 I will test as soon as possible.

[shaun-pendrigh]

@rajeshgupta723 When trying to launch the sample I get:

> intuit-nodejsclient@1.0.0 start
> node app

node:internal/modules/cjs/loader:1404
  throw err;
  ^

Error: Cannot find module './errors/OAuthError'

Looking in the code I see these lines in 4.2.1 but there is no errors folder.

// Move error classes to a separate file
const OAuthError = require('./errors/OAuthError');
const ValidationError = require('./errors/ValidationError');
const TokenError = require('./errors/TokenError');

[rajeshgupta723]

Hi @shaun-pendrigh Please get latest from the release-4.2.1 branch and try again. Thanks

[shaun-pendrigh]

@rajeshgupta723 Thanks the example runs now. But can you please confirm where I would see the additional API error detail? I tried logging the full error object but it does not contain the "Fault" information that I rely on to interpret the error.

[rajeshgupta723]

Hi @shaun-pendrigh
Thank you for your patience. Please get latest from the release-4.2.1 branch and try again.

Here is the info on the error handling, particularly for the Fault authresponse json. Please let me know. Thanks

FYI -

Error handling
here's how errors from /src/errors are handled and displayed:

1. Error Classes Structure:

• OAuthError: Base error class that all other errors extend from
• ValidationError: For validation-related errors
• TokenError: For token-related errors
• NetworkError: For network-related errors

2. Error Display Methods:

a) Console Logging:
The OAuthClient class has a built-in logging system that logs errors using the log() method
Errors are logged with the format: 'error', 'Get makeAPICall () threw an exception : ', safeStringify(e)
The safeStringify() function is used to safely convert error objects to JSON strings

b) Error String Representation:
All errors have a toString() method that formats errors as:

ErrorName: message (code) - description [TID: intuitTid]

Example: OAuthError: Rate limit exceeded (RATE_LIMIT_EXCEEDED) - Too many requests, please try again later [TID: 1234-5678]

c) JSON Representation: All errors have a toJSON() method that returns
{
name: string,
message: string,
code: string,
description: string,
intuitTid: string,
stack: string
}

3. Error Handling Locations:
a) API Calls (makeApiCall method):
Network errors (ECONNRESET, ETIMEDOUT, etc.)
Timeout errors
Rate limit errors (429)
API errors (400-500 range)
Validation errors (missing required parameters)
b) Token Operations:
Token validation errors
Token refresh errors
Token revocation errors
c) Response Validation:
Empty response errors
Missing status code errors
Rate limit errors (429)
Unauthorized errors (401)
Forbidden errors (403)

4. Error Logging Configuration:
   Logging can be enabled by setting logging: true in the OAuthClient configuration
   Log entries include:

• Timestamp
• Log level
• Message
• Request context
• Error details
• Environment information
• Client ID

5. Error Handling Best Practices (from README):
   
try {
   await oauthClient.makeApiCall({ url: 'https://api.example.com' });
   } catch (error) {
   if (error instanceof TokenError) {
   // Handle token errors
   console.error('Token error:', error.code, error.description);
   } else if (error instanceof NetworkError) {
   // Handle network errors
   console.error('Network error:', error.message);
   } else if (error instanceof ValidationError) {
   // Handle validation errors
   console.error('Validation error:', error.message);
   } else {
   // Handle other errors
   console.error('Unexpected error:', error);
   }
   }


The errors are primarily shown to users through:

1. Console logs (when logging is enabled)
2. Error objects thrown that can be caught and handled by the application
3. String representations when errors are converted to strings
4. JSON representations when errors are serialized

The error handling system provides detailed information about what went wrong, including error codes, descriptions, and transaction IDs for debugging purposes.

[shaun-pendrigh]

Hi @rajeshgupta723. Not sure what I am missing. This is what I have done.

• Downloaded branch 4.2.1 and unzipped
• Opened the main project and ran npm install and then npm link
• Opened the sample project and ran npm install and then npm link intuit-oauth --save
• Modified app.js changed getCompanyInfo to generate invalid call as below which is an invalid enumeration.
• Logged the error which still had no detail about the enumeration error

.makeApiCall({ url: "https://sandbox-quickbooks.api.intuit.com/v3/company/<realmid>/reports/BalanceSheet?accounting_method=Accrual&date_macro=thisyeartolastmonth1&minorversion=75" })

It just has this:

{
    "error": "Request failed with status code 400",
    "authResponse": {
        "token": { ... },
        "response": "",
        "body": "",
        "json": null,
        "intuit_tid": ""
    },
    "intuit_tid": "",
    "originalMessage": "Request failed with status code 400",
    "error_description": "",
    "message": "Request failed with status code 400"
}

Would appreciate if you can let me know why I don't see the detail of the error, thanks

[shaun-pendrigh]

Hi @rajeshgupta723 just checking if you saw my last post? Despite your explanation I am still unable to get the API call error detail in the output.

[rajeshgupta723]

Hi @shaun-pendrigh
I see your point. When 400 BAD Request error (or fault) happens in the API response, we should see something details in the response Fault object json. I have added Exception analysis in the console log that will help you see the Fault error details (a snapshot is attached here). Let me know if helps. Please get latest from the release-4.2.1 branch. Thanks!

[rajeshgupta723]

e.g. sample error exception analysis console logs

[shaun-pendrigh]

Thanks @rajeshgupta723, I will review these updates and test the error process again as soon as I have a gap.