feat: lg naming migration #2597

zhixzhan · 2020-04-10T04:24:19Z

Description

LG team recently changed the naming policy. microsoft/botbuilder-dotnet#3712

Remove dash in identifier (template name)

It's an incompatible change, and previous LG file must change their template name, probably use _ instead.

e.g, replace dash - to underline _

bfdactivity-76HgfJ 
-> 
bfdactivity_76HgfJ

Likely there are 3 part work.

update all sample bot.
update generate LG template pattern.
migrate user's bot

For 3, one migration solution is before we switch to new lg parser (which would failed to parse), do replacement at current lg parser ( which both support dash - & underline _ ).

Renaming check list

LG

bfdactivity-1234 -> SendActivity_1234
bfdprompt-1234 -> TextInput_Prompt_1234
bfdinvalidPrompt-1234 -> TextInput_InvalidPrompt_1234
bfdunrecognizedPrompt-1234 -> TextInput_UnrecognizedPrompt_1234
bfddefaultValueResponse-1234 -> TextInput_DefaultValueResponse_1234

LU

TextInput.response-RuZhXe -> TextInput_Response_RuZhXe

In this PR, we've also updated the sdk packages and schems which includes some features and bug fixes:

Enable composer to create a skill.
LanguagePolicy fix.
Schema update, Microsoft.Recognizer renamed to Microsoft.IRecognizer, which have some coresponding SDKKinds fixes.
Some other SDK fix like, foreach, RepeatOption, some lg expression fixes, oauth fix....

fixes #2499, #2624

Task Item

refs #2596
refs #778

Screenshots

After load a old bot, replace results:
*.dialog:

*.lg:

adaptiveCard.json

Won't auto-replace case:

reference is user customize defined lg template name,

- ${my-template()}

technically can not distinguish it is an expression or a template reference.

github-actions · 2020-04-10T04:33:07Z

Coverage remained the same at 41.186% when pulling d2590dc on lg-naming-migration into 9f2c161 on master.

…rk-Composer into lg-naming-migration

cwhitten · 2020-04-12T15:18:08Z

hey @zhixzhan. thanks for taking this one. I'd like to take the opportunity to change the LG template naming scheme to be more inline with where we want to go. instead of bfdactivity_${id} let's write SendActivity_${id}. Can you include this change here?

Additionally, let's make sure to also update the following:

Inline LG naming conventions in the prompts
# bfdprompt-RuZhXe() -> ${inputType}_Prompt_${id}

Inline LU naming conventions in the prompts
# TextInput.response-RuZhXe -> ${inputType}_Response_${id}

cc @tdurnford do you have any comments here?

zhixzhan · 2020-04-13T02:04:26Z

hey @zhixzhan. thanks for taking this one. I'd like to take the opportunity to change the LG template naming scheme to be more inline with where we want to go. instead of bfdactivity_${id} let's write SendActivity_${id}. Can you include this change here?

Additionally, let's make sure to also update the following:

Inline LG naming conventions in the prompts
# bfdprompt-RuZhXe() -> ${inputType}_Prompt_${id}

Inline LU naming conventions in the prompts
# TextInput.response-RuZhXe -> ${inputType}_Response_${id}

cc @tdurnford do you have any comments here?

@cwhitten Okay, will update it.

# TextInput.response-RuZhXe -> ${inputType}_Response_${id}

Composer/packages/ui-plugins/lg/src/LgField.tsx

tdurnford · 2020-04-13T16:30:13Z

@zhixzhan @cwhitten I think it's a good idea to standardize the naming conventions for lg and lu in the prompts, and ${inputType}_Prompt_${id} and ${inputType}_Response_${id} respectively makes sense to me.

cwhitten · 2020-04-14T01:44:32Z

@zhixzhan I like your plan to migrate between LG parsers. Will you include that in this change?

zhixzhan · 2020-04-14T02:04:20Z

@zhixzhan I like your plan to migrate between LG parsers. Will you include that in this change?

@cwhitten you mean update the latest lgParser include this? I know the js version is on the way, probably ready at middle of this week. if so, yes we will include this.

cwhitten · 2020-04-14T02:21:25Z

@zhixzhan I like your plan to migrate between LG parsers. Will you include that in this change?

@cwhitten you mean update the latest lgParser include this? I know the js version is on the way, probably ready at middle of this week. if so, yes we will include this.

No I mean the strategy to update old templates to the new naming convention.

Composer/packages/server/src/models/bot/botProject.ts

…tFramework-Composer into lg-naming-migration

which include repeat option fix and OAuth ifx

luhan2017 · 2020-04-17T09:05:47Z

I've tested this branch. All the luis bot are not working correctly because such settings are auto generated by lubuild, "=settings.luis.additem_en-us_lu", but we don't support - in expressions right now.

Talked with @boydc2014 and @feich-ms , fei is going to make a change in lubuild to replace all the - with _ in expressions. We need to wait until fei's update is ready.

luhan2017

Need to update bf lu package

zhixzhan · 2020-04-17T10:33:01Z

Need to update bf lu package

@luhan2017 Luis package has been updated, can you have another try.

cwhitten · 2020-04-17T13:39:24Z

do we need to migrate old luis settings that use the '-' character?

zhixzhan · 2020-04-18T01:39:14Z

do we need to migrate old luis settings that use the '-' character?

@luhan2017 if re-run lubuild or publish, can previous settings be erased?

luhan2017 · 2020-04-18T08:43:44Z

@luhan2017 if re-run lubuild or publish, can previous settings be erased?

Yes they will be re-generated.

cwhitten · 2020-04-18T18:21:48Z

@zhixzhan in the todowithluis sample I'm seeing broken behavior attempting to navigate between the all-up lg page and the design page, and also when trying to delete dialogs. I don't see the same behavior when using other samples.

Also seeing the following in the console:

LU Language Client: The server is initialized.
console-window.js:61 LU Language Client: Section todobotwithluissample-3.lu#newSection do not exist

zhixzhan · 2020-04-19T12:41:10Z

@zhixzhan in the todowithluis sample I'm seeing broken behavior attempting to navigate between the all-up lg page and the design page, and also when trying to delete dialogs. I don't see the same behavior when using other samples.

it comes from re-open current project, the last file write maybe not finished. I add a try_catch to mute this error.

Also seeing the following in the console:

LU Language Client: The server is initialized.
console-window.js:61 LU Language Client: Section todobotwithluissample-3.lu#newSection do not exist

@cwhitten updated.

* change - in template name to _ for all sample bots * update lg naming pattern * update tests * add method to convert template name when loading * Inline LU naming conventions in the prompts # TextInput.response-RuZhXe -> ${inputType}_Response_${id} * update lg name pattern * replace bfdactivity -> SendActivity * activity -> SendActivity * bfdprompt_1234 -> TextInput_Prompt_1234 * designerId no dash - * lgField use schema.$kind as lgNameType * use standalone method generate designer id * Update packages * Update sdk.schema * more replacement * change LG package version * upgrade lg package * fix api of Expression * Update BotProject.csproj update to the latest which include: 1. skill support 2. foreach and foreachPage nested fix. * update sample bot * use SDKKinds * use shared lu name builder * Update LanguagePolicy and IRecognzier * Recognizer -> IRecognizer * Update to the latest 200416 which include repeat option fix and OAuth ifx * Fix for skill AutoEndDialog * upgrade luis package * replace cover ${ } and @{ } expression syntax * upgrade luis package fix dash - * handle file write error * use a placeholder luSectionName Co-authored-by: Shuai Wang <shuwan@microsoft.com> Co-authored-by: Lu Han <32191031+luhan2017@users.noreply.github.com> Co-authored-by: Chris Whitten <christopher.whitten@microsoft.com>

change - in template name to _ for all sample bots

d2590dc

zhixzhan and others added 4 commits April 10, 2020 15:05

update lg naming pattern

14e32c9

update tests

4404067

add method to convert template name when loading

7ef61eb

Merge branch 'lg-naming-migration' of github.com:microsoft/BotFramewo…

3ba6acc

…rk-Composer into lg-naming-migration

cwhitten mentioned this pull request Apr 12, 2020

Default naming scheme, behavior for all concepts #778

Closed

zhixzhan added 5 commits April 13, 2020 15:34

Inline LU naming conventions in the prompts

03c3e02

# TextInput.response-RuZhXe -> ${inputType}_Response_${id}

update lg name pattern

694b3a3

replace bfdactivity -> SendActivity

5286a6b

activity -> SendActivity

ab7f5ad

bfdprompt_1234 -> TextInput_Prompt_1234

cde458e

zhixzhan commented Apr 13, 2020

View reviewed changes

Composer/packages/ui-plugins/lg/src/LgField.tsx Outdated Show resolved Hide resolved

zhixzhan commented Apr 14, 2020

View reviewed changes

Composer/packages/server/src/models/bot/botProject.ts Show resolved Hide resolved

zhixzhan and others added 8 commits April 14, 2020 12:26

designerId no dash -

8218e92

lgField use schema.$kind as lgNameType

f4a7d0f

use standalone method generate designer id

cdb2d88

Update packages

997ae11

Update sdk.schema

3e7f2f5

more replacement

8d12e03

Merge branch 'lg-naming-migration' of https://github.com/microsoft/Bo…

71be4a7

…tFramework-Composer into lg-naming-migration

Merge branch 'master' into lg-naming-migration

7aa02a1

zhixzhan marked this pull request as ready for review April 14, 2020 08:02

zhixzhan requested a review from a-b-r-o-w-n as a code owner April 14, 2020 08:02

luhan2017 and others added 8 commits April 16, 2020 17:31

Update LanguagePolicy and IRecognzier

f496659

Recognizer -> IRecognizer

935f940

Update to the latest 200416

da71cce

which include repeat option fix and OAuth ifx

Merge branch 'master' into lg-naming-migration

ea93471

Merge branch 'master' into lg-naming-migration

e29a469

Fix for skill AutoEndDialog

88fd61b

upgrade luis package

4d856c7

replace cover ${ } and @{ } expression syntax

26fa66e

luhan2017 requested changes Apr 17, 2020

View reviewed changes

upgrade luis package fix dash -

550e910

Merge branch 'master' into lg-naming-migration

5665b29

Merge branch 'master' into lg-naming-migration

5292ee9

luhan2017 previously approved these changes Apr 18, 2020

View reviewed changes

zhixzhan added 2 commits April 19, 2020 19:10

handle file write error

b83ce5c

use a placeholder luSectionName

3823239

zhixzhan dismissed luhan2017’s stale review via 3823239 April 19, 2020 12:11

cwhitten approved these changes Apr 20, 2020

View reviewed changes

cwhitten merged commit 4704385 into master Apr 20, 2020

cwhitten deleted the lg-naming-migration branch April 20, 2020 15:23

yeze322 mentioned this pull request Apr 21, 2020

LG template name not correct #2726

Closed

7 tasks

zhixzhan mentioned this pull request Apr 27, 2020

fix: unexpected lg name replacement in dialog dataTime #2774

Merged

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: lg naming migration #2597

feat: lg naming migration #2597

zhixzhan commented Apr 10, 2020 •

edited by luhan2017

Loading

github-actions bot commented Apr 10, 2020

cwhitten commented Apr 12, 2020 •

edited

Loading

zhixzhan commented Apr 13, 2020

tdurnford commented Apr 13, 2020

cwhitten commented Apr 14, 2020

zhixzhan commented Apr 14, 2020

cwhitten commented Apr 14, 2020

luhan2017 commented Apr 17, 2020

luhan2017 left a comment

zhixzhan commented Apr 17, 2020

cwhitten commented Apr 17, 2020

zhixzhan commented Apr 18, 2020

luhan2017 commented Apr 18, 2020

cwhitten commented Apr 18, 2020 •

edited

Loading

zhixzhan commented Apr 19, 2020 •

edited

Loading

feat: lg naming migration #2597

feat: lg naming migration #2597

Conversation

zhixzhan commented Apr 10, 2020 • edited by luhan2017 Loading

Description

Renaming check list

LG

LU

Task Item

Screenshots

Won't auto-replace case:

github-actions bot commented Apr 10, 2020

cwhitten commented Apr 12, 2020 • edited Loading

zhixzhan commented Apr 13, 2020

tdurnford commented Apr 13, 2020

cwhitten commented Apr 14, 2020

zhixzhan commented Apr 14, 2020

cwhitten commented Apr 14, 2020

luhan2017 commented Apr 17, 2020

luhan2017 left a comment

Choose a reason for hiding this comment

zhixzhan commented Apr 17, 2020

cwhitten commented Apr 17, 2020

zhixzhan commented Apr 18, 2020

luhan2017 commented Apr 18, 2020

cwhitten commented Apr 18, 2020 • edited Loading

zhixzhan commented Apr 19, 2020 • edited Loading

zhixzhan commented Apr 10, 2020 •

edited by luhan2017

Loading

cwhitten commented Apr 12, 2020 •

edited

Loading

cwhitten commented Apr 18, 2020 •

edited

Loading

zhixzhan commented Apr 19, 2020 •

edited

Loading