nbransby/dialogue-builder-example

Example of using https://github.com/nbransby/dialogue-builder

dialogue-builder-example

A working example of a bot utilising dialogue-builder including persistence of dialogue state.

This example is written in TypeScript and consists of two files bot.ts and onboarding.ts, (bot.js and onboarding.js contain the transpiled TypeScript - not a pretty sight).

There is also bot.esnext.js and onboarding.esnext.js which is my attempt to implement the example without TypeScript but still using all the advanced JS syntax such as async/await and object destructuring. Although I haven't tried it myself, by using babel it should be possible to compile this down to es5 which is necessary to run on AWS Lambda.

Dialogue Builder depends on bot-builder by claudia.js who's command line tool supports deploying to AWS Lambda. But in this example we use the Serverless Framework for deployment as it also supports automated provisioning of DynamoDB instances which is used in this example to store the dialog state.

To deploy this example so you can test it in Facebook Messenger you will need to do the following:

• #####Create a Facebook App

Create a new Facebook App or use an existing one. In the serverless.yml file, replace REPLACE_WITH_APP_SECRET with your Facebook App Secret

• #####Create a Facebook Page

Create a new Page or use an existing one, then go to the App Dashboard and under Product Settings click "Add Product" and select "Messenger."

In the Token Generation section, select your Page. A Page Access Token will be generated for you.

In the serverless.yml file, replaceREPLACE_WITH_PAGE_ACCESS_TOKEN with your Page Access Token

• #####Install serverless and setup your AWS account credentials on your machine

https://serverless.com/framework/docs/providers/aws/guide/installation/

Make sure to also follow these instructions on setting up AWS credentials

• #####Run the following in the root of this directory and, once complete, copy the URL returned

    npm install
    serverless deploy
  

• #####Setup the Webhook on Facebook with the URL as the Callback URL and SOMETHING_RANDOM as the verify token

In the Webhooks section, click "Setup Webhooks."

Enter a URL for a webhook, enter a Verify Token and select messages and messaging_postbacks under Subscription Fields.

• #####Subscribe the App to the Page on Facebook

In the Webhooks section, you can subscribe the webhook for a specific page.

• #####Try your new bot

Go to your Facebook Page and send a message to it. The bot should respond!

dialogue-builder-example's Issues

add line on cloudFormation permission requirement on README

lambdaContext does not exist on type 'Request'

> tsc && serverless deploy function -f pointless-bot -l


10         apiRequest.lambdaContext.callbackWaitsForEmptyEventLoop = true;
                      ~~~~~~~~~~~~~

bot.ts(10,20): error TS2339: Property 'lambdaContext' does not exist on type 'Request'.

function name choice

I'm curious about the function name choice, right now it's webhook.... is there a convention as to this? and what's its relations to the service name which is defined up front.

bot crash at start with typeError

TypeError: this.state.filter is not a function at TypeError: this.state.filter is not a function
    at State.stateChanged (/var/task/node_modules/dialogue-builder/dialogue-builder.js:304:32)
    at new State (/var/task/node_modules/dialogue-builder/dialogue-builder.js:301:31)
    at new Dialogue (/var/task/node_modules/dialogue-builder/dialogue-builder.js:170:22)
    at module.exports.builder.platforms (/var/task/bot.js:44:24)
    at /var/task/node_modules/claudia-bot-builder/lib/bot-builder.js:29:55