Update Emulator to Use New Cognitive Service API #1878

bwamie · 2019-09-22T15:24:41Z

Update Emulator to Use New Cognitive Service API
Add token refresh 5 minutes before it expires.

coveralls · 2019-09-22T15:37:43Z

Coverage increased (+0.02%) to 66.959% when pulling e2ccb9a on edwinb/speech-for-paid-api-changes into 98e7b21 on master.

compulim

Add tests.

packages/app/client/src/state/sagas/chatSagas.ts

packages/emulator/core/src/facility/botEndpoint.ts

packages/sdk/shared/src/types/index.ts

packages/sdk/shared/src/types/speechRegionToken.ts

compulim · 2019-09-23T18:54:25Z

packages/emulator/core/src/facility/botEndpoint.ts

-    if (!this.msaAppId || !this.msaPassword) {
-      throw new Error('bot must have Microsoft App ID and password');
-    }
+  private isTokenExpired(): boolean {


Don't duplicate code.

With which one? Its not duplacted. If you mean with isTokenExpiringSoon then it is not. They are different.

I mean the isTokenExpired and isTokenExpiringSoon is too similar.

It may make sense to return the expiry, or building a function named willTokenExpireWithin(durationInMs: number = 0).

compulim · 2019-09-23T18:54:36Z

packages/emulator/core/src/facility/botEndpoint.ts


-    const query = new URLSearchParams({ goodForInMinutes: duration } as any);
-    const res = await this.fetchWithAuth(new URL(`?${query.toString()}`, speechEndpoint.tokenEndpoint).toString());
+  private renewTokenBeforeExpiry() {


Don't use then, use async/await.

packages/app/shared/src/types/speechTypes.ts

compulim · 2019-09-23T18:56:42Z

packages/app/shared/src/types/speechRegionToken.ts

@@ -0,0 +1,38 @@
+//


Why there is a dupe file in /sdk/?

Same as above

We should just choose one -- I vote for sdk -- and delete the other one. There should be minimal code churn because the type SpeechTokenInfo is only used in one place

packages/app/shared/src/types/index.ts

tonyanziano

After you finish resolving PR feedback, please run the command npm run lint:fix from the root of the project. This should fix issues like import sorting, however it might not alphabetize them.

tonyanziano · 2019-09-24T17:39:13Z

packages/app/shared/src/types/speechRegionToken.ts

@@ -0,0 +1,38 @@
+//


We should just choose one -- I vote for sdk -- and delete the other one. There should be minimal code churn because the type SpeechTokenInfo is only used in one place

compulim · 2019-09-26T21:26:02Z

packages/emulator/core/src/facility/botEndpoint.ts

+    }
+
+    if (!this.msaAppId || !this.msaPassword) {
+      throw new Error('bot must have Microsoft App ID and password');


I mean it looks a bit late to throw here.

tonyanziano

Pulled it down and tested it. Looks good to me, but you should address the comments William left. 👍

packages/app/client/src/state/sagas/chatSagas.ts

packages/emulator/core/src/facility/botEndpoint.ts

compulim · 2019-09-30T19:40:13Z

packages/emulator/core/src/facility/botEndpoint.ts

+    }
+
+    if (this.speechRegionToken && !refresh && !this.willTokenExpireWithin(0)) {
+      if (this.willTokenExpireWithin(this.speechRegionToken.tokenLife * 0.5)) {


Suggested change

if (this.willTokenExpireWithin(this.speechRegionToken.tokenLife * 0.5)) {

if (this.willTokenExpireWithin(this.speechRegionToken.tokenLife / 2)) {

packages/emulator/core/src/facility/botEndpoint.ts

compulim · 2019-09-30T19:40:48Z

packages/emulator/core/src/facility/botEndpoint.ts

-    }
+  private willTokenExpireWithin(millisecondsToExpire: number): boolean {
+    const currentDateTime = new Date();
+    const timeFromNowMilliseconds = currentDateTime.getTime() + millisecondsToExpire;


Suggested change

const timeFromNowMilliseconds = currentDateTime.getTime() + millisecondsToExpire;

const timeFromNowMilliseconds = Date.now() + millisecondsToExpire;

packages/emulator/core/src/authEndpoints.ts

packages/app/client/src/state/sagas/chatSagas.ts

packages/emulator/core/src/facility/botEndpoint.ts

packages/app/client/src/state/sagas/chatSagas.ts

compulim

In addition for comments below, there are couple of things that are still unanswered in previous reviews.

compulim · 2019-10-02T19:19:04Z

packages/app/client/src/state/sagas/chatSagas.ts

+
+    if (speechAuthenticationToken && speechAuthenticationToken.access_Token && speechAuthenticationToken.region) {
+      const factory = yield call(createCognitiveServicesSpeechServicesPonyfillFactory, {
+        authorizationToken: () => Promise.resolve(speechAuthenticationToken.access_Token),


This should a Promise function. When called, will fetch the token from the server. And the token need to be cached for its half-life.

packages/emulator/core/src/facility/botEndpoint.ts

packages/app/client/src/state/sagas/chatSagas.ts

compulim

Looks good to me.

If the speech token call is taking too much time, and the user keep clicking on the microphone button. It may end up having multiple ongoing "get token call". I am okay with this for now.

Love your tests. AFAIR, people said test code is statistically 3 times the size of production code.

Let's wait for Chris to test it out.

packages/app/client/src/state/sagas/chatSagas.ts

packages/emulator/core/src/authEndpoints.ts

stale

cwhitten · 2019-10-08T17:04:03Z

Nice work @edwin4microsoft & @tonyanziano. Let's resolve conflicts and get it in.

bwamie requested review from a-b-r-o-w-n, compulim, corinagum, cwhitten and tonyanziano as code owners September 22, 2019 15:24

compulim requested changes Sep 23, 2019

View reviewed changes

tonyanziano previously requested changes Sep 24, 2019

View reviewed changes

compulim requested changes Sep 26, 2019

View reviewed changes

tonyanziano reviewed Sep 26, 2019

View reviewed changes

compulim requested changes Sep 30, 2019

View reviewed changes

tonyanziano reviewed Oct 2, 2019

View reviewed changes

packages/app/client/src/state/sagas/chatSagas.ts Outdated Show resolved Hide resolved

compulim previously requested changes Oct 2, 2019

View reviewed changes

cwhitten assigned corinagum Oct 2, 2019

corinagum assigned tonyanziano and unassigned corinagum Oct 4, 2019

tonyanziano force-pushed the edwinb/speech-for-paid-api-changes branch from 9e4d7f5 to 505fd53 Compare October 7, 2019 22:50

tonyanziano reviewed Oct 7, 2019

View reviewed changes

packages/app/client/src/state/sagas/chatSagas.ts Show resolved Hide resolved

tonyanziano force-pushed the edwinb/speech-for-paid-api-changes branch from 505fd53 to da0ef01 Compare October 7, 2019 23:20

compulim reviewed Oct 7, 2019

View reviewed changes

packages/app/client/src/state/sagas/chatSagas.ts Show resolved Hide resolved

packages/emulator/core/src/authEndpoints.ts Outdated Show resolved Hide resolved

cwhitten previously approved these changes Oct 8, 2019

View reviewed changes

tonyanziano dismissed cwhitten’s stale review via 06b0443 October 8, 2019 17:23

tonyanziano force-pushed the edwinb/speech-for-paid-api-changes branch from da0ef01 to 06b0443 Compare October 8, 2019 17:23

Migrated fron Bing Speech to Cognitive Services Speech API.

e2ccb9a

tonyanziano force-pushed the edwinb/speech-for-paid-api-changes branch from 06b0443 to e2ccb9a Compare October 8, 2019 17:36

tonyanziano merged commit 90384b8 into master Oct 8, 2019

tonyanziano deleted the edwinb/speech-for-paid-api-changes branch October 8, 2019 17:53

natelandon mentioned this pull request Jun 22, 2023

[Snyk] Security upgrade restify from 4.3.0 to 10.0.0 natelandon/BotFramework-Emulator#20

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update Emulator to Use New Cognitive Service API #1878

Update Emulator to Use New Cognitive Service API #1878

bwamie commented Sep 22, 2019

coveralls commented Sep 22, 2019 •

edited

Loading

compulim left a comment

compulim Sep 23, 2019

bwamie Sep 24, 2019

compulim Sep 26, 2019

compulim Sep 23, 2019

compulim Sep 23, 2019

bwamie Sep 23, 2019

tonyanziano Sep 24, 2019

tonyanziano left a comment •

edited

Loading

tonyanziano Sep 24, 2019

compulim Sep 26, 2019

tonyanziano left a comment

compulim Sep 30, 2019

compulim Sep 30, 2019

compulim left a comment •

edited

Loading

compulim Oct 2, 2019

compulim left a comment

cwhitten commented Oct 8, 2019

	if (this.willTokenExpireWithin(this.speechRegionToken.tokenLife * 0.5)) {
	if (this.willTokenExpireWithin(this.speechRegionToken.tokenLife / 2)) {

	const timeFromNowMilliseconds = currentDateTime.getTime() + millisecondsToExpire;
	const timeFromNowMilliseconds = Date.now() + millisecondsToExpire;

Update Emulator to Use New Cognitive Service API #1878

Update Emulator to Use New Cognitive Service API #1878

Conversation

bwamie commented Sep 22, 2019

coveralls commented Sep 22, 2019 • edited Loading

compulim left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tonyanziano left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tonyanziano left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

compulim left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

compulim left a comment

Choose a reason for hiding this comment

cwhitten commented Oct 8, 2019

coveralls commented Sep 22, 2019 •

edited

Loading

tonyanziano left a comment •

edited

Loading

compulim left a comment •

edited

Loading