Fix duplicate text (#13326)

* Improve the debugging experience.

- GetSuggestion gets cancelled during debugging because it times out. So
  we use an environment variable to control whether to allow
cancellation from psreadline.
- Use another macro to control if print message for telemetry.

* Fix a bug that the command line is repeated in the suggestion.

- When we parse the command line and there is an incomplete parameter
  list, we repeat the command line in the suggestion.
- The cause is that we parse the command line and get the wrong
  parameter set from the user input

Author: kceiw

tools/Az.Tools.Predictor/Az.Tools.Predictor.Test/AzPredictorServiceTests.cs

@@ -1,4 +1,4 @@
-// ----------------------------------------------------------------------------------
+// ----------------------------------------------------------------------------------
 //
 // Copyright Microsoft Corporation
 // Licensed under the Apache License, Version 2.0 (the "License");

tools/Az.Tools.Predictor/Az.Tools.Predictor.Test/AzPredictorTests.cs

@@ -146,5 +146,26 @@ public void VerifySuggestion(string userInput)
 
             Assert.Equal(expected.Select(e => e.Item1), actual.Select(a => a.SuggestionText));
         }
+
+        /// <summary>
+        /// Verifies that we still return correct prediction when the user has input an incomplete command line.
+        /// </summary>
+        [Fact]
+        public void VerifySuggestionOnIncompleteCommand()
+        {
+            // We need to get the suggestions for more than one. So we create a local version az predictor.
+            var localAzPredictor = new AzPredictor(this._service, this._telemetryClient, new Settings()
+            {
+                SuggestionCount = 7,
+            });
+
+            var userInput = "New-AzResourceGroup -Name 'ResourceGroup01' -Location 'Central US' -WhatIf -";
+            var expected = "New-AzResourceGroup -Name 'ResourceGroup01' -Location 'Central US' -WhatIf -Verbose ***";
+
+            var predictionContext = PredictionContext.Create(userInput);
+            var actual = localAzPredictor.GetSuggestion(predictionContext, CancellationToken.None);
+
+            Assert.Equal(expected, actual.First().SuggestionText);
+        }
     }
 }

tools/Az.Tools.Predictor/Az.Tools.Predictor/AzPredictor.cs

@@ -158,9 +158,13 @@ public List<PredictiveSuggestion> GetSuggestion(PredictionContext context, Cance
 
             try
             {
-                suggestions = _service.GetSuggestion(context.InputAst, _settings.SuggestionCount.Value, cancellationToken);
+                suggestions = _service.GetSuggestion(context.InputAst, _settings.SuggestionCount.Value, Settings.ContinueOnTimeout ? CancellationToken.None : cancellationToken);
+
+                if (!Settings.ContinueOnTimeout)
+                {
+                    cancellationToken.ThrowIfCancellationRequested();
+                }
 
-                cancellationToken.ThrowIfCancellationRequested();
                 var userInput = context.InputAst.Extent.Text;
                 return suggestions.Select((r, index) =>
                     {

tools/Az.Tools.Predictor/Az.Tools.Predictor/AzPredictorTelemetryClient.cs

@@ -18,9 +18,7 @@
 using Newtonsoft.Json;
 using System;
 using System.Collections.Generic;
-using System.Diagnostics;
 using System.Globalization;
-using System.IO;
 
 namespace Microsoft.Azure.PowerShell.Tools.AzPredictor
 {
@@ -69,7 +67,7 @@ public void OnHistory(string historyLine)
 
             _telemetryClient.TrackEvent($"{AzPredictorTelemetryClient.TelemetryEventPrefix}/CommandHistory", currentLog);
 
-#if DEBUG
+#if TELEMETRY_TRACE && DEBUG
             Console.WriteLine("Recording CommandHistory");
 #endif
         }
@@ -93,7 +91,7 @@ public void OnRequestPrediction(string command)
 
             _telemetryClient.TrackEvent($"{AzPredictorTelemetryClient.TelemetryEventPrefix}/RequestPrediction", currentLog);
 
-#if DEBUG
+#if TELEMETRY_TRACE && DEBUG
             Console.WriteLine("Recording RequestPrediction");
 #endif
         }
@@ -116,7 +114,7 @@ public void OnRequestPredictionError(string command, Exception e)
 
             _telemetryClient.TrackEvent($"{AzPredictorTelemetryClient.TelemetryEventPrefix}/RequestPredictionError", currentLog);
 
-#if DEBUG
+#if TELEMETRY_TRACE && DEBUG
             Console.WriteLine("Recording RequestPredictionError");
 #endif
         }
@@ -138,7 +136,7 @@ public void OnSuggestionAccepted(string acceptedSuggestion)
 
             _telemetryClient.TrackEvent($"{AzPredictorTelemetryClient.TelemetryEventPrefix}/AcceptSuggestion", properties);
 
-#if DEBUG
+#if TELEMETRY_TRACE && DEBUG
             Console.WriteLine("Recording AcceptSuggestion");
 #endif
         }
@@ -162,7 +160,7 @@ public void OnGetSuggestion(string maskedUserInput, IEnumerable<ValueTuple<strin
 
             _telemetryClient.TrackEvent($"{AzPredictorTelemetryClient.TelemetryEventPrefix}/GetSuggestion", properties);
 
-#if DEBUG
+#if TELEMETRY_TRACE && DEBUG
             Console.WriteLine("Recording GetSuggestioin");
 #endif
         }
@@ -184,7 +182,7 @@ public void OnGetSuggestionError(Exception e)
 
             _telemetryClient.TrackEvent($"{AzPredictorTelemetryClient.TelemetryEventPrefix}/GetSuggestionError", properties);
 
-#if DEBUG
+#if TELEMETRY_TRACE && DEBUG
             Console.WriteLine("Recording GetSuggestioinError");
 #endif
         }

tools/Az.Tools.Predictor/Az.Tools.Predictor/ParameterSet.cs

@@ -45,6 +45,19 @@ public ParameterSet(CommandAst commandAst)
                     param = elem;
                     arg = null;
                 }
+                else if (AzPredictorConstants.ParameterIndicator == elem?.ToString().Trim().FirstOrDefault())
+                {
+                    // We have an incomplete command line such as
+                    // `New-AzResourceGroup -Name ResourceGroup01 -Location WestUS -`
+                    // We'll ignore the incomplete parameter.
+                    if (param != null)
+                    {
+                        Parameters.Add(new Tuple<string, string>(param.ToString(), arg?.ToString()));
+                    }
+
+                    param = null;
+                    arg = null;
+                }
                 else
                 {
                     arg = elem;

tools/Az.Tools.Predictor/Az.Tools.Predictor/Settings.cs

@@ -41,6 +41,36 @@ sealed class Settings
         /// </summary>
         public int? SuggestionCount { get; set; }
 
+        private static bool? _isContinueOnTimeout;
+        /// <summary>
+        /// Gets the value to indicate whether to ignore cancellation request and keep running.
+        /// This should be only set during debugging.
+        /// </summary>
+        [JsonIgnore]
+        internal static bool ContinueOnTimeout
+        {
+            get
+            {
+                if (_isContinueOnTimeout.HasValue)
+                {
+                    return _isContinueOnTimeout.Value;
+                }
+
+                var envValue = Environment.GetEnvironmentVariable("AzPredictorContinueOnTimeout");
+
+                if (bool.TryParse(envValue, out bool envBoolValue))
+                {
+                    _isContinueOnTimeout = envBoolValue;
+                }
+                else
+                {
+                    _isContinueOnTimeout = false;
+                }
+
+                return _isContinueOnTimeout.Value;
+            }
+        }
+
         /// <summary>
         /// Gets an instance of the settings.
         /// </summary>