Prevent encoding query parameters #1445

Activity

1. xeinebiu commented on Mar 16, 2022

   

   xeinebiu

   on Mar 16, 2022

   Last edited by xeinebiu

   Author

   More actions

   Currently using the below workaround.

   class EncodingInterceptor extends Interceptor {
     @override
     void onRequest(RequestOptions options, RequestInterceptorHandler handler) {
       if (options.queryParameters.isEmpty) {
         super.onRequest(options, handler);
         return;
       }
   
       final queryParams = _getQueryParams(options.queryParameters);
       handler.next(
         options.copyWith(
           path: _getNormalizedUrl(options.path, queryParams),
           queryParameters: Map.from({}),
         ),
       );
     }
   
     String _getNormalizedUrl(String baseUrl, String queryParams) {
       if (baseUrl.contains("?")) {
         return baseUrl + "&$queryParams";
       } else {
         return baseUrl + "?$queryParams";
       }
     }
   
     String _getQueryParams(Map<String, dynamic> map) {
       String result = "";
       map.forEach((key, value) {
         result += "$key=${Uri.encodeComponent(value)}&";
       });
       return result;
     }
   }

   https://github.com/flutterchina/dio/blob/develop/dio/lib/src/transformer.dart#L45
   Can be fixed by using Uri.encodeComponent(value) instead.

   👍React with 👍2Reacted by Jimmy and Artur Saidov

   ❤️React with ❤️5Reacted by Jimmy, cannoloops, Larsson K, Luca Venir and Ivan Starchykov
2. minhdangoz commented on Sep 16, 2022

   

   minhdangoz

   on Sep 16, 2022

   More actions

   Currently using the below workaround.

   class EncodingInterceptor extends Interceptor {
     @override
     void onRequest(RequestOptions options, RequestInterceptorHandler handler) {
       if (options.queryParameters.isEmpty) {
         super.onRequest(options, handler);
         return;
       }
   
       final queryParams = _getQueryParams(options.queryParameters);
       handler.next(
         options.copyWith(
           path: _getNormalizedUrl(options.path, queryParams),
           queryParameters: Map.from({}),
         ),
       );
     }
   
     String _getNormalizedUrl(String baseUrl, String queryParams) {
       if (baseUrl.contains("?")) {
         return baseUrl + "&$queryParams";
       } else {
         return baseUrl + "?$queryParams";
       }
     }
   
     String _getQueryParams(Map<String, dynamic> map) {
       String result = "";
       map.forEach((key, value) {
         result += "$key=${Uri.encodeComponent(value)}&";
       });
       return result;
     }
   }

   https://github.com/flutterchina/dio/blob/develop/dio/lib/src/transformer.dart#L45 Can be fixed by using Uri.encodeComponent(value) instead.

   Thanks, it works with me
3. mb180594b commented on Nov 24, 2022

   

   mb180594b

   on Nov 24, 2022

   Last edited by mb180594b

   More actions

   Currently using the below workaround.

   class EncodingInterceptor extends Interceptor {
     @override
     void onRequest(RequestOptions options, RequestInterceptorHandler handler) {
       if (options.queryParameters.isEmpty) {
         super.onRequest(options, handler);
         return;
       }
   
       final queryParams = _getQueryParams(options.queryParameters);
       handler.next(
         options.copyWith(
           path: _getNormalizedUrl(options.path, queryParams),
           queryParameters: Map.from({}),
         ),
       );
     }
   
     String _getNormalizedUrl(String baseUrl, String queryParams) {
       if (baseUrl.contains("?")) {
         return baseUrl + "&$queryParams";
       } else {
         return baseUrl + "?$queryParams";
       }
     }
   
     String _getQueryParams(Map<String, dynamic> map) {
       String result = "";
       map.forEach((key, value) {
         result += "$key=${Uri.encodeComponent(value)}&";
       });
       return result;
     }
   }

   https://github.com/flutterchina/dio/blob/develop/dio/lib/src/transformer.dart#L45 Can be fixed by using Uri.encodeComponent(value) instead.

   I suggest you this change to avoid errors on the qp's types sent:

   String _getQueryParams(Map<String, dynamic> map) {
       String result = "";
       map.forEach((key, value) {
         result += value.runtimeType == String
             ? "$key=${Uri.encodeComponent(value)}&"
             : "$key=$value&";
       });
       return result;
     }
   

   👍React with 👍2Reacted by Larsson K and Ivan Starchykov
4. AlexV525 commented on Dec 15, 2022

   

   AlexV525

   on Dec 15, 2022

   Member

   More actions

   Hi everyone. According to Uri.encodeQueryComponent that is used in Transformer.urlEncodeMap, it's the right choice of the API. But I also want to test if I can provide another solution to change the code base:

   Try to replace:
   https://github.com/flutterchina/dio/blob/9040bde4a07ffe4e201e4ec014242a16eb69d926/dio/lib/src/options.dart#L545-L550

   To this:

   // Normalize the url.
   return Uri.parse(url)
       .replace(queryParameters: queryParameters)
       .normalizePath();

   This will drop the usage of the ListFormat, but please let me know if it works.
5. AlexV525

   closed this as completedon Feb 13, 2023
6. lucavenir commented on Jan 18, 2024

   

   lucavenir

   on Jan 18, 2024

   Last edited by lucavenir

   More actions

   This is completed because... there's a way to avoid encoding query parameters without the above workaround?

   The above workaround doesn't work for me. The parameters still gets encoded. Aka I want to send a query param like so:

   ?param=auth0|someId
   

   But even if I explicitly overwrite the above without encoding I still get

   ?param=auth0%7CsomeId
   

   Which is pretty annoying. I have no other interceptors implemented / connected.

   👍React with 👍5Reacted by Ken Wong, Pvh365, Ahmed Shendy, oleksii-melnychenko-pwrcd and lexwilliam
7. intraector commented on Feb 10, 2025

   

   intraector

   on Feb 10, 2025

   More actions

   Well, as it turns out, the only thing I had to do is just trim() the query. Works just fine.

   😄React with 😄1Reacted by Larsson K