Fix firewall error message (#54)

Co-authored-by: Jesse MacFadyen <[email protected]>

Author: moritzraho

lib/StateStoreError.js

@@ -53,13 +53,17 @@ E('ERROR_BAD_ARGUMENT', '%s')
 E('ERROR_NOT_IMPLEMENTED', 'method `%s` not implemented')
 E('ERROR_BAD_CREDENTIALS', 'cannot access %s, make sure your credentials are valid')
 E('ERROR_PAYLOAD_TOO_LARGE', 'key, value or request payload is too large')
+// this error is specific to Adobe's owned database
+E('ERROR_FIREWALL', 'cannot access %s because your IP is blocked by a firewall, please make sure to run in an Adobe I/O Runtime action')
 
 // eslint-disable-next-line jsdoc/require-jsdoc
 function logAndThrow (e) {
   const internalError = e.sdkDetails._internal
   // by default stringifying an Error returns '{}' because toJSON is not defined, so here we make sure that we properly
   // stringify the _internal error objects
-  if (internalError instanceof Error && !internalError.toJSON) internalError.toJSON = () => Object.getOwnPropertyNames(internalError).reduce((obj, prop) => { obj[prop] = internalError[prop]; return obj }, {})
+  if (internalError instanceof Error && !internalError.toJSON) {
+    internalError.toJSON = () => Object.getOwnPropertyNames(internalError).reduce((obj, prop) => { obj[prop] = internalError[prop]; return obj }, {})
+  }
   logger.error(JSON.stringify(e, null, 2))
   throw e
 }

lib/impl/CosmosStateStore.js

@@ -28,9 +28,19 @@ async function _wrap (promise, params) {
     const copyParams = cloneDeep(params)
     // error handling
     const status = e.statusCode || e.code
-    if (status === 404) return null
-    if (status === 403) logAndThrow(new codes.ERROR_BAD_CREDENTIALS({ messageValues: ['underlying DB provider'], sdkDetails: copyParams }))
-    if (status === 413) logAndThrow(new codes.ERROR_PAYLOAD_TOO_LARGE({ sdkDetails: copyParams }))
+    if (status === 404) {
+      return null
+    }
+    logger.debug(`got internal error with status ${status}: ${e.message} `)
+    if (status === 403) {
+      if (e.message.includes('blocked by your Cosmos DB account firewall settings')) {
+        logAndThrow(new codes.ERROR_FIREWALL({ messageValues: ['underlying DB provider'], sdkDetails: copyParams }))
+      }
+      logAndThrow(new codes.ERROR_BAD_CREDENTIALS({ messageValues: ['underlying DB provider'], sdkDetails: copyParams }))
+    }
+    if (status === 413) {
+      logAndThrow(new codes.ERROR_PAYLOAD_TOO_LARGE({ sdkDetails: copyParams }))
+    }
     logAndThrow(new codes.ERROR_INTERNAL({ messageValues: [`unknown error response from provider with status: ${status || 'unknown'}`], sdkDetails: { ...copyParams, _internal: e } }))
   }
   // 404 does not throw in cosmos SDK which is fine as we treat 404 as a non-error,

test/impl/CosmosStateStore.test.js

@@ -57,21 +57,24 @@ beforeEach(async () => {
 // eslint-disable-next-line jsdoc/require-jsdoc
 async function testProviderErrorHandling (func, mock, fparams) {
   // eslint-disable-next-line jsdoc/require-jsdoc
-  async function testOne (status, expectCheck, isInternal, ...addArgs) {
-    const providerError = new Error('fakeProviderError')
-    if (status) providerError.code = status
+  async function testOne (status, errorMessage, expectCheck, isInternal, ...addArgs) {
+    const providerError = new Error(errorMessage)
+    if (status) {
+      providerError.code = status
+    }
 
     const expectedErrorDetails = { ...fparams }
-    if (isInternal) expectedErrorDetails._internal = providerError
+    if (isInternal) { expectedErrorDetails._internal = providerError }
     mock.mockReset()
     mock.mockRejectedValue(providerError)
     await global[expectCheck](func, ...addArgs, expectedErrorDetails)
   }
 
-  await testOne(403, 'expectToThrowForbidden')
-  await testOne(413, 'expectToThrowTooLarge')
-  await testOne(500, 'expectToThrowInternalWithStatus', true, 500)
-  await testOne(undefined, 'expectToThrowInternal', true)
+  await testOne(403, 'This is blocked by your Cosmos DB account firewall settings.', 'expectToThrowFirewall')
+  await testOne(403, 'fakeError', 'expectToThrowForbidden')
+  await testOne(413, 'fakeError', 'expectToThrowTooLarge')
+  await testOne(500, 'fakeError', 'expectToThrowInternalWithStatus', true, 500)
+  await testOne(undefined, 'fakeError', 'expectToThrowInternal', true)
   // when provider resolves with bad status which is not 404
   const providerResponse = {
     statusCode: 400

test/jest.setup.js

@@ -63,6 +63,7 @@ global.expectToThrowCustomError = async (func, code, words, expectedErrorDetails
 
 global.expectToThrowBadArg = async (received, words, expectedErrorDetails) => global.expectToThrowCustomError(received, 'ERROR_BAD_ARGUMENT', words, expectedErrorDetails)
 global.expectToThrowForbidden = async (received, expectedErrorDetails) => global.expectToThrowCustomError(received, 'ERROR_BAD_CREDENTIALS', ['cannot', 'access', 'credentials'], expectedErrorDetails)
+global.expectToThrowFirewall = async (received, expectedErrorDetails) => global.expectToThrowCustomError(received, 'ERROR_FIREWALL', ['your', 'IP', 'blocked', 'firewall'], expectedErrorDetails)
 global.expectToThrowInternalWithStatus = async (received, status, expectedErrorDetails) => global.expectToThrowCustomError(received, 'ERROR_INTERNAL', ['' + status], expectedErrorDetails)
 global.expectToThrowInternal = async (received, expectedErrorDetails) => global.expectToThrowCustomError(received, 'ERROR_INTERNAL', ['unknown'], expectedErrorDetails)
 global.expectToThrowNotImplemented = async (received, methodName) => global.expectToThrowCustomError(received, 'ERROR_NOT_IMPLEMENTED', ['not', 'implemented', methodName], {})