Skip to content
This repository was archived by the owner on Jun 30, 2022. It is now read-only.

Commit 62d67fe

Browse files
Batta32darrenj
authored andcommitted
[Documentation] Add Firewall configuration in Known Issues documentation (#2910)
* Update Known Issue documentation adding firewall scenario * Add related issue of botbuilder-js
1 parent 2a0162d commit 62d67fe

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

docs/_docs/help/known-issues.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -214,3 +214,38 @@ protected override async Task<DialogTurnResult> OnContinueDialogAsync(DialogCont
214214
For more information, check the following issues:
215215
* [#1589](https://github.com/microsoft/botframework-solutions/issues/1589) - `OnTurnError function inside DefaultAdapter doesn't end the current dialog`
216216
* [#2766](https://github.com/microsoft/botframework-solutions/issues/2766) - `OnTurnError is not getting called in VA`
217+
218+
## If a resource has a firewall configured, the resource might not be reached by the bot
219+
There is a known issue in the Azure resources with a firewall configured when the bot is trying to reach to the resource:
220+
`{"code":"Forbidden","message":"Request originated from client IP <IP>. This is blocked by your <RESOURCE> firewall settings"}`
221+
222+
You can check your network configuration in the Azure Portal as follows:
223+
1. Select your desired resource
224+
1. Select `Firewall and virtual networks` configuration
225+
1. Check the configuration of the `Allow access from` to enable all or selected networks
226+
1. If you have selected networks, check the configured networks
227+
228+
If you are using a C# bot and Bot Framework Emulator, you will see a trace when these kind of exceptions are caught by the `onTurnError` handler in order to identify the error.
229+
230+
Otherwise, if you are using a TypeScript bot, you should remove the `showTypingMiddleware` and add the `onTurnError` handler in the `defaultAdapter`:
231+
232+
[DefaultAdapter.ts](https://github.com/microsoft/botframework-solutions/blob/master/templates/Virtual-Assistant-Template/typescript/samples/sample-assistant/src/adapters/defaultAdapter.ts)
233+
```typescript
234+
this.onTurnError = async (context: TurnContext, error: Error): Promise<void> => {
235+
await context.sendActivity({
236+
type: ActivityTypes.Trace,
237+
text: error.message || JSON.stringify(error)
238+
});
239+
await context.sendActivity({
240+
type: ActivityTypes.Trace,
241+
text: error.stack
242+
});
243+
telemetryClient.trackException({ exception: error });
244+
};
245+
```
246+
247+
For more information, check the following issues:
248+
* [botbuilder-js#1599](https://github.com/microsoft/botbuilder-js/issues/1599) - `[BotBuilder-Core] Handle Uncaught Exceptions`
249+
* [#2766](https://github.com/microsoft/botframework-solutions/issues/2766) - `OnTurnError is not getting called in VA`
250+
* [botbuilder-js#726](https://github.com/microsoft/botbuilder-js/issues/726) - `ShowTypingMiddleware suppresses errors and does not allow adapter.onTurnError to handle them`
251+
* [botbuilder-js#1170](https://github.com/microsoft/botbuilder-js/issues/1170) - `ShowTypingMiddleware provoke silent error behaviour`

0 commit comments

Comments
 (0)