GraphError: Subscription validation request failed despite Accessible Endpoint hosted on Google Cloud
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 25/100
- Issue type
- Bug
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- node.js, typescript
- Domain
- api
Research direction
Start by comparing the subscription request and validation response described in the issue with the SDK path shown in the stack trace, especially @microsoft/microsoft-graph-client/lib/src/GraphRequest.js and GraphErrorHandler.js. Determine whether the SDK request differs from Postman or whether the failure is returned by Microsoft Graph; done means a reproducible cause and a confirmed fix or actionable report.
Written by the indexing model from the issue text.
Description
Bug Report
Prerequisites
- Can you reproduce the problem?
- Are you running the latest version?
- Are you reporting to the correct repository?
- Did you perform a cursory search?
For more information, see the CONTRIBUTING guide.
Description
I've been working on implementing Microsoft Graph webhook subscriptions in my application, and I've run into an issue with subscription validation. Whenever I attempt to validate the subscription, I've consistently receive the following error message:
GraphError: Subscription validation request timed out.
My subscription server is deployed and hosted on Google Cloud Function v2, allowing all unauthenticated invocations.
The following verification is performed using Microsoft's Postman Collection:
- Endpoint is accessible on the internet with unauthenticated invocation
- Endpoint is returning 200OK, text-plain, decoded validationToken as intended
- Endpoint able to reply within 10s timeframe consistently
However, when I actually attempt to create subscription request using MicrosoftGraph Javascript SDK, the validation request always faces timeout issue despite it being accessible via PostMan.
Code Snippet to Invoke Subscription Request
const requestBody: Subscription =
changeType: "updated",
resource: `/users/${folderId}/drive/root
expirationDateTime: new Date(now.setDate(now.getDate() + 28)).toISOString(),
notificationUrl: `${process.env.ONEDRIVE_URL}/folders/${folderId}?workspaceId=${workspaceId}`,
clientState: "somerandomtext";
}
await driveClient.api("/subscriptions").post(requestBody);
Console Errors:
GraphError: Subscription validation request timed out.
at new GraphError (/code/node_modules/@microsoft/microsoft-graph-client/lib/src/GraphError.js:34:28)
at GraphErrorHandler.constructErrorFromResponse (/code/node_modules/@microsoft/microsoft-graph-client/lib/src/GraphErrorHandler.js:63:22)
at Function.<anonymous> (/code/node_modules/@microsoft/microsoft-graph-client/lib/src/GraphErrorHandler.js:91:48)
at step (/code/node_modules/tslib/tslib.js:195:27)
at Object.next (/code/node_modules/tslib/tslib.js:176:57)
at /code/node_modules/tslib/tslib.js:169:75
at new Promise (<anonymous>)
at Object.__awaiter (/code/node_modules/tslib/tslib.js:165:16)
at GraphErrorHandler.getError (/code/node_modules/@microsoft/microsoft-graph-client/lib/src/GraphErrorHandler.js:87:24)
at GraphRequest.<anonymous> (/code/node_modules/@microsoft/microsoft-graph-client/lib/src/GraphRequest.js:315:84) {
statusCode: 400,
code: 'InvalidRequest',
requestId: 'uuid,
date: 2023-09-30T21:36:48.000Z,
body: '{"code":"InvalidRequest","message":"Subscription validation request timed out.","innerError":{"date":"2023-10-01T05:36:48","request-id":"uuid,"client-request-id":"uuid}}',
headers: HeadersList {
cookies: null,
[Symbol(headers map)]: Map(10) {
'cache-control' => [Object],
'transfer-encoding' => [Object],
'content-type' => [Object],
'content-encoding' => [Object],
'vary' => [Object],
'strict-transport-security' => [Object],
'request-id' => [Object],
'client-request-id' => [Object],
'x-ms-ags-diagnostic' => [Object],
'date' => [Object]
},
[Symbol(headers map sorted)]: null
}
}
Code Snippet to Listen for Subscription Validation
import { FastifyPluginAsyncTypebox } from "@fastify/type-provider-typebox";
import { Type } from "@sinclair/typebox";
export const ParamsSchema = Type.Object({
fid: Type.String(),
});
export const QuerySchema = Type.Object({
workspaceId: Type.RegEx(/^[0-9a-z]{25}$/),
validationToken: Type.Optional(Type.String()),
});
const main: FastifyPluginAsyncTypebox = async (app, options): Promise<void> => {
/**
* Listens to changes to a folder
*/
app.post("/", { schema: { params: ParamsSchema, querystring: QuerySchema } }, async (req, rep) => {
app.log.info("Received webhook request");
// If there is a validationToken parameter
// in the query string, this is the endpoint validation
// request sent by Microsoft Graph. Return the token
// as plain text with a 200 response
// https://docs.microsoft.com/graph/webhooks#notification-endpoint-validation
// https://github.com/microsoftgraph/nodejs-webhooks-sample/blob/main/routes/listen.js#L13
if (req.query.validationToken) {
return req.query.validationToken;
}
// Other logic but is commented
return {};
});
}
Screenshots: [If applicable, add screenshots to help explain your problem]
Logs from Google Cloud Console
Usage Information
Request ID - Value of the requestId field if you are receiving a Graph API error response
SDK Version - 3.0.7
- Node (Check, if using Node version of SDK)
Node Version - v18.17.1
I'm unsure why the validation request fails in my application but works with Postman. Can anyone offer guidance on what could be causing this issue or suggest potential solutions?
- Dominant language
- TypeScript
- Stars
- 833
- Forks
- 240
- PR merge metrics
- No merged PRs in 30d
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from microsoftgraph/msgraph-sdk-javascript
-
status:waiting-for-triage
Difficulty 1/5 Under an hour Newbie friendliness 62/100
-
Is anyone here? Open
Difficulty 4/5 3-5 days Newbie friendliness 25/100
microsoftgraph/msgraph-sdk-javascript#2005 · 1 reaction ·
-
Is it really correct that the Javascript version of the graph SDK doesn't offer typed requests? Openstatus:waiting-for-triage
Difficulty 5/5 Over a week Newbie friendliness 42/100
-
status:waiting-for-triage type:bug
Difficulty 3/5 1-2 days Newbie friendliness 48/100
microsoftgraph/msgraph-sdk-javascript#1999 · 2 comments · 1 reaction ·
-
status:waiting-for-triage type:bug
Difficulty 4/5 3-5 days Newbie friendliness 45/100
All issues in microsoftgraph/msgraph-sdk-javascript
Similar issues
-
Type/Bug
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
OpenNSW/nsw-srilanka#497 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
0xMiden/bridge-portal#132 ·
-
react-doctor severity:warning tech-debt
Difficulty 1/5 Under an hour Newbie friendliness 88/100
digidem/comapeo-cloud-app#403 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100