[DOCS] Improve discoverability of the timeout parameter for fetch requests (in docs and/or code)

Question

[DOCS] Improve discoverability of the timeout parameter for fetch requests (in docs and/or code)

Closed this issue a month ago · 4 comments

Describe the bug
Please provide a clear and concise description of what the bug is.
Trying to decode a token generated by Cognito results in Failed to fetch jwks.
I've double checked all credentials (AWS_COGNITO_USER_POOL_ID, AWS_COGNITO_CLIENT_ID)

fetch the raw URL of the jwks from amazon works well - The json is retrieved.

Versions
Which version of aws-jwt-verify are you using? 4.0.0
Are you using the library in Node.js or in the Web browser? Postman/Browser
If Node.js, which version of Node.js are you using? (Should be at least 14)
If Web browser, which web browser and which version of it are you using? 20.4.0
If using TypeScript, which version of TypeScript are you using? (Should be at least 4) 5.1.6

To Reproduce
If you can, please provide a minimal code example that reproduces the bug.
const decoded = await verifier.verify(token);

Answer 1 · 2023-08-04T06:22:53.000Z

Seems like the problem is a timeout after 1500 which is the default.
When increasing the timeout to 5000, the request process successfully.

    async getJwks(jwksUri) {
        const existingFetch = this.fetchingJwks.get(jwksUri);
        if (existingFetch) {
            return existingFetch;
        }
        **const jwksPromise = this.fetcher.fetch(jwksUri, { responseTimeout: 5000 }).then((res) => {**
            assertIsJwks(res);
            return res;
        });
        this.fetchingJwks.set(jwksUri, jwksPromise);
        let jwks;
        try {
            jwks = await jwksPromise;
        }
        finally {
            this.fetchingJwks.delete(jwksUri);
        }
        this.jwksCache.set(jwksUri, jwks);
        return jwks;
    }

Answer 2 · 2023-08-04T06:23:16.000Z

Seems like the problem is a timeout after 1500 which is the default.
When increasing the timeout to 5000, the request process successfully.

    async getJwks(jwksUri) {
        const existingFetch = this.fetchingJwks.get(jwksUri);
        if (existingFetch) {
            return existingFetch;
        }
        **const jwksPromise = this.fetcher.fetch(jwksUri, { responseTimeout: 5000 }).then((res) => {**
            assertIsJwks(res);
            return res;
        });
        this.fetchingJwks.set(jwksUri, jwksPromise);
        let jwks;
        try {
            jwks = await jwksPromise;
        }
        finally {
            this.fetchingJwks.delete(jwksUri);
        }
        this.jwksCache.set(jwksUri, jwks);
        return jwks;
    }

Is it possible to expose timeout setting to the user?

Answer 3 · 2023-08-04T06:25:49.000Z

The timeout is user exposed: https://github.com/awslabs/aws-jwt-verify#configuring-the-jwks-response-timeout-and-other-http-options-with-jsonfetcher