[bug-bash] print maps a missing item's HTTP 404 to exit 1 instead of documented not-found exit 5

Geschlossen Anfängerfreundlich
  • Stimmt etwas nicht?
#279 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Ein zugehöriger Pull Request wurde bereits gemerged.

  • #288 von @mkrueger — gemerged

Bewertung

Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Anfängerfreundlichkeit
78/100
Issue-Typ
Bug
Klarheit
Klar beschrieben
Aktivitätsstatus
Aktiv
Tech-Stack
azure, cli, csharp
Bereich
cli, databases

Rechercherichtung

Beginne mit PrintCommand.PrintItemAsync und seinem ReadItemStreamAsync-NotFound-Zweig und verfolge dann, wie ShellExitCode Befehlsfehler Exitcodes zuordnet. Prüfe den dokumentierten Exitcode-Vertrag und die benachbarten Tests für einzelne Lesezugriffe. Fertig ist es, wenn bei einem fehlenden Element weiterhin die verständliche Fehlermeldung ausgegeben und Exitcode 5 zurückgegeben wird.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

bug bug-bash

Environment

Windows x64, CosmosDBShell 1.1.291-preview (db49321323).
Verified on a disposable container with partition key /pk, using an authorized
Azure CLI identity and Gateway connection mode.

Repro

The following creates a unique disposable shared-throughput database (400 RU/s)
and an empty container. Supply an authorized Azure NoSQL account using these
environment variables; no real endpoint or identity is included in this report:

# Set COSMOS_ENDPOINT, AZURE_SUBSCRIPTION_ID and COSMOS_RESOURCE_GROUP first.
foreach ($name in @('COSMOS_ENDPOINT', 'AZURE_SUBSCRIPTION_ID', 'COSMOS_RESOURCE_GROUP')) {
    if ([string]::IsNullOrWhiteSpace([Environment]::GetEnvironmentVariable($name))) {
        throw "Set $name to an authorized test account value before continuing."
    }
}
$package = "$env:USERPROFILE\.dotnet\tools\.store\cosmosdbshell\1.1.291-preview"
$shell = Join-Path $package 'cosmosdbshell.win-x64\1.1.291-preview\tools\net10.0\win-x64\CosmosDBShell.exe'
& $shell --version
$connection = @(
    '--connect', $env:COSMOS_ENDPOINT,
    '--connect-azure-cli', '--connect-mode', 'gateway',
    '--connect-subscription', $env:AZURE_SUBSCRIPTION_ID,
    '--connect-resource-group', $env:COSMOS_RESOURCE_GROUP,
    '--output', 'json', '--quiet'
)
$db = 'BugBash_Print_' + [guid]::NewGuid().ToString('N')
& $shell @connection -c "mkdb $db --scale=m --ru=400"
if ($LASTEXITCODE -ne 0) { throw 'Fixture database creation failed; stop.' }
& $shell @connection --database $db -c 'mkcon Items /pk'
if ($LASTEXITCODE -ne 0) { throw 'Fixture container creation failed; stop.' }

# Exact failing command. The new container is empty, so this item cannot exist.
& $shell @connection --database $db --container Items -c 'print absent p1'
$readExit = $LASTEXITCODE
"Observed exit code: $readExit"

Actual: Observed exit code 1. Expected: 5.

Expected

A point read that returns HTTP 404 maps to not-found exit code 5, as documented
in the CLI's exit-code contract.

Actual

The command returns exit code 1, with a JSON stderr error saying the item was
not found and suggesting the partition key be verified.

Observed direct live reproduction:

print absent p1

stderr:

{"status":"error","error":"Item with id 'absent' not found using partition key 'p1'. Verify the partition key value is correct."}

Also reproduced for an item correctly absent after atomic batch rollback, and
after a successful explicit item deletion. This is an exit-code classification
bug, not a batch rollback or item deletion failure.

Cleanup

Delete only the database created by the commands above:

& $shell @connection -c "rmdb $db true"

Investigation lead

PrintCommand.PrintItemAsync uses ReadItemStreamAsync. Its explicit NotFound
branch throws a plain CommandException without preserving the HTTP status or
an SDK exception. ShellExitCode therefore cannot recognize the original 404
and falls back to general failure.

The fix should preserve the useful friendly error message while retaining the
original status classification. No fix has been implemented.

Vorherrschende Sprache
C#
Sterne
4
Forks
7
Ø Merge
1 T. 15 Std.
Gemergte PRs (30 T.)
33

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus Azure/CosmosDBShell

Alle Issues in Azure/CosmosDBShell

Ähnliche Issues

Weitere Issues zu C#

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.