feat: Custom Action Sample #2950

luhan2017 · 2020-05-08T09:55:10Z

Description

In this PR, I added a CustomAction solution in the C# runtime folder which includes the custom code and schema.

Here are the steps to enable CustomAction:

Create a echo bot.
Enable ejected runtime, the runtime will be placed in the bot folder.
In the bot/runtime folder add a project reference in azurewebapp/Microsoft.BotFramework.Composer.WebApp.csproj,

<ProjectReference Include="..\customaction\Microsoft.BotFramework.Composer.CustomAction.csproj" />

Then remove line 28, uncomment line 29 and 139 in azurewebapp/Startup.cs file

using Microsoft.BotFramework.Composer.CustomAction;
// This is for custom action component registration.
ComponentRegistration.Add(new CustomActionComponentRegistration());

Run dotnet build to verifty if it passes build.

EchoBot-9\runtime\azurewebapp>dotnet build

Go to azurewebapp/schemas folder, run update.cmd, the sdk.schema will be updated.

EchoBot-9\runtime\azurewebapp\schemas>update.cmd

Copy the sdk.schema to the bot/schemas
Go back to composer, reopen the bot and you can add a custom action.

Task Item

Create your bot based on custom actions and try out in emulator.

fixes #2824
fixes #2896

Screenshots

github-actions · 2020-05-08T20:39:52Z

Coverage remained the same at 0.0% when pulling a41c84d on luhan/customActionSample into fb2b7f0 on master.

boydc2014 · 2020-05-09T02:45:09Z

Composer/plugins/samples/assets/projects/CustomAction/customaction.dialog

@@ -0,0 +1,100 @@
+{


I thought since we modified the built-in CSharp template (code + schema), we don't actually need this sample, every sample can be used as customized action sample.

see #2824 (comment)

boydc2014 · 2020-05-09T02:47:52Z

Composer/plugins/samples/assets/projects/CustomAction/schemas/sdk.schema

@@ -0,0 +1,8901 @@
+{


this should be an update to the default sdk.schema, instead of creating a new one.

boydc2014 · 2020-05-09T02:48:42Z

Composer/plugins/samples/assets/projects/CustomAction/schemas/MultiplyDialog.schema

@@ -0,0 +1,25 @@
+{


This is unnecessary, and doing the schema here and doing the code in another place actually make the CSharp Bot template not "self-contained".

boydc2014

See above.

I expect the changes to be

Only happened inside BotProject/CSharp/Template
add a new MultiplyDialog.schema + MultiplyDialog.cs (self-contained change)
update the sdk.schema to include this MultiplyDialog.schema (using dialog:merge)

and that's it, if user run ejection, it would just work, make sense?

luhan2017 · 2020-05-09T03:23:41Z

If we want to keep the custom schema "custom", we need keep two versions of schema in composer:

composer/packages/server/schemas/sdk.schema, this is our default schema and should not include custom schema.
runtime/azurewebapp/schemas/sdk.schema. this is default+custom schema.

which means, every time we update the sdk package+schema, we need to keep in mind to do twice of the schema merge for the above two, which doesn't look good for me.

So my hacky way is to put custom schema in the sample folder and when ejection you can customize you sdk.schema by rerun the dialog:merge.

I think both way are not perfect, how about we just explain how to use it in documents. I am not sure providing a single click experience on custom schema is a good direction which will make user confused. ("I don't need to do anything to enable custom schema"?)

@srinaath is working on a readme to explain how to enable this. we can decide whether that is enough for user. if adding this sample just introduces more confusion, let's close this.

@cwhitten @benbrown thoughts?

hibrenda · 2020-05-09T11:50:21Z

I prefer to let user know how to merge the sdk.schema instead of just give them the customized sdk.schema as if user really use this feature later, he need to know how to do the schema merge.
So until we have the UX trade off to implement this step later, we just provide the readme file(manual step) to user.

For custom schema, there are 2 steps.

custom runtime (self-contained now)

The customized runtime can be set up through the ejection
User can learn from this sample for how to write a customized code and also how to register the customized code into startup.cs . User can easily extend it based on this sample code.

customized schema (manual for R9)

The customized schema (sample) is located in the sample folder
User need to follow readme to install bf-dialog tool and manually execute "bf dialog:merge" to get the updated sdk.schema file.

Just like we did the manual step for azure provision, if user don't follow the step, they can not make it.

srinaath · 2020-05-11T17:50:08Z

@luhan2017 I used this PR to actually build my README file for adding custom actions. I think there is a lot of value in including this sample and I'm mentioning about this sample in the README too. Granted the PR does a little magic of showing the merged schema directly. But the README coupled with this sample should give a user a good idea to add custom actions.

@hibrenda I will be making a PR today to close #2896 that includes the steps you have mentioned above. We can update that PR if the README is still confusing for someone starting up with Composer

srinaath · 2020-05-11T17:56:22Z

runtime/dotnet/azurewebapp/Startup.cs

@@ -168,6 +169,9 @@ public void ConfigureServices(IServiceCollection services)
            var resourceExplorer = new ResourceExplorer().AddFolder(botDir);
            var rootDialog = GetRootDialog(botDir);

+            // register customized types, please note this is only needed for customized actions. 
+            resourceExplorer.RegisterType<MultiplyDialog>("MultiplyDialog");


@luhan2017 so currently the default runtime that is ejected out is going to include this registration for all samples correct? Do you think if we could include this registration only if they eject out CustomActions sample?

yes we should include it for everyone so they have a clear example of how it works.

carlosscastro · 2020-05-11T18:56:26Z

@luhan2017 @benbrown should this be added to the functions runtime as well? If yes, we could place the dialog in the core project (/runtime/core) and then jsut reference it from the web app startup.cs and from the functions startup.cs.

benbrown · 2020-05-11T19:31:45Z

IMO - yes!

luhan2017 · 2020-05-12T10:54:17Z

To who evolved in the PR, @benbrown @benbrown @hibrenda @cwhitten @srinaath

I have removed an action sample and added a custom action project in the runtime folder. which user need to refer to it explicitly to enable it. See the details at the beginning.

@carlosscastro , if user want to enable it for azure function, he/she will need to add a project reference for azure function and add CustomActionComponentRegistration in Azurefunction/startup.cs. which I didn't explicitly add right now.

srinaath · 2020-05-12T16:43:32Z

Awesome @luhan2017 .. Adding my README commits to this PR too. Once added I think we can request a rereview and merge it

Signed-off-by: Srinaath Ravichandran <srravich@microsoft.com> Readme updated Signed-off-by: Srinaath Ravichandran <srravich@microsoft.com>

Signed-off-by: Srinaath Ravichandran <srravich@microsoft.com>

srinaath · 2020-05-12T20:37:28Z

README updated and update.sh script to run bfdialog tool on Mac/Win added. PR ready for rereview

Signed-off-by: Srinaath Ravichandran <srravich@microsoft.com>

boydc2014

Now looks good to me

* Custom Action Sample * Update resultProperty type * fix the displayed title of customized action (microsoft#2951) * Update the Custom Action to a seperated solution * update * azure readme Signed-off-by: Srinaath Ravichandran <srravich@microsoft.com> Readme updated Signed-off-by: Srinaath Ravichandran <srravich@microsoft.com> * Appednignmultiplydialog.schema Signed-off-by: Srinaath Ravichandran <srravich@microsoft.com> * Removed whitespace Signed-off-by: Srinaath Ravichandran <srravich@microsoft.com> * Fixed typo Signed-off-by: Srinaath Ravichandran <srravich@microsoft.com> * More readme updates Signed-off-by: Srinaath Ravichandran <srravich@microsoft.com> Co-authored-by: zeye <2295905420@qq.com> Co-authored-by: Srinaath Ravichandran <srravich@microsoft.com> Co-authored-by: Srinaath Ravichandran <srinaath27@gmail.com> Co-authored-by: Andy Brown <asbrown002@gmail.com>

luhan2017 requested review from a-b-r-o-w-n, benbrown, beyackle, boydc2014, carlosscastro, corinagum, cwhitten, srinaath and tonyanziano as code owners May 8, 2020 09:55

luhan2017 changed the title ~~Custom Action Sample~~ feat: Custom Action Sample May 8, 2020

a-b-r-o-w-n changed the base branch from luhan/rc1 to master May 8, 2020 20:28

luhan2017 and others added 3 commits May 8, 2020 13:30

Custom Action Sample

9521d71

Update resultProperty type

a35a11e

fix the displayed title of customized action (#2951)

a41c84d

a-b-r-o-w-n force-pushed the luhan/customActionSample branch from 48341cf to a41c84d Compare May 8, 2020 20:30

Merge branch 'master' into luhan/customActionSample

395e8eb

boydc2014 reviewed May 9, 2020

View reviewed changes

boydc2014 requested changes May 9, 2020

View reviewed changes

boydc2014 self-assigned this May 11, 2020

srinaath reviewed May 11, 2020

View reviewed changes

luhan2017 added 2 commits May 12, 2020 13:27

Merge branch 'master' into luhan/customActionSample

b6184a0

Update the Custom Action to a seperated solution

e60facf

update

c603768

Srinaath Ravichandran added 4 commits May 12, 2020 12:26

azure readme

e7e1662

Signed-off-by: Srinaath Ravichandran <srravich@microsoft.com> Readme updated Signed-off-by: Srinaath Ravichandran <srravich@microsoft.com>

Appednignmultiplydialog.schema

6b2da4b

Signed-off-by: Srinaath Ravichandran <srravich@microsoft.com>

Removed whitespace

4406534

Signed-off-by: Srinaath Ravichandran <srravich@microsoft.com>

Fixed typo

cd4b063

Signed-off-by: Srinaath Ravichandran <srravich@microsoft.com>

srinaath and others added 2 commits May 12, 2020 13:37

Merge branch 'master' into luhan/customActionSample

af599f0

More readme updates

387184a

Signed-off-by: Srinaath Ravichandran <srravich@microsoft.com>

srinaath requested review from srinaath and boydc2014 May 12, 2020 20:44

boydc2014 previously approved these changes May 13, 2020

View reviewed changes

srinaath previously approved these changes May 13, 2020

View reviewed changes

Merge branch 'master' into luhan/customActionSample

1aa2b98

a-b-r-o-w-n dismissed stale reviews from srinaath and boydc2014 via 1aa2b98 May 13, 2020 18:38

a-b-r-o-w-n merged commit 76cc7c3 into master May 13, 2020

a-b-r-o-w-n deleted the luhan/customActionSample branch May 13, 2020 19:18

a-b-r-o-w-n mentioned this pull request May 15, 2020

release: prepare release notes #3096

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Custom Action Sample #2950

feat: Custom Action Sample #2950

luhan2017 commented May 8, 2020 •

edited by srinaath

Loading

github-actions bot commented May 8, 2020

boydc2014 May 9, 2020

boydc2014 May 9, 2020

boydc2014 May 9, 2020

boydc2014 May 9, 2020

boydc2014 left a comment

luhan2017 commented May 9, 2020

hibrenda commented May 9, 2020

srinaath commented May 11, 2020 •

edited

Loading

srinaath May 11, 2020

benbrown May 11, 2020

carlosscastro commented May 11, 2020

benbrown commented May 11, 2020

luhan2017 commented May 12, 2020

srinaath commented May 12, 2020

srinaath commented May 12, 2020

boydc2014 left a comment

feat: Custom Action Sample #2950

feat: Custom Action Sample #2950

Conversation

luhan2017 commented May 8, 2020 • edited by srinaath Loading

Description

Task Item

Screenshots

github-actions bot commented May 8, 2020

boydc2014 May 9, 2020

Choose a reason for hiding this comment

boydc2014 May 9, 2020

Choose a reason for hiding this comment

boydc2014 May 9, 2020

Choose a reason for hiding this comment

boydc2014 May 9, 2020

Choose a reason for hiding this comment

boydc2014 left a comment

Choose a reason for hiding this comment

luhan2017 commented May 9, 2020

hibrenda commented May 9, 2020

srinaath commented May 11, 2020 • edited Loading

srinaath May 11, 2020

Choose a reason for hiding this comment

benbrown May 11, 2020

Choose a reason for hiding this comment

carlosscastro commented May 11, 2020

benbrown commented May 11, 2020

luhan2017 commented May 12, 2020

srinaath commented May 12, 2020

srinaath commented May 12, 2020

boydc2014 left a comment

Choose a reason for hiding this comment

luhan2017 commented May 8, 2020 •

edited by srinaath

Loading

srinaath commented May 11, 2020 •

edited

Loading