fix: prevent potentially null base log urls from being used (#20)

* fix: prevent potentially null baseUrls from being used

* test: fixing a test that was asserting against a false positive

Author: erunion

packages/node/__tests__/index.test.js

@@ -355,7 +355,7 @@ describe('#metrics', () => {
       })
         .get('/v1/')
         .basicAuth({ user: apiKey })
-        .reply(200, {
+        .reply(401, {
           error: 'APIKEY_NOTFOUNDD',
           message: "We couldn't find your API key",
           suggestion:
@@ -382,7 +382,7 @@ describe('#metrics', () => {
         .get('/test')
         .expect(200)
         .expect(res => {
-          expect(getCache().getKey('baseUrl')).toBeUndefined();
+          expect(getCache().getKey('baseUrl')).toBeNull();
 
           // `x-documentation-url` header should not be present since we couldn't get the base URL!
           expect(Object.keys(res.headers)).not.toContain('x-documentation-url');

packages/node/index.js

@@ -57,7 +57,13 @@ async function getProjectBaseUrl(encodedApiKey) {
         'User-Agent': `${pkg.name}/${pkg.version}`,
       },
     })
-      .then(res => res.json())
+      .then(res => {
+        if (res.status >= 400 && res.status <= 599) {
+          throw res;
+        }
+
+        return res.json();
+      })
       .then(project => {
         baseUrl = project.baseUrl;
 
@@ -96,7 +102,7 @@ module.exports.metrics = (apiKey, group, options = {}) => {
     const startedDateTime = new Date();
     const logId = uuidv4();
 
-    if (baseLogUrl !== undefined) {
+    if (baseLogUrl !== undefined && typeof baseLogUrl === 'string') {
       res.setHeader('x-documentation-url', `${baseLogUrl}/logs/${logId}`);
     }