feat: Update getBuilds filter param to support array values (#149)

* Update getBuilds filter param to support array values * Use interpolation rather than concat
percy · Oct 28, 2019 · f596999 · f596999
1 parent 503a884
commit f596999
Show file tree

Hide file tree

Showing 2 changed files with 43 additions and 1 deletion.
diff --git a/src/main.js b/src/main.js
@@ -181,7 +181,15 @@ class PercyClient {
   getBuilds(project, filter) {
     filter = filter || {};
     let queryString = Object.keys(filter)
-      .map(key => 'filter[' + key + ']=' + filter[key])
+      .map(key => {
+        if (Array.isArray(filter[key])) {
+          // If filter value is an array, match Percy API's format expectations of:
+          //   filter[key][]=value1&filter[key][]=value2
+          return filter[key].map(array_value => `filter[${key}][]=${array_value}`).join('&');
+        } else {
+          return 'filter[' + key + ']=' + filter[key];
+        }
+      })
       .join('&');
 
     if (queryString.length > 0) {

diff --git a/test/main-test.js b/test/main-test.js
@@ -234,6 +234,40 @@ describe('PercyClient', function() {
           });
       });
     });
+
+    describe('filtered by state, branch, and shas', function() {
+      it('returns the response body', function(done) {
+        let responseMock = function(url, requestBody) {
+          // Verify request data.
+          assert.equal(requestBody, '');
+          let responseBody = {foo: 123};
+          return [201, responseBody];
+        };
+
+        nock('https://percy.io')
+          .get(
+            '/api/v1/projects/my_project/builds?filter[branch]=master&filter[state]=finished' +
+              '&filter[shas][]=my_sha&filter[shas][]=my_other_sha',
+          )
+          .reply(201, responseMock);
+
+        let request = percyClient.getBuilds('my_project', {
+          branch: 'master',
+          state: 'finished',
+          shas: ['my_sha', 'my_other_sha'],
+        });
+
+        request
+          .then(response => {
+            assert.equal(response.statusCode, 201);
+            assert.deepEqual(response.body, {foo: 123});
+            done();
+          })
+          .catch(err => {
+            done(err);
+          });
+      });
+    });
   });
 
   describe('makeResource', function() {