mirror of
https://github.com/awatertrevi/infisical.git
synced 2026-10-06 09:26:47 +00:00
Merge pull request #4011 from Infisical/optimize-token-cleanup-job
Optimize token cleanup job
This commit is contained in:
@@ -30,10 +30,17 @@ export const identityAccessTokenDALFactory = (db: TDbClient) => {
|
|||||||
const removeExpiredTokens = async (tx?: Knex) => {
|
const removeExpiredTokens = async (tx?: Knex) => {
|
||||||
logger.info(`${QueueName.DailyResourceCleanUp}: remove expired access token started`);
|
logger.info(`${QueueName.DailyResourceCleanUp}: remove expired access token started`);
|
||||||
|
|
||||||
|
const BATCH_SIZE = 10000;
|
||||||
|
const MAX_RETRY_ON_FAILURE = 3;
|
||||||
|
const QUERY_TIMEOUT_MS = 10 * 60 * 1000; // 10 minutes
|
||||||
const MAX_TTL = 315_360_000; // Maximum TTL value in seconds (10 years)
|
const MAX_TTL = 315_360_000; // Maximum TTL value in seconds (10 years)
|
||||||
|
|
||||||
try {
|
let deletedTokenIds: { id: string }[] = [];
|
||||||
const docs = (tx || db)(TableName.IdentityAccessToken)
|
let numberOfRetryOnFailure = 0;
|
||||||
|
let isRetrying = false;
|
||||||
|
|
||||||
|
const getExpiredTokensQuery = (dbClient: Knex | Knex.Transaction) =>
|
||||||
|
dbClient(TableName.IdentityAccessToken)
|
||||||
.where({
|
.where({
|
||||||
isAccessTokenRevoked: true
|
isAccessTokenRevoked: true
|
||||||
})
|
})
|
||||||
@@ -47,34 +54,64 @@ export const identityAccessTokenDALFactory = (db: TDbClient) => {
|
|||||||
);
|
);
|
||||||
})
|
})
|
||||||
.orWhere((qb) => {
|
.orWhere((qb) => {
|
||||||
void qb.where("accessTokenTTL", ">", 0).andWhere((qb2) => {
|
void qb.where("accessTokenTTL", ">", 0).andWhereRaw(
|
||||||
void qb2
|
`
|
||||||
.where((qb3) => {
|
-- Check if the token's effective expiration time has passed.
|
||||||
void qb3
|
-- The expiration time is calculated by adding its TTL to its last renewal/creation time.
|
||||||
.whereNotNull("accessTokenLastRenewedAt")
|
COALESCE(
|
||||||
// accessTokenLastRenewedAt + convert_integer_to_seconds(accessTokenTTL) < present_date
|
"${TableName.IdentityAccessToken}"."accessTokenLastRenewedAt", -- Use last renewal time if available
|
||||||
.andWhereRaw(
|
"${TableName.IdentityAccessToken}"."createdAt" -- Otherwise, use creation time
|
||||||
`"${TableName.IdentityAccessToken}"."accessTokenLastRenewedAt" + make_interval(secs => LEAST("${TableName.IdentityAccessToken}"."accessTokenTTL", ?)) < NOW()`,
|
)
|
||||||
[MAX_TTL]
|
+ make_interval(
|
||||||
);
|
secs => LEAST(
|
||||||
})
|
"${TableName.IdentityAccessToken}"."accessTokenTTL", -- Token's specified TTL
|
||||||
.orWhere((qb3) => {
|
? -- Capped by MAX_TTL (parameterized value)
|
||||||
void qb3
|
)
|
||||||
.whereNull("accessTokenLastRenewedAt")
|
)
|
||||||
// created + convert_integer_to_seconds(accessTokenTTL) < present_date
|
< NOW() -- Check if the calculated time is before now
|
||||||
.andWhereRaw(
|
`,
|
||||||
`"${TableName.IdentityAccessToken}"."createdAt" + make_interval(secs => LEAST("${TableName.IdentityAccessToken}"."accessTokenTTL", ?)) < NOW()`,
|
[MAX_TTL]
|
||||||
[MAX_TTL]
|
);
|
||||||
);
|
});
|
||||||
});
|
|
||||||
|
do {
|
||||||
|
try {
|
||||||
|
const deleteBatch = async (dbClient: Knex | Knex.Transaction) => {
|
||||||
|
const idsToDeleteQuery = getExpiredTokensQuery(dbClient).select("id").limit(BATCH_SIZE);
|
||||||
|
return dbClient(TableName.IdentityAccessToken).whereIn("id", idsToDeleteQuery).del().returning("id");
|
||||||
|
};
|
||||||
|
|
||||||
|
if (tx) {
|
||||||
|
// eslint-disable-next-line no-await-in-loop
|
||||||
|
deletedTokenIds = await deleteBatch(tx);
|
||||||
|
} else {
|
||||||
|
// eslint-disable-next-line no-await-in-loop
|
||||||
|
deletedTokenIds = await db.transaction(async (trx) => {
|
||||||
|
await trx.raw(`SET statement_timeout = ${QUERY_TIMEOUT_MS}`);
|
||||||
|
return deleteBatch(trx);
|
||||||
});
|
});
|
||||||
})
|
}
|
||||||
.delete();
|
|
||||||
await docs;
|
numberOfRetryOnFailure = 0; // reset
|
||||||
logger.info(`${QueueName.DailyResourceCleanUp}: remove expired access token completed`);
|
} catch (error) {
|
||||||
} catch (error) {
|
numberOfRetryOnFailure += 1;
|
||||||
throw new DatabaseError({ error, name: "IdentityAccessTokenPrune" });
|
logger.error(error, "Failed to delete a batch of expired identity access tokens on pruning");
|
||||||
|
} finally {
|
||||||
|
// eslint-disable-next-line no-await-in-loop
|
||||||
|
await new Promise((resolve) => {
|
||||||
|
setTimeout(resolve, 10); // time to breathe for db
|
||||||
|
});
|
||||||
|
}
|
||||||
|
isRetrying = numberOfRetryOnFailure > 0;
|
||||||
|
} while (deletedTokenIds.length > 0 || (isRetrying && numberOfRetryOnFailure < MAX_RETRY_ON_FAILURE));
|
||||||
|
|
||||||
|
if (numberOfRetryOnFailure >= MAX_RETRY_ON_FAILURE) {
|
||||||
|
logger.error(
|
||||||
|
`IdentityAccessTokenPrune: Pruning failed and stopped after ${MAX_RETRY_ON_FAILURE} consecutive retries.`
|
||||||
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
logger.info(`${QueueName.DailyResourceCleanUp}: remove expired access token completed`);
|
||||||
};
|
};
|
||||||
|
|
||||||
return { ...identityAccessTokenOrm, findOne, removeExpiredTokens };
|
return { ...identityAccessTokenOrm, findOne, removeExpiredTokens };
|
||||||
|
|||||||
Reference in New Issue
Block a user