[communication-short-codes] Migrate to Core v2 #19043

AlonsoMondal · 2021-12-08T22:30:03Z

Updating the version of the autorest.typescript extension to the code generator to 6.0.0-beta.15

Main change is updating the dependencies from @azure/core-http to @azure/core-client/@azure/core-rest-pipeline packages, the client for rest http calls

Issue: #18688

Mainly following this wiki guide: https://github.com/Azure/autorest.typescript/wiki/%60core-http%60-dependency-migration-to-%60core-client%60-%60core-rest-pipeline%60

Also aiding myself with other PRs in communication that have done this, e.g. #17045

check-enforcer · 2021-12-08T22:40:30Z

This pull request is protected by Check Enforcer.

What is Check Enforcer?

Check Enforcer helps ensure all pull requests are covered by at least one check-run (typically an Azure Pipeline). When all check-runs associated with this pull request pass then Check Enforcer itself will pass.

Why am I getting this message?

You are getting this message because Check Enforcer did not detect any check-runs being associated with this pull request within five minutes. This may indicate that your pull request is not covered by any pipelines and so Check Enforcer is correctly blocking the pull request being merged.

What should I do now?

If the check-enforcer check-run is not passing and all other check-runs associated with this PR are passing (excluding license-cla) then you could try telling Check Enforcer to evaluate your pull request again. You can do this by adding a comment to this pull request as follows:
/check-enforcer evaluate
Typically evaulation only takes a few seconds. If you know that your pull request is not covered by a pipeline and this is expected you can override Check Enforcer using the following command:
/check-enforcer override
Note that using the override command triggers alerts so that follow-up investigations can occur (PRs still need to be approved as normal).

What if I am onboarding a new service?

Often, new services do not have validation pipelines associated with them, in order to bootstrap pipelines for a new service, you can issue the following command as a pull request comment:
/azp run prepare-pipelines
This will run a pipeline that analyzes the source tree and creates the pipelines necessary to build and validate your pull request. Once the pipeline has been created you can trigger the pipeline using the following comment:
/azp run js - [service] - ci

AlonsoMondal · 2021-12-08T22:45:18Z

/azp run js - shortcodes - ci

azure-pipelines · 2021-12-08T22:45:23Z

No pipelines are associated with this pull request.

AlonsoMondal · 2021-12-08T22:46:49Z

/azp run js - communication-short-codes - tests

azure-pipelines · 2021-12-08T22:47:01Z

Azure Pipelines successfully started running 1 pipeline(s).

AlonsoMondal · 2021-12-08T23:09:00Z

/azp run js - communication-short-codes - tests

azure-pipelines · 2021-12-08T23:09:13Z

Azure Pipelines successfully started running 1 pipeline(s).

AlonsoMondal · 2021-12-08T23:53:10Z

/azp run js - communication-short-codes - tests

azure-pipelines · 2021-12-08T23:53:23Z

Azure Pipelines successfully started running 1 pipeline(s).

azure-sdk · 2021-12-08T23:54:38Z

API changes have been detected in @azure-tools/communication-short-codes. You can review API changes here

sdk/communication/communication-short-codes/src/shortCodesClient.ts

AlonsoMondal · 2021-12-15T16:59:31Z

/azp run js - communication-short-codes - tests

azure-pipelines · 2021-12-15T16:59:36Z

Pull request contains merge conflicts.

AlonsoMondal · 2021-12-15T17:04:42Z

/azp run js - communication-short-codes - tests

azure-pipelines · 2021-12-15T17:04:55Z

Azure Pipelines successfully started running 1 pipeline(s).

AlonsoMondal · 2021-12-15T17:56:57Z

/azp run js - communication-short-codes - tests

azure-pipelines · 2021-12-15T17:57:11Z

Azure Pipelines successfully started running 1 pipeline(s).

AlonsoMondal · 2021-12-15T22:01:14Z

Hello @ramya-rao-a ! With the changes made up to now the node tests are passing with v2 http client, but all browser tests fail. Main message from error:
TypeError: Cannot read properties of undefined (reading 'createHash') at shaHash$1 (src/utils/cryptoUtils.ts:12:45 <- dist-test/index.browser.js:34861:48) at signRequest (src/utils/communicationAccessKeyCredentialPolicy.ts:58:29 <- dist-test/index.browser.js:34905:32)

I see that communication-common uses 2 cryptoUtils files, one called cryptoUtils.browser.ts, which in my mind would fix this issue, but how can I tell the browser tests to use this other cryptoUtils?

I have also tried debugging the browser tests but it seems it never goes through the actual cryptoUtils nor communicationAccessKeyCredentialPolicy ...
Anything you might notice?

joheredi · 2021-12-17T15:54:15Z

Hello @ramya-rao-a ! With the changes made up to now the node tests are passing with v2 http client, but all browser tests fail. Main message from error: TypeError: Cannot read properties of undefined (reading 'createHash') at shaHash$1 (src/utils/cryptoUtils.ts:12:45 <- dist-test/index.browser.js:34861:48) at signRequest (src/utils/communicationAccessKeyCredentialPolicy.ts:58:29 <- dist-test/index.browser.js:34905:32)

I see that communication-common uses 2 cryptoUtils files, one called cryptoUtils.browser.ts, which in my mind would fix this issue, but how can I tell the browser tests to use this other cryptoUtils?

I have also tried debugging the browser tests but it seems it never goes through the actual cryptoUtils nor communicationAccessKeyCredentialPolicy ... Anything you might notice?

@AlonsoMondal, usually this node->browser mapping is set in the package.json, something like this under "browser"

{
"name": "@azure/communication-sms",
  "version": "1.1.0",
  "description": "SDK for Azure Communication SMS service which facilitates the sending of SMS messages.",
  "sdk-type": "client",
  "main": "dist/index.js",
  "module": "dist-esm/src/index.js",
  "browser": {
    "stream": "./node_modules/stream-browserify/index.js",
    "./dist-esm/src/credentials/cryptoUtils.js": "./dist-esm/src/credentials/cryptoUtils.browser.js"
  },
 ...
}

Where the key is the transpiled node/default version (see that it is pointing to the dist-esm folder and to the .js file) and the value is the transpiled browser version.

Browser bundlers would read this mapping and whenever they would use"./dist-esm/src/credentials/cryptoUtils.js" instead they would take the file set on the right side of the mapping.

This should help you with the browser tests. When setting the mappings make sure the file paths match the actual files in your dist-esm folder after building your project

AlonsoMondal · 2021-12-20T23:55:19Z

/azp run js - communication-short-codes - tests

azure-pipelines · 2021-12-20T23:55:31Z

Azure Pipelines successfully started running 1 pipeline(s).

prepared for second beta release.

Fix package-name property in autorest configuration

Inject XHR client to fix browser tests

danielortega-msft · 2022-03-10T23:21:24Z

@petrsvihlik this PR is now updated to address your comments. Can you please review again?

CC: @rtrevino89

sdk/communication/communication-short-codes/swagger/README.md

sdk/communication/communication-short-codes/src/utils/constants.ts

sdk/communication/communication-short-codes/test/internal/headers.spec.ts

sdk/communication/communication-short-codes/review/communication-short-codes.api.md

sdk/communication/communication-short-codes/test/public/utils/recordedClient.ts

sdk/communication/communication-short-codes/CHANGELOG.md

- Add versioning metadata to package.json - Update changelog wording - Import `isNode` from `@azure/test-utils` - Restore tokenCredential explicit typing

danielortega-msft · 2022-03-11T19:21:35Z

@petrsvihlik just pushed some changes addressing your comments. Thanks for the thorough review!

joheredi · 2022-03-14T21:30:36Z

sdk/communication/communication-short-codes/test/public/utils/recordedClient.ts

  isPlaybackMode,
+  record,


Would you mind filing an issue to track migrating tests to the new recorder?
https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/test-utils/recorder/MIGRATION.md

joheredi

Changes look good! Please file an issue for migrating tests to the new recorder

danielortega-msft · 2022-03-15T17:26:27Z

Thanks for the reviews! I created the issue to track the test recorder migration, you can see it here: #20871.

* changes to migrate http client * shortcodes-http * formatting changes * fixing from pulling * formatting * credential changes for http client v2 migration * adding browser specific utils for auth * adding linter fixes * fixing mocked client * updating policy and sdk version constant * formatting.... * re-recording node tests * fixes needed for browser tests * re-recording tests * fixing unsupported ES2020 'OptionalChain' syntax * formatting * fixing unsupported ES2020 'OptionalChain' syntax on pending sample * fixing unsupported ES2020 'OptionalChain' syntax * fixed typo for shortcodes description * retaking http migration work * removing unnecessary file * removing http-core library * resolving comments * adding re recorded tests * resolving comments and re-recording tests * removing unsupported chainings in samples * fixing samples for ES2020 unsupported syntax * formatting * fixing samples and rerecording tests * fixing tests to include azure on user agent. prepared for second beta release. * fixing error from sms. formatting. * Update communication-common dependency to 2.0.0 Fix package-name property in autorest configuration * Reuse auth pipelines from communication-common Inject XHR client to fix browser tests * Cleanup no longer needed dependencies * Lint and format * Expect `preferredVanityNumbers` in program briefs * Address PR comments - Add versioning metadata to package.json - Update changelog wording - Import `isNode` from `@azure/test-utils` - Restore tokenCredential explicit typing Co-authored-by: Daniel Ortega <[email protected]>

AlonsoMondal commented Dec 10, 2021

View reviewed changes

sdk/communication/communication-short-codes/src/shortCodesClient.ts Outdated Show resolved Hide resolved

AlonsoMondal requested a review from ramya-rao-a December 15, 2021 21:56

ramya-rao-a mentioned this pull request Dec 15, 2021

Update the new @azure/communication-short-codes package to use the latest code generator #18688

Closed

AlonsoMondal marked this pull request as ready for review December 20, 2021 23:54

AlonsoMondal requested review from bterlson, danielav7, jeremymeng and xirzec as code owners December 20, 2021 23:54

AlonsoMondal requested review from arifibrahim4 and RoyHerrod as code owners December 21, 2021 00:25

AlonsoMondal and others added 4 commits March 9, 2022 16:29

fixing samples and rerecording tests

b549cd0

fixing tests to include azure on user agent.

c6d249a

prepared for second beta release.

fixing error from sms. formatting.

99a1f79

Update communication-common dependency to 2.0.0

e9ec64c

Fix package-name property in autorest configuration

danielortega-msft force-pushed the shortcodes-http branch from b4fbfbd to e9ec64c Compare March 10, 2022 00:50

danielortega-msft added 4 commits March 9, 2022 17:11

Reuse auth pipelines from communication-common

183ab96

Inject XHR client to fix browser tests

Cleanup no longer needed dependencies

a154fe5

Lint and format

f2bb065

Expect preferredVanityNumbers in program briefs

cf46b85

danielortega-msft requested review from petrsvihlik and removed request for ramya-rao-a March 10, 2022 23:21

danielortega-msft requested review from xirzec, jeremymeng, joheredi and witemple-msft March 10, 2022 23:21

petrsvihlik reviewed Mar 11, 2022

View reviewed changes

sdk/communication/communication-short-codes/swagger/README.md Show resolved Hide resolved

petrsvihlik suggested changes Mar 11, 2022

View reviewed changes

Address PR comments

48337ff

- Add versioning metadata to package.json - Update changelog wording - Import `isNode` from `@azure/test-utils` - Restore tokenCredential explicit typing

petrsvihlik approved these changes Mar 14, 2022

View reviewed changes

joheredi reviewed Mar 14, 2022

View reviewed changes

joheredi approved these changes Mar 14, 2022

View reviewed changes

danielortega-msft merged commit ca2ff18 into Azure:main Mar 15, 2022

petrsvihlik mentioned this pull request Mar 17, 2022

[Communication]Move the Communication packages to use core-rest-pipeline #15814

Closed

danielortega-msft mentioned this pull request Mar 29, 2022

[Communication] short-codes - Prepare communication-short-codes for release #21096

Merged

3 tasks

arifibrahim4 mentioned this pull request Apr 25, 2022

Feature/sms core v2 and test recoder migration #21328

Merged

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[communication-short-codes] Migrate to Core v2 #19043

[communication-short-codes] Migrate to Core v2 #19043

AlonsoMondal commented Dec 8, 2021 •

edited

Loading

check-enforcer bot commented Dec 8, 2021

AlonsoMondal commented Dec 8, 2021

azure-pipelines bot commented Dec 8, 2021

AlonsoMondal commented Dec 8, 2021

azure-pipelines bot commented Dec 8, 2021

AlonsoMondal commented Dec 8, 2021

azure-pipelines bot commented Dec 8, 2021

AlonsoMondal commented Dec 8, 2021

azure-pipelines bot commented Dec 8, 2021

azure-sdk commented Dec 8, 2021

AlonsoMondal commented Dec 15, 2021

azure-pipelines bot commented Dec 15, 2021

AlonsoMondal commented Dec 15, 2021

azure-pipelines bot commented Dec 15, 2021

AlonsoMondal commented Dec 15, 2021

azure-pipelines bot commented Dec 15, 2021

AlonsoMondal commented Dec 15, 2021

joheredi commented Dec 17, 2021

AlonsoMondal commented Dec 20, 2021

azure-pipelines bot commented Dec 20, 2021

danielortega-msft commented Mar 10, 2022

danielortega-msft commented Mar 11, 2022

joheredi Mar 14, 2022

joheredi left a comment

danielortega-msft commented Mar 15, 2022

[communication-short-codes] Migrate to Core v2 #19043

[communication-short-codes] Migrate to Core v2 #19043

Conversation

AlonsoMondal commented Dec 8, 2021 • edited Loading

check-enforcer bot commented Dec 8, 2021

What is Check Enforcer?

Why am I getting this message?

What should I do now?

What if I am onboarding a new service?

AlonsoMondal commented Dec 8, 2021

azure-pipelines bot commented Dec 8, 2021

AlonsoMondal commented Dec 8, 2021

azure-pipelines bot commented Dec 8, 2021

AlonsoMondal commented Dec 8, 2021

azure-pipelines bot commented Dec 8, 2021

AlonsoMondal commented Dec 8, 2021

azure-pipelines bot commented Dec 8, 2021

azure-sdk commented Dec 8, 2021

AlonsoMondal commented Dec 15, 2021

azure-pipelines bot commented Dec 15, 2021

AlonsoMondal commented Dec 15, 2021

azure-pipelines bot commented Dec 15, 2021

AlonsoMondal commented Dec 15, 2021

azure-pipelines bot commented Dec 15, 2021

AlonsoMondal commented Dec 15, 2021

joheredi commented Dec 17, 2021

AlonsoMondal commented Dec 20, 2021

azure-pipelines bot commented Dec 20, 2021

danielortega-msft commented Mar 10, 2022

danielortega-msft commented Mar 11, 2022

joheredi Mar 14, 2022

Choose a reason for hiding this comment

joheredi left a comment

Choose a reason for hiding this comment

danielortega-msft commented Mar 15, 2022

AlonsoMondal commented Dec 8, 2021 •

edited

Loading