[Samples][Java] Fix disparities of 15.handling-attachments sample (microsoft#3228)

* Changes for sample 15

* Remove unnecessary files

* Fix error / improve message sending

* Move methods around

* Add corrections

* Change header in line

* Fix nit changes in README document

Co-authored-by: matiasroldan6 <[email protected]>

Author: Batta32

samples/java_springboot/15.handling-attachments/README.md

@@ -1,34 +1,37 @@
 # Handling Attachments
 
-Bot Framework v4 handling attachments bot sample
+Bot Framework v4 handling attachments bot sample.
 
 This bot has been created using [Bot Framework](https://dev.botframework.com), it shows how to send outgoing attachments and how to save attachments to disk.
 
 > **NOTE: A specific example for Microsoft Teams, demonstrating how to
 upload files to Teams from a bot and how to receive a file sent to a bot as an attachment, can be found [here](../56.teams-file-upload)**
 
+This sample is a Spring Boot app and uses the Azure CLI and azure-webapp Maven plugin to deploy to Azure.
+
 ## Prerequisites
 
 - Java 1.8+
 - Install [Maven](https://maven.apache.org/)
 - An account on [Azure](https://azure.microsoft.com) if you want to deploy to Azure.
 
-## To try this sample locally
+## To try this sample
 - From the root of this project folder:
   - Build the sample using `mvn package`
   - Run it by using `java -jar .\target\bot-attachments-sample.jar`
 
-- Test the bot using Bot Framework Emulator
+## Testing the bot using Bot Framework Emulator
 
-  [Bot Framework Emulator](https://github.com/microsoft/botframework-emulator) is a desktop application that allows bot developers to test and debug their bots on localhost or running remotely through a tunnel.
+[Bot Framework Emulator](https://github.com/microsoft/botframework-emulator) is a desktop application that allows bot developers to test and debug their bots on localhost or running remotely through a tunnel.
 
-  - Install the Bot Framework Emulator version 4.3.0 or greater from [here](https://github.com/Microsoft/BotFramework-Emulator/releases)
+- Install the latest Bot Framework Emulator from [here](https://github.com/Microsoft/BotFramework-Emulator/releases)
 
-  - Connect to the bot using Bot Framework Emulator
+### Connect to the bot using Bot Framework Emulator
+  - Launch Bot Framework Emulator
+  - File -> Open Bot
+  - Enter a Bot URL of `http://localhost:3978/api/messages`
 
-    - Launch Bot Framework Emulator
-    - File -> Open Bot
-    - Enter a Bot URL of `http://localhost:3978/api/messages`
+With the Bot Framework Emulator connected to your running bot, the sample will show you different types of attachments.
 
 ## Interacting with the bot
 
@@ -42,7 +45,7 @@ As described on [Deploy your bot](https://docs.microsoft.com/en-us/azure/bot-ser
 ### 1. Login to Azure
 From a command (or PowerShell) prompt in the root of the bot folder, execute:  
 `az login`
-  
+
 ### 2. Set the subscription
 `az account set --subscription "<azure-subscription>"`
 
@@ -62,10 +65,14 @@ Record the `appid` from the returned JSON
 Replace the values for `<appid>`, `<appsecret>`, `<botname>`, and `<groupname>` in the following commands:
 
 #### To a new Resource Group
-`az deployment sub create --name "echoBotDeploy" --location "westus" --template-file ".\deploymentTemplates\template-with-new-rg.json" --parameters appId="<appid>" appSecret="<appsecret>" botId="<botname>" botSku=S1 newAppServicePlanName="echoBotPlan" newWebAppName="echoBot" groupLocation="westus" newAppServicePlanLocation="westus"` 
+```
+az deployment sub create --name "attachmentsBotDeploy" --location "westus" --template-file ".\deploymentTemplates\template-with-new-rg.json" --parameters appId="<appid>" appSecret="<appsecret>" botId="<botname>" botSku=S1 newAppServicePlanName="attachmentsBotPlan" newWebAppName="attachmentsBot" groupLocation="westus" newAppServicePlanLocation="westus"
+``` 
 
 #### To an existing Resource Group
-`az deployment group create --resource-group "<groupname>" --template-file ".\deploymentTemplates\template-with-preexisting-rg.json" --parameters appId="<appid>" appSecret="<appsecret>" botId="<botname>" newWebAppName="echoBot" newAppServicePlanName="echoBotPlan" appServicePlanLocation="westus" --name "echoBot"`
+```
+az deployment group create --resource-group "<groupname>" --template-file ".\deploymentTemplates\template-with-preexisting-rg.json" --parameters appId="<appid>" appSecret="<appsecret>" botId="<botname>" newWebAppName="attachmentsBot" newAppServicePlanName="attachmentsBotPlan" appServicePlanLocation="westus" --name "attachmentsBot"
+```
 
 ### 5. Update app id and password
 In src/main/resources/application.properties update 
@@ -74,7 +81,7 @@ In src/main/resources/application.properties update
 
 ### 6. Deploy the code
 - Execute `mvn clean package` 
-- Execute `mvn azure-webapp:deploy -Dgroupname="<groupname>" -Dbotname="<botname>"`
+- Execute `mvn azure-webapp:deploy -Dgroupname="<groupname>" -Dbotname="<bot-app-service-name>"`
 
 If the deployment is successful, you will be able to test it via "Test in Web Chat" from the Azure Portal using the "Bot Channel Registration" for the bot.
 
@@ -83,9 +90,8 @@ After the bot is deployed, you only need to execute #6 if you make changes to th
 
 ## Further reading
 
-- [Maven Plugin for Azure App Service](https://docs.microsoft.com/en-us/java/api/overview/azure/maven/azure-webapp-maven-plugin/readme?view=azure-java-stable)
+- [Maven Plugin for Azure App Service](https://github.com/microsoft/azure-maven-plugins/tree/develop/azure-webapp-maven-plugin)
 - [Spring Boot](https://spring.io/projects/spring-boot)
-- [Azure for Java cloud developers](https://docs.microsoft.com/en-us/azure/java/?view=azure-java-stable)
 - [Bot Framework Documentation](https://docs.botframework.com)
 - [Bot Basics](https://docs.microsoft.com/azure/bot-service/bot-builder-basics?view=azure-bot-service-4.0)
 - [Attachments](https://docs.microsoft.com/en-us/azure/bot-service/nodejs/bot-builder-nodejs-send-receive-attachments?view=azure-bot-service-4.0)
@@ -94,4 +100,5 @@ After the bot is deployed, you only need to execute #6 if you make changes to th
 - [Azure Bot Service Documentation](https://docs.microsoft.com/azure/bot-service/?view=azure-bot-service-4.0)
 - [Azure CLI](https://docs.microsoft.com/cli/azure/?view=azure-cli-latest)
 - [Azure Portal](https://portal.azure.com)
-- [Channels and Bot Connector Service](https://docs.microsoft.com/en-us/azure/bot-service/bot-concepts?view=azure-bot-service-4.0)
+- [Azure for Java cloud developers](https://docs.microsoft.com/en-us/azure/java/?view=azure-java-stable)
+- [Channels and Bot Connector Service](https://docs.microsoft.com/en-us/azure/bot-service/bot-concepts?view=azure-bot-service-4.0)

samples/java_springboot/15.handling-attachments/src/main/java/com/microsoft/bot/sample/attachments/AttachmentsBot.java

@@ -32,6 +32,13 @@
 
 /**
  * This class implements the functionality of the Bot.
+ * 
+ * Represents a bot that processes incoming activities.
+ * For each user interaction, an instance of this class is created and the onTurn method is called.
+ * This is a Transient lifetime service. Transient lifetime services are created
+ * each time they're requested. For each Activity received, a new instance of this
+ * class is created. Objects that are expensive to construct, or have a lifetime
+ * beyond the single turn, should be carefully managed.
  *
  * <p>
  * This is where application specific logic for interacting with the users would be added. For this
@@ -41,20 +48,39 @@
  */
 public class AttachmentsBot extends ActivityHandler {
 
-    @Override
-    protected CompletableFuture<Void> onMessageActivity(TurnContext turnContext) {
-        return processInput(turnContext)
-            .thenCompose(turnContext::sendActivity)
-            .thenCompose(resourceResponse -> displayOptions(turnContext));
-    }
-
     @Override
     protected CompletableFuture<Void> onMembersAdded(
         List<ChannelAccount> membersAdded,
         TurnContext turnContext
     ) {
         return sendWelcomeMessage(turnContext);
     }
+    
+    @Override
+    protected CompletableFuture<Void> onMessageActivity(TurnContext turnContext) {
+        return processInput(turnContext)
+            // Respond to the user.
+            .thenCompose(reply -> turnContext.sendActivities(MessageFactory.text("HI"), reply))
+            .thenCompose(resourceResponse -> displayOptions(turnContext));     
+    }    
+ 
+    private static CompletableFuture<Void> displayOptions(TurnContext turnContext) {
+        // Create a HeroCard with options for the user to interact with the bot.
+        HeroCard card = new HeroCard();
+        card.setText("You can upload an image or select one of the following choices");
+
+        // Note that some channels require different values to be used in order to get buttons to display text.
+        // In this code the emulator is accounted for with the 'title' parameter, but in other channels you may
+        // need to provide a value for other parameters like 'text' or 'displayText'.
+        card.setButtons(
+            new CardAction(ActionTypes.IM_BACK, "1. Inline Attachment", "1"),
+            new CardAction(ActionTypes.IM_BACK, "2. Internet Attachment", "2"),
+            new CardAction(ActionTypes.IM_BACK, "3. Uploaded Attachment", "3")
+        );
+
+        Activity reply = MessageFactory.attachment(card.toAttachment());
+        return turnContext.sendActivity(reply).thenApply(resourceResponse -> null);
+    }    
 
     // Greet the user and give them instructions on how to interact with the bot.
     private CompletableFuture<Void> sendWelcomeMessage(TurnContext turnContext) {
@@ -74,23 +100,6 @@ private CompletableFuture<Void> sendWelcomeMessage(TurnContext turnContext) {
             .collect(CompletableFutures.toFutureList()).thenApply(resourceResponses -> null);
     }
 
-    private CompletableFuture<Void> displayOptions(TurnContext turnContext) {
-        // Create a HeroCard with options for the user to interact with the bot.
-        HeroCard card = new HeroCard();
-        card.setText("You can upload an image or select one of the following choices");
-
-        // Note that some channels require different values to be used in order to get buttons to display text.
-        // In this code the emulator is accounted for with the 'title' parameter, but in other channels you may
-        // need to provide a value for other parameters like 'text' or 'displayText'.
-        card.setButtons(
-            new CardAction(ActionTypes.IM_BACK, "1. Inline Attachment", "1"),
-            new CardAction(ActionTypes.IM_BACK, "2. Internet Attachment", "2"),
-            new CardAction(ActionTypes.IM_BACK, "3. Uploaded Attachment", "3")
-        );
-
-        Activity reply = MessageFactory.attachment(card.toAttachment());
-        return turnContext.sendActivity(reply).thenApply(resourceResponse -> null);
-    }
 
     // Given the input from the message, create the response.
     private CompletableFuture<Activity> processInput(TurnContext turnContext) {
@@ -105,9 +114,10 @@ private CompletableFuture<Activity> processInput(TurnContext turnContext) {
         return handleOutgoingAttachment(turnContext, activity);
     }
 
+    // Returns a reply with the requested Attachment
     private CompletableFuture<Activity> handleOutgoingAttachment(TurnContext turnContext, Activity activity) {
+        // Look at the user input, and figure out what kind of attachment to send.
         CompletableFuture<Activity> result;
-
         if (activity.getText().startsWith("1")) {
             result = getInlineAttachment()
                 .thenApply(attachment -> {
@@ -116,12 +126,9 @@ private CompletableFuture<Activity> handleOutgoingAttachment(TurnContext turnCon
                     return reply;
                 });
         } else if (activity.getText().startsWith("2")) {
-            result = getInternetAttachment()
-                .thenApply(attachment -> {
-                    Activity reply = MessageFactory.text("This is an attachment from a HTTP URL.");
-                    reply.setAttachment(attachment);
-                    return reply;
-                });
+            Activity reply = MessageFactory.text("This is an attachment from a HTTP URL.");
+            reply.setAttachment(getInternetAttachment());
+            result = CompletableFuture.completedFuture(reply);
         } else if (activity.getText().startsWith("3")) {
             // Get the uploaded attachment.
             result = getUploadedAttachment(
@@ -132,6 +139,7 @@ private CompletableFuture<Activity> handleOutgoingAttachment(TurnContext turnCon
                     return reply;
                 });
         } else {
+            // The user did not enter input that this bot was built to handle.
             result = CompletableFuture.completedFuture(
                 MessageFactory.text("Your input was not recognized please try again.")
             );
@@ -197,15 +205,7 @@ private CompletableFuture<Attachment> getInlineAttachment() {
             });
     }
 
-    // Creates an Attachment to be sent from the bot to the user from a HTTP URL.
-    private CompletableFuture<Attachment> getInternetAttachment() {
-        Attachment attachment = new Attachment();
-        attachment.setName("architecture-resize.png");
-        attachment.setContentType("image/png");
-        attachment.setContentUrl("https://docs.microsoft.com/en-us/bot-framework/media/how-it-works/architecture-resize.png");
-        return CompletableFuture.completedFuture(attachment);
-    }
-
+    // Creates an "Attachment" to be sent from the bot to the user from an uploaded file.
     private CompletableFuture<Attachment> getUploadedAttachment(TurnContext turnContext, String serviceUrl, String conversationId) {
         if (StringUtils.isEmpty(serviceUrl)) {
             return Async.completeExceptionally(new IllegalArgumentException("serviceUrl"));
@@ -238,6 +238,16 @@ private CompletableFuture<Attachment> getUploadedAttachment(TurnContext turnCont
                     });
             });
     }
+        
+    // Creates an Attachment to be sent from the bot to the user from a HTTP URL.
+    private static Attachment getInternetAttachment() {
+        // ContentUrl must be HTTPS.
+        Attachment attachment = new Attachment();
+        attachment.setName("architecture-resize.png");
+        attachment.setContentType("image/png");
+        attachment.setContentUrl("https://docs.microsoft.com/en-us/bot-framework/media/how-it-works/architecture-resize.png");
+        return attachment;
+    }
 
     private CompletableFuture<String> getEncodedFileData(String filename) {
         return getFileData(filename)

samples/java_springboot/15.handling-attachments/src/main/java/com/microsoft/bot/sample/attachments/package-info.java

@@ -0,0 +1,8 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License. See License.txt in the project root for
+// license information.
+
+/**
+ * This package contains the classes for the handling attachments sample.
+ */
+package com.microsoft.bot.sample.attachments;

samples/java_springboot/15.handling-attachments/src/main/webapp/index.html

@@ -4,7 +4,7 @@
 <head>
     <meta charset="utf-8">
     <meta name="viewport" content="width=device-width, initial-scale=1">
-    <title>EchoBot</title>
+    <title>Handling Attachments Sample</title>
     <style>
         body {
             margin: 0px;