Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add Bot State API deprecation warning #348

Merged
merged 16 commits into from
Nov 30, 2017
Merged

Add Bot State API deprecation warning #348

Changes from 1 commit
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
8393454
Add Bot State API depreciation warning
Nov 17, 2017
fac6c5c
update warning message text + replace docs URLs with aka.ms links
Nov 17, 2017
24d87e6
fix typo in docs link
Nov 17, 2017
22a20d8
src/server/controllers/connector/botStateController.ts
Nov 17, 2017
3a3103f
update variable name
Nov 17, 2017
1846284
fix typo
Nov 17, 2017
651a858
set depreciation warning flag to true after first warning.
Nov 17, 2017
14fb026
change "depreciation" to "deprecation" in method and variable name
Nov 17, 2017
bca9fe8
add check for conversation object
Nov 17, 2017
8df0c98
hyperlink log message
Nov 27, 2017
5b744d1
updated warning message per eanderson feedback
Nov 28, 2017
fa5f143
split messages linked/not linked
Nov 28, 2017
9621eac
update per eanders feedback
Nov 29, 2017
7e3e390
update per eanders feedback
Nov 29, 2017
06a1f88
update per eanders feedback
Nov 30, 2017
017b2c9
update per eanders feedback
Nov 30, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions src/server/controllers/connector/botStateController.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,10 +60,12 @@ export class BotStateController {

private logBotStateApiDeprecationWarning(botId: string, conversationId: string) {
const conversation: Conversation = emulator.conversations.conversationById(botId, conversationId);
if (!conversation.stateApiDeprecationWarningShown) {
conversation.stateApiDeprecationWarningShown = true;
log.warn('Warning: The Bot Framework State API is not recommended for production environments, and may be deprecated in a future release.',
log.makeLinkMessage('Learn how to implement your own storage adapter.', 'https://aka.ms/botframework-state-service'));
if (conversation) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you please simplify this to a single line?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

Copy link
Member

@stevengum stevengum Nov 30, 2017 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since there aren't any else statements in this method, what about:

if (conversation && !conversation.stateApiDeprecationWarningShown) {

as opposed to

if (conversation) { if (!conversation.stateApiDeprecationWarningShown) {

if (!conversation.stateApiDeprecationWarningShown) {
conversation.stateApiDeprecationWarningShown = true;
log.warn('Warning: The Bot Framework State API is not recommended for production environments, and may be deprecated in a future release.',
log.makeLinkMessage('Learn how to implement your own storage adapter.', 'https://aka.ms/botframework-state-service'));
}
}
}

Expand Down