topic Re: Properly change the format of queries in ArcGIS JavaScript Maps SDK Questions

Properly change the format of queries

ShanonLoughton — Sun, 12 Dec 2021 16:09:15 GMT

For a particular situation, in ArcGIS for JS API 4.15 I am trying to force a particular format of all Feature Server (FS) queries to JSON (f=json, or f=pjson), regardless of the ArcGIS Server's (10.7.1) > Feature Service's > Layer config params, such as SupportedQueryFormats: JSON, GeoJSON, PBF. It looks like PBF is preferred to be used by clients, if it is available.

I have forced f=json with esri.Config.request successfully:

require([
 "esri/config",
 ...
 ], function(esriConfig,...) {
    esriConfig.request.interceptors.push({ 
       before(params) {
          if (params.url.includes("query")) {
             params.requestOptions.query.f = 'json';
          }
       }
    }
   ...
 });

which works at the call level. However when the query is originally PBF, the client JS SDK is expecting it to come back and be parsed as PBF still, even though I have intercepted the initial request. I know this because the FL does not display on the web map and I get the console error:

dojo-lite.js:261 [esri.tasks.operations.pbfFeatureServiceParser]

f {name: "query:parsing-pbf", message: "Error while parsing FeatureSet PBF payload", details: {…}}
1. details: {error: Error: Invalid data type! at c.skip (https://js.arcgis.com/4.15/dojo/dojo-lite.js:726:180) …}
2. message: "Error while parsing FeatureSet PBF payload"
3. name: "query:parsing-pbf"
4. ...

Is this a bug in ArcGIS for JS API?

Is there a more robust way to change the FS query format from the client?

Re: Properly change the format of queries

YannCabon — Sat, 11 Dec 2021 09:16:47 GMT

Hi Shanon,

We don't have a proper way to disable pbf at the moment. You are on the right track to use interceptors.

It would work if you intercept the call to the service info, and override the supported query formats to only have JSON.

        esriConfig.request.interceptors.push({
          urls: /FeatureServer\/\d+$/,
          after: function (response) {
            response.data.supportedQueryFormats = "JSON";
          }
        });‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

Cheers

Yann

Re: Properly change the format of queries

viewprogisdev — Wed, 19 May 2021 02:24:29 GMT

@ArnoFiva @ShanonLoughton @YannCabon
Does the interceptors solution you have provided work with JS API 3.x version?

Re: Properly change the format of queries

Noah-Sager — Wed, 26 May 2021 17:52:10 GMT

@viewprogisdev - at 3x, we have a setRequestPreCallback method that is fairly similar. See here:

https://developers.arcgis.com/javascript/3/jsapi/esri.request-amd.html#esrirequest.setrequestprecallback

Re: Properly change the format of queries

JeffPace1 — Thu, 23 Sep 2021 02:16:06 GMT

has this been addressed? We are having trouble serving pbf files. WE need to disable from the server side as we cannot control what the application requests.

Re: Properly change the format of queries

LanceKirby2 — Tue, 04 Oct 2022 16:14:07 GMT

@JeffPace1 @ShanonLoughton I am having a similar issue. Did either of you ever figure out a resolution?

Re: Properly change the format of queries

MKa — Thu, 30 Jan 2025 17:05:22 GMT

This appears to still be an issue that I cannot resolve? I have a feature service that when I "Zoom to" one of the records it comes back with the error of "Error while parsing FeatureSet PBF payload".