Adaptive Card Transformer Sample Bot

Overview

This is DocBot, a sample Teams bot implementation that simulates scheduling a Doctor's appointment.

This project represents a scenario where a backend API handles all of the dialog flow logic. All user responses are forwarded to the API and all of the API's responses are transformed/adapted to be displayed to the user as Adaptive Cards. To achieve this, the bot leverages the adaptive-card-transformer. This repository contains a sample Microsoft Teams bot, backend API, and set of plugins to use with adaptive-card-transformer.

To kickstart a project using the adaptive-card-transformer like the DocBot, leverage the Yeoman generator-AdaptiveCardTransformer and refer to the How To Integrate documentation.

Related Projects

There are three related repositories for the adaptive-card-transformer:

• AdaptiveCardTransformer - an easy-to-use adapter which enables back-end NLU responses to be rendered through Adaptive Card functionality with an extendable plugin pattern.
• AdaptiveCardTransformerExampleBot (this repository) - The Teams bot example implementation that uses the adaptive-card-transformer.
• generator-AdaptiveCardTransformer - The Yeoman generator for scaffolding plugins using the adaptive-card-transformer.

Development

Development Container

1. Install the Remote-Containers VSCode extension
2. Open the solution using the devcontainer, the ci tools and solution dependencies will be installed on the devcontainer build
3. If the devcontainer is slow, take a look at some of the suggestions here eg: switching to delegated mount consistency in macOS really helps. The node_modules are mounted in a volume to speed up the overall build of the container.
4. When making a commit the pre-commit hook will run detect-secrets.sh. If you want to run the pre-commit hook manually run pre-commit run --all-files

Setup Development Bot

1. Clone the repository

2. (optional) Open the repository in the dev container using VSCode. If you choose run the bot using the Emulator (Option 2), do not run the bot in the dev container.

3. adaptive-card-transformer is currently available as a public GitHub package. Before installing, you will need to explicitly reference the GitHub package registry and fill in the auth token with your own GitHub Personal Access Token (PAT):

   • To create a GitHub PAT token, follow this guide

   • To use the adaptive-card-transformer package, you will only need to set the read:packages scope for the token

   • Run cp .npmrc.example .npmrc in your project's root directory

   • Replace TOKEN in the newly created .npmrc with your own created token:

     //npm.pkg.github.com/:_authToken=TOKEN
     @retaildevcrews:registry=https://npm.pkg.github.com

4. Run your bot with ngrok (recommended) or run your bot locally the Bot Framework Emulator. Please refer to instructions below for either option.

Option 1: Run your bot with ngrok (Recommended)

1. Register your bot on Azure Bot (Azure Portal)

   • Create Bot name
   • Select Resource Group
   • Use Standard pricing tier
   • Select default "Create new Microsoft App ID"
   • Settings > Configuration > Messaging endpoint
     • https://<ngrok_tunnel_hostname>/api/messages
     • Example: https://pinkalpaca-chatbot.ngrok.io/api/messages

2. Run cp .env.example .env and fill in more information in '.env' file:

   • Microsoft App ID can be found in Settings > Configuration
   • Next to Microsoft App ID > Manage > New client secret > copy value for MicrosoftAppPassword

3. Run cp ngrok.example.yml ngrok.yml and fill in the ngrok authtoken and hostname

   • The ngrok account owner that setup the domain should have this information

4. Go to the src directory

   cd src/

5. Install modules

   npm install

6. Start the bot and the api (within the dev container)

   npm start

7. In a separate terminal (still within the dev container), start the ngrok tunnel

   ngrok start --all -config=ngrok.yml

8. Enable Teams Bot Channel

   • Azure Bot (previous step) > Settings > Channels > Microsoft Teams > Save > Terms of Service
     • Keep default "Microsoft Teams Commercial (most common) selected
   • Azure Bot > Settings > Channels > Microsoft Teams

9. Ready to test through Microsoft Teams! Remember to have ngrok and the bot server running when testing.

Option 2: Run your bot locally with the Bot Framework Emulator

To run your bot locally with the Bot Framework Emulator, type the following in your console (outside of the dev container):

1. Run cp .env.example .env and leave the values for Microsoft App ID and MicrosoftAppPassword blank.

2. Go to the src directory

   cd src/

3. Install modules

   npm install

4. Start the bot and the api (outside of the dev container)

   npm start

5. Launch Bot Framework Emulator

   • File -> Open Bot
   • Enter a Bot URL of http://localhost:3978/api/messages
   • Once the Emulator is connected, you can interact with and receive messages from your bot.

Testing

The bot leverages ts-jest on top of Jest for unit testing. This provides all the benefits of Jest (simplicity, rich functionality, built-in code coverage metrics) along with the complete TypeScript support of ts-jest (type-checking).

To run unit tests:

npm test # run all unit tests

npm test -- SomeTestFile # run unit tests in SomeTestFile

npm run test-coverage # run all unit tests with code coverage report

Enhance CI Pipeline

Run Woke with Custom Rulesets from Azure Bob Storage

Woke is a linting tool used to detect non-inclusive language in your source code and recommends alternative terms to use. A "ruleset" (a yaml file) defines the terms that woke will lint for. This repository currently runs woke with woke's default ruleset, which lints for non-inclusive terms.

In addition to the default ruleset, you can also define and apply custom rulesets to Woke. For example, you can use a custom ruleset to enforce branding terms. Custom rulesets can be stored in an Azure Storage Container. To access a custom ruleset locally from Azure Blob Storage, you will need to generate a SAS token on the ruleset file and set the token value in the '.env' file.

To use a custom ruleset from Azure Blob Storage and run Woke:

1. Add AZURE_STORAGE_SAS_TOKEN to .env file

2. Fill in the value for AZURE_STORAGE_SAS_TOKEN in '.env' with your generated sas token.

3. Add this line to ./scripts/run-ci.sh to pull custom ruleset from Azure Blob Storge: az storage blob download --account-name wokeruleset --container-name custom-ruleset --name ruleset.yaml --file customRuleSet.yaml --sas-token "$AZURE_STORAGE_SAS_TOKEN"

4. Add this line ./scripts/run-ci.sh to run woke with custom ruleset: woke -c customRuleSet.yaml --exit-1-on-failure

How to file issues and get help

This project uses GitHub Issues to track bugs and feature requests. Please search the existing issues before filing new issues to avoid duplicates. For new issues, file your bug or feature request as a new issue. For help and questions about using this project, please open a GitHub issue.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA. This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.