Client: Don't send auth header when token is empty

.test-env

@@ -1,6 +1,6 @@
 # Configs for testing repo download:
-SDK_TESTING_URL="https://github.com/algorand/algorand-sdk-testing"
-SDK_TESTING_BRANCH="master"
+SDK_TESTING_URL="https://github.com/Eric-Warehime/algorand-sdk-testing"
+SDK_TESTING_BRANCH="client-no-header-tests"
 SDK_TESTING_HARNESS="test-harness"
 
 INSTALL_ONLY=0

src/client/v2/serviceClient.ts

@@ -19,6 +19,9 @@ function convertTokenStringToTokenHeader(
   headerIdentifier: TokenHeaderIdentifier
 ): TokenHeader {
   const tokenHeader = {};
+  if (token === '') {
+    return tokenHeader;
+  }
   tokenHeader[headerIdentifier] = token;
   return tokenHeader as TokenHeader;
 }

tests/9.Client.ts

@@ -161,6 +161,17 @@ describe('client', () => {
       assert.strictEqual(client.c['bc']['baseURL']['port'], '456');
     });
 
+    it('should not provide auth request headers when the token is empty', () => {
+      const client = new AlgodClient('', `${baseServer}:${123}`, 456);
+      assert.deepStrictEqual(
+        {
+          ...client.c['bc']['tokenHeaders'],
+          ...client.c['bc']['defaultHeaders'],
+        },
+        {}
+      );
+    });
+
     /* eslint-disable dot-notation */
   });
 });

tests/cucumber/steps/index.js

@@ -325,11 +325,11 @@ function setupMockServerForPaths(mockServer) {
   });
 }
 
-function getMockServerRequestUrlsMethods(mockServer) {
+function getMockServerRequestUrlsMethodsHeaders(mockServer) {
   return mockServer
     .requests()
     .filter((req) => req.method !== 'OPTIONS') // ignore cors preflight requests from the browser
-    .map((req) => ({ method: req.method, url: req.url }));
+    .map((req) => ({ method: req.method, url: req.url, headers: req.headers }));
 }
 
 function isFunction(functionToCheck) {
@@ -478,10 +478,10 @@ for (const name of Object.keys(steps.then)) {
   if (name === 'expect the path used to be {string}') {
     Then(name, function (expectedRequestPath) {
       // get all requests the mockservers have seen since reset
-      const algodSeenRequests = getMockServerRequestUrlsMethods(
+      const algodSeenRequests = getMockServerRequestUrlsMethodsHeaders(
         algodMockServerPathRecorder
       );
-      const indexerSeenRequests = getMockServerRequestUrlsMethods(
+      const indexerSeenRequests = getMockServerRequestUrlsMethodsHeaders(
         indexerMockServerPathRecorder
       );
       return fn.call(
@@ -494,10 +494,10 @@ for (const name of Object.keys(steps.then)) {
   } else if (name === 'expect the request to be {string} {string}') {
     Then(name, function (expectedRequestType, expectedRequestPath) {
       // get all requests the mockservers have seen since reset
-      const algodSeenRequests = getMockServerRequestUrlsMethods(
+      const algodSeenRequests = getMockServerRequestUrlsMethodsHeaders(
         algodMockServerPathRecorder
       );
-      const indexerSeenRequests = getMockServerRequestUrlsMethods(
+      const indexerSeenRequests = getMockServerRequestUrlsMethodsHeaders(
         indexerMockServerPathRecorder
       );
       return fn.call(
@@ -511,10 +511,10 @@ for (const name of Object.keys(steps.then)) {
   } else if (name === 'we expect the path used to be {string}') {
     Then(name, function (expectedRequestPath) {
       // get all requests the mockservers have seen since reset
-      const algodSeenRequests = getMockServerRequestUrlsMethods(
+      const algodSeenRequests = getMockServerRequestUrlsMethodsHeaders(
         algodMockServerPathRecorder
       );
-      const indexerSeenRequests = getMockServerRequestUrlsMethods(
+      const indexerSeenRequests = getMockServerRequestUrlsMethodsHeaders(
         indexerMockServerPathRecorder
       );
       return fn.call(
@@ -524,6 +524,19 @@ for (const name of Object.keys(steps.then)) {
         expectedRequestPath
       );
     });
+  } else if (
+    name === 'expect the observed header keys to equal the expected header keys'
+  ) {
+    Then(name, function () {
+      // get all requests the mockservers have seen since reset
+      const algodSeenRequests = getMockServerRequestUrlsMethodsHeaders(
+        algodMockServerPathRecorder
+      );
+      const indexerSeenRequests = getMockServerRequestUrlsMethodsHeaders(
+        indexerMockServerPathRecorder
+      );
+      return fn.call(this, algodSeenRequests, indexerSeenRequests);
+    });
   } else if (
     name === 'the produced json should equal {string} loaded from {string}'
   ) {

tests/cucumber/steps/steps.js

@@ -1604,6 +1604,28 @@ module.exports = function getSteps(options) {
     );
   });
 
+  Given('expected headers', (headersTable) => {
+    this.expectedHeaders = headersTable.hashes();
+  });
+
+  Then(
+    'expect the observed header keys to equal the expected header keys',
+    (algodSeenRequests, indexerSeenRequests) => {
+      let actualRequests;
+      if (algodSeenRequests.length !== 0) {
+        [actualRequests] = algodSeenRequests;
+      } else if (indexerSeenRequests.length !== 0) {
+        [actualRequests] = indexerSeenRequests;
+      } else {
+        throw new Error('no requests observed.');
+      }
+      assert.deepStrictEqual(
+        Object.keys(actualRequests.headers).sort(),
+        this.expectedHeaders.map((entry) => entry.key).sort()
+      );
+    }
+  );
+
   Then(
     'expect the path used to be {string}',
     (algodSeenRequests, indexerSeenRequests, expectedRequestPath) => {
@@ -3269,6 +3291,30 @@ module.exports = function getSteps(options) {
     }
   );
 
+  Given(
+    'an algod v2 client connected to mock server with token {string}',
+    function (token) {
+      this.v2Client = new algosdk.Algodv2(
+        token,
+        `http://${mockAlgodPathRecorderHost}`,
+        mockAlgodPathRecorderPort,
+        {}
+      );
+    }
+  );
+
+  Given(
+    'an indexer v2 client connected to mock server with token {string}',
+    function (token) {
+      this.indexerV2client = new algosdk.Indexer(
+        token,
+        `http://${mockIndexerPathRecorderHost}`,
+        mockIndexerPathRecorderPort,
+        {}
+      );
+    }
+  );
+
   Given(
     'I create a new transient account and fund it with {int} microalgos.',
     async function (fundingAmount) {
@@ -4781,6 +4827,14 @@ module.exports = function getSteps(options) {
     await this.v2Client.unsetSyncRound().do();
   });
 
+  When('we make an arbitrary algod call', async function () {
+    await this.v2Client.healthCheck().do();
+  });
+
+  When('we make an arbitrary indexer call', async function () {
+    await this.indexerV2client.makeHealthCheck().do();
+  });
+
   if (!options.ignoreReturn) {
     return steps;
   }

tests/cucumber/unit.tags

@@ -6,6 +6,7 @@
 @unit.applications.boxes
 @unit.atomic_transaction_composer
 @unit.blocksummary
+@unit.client-no-headers
 @unit.dryrun
 @unit.dryrun.trace.application
 @unit.feetest