chore: Enhance error handling and user guidance in scripts and documentation

Author: Avijit-Microsoft

azure.yaml

@@ -18,7 +18,7 @@ hooks:
       run: |
         Write-Host "Web app URL: "
         Write-Host "$env:WEB_APP_URL" -ForegroundColor Cyan
-        Write-Host "`nRun the following command in your Bash terminal. It will grant the necessary permissions between resources and your user account, and also process and load the sample data into the application."
+        Write-Host "`nCreate and activate a virtual environment if not already done, then run the following command in your Bash terminal. It will grant the necessary permissions between resources and your user account, and also process and load the sample data into the application."
         Write-Host "bash ./infra/scripts/process_sample_data.sh" -ForegroundColor Cyan
       shell: pwsh
       continueOnError: false
@@ -28,7 +28,7 @@ hooks:
         echo "Web app URL: "
         echo $WEB_APP_URL
         echo ""
-        echo "Run the following command in your Bash terminal. It will grant the necessary permissions between resources and your user account, and also process and load the sample data into the application."
+        echo "Create and activate a virtual environment if not already done, then run the following command in your Bash terminal. It will grant the necessary permissions between resources and your user account, and also process and load the sample data into the application."
         echo "bash ./infra/scripts/process_sample_data.sh"
       shell: sh
       continueOnError: false

documents/DeploymentGuide.md

@@ -253,7 +253,7 @@ Once you've opened the project in [Codespaces](#github-codespaces), [Dev Contain
     - This deployment generally takes **7-10 minutes** to provision the resources in your account and set up the solution.
     - If you encounter an error or timeout during deployment, changing the location may help, as there could be availability constraints for the resources.
 
-5. Once the deployment has completed successfully, copy the bash command from terminal: (ex: `bash ./infra/scripts/process_sample_data.sh`) for later use.
+5. Once the deployment has completed successfully, continue with the following steps to process and load the sample data.
 
 6. Create and activate a virtual environment in bash terminal:
   

infra/scripts/copy_kb_files.sh

@@ -46,8 +46,22 @@ if ! az account show &> /dev/null; then
 fi
 
 # Check and assign Storage Blob Data Contributor role to current user
-signed_user_id=$(az ad signed-in-user show --query id --output tsv)
+signed_user_id=$(az ad signed-in-user show --query id --output tsv 2>&1)
+if [ -z "$signed_user_id" ] || [[ "$signed_user_id" == *"ERROR"* ]] || [[ "$signed_user_id" == *"InteractionRequired"* ]]; then
+    echo "✗ Failed to get signed-in user ID. Token may have expired. Re-authenticating..."
+    az login --use-device-code
+    signed_user_id=$(az ad signed-in-user show --query id --output tsv)
+    if [ -z "$signed_user_id" ]; then
+        echo "✗ Failed to get signed-in user ID after re-authentication"
+        exit 1
+    fi
+fi
+
 storage_resource_id=$(az storage account show --name "$storageAccountName" --resource-group "$resourceGroupName" --query id --output tsv)
+if [ -z "$storage_resource_id" ]; then
+    echo "✗ Failed to get storage account resource ID"
+    exit 1
+fi
 
 role_assignment=$(MSYS_NO_PATHCONV=1 az role assignment list --assignee $signed_user_id --role "Storage Blob Data Contributor" --scope $storage_resource_id --query "[].roleDefinitionId" -o tsv)
 if [ -z "$role_assignment" ]; then

infra/scripts/process_sample_data.sh

@@ -57,12 +57,21 @@ enable_public_access() {
 		--name "$storageAccountName" \
 		--resource-group "$resourceGroupName" \
 		--query "publicNetworkAccess" \
-		-o tsv)
+		-o tsv 2>&1)
+	if [ -z "$original_storage_public_access" ] || [[ "$original_storage_public_access" == *"ERROR"* ]]; then
+		echo "✗ Failed to get Storage Account public access status"
+		return 1
+	fi
+	
 	original_storage_default_action=$(az storage account show \
 		--name "$storageAccountName" \
 		--resource-group "$resourceGroupName" \
 		--query "networkRuleSet.defaultAction" \
-		-o tsv)
+		-o tsv 2>&1)
+	if [ -z "$original_storage_default_action" ] || [[ "$original_storage_default_action" == *"ERROR"* ]]; then
+		echo "✗ Failed to get Storage Account network default action"
+		return 1
+	fi
 
 	if [ "$original_storage_public_access" != "Enabled" ]; then
 		echo "✓ Enabling Storage Account public access"
@@ -356,7 +365,10 @@ if az account show &> /dev/null; then
 else
     # Use Azure CLI login if running locally
     echo "Authenticating with Azure CLI..."
-    az login --use-device-code
+    if ! az login --use-device-code; then
+        echo "✗ Failed to authenticate with Azure"
+        exit 1
+    fi
 fi
 
 if check_azd_installed; then
@@ -365,8 +377,12 @@ fi
 
 #check if user has selected the correct subscription
 echo ""
-currentSubscriptionId=$(az account show --query id -o tsv)
-currentSubscriptionName=$(az account show --query name -o tsv)
+currentSubscriptionId=$(az account show --query id -o tsv 2>/dev/null)
+currentSubscriptionName=$(az account show --query name -o tsv 2>/dev/null)
+if [ -z "$currentSubscriptionId" ] || [ -z "$currentSubscriptionName" ]; then
+    echo "✗ Failed to get current subscription information"
+    exit 1
+fi
 if [ "$currentSubscriptionId" != "$azSubscriptionId" ]; then
 	echo "Current selected subscription is $currentSubscriptionName ( $currentSubscriptionId )."
 	read -rp "Do you want to continue with this subscription?(y/n): " confirmation
@@ -399,11 +415,17 @@ if [ "$currentSubscriptionId" != "$azSubscriptionId" ]; then
 		done
 	else
 		echo "Proceeding with the current subscription: $currentSubscriptionName ( $currentSubscriptionId )"
-		az account set --subscription "$currentSubscriptionId"
+		if ! az account set --subscription "$currentSubscriptionId"; then
+			echo "✗ Failed to set subscription"
+			exit 1
+		fi
 	fi
 else
 	echo "Proceeding with the subscription: $currentSubscriptionName ( $currentSubscriptionId )"
-	az account set --subscription "$currentSubscriptionId"
+	if ! az account set --subscription "$currentSubscriptionId"; then
+		echo "✗ Failed to set subscription"
+		exit 1
+	fi
 fi
 echo ""
 

infra/scripts/run_create_index_scripts.sh

@@ -28,10 +28,21 @@ if ! az account show &> /dev/null; then
 fi
 
 # Get signed in user and store the output
-signed_user=$(az ad signed-in-user show --query "{id:id, displayName:displayName}" -o json)
+signed_user=$(az ad signed-in-user show --query "{id:id, displayName:displayName}" -o json 2>&1)
+if [[ "$signed_user" == *"ERROR"* ]] || [[ "$signed_user" == *"InteractionRequired"* ]] || [[ "$signed_user" == *"AADSTS"* ]]; then
+    echo "✗ Failed to get signed-in user. Token may have expired. Re-authenticating..."
+    az login --use-device-code
+    signed_user=$(az ad signed-in-user show --query "{id:id, displayName:displayName}" -o json)
+fi
+
 signed_user_id=$(echo "$signed_user" | grep -o '"id": *"[^"]*"' | head -1 | sed 's/"id": *"\([^"]*\)"/\1/')
 signed_user_display_name=$(echo "$signed_user" | grep -o '"displayName": *"[^"]*"' | sed 's/"displayName": *"\([^"]*\)"/\1/')
 
+if [ -z "$signed_user_id" ] || [ -z "$signed_user_display_name" ]; then
+    echo "✗ Failed to extract user information after authentication"
+    exit 1
+fi
+
 # Note: Environment variables are now passed as parameters from process_sample_data.sh
 
 ### Assign Azure AI User role to the signed in user for AI Foundry ###