LargeFileUploadTask not using GraphError

Open
#1,557 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
45/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Stale
Tech stack
typescript
Domain
api

Research direction

Start with LargeFileUploadTask.ts around line 260, then trace the response handling through GraphResponseHandler.ts around lines 95 and 176-179. Confirm how upload errors are propagated and ensure an API error from LargeFileUploadTask is exposed as a GraphError rather than the raw response object.

Written by the indexing model from the issue text.

Description

Bug Report

Prerequisites

  • Can you reproduce the problem?
  • Are you running the latest version?
  • Are you reporting to the correct repository?
  • Did you perform a cursory search?

Description

Errors thrown during a LargeFileUploadTask are not wrapped with GraphError.
Please correct me if I'm wrong, but I was expecting all errors from the API to be wrapped in that class.

In our case, this happened when running multiple uploads, but I think the specific error is irrelevant.

Screenshots:
image

You can see in the screenshot that the "error object" is just the direct response from the API:
https://learn.microsoft.com/en-us/graph/errors#json-representation

Steps to Reproduce

Not sure what to add here, I think this applies to any error during an upload task. We're experiencing this when trying to send multiple emails at once, all with attachments. This causes the MailboxConcurrency error to be thrown.

Expected behavior:
Error to be an instance of GraphError.

Actual behavior:
Error is actually the response object returned by the API.

Additional Context

I've tried to track this down, but it's my first time actually browsing the SDK code.

  1. Upload task tries to handle response: https://github.com/microsoftgraph/msgraph-sdk-javascript/blob/0f8eb690d571c37d9a8df1b8564e8a46ba46829a/src/tasks/LargeFileUploadTask.ts#L260
  2. I'm assuming it's then calling GraphResponseHandler.convertResponse: https://github.com/microsoftgraph/msgraph-sdk-javascript/blob/0f8eb690d571c37d9a8df1b8564e8a46ba46829a/src/GraphResponseHandler.ts#L95
  3. Again, I'm assuming it goes on the else branch and directly throws the response from the API: https://github.com/microsoftgraph/msgraph-sdk-javascript/blob/0f8eb690d571c37d9a8df1b8564e8a46ba46829a/src/GraphResponseHandler.ts#L176-L179

Usage Information

Request ID - Value of the requestId field if you are receiving a Graph API error response

SDK Version - 3.0.6

  • Node (Check, if using Node version of SDK)

Node Version - 18.15.0

Dominant language
TypeScript
Stars
833
Forks
240
PR merge metrics
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from microsoftgraph/msgraph-sdk-javascript

All issues in microsoftgraph/msgraph-sdk-javascript

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.