Introduce `rawRequest()` to replace `rawResponse` by dixonyant · Pull Request #1317 · Esri/arcgis-rest-js

dixonyant · 2026-05-15T18:17:55Z

This PR introduces rawRequest() to replace rawResponse: true in rest-request. It also implements the new IRequestOptions interface across request and request tests.
It outright removes support for rawResponse and maxUrlLength while retaining backwards-compatibility for legacy IRequestOptions.

Users will have to update their code to use requestFlags.ignoreMaxUrlLength and manually request a raw response using rawRequest() and handle the response on their own.

Raw Request:
- to be used to request a response as html, text, pbf, or BLOB.

IRequestOptions:
- moved http related options to requestOption.fetchOptions
- moved boolean flags to requestOptions.requestFlags
- refactored maxUrlLength case to a new workflow that uses requestFlags.ignoreMaxUrlLength when users want to force a GET request with a very long url length (due to long query params or other large stringified properties appended to url)
- removed requestfrom IRequestOptions as it was an artifact from jasmine era testing days

Added normalizeDeprecatedRequestOptions() as a way to support backwards compatibility for ILegacyRequestOptions (except for rawResponse and maxUrlLength which we are fully removing from request in this pr).

…ponse

force f=json request and remove response formatting through a default request. passing f params to request should warn and override

remove unused params parameter as params should already be within the options parameter

remove redundant assignment destructure requestFlags and remove double self platform call destructure request context wrap rawRequest in retry logic for parity remove error retry in rawResponse restruct build auth logic

…into rawrequest-replace-rawresponse

Copilot

Pull request overview

This PR introduces a new rawRequest() API in @esri/arcgis-rest-request to replace the legacy rawResponse behavior, while also migrating legacy top-level request options (e.g. httpMethod, headers, credentials, signal, hideToken, suppressWarnings) into the newer fetchOptions and requestFlags shapes.

Changes:

Added rawRequest() and refactored request()/internalRequest() to centralize option normalization and deprecation warnings.
Added normalizeDeprecatedRequestOptions() + tests, and updated deprecated-option warning behavior (including a suppressWarnings argument).
Updated multiple packages/tests to use fetchOptions.method and to route raw-response use cases through rawRequest() (including Feature Service f=pbf).

Reviewed changes

Copilot reviewed 22 out of 22 changed files in this pull request and generated 10 comments.

Show a summary per file

File	Description
packages/arcgis-rest-request/test/utils/normalize-deprecated-request-options.test.ts	Adds unit tests for legacy option normalization into `requestFlags`/`fetchOptions`.
packages/arcgis-rest-request/test/utils/ArcGISTokenRequestError.test.ts	Updates expectations to assert `fetchOptions.method` rather than legacy `httpMethod`.
packages/arcgis-rest-request/test/utils/ArcGISRequestError.test.ts	Updates expectations to assert `fetchOptions.method` rather than legacy `httpMethod`.
packages/arcgis-rest-request/test/utils/ArcGISAuthError.test.ts	Updates tests to pass `fetchOptions.method` instead of `httpMethod`.
packages/arcgis-rest-request/test/request.test.ts	Updates request behavior tests; adds `rawRequest()` coverage; switches legacy options to new shapes.
packages/arcgis-rest-request/test/deprecated-request-options-warning.test.ts	Updates warning assertions and adds `suppressWarnings` argument coverage.
packages/arcgis-rest-request/src/utils/warn-deprecated-request-options.ts	Adds “unsupported” warnings for `maxUrlLength`/`rawResponse` and supports suppression.
packages/arcgis-rest-request/src/utils/normalize-deprecated-request-options.ts	New helper to map legacy top-level options into `requestFlags`/`fetchOptions`.
packages/arcgis-rest-request/src/utils/IRequestOptions.ts	Removes deprecated `request` override type and related internal type alias.
packages/arcgis-rest-request/src/utils/append-custom-params.ts	Removes legacy `request` from the non-param key list.
packages/arcgis-rest-request/src/request.ts	Core refactor: normalization, `rawRequest()`, revised fetch flow, and updated token handling.
packages/arcgis-rest-request/src/fetch-token.ts	Removes now-unnecessary `rawResponse=false` forcing; renames response type.
packages/arcgis-rest-request/src/AuthenticationManagerBase.ts	Removes `rawResponse` note/override; relies on new request behavior.
packages/arcgis-rest-request/src/ArcGISIdentityManager.ts	Removes `rawResponse` note/override; relies on new request behavior.
packages/arcgis-rest-portal/src/sharing/is-item-shared-with-group.ts	Updates docs removing the outdated `rawResponse` limitation note.
packages/arcgis-rest-portal/src/items/get.ts	Switches file/blob paths to `rawRequest()` and removes `rawResponse` toggling via `request()`.
packages/arcgis-rest-geocoding/src/geocode.ts	Routes `rawResponse` behavior through `rawRequest()`.
packages/arcgis-rest-geocoding/src/bulk.ts	Routes `rawResponse` behavior through `rawRequest()`.
packages/arcgis-rest-feature-service/test/query.test.ts	Adds test ensuring `f=pbf` returns a raw `Response`.
packages/arcgis-rest-feature-service/test/query.test.live.ts	Removes `rawResponse: true` from live PBF tests (now implied via behavior).
packages/arcgis-rest-feature-service/test/addToServiceDefinition.test.ts	Updates expectations from `httpMethod` to `fetchOptions.method`.
packages/arcgis-rest-feature-service/src/query.ts	Uses `rawRequest()` for PBF and updates docs about PBF usage.
packages/arcgis-rest-feature-service/src/createFeatureService.ts	Removes outdated `rawResponse` limitation note and override.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

dixonyant · 2026-06-12T22:20:20Z

+  const fetchOptions = {
+    ...(httpMethod !== undefined ? { method: httpMethod } : {}),
+    ...(credentials !== undefined ? { credentials } : {}),
+    ...(signal !== undefined ? { signal } : {}),
+    ...requestOptions.fetchOptions,
+    headers: {
+      ...(headers as any),
+      ...(requestOptions.fetchOptions?.headers as any)
+    }
+  };


I created helper methods to cover this in a more comprehensive way since it is needed in multiple places. We can reevaluate once all legacy shape options and normalization functions are removed if we need to keep it around still. (there should be one or two direct calls to merge headers in request standalone)

patrickarlt

@dixonyant this LGTM but I would take the advice of the Copilot bot and handle the header object in other formats then just a plain object.

…-options.ts Co-authored-by: Patrick Arlt <patrick.arlt@gmail.com>

Copilot

Pull request overview

Copilot reviewed 26 out of 27 changed files in this pull request and generated 9 comments.

dixonyant · 2026-06-12T23:26:56Z

      const options = {
        httpMethod: "GET",
        authentication: this,
-        ...requestOptions,
-        rawResponse: false
+        ...requestOptions
      } as IRequestOptions;


These and all the below instances are all part of this larger wip change that is going into the v5.0.0 branch. The focus of this PR is to handle options at the request/rawRequest level. there is a follow up story that covers all the package-level and repo-uses of LegacyRequestOptions. These will all be done by the time v5.0.0 -> main merges into main.

patrickarlt · 2026-06-16T19:37:19Z

+  } else if (queryOptions.params?.f === "pbf") {
+    return rawRequest(
+      `${cleanUrl(requestOptions.url)}/query`,
+      queryOptions
+    ) as Promise<any>;


@dixonyant this also seems off. The goal is that all methods should return JSON by default and this breaks the pattern by returning Promise<any> if f=pbf so if someone really wants f=pbf they will neet to use a new rawQueryFeatures() that will need to be added at v5

Yes it is off. This in-between behavior shouldn't even see the light of day since the follow-up PR is going to be all the removing of rawRequest calls from all functions that should be only returning JSON. They either get a replacement rawFunction call after v5 or with v5. Just the purpose of this PR is to replace the guts of all calls to request({rawResponse}) with rawRequest for immediate backwards compatibility internally, and then I was going to remove fully and assert types in the next follow-up PR.

github-actions · 2026-06-13T00:06:40Z

Package	Line Rate	Branch Rate	Health
arcgis-rest-basemap-sessions.src	100%	100%	✔
arcgis-rest-basemap-sessions.src.utils	100%	100%	✔
arcgis-rest-demographics.src	100%	100%	✔
arcgis-rest-developer-credentials.src	100%	100%	✔
arcgis-rest-developer-credentials.src.shared	100%	100%	✔
arcgis-rest-elevation.src	100%	100%	✔
arcgis-rest-feature-service.src	100%	100%	✔
arcgis-rest-feature-service.src.pbf-parser	100%	100%	✔
arcgis-rest-geocoding.src	100%	100%	✔
arcgis-rest-places.src	100%	100%	✔
arcgis-rest-portal.src.groups	100%	100%	✔
arcgis-rest-portal.src.items	100%	100%	✔
arcgis-rest-portal.src.orgs	100%	100%	✔
arcgis-rest-portal.src.services	100%	100%	✔
arcgis-rest-portal.src.sharing	100%	100%	✔
arcgis-rest-portal.src.users	100%	100%	✔
arcgis-rest-portal.src.util	100%	100%	✔
arcgis-rest-request.src	100%	100%	✔
arcgis-rest-request.src.types	100%	100%	✔
arcgis-rest-request.src.utils	100%	100%	✔
arcgis-rest-routing.src	100%	100%	✔
Summary	100% (2482 / 2482)	100% (1342 / 1342)	✔

Minimum allowed line rate is 100%

patrickarlt

@dixonyant There still seem to be a few cases where methods can return non JSON objects. These could get resolved now or in a future issue if you want to make a follow up issue.

patrickarlt · 2026-06-16T19:37:19Z

+  } else if (queryOptions.params?.f === "pbf") {
+    return rawRequest(
+      `${cleanUrl(requestOptions.url)}/query`,
+      queryOptions
+    ) as Promise<any>;


@dixonyant this also seems off. The goal is that all methods should return JSON by default and this breaks the pattern by returning Promise<any> if f=pbf so if someone really wants f=pbf they will neet to use a new rawQueryFeatures() that will need to be added at v5

dixonyant added 21 commits April 21, 2026 11:06

Merge branch 'requestoptionsv5changes' into rawrequest-replace-rawres…

adbf710

…ponse

add v2 request file for comparison

290c292

refactor to async await syntax

bfb6539

regrouping request constructions

ecf1c25

revert url naming

71eb068

pre rawrequest extraction parity state

ef0e0c5

remove rawResponse altogether form request

60988fc

force f=json request and remove response formatting through a default request. passing f params to request should warn and override

remove params from checkForErrors

224e2b6

remove unused params parameter as params should already be within the options parameter

remove unused vars

bd4812c

support geojson as json in request

c6358f0

log warning change

0fa2486

fix broken test

6197005

wip centralize fetchOptions

35d84fb

remove redundant assignment

0baa47e

destructure requestFlags and remove double self platform call

43e9f61

destructure request context

bf96460

wrap rawRequest in retry logic for parity

dfb644b

remove error retry in rawResponse

6ca8013

restruct build auth logic

1602de6

wip centralize fetchOptions

3974367

remove redundant assignment destructure requestFlags and remove double self platform call destructure request context wrap rawRequest in retry logic for parity remove error retry in rawResponse restruct build auth logic

Merge remote-tracking branch 'origin/rawrequest-replace-rawresponse' …

825536f

…into rawrequest-replace-rawresponse

dixonyant marked this pull request as draft May 15, 2026 18:18

dixonyant changed the title ~~Rawrequest replace rawresponse~~ RawRequest() to replace rawResponse May 15, 2026

dixonyant changed the title ~~RawRequest() to replace rawResponse~~ Introduce rawRequest() to replace rawResponse May 15, 2026

dixonyant changed the base branch from main to v5.0.0 May 15, 2026 18:20

dixonyant added 5 commits May 15, 2026 14:23

wip normalize compatibility requestOptions

1ffaca5

warn unsupported on maxUrlLength and rawResponse usage

141b65f

use old shape

d1675a5

update requestOptions shape

7f70ec6

undo test change

e37a060

dixonyant added 2 commits May 28, 2026 16:33

add test case for raw request with no options

83eee25

update maxUrlLength refactor to ignoreMaxUrlLength test cases

c4c714b

dixonyant requested a review from Copilot June 5, 2026 18:41

Copilot started reviewing on behalf of dixonyant June 5, 2026 18:42 View session

Merge branch 'v5.0.0' into rawrequest-replace-rawresponse

0c6c675

dixonyant marked this pull request as ready for review June 5, 2026 18:46

Copilot AI reviewed Jun 5, 2026

View reviewed changes

dixonyant self-assigned this Jun 5, 2026

dixonyant added 2 commits June 5, 2026 14:08

install playwright version to remove hanging ci issue

92bb7a0

update pr feedback

bea9adf

dixonyant requested review from dbouwman, gavinr-maps, gowin20 and patrickarlt June 5, 2026 22:35

add changeset

2bd2aa3

patrickarlt requested changes Jun 9, 2026

View reviewed changes

dixonyant and others added 4 commits June 9, 2026 08:57

Update packages/arcgis-rest-request/src/utils/warn-deprecated-request…

a362469

…-options.ts Co-authored-by: Patrick Arlt <patrick.arlt@gmail.com>

pull GET to POST workflow out into helper

b2fccda

add mergeHeaders until we get to the point or removing legacy options

940990a

update global defaults to use normalized and updated IRequestOptions

436dca5

dixonyant requested review from Copilot and patrickarlt June 12, 2026 22:26

Copilot started reviewing on behalf of dixonyant June 12, 2026 22:26 View session

Copilot AI reviewed Jun 12, 2026

View reviewed changes

dixonyant added 2 commits June 12, 2026 16:33

force ceorce json unconditionally

2d0f684

don't warn when f param is not passed in

dd42707

patrickarlt requested changes Jun 16, 2026

View reviewed changes

dixonyant merged commit 99b4b39 into v5.0.0 Jun 18, 2026
2 checks passed

dixonyant mentioned this pull request Jul 1, 2026

Remove rawResponse support from REST JS packages #1326

Open

Uh oh!

Conversation

dixonyant commented May 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dixonyant Jun 12, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

patrickarlt left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

dixonyant Jun 12, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

patrickarlt Jun 16, 2026

Choose a reason for hiding this comment

Uh oh!

dixonyant Jun 17, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented Jun 13, 2026

Uh oh!

patrickarlt left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

patrickarlt Jun 16, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

dixonyant commented May 15, 2026 •

edited

Loading