upgrade for new survey machenism (#19285)

* revise code

* revise code

* generate help markdown file

* revise code

* Revise code

* revise code

* revise code

* test common 1.0.0-preview

* revise code

* add dependency on new common lib and add change log

* revise change log

Co-authored-by: [email protected] <[email protected]>
Co-authored-by: Yunchi Wang <[email protected]>

Author: 3 people

src/Accounts/Accounts/Account/ConnectAzureRmAccount.cs

@@ -44,6 +44,7 @@
 using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
 using Microsoft.WindowsAzure.Commands.Common.Utilities;
 using Microsoft.WindowsAzure.Commands.Utilities.Common;
+using Microsoft.Azure.PowerShell.Common.Share.Survey;
 
 namespace Microsoft.Azure.Commands.Profile
 {
@@ -680,7 +681,7 @@ public void OnImport()
 #if DEBUG
                 }
 #endif
-
+                SurveyHelper.GetInstance().updateSurveyHelper(AzureSession.Instance.ExtendedProperties["InstallationId"]);
                 var autoSaveEnabled = AzureSession.Instance.ARMContextSaveMode == ContextSaveMode.CurrentUser;
                 var autosaveVariable = System.Environment.GetEnvironmentVariable(AzureProfileConstants.AzureAutosaveVariable);
 

src/Accounts/Accounts/ChangeLog.md

@@ -20,6 +20,8 @@
 
 ## Upcoming Release
 * Supported returning all subscriptions with specified name while using `Get-AzSubscription` with parameter `SubscriptionName`. [#19295]
+* Fixed null reference exception when cmdlet uses AzureRestOperation [#18104]
+* Updated survey message and settings
 
 ## Version 2.9.1
 * Implemented `SupportsShouldProcess` for `Invoke-AzRestMethod`

src/Accounts/Accounts/Feedback/OpenAzSurveyLinkCmdlet.cs

@@ -13,29 +13,44 @@
 // ----------------------------------------------------------------------------------
 
 using Microsoft.Azure.Commands.Common.Authentication.Abstractions;
+using Microsoft.Azure.Commands.Common.Authentication;
+using Microsoft.Azure.PowerShell.Common.Share.Survey;
 using Microsoft.WindowsAzure.Commands.Utilities.Common;
 using System;
 using System.Diagnostics;
 using System.Management.Automation;
 using System.Runtime.InteropServices;
+using System.IO;
+using Newtonsoft.Json;
 
 namespace Microsoft.Azure.Commands.Profile.Survey
 {
     [Cmdlet(VerbsCommon.Open, ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "SurveyLink"), OutputType(typeof(void))]
     public class OpenAzSurveyLinkCmdlet : AzurePSCmdlet
     {
-        private const string _surveyLinkFormat = "https://aka.ms/azpssurvey?Q_CHL=INTERCEPT";
-
         protected override IAzureContext DefaultContext => null;
 
         protected override string DataCollectionWarning => null;
 
         public override void ExecuteCmdlet()
         {
-            WriteInformation(new HostInformationMessage() { Message = $"Opening the default browser to {_surveyLinkFormat}" }, new string[] { "PSHOST" });
-            OpenBrowser(_surveyLinkFormat);
+            DateTime today = DateTime.UtcNow;
+            AzureSession.Instance.ExtendedProperties.TryGetValue("InstallationId", out string InstallationId);
+            String version= AzurePSCmdlet.AzVersion;
+            int gapDays = -1;
+
+            ScheduleInfo scheduleInfo = SurveyHelper.GetInstance().GetScheduleInfo();
+            DateTime LastPromptDate = Convert.ToDateTime(scheduleInfo?.LastPromptDate);
+            if (LastPromptDate != DateTime.MinValue){
+                TimeSpan ts = today.Subtract(LastPromptDate);
+                gapDays = (int) ts.TotalDays;
+            }
+            String svLink = $"https://go.microsoft.com/fwlink/?linkid=2201766&ID={InstallationId}&v={version}&d={gapDays}";
+            WriteInformation(new HostInformationMessage() { Message = $"Opening the default browser to {svLink}" }, new string[] { "PSHOST" });
+            OpenBrowser(svLink);
         }
 
+
         private void OpenBrowser(string url)
         {
             try

src/Accounts/Accounts/help/Clear-AzConfig.md

@@ -22,7 +22,7 @@ Clear-AzConfig [-Force] [-PassThru] [-AppliesTo <String>] [-Scope <ConfigScope>]
 ```
 Clear-AzConfig [-PassThru] [-AppliesTo <String>] [-Scope <ConfigScope>]
  [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [-DefaultSubscriptionForLogin]
- [-DisplayBreakingChangeWarning] [-EnableDataCollection] [<CommonParameters>]
+ [-DisplayBreakingChangeWarning] [-DisplaySurveyMessage] [-EnableDataCollection] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -114,6 +114,21 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### -DisplaySurveyMessage
+When enabled, you are prompted infrequently to participate in user experience surveys for Azure PowerShell.
+
+```yaml
+Type: System.Management.Automation.SwitchParameter
+Parameter Sets: ClearByKey
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -EnableDataCollection
 When enabled, Azure PowerShell cmdlets send telemetry data to Microsoft to improve the customer experience.
 For more information, see our privacy statement: https://aka.ms/privacy

src/Accounts/Accounts/help/Get-AzConfig.md

@@ -14,7 +14,8 @@ Gets the configs of Azure PowerShell.
 
 ```
 Get-AzConfig [-AppliesTo <String>] [-Scope <ConfigScope>] [-DefaultProfile <IAzureContextContainer>]
- [-DefaultSubscriptionForLogin] [-DisplayBreakingChangeWarning] [-EnableDataCollection] [<CommonParameters>]
+ [-DefaultSubscriptionForLogin] [-DisplayBreakingChangeWarning] [-DisplaySurveyMessage] [-EnableDataCollection]
+ [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -125,6 +126,21 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### -DisplaySurveyMessage
+When enabled, you are prompted infrequently to participate in user experience surveys for Azure PowerShell.
+
+```yaml
+Type: System.Management.Automation.SwitchParameter
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -EnableDataCollection
 When enabled, Azure PowerShell cmdlets send telemetry data to Microsoft to improve the customer experience.
 For more information, see our privacy statement: https://aka.ms/privacy

src/Accounts/Accounts/help/Update-AzConfig.md

@@ -15,7 +15,7 @@ Updates the configs of Azure PowerShell.
 ```
 Update-AzConfig [-AppliesTo <String>] [-Scope <ConfigScope>] [-DefaultProfile <IAzureContextContainer>]
  [-WhatIf] [-Confirm] [-DefaultSubscriptionForLogin <String>] [-DisplayBreakingChangeWarning <Boolean>]
- [-EnableDataCollection <Boolean>] [<CommonParameters>]
+ [-DisplaySurveyMessage <Boolean>] [-EnableDataCollection <Boolean>] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -137,6 +137,21 @@ Accept pipeline input: True (ByPropertyName)
 Accept wildcard characters: False
 ```
 
+### -DisplaySurveyMessage
+When enabled, you are prompted infrequently to participate in user experience surveys for Azure PowerShell.
+
+```yaml
+Type: System.Boolean
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: True (ByPropertyName)
+Accept wildcard characters: False
+```
+
 ### -EnableDataCollection
 When enabled, Azure PowerShell cmdlets send telemetry data to Microsoft to improve the customer experience.
 For more information, see our privacy statement: https://aka.ms/privacy

src/Accounts/Authentication/Authentication.csproj

@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
     <PsModuleName>Accounts</PsModuleName>

src/Accounts/Authentication/AzureSessionInitializer.cs

@@ -26,6 +26,8 @@
 using Microsoft.Azure.Commands.Common.Authentication.Properties;
 using Microsoft.Azure.Commands.Common.Authentication.Config;
 using Newtonsoft.Json;
+using Microsoft.Azure.Commands.Common.Authentication.Models;
+
 
 using TraceLevel = System.Diagnostics.TraceLevel;
 using System.Collections.Generic;
@@ -39,6 +41,7 @@ namespace Microsoft.Azure.Commands.Common.Authentication
     public static class AzureSessionInitializer
     {
         private const string ContextAutosaveSettingFileName = ContextAutosaveSettings.AutoSaveSettingsFile;
+
         private const string DataCollectionFileName = AzurePSDataCollectionProfile.DefaultFileName;
 
         /// <summary>
@@ -173,7 +176,14 @@ static ContextAutosaveSettings InitializeSessionSettings(IDataStore store, strin
                     result.ContextDirectory = migrated ? profileDirectory : settings.ContextDirectory ?? result.ContextDirectory;
                     result.Mode = settings.Mode;
                     result.ContextFile = settings.ContextFile ?? result.ContextFile;
-                    if (migrated)
+                    result.Settings = settings.Settings;
+                    bool updateSettings = false;
+                    if (!settings.Settings.ContainsKey("InstallationId"))
+                    {
+                        result.Settings.Add("InstallationId", GetAzureCLIInstallationId(store) ?? Guid.NewGuid().ToString());
+                        updateSettings = true;
+                    }
+                    if (migrated || updateSettings)
                     {
                         string autoSavePath = Path.Combine(profileDirectory, settingsFile);
                         store.WriteFile(autoSavePath, JsonConvert.SerializeObject(result));
@@ -188,6 +198,7 @@ static ContextAutosaveSettings InitializeSessionSettings(IDataStore store, strin
                     }
                     string autoSavePath = Path.Combine(profileDirectory, settingsFile);
                     result.Mode = ContextSaveMode.CurrentUser;
+                    result.Settings.Add("InstallationId", GetAzureCLIInstallationId(store) ?? Guid.NewGuid().ToString());
                     store.WriteFile(autoSavePath, JsonConvert.SerializeObject(result));
                 }
             }
@@ -202,6 +213,24 @@ static ContextAutosaveSettings InitializeSessionSettings(IDataStore store, strin
             return result;
         }
 
+        private static String GetAzureCLIInstallationId(IDataStore store){
+            if (store.FileExists(AzCLIProfileInfo.AzCLIProfileFile))
+            {
+                try
+                {
+                    AzCLIProfileInfo azInfo = JsonConvert.DeserializeObject<AzCLIProfileInfo>(store.ReadFileAsText(AzCLIProfileInfo.AzCLIProfileFile));
+                    if (!string.IsNullOrEmpty(azInfo?.installationId))
+                    {
+                        return azInfo.installationId;
+                    }
+                }
+                catch (Exception)
+                {
+                    TracingAdapter.Information($"[AzureSessionInitializer]: Cannot read Azure CLI profile from {AzCLIProfileInfo.AzCLIProfileFile}");
+                }
+            }
+            return null;
+        }
         static void InitializeDataCollection(IAzureSession session)
         {
             session.RegisterComponent(DataCollectionController.RegistryKey, () => DataCollectionController.Create(session));
@@ -239,7 +268,8 @@ static IAzureSession CreateInstance(IDataStore dataStore = null, Action<string>
             session.ARMProfileFile = autoSave.ContextFile;
             session.TokenCacheDirectory = autoSave.CacheDirectory;
             session.TokenCacheFile = autoSave.CacheFile;
-
+            autoSave.Settings.TryGetValue("InstallationId", out string installationId);
+            session.ExtendedProperties.Add("InstallationId", installationId);
             InitializeConfigs(session, profilePath, writeWarning);
             InitializeDataCollection(session);
             session.RegisterComponent(HttpClientOperationsFactory.Name, () => HttpClientOperationsFactory.Create());

src/Accounts/Authentication/Config/ConfigInitializer.cs

@@ -191,8 +191,7 @@ private void RegisterConfigs(IConfigManager configManager)
                 AzurePSDataCollectionProfile.EnvironmentVariableName,
                 new[] { AppliesTo.Az }));
 
-            // configs with their own types
-            // configManager.RegisterConfig(new EnableInterceptSurveyConfig()); // todo: uncomment after improvements are made to survey
+            configManager.RegisterConfig(new EnableInterceptSurveyConfig());
             configManager.RegisterConfig(new DisplayBreakingChangeWarningsConfig());
         }
     }

src/Accounts/Authentication/Config/Definitions/EnableInterceptSurveyConfig.cs

@@ -36,15 +36,14 @@ internal class EnableInterceptSurveyConfig : TypedConfig<bool>
 
         public override string ParseFromEnvironmentVariables(IReadOnlyDictionary<string, string> environmentVariables)
         {
-            if (environmentVariables.TryGetValue("Azure_PS_Intercept_Survey", out string configString))
+            environmentVariables.TryGetValue("Azure_PS_Intercept_Survey", out string oldConfigString);
+            environmentVariables.TryGetValue("AzSurveyMessage", out string configString);
+
+            if (string.Equals(Boolean.FalseString, oldConfigString, StringComparison.OrdinalIgnoreCase)  || string.Equals(Boolean.FalseString, configString, StringComparison.OrdinalIgnoreCase))
             {
-                if ("Disabled".Equals(configString, StringComparison.OrdinalIgnoreCase)
-                    || "False".Equals(configString, StringComparison.OrdinalIgnoreCase))
-                {
-                    return false.ToString();
-                }
+                return Boolean.FalseString;
             }
-            return null;
+            return string.Empty;
         }
     }
 }