-
Notifications
You must be signed in to change notification settings - Fork 3.8k
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.
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
Fix Importing Az in Parallel #18483
Merged
BethanyZhou
merged 5 commits into
Azure:main
from
isra-fel:18321-az-module-cannot-be-imported-in-parallel
Jun 28, 2022
Merged
Fix Importing Az in Parallel #18483
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
87d1543
use mutex to protect config init
isra-fel 2ec5db4
Merge branch 'main' of https://github.com/Azure/azure-powershell into…
isra-fel 4cdd4d0
Merge branch 'main' of https://github.com/Azure/azure-powershell into…
isra-fel eea174e
Fix ConfigKeys reference
isra-fel 0c2c34e
Merge branch 'main' of https://github.com/Azure/azure-powershell into…
isra-fel File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -33,11 +33,10 @@ namespace Microsoft.Azure.Commands.Common.Authentication.Config | |
internal class ConfigInitializer | ||
{ | ||
internal IDataStore DataStore { get; set; } = new DiskDataStore(); | ||
private static readonly object _fsLock = new object(); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. lock is no longer needed because the initialization is guarded by a mutex |
||
|
||
internal IEnvironmentVariableProvider EnvironmentVariableProvider { get; set; } = new DefaultEnvironmentVariableProvider(); | ||
|
||
public string ConfigPath | ||
private string ConfigPath | ||
{ | ||
get | ||
{ | ||
|
@@ -47,6 +46,10 @@ public string ConfigPath | |
} | ||
return _cachedConfigPath; | ||
} | ||
set | ||
{ | ||
_cachedConfigPath = value; | ||
} | ||
} | ||
private string _cachedConfigPath; | ||
private readonly IEnumerable<string> _configPathCandidates; | ||
|
@@ -87,16 +90,7 @@ private string GetPathToConfigFile(IEnumerable<string> paths) | |
continue; | ||
} | ||
} | ||
throw new ApplicationException($"Failed to store the config file. Please make sure any one of the following paths is accessible: {string.Join(", ", paths)}"); | ||
} | ||
|
||
internal IConfigManager GetConfigManager() | ||
{ | ||
lock (_fsLock) | ||
{ | ||
ValidateConfigFile(); | ||
} | ||
return new ConfigManager(ConfigPath, DataStore, EnvironmentVariableProvider); | ||
throw new ApplicationException($"Failed to create the config file. Please make sure any one of the following paths is accessible: {string.Join(", ", paths)}"); | ||
} | ||
|
||
private void ValidateConfigFile() | ||
|
@@ -122,46 +116,62 @@ private void ResetConfigFileToDefault() | |
} | ||
} | ||
|
||
// todo: tests initializes configs in a different way. Maybe there should be an abstraction IConfigInitializer and two concrete classes ConfigInitializer + TestConfigInitializer | ||
internal void InitializeForAzureSession(AzureSession session) | ||
/// <summary> | ||
/// Initializes the config manager and registers it to <see cref="AzureSession"/>. | ||
/// </summary> | ||
/// <param name="session"></param> | ||
public void Initialize(IAzureSession session) | ||
{ | ||
ValidateConfigFile(); | ||
Initialize(session, new DefaultConfigManager(ConfigPath, DataStore, EnvironmentVariableProvider)); | ||
} | ||
|
||
private void Initialize(IAzureSession session, IConfigManager configManager) | ||
{ | ||
IConfigManager configManager = GetConfigManager(); | ||
session.RegisterComponent(nameof(IConfigManager), () => configManager); | ||
session.RegisterComponent(nameof(IConfigManager), () => configManager, true); | ||
RegisterConfigs(configManager); | ||
configManager.BuildConfig(); | ||
} | ||
|
||
/// <summary> | ||
/// Initializes the config manager with limited capabilities but in a safe manner. | ||
/// Registers it to <see cref="AzureSession"/>. | ||
/// </summary> | ||
/// <param name="session"></param> | ||
public void SafeInitialize(IAzureSession session) | ||
{ | ||
ConfigPath = ""; | ||
Initialize(session, new SafeConfigManager()); | ||
} | ||
|
||
/// <summary> | ||
/// Migrates independent configs to the new config framework. | ||
/// </summary> | ||
/// <param name="profilePath">Path of session profile where old config files are stored.</param> | ||
internal void MigrateConfigs(string profilePath) | ||
{ | ||
lock (_fsLock) | ||
// Migrate data collection config | ||
string dataCollectionConfigPath = Path.Combine(profilePath, AzurePSDataCollectionProfile.DefaultFileName); | ||
const string legacyConfigKey = "enableAzureDataCollection"; | ||
// Migrate only when: | ||
// 1. Old config file exists | ||
// 2. New config file does not exist | ||
if (DataStore.FileExists(dataCollectionConfigPath) && _configPathCandidates.All(path => !DataStore.FileExists(path))) | ||
{ | ||
// Migrate data collection config | ||
string dataCollectionConfigPath = Path.Combine(profilePath, AzurePSDataCollectionProfile.DefaultFileName); | ||
const string legacyConfigKey = "enableAzureDataCollection"; | ||
// Migrate only when: | ||
// 1. Old config file exists | ||
// 2. New config file does not exist | ||
if (DataStore.FileExists(dataCollectionConfigPath) && _configPathCandidates.All(path => !DataStore.FileExists(path))) | ||
try | ||
{ | ||
try | ||
string json = DataStore.ReadFileAsText(dataCollectionConfigPath); | ||
JObject root = JObject.Parse(json); | ||
if (root.TryGetValue(legacyConfigKey, out JToken jToken)) | ||
{ | ||
string json = DataStore.ReadFileAsText(dataCollectionConfigPath); | ||
JObject root = JObject.Parse(json); | ||
if (root.TryGetValue(legacyConfigKey, out JToken jToken)) | ||
{ | ||
bool enabled = ((bool)jToken); | ||
new JsonConfigHelper(ConfigPath, DataStore).Update(ConfigPathHelper.GetPathOfConfig(ConfigKeys.EnableDataCollection), enabled); | ||
} | ||
} | ||
catch (Exception) | ||
{ | ||
// do not throw for file IO exceptions | ||
bool enabled = ((bool)jToken); | ||
new JsonConfigHelper(ConfigPath, DataStore).Update(ConfigPathHelper.GetPathOfConfig(ConfigKeys.EnableDataCollection), enabled); | ||
} | ||
} | ||
catch (Exception) | ||
{ | ||
// do not throw for file IO exceptions | ||
} | ||
} | ||
} | ||
|
||
|
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why previous code didn't work? var dataStore = settings?.DataStore ?? new MockDataStore();