DisableResponseDecompressionPolicy error with electron app using azure sdk from angular renderer

[amrit-moomie]

I have a desktop app that uses electron and angular. I am trying to upload the Blob storage using @azure/storage-blob in the angular renderer process. When uploadData method is called library will just crash with following error:

Error: Uncaught (in promise): Error: DisableResponseDecompressionPolicy is not supported in browser environment
Error: DisableResponseDecompressionPolicy is not supported in browser environment

Please note I am using nodeIntegration: true when opening the angular portal like below:

     this.mainWindow = new BrowserWindow({
          webPreferences: {
            nodeIntegration: true
         },
        });

From my understanding is that disableResponseDecompressionPolicy is only available in Node.js but this is a common use case where angular apps running inside an electron shell need to communicate with azure-storage. Can we get more clarity on this issue, whether this is a limit in the SDK and how can angular app inside electron work

old issue: #14025

[azure-sdk]

Label prediction was below confidence level 0.6 for Model:ServiceLabels: 'Storage:0.5366847,Azure.Core:0.18370384,Azure.Identity:0.06410674'

[maorleger]

@amrit-moomie thank you for creating this issue! I have routed it to the appropriate team for investigation. @EmmaZhu could someone from the storage team take a look?

[EmmaZhu]

Storage only uses disableResponseDecompressionPolicy when determined it's Node.js environment in runtime, but seems for Electron it still selects the browser path.

  if (isNode) {
    // policies only available in Node.js runtime, not in browsers
    factories.push(proxyPolicy(pipelineOptions.proxyOptions));
    factories.push(disableResponseDecompressionPolicy());
  }

@jeremymeng , any suggestions how we could deal with this situation?

Thanks
Emma

[amrit-moomie]

Hi @EmmaZhu
Any update on how this can be resolved?

[jeremymeng]

@EmmaZhu we could change the browser version of these policy to not throw and just log warning messages. However, if angular app is running our Storage SDK code in the browser path, users might be surprised when their compressed blob get decompressed automatically by the browser when downloading.

[EmmaZhu]

Hi @jeremymeng ,

I may understand the issue wrong, please correct me if I'm wrong.

The issue here is: when customer set nodeIntegration: true, isNode which detects the environment in runtime would return true, but the file is picked up in compiling and the compiler thinks it's a browser.

I see we only support disableResponseDecompressionPolicy in Node.JS, because we have no control on whether to decompress response content in Browser environment.

If customer sets nodeIntegration: true, do we have control on on whether to decompress response content? If anyway, we cannot control it, I think maybe ignoring the disableResponseDecompressionPolicy setting with a warning is a good way to go.

Thanks
Emma

[amrit-moomie]

Hi @EmmaZhu @jeremymeng

Possible to get a fix for this in the coming version?

[jeremymeng]

I don't know a lot about Electron. It seems that nodeIntegration: true would allow access to nodejs apis. I wonder whether there's a way to let Electron go through our NodeJS code path, then the behavior would not be a surprise.

[gingi]

I have the exact same issue. We use @azure/storage-blob in an Electron web view, and try to use browser-only flows (which is not ideal), but then encounter this error ("DisableResponseDecompressionPolicy is not supported in browser environment") when trying to list storage containers (BlobServiceClient.listContainers()). In addition to addressing this particular issue, it would be helpful to provide guidance on using the Azure Storage SDK in Electron (we use Webpack for bundling, for what it's worth).

[EmmaZhu]

Seems the root cause for this issue is: isNode function in our SDK determines it's a node environment, but the bundle still thinks it's a browser and uses the browser version file.

The best fix should be to make isNode and the bundle behavior consistent. But for now, we still don't know how the difference happens.

[EmmaZhu]

Hi @jeremymeng ,

If we add a browser version isNode implementation which always returns false, would this cause any potential issues? This way the isNode behavior would be consistent with the bundle way. I'm still worried this may cause other issues we don't know about for now.

Thanks
Emma

[gingi]

@EmmaZhu: It looks like isNode() works properly within the Electron renderer process (it returns true). But @azure/core-http still uses the browser version of several policies, including DisableResponseCompressionPolicy, which throw this error. It seems to be defined in package.json's "browser" section which is in turn used by rollup. So I'm assuming isNode() isn't being honored.

[EmmaZhu]

@gingi :

I think the issue is because: The bundler dectects it's a browserfy environment and choses the browser version DisableResponseCompressionPolicy definition when isNode() is not invoked yet. While in runtime, isNode() is invoked and returns true due to configure of nodeIntegration: true

[gingi]

Update:

I modified our webpack config to favor the node versions of both @azure/storage-blob and @azure/core-http (we need the latter because of policy enforcements):

    resolve: {
        alias: {
            "@azure/storage-blob":
                "node_modules/@azure/storage-blob/dist/index.js",
            "@azure/core-http":
                "node_modules/@azure/core-http/dist/index.js"
        }
    },

However, I am now facing the error Failed to execute 'fetch' on 'Window': Illegal invocation, which is thrown by:

https://github.com/gingi/azure-sdk-for-js/blob/80949a8a07f168c1e45188f52d9ddf09fffa8edc/sdk/core/core-http/src/nodeFetchHttpClient.ts#L359-L359

Any ideas on how to handle this? I found this possibly related issue.

[amrit-moomie]

@EmmaZhu
Is it possible to get a workaround or solution to this issue?

[ghost]

Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc @xgithubtriage.

Issue Details

---

I have a desktop app that uses electron and angular. I am trying to upload the Blob storage using @azure/storage-blob in the angular renderer process. When uploadData method is called library will just crash with following error:

Error: Uncaught (in promise): Error: DisableResponseDecompressionPolicy is not supported in browser environment
Error: DisableResponseDecompressionPolicy is not supported in browser environment

Please note I am using nodeIntegration: true when opening the angular portal like below:

     this.mainWindow = new BrowserWindow({
          webPreferences: {
            nodeIntegration: true
         },
        });

From my understanding is that disableResponseDecompressionPolicy is only available in Node.js but this is a common use case where angular apps running inside an electron shell need to communicate with azure-storage. Can we get more clarity on this issue, whether this is a limit in the SDK and how can angular app inside electron work

old issue: #14025

Author:	amrit-moomie
Assignees:	EmmaZhu
Labels:	bug, customer-reported, Client, Storage, Service Attention
Milestone:	-

[EmmaZhu]

Hi @jeremymeng ,

Any chance to Iadd a browser version isNode implementation which always returns false, would this cause any potential issues?

Thanks
Emma

[github-actions]

Hi @amrit-moomie, we deeply appreciate your input into this project. Regrettably, this issue has remained inactive for over 2 years, leading us to the decision to close it. We've implemented this policy to maintain the relevance of our issue queue and facilitate easier navigation for new contributors. If you still believe this topic requires attention, please feel free to create a new issue, referencing this one. Thank you for your understanding and ongoing support.