Standardized app.py and on_error messages in original samples. (#376)

Author: tracyboehrer

samples/06.using-cards/app.py

@@ -6,6 +6,8 @@
 """
 import asyncio
 import sys
+from datetime import datetime
+from types import MethodType
 
 from flask import Flask, request, Response
 from botbuilder.core import (
@@ -16,49 +18,65 @@
     TurnContext,
     UserState,
 )
-from botbuilder.schema import Activity
+from botbuilder.schema import Activity, ActivityTypes
 
 from dialogs import MainDialog
 from bots import RichCardsBot
 
+# Create the loop and Flask app
 LOOP = asyncio.get_event_loop()
 APP = Flask(__name__, instance_relative_config=True)
 APP.config.from_object("config.DefaultConfig")
 
-SETTINGS = BotFrameworkAdapterSettings(
-    APP.config["APP_ID"], APP.config["APP_PASSWORD"]
-)
+# Create adapter.
+# See https://aka.ms/about-bot-adapter to learn more about how bots work.
+SETTINGS = BotFrameworkAdapterSettings(APP.config["APP_ID"], APP.config["APP_PASSWORD"])
 ADAPTER = BotFrameworkAdapter(SETTINGS)
 
+
 # Catch-all for errors.
-async def on_error(context: TurnContext, error: Exception):
-    # This check writes out errors to console log
+async def on_error(self, context: TurnContext, error: Exception):
+    # This check writes out errors to console log .vs. app insights.
     # NOTE: In production environment, you should consider logging this to Azure
     #       application insights.
-    print(f"\n [on_turn_error]: { error }", file=sys.stderr)
+    print(f"\n [on_turn_error] unhandled error: {error}", file=sys.stderr)
+
     # Send a message to the user
-    await context.send_activity("Oops. Something went wrong!")
+    await context.send_activity("The bot encountered an error or bug.")
+    await context.send_activity("To continue to run this bot, please fix the bot source code.")
+    # Send a trace activity if we're talking to the Bot Framework Emulator
+    if context.activity.channel_id == 'emulator':
+        # Create a trace activity that contains the error object
+        trace_activity = Activity(
+            label="TurnError",
+            name="on_turn_error Trace",
+            timestamp=datetime.utcnow(),
+            type=ActivityTypes.trace,
+            value=f"{error}",
+            value_type="https://www.botframework.com/schemas/error"
+        )
+        # Send a trace activity, which will be displayed in Bot Framework Emulator
+        await context.send_activity(trace_activity)
+
     # Clear out state
     await CONVERSATION_STATE.delete(context)
 
-
-ADAPTER.on_turn_error = on_error
+ADAPTER.on_turn_error = MethodType(on_error, ADAPTER)
 
 # Create MemoryStorage, UserState and ConversationState
 MEMORY = MemoryStorage()
-
-# Commented out user_state because it's not being used.
 USER_STATE = UserState(MEMORY)
 CONVERSATION_STATE = ConversationState(MEMORY)
 
-
+# Create dialog and Bot
 DIALOG = MainDialog()
 BOT = RichCardsBot(CONVERSATION_STATE, USER_STATE, DIALOG)
 
 
+# Listen for incoming requests on /api/messages.
 @APP.route("/api/messages", methods=["POST"])
 def messages():
-    """Main bot message handler."""
+    # Main bot message handler.s
     if "application/json" in request.headers["Content-Type"]:
         body = request.json
     else:
@@ -69,12 +87,9 @@ def messages():
         request.headers["Authorization"] if "Authorization" in request.headers else ""
     )
 
-    async def aux_func(turn_context):
-        await BOT.on_turn(turn_context)
-
     try:
         task = LOOP.create_task(
-            ADAPTER.process_activity(activity, auth_header, aux_func)
+            ADAPTER.process_activity(activity, auth_header, BOT.on_turn)
         )
         LOOP.run_until_complete(task)
         return Response(status=201)

samples/06.using-cards/config.py

@@ -13,7 +13,3 @@ class DefaultConfig:
     PORT = 3978
     APP_ID = os.environ.get("MicrosoftAppId", "")
     APP_PASSWORD = os.environ.get("MicrosoftAppPassword", "")
-    LUIS_APP_ID = os.environ.get("LuisAppId", "")
-    LUIS_API_KEY = os.environ.get("LuisAPIKey", "")
-    # LUIS endpoint host name, ie "westus.api.cognitive.microsoft.com"
-    LUIS_API_HOST_NAME = os.environ.get("LuisAPIHostName", "")

samples/06.using-cards/requirements.txt

@@ -1,2 +1,3 @@
 botbuilder-core>=4.4.0b1
-botbuilder-dialogs>=4.4.0b1
+botbuilder-dialogs>=4.4.0b1
+flask>=1.0.3

samples/13.core-bot/adapter_with_error_handler.py

@@ -1,14 +1,15 @@
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License.
 import sys
+from datetime import datetime
+
 from botbuilder.core import (
     BotFrameworkAdapter,
     BotFrameworkAdapterSettings,
     ConversationState,
-    MessageFactory,
     TurnContext,
 )
-from botbuilder.schema import InputHints
+from botbuilder.schema import InputHints, ActivityTypes, Activity
 
 
 class AdapterWithErrorHandler(BotFrameworkAdapter):
@@ -25,14 +26,25 @@ async def on_error(context: TurnContext, error: Exception):
             # This check writes out errors to console log
             # NOTE: In production environment, you should consider logging this to Azure
             #       application insights.
-            print(f"\n [on_turn_error]: {error}", file=sys.stderr)
+            print(f"\n [on_turn_error] unhandled error: {error}", file=sys.stderr)
 
             # Send a message to the user
-            error_message_text = "Sorry, it looks like something went wrong."
-            error_message = MessageFactory.text(
-                error_message_text, error_message_text, InputHints.expecting_input
-            )
-            await context.send_activity(error_message)
+            await context.send_activity("The bot encountered an error or bug.")
+            await context.send_activity("To continue to run this bot, please fix the bot source code.")
+            # Send a trace activity if we're talking to the Bot Framework Emulator
+            if context.activity.channel_id == 'emulator':
+                # Create a trace activity that contains the error object
+                trace_activity = Activity(
+                    label="TurnError",
+                    name="on_turn_error Trace",
+                    timestamp=datetime.utcnow(),
+                    type=ActivityTypes.trace,
+                    value=f"{error}",
+                    value_type="https://www.botframework.com/schemas/error"
+                )
+                # Send a trace activity, which will be displayed in Bot Framework Emulator
+                await context.send_activity(trace_activity)
+
             # Clear out state
             nonlocal self
             await self._conversation_state.delete(context)

samples/13.core-bot/app.py

@@ -25,6 +25,7 @@
 from adapter_with_error_handler import AdapterWithErrorHandler
 from flight_booking_recognizer import FlightBookingRecognizer
 
+# Create the loop and Flask app
 LOOP = asyncio.get_event_loop()
 APP = Flask(__name__, instance_relative_config=True)
 APP.config.from_object("config.DefaultConfig")
@@ -35,17 +36,22 @@
 MEMORY = MemoryStorage()
 USER_STATE = UserState(MEMORY)
 CONVERSATION_STATE = ConversationState(MEMORY)
+
+# Create adapter.
+# See https://aka.ms/about-bot-adapter to learn more about how bots work.
 ADAPTER = AdapterWithErrorHandler(SETTINGS, CONVERSATION_STATE)
+
+# Create dialogs and Bot
 RECOGNIZER = FlightBookingRecognizer(APP.config)
 BOOKING_DIALOG = BookingDialog()
-
 DIALOG = MainDialog(RECOGNIZER, BOOKING_DIALOG)
 BOT = DialogAndWelcomeBot(CONVERSATION_STATE, USER_STATE, DIALOG)
 
 
+# Listen for incoming requests on /api/messages.
 @APP.route("/api/messages", methods=["POST"])
 def messages():
-    """Main bot message handler."""
+    # Main bot message handler.
     if "application/json" in request.headers["Content-Type"]:
         body = request.json
     else:
@@ -56,12 +62,9 @@ def messages():
         request.headers["Authorization"] if "Authorization" in request.headers else ""
     )
 
-    async def aux_func(turn_context):
-        await BOT.on_turn(turn_context)
-
     try:
         task = LOOP.create_task(
-            ADAPTER.process_activity(activity, auth_header, aux_func)
+            ADAPTER.process_activity(activity, auth_header, BOT.on_turn)
         )
         LOOP.run_until_complete(task)
         return Response(status=201)

samples/21.corebot-app-insights/README.md

@@ -1,4 +1,4 @@
-# CoreBot
+# CoreBot with Application Insights
 
 Bot Framework v4 core bot sample.
 
@@ -12,21 +12,29 @@ This bot has been created using [Bot Framework](https://dev.botframework.com), i
 
 ## Prerequisites
 
-This sample **requires** prerequisites in order to run.
+### Install Python 3.6
 
 ### Overview
 
-This bot uses [LUIS](https://www.luis.ai), an AI based cognitive service, to implement language understanding.
-
-### Install Python 3.6
-
+This bot uses [LUIS](https://www.luis.ai), an AI based cognitive service, to implement language understanding 
+and [Application Insights](https://docs.microsoft.com/azure/azure-monitor/app/cloudservices), an extensible Application Performance Management (APM) service for web developers on multiple platforms.
 
 ### Create a LUIS Application to enable language understanding
 
 LUIS language model setup, training, and application configuration steps can be found [here](https://docs.microsoft.com/azure/bot-service/bot-builder-howto-v4-luis?view=azure-bot-service-4.0&tabs=cs).
 
 If you wish to create a LUIS application via the CLI, these steps can be found in the [README-LUIS.md](README-LUIS.md).
 
+### Add Application Insights service to enable the bot monitoring
+Application Insights resource creation steps can be found [here](https://docs.microsoft.com/azure/azure-monitor/app/create-new-resource).
+
+## Running the sample
+- Run `pip install -r requirements.txt` to install all dependencies
+- Update LuisAppId, LuisAPIKey and LuisAPIHostName in `config.py` with the information retrieved from the [LUIS portal](https://www.luis.ai)
+- Update AppInsightsInstrumentationKey in `config.py`
+- Run `python app.py`
+- Alternatively to the last command, you can set the file in an environment variable with `set FLASK_APP=app.py` in windows (`export FLASK_APP=app.py` in mac/linux) and then run `flask run --host=127.0.0.1 --port=3978`
+
 
 ## Testing the bot using Bot Framework Emulator
 
@@ -50,8 +58,8 @@ If you wish to create a LUIS application via the CLI, these steps can be found i
 - [Activity processing](https://docs.microsoft.com/en-us/azure/bot-service/bot-builder-concept-activity-processing?view=azure-bot-service-4.0)
 - [Azure Bot Service Introduction](https://docs.microsoft.com/azure/bot-service/bot-service-overview-introduction?view=azure-bot-service-4.0)
 - [Azure Bot Service Documentation](https://docs.microsoft.com/azure/bot-service/?view=azure-bot-service-4.0)
-- [.NET Core CLI tools](https://docs.microsoft.com/dotnet/core/tools/?tabs=netcore2x)
-- [Azure CLI](https://docs.microsoft.com/cli/azure/?view=azure-cli-latest)
-- [Azure Portal](https://portal.azure.com)
 - [Language Understanding using LUIS](https://docs.microsoft.com/azure/cognitive-services/luis/)
-- [Channels and Bot Connector Service](https://docs.microsoft.com/azure/bot-service/bot-concepts?view=azure-bot-service-4.0)
+- [Channels and Bot Connector Service](https://docs.microsoft.com/azure/bot-service/bot-concepts?view=azure-bot-service-4.0)
+- [Application insights Overview](https://docs.microsoft.com/azure/azure-monitor/app/app-insights-overview)
+- [Getting Started with Application Insights](https://github.com/Microsoft/ApplicationInsights-aspnetcore/wiki/Getting-Started-with-Application-Insights-for-ASP.NET-Core)
+- [Filtering and preprocessing telemetry in the Application Insights SDK](https://docs.microsoft.com/azure/azure-monitor/app/api-filtering-sampling)