Skip to content

Conversation

pamelafox
Copy link
Collaborator

@pamelafox pamelafox commented Aug 16, 2025

Purpose

Fixes #2678

This pull request updates the error message shown when the app encounters an exception. The new message directs you to check the application logs for a full traceback, replacing the previous reference to aka.ms/appservice-logs. This is a better experience since developers may see the message locally, on Container Apps (the new default), or App Service (the old default). In the future, we could add a page that was specific about how to find logs across all three environments, but such a page doesn't exist yet, so better to remove the outdated link for now.

Does this introduce a breaking change?

When developers merge from main and run the server, azd up, or azd deploy, will this produce an error?
If you're not sure, try it out on an old environment.

[ ] Yes
[X] No

Does this require changes to learn.microsoft.com docs?

This repository is referenced by this tutorial
which includes deployment, settings and usage instructions. If text or screenshot need to change in the tutorial,
check the box below and notify the tutorial author. A Microsoft employee can do this for you if you're an external contributor.

[ ] Yes
[X] No

Type of change

[X] Bugfix
[ ] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Documentation content changes
[ ] Other... Please describe:

Code quality checklist

See CONTRIBUTING.md for more details.

  • The current tests all pass (python -m pytest).
  • I added tests that prove my fix is effective or that my feature works
  • I ran python -m pytest --cov to verify 100% coverage of added lines
  • I ran python -m mypy to check for type errors
  • I either used the pre-commit hooks or ran ruff and black manually on my code.

@pamelafox pamelafox requested a review from Copilot August 16, 2025 00:06
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This pull request updates error messages throughout the application to be more platform-agnostic by removing a specific reference to Azure App Service logs. The change replaces instructions to visit "aka.ms/appservice-logs" with a more generic instruction to "check the application logs for a full traceback", making the error message applicable across different deployment environments (local development, Container Apps, and App Service).

  • Updates the core error message template in the backend error handling module
  • Updates all corresponding test snapshots and assertions to reflect the new error message format

Reviewed Changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated no comments.

File Description
app/backend/error.py Updates the ERROR_MESSAGE template to use platform-agnostic language
tests/test_cosmosdb.py Updates test assertions to match the new error message format
tests/snapshots/test_app//result.json Updates test snapshots for various error handling scenarios to reflect the new message

@pamelafox pamelafox changed the title Update error messages to be more platform agnostic Update error message to be platform agnostic Aug 16, 2025
@pamelafox pamelafox merged commit 9b176d2 into Azure-Samples:main Aug 16, 2025
21 checks passed
@pamelafox pamelafox deleted the errormessage branch August 16, 2025 00:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Remove hardcoded url to appservice-logs in error message
1 participant