From 3fe461e52cf559790b1fa9a0b5daa8db632b3fcd Mon Sep 17 00:00:00 2001 From: Sean Chen Date: Mon, 22 Jun 2026 17:09:25 -0400 Subject: [PATCH] fix: use query params for GET address-book methods - Replace .send(params) with .query(params) in getConnections, getListingEntryContacts, and getListingEntryDirectory so filters are sent as URL query params rather than request body GN-2899 #9084 --- .../src/bitgo/address-book/address-book.ts | 19 ++- .../unit/bitgo/address-book/address-book.ts | 156 ++++++++++++++++++ 2 files changed, 171 insertions(+), 4 deletions(-) create mode 100644 modules/sdk-core/test/unit/bitgo/address-book/address-book.ts diff --git a/modules/sdk-core/src/bitgo/address-book/address-book.ts b/modules/sdk-core/src/bitgo/address-book/address-book.ts index e578cb9a4e..418d48fef1 100644 --- a/modules/sdk-core/src/bitgo/address-book/address-book.ts +++ b/modules/sdk-core/src/bitgo/address-book/address-book.ts @@ -50,7 +50,11 @@ export class AddressBook implements IAddressBook { */ getConnections(params?: GetAddressBookConnectionsParams): Promise { const url = this.bitgo.microservicesUrl('/api/address-book/v1/connections'); - return this.bitgo.get(url).set('enterprise-id', this.enterpriseId).send(params).result(); + return this.bitgo + .get(url) + .set('enterprise-id', this.enterpriseId) + .query(params ?? {}) + .result(); } /** @@ -84,7 +88,6 @@ export class AddressBook implements IAddressBook { const response: GetAddressBookListingResponse = await this.bitgo .get(url) .set('enterprise-id', this.enterpriseId) - .send() .result(); this._listing = response; return this.listing() as AddressBookListing; @@ -125,7 +128,11 @@ export class AddressBook implements IAddressBook { params?: GetAddressBookListingEntryContactsParams ): Promise { const url = this.bitgo.microservicesUrl('/api/address-book/v1/listing/entry/contacts'); - return this.bitgo.get(url).set('enterprise-id', this.enterpriseId).send(params).result(); + return this.bitgo + .get(url) + .set('enterprise-id', this.enterpriseId) + .query(params ?? {}) + .result(); } /** @@ -135,7 +142,11 @@ export class AddressBook implements IAddressBook { params?: GetAddressBookListingEntryDirectoryParams ): Promise { const url = this.bitgo.microservicesUrl('/api/address-book/v1/listing/entry/directory'); - return this.bitgo.get(url).set('enterprise-id', this.enterpriseId).send(params).result(); + return this.bitgo + .get(url) + .set('enterprise-id', this.enterpriseId) + .query(params ?? {}) + .result(); } /** diff --git a/modules/sdk-core/test/unit/bitgo/address-book/address-book.ts b/modules/sdk-core/test/unit/bitgo/address-book/address-book.ts new file mode 100644 index 0000000000..530e8c122c --- /dev/null +++ b/modules/sdk-core/test/unit/bitgo/address-book/address-book.ts @@ -0,0 +1,156 @@ +import * as sinon from 'sinon'; +import * as superagent from 'superagent'; +import 'should'; +import { AddressBook } from '../../../../src/bitgo/address-book/address-book'; + +describe('AddressBook', function () { + let addressBook: AddressBook; + let mockBitGo: any; + const enterpriseId = 'test-enterprise-id'; + + function makeGetStub() { + const queryStub = sinon.stub().returns({ result: sinon.stub().resolves({}) }); + const setStub = sinon.stub().returns({ query: queryStub }); + mockBitGo.get.returns({ set: setStub }); + return { setStub, queryStub }; + } + + function makeParameterlessGetStub(response: Record = {}) { + const resultStub = sinon.stub().resolves(response); + const setStub = sinon.stub().returns({ result: resultStub }); + mockBitGo.get.returns({ set: setStub }); + return { setStub, resultStub }; + } + + beforeEach(function () { + mockBitGo = { + get: sinon.stub(), + microservicesUrl: sinon.stub().callsFake((path: string) => `https://app.bitgo.com${path}`), + }; + addressBook = new AddressBook(enterpriseId, mockBitGo); + }); + + afterEach(function () { + sinon.restore(); + }); + + describe('getConnections', function () { + it('should pass params as query string, not request body', async function () { + const { queryStub } = makeGetStub(); + const params = { connectionType: 'DVP' as const, status: 'INACTIVE' as const, offset: 0, limit: 10 }; + + await addressBook.getConnections(params); + + sinon.assert.calledWith(mockBitGo.get, 'https://app.bitgo.com/api/address-book/v1/connections'); + sinon.assert.calledOnce(queryStub); + sinon.assert.calledWith(queryStub, params); + }); + + it('should work with no params', async function () { + const { queryStub } = makeGetStub(); + + await addressBook.getConnections(); + + sinon.assert.calledWith(mockBitGo.get, 'https://app.bitgo.com/api/address-book/v1/connections'); + sinon.assert.calledOnce(queryStub); + sinon.assert.calledWith(queryStub, {}); + }); + + it('should pass array filters to query unchanged', async function () { + const { queryStub } = makeGetStub(); + const params = { + ownerWalletId: ['wallet-a', 'wallet-b'], + targetWalletId: ['wallet-c'], + }; + + await addressBook.getConnections(params); + + sinon.assert.calledWith(mockBitGo.get, 'https://app.bitgo.com/api/address-book/v1/connections'); + sinon.assert.calledOnce(queryStub); + sinon.assert.calledWith(queryStub, params); + }); + }); + + describe('getConnections array query param serialization', function () { + it('superagent serializes string[] as repeated keys, which address-book accepts via nonEmptyArrayFromQueryParam', function () { + const req = superagent.get('https://example.com').query({ + ownerWalletId: ['wallet-a', 'wallet-b'], + targetWalletId: ['wallet-c'], + }); + // Trigger superagent's query-string assembly without sending the request. + req.end(() => undefined); + + req.url!.should.equal( + 'https://example.com?ownerWalletId=wallet-a&ownerWalletId=wallet-b&targetWalletId=wallet-c' + ); + }); + }); + + describe('getListing', function () { + it('should use GET with enterprise-id header and no query or body', async function () { + const listing = { + id: 'listing-id', + enterpriseId, + name: 'Test Listing', + owner: 'owner', + createdAt: '2024-01-01', + updatedAt: '2024-01-01', + }; + const { setStub, resultStub } = makeParameterlessGetStub(listing); + + const result = await addressBook.getListing(); + + sinon.assert.calledWith(mockBitGo.get, 'https://app.bitgo.com/api/address-book/v1/listing/global'); + sinon.assert.calledOnce(setStub); + sinon.assert.calledWith(setStub, 'enterprise-id', enterpriseId); + sinon.assert.calledOnce(resultStub); + result.should.deepEqual(listing); + }); + }); + + describe('getListingEntryContacts', function () { + it('should pass params as query string, not request body', async function () { + const { queryStub } = makeGetStub(); + const params = { status: 'ACTIVE' as const, limit: 5 }; + + await addressBook.getListingEntryContacts(params); + + sinon.assert.calledWith(mockBitGo.get, 'https://app.bitgo.com/api/address-book/v1/listing/entry/contacts'); + sinon.assert.calledOnce(queryStub); + sinon.assert.calledWith(queryStub, params); + }); + + it('should work with no params', async function () { + const { queryStub } = makeGetStub(); + + await addressBook.getListingEntryContacts(); + + sinon.assert.calledWith(mockBitGo.get, 'https://app.bitgo.com/api/address-book/v1/listing/entry/contacts'); + sinon.assert.calledOnce(queryStub); + sinon.assert.calledWith(queryStub, {}); + }); + }); + + describe('getListingEntryDirectory', function () { + it('should pass params as query string, not request body', async function () { + const { queryStub } = makeGetStub(); + const params = { status: 'ACTIVE' as const, limit: 5 }; + + await addressBook.getListingEntryDirectory(params); + + sinon.assert.calledWith(mockBitGo.get, 'https://app.bitgo.com/api/address-book/v1/listing/entry/directory'); + sinon.assert.calledOnce(queryStub); + sinon.assert.calledWith(queryStub, params); + }); + + it('should work with no params', async function () { + const { queryStub } = makeGetStub(); + + await addressBook.getListingEntryDirectory(); + + sinon.assert.calledWith(mockBitGo.get, 'https://app.bitgo.com/api/address-book/v1/listing/entry/directory'); + sinon.assert.calledOnce(queryStub); + sinon.assert.calledWith(queryStub, {}); + }); + }); +});