forked from microsoft/BotBuilder-Samples
-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add new echo-proxy-bot sample for JS
- Loading branch information
1 parent
b32524d
commit b22bb0a
Showing
31 changed files
with
5,534 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
MicrosoftAppType= | ||
MicrosoftAppId= | ||
MicrosoftAppPassword= | ||
MicrosoftAppTenantId= | ||
|
||
HTTP_PROXY=http://127.0.0.1:8080 | ||
HTTPS_PROXY=http://127.0.0.1:8080 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
/* eslint-disable */ | ||
module.exports = { | ||
"extends": "standard", | ||
"rules": { | ||
"semi": [2, "always"], | ||
"indent": [2, 4], | ||
"no-return-await": 0, | ||
"space-before-function-paren": [2, { | ||
"named": "never", | ||
"anonymous": "never", | ||
"asyncArrow": "always" | ||
}], | ||
"template-curly-spacing": [2, "always"] | ||
} | ||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,103 @@ | ||
# echo-proxy-bot | ||
|
||
Bot Framework v4 echo-proxy bot sample | ||
|
||
This bot has been created using [Bot Framework](https://dev.botframework.com), it shows how to configure the bot to use it behind a corporative proxy. | ||
|
||
## Prerequisites | ||
|
||
- [Node.js](https://nodejs.org) version 16.16.0 or higher | ||
|
||
```bash | ||
# determine node version | ||
node --version | ||
``` | ||
|
||
## To try this sample | ||
|
||
- Clone the repository | ||
|
||
```bash | ||
git clone https://github.com/microsoft/botbuilder-samples.git | ||
``` | ||
|
||
- In a terminal, navigate to `samples/javascript_nodejs/86.echo-proxy-bot` | ||
|
||
```bash | ||
cd samples/javascript_nodejs/86.echo-proxy-bot | ||
``` | ||
|
||
- Install modules | ||
|
||
```bash | ||
npm install | ||
``` | ||
|
||
- Set up the proxy variables | ||
|
||
- Add the `HTTP_PROXY` and `HTTPS_PROXY` values in the **.env** file. For testing you can use the localhost and an available port: | ||
``` | ||
HTTP_PROXY=http://127.0.0.1:8080 | ||
HTTPS_PROXY=http://127.0.0.1:8080 | ||
``` | ||
|
||
This sample provides two options to work behind a proxy: | ||
|
||
**Option #1: Setting up the proxy variables globally for NodeJS**. | ||
|
||
- Make sure the code marked as option #1 is enabled in **index.js**. | ||
It will use the `node-global-proxy` package to configure and start the global proxy with the provided env variables. | ||
|
||
> This option will route all the requests the bot makes through the proxy. | ||
|
||
**Option #2: Setting up the proxy in the Connector Client Options** | ||
- Make sure the code marked as option #2 is enabled in **index.js**. | ||
- Fill in the `proxySettings` of _ConnectorClientOptions_ with the `host` and `port` for your proxy. For testing you can use the localhost and an available port: | ||
```JavaScript | ||
{ proxySettings: { host: '127.0.0.1', port: 8080 } } | ||
``` | ||
- Additionally, you can set the `ProxyUrl` property for the MSAL requests [msal documentation](https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-node/docs/faq.md#why-doesnt-my-app-function-correctly-when-its-running-behind-a-proxy). | ||
> This option will route the authentication requests that botbuilder makes through the proxy. Other requests, like calls to intranet APIs, will go out directly. | ||
You can verify the routed requests with a tool like [straightforward](https://github.com/berstend/straightforward). | ||
- Start the bot | ||
```bash | ||
npm start | ||
``` | ||
## 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. | ||
- Install the latest Bot Framework Emulator from [here](https://github.com/Microsoft/BotFramework-Emulator/releases) | ||
### 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` | ||
## Interacting with the bot | ||
Enter text in the emulator. The text will be echoed back by the bot. | ||
## Deploy the bot to Azure | ||
To learn more about deploying a bot to Azure, see [Deploy your bot to Azure](https://aka.ms/azuredeployment) for a complete list of deployment instructions. | ||
## Further reading | ||
- [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) | ||
- [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) | ||
- [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) | ||
- [Restify](https://www.npmjs.com/package/restify) | ||
- [dotenv](https://www.npmjs.com/package/dotenv) | ||
- [node-global-proxy](https://www.npmjs.com/package/node-global-proxy) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
// Copyright (c) Microsoft Corporation. All rights reserved. | ||
// Licensed under the MIT License. | ||
|
||
const { ActivityHandler, MessageFactory } = require('botbuilder'); | ||
|
||
class EchoProxyBot extends ActivityHandler { | ||
constructor() { | ||
super(); | ||
// See https://aka.ms/about-bot-activity-message to learn more about the message and other activity types. | ||
this.onMessage(async (context, next) => { | ||
const replyText = `Echo: ${ context.activity.text }`; | ||
await context.sendActivity(MessageFactory.text(replyText, replyText)); | ||
// By calling next() you ensure that the next BotHandler is run. | ||
await next(); | ||
}); | ||
|
||
this.onMembersAdded(async (context, next) => { | ||
const membersAdded = context.activity.membersAdded; | ||
const welcomeText = 'Hello and welcome!'; | ||
for (let cnt = 0; cnt < membersAdded.length; ++cnt) { | ||
if (membersAdded[cnt].id !== context.activity.recipient.id) { | ||
await context.sendActivity(MessageFactory.text(welcomeText, welcomeText)); | ||
} | ||
} | ||
// By calling next() you ensure that the next BotHandler is run. | ||
await next(); | ||
}); | ||
} | ||
} | ||
|
||
module.exports.EchoProxyBot = EchoProxyBot; |
2 changes: 2 additions & 0 deletions
2
samples/javascript_nodejs/86.echo-proxy-bot/deploymentScripts/linux/.deployment
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
[config] | ||
command = ./deploy.sh |
100 changes: 100 additions & 0 deletions
100
samples/javascript_nodejs/86.echo-proxy-bot/deploymentScripts/linux/deploy.sh
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,100 @@ | ||
#!/bin/bash | ||
|
||
# ---------------------- | ||
# KUDU Deployment Script | ||
# Version: 1.0.17 | ||
# ---------------------- | ||
|
||
# Helpers | ||
# ------- | ||
|
||
exitWithMessageOnError () { | ||
if [ ! $? -eq 0 ]; then | ||
echo "An error has occurred during web site deployment." | ||
echo $1 | ||
exit 1 | ||
fi | ||
} | ||
|
||
# Prerequisites | ||
# ------------- | ||
|
||
# Verify node.js installed | ||
hash node 2>/dev/null | ||
exitWithMessageOnError "Missing node.js executable, please install node.js, if already installed make sure it can be reached from current environment." | ||
|
||
# Setup | ||
# ----- | ||
|
||
SCRIPT_DIR="${BASH_SOURCE[0]%\\*}" | ||
SCRIPT_DIR="${SCRIPT_DIR%/*}" | ||
ARTIFACTS=$SCRIPT_DIR/../artifacts | ||
KUDU_SYNC_CMD=${KUDU_SYNC_CMD//\"} | ||
|
||
if [[ ! -n "$DEPLOYMENT_SOURCE" ]]; then | ||
DEPLOYMENT_SOURCE=$SCRIPT_DIR | ||
fi | ||
|
||
if [[ ! -n "$NEXT_MANIFEST_PATH" ]]; then | ||
NEXT_MANIFEST_PATH=$ARTIFACTS/manifest | ||
|
||
if [[ ! -n "$PREVIOUS_MANIFEST_PATH" ]]; then | ||
PREVIOUS_MANIFEST_PATH=$NEXT_MANIFEST_PATH | ||
fi | ||
fi | ||
|
||
if [[ ! -n "$DEPLOYMENT_TARGET" ]]; then | ||
DEPLOYMENT_TARGET=$ARTIFACTS/wwwroot | ||
else | ||
KUDU_SERVICE=true | ||
fi | ||
|
||
if [[ ! -n "$KUDU_SYNC_CMD" ]]; then | ||
# Install kudu sync | ||
echo Installing Kudu Sync | ||
npm install kudusync -g --silent | ||
exitWithMessageOnError "npm failed" | ||
|
||
if [[ ! -n "$KUDU_SERVICE" ]]; then | ||
# In case we are running locally this is the correct location of kuduSync | ||
KUDU_SYNC_CMD=kuduSync | ||
else | ||
# In case we are running on kudu service this is the correct location of kuduSync | ||
KUDU_SYNC_CMD=$APPDATA/npm/node_modules/kuduSync/bin/kuduSync | ||
fi | ||
fi | ||
|
||
# Node Helpers | ||
# ------------ | ||
|
||
selectNodeVersion () { | ||
NPM_CMD=npm | ||
NODE_EXE=node | ||
} | ||
|
||
################################################################################################################################## | ||
# Deployment | ||
# ---------- | ||
|
||
echo Handling node.js deployment. | ||
|
||
# 1. KuduSync | ||
if [[ "$IN_PLACE_DEPLOYMENT" -ne "1" ]]; then | ||
"$KUDU_SYNC_CMD" -v 50 -f "$DEPLOYMENT_SOURCE" -t "$DEPLOYMENT_TARGET" -n "$NEXT_MANIFEST_PATH" -p "$PREVIOUS_MANIFEST_PATH" -i ".git;.hg;.deployment;deploy.sh" | ||
exitWithMessageOnError "Kudu Sync failed" | ||
fi | ||
|
||
# 2. Select node version | ||
selectNodeVersion | ||
|
||
# 3. Install npm packages | ||
if [ -e "$DEPLOYMENT_TARGET/package.json" ]; then | ||
cd "$DEPLOYMENT_TARGET" | ||
echo "Running $NPM_CMD install --production" | ||
eval $NPM_CMD install --production | ||
exitWithMessageOnError "npm failed" | ||
cd - > /dev/null | ||
fi | ||
|
||
################################################################################################################################## | ||
echo "Finished successfully." |
2 changes: 2 additions & 0 deletions
2
samples/javascript_nodejs/86.echo-proxy-bot/deploymentScripts/windows/.deployment
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
[config] | ||
command = deploy.cmd |
Oops, something went wrong.