Esri/arcgis-rest-js

Expose Response Headers on ArcgisError object for status != 200

Open

#1,181 opened on Nov 8, 2024

 (4 comments) (0 reactions) (1 assignee)TypeScript (126 forks)auto 404
enhancementhelp wanted

Repository metrics

Stars
 (389 stars)
PR merge metrics
 (PR metrics pending)

Description

Describe the problem

We had a support request with AGOL and they need the response headers, there is no way to get them from this package without patching the module (which we are attempting) When a status code 500/503 (non 200) error is returned the response headers are not exposed via the error object.

Describe the proposed solution

We are seeing if this will work (in my simulations it appeared to). Tweaking this code here seemed to do it.

https://github.com/Esri/arcgis-rest-js/blob/main/packages/arcgis-rest-request/src/request.ts#L424

            const { status, statusText, headers } = response;
            const { message, details } = jsonError.error;
            const formattedMessage = `${message}. ${
              details ? details.join(" ") : ""
            }`.trim();

            throw new ArcGISRequestError(
              formattedMessage,
              `HTTP ${status} ${statusText}`,
              {body: jsonError, headers: [...headers]},
              url,
              options
            );
          })

Alternatives considered

No response

Additional Information

No response

Contributor guide