[WR-175] change search access request signature (#77)

* changes multiple filter array arguments to be a single filters object

Author: pirtleshell

.env.example

@@ -5,4 +5,4 @@ API_URL=https://dev.e3db.com
 CLIENT_REGISTRATION_TOKEN=<existing_client_token_here>
 ID_REALM_NAME=<existing_realm_name_here>
 ID_APP_NAME=account
-TEST_TOZID_GROUP_ID=<existing_group_id_here>
+TEST_TOZID_GROUP_ID=<existing_group_id_that_has_access_policy_here>

__tests__/identity.test.js

@@ -173,15 +173,15 @@ describe('Tozny identity client', () => {
     )
 
     // search for requests this client made!
-    const searchByRequestorIDsParams = [identity.storage.config.clientId]
-
+    const filters = {
+      requestorIds: [identity.storage.config.clientId],
+    }
     // NOTE: fails due to "Group must have only 1 access policy" but we have none
     // create in 'Manage Realm' via UI to setup policy record
     const searchResults = await ops.searchAccessRequests(
       realmConfig,
       identity,
-      searchByRequestorIDsParams,
-      null, // searchByGroupIDsParams
+      filters,
       0, // next token
       10 // limit
     )
@@ -258,11 +258,8 @@ describe('Tozny identity client', () => {
       accessRequestId: createdAccessRequest.id,
       comment: 'COMMENT',
     }
-    await ops.approveAccessRequests(
-      realmConfig,
-      identity,
-      realmName,
-      [approval]
-    )
+    await ops.approveAccessRequests(realmConfig, identity, realmName, [
+      approval,
+    ])
   })
 })

__tests__/utils/operations.js

@@ -1276,20 +1276,12 @@ module.exports = {
     )
     return JSON.parse(result)
   },
-  async searchAccessRequests(
-    config,
-    user,
-    searchByRequestorIDsParams,
-    searchByGroupIDsParams,
-    nextToken,
-    limit
-  ) {
+  async searchAccessRequests(config, user, filters, nextToken, limit) {
     const result = await runInEnvironment(
       async function (
         realmJSON,
         userJSON,
-        searchByRequestorIDsParamsJSON,
-        searchByGroupIDsParamsJSON,
+        filtersJSON,
         nextTokenJson,
         limitJSON
       ) {
@@ -1302,18 +1294,12 @@ module.exports = {
         )
         const user = realm.fromObject(userJSON)
         return user
-          .searchAccessRequests(
-            searchByRequestorIDsParamsJSON,
-            searchByGroupIDsParamsJSON,
-            nextTokenJson,
-            limitJSON
-          )
+          .searchAccessRequests(filtersJSON, nextTokenJson, limitJSON)
           .then(JSON.stringify)
       },
       JSON.stringify(config),
       user.stringify(),
-      searchByRequestorIDsParams,
-      searchByGroupIDsParams,
+      filters,
       nextToken,
       limit
     )

lib/identity/client.js

@@ -1183,30 +1183,30 @@ class Client extends PartialClient {
    * searchAccessRequests allows for searching for all access requests associated or authorizable
    * by the searcher, allowing for filtering based off group id to access or requestor id
    *
-   * @param {Object} accessRequestSearchRequest
+   * @param {Object} filters Information about filters by which to search access requests.
+   * @param {string[]} [filters.groupIds] List of ids of which group the access request is for
+   * @param {string[]} [filters.requestorIds] List of ids of who created the access request
+   * @param {number} [nextToken] Pagination token of the search results
+   * @param {number} [limit] Maximum number of responses per search page. Defaults to 1000.
    *
    * @return {Object} Access requests matching the search filter
    */
-  async searchAccessRequests(
-    filterByRequestorIDs = [],
-    filterByGroupIDs = [],
-    nextToken = 0,
-    limit = 1000
-  ) {
-    const requestParams = new AccessRequestSearchRequest(
-      filterByRequestorIDs,
-      filterByGroupIDs,
-      nextToken,
-      limit
-    )
+  async searchAccessRequests(filters = {}, nextToken = 0, limit = 1000) {
     let response = await this.storage.authenticator.tsv1Fetch(
       `${this.storage.config.apiUrl}/v1/identity/pam/access_requests/search`,
       {
         method: 'POST',
         headers: {
           'Content-Type': 'application/json',
         },
-        body: requestParams.stringify(),
+        body: JSON.stringify({
+          access_request_search_filters: {
+            group_ids: filters.groupIds,
+            requestor_ids: filters.requestorIds,
+          },
+          next_token: nextToken,
+          limit,
+        }),
       }
     )
     await checkStatus(response)
@@ -1256,13 +1256,13 @@ class Client extends PartialClient {
   }
 
   /**
-     * approveAccessRequests approves one or more access requests
-     *
-     * @param {string} realmName - name of realm
-     * @param {Array} approvals - an array of objects with the access request id and comment
-     *
-     * @return {Object} The updated access requests
-     */
+   * approveAccessRequests approves one or more access requests
+   *
+   * @param {string} realmName - name of realm
+   * @param {Array} approvals - an array of objects with the access request id and comment
+   *
+   * @return {Object} The updated access requests
+   */
   async approveAccessRequests(realmName, approvals) {
     const request = new AccessRequestApprovalsRequest(realmName, approvals)
     let response = await this.storage.authenticator.tsv1Fetch(

types/accessRequestSearchRequest.js

@@ -36,7 +36,6 @@ const GroupMembership = require('./groupMembership')
 const Capabilities = require('./capabilities')
 const GroupMember = require('./groupMember')
 const AccessRequest = require('./accessRequest')
-const AccessRequestSearchRequest = require('./accessRequestSearchRequest')
 const AccessRequestSearchResponse = require('./accessRequestSearchResponse')
 const AccessRequestApprovalsRequest = require('./accessRequestApprovalsRequest')
 const AccessRequestApprovalsResponse = require('./accessRequestApprovalsResponse')
@@ -80,7 +79,6 @@ module.exports = {
   Capabilities,
   GroupMember,
   AccessRequest,
-  AccessRequestSearchRequest,
   AccessRequestSearchResponse,
   AccessRequestApprovalsRequest,
   AccessRequestApprovalsResponse,