Implemented caching mechanism for tab completion results. Would appreciate a quick code review.

pcgeek86 · pcgeek86 · commit b1d99d34aac9 · 2015-04-27T22:29:46.000-06:00
diff --git a/Microsoft.Azure.ArgumentCompleters.ps1 b/Microsoft.Azure.ArgumentCompleters.ps1
@@ -21,6 +21,8 @@ function StorageAccount_StorageAccountNameCompleter
 
     $CacheKey = 'StorageAccount_StorageAccountNameCache';
     $StorageAccountNameCache = Get-CompletionPrivateData -Key $CacheKey;
+
+    ### Return the cached value if it has not expired
     if ($StorageAccountNameCache) {
         return $StorageAccountNameCache;
     }
diff --git a/TabExpansion++.psm1 b/TabExpansion++.psm1
@@ -134,9 +134,19 @@ function Set-CompletionPrivateData
         $Key,
 
         [object]
-        $Value)
+        $Value,
 
-    $completionPrivateData[$key] = $value
+        [ValidateNotNullOrEmpty()]
+        [int]
+        $ExpirationSeconds = 20
+        )
+
+    $Cache = [PSCustomObject]@{
+        Value = $Value;
+        ExpirationTime = (Get-Date).AddSeconds($ExpirationSeconds);
+        };
+    Add-Content -Path TabExpansion.log -Value ('Setting cache expiration time to: {0}. Key is: {1}' -f $Cache.ExpirationTime, $Key);
+    $completionPrivateData[$key] = $Cache;
 }
 
 #############################################################################
@@ -148,8 +158,12 @@ function Get-CompletionPrivateData
         [string]
         $Key)
 
-    Flush-BackgroundResultsQueue
-    return $completionPrivateData[$key]
+    Flush-BackgroundResultsQueue;
+
+    $cacheValue = $completionPrivateData[$key];
+    if ((Get-Date) -lt $cacheValue.ExpirationTime) {
+        return $cacheValue.Value;
+    }
 }
 
 #############################################################################
@@ -562,7 +576,15 @@ function Update-ArgumentCompleter
 #############################################################################
 #
 # .SYNOPSIS
+# Retrieves a list of argument completers that have been loaded into the
+# PowerShell session.
+#
+# .PARAMETER Name
+# The name of the argument complete to retrieve. This parameter supports 
+# wildcards (asterisk).
 #
+# .EXAMPLE
+# Get-ArgumentComplete
 function Get-ArgumentCompleter
 {
     [CmdletBinding()]
@@ -796,7 +818,7 @@ function Flush-BackgroundResultsQueue
         $parameters = $item.Value
         if ($item.ArgumentCompleter)
         {
-            Register-ArgumentCompleter @parameters
+            TabExpansion++\Register-ArgumentCompleter @parameters
         }
         elseif ($item.InitializationData)
         {

Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,8 @@ function StorageAccount_StorageAccountNameCompleter`
`21`	`21`
`22`	`22`	`$CacheKey = 'StorageAccount_StorageAccountNameCache';`
`23`	`23`	`$StorageAccountNameCache = Get-CompletionPrivateData -Key $CacheKey;`
	`24`	`+`
	`25`	`+ ### Return the cached value if it has not expired`
`24`	`26`	`if ($StorageAccountNameCache) {`
`25`	`27`	`return $StorageAccountNameCache;`
`26`	`28`	`}`