Corrected: Improved AQUA Error Messages for Authorization and Tag-Related Uses #1141

elizjo · 2025-03-31T22:40:48Z

Currently, the AQUA UI throws generic errors when auth issues arise- not informing the user of potential solutions and suggested policy additions to fix the error.

Added 'troubleshooting_tips' section (see example json below)

links to the specific section (as specified by the operation error from the OCI Service Error) to our AQUA troubleshooting page
result : user will obtain a specific action to fix their auth issue

Distinguish between Auth error versus tag related error.

certain operations have two methods for failure- auth related and tag related. We use the OCI Service Error to single out 'Invalid tag' errors for the create_model and update_model operations
result: user obtains a different fix for a tag-related error vs. an auth error

Refactored write_error in used in base_handler.py and WS handlers to utils.py (basically common code between these handlers were stuck into a single file)

Passed all test cases

{
  "status": 404,
  "troubleshooting_tips": "Unable to list model deployments. See tips for troubleshooting: https://github.com/oracle-samples/oci-data-science-ai-samples/blob/main/ai-quick-actions/troubleshooting-tips.md#list-model-deployments",
  "message": "Authorization Failed: The resource you're looking for isn't accessible. Operation Name: list_model_deployments.",
  "service_payload": {
    "target_service": "data_science",
    "status": 404,

github-actions · 2025-03-31T23:11:14Z

📌 Cov diff with main:

📌 Overall coverage:

VipulMascarenhas

There's one test failing in test_model_handler.py, can you please fix it?

mayoor · 2025-04-01T02:53:25Z

ads/aqua/extension/utils.py

+
+        if operation_name:
+            if operation_name.startswith("create"):
+                return f"{messages['create']} Operation Name: {operation_name}."


We need to check the status code before determining if this is an auth failure. If we give wrong input parameters, create can fail. Usually the wrong param happens because user have selected a shape which is not GA in the chosen region

mayoor · 2025-04-01T02:56:36Z

ads/aqua/extension/utils.py

+    return tip
+
+
+def construct_error(status_code, **kwargs) -> tuple[dict[str, int], str, str]:


status_code missing type

mayoor · 2025-04-01T02:59:07Z

ads/aqua/extension/utils.py

+    return f"https://github.com/oracle-samples/oci-data-science-ai-samples/blob/main/ai-quick-actions/troubleshooting-tips.md#{github_header}"
+
+
+def get_troubleshooting_tips(service_payload: str,


payload is Dict?

mayoor · 2025-04-01T03:02:36Z

ads/aqua/extension/utils.py

+        "message": message,
+        "service_payload": service_payload,
+        "reason": reason,
+        "request_id": str(uuid.uuid4()),


How does the request id help here?

@mrDzurb @VipulMascarenhas we should consider tracing our APIs so that we can use this request id for checking in lumberjack.

This is for later. For this PR we can leave this as is

Not sure about if this request_id is used somewhere? Maybe we use it somehow on UI side?

the request id is logged in lumberjack with the request id, and we print it in the local notebook logs for errors or when CLI is used - but request id is not shown in the UI yet. We'll need a UI change to show this alongside the error message.

…omments

github-actions · 2025-04-02T01:29:50Z

📌 Cov diff with main:

📌 Overall coverage:

mrDzurb · 2025-04-01T03:30:10Z

ads/aqua/extension/utils.py

+        "message": message,
+        "service_payload": service_payload,
+        "reason": reason,
+        "request_id": str(uuid.uuid4()),


Not sure about if this request_id is used somewhere? Maybe we use it somehow on UI side?

mrDzurb · 2025-04-02T05:18:48Z

ads/aqua/constants.py

+        "put_object": "Unable to access or find Object Storage Bucket. See tips for troubleshooting: ",
+        "list_model_version_sets": "Unable to create or fetch model version set. See tips for troubleshooting:",
+        "update_model": "Unable to update model. See tips for troubleshooting: ",
+        "list_data_science_private_endpoints": "Unable to access specified Object Storage Bucket. See tips for troubleshooting:  ",


Is it a correct message for this key?

mrDzurb · 2025-04-02T05:20:32Z

ads/aqua/constants.py

+        "list_model_version_sets": "Unable to create or fetch model version set. See tips for troubleshooting:",
+        "update_model": "Unable to update model. See tips for troubleshooting: ",
+        "list_data_science_private_endpoints": "Unable to access specified Object Storage Bucket. See tips for troubleshooting:  ",
+        "create_model" : "Unable to register or create model. See tips for troubleshooting: ",


I think we should stick with “register” here, using “create” might imply that registering and creating are two separate operations, which could be confusing.

mrDzurb · 2025-04-02T05:26:18Z

ads/aqua/constants.py

+        "create_job_run": "Unable to create job run. See tips for troubleshooting: ",
+}
+
+ERROR_MESSAGES = {


NIT: the ERROR_MESSAGES might be to generic name for this. How aboutL STATUS_CODE_MESSAGE?

mrDzurb · 2025-04-02T05:33:48Z

ads/aqua/extension/utils.py

+    return tip
+
+
+def construct_error(status_code: int, **kwargs) -> tuple[dict[str, int], str, str]:


I think we can consider to use pydantic class instad returning a tuple?

Something like:

class ErrorResponse(Serializable): """Structured error response returned to the client.""" status: int = Field(..., description="HTTP status code.") message: str = Field(..., description="Error message.") request_id: str = Field(..., description="Unique ID for tracking the error.") reason: Optional[str] = Field(None, description="Reason for the error.") service_payload: Optional[Dict[str, Any]] = Field(default_factory=dict) troubleshooting_tips: Optional[List[str]] = Field(default_factory=list)

And

def construct_error(status_code: int, **kwargs) -> ErrorResponse: ....

Added ReplyDetails Pydantic class

github-actions · 2025-04-02T06:06:12Z

📌 Cov diff with main:

📌 Overall coverage:

github-actions · 2025-04-02T17:23:00Z

📌 Cov diff with main:

📌 Overall coverage:

mrDzurb · 2025-04-02T23:13:57Z

ads/aqua/extension/utils.py

+            - message (str, optional): A custom error message, from error raised from failed AQUA methods calling OCI SDK methods
+            - exc_info (tuple, optional): Exception information (e.g., from `sys.exc_info()`), used for logging.
+
+    Returns:


NIT: The docstring I guess needs to be changed

github-actions · 2025-04-02T23:25:22Z

📌 Cov diff with main:

📌 Overall coverage:

github-actions · 2025-04-03T00:19:36Z

📌 Cov diff with main:

📌 Overall coverage:

elizjo added 2 commits March 31, 2025 15:36

resolved unit test issues

47988be

removed print statement

6ccdcf9

elizjo requested review from darenr, mayoor, mrDzurb, VipulMascarenhas, qiuosier and ahosler as code owners March 31, 2025 22:40

oracle-contributor-agreement bot added the OCA Verified All contributors have signed the Oracle Contributor Agreement. label Mar 31, 2025

VipulMascarenhas reviewed Mar 31, 2025

View reviewed changes

mayoor reviewed Apr 1, 2025

View reviewed changes

mayoor and others added 2 commits April 1, 2025 17:46

Add docker code (#1139)

ba9744f

corrected failed unit tests, added unit tests for errors, addressed c…

fce15e4

…omments

mrDzurb reviewed Apr 2, 2025

View reviewed changes

Merge branch 'main' into ODSC-70595/aqua_error_tips

4039d6f

Merge branch 'main' into ODSC-70595/aqua_error_tips

7ad9aeb

pydantic error class w/ details, addressed comments

06d326a

mrDzurb previously approved these changes Apr 2, 2025

View reviewed changes

fixed docstring

d97b106

elizjo dismissed mrDzurb’s stale review via d97b106 April 2, 2025 23:24

Merge branch 'main' into ODSC-70595/aqua_error_tips

5c73f63

mrDzurb approved these changes Apr 2, 2025

View reviewed changes

mrDzurb requested review from VipulMascarenhas and mayoor April 2, 2025 23:25

Merge branch 'main' into ODSC-70595/aqua_error_tips

03a2b5d

VipulMascarenhas approved these changes Apr 3, 2025

View reviewed changes

mrDzurb merged commit 0ada1cc into main Apr 3, 2025
22 of 23 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Corrected: Improved AQUA Error Messages for Authorization and Tag-Related Uses #1141

Corrected: Improved AQUA Error Messages for Authorization and Tag-Related Uses #1141

elizjo commented Mar 31, 2025 •

edited

Loading

github-actions bot commented Mar 31, 2025

VipulMascarenhas left a comment •

edited

Loading

mayoor Apr 1, 2025

elizjo Apr 3, 2025

mayoor Apr 1, 2025

elizjo Apr 3, 2025

mayoor Apr 1, 2025

elizjo Apr 3, 2025

mayoor Apr 1, 2025

mrDzurb Apr 1, 2025

VipulMascarenhas Apr 1, 2025

github-actions bot commented Apr 2, 2025

mrDzurb Apr 1, 2025

mrDzurb Apr 2, 2025

elizjo Apr 3, 2025

mrDzurb Apr 2, 2025

elizjo Apr 3, 2025

mrDzurb Apr 2, 2025

elizjo Apr 3, 2025

mrDzurb Apr 2, 2025

elizjo Apr 3, 2025

github-actions bot commented Apr 2, 2025

github-actions bot commented Apr 2, 2025

mrDzurb Apr 2, 2025

elizjo Apr 3, 2025

github-actions bot commented Apr 2, 2025

github-actions bot commented Apr 3, 2025

		return tip


		def construct_error(status_code, **kwargs) -> tuple[dict[str, int], str, str]:

		return f"https://github.com/oracle-samples/oci-data-science-ai-samples/blob/main/ai-quick-actions/troubleshooting-tips.md#{github_header}"


		def get_troubleshooting_tips(service_payload: str,

		return tip


		def construct_error(status_code: int, **kwargs) -> tuple[dict[str, int], str, str]:

Corrected: Improved AQUA Error Messages for Authorization and Tag-Related Uses #1141

Corrected: Improved AQUA Error Messages for Authorization and Tag-Related Uses #1141

Conversation

elizjo commented Mar 31, 2025 • edited Loading

github-actions bot commented Mar 31, 2025

VipulMascarenhas left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Apr 2, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Apr 2, 2025

github-actions bot commented Apr 2, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Apr 2, 2025

github-actions bot commented Apr 3, 2025

elizjo commented Mar 31, 2025 •

edited

Loading

VipulMascarenhas left a comment •

edited

Loading