Add reviews support: read and translate Store reviews

[Alexandre Zollinger Chohfi (azchohfi)]

Issue #179 asked for three things: read Store reviews, reply to them, and translate them. Before designing anything I checked whether official APIs actually exist for each, and only one of the three does.

Capability	API	Status
Read	GET /v1.0/my/analytics/reviews	Live, not deprecated
Reply	POST /v1.0/my/reviews/responses	Microsoft documents it as "currently not in a working state"
Translate	none	No language field, no translated text

What this adds

msstore reviews list <productId>            # Spectre table
msstore reviews get <productId> <reviewId>  # full JSON on stdout

list supports --startDate, --endDate, --top, --skip, --rating and --market. Both support --translate [lang].

Reading goes through a new GetAppReviewsAsync on IStorePackagedAPI. The analytics API lives on the same host and scope that StorePackagedAPI already authenticates against, so this reuses the existing DevCenter credential path with no new auth work, and reuses PagedResponse<T>.

Reply is deliberately not implemented

The reply API is documented, but Microsoft has flagged it as not working since July 2023, and the banner is still present on a page republished in March 2026. Reports show it returning 400 code:4012 and later 502. A reviews respond command would fail on every invocation, so this ships read-only and the README points at Partner Center instead. There is no replacement API: the Store submission API v2 has no reviews endpoints.

Translation is external by necessity

The Store returns no translated text and no language metadata for reviews. market is an ISO 3166 country code, not a language, so it cannot stand in for one. Partner Center's translate toggle is UI only.

So --translate uses Azure AI Translator with a key the user supplies, via MSSTORE_TRANSLATOR_KEY / MSSTORE_TRANSLATOR_REGION or msstore settings set-translator-key, which stores the key through ICredentialManager and keeps only the non-secret region in settings.json.

It targets Translator v3.0 rather than the newer 2026-06-06 GA, because v3.0 works with a plain Translator resource key while the newer version's headline features expect a Microsoft Foundry resource. The api-version constant and the wire DTOs sit behind ITranslationService so that swap stays contained.

Things worth a careful look

• Every AppReview field is optional. The analytics API omits fields entirely rather than returning them as null. A live call against a real app confirmed this: DeviceModel, DeviceRAM, IsTouchEnabled and ReviewTitle all came back absent.
• Date is a string. The service returns a US-format value like 5/17/2014 11:42:41 PM, not ISO-8601, so it is kept as a string to round-trip exactly.
• The date parameters do not behave as documented. The docs say startDate/endDate default to the current date. In practice, omitting them sends no date parameters and the service returns every review. The option help and the "not found" message reflect the observed behaviour, not the documented one, and the message only suggests widening the range when the caller actually narrowed it.
• detectedLanguage.score is deserialized as a double. The published Translator Swagger types it as an integer, which is wrong.
• Translator error code is a JSON number, not a string, so it is modelled as int.
• The translator client does not reuse RetryAfterHttpHandler. That handler retries 429s forever with no attempt cap, and Translator does not document a Retry-After header, so the service does its own capped exponential backoff and only honours the header opportunistically.
• IEnvironmentInformationService gained GetEnvironmentVariable so the translator service can be unit tested without mutating process-wide environment state.

Verification

230 tests pass, including 37 new ones covering the commands and the translator client (batching, index alignment, region header handling and error-code mapping).

Also smoke tested end to end against a real Partner Center account: listing and getting real reviews, the market and rating filters, the unauthenticated /languages validation path, and the missing-key and bad-key error messages.

Fixes: #179

[Copilot]

🟢 Approval recommended

The implementation is cohesive and well-tested, with only a minor user-facing wording issue noted in the reviews list empty-result message.

Pull request overview

Adds a new reviews feature area to msstore-cli, enabling users to list and fetch Microsoft Store analytics reviews for packaged (MSIX) apps, with optional on-demand translation via Azure AI Translator while keeping secrets in the OS credential store.

Changes:

• Introduces msstore reviews list <productId> (Spectre table) and msstore reviews get <productId> <reviewId> (JSON to stdout), plus shared --translate [lang].
• Adds an Azure AI Translator client (ITranslationService) with batching, retry/backoff, and a settings set-translator-key command that stores secrets via ICredentialManager.
• Extends IStorePackagedAPI / StorePackagedAPI to call the DevCenter analytics reviews endpoint and models the AppReview payload.

File summaries

File	Description
README.md	Documents new reviews commands and translator configuration options.
MSStore.CLI/StoreHostBuilderExtensions.cs	Registers new commands/handlers for DI and trimming safety.
MSStore.CLI/Services/Translation/TranslationSourceGenerationContext.cs	Adds STJ source-gen context for Translator wire DTOs.
MSStore.CLI/Services/Translation/TranslationResult.cs	Adds a small internal result model for translations.
MSStore.CLI/Services/Translation/TranslationException.cs	Adds a user-facing exception type for translation failures.
MSStore.CLI/Services/Translation/Models/TranslatorLanguagesResponse.cs	DTO for /languages response.
MSStore.CLI/Services/Translation/Models/TranslatorLanguage.cs	DTO for individual supported language metadata.
MSStore.CLI/Services/Translation/Models/TranslatorErrorResponse.cs	DTO wrapper for Translator error responses.
MSStore.CLI/Services/Translation/Models/TranslatorError.cs	DTO for Translator error object (numeric code).
MSStore.CLI/Services/Translation/Models/TranslationInfo.cs	DTO for a translation entry in Translator responses.
MSStore.CLI/Services/Translation/Models/TranslateResultItem.cs	DTO for one element in the translate response array.
MSStore.CLI/Services/Translation/Models/TranslateInput.cs	DTO for one element in the translate request array.
MSStore.CLI/Services/Translation/Models/DetectedLanguageInfo.cs	DTO for detected language info (double score).
MSStore.CLI/Services/Translation/ITranslationService.cs	Defines translation abstraction used by commands.
MSStore.CLI/Services/Translation/AzureAITranslatorService.cs	Implements Translator v3.0 client, batching, retries, and error mapping.
MSStore.CLI/Services/IEnvironmentInformationService.cs	Adds GetEnvironmentVariable for testability.
MSStore.CLI/Services/EnvironmentInformationService.cs	Implements GetEnvironmentVariable.
MSStore.CLI/Services/Configurations.cs	Persists non-secret translator region in settings.
MSStore.CLI/Program.cs	Wires translator service + named HttpClient into DI.
MSStore.CLI/MicrosoftStoreCLI.cs	Adds reviews as a top-level command.
MSStore.CLI/Helpers/ParseResultExtensions.cs	Adds GetTranslateLanguage() helper for --translate.
MSStore.CLI/Commands/SettingsCommand.cs	Adds set-translator-key subcommand under settings.
MSStore.CLI/Commands/Settings/SetTranslatorKeyCommand.cs	Implements secure storage/clearing of translator key + region.
MSStore.CLI/Commands/ReviewsCommand.cs	Adds reviews command and shared options/args (incl. --translate).
MSStore.CLI/Commands/Reviews/ReviewTranslator.cs	Translates review title/text in one batched call and populates fields.
MSStore.CLI/Commands/Reviews/ListCommand.cs	Implements review listing, filtering, table rendering, and translation.
MSStore.CLI/Commands/Reviews/GetCommand.cs	Implements fetching a single review and emitting JSON to stdout.
MSStore.CLI.UnitTests/ReviewsCommandUnitTests.cs	Adds command-level tests for list/get and translation behavior.
MSStore.CLI.UnitTests/BaseCommandLineTest.cs	Adds fake reviews + translation plumbing to test harness.
MSStore.CLI.UnitTests/AzureAITranslatorServiceUnitTests.cs	Adds unit tests covering translator client behavior and error mapping.
MSStore.API/SourceGenerationContext.cs	Adds STJ source-gen entries for AppReview and paged response.
MSStore.API/Packaged/StorePackagedAPI.cs	Adds GetAppReviewsAsync implementation using analytics endpoint.
MSStore.API/Packaged/Models/AppReview.cs	Adds reviews DTO (all-optional fields + CLI-populated translated fields).
MSStore.API/Packaged/IStorePackagedAPI.cs	Adds GetAppReviewsAsync to the packaged API interface.

Review details

• Files reviewed: 34/34 changed files
• Comments generated: 1
• Review effort level: Lite

---

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

[Copilot]

🔵 Needs a closer look

Negative paging values (--top/--skip) are not validated and can lead to avoidable service-side failures and confusing runtime behavior.

Review details

Suppressed comments (2)

Previously missed (2) — in code that hasn't changed since the last review.

MSStore.API/Packaged/StorePackagedAPI.cs:681

• GetAppReviewsAsync validates top only against the maximum, but negative top/skip values can still be passed through and produce a service-side failure. Add range checks for negative paging values so callers get a clear, deterministic exception.
  MSStore.CLI/Commands/Reviews/ListCommand.cs:103
• --top and --skip accept numeric values but negative values aren’t rejected, so they can be sent to the analytics API and fail the request. Add explicit validation for negative paging values with a clear error message.

• Files reviewed: 34/34 changed files
• Comments generated: 0 new
• Review effort level: Lite

[Copilot]

🟢 Approval recommended

The changes align with the PR description, keep stdout/stderr behavior consistent, and include substantial unit tests for both the new commands and the translator client.

Review details

• Files reviewed: 35/35 changed files
• Comments generated: 0 new
• Review effort level: Lite

[Copilot]

🔵 Needs a closer look

There are a couple of user-facing correctness issues to address (notably trimming/persistence of translator key/region and a small README wording mismatch) before this is safe to merge.

Review details

Suppressed comments (2)

Previously missed (2) — in code that hasn't changed since the last review.

MSStore.CLI/Commands/Settings/SetTranslatorKeyCommand.cs:98

• The key and region are stored exactly as provided. If the user includes leading/trailing whitespace, the stored value will later be sent in request headers verbatim and cause hard-to-diagnose authentication failures. Trim the key/region before persisting them.
  README.md:40
• The wording here implies both key and region are stored in the OS secure store, but the implementation stores only the key there and saves the region in settings.json (Configurations.TranslatorRegion). Please adjust the sentence to avoid misleading users about where the region is persisted.

• Files reviewed: 35/35 changed files
• Comments generated: 0 new
• Review effort level: Lite

[Copilot]

🔵 Needs a closer look

Translator error logging currently includes full response bodies at Error level, which can leak sensitive data into verbose/CI logs.

Review details

Suppressed comments (1)

Previously missed (1) — in code that hasn't changed since the last review.

MSStore.CLI/Services/Translation/AzureAITranslatorService.cs:362

• The Error-level logs include the full Translator response body (content). When users run with --verbose (or in CI with logs collected), this can leak potentially sensitive data into logs. Consider logging only status/request-id at Error and moving the body to Debug (or truncating/redacting it).

• Files reviewed: 36/36 changed files
• Comments generated: 0 new
• Review effort level: Lite

[Copilot]

🔵 Needs a closer look

The new ANSI-stripping regex in BaseCommandLineTest is too narrow and may still leave escape sequences in captured output, risking flaky test assertions across environments.

Review details

Suppressed comments (1)

Previously missed (1) — in code that hasn't changed since the last review.

MSStore.CLI.UnitTests/BaseCommandLineTest.cs:998

• The ANSI-stripping regex only matches CSI sequences of the form ESC + '[' + digits/';' + letter. Spectre can emit other CSI sequences (e.g., private-mode codes like ESC[?25l/ESC[?25h or sequences with intermediate bytes), which would remain in captured output and can still make string assertions flaky on different terminals/CI hosts.

• Files reviewed: 36/36 changed files
• Comments generated: 0 new
• Review effort level: Lite

[Copilot]

🟡 Changes recommended

The Translator JSON source-gen options currently force camelCase property names, which risks sending invalid request payloads to the Translator v3 endpoint.

Once you've addressed the issues Copilot identified, you can request another Copilot review.

Review details

• Files reviewed: 37/37 changed files
• Comments generated: 1
• Review effort level: Lite

[Copilot]

🟢 Approval recommended

The changes are cohesive, align with the PR description (read-only + external translation), and include thorough command/service/unit test coverage without introducing evident correctness or convention issues.

Review details

• Files reviewed: 37/37 changed files
• Comments generated: 0 new
• Review effort level: Lite