[Identity] Migrated to samples v2 #19085

sadasant · 2021-12-09T21:51:48Z

I’m following the migration guide to move Identity to the samples v2: https://github.com/Azure/azure-sdk-for-js/wiki/Samples-v2-Migration-Guide

Important: Added the dependencyOverrides in order to require @azure/keyvault-keys on the samples, since Identity can’t depend on @azure/keyvault-keys (it would get recursive).

Fixes #14474

witemple-msft

I always only thought of dependencyOverrides as being to override dependency version selectors and not to inject them, but this should totally work and is honestly quite clever.

I have one comment about how the build errors might be fixed, and another about why we need to import from the identity package name and not from ../src.

witemple-msft · 2021-12-09T22:42:07Z

sdk/identity/identity/samples-dev/clientSecretCredential.ts

+import { ClientSecretCredential } from "../src";
 import { KeyClient } from "@azure/keyvault-keys";


Two comments here:

We need to still be importing from @azure/identity here. Adding it to the paths entry in tsconfig should enable this, so you don't need to import from source for that to resolve (as you can think of paths as adding a manual module resolution entry to the TypeScript compiler).

We will also need an entry for @azure/keyvault-keys. I never thought to use dependencyOverrides for this purpose, but it should totally work if we also add a paths entry for it! I think something like "@azure/keyvault-keys": ["../../keyvault/keyvault-keys/src/index"] should work nicely.

So, I updated the references to @azure/identity on the samples, but "@azure/keyvault-keys": ["../../keyvault/keyvault-keys/src/index"] didn’t work. We talked over teams and we realized that adding keyvault on paths would alter significantly how the dist folder appears (it grabs a large part of the repository structure, to group these two projects under the same root).

and a cleanup related to keys on the package.json

deyaaeldeen · 2021-12-11T00:57:08Z

sdk/identity/identity/README.md

@@ -10,7 +10,7 @@ Key links:
 - [Package (npm)](https://www.npmjs.com/package/@azure/identity)
 - [API Reference Documentation](https://docs.microsoft.com/javascript/api/@azure/identity)
 - [Product documentation](https://azure.microsoft.com/services/active-directory/)
- [Samples](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity/samples)
+- [Samples](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity/samples/v2)


I think other versions could be added in the future so do we want the customer to pick and choose the right version for them?

Ohh interesting! — Though I’d rather not think too much about it at the moment 🙏 I took a peek and it made me question other things. Makes me feel it’s a scope leak and could lead to a rabbit hole.

I took a peek and it made me question other things.

@sadasant interesting, anything you could share that could help with future migrations?

deyaaeldeen · 2021-12-11T00:59:33Z

sdk/identity/identity/samples/v2/javascript/clientSecretCredential.js

@@ -1,6 +1,10 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.

+/**
+ * @summary Authenticates with a client and a client's secret.


The word client is overloaded in this context and could be confusing. Should we use "application" instead?

"App Registration"?

Updated! Please let me know how it looks 👍

witemple-msft

Very nice. I have just a couple of comments on the @summary tags.

witemple-msft · 2021-12-13T16:32:45Z

sdk/identity/identity/samples/v2/javascript/clientSecretCredential.js

@@ -1,6 +1,10 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.

+/**
+ * @summary Authenticates with a client and a client's secret.


"App Registration"?

sdk/identity/identity/samples-dev/environmentCredential.ts

sdk/identity/identity/samples-dev/defaultAzureCredential.ts

Co-authored-by: Will Temple <[email protected]>

deyaaeldeen · 2021-12-13T21:02:35Z

sdk/identity/identity/samples-dev/clientSecretCredential.ts

@@ -1,6 +1,10 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.

+/**
+ * @summary Authenticates with a client and a app registration's secret.


could you update this summary as well?

Oh now I think I should have said Authenticates with an app registration’s client Id and secret. I’ll update it!

How does this look? 9f525fc

Looks good, thanks!

Mitryakh/network 2022 01 01 (Azure#19412) * Adds base for updating Microsoft.Network from version stable/2021-08-01 to version 2022-01-01 * Updates readme * Updates API version in new specs and examples * Updated Explicit proxy settings by adding one boolean field to it (Azure#19011) * API for provider port (Azure#19041) * Update readme.md * Create expressRouteProviderPort.json * Create expressRouteProviderPortList.json * Create expressRouteProviderPort.json * Update custom-words.txt * Update expressRouteProviderPort.json * Update expressRouteProviderPortList.json * Update expressRouteProviderPort.json * Add WAF match variable operators (Azure#18925) ### webapplicationfirewall.json * Add GreaterThanOrEquals operator and Any operator to custom rule match conditions in WAF policy spec * Add VirtualHub Router autoscale configuration (Azure#19131) Co-authored-by: Andrii Kalinichenko <[email protected]> * Adding rule priority to Tls Proxy routing rule object model (Azure#19135) Co-authored-by: Vinay Mundada <[email protected]> * swagger changes for new ssl policies (Azure#19183) * Update Swagger Spec for VMSS Packet Capture (Azure#19202) * Update Swagger Spec for VMSS Packet Capture * Remove extra line * Update Swagger spec for Connection Monitor VMSS (Azure#19203) * Adding new endpoint in ConnectionMonitor * Changing ConnectionMonitor endpoints order * Add flushConnection to NSG (Azure#19085) * Merge NetworkManger into 2022-01-01 (Azure#19169) * Merge NetworkManger into 2022-01-01 * Remove EffectiveVnet APIs * Remove SecurityUser Resource * update readme * Fix as comments * fix as comments * remove network group type * Add new parameter noInternetAdvertise to CustomIPPrefix (Azure#19340) * fix * fix Co-authored-by: Weiheng Li <[email protected]> * Route Server Integration feature swagger changes (Azure#19215) * Route Server Integration feature swagger changes * prettier run changes * updating api version in examples file * fixing test errors * fixing test errors * fixing modelvalidation errors * fixing test errors * fixing modelvalidation errors * changes based on review comments * fixing lintdiff failure * updating examples * update wrong enum value for customipprefix (Azure#19382) * fix * fix * fix Co-authored-by: Weiheng Li <[email protected]> * Updated ExplicitProxySettings to ExplicitProxy on Firewall Policy ver2022-01-01 (Azure#19299) Co-authored-by: Gizachew Eshetie <[email protected]> * Add resource type (Azure#19434) Co-authored-by: Andrii Kalinichenko <[email protected]> * Fix prettier errors (Azure#19462) Co-authored-by: Andrii Kalinichenko <[email protected]> Co-authored-by: uditmisra52 <[email protected]> Co-authored-by: jashsing-mic <[email protected]> Co-authored-by: Anurag Kishore <[email protected]> Co-authored-by: AndriiKalinichenko <[email protected]> Co-authored-by: Andrii Kalinichenko <[email protected]> Co-authored-by: Vinay Jayant Mundada <[email protected]> Co-authored-by: Vinay Mundada <[email protected]> Co-authored-by: kaushik-ms <[email protected]> Co-authored-by: snagpal99 <[email protected]> Co-authored-by: kumaam <[email protected]> Co-authored-by: Satya-anshu <[email protected]> Co-authored-by: yanfa317 <[email protected]> Co-authored-by: Weiheng Li <[email protected]> Co-authored-by: Weiheng Li <[email protected]> Co-authored-by: Anchal Kapoor <[email protected]> Co-authored-by: Gizachew-Eshetie <[email protected]> Co-authored-by: Gizachew Eshetie <[email protected]>

sadasant added 2 commits December 9, 2021 21:44

Migrated to samples v2

0b0a93c

cleanups

5ddfb49

sadasant requested a review from witemple-msft December 9, 2021 21:51

sadasant self-assigned this Dec 9, 2021

ghost added the Azure.Identity label Dec 9, 2021

witemple-msft reviewed Dec 9, 2021

View reviewed changes

sadasant added 5 commits December 9, 2021 22:55

importing from @azure/identity

7781197

referencing to a specific version of keyvault-keys

7f6f8ad

fixing links

084ed4f

I had accidentally altered the references to AzureIdentityExamples.md

05c8fab

different product slug

299eee1

and a cleanup related to keys on the package.json

sadasant marked this pull request as ready for review December 11, 2021 00:05

sadasant requested review from deyaaeldeen, mikeharder, praveenkuttappan and schaabs as code owners December 11, 2021 00:05

deyaaeldeen reviewed Dec 11, 2021

View reviewed changes

witemple-msft approved these changes Dec 13, 2021

View reviewed changes

sadasant and others added 3 commits December 13, 2021 15:09

Apply suggestions from code review

460054d

Co-authored-by: Will Temple <[email protected]>

client to App Registration

ac5797d

updates after pulling from origin

7263a41

deyaaeldeen reviewed Dec 13, 2021

View reviewed changes

better wording

9f525fc

sadasant enabled auto-merge (squash) December 13, 2021 22:16

sadasant merged commit a5289f1 into Azure:main Dec 13, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Identity] Migrated to samples v2 #19085

[Identity] Migrated to samples v2 #19085

sadasant commented Dec 9, 2021 •

edited

Loading

witemple-msft left a comment

witemple-msft Dec 9, 2021

sadasant Dec 10, 2021

deyaaeldeen Dec 11, 2021

sadasant Dec 13, 2021

deyaaeldeen Dec 13, 2021

deyaaeldeen Dec 11, 2021

witemple-msft Dec 13, 2021

sadasant Dec 13, 2021

witemple-msft left a comment

witemple-msft Dec 13, 2021

deyaaeldeen Dec 13, 2021

sadasant Dec 13, 2021 •

edited

Loading

sadasant Dec 13, 2021

deyaaeldeen Dec 13, 2021

		import { ClientSecretCredential } from "../src";
		import { KeyClient } from "@azure/keyvault-keys";

[Identity] Migrated to samples v2 #19085

[Identity] Migrated to samples v2 #19085

Conversation

sadasant commented Dec 9, 2021 • edited Loading

witemple-msft 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

Choose a reason for hiding this comment

witemple-msft left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sadasant Dec 13, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sadasant commented Dec 9, 2021 •

edited

Loading

sadasant Dec 13, 2021 •

edited

Loading