Skip to content

Add header property to Graph error object #1133

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nikithauc merged 7 commits into from
Jan 17, 2023
Merged

Add header property to Graph error object #1133

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
bf20250
headers prop in GraphError
nikithauc Dec 29, 2022
cd45b63
adding test
nikithauc Jan 12, 2023
0745826
Merge branch 'dev' into nikithauc/graph-error-headers
nikithauc Jan 12, 2023
c57728b
changing the headers type
nikithauc Jan 13, 2023
25ffdcf
remove commented code
nikithauc Jan 13, 2023
3dc6a49
Merge branch 'dev' into nikithauc/graph-error-headers
nikithauc Jan 13, 2023
c877b9f
Merge branch 'dev' into nikithauc/graph-error-headers
nikithauc Jan 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions shims.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,5 @@ interface NodeStream {
read(size?: number): any;
on(event: string | symbol, listener: (...args: any[]) => void): this;
}

interface Headers{}
2 changes: 2 additions & 0 deletions src/GraphError.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@ export class GraphError extends Error {
*/
public date: Date;

public headers?: Headers;

/**
* @public
* A member holding original error response by the graph service
Expand Down
12 changes: 7 additions & 5 deletions src/GraphErrorHandler.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,13 +40,14 @@ export class GraphErrorHandler {
* @param {number} [statusCode] - The status code of the response
* @returns The GraphError instance
*/
private static constructError(error: Error, statusCode?: number): GraphError {
private static constructError(error: Error, statusCode?: number, rawResponse?: Response): GraphError {
const gError = new GraphError(statusCode, "", error);
if (error.name !== undefined) {
gError.code = error.name;
}
gError.body = error.toString();
gError.date = new Date();
gError.headers = rawResponse?.headers;
return gError;
}

Expand All @@ -71,7 +72,7 @@ export class GraphErrorHandler {
* }
* }
*/
private static constructErrorFromResponse(graphError: GraphAPIErrorResponse, statusCode: number): GraphError {
private static constructErrorFromResponse(graphError: GraphAPIErrorResponse, statusCode: number, rawResponse?: Response): GraphError {
const error = graphError.error;
const gError = new GraphError(statusCode, error.message);
gError.code = error.code;
Expand All @@ -81,6 +82,7 @@ export class GraphErrorHandler {
}

gError.body = JSON.stringify(error);
gError.headers = rawResponse?.headers;

return gError;
}
Expand All @@ -96,12 +98,12 @@ export class GraphErrorHandler {
* @param {GraphRequestCallback} [callback] - The graph request callback function
* @returns A promise that resolves to GraphError instance
*/
public static async getError(error: any = null, statusCode = -1, callback?: GraphRequestCallback): Promise<GraphError> {
public static async getError(error: any = null, statusCode = -1, callback?: GraphRequestCallback, rawResponse?: Response): Promise<GraphError> {
let gError: GraphError;
if (error && error.error) {
gError = GraphErrorHandler.constructErrorFromResponse(error, statusCode);
gError = GraphErrorHandler.constructErrorFromResponse(error, statusCode, rawResponse);
} else if (error instanceof Error) {
gError = GraphErrorHandler.constructError(error, statusCode);
gError = GraphErrorHandler.constructError(error, statusCode, rawResponse);
} else {
gError = new GraphError(statusCode);
gError.body = error; // if a custom error is passed which is not instance of Error object or a graph API response
Expand Down
2 changes: 1 addition & 1 deletion src/GraphRequest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -388,7 +388,7 @@ export class GraphRequest {
if (rawResponse) {
statusCode = rawResponse.status;
}
const gError: GraphError = await GraphErrorHandler.getError(error, statusCode, callback);
const gError: GraphError = await GraphErrorHandler.getError(error, statusCode, callback, rawResponse);
throw gError;
}
}
Expand Down
19 changes: 19 additions & 0 deletions test/common/core/GraphErrorHandler.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,5 +108,24 @@ describe("GraphErrorHandler.ts", () => {
assert.equal(gError.body, null);
assert.equal(gError.requestId, null);
});

it("Should get header from response", async () => {
const headers = { keyTest: "valueTest" };
const errorResponse = {
error: {
code: "500",
message: "Internal Server Error",
innerError: {
"request-id": "some random id",
},
},
};
const rawResponse = new Response(undefined, {
headers: new Headers(headers),
});
const gError = await GraphErrorHandler.getError(errorResponse, 500, undefined, rawResponse);
assert.isDefined(gError.headers);
assert.equal(gError.headers?.get("keyTest"), headers.keyTest);
});
});
});