OIDC: allow configuring the request timeout (#1177)

Add IdP timeout, controlled by env var GRIST_OIDC_SP_HTTP_TIMEOUT

---------

Co-authored-by: atropos <sv7n@pm.me>
This commit is contained in:
Florent
2024-09-03 23:10:18 +02:00
committed by GitHub
parent 16d246094b
commit b1a9e5f0da
2 changed files with 60 additions and 3 deletions

View File

@@ -5,7 +5,7 @@ import {Sessions} from "app/server/lib/Sessions";
import log from "app/server/lib/log";
import {assert} from "chai";
import Sinon from "sinon";
import {Client, generators, errors as OIDCError} from "openid-client";
import {Client, custom, generators, errors as OIDCError} from "openid-client";
import express from "express";
import _ from "lodash";
import {RequestWithLogin} from "app/server/lib/Authorizer";
@@ -192,6 +192,55 @@ describe('OIDCConfig', () => {
});
});
});
describe('GRIST_OIDC_SP_HTTP_TIMEOUT', function () {
[
{
itMsg: 'when omitted should not override openid-client default value',
expectedUserDefinedHttpOptions: {}
},
{
itMsg: 'should reject when the provided value is not a number',
env: {
GRIST_OIDC_SP_HTTP_TIMEOUT: '__NOT_A_NUMBER__',
},
expectedErrorMsg: /__NOT_A_NUMBER__ does not look like a number/,
},
{
itMsg: 'should override openid-client timeout accordingly to the provided value',
env: {
GRIST_OIDC_SP_HTTP_TIMEOUT: '10000',
},
shouldSetTimeout: true,
expectedUserDefinedHttpOptions: {
timeout: 10000
}
},
{
itMsg: 'should allow disabling the timeout by having its value set to 0',
env: {
GRIST_OIDC_SP_HTTP_TIMEOUT: '0',
},
expectedUserDefinedHttpOptions: {
timeout: 0
}
}
].forEach(ctx => {
it(ctx.itMsg, async () => {
const setHttpOptionsDefaultsStub = sandbox.stub(custom, 'setHttpOptionsDefaults');
setEnvVars();
Object.assign(process.env, ctx.env);
const promise = OIDCConfigStubbed.buildWithStub();
if (ctx.expectedErrorMsg) {
await assert.isRejected(promise, ctx.expectedErrorMsg);
} else {
await assert.isFulfilled(promise, 'initOIDC should have been fulfilled');
assert.isTrue(setHttpOptionsDefaultsStub.calledOnce, 'Should have called custom.setHttpOptionsDefaults');
assert.deepEqual(setHttpOptionsDefaultsStub.firstCall.args[0], ctx.expectedUserDefinedHttpOptions);
}
});
});
});
});
describe('GRIST_OIDC_IDP_ENABLED_PROTECTIONS', () => {