Azure bot Direct Line App Service Extension Error: Upgrade to WebSocket is required.

Question

Azure bot Direct Line App Service Extension Error: Upgrade to WebSocket is required.

Pravin Ambekar 6

Hello Team,

I have Azure web app bot using bot framework and qnamaker , To isolate bot service from unauthenticated user access we have enabled Direct Line App Service Extension.
For this:

1) We have enabled App service extension from Direct Line Channel in portal
2) Configured App Service Extension Keys into App Service.
3) Made required change in Web App Bot source to add app.UseWebSocket() & app.UseNamedPipes() and deployed changes. (apart from these two, i have not made any other change)

the Bot is created and configured through Virtual Assistant template and the OS is of Linux kind.

But i am getting error upon accessing https://xxx.azurewebsites.net/api/messages that Upgrade to WebSocket is required.
and getting 404 error while access https://xxx.azurewebsites.net/.bot/

I already have

enabled Web Socket option from General Settings of App service configuration,
Configured DirectLineExtensionKey and Version in Application Settings section.

I already have followed troubleshooting steps mentioned here: https://learn.microsoft.com/en-us/azure/bot-service/bot-service-channel-directline-extension-net-bot?view=azure-bot-service-4.0#troubleshooting but still not success

Surprisingly bot in the web chat still working and responding to questions

Could you please advise what could be possible reason for the issue, as the check for correct configuration is to see json result upon navigating to : https://<your_app_service>.azurewebsites.net/.bot and getting result something like : {"v":"123","k":true,"ib":true,"ob":true,"initialized":true}
But here i am getting 404.

Thank you.

YutongTie-MSFT 53,971 Reputation points Moderator

2022-01-06T18:12:36.483+00:00

@Pravin Ambekar

Hello, when you mentioned your web chat is working, are you mentioning "Test in Web Chat" works from Azure Portal > Your Resource Group > Your Bot > Test in Web Chat?

Please ensure that you ran the az bot prepare-deploy step prior to deployment. Missing this step often manifests in a bot not starting or 404 errors (due to missing/incorrect web.config) when visiting https://<yourBot>.azurewebsites.net

Regards,
Yutong
Pravin Ambekar 6 Reputation points

2022-01-07T04:17:02.027+00:00

Hello @YutongTie-MSFT ,

Thank you for the response,

Yes, Web Chat here means "Test In Web Chat", which we normally access in portal Web App Bot blade.

About az bot prepare: Yes this step is part of deployment and it is included in publish.ps1 ps script.

As mentioned earlier i am using Virtual assistant template for provisioning BOT resources and Bot app deployment
Which includes Bot prepare-deploy step:

//Check for existing deployment files

if (-not (Test-Path (Join-Path $projFolder '.deployment'))) {
# Add needed deployment files for az
az bot prepare-deploy --lang Csharp --code-dir $projFolder --proj-file-path $projFile.name --output json | Out-Null
}

Is there anyway to check if configuration in web.config is incorrect or to trace reason for getting 404 ?
Pravin Ambekar 6 Reputation points

2022-01-07T15:33:15.827+00:00

Hello again @YutongTie-MSFT ,

Just an additional information , the normal https://xxx.azurewebsites.net site loading default page correctly, and as i mentioned Test Web app bot also working properly
Only concern in i am not able to check if Direct Line Extension service is working properly or not because the url https://xxx.azurewebsites.net/.bot or
https://xxx.azurewebsites.net/api/messages not returning correct output
Pravin Ambekar 6 Reputation points

2022-01-12T12:28:37.227+00:00

Hi @YutongTie-MSFT ,

Additionally when i try to access client html page where bot is configured to request token and access bot service i get error message as :

webchat.js:2 WebSocket connection to 'wss://xxx.azurewebsite.net/.bot/v3/directline/conversations/connect?token=ew0KICAiYWxnIjogIlJTMjU2IiwNCiAgImtpZCI6ICJ2cG4y... failed:

I have mentioned detailed explanation here : https://github.com/microsoft/botframework-solutions/issues/3849 in case you need any additional detail.

Thank you in advance.
YutongTie-MSFT 53,971 Reputation points Moderator

2022-01-16T23:54:05.167+00:00

@Pravin Ambekar Thanks for the details, I am also tracking on that github issue to see any response from bot team.
Pravin Ambekar 6 Reputation points

2022-01-20T11:45:06.743+00:00

Hello @YutongTie-MSFT ,

Is there really nothing we could do, apart from waiting from Bot Framework team,
I mean its been more that two week but i am still struggling to understand root cause for the issue.
I have put everything there on GitHub for presenting the case , but no positive feedback yet.
I desperately need this as there is pressure on me to get this fixed.
YutongTie-MSFT 53,971 Reputation points Moderator

2022-01-25T18:51:10.187+00:00

@Pravin Ambekar

I am sorry for your experience. I have seen active responses in the GitHub thread, if you feel free the process is slow, I can enable you a support ticket to get help from support engineer at the meantime.

The last response from the engineer is from 8 hours ago:

Please let me know if this helps or not, so that we can push this to solve before your due.

Regards,
Yutong

2 answers

Your answer

YutongTie-MSFT 53,971 Reputation points Moderator

2022-01-06T18:12:36.483+00:00

@Pravin Ambekar

Hello, when you mentioned your web chat is working, are you mentioning "Test in Web Chat" works from Azure Portal > Your Resource Group > Your Bot > Test in Web Chat?

Please ensure that you ran the az bot prepare-deploy step prior to deployment. Missing this step often manifests in a bot not starting or 404 errors (due to missing/incorrect web.config) when visiting https://<yourBot>.azurewebsites.net

Regards,
Yutong
Pravin Ambekar 6 Reputation points

2022-01-07T04:17:02.027+00:00

Hello @YutongTie-MSFT ,

Thank you for the response,

Yes, Web Chat here means "Test In Web Chat", which we normally access in portal Web App Bot blade.

About az bot prepare: Yes this step is part of deployment and it is included in publish.ps1 ps script.

As mentioned earlier i am using Virtual assistant template for provisioning BOT resources and Bot app deployment
Which includes Bot prepare-deploy step:

//Check for existing deployment files

if (-not (Test-Path (Join-Path $projFolder '.deployment'))) {
# Add needed deployment files for az
az bot prepare-deploy --lang Csharp --code-dir $projFolder --proj-file-path $projFile.name --output json | Out-Null
}

Is there anyway to check if configuration in web.config is incorrect or to trace reason for getting 404 ?
Pravin Ambekar 6 Reputation points

2022-01-07T15:33:15.827+00:00

Hello again @YutongTie-MSFT ,

Just an additional information , the normal https://xxx.azurewebsites.net site loading default page correctly, and as i mentioned Test Web app bot also working properly
Only concern in i am not able to check if Direct Line Extension service is working properly or not because the url https://xxx.azurewebsites.net/.bot or
https://xxx.azurewebsites.net/api/messages not returning correct output
Pravin Ambekar 6 Reputation points

2022-01-12T12:28:37.227+00:00

Hi @YutongTie-MSFT ,

Additionally when i try to access client html page where bot is configured to request token and access bot service i get error message as :

webchat.js:2 WebSocket connection to 'wss://xxx.azurewebsite.net/.bot/v3/directline/conversations/connect?token=ew0KICAiYWxnIjogIlJTMjU2IiwNCiAgImtpZCI6ICJ2cG4y... failed:

I have mentioned detailed explanation here : https://github.com/microsoft/botframework-solutions/issues/3849 in case you need any additional detail.

Thank you in advance.
YutongTie-MSFT 53,971 Reputation points Moderator

2022-01-16T23:54:05.167+00:00

@Pravin Ambekar Thanks for the details, I am also tracking on that github issue to see any response from bot team.
Pravin Ambekar 6 Reputation points

2022-01-20T11:45:06.743+00:00

Hello @YutongTie-MSFT ,

Is there really nothing we could do, apart from waiting from Bot Framework team,
I mean its been more that two week but i am still struggling to understand root cause for the issue.
I have put everything there on GitHub for presenting the case , but no positive feedback yet.
I desperately need this as there is pressure on me to get this fixed.
YutongTie-MSFT 53,971 Reputation points Moderator

2022-01-25T18:51:10.187+00:00

@Pravin Ambekar

I am sorry for your experience. I have seen active responses in the GitHub thread, if you feel free the process is slow, I can enable you a support ticket to get help from support engineer at the meantime.

The last response from the engineer is from 8 hours ago:

Please let me know if this helps or not, so that we can push this to solve before your due.

Regards,
Yutong

Answer 1

Destin Joy 1,871

Check Issue is due to WebSockets being disabled in the bot's web.config

Answer 2

Alasdair Miller 1

Am having the same issue - did you resolve ?

Pravin Ambekar 6 Reputation points

2022-04-04T06:14:33.06+00:00

@Alasdair Miller

Yes, Basically i moved QnA maker to latest Language service, having Custom Question Answering feature.
Let me know if you need any additional information.

Share via

Azure bot Direct Line App Service Extension Error: Upgrade to WebSocket is required.

2 answers

Your answer