Fixing URLSearch params with Arrays

Author: Perki

components/pryv-monitor/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pryv/monitor",
-  "version": "3.0.0",
+  "version": "3.0.1",
   "description": "Extends `pryv` with event-driven notifications for changes on a Pryv.io account",
   "keywords": [
     "Pryv",

components/pryv-socket.io/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pryv/socket.io",
-  "version": "3.0.0",
+  "version": "3.0.1",
   "description": "Extends `pryv` with Socket.IO transport",
   "keywords": [
     "Pryv",

components/pryv/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pryv",
-  "version": "3.0.0",
+  "version": "3.0.1",
   "description": "Pryv JavaScript library",
   "keywords": [
     "Pryv",

components/pryv/src/Connection.js

@@ -6,6 +6,7 @@ const utils = require('./utils.js');
 const jsonParser = require('./lib/json-parser');
 const libGetEventStreamed = require('./lib/getEventStreamed');
 const PryvError = require('./lib/PryvError');
+const buildSearchParams = require('./lib/buildSearchParams');
 
 /**
  * @class Connection
@@ -290,7 +291,7 @@ class Connection {
     path = path || '';
     let queryStr = '';
     if (queryParams && Object.keys(queryParams).length > 0) {
-      queryStr = '?' + new URLSearchParams(queryParams).toString();
+      queryStr = '?' + buildSearchParams(queryParams);
     }
     const response = await fetch(this.endpoint + path + queryStr, {
       headers: {

components/pryv/src/lib/buildSearchParams.js

@@ -0,0 +1,26 @@
+/**
+ * @license
+ * [BSD-3-Clause](https://github.com/pryv/lib-js/blob/master/LICENSE)
+ */
+
+/**
+ * Build URL search params string from an object, properly handling arrays.
+ * Arrays are expanded as repeated keys: { a: ['x', 'y'] } => 'a=x&a=y'
+ * @param {Object} params - Query parameters object
+ * @returns {string} - URL encoded query string
+ */
+function buildSearchParams (params) {
+  const searchParams = new URLSearchParams();
+  for (const [key, value] of Object.entries(params)) {
+    if (Array.isArray(value)) {
+      for (const item of value) {
+        searchParams.append(key, item);
+      }
+    } else if (value !== undefined && value !== null) {
+      searchParams.append(key, value);
+    }
+  }
+  return searchParams.toString();
+}
+
+module.exports = buildSearchParams;

components/pryv/src/lib/getEventStreamed.js

@@ -4,6 +4,8 @@
  */
 /* global fetch */
 
+const buildSearchParams = require('./buildSearchParams');
+
 module.exports = getEventStreamed;
 
 async function getEventStreamed (conn, queryParam, parser) {
@@ -43,7 +45,7 @@ async function getEventStreamed (conn, queryParam, parser) {
 
   // ------------   fetch ------------------- //
   const url = new URL(conn.endpoint + 'events');
-  url.search = new URLSearchParams(queryParam).toString();
+  url.search = buildSearchParams(queryParam);
   const fetchParams = { method: 'GET', headers: { Accept: 'application/json' } };
   if (conn.token) fetchParams.headers.Authorization = conn.token;
 

components/pryv/src/utils.js

@@ -4,6 +4,7 @@
  */
 const regexAPIandToken = /(.+):\/\/(.+)@(.+)/gm;
 const regexSchemaAndPath = /(.+):\/\/(.+)/gm;
+const buildSearchParams = require('./lib/buildSearchParams');
 
 /**
  * Utilities to access Pryv API.
@@ -21,7 +22,7 @@ const utils = module.exports = {
   async fetchGet (url, queryParams = {}, headers = {}) {
     let queryStr = '';
     if (queryParams && Object.keys(queryParams).length > 0) {
-      queryStr = '?' + new URLSearchParams(queryParams).toString();
+      queryStr = '?' + buildSearchParams(queryParams);
     }
     const myHeaders = Object.assign({ Accept: 'application/json' }, headers);
     const response = await fetch(url + queryStr, { headers: myHeaders });

components/pryv/test/Connection.test.js

@@ -311,9 +311,12 @@ describe('[CONX] Connection', () => {
       expect(res.events.length).to.equal(1);
     });
 
-    it('[CGTA] /events with params', async () => {
+    it('[CGTB] /events with params', async () => {
       const res = await conn.get('events', { fromTime: 0, toTime: Date.now() / 1000, limit: 10000, types: ['note/txt'], streams: ['data', 'monitor-test'] });
-      console.log(res);
+      expect(res.events.length > 0).to.be.true;
+      for (const event of res.events) {
+        expect(event.type).to.equal('note/txt');
+      }
     });
   });
 
@@ -349,7 +352,9 @@ describe('[CONX] Connection', () => {
       it('[CSNZ] streaming with query params', async () => {
         const queryParams = { fromTime: 0, toTime: Date.now() / 1000, limit: 10000, types: ['note/txt'], streams: ['data', 'monitor-test'] };
         let eventsCount = 0;
-        function forEachEvent (event) { eventsCount++; console.log(event.type, event.streamIds); }
+        function forEachEvent (event) {
+          eventsCount++;
+        }
         const res = await conn.getEventsStreamed(queryParams, forEachEvent);
         expect(eventsCount).to.equal(res.eventsCount);
       });

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "lib-js",
-  "version": "3.0.0",
+  "version": "3.0.1",
   "private": false,
   "description": "Pryv JavaScript library and add-ons",
   "keywords": [