GraphError has an empty message when the error response is not Graph JSON (text/plain, HTML or empty body)
Maintainer antworten meist innerhalb von 1 Tag
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Anfängerfreundlichkeit
- 76/100
- Issue-Typ
- Bug
- Klarheit
- Klar beschrieben
- Aktivitätsstatus
- Aktiv
- Tech-Stack
- node.js, typescript
- Bereich
- backend-api-design
Rechercherichtung
Lies src/GraphErrorHandler.ts, insbesondere getError und den abschließenden Fallback-Zweig, sowie die in src/GraphResponseHandler.ts beschriebene Behandlung der Antwort. Ergänze Tests für Nicht-Graph-Fehlerantworten wie Klartext und leere Antworten und führe anschließend die relevanten GraphErrorHandler-Tests aus. Fertig ist die Aufgabe, wenn ein HTTP-Fehler immer eine aussagekräftige, nicht leere Meldung hat und Graph-JSON-Fehler ihre bisherige Meldung beibehalten.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
Describe the bug
When Graph (or a gateway in front of it) answers a request with an error status and a body that is not the usual { "error": { ... } } JSON, the thrown GraphError has message === "" and code === null. Logging error.message or showing it to a user then yields nothing; only statusCode says what happened.
From reading the code (unchanged between 3.0.7 and dev @ e6a6221):
- On a non-2xx response,
GraphResponseHandler.getResponsethrows the parsed body itself. Fortext/plainthat is a string; fortext/htmlandapplication/xmlit is the rawReadableStreamwhenDOMParseris undefined, as in Node (L125, parseDocumentResponse); without aContent-Typeit is the stream as well (L147). GraphErrorHandler.getErroronly reads a message from a Graph JSON body or from anError. Anything else falls through tonew GraphError(statusCode)with no message (L108), and the constructor passesundefinedtosuper(GraphError.ts L63).
A plain-text body such as Service Unavailable ends up in error.body, but not in error.message.
Expected behavior
error.message is never empty for an HTTP error. For example, the status line when there is nothing better ("HTTP 503" or "503 Service Unavailable"), or the text body when the response is text/plain.
How to reproduce
A local server stands in for Graph and answers four paths with an error status. Run with Node 22 or bun:
import http from "node:http";
import { Client, GraphError } from "@microsoft/microsoft-graph-client";
import pkg from "@microsoft/microsoft-graph-client/package.json" with { type: "json" };
const cases = {
"/json-error": [403, "application/json", JSON.stringify({ error: { code: "Authorization_RequestDenied", message: "Insufficient privileges to complete the operation." } })],
"/html-502": [502, "text/html", "<html><body>Bad Gateway</body></html>"],
"/text-503": [503, "text/plain", "Service Unavailable"],
"/empty-500": [500, undefined, ""],
};
const server = await new Promise((r) => { const s = http.createServer((req, res) => {
const [status, type, body] = cases[new URL(req.url, "http://x").pathname];
res.writeHead(status, type ? { "content-type": type } : {}).end(body);
}).listen(0, "127.0.0.1", () => r(s)); });
const client = Client.initWithMiddleware({
baseUrl: `http://127.0.0.1:${server.address().port}`,
authProvider: { getAccessToken: async () => "example-token" },
});
console.log("@microsoft/microsoft-graph-client", pkg.version, "| runtime", typeof Bun !== "undefined" ? `bun ${Bun.version}` : `node ${process.version}`);
for (const path of Object.keys(cases)) {
try { await client.api(path).version("").get(); }
catch (e) {
console.log(`${path.padEnd(12)} GraphError: ${e instanceof GraphError} statusCode: ${e.statusCode} code: ${JSON.stringify(e.code)} message: ${JSON.stringify(e.message)} body: ${JSON.stringify(e.body)?.slice(0, 50)}`);
}
}
server.close();
Output:
@microsoft/microsoft-graph-client 3.0.7 | runtime node v22.23.3
/json-error GraphError: true statusCode: 403 code: "Authorization_RequestDenied" message: "Insufficient privileges to complete the operation." body: "{\"code\":\"Authorization_RequestDenied\",\"messa
/html-502 GraphError: true statusCode: 502 code: null message: "" body: {}
/text-503 GraphError: true statusCode: 503 code: null message: "" body: "Service Unavailable"
/empty-500 GraphError: true statusCode: 500 code: null message: "" body: {}
The same output with bun 1.4.4.
SDK Version
3.0.7 (latest on npm). Code read on dev @ e6a6221 (package.json says 3.0.8, not published yet).
Latest version known to work for scenario above?
None known.
Known Workarounds
Fall back on the status code when the message is empty, e.g. error.message || `HTTP ${error.statusCode}` .
Debug output
Not applicable. The output above is the full repro output.
Configuration
- OS: Linux (WSL2), x64
- Node.js v22.23.3 and bun 1.4.4
- Not specific to this configuration, as far as I can tell from the code.
Other information
A possible fix is a fallback message in getError's last branch: the body when it is a non-empty string, otherwise a status line such as HTTP ${statusCode}.
Related: #353 fixed an empty error coming from the auth provider callback, which is a different path. #1534 (closed) logs a 401 GraphError whose first line has no message text, which looks like the same case.
- Vorherrschende Sprache
- TypeScript
- Sterne
- 836
- Forks
- 241
- Ø Merge
- 1 T. 12 Std.
- Gemergte PRs (30 T.)
- 10
Entwicklungsumgebung
- Kein Dockerfile und keine Docker-Compose-Datei
- Hat eine Pull-Request-Vorlage
- Beitragsleitfaden lesen
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus microsoftgraph/msgraph-sdk-javascript
-
client.api() throws "Unable to parse the URL" for relative paths containing https:// in the queryEvtl. vergeben Ein verknüpfter Pull Request ist offen oder bereits gemergt. Offen
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 85/100
microsoftgraph/msgraph-sdk-javascript#2039 ·
Maintainer antworten meist innerhalb von 1 Tag
-
status:waiting-for-triage
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 62/100
microsoftgraph/msgraph-sdk-javascript#1956 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Is anyone here?Offen
Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 25/100
microsoftgraph/msgraph-sdk-javascript#2005 · 1 Reaktion ·
Maintainer antworten meist innerhalb von 1 Tag
-
Is it really correct that the Javascript version of the graph SDK doesn't offer typed requests?Offenstatus:waiting-for-triage
Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 42/100
microsoftgraph/msgraph-sdk-javascript#2004 ·
Maintainer antworten meist innerhalb von 1 Tag
-
status:waiting-for-triage type:bug
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 48/100
microsoftgraph/msgraph-sdk-javascript#1999 · 2 Kommentare · 1 Reaktion ·
Maintainer antworten meist innerhalb von 1 Tag
Alle Issues in microsoftgraph/msgraph-sdk-javascript
Ähnliche Issues
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100
fb55/htmlparser2#2579 ·
Maintainer antworten meist innerhalb von 1 Tag
-
bug good first issue needs-review
Schwierigkeit 1/5 1-3 Stunden Anfängerfreundlichkeit 83/100
Maintainer antworten meist innerhalb von 1 Tag
-
Add Module DB RulesOffendocumentation public
Schwierigkeit 1/5 1-3 Stunden Anfängerfreundlichkeit 68/100
midnightntwrk/umbradb#65 ·
Maintainer antworten meist innerhalb von 2 Tagen
-
area/channels kind/bug priority/medium
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100
nanocoai/nanoclaw#4501 · 1 Kommentar ·
Maintainer antworten meist innerhalb von 1 Tag
-
needs verification
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 74/100
Maintainer antworten meist innerhalb von 13 Tagen