Pause and repeat request when receive throttling (error 429) #88

Author: NowinskiK

source/Private/Test-FabricApiResponse.ps1

@@ -76,7 +76,6 @@ function Test-FabricApiResponse {
     #$responseHeader = $script:responseHeader
     #$statusCode = $script:statusCode
     $result = $null
-
     Write-Message -Message "Testing API response for '$Operation' operation. StatusCode: $statusCode." -Level Debug
 
     switch ($statusCode) {
@@ -122,6 +121,15 @@ function Test-FabricApiResponse {
                 return $operationStatus
             }
         }
+        429 {
+            Write-Message -Message "API rate limit exceeded. Status Code: $statusCode ($($Response.errorCode))" -Level Warning
+            Write-Message -Message "$($Response.message). Waiting $($responseHeader['Retry-After']) seconds..." -Level Warning
+            $retryAfter = $responseHeader['Retry-After']
+            $retryAfterStr = $retryAfter[0].ToString()
+            $retryAfterInt = [int]$retryAfterStr
+            Start-Sleep -Seconds $retryAfterInt
+            return "Command:Repeat"
+        }
         default {
             Write-Message -Message "Test-FabricApiResponse::default" -Level Debug
             Write-Message -Message "Unexpected response code: $statusCode from the API." -Level Error

source/Public/Deployment Pipeline/New-FabricDeploymentPipeline.ps1

@@ -108,6 +108,6 @@ function New-FabricDeploymentPipeline {
     } catch {
         # Step 6: Error handling
         $errorDetails = $_.Exception.Message
-        Write-Message -Message "Failed to create deployment pipeline. Error: $errorDetails" -Level Error
+        Write-Error -Message "Failed to create deployment pipeline. Error: $errorDetails"
     }
 }

source/Public/Invoke-FabricRestMethod.ps1

@@ -105,40 +105,46 @@ Function Invoke-FabricRestMethod {
         Write-Message -Message "No request body provided." -Level Debug
     }
 
-    $request = @{
-        Headers = $FabricSession.HeaderParams
-        Uri = $Uri
-        Method = $Method
-        Body = $Body
-        ContentType = "application/json"
-        ErrorAction = 'Stop'
-        SkipHttpErrorCheck = $true
-        ResponseHeadersVariable = "responseHeader"
-        StatusCodeVariable = "statusCode"
-    }
-    $response = Invoke-RestMethod @request
+    $repeat = $false
+    do {
+
+        $request = @{
+            Headers = $FabricSession.HeaderParams
+            Uri = $Uri
+            Method = $Method
+            Body = $Body
+            ContentType = "application/json"
+            ErrorAction = 'Stop'
+            SkipHttpErrorCheck = $true
+            ResponseHeadersVariable = "responseHeader"
+            StatusCodeVariable = "statusCode"
+        }
+        $response = Invoke-RestMethod @request
 
-    Write-Message -Message "Result response code: $statusCode" -Level Debug
-    if ($response) {
-        Write-Message -Message "Result return: $response" -Level Debug
-    }
-    # Needed for backward compatibility, example: Get-FabricWorkspace
-    $script:statusCode = $statusCode
-    $script:responseHeader = $responseHeader
-
-    if ($HandleResponse) {
-        $params = @{
-            Response = $response
-            ResponseHeader = $responseHeader
-            StatusCode = $statusCode
-            Operation = (Get-PSCallStack)[1].Command.Split('-')[0]
-            ObjectIdOrName = $ObjectIdOrName
-            TypeName = $TypeName
-            NoWait = $NoWait
-            SuccessMessage = $SuccessMessage
+        Write-Message -Message "Result response code: $statusCode" -Level Debug
+        if ($response) {
+            Write-Message -Message "Result return: $response" -Level Debug
         }
-        $response = Test-FabricApiResponse @params
-    }
+        # Needed for backward compatibility, example: Get-FabricWorkspace
+        $script:statusCode = $statusCode
+        $script:responseHeader = $responseHeader
+
+        if ($HandleResponse) {
+            $params = @{
+                Response = $response
+                ResponseHeader = $responseHeader
+                StatusCode = $statusCode
+                Operation = (Get-PSCallStack)[1].Command.Split('-')[0]
+                ObjectIdOrName = $ObjectIdOrName
+                TypeName = $TypeName
+                NoWait = $NoWait
+                SuccessMessage = $SuccessMessage
+            }
+            $response = Test-FabricApiResponse @params
+            $repeat = $response -is [string] -and $response -eq "Command:Repeat"
+        }
+
+    } while ($repeat)
 
     Write-Message -Message "::End" -Level Debug
     $response