chore: add UserDescriptor to branches.list (#293)

* chore: add UserDescriptor to branches.list * fix: test * fix: cleanup * fix: feedback + docs * Revert "fix: feedback + docs" This reverts commit 02afb20. * progress: allow project & user filter * progress: update docs + type definitions * Update docs/abstract-api.md Co-authored-by: Tom Moor <[email protected]> * fix: stringify once Co-authored-by: Tom Moor <[email protected]>
goabstract · Jul 16, 2020 · 0849b63 · 0849b63
1 parent 1737299
commit 0849b63
Show file tree

Hide file tree

Showing 4 changed files with 68 additions and 11 deletions.
diff --git a/abstract-sdk.d.ts b/abstract-sdk.d.ts
@@ -150,7 +150,7 @@ interface Assets extends Endpoint {
 interface Branches extends Endpoint {
   info(descriptor: BranchDescriptor, requestOptions?: RequestOptions): Promise<Branch>;
   list(
-    descriptor?: ProjectDescriptor,
+    descriptor?: ProjectDescriptor | UserDescriptor | ProjectMembershipDescriptor,
     options?: RequestOptions & { filter?: "active" | "archived" | "mine", search?: string }
   ): Promise<Branch[]>;
   mergeState(descriptor: BranchDescriptor, options?: { parent?: string }): Promise<BranchMergeState>;

diff --git a/docs/abstract-api.md b/docs/abstract-api.md
@@ -226,6 +226,25 @@ abstract.branches.list({
 });
 ```
 
+List all active branches for a user in a project
+
+```js
+abstract.branches.list({
+  userId: "48b5d670-2002-45ea-929d-4b00863778e4",
+  projectId: "616daa90-1736-11e8-b8b0-8d1fec7aef78"
+}, {
+  filter: "active"
+});
+```
+
+List all branches for a user across all organizations
+
+```js
+abstract.branches.list({
+  userId: "48b5d670-2002-45ea-929d-4b00863778e4"
+});
+```
+
 Search for a branch by name across all projects 
 
 ```js
@@ -2390,7 +2409,7 @@ Reference for the parameters required to load resources with the Abstract SDK.
 }
 ```
 
-### OrganizationProjectDescriptor
+### ProjectMembershipDescriptor
 
 ```js
 {
@@ -2399,7 +2418,7 @@ Reference for the parameters required to load resources with the Abstract SDK.
 }
 ```
 
-### ProjectMembershipDescriptor
+### OrganizationMembershipDescriptor
 
 ```js
 {

diff --git a/src/endpoints/Branches.js b/src/endpoints/Branches.js
@@ -6,7 +6,8 @@ import type {
   BranchMergeState,
   ListOptions,
   ProjectDescriptor,
-  RequestOptions
+  RequestOptions,
+  UserDescriptor
 } from "../types";
 import Endpoint from "../endpoints/Endpoint";
 import { wrap } from "../util/helpers";
@@ -47,7 +48,7 @@ export default class Branches extends Endpoint {
   }
 
   list(
-    descriptor?: ProjectDescriptor,
+    descriptor?: ProjectDescriptor | UserDescriptor,
     options: {
       ...ListOptions,
       filter?: "active" | "archived" | "mine",
@@ -58,17 +59,34 @@ export default class Branches extends Endpoint {
 
     return this.configureRequest<Promise<Branch[]>>("list", {
       api: async () => {
-        const query = querystring.stringify({ limit, offset, filter, search });
-        const requestUrl = descriptor
-          ? `projects/${descriptor.projectId}/branches/?${query}`
-          : `branches/?${query}`;
+        let queryOptions = { limit, offset, filter, search };
+        let response = null;
+
+        if (descriptor && descriptor.userId) {
+          queryOptions = {
+            ...queryOptions,
+            userId: descriptor.userId
+          };
+        }
+
+        const query = querystring.stringify(queryOptions);
+
+        if (descriptor && descriptor.projectId) {
+          response = await this.apiRequest(
+            `projects/${descriptor.projectId}/branches/?${query}`,
+            { headers }
+          );
+        } else {
+          response = await this.apiRequest(`branches/?${query}`, {
+            headers
+          });
+        }
 
-        const response = await this.apiRequest(requestUrl, { headers });
         return wrap(response.data.branches, response);
       },
 
       cli: async () => {
-        if (!descriptor) {
+        if (!descriptor || (descriptor && !descriptor.projectId)) {
           throw new BranchSearchCLIError();
         }
 

diff --git a/tests/endpoints/Branches.test.js b/tests/endpoints/Branches.test.js
@@ -137,6 +137,26 @@ describe("branches", () => {
       ]);
     });
 
+    test("api - all branches for a user", async () => {
+      mockAPI("/branches/?userId=1234", {
+        data: {
+          branches: [
+            {
+              id: "branch-id"
+            }
+          ]
+        }
+      });
+
+      const response = await API_CLIENT.branches.list({ userId: "1234" });
+
+      expect(response).toEqual([
+        {
+          id: "branch-id"
+        }
+      ]);
+    });
+
     test("cli", async () => {
       mockCLI(["branches", "list", "--project-id=project-id"], {
         branches: [