refactor: Code quality fix #700

Kingshuk-Microsoft · 2026-02-10T10:27:46Z

Purpose

This pull request includes a variety of improvements and cleanups across the backend, frontend, and test codebases. The most significant changes focus on improving error handling and logging, refactoring exception usage, cleaning up unused imports, and making tests more robust and readable.

Backend Improvements:

Enhanced exception handling and logging throughout the backend, especially in orchestrator.py and cosmos_service.py, by catching specific exceptions, logging debug or warning messages, and avoiding silent failures. This increases observability and maintainability. [1] [2] [3] [4]
Removed unnecessary imports (such as asyncio and json) from several backend scripts and modules, reducing clutter and potential confusion. [1] [2] [3] [4] [5] [6]

Frontend and TypeScript Updates:

Cleaned up unused Fluent UI imports in frontend components and pages, simplifying the import statements and potentially reducing bundle size. [1] [2]
Fixed a test to properly mock the chat history rename API call, improving the reliability of the test suite.

Testing and E2E Test Improvements:

Updated exception handling in end-to-end tests to catch specific exceptions (Exception) instead of using bare except, improving error clarity and debugging. [1] [2] [3] [4]
Improved test logic and logging in several E2E tests, including more robust handling when no chat history is present, better section removal logic, and clearer pass/fail messages. [1] [2] [3] [4] [5]

Miscellaneous Cleanups:

Removed unused variables, refined import statements, and clarified output messages in various utility scripts and test files. [1] [2] [3] [4] [5] [6]
Minor constructor change in _AzureSearchSettings to ensure proper initialization of parent classes.
Minor fix in sample_content_generation.py to avoid unused assignment.

These changes collectively improve code quality, maintainability, and robustness across the project.

Does this introduce a breaking change?

Yes
No

Golden Path Validation

I have tested the primary workflows (the "golden path") to ensure they function correctly without errors.

Deployment Validation

I have validated the deployment process successfully and all services are running as expected with this change.

What to Check

GP Testing

… scripts

Copilot

Pull request overview

This PR focuses on code-quality cleanups and robustness improvements across backend services, utility scripts, frontend components, and test suites—primarily by tightening exception handling, improving logging/observability, and removing unused imports/variables.

Changes:

Improved exception handling/logging in backend orchestrator and Cosmos service to avoid silent failures and increase observability.
Cleaned up unused imports/variables across docs/scripts/frontend to reduce clutter and potential confusion.
Refined E2E/test logic for better reliability and readability (e.g., clearer branching, improved section removal selection).

Reviewed changes

Copilot reviewed 17 out of 17 changed files in this pull request and generated 9 comments.

Show a summary per file

File	Description
docs/generate_architecture_png.py	Removes unused locals and replaces bare `except` with specific exception handling for font loading.
docs/generate_architecture.py	Removes unused Azure network diagram import to simplify dependencies.
content-gen/tests/test_agents.py	Removes unused test imports to reduce noise in the unit test module.
content-gen/tests/rai_testing.py	Cleans up imports/flags and adjusts report output path printing (but introduces an auth dependency regression—see PR comments).
content-gen/src/backend/services/cosmos_service.py	Adds warning logging instead of silently swallowing cross-partition query failures.
content-gen/src/backend/orchestrator.py	Adds debug logging around best-effort JSON parsing and improves observability when compliance parsing fails.
content-gen/src/backend/app.py	Removes unused inline `asyncio` imports in request handlers.
content-gen/scripts/test_content_generation.py	Removes unused `json` import.
content-gen/scripts/sample_content_generation.py	Removes unused `os` import and avoids unused assignment when awaiting generation.
content-gen/scripts/post_deploy.py	Removes unused imports and tightens typing imports.
content-gen/scripts/create_image_search_index.py	Removes unused `json` import.
archive-doc-gen/tests/e2e-test/tests/test_st_docgen_tc.py	Refactors E2E test logic (exception specificity, section selection logic, logging/branch tweaks).
archive-doc-gen/tests/e2e-test/pages/draftPage.py	Removes unused `os` import.
archive-doc-gen/src/frontend/src/pages/chat/Chat.tsx	Removes unused Fluent UI imports to simplify the component import surface.
archive-doc-gen/src/frontend/src/components/ChatHistory/chatHistoryListItem.test.tsx	Adjusts rename test mocking/formatting (but leaves a test intent mismatch—see PR comments).
archive-doc-gen/src/frontend/src/components/ChatHistory/ChatHistoryListItem.tsx	Removes unused Fluent UI tooltip styles import.
archive-doc-gen/src/backend/settings.py	Attempts to ensure parent initializer execution for datasource settings (but introduces duplicate `__init__` issue—see PR comments).

Comments suppressed due to low confidence (1)

archive-doc-gen/src/backend/settings.py:262

This class does not call DatasourcePayloadConstructor.init during initialization. (_AzureSearchSettings.init may be missing a call to a base class init)
This class does not call DatasourcePayloadConstructor.init during initialization. (_AzureSearchSettings.init may be missing a call to a base class init)

class _AzureSearchSettings(BaseSettings, DatasourcePayloadConstructor):

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-02-10T10:32:29Z

content-gen/tests/rai_testing.py

+    # Azure Identity is optional; authentication features depending on it will be unavailable.
+    pass




The azure.identity import is now silently ignored (except ImportError: pass), but later _get_auth_headers() unconditionally references AzureCliCredential / InteractiveBrowserCredential. If azure-identity isn't installed and --use-azure-auth is used, this will raise NameError instead of cleanly disabling auth. Reintroduce an availability flag/guard, or move the import inside _get_auth_headers() and return a clear error when the dependency is missing.

Suggested change

# Azure Identity is optional; authentication features depending on it will be unavailable.

pass

# Azure Identity is optional; provide stubs that fail clearly if Azure auth is requested.

class _MissingAzureIdentityCredential:

def __init__(self, *args, **kwargs) -> None:

raise RuntimeError(

"The 'azure-identity' package is required to use '--use-azure-auth'. "

"Install it with 'pip install azure-identity' and try again."

)

AzureCliCredential = _MissingAzureIdentityCredential

InteractiveBrowserCredential = _MissingAzureIdentityCredential

Copilot · 2026-02-10T10:32:30Z

archive-doc-gen/src/backend/settings.py

+    def __init__(self, *args, settings: "_AppSettings", **data):
+        # Ensure DatasourcePayloadConstructor.__init__ runs so that _settings is initialized
+        super().__init__(*args, settings=settings, **data)
+


_AzureSearchSettings now defines __init__ twice; the later definition overwrites the earlier one, so the newly added initializer (meant to ensure DatasourcePayloadConstructor.__init__ runs) will never execute. Consolidate to a single init strategy (e.g., set _settings in model_post_init, or explicitly initialize the private attr once) so _settings is reliably set before construct_payload_configuration() uses it.

Copilot · 2026-02-10T10:32:30Z

content-gen/src/backend/orchestrator.py

+                                    except Exception as parse_error:
+                                        # Best-effort JSON extraction from markdown code block; on failure,
+                                        # fall back to the original prompt_text without interrupting image generation.
+                                        logger.debug(f"Failed to parse JSON from markdown code block for image prompt: {parse_error}")


This debug log uses an f-string, which eagerly formats even when debug logging is disabled. Prefer parameterized logging (logger.debug("… %s", parse_error)) and/or exc_info=True if you want traceback details.

Suggested change

logger.debug(f"Failed to parse JSON from markdown code block for image prompt: {parse_error}")

logger.debug(

"Failed to parse JSON from markdown code block for image prompt: %s",

parse_error,

)

Copilot · 2026-02-10T10:32:31Z

archive-doc-gen/src/frontend/src/components/ChatHistory/chatHistoryListItem.test.tsx

  test('shows error when trying to rename to an existing title', async () => {
-    const existingTitle = 'Existing Chat Title'
-      ; (historyRename as jest.Mock).mockResolvedValueOnce({
-        ok: false,
-        json: async () => ({ message: 'Title already exists' })
-      })
+    (historyRename as jest.Mock).mockResolvedValueOnce({
+      ok: false,
+      json: async () => ({ message: 'Title already exists' })
+    })


This test is titled as if it verifies renaming to an existing title, but it doesn’t actually attempt a rename to another conversation’s title (it changes the input to the current title) and the historyRename mock becomes effectively unused. Either update the test name/assertions to match the “unchanged title” validation, or change the input to a genuinely different existing title and assert on the API-driven error message.

Copilot · 2026-02-10T10:32:31Z

archive-doc-gen/tests/e2e-test/tests/test_st_docgen_tc.py

            assert thread_count > 0, "No chat history threads found to hover over"

-        if thread_count > 0:
+        if thread_count <= 0:


Test is always false, because of this condition.

Copilot · 2026-02-10T10:32:31Z

archive-doc-gen/tests/e2e-test/tests/test_st_docgen_tc.py

-            if current_responses_empty == initial_responses:
-                logger.info("✅ System did not accept empty query - no response generated")
-            else:
+            if current_responses_empty != initial_responses:


Test is always false, because of this condition.

Copilot · 2026-02-10T10:32:31Z

docs/generate_architecture.py

 from diagrams.azure.database import CosmosDb, BlobStorage
 from diagrams.azure.ml import CognitiveServices
-from diagrams.azure.network import VirtualNetworks, PrivateEndpoint, DNSZones
+from diagrams.azure.network import PrivateEndpoint, DNSZones


Import of 'DNSZones' is not used.

Suggested change

from diagrams.azure.network import PrivateEndpoint, DNSZones

from diagrams.azure.network import PrivateEndpoint

Copilot · 2026-02-10T10:32:32Z

content-gen/scripts/post_deploy.py

 from dataclasses import dataclass
 from pathlib import Path
-from typing import Optional, List, Dict, Any
+from typing import List, Dict, Any


Import of 'List' is not used.
Import of 'Any' is not used.

Suggested change

from typing import List, Dict, Any

from typing import Dict

Copilot · 2026-02-10T10:32:32Z

archive-doc-gen/tests/e2e-test/tests/test_st_docgen_tc.py


-        if thread_count > 0:
+        if thread_count <= 0:
+            logger.warning("Skipping hover action: no chat history threads available.")


This statement is unreachable.

fix: remove unused imports and improve error handling across multiple…

1ffd109

… scripts

Kingshuk-Microsoft requested a review from Copilot February 10, 2026 10:28

Copilot started reviewing on behalf of Kingshuk-Microsoft February 10, 2026 10:28 View session

Kingshuk-Microsoft requested review from Avijit-Microsoft, Fr4nc3, Prajwal-Microsoft, Roopan-Microsoft, Vinay-Microsoft, aniaroramsft, dgp10801, marktayl1, nchandhi and toherman-msft February 10, 2026 10:28

Copilot AI reviewed Feb 10, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: Code quality fix #700

refactor: Code quality fix #700

Uh oh!

Kingshuk-Microsoft commented Feb 10, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Feb 10, 2026

Uh oh!

Copilot AI Feb 10, 2026

Uh oh!

Copilot AI Feb 10, 2026

Uh oh!

Copilot AI Feb 10, 2026

Uh oh!

Copilot AI Feb 10, 2026

Uh oh!

Copilot AI Feb 10, 2026

Uh oh!

Copilot AI Feb 10, 2026

Uh oh!

Copilot AI Feb 10, 2026

Uh oh!

Copilot AI Feb 10, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

		# Azure Identity is optional; authentication features depending on it will be unavailable.
		pass

-    # Azure Identity is optional; authentication features depending on it will be unavailable.
-    pass
+    # Azure Identity is optional; provide stubs that fail clearly if Azure auth is requested.
+    class _MissingAzureIdentityCredential:
+        def __init__(self, *args, **kwargs) -> None:
+            raise RuntimeError(
+                "The 'azure-identity' package is required to use '--use-azure-auth'. "
+                "Install it with 'pip install azure-identity' and try again."
+            )
+    AzureCliCredential = _MissingAzureIdentityCredential
+    InteractiveBrowserCredential = _MissingAzureIdentityCredential

	from diagrams.azure.network import PrivateEndpoint, DNSZones
	from diagrams.azure.network import PrivateEndpoint

refactor: Code quality fix #700

Are you sure you want to change the base?

refactor: Code quality fix #700

Uh oh!

Conversation

Kingshuk-Microsoft commented Feb 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Purpose

Does this introduce a breaking change?

Golden Path Validation

Deployment Validation

What to Check

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Feb 10, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 10, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 10, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 10, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 10, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 10, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 10, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 10, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 10, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Kingshuk-Microsoft commented Feb 10, 2026 •

edited

Loading