Function checkRateLimitIfNeeded

lib/metadata/metadataUtils.js:262–315

* Check rate limiting if not already checked * * Extracts rate limit config from bucket metadata, caches it, and enforces limit. * Calls callback with error if rate limited, null if allowed or no rate limiting. * * @param {object} request - Request object * @param {AuthInfo} authInfo - AuthInf

(request, authInfo, bucketMD, log, callback)

 * @returns {undefined}
 */
function checkRateLimitIfNeeded(request, authInfo, bucketMD, log, callback) {
    // Skip if already checked or not enabled
    if (!requestNeedsRateCheck(request)) {
        return process.nextTick(callback, null);
    }

    // Extract rate limit config from bucket metadata and cache it
    const checks = [];
    const rateLimitConfig = extractRateLimitConfigFromRequest(request, authInfo, bucketMD, log);

    if (!request.rateLimitBucketAlreadyChecked && rateLimitConfig.bucket !== undefined) {
        cache.setCachedConfig(
            cache.namespace.bucket,
            bucketMD.getName(),
            rateLimitConfig.bucket,
            config.rateLimiting.bucket.configCacheTTL
        );
        cache.setCachedBucketOwner(bucketMD.getName(), bucketMD.getOwner(), config.rateLimiting.bucket.configCacheTTL);
        checks.push(...buildRateChecksFromConfig('bucket', bucketMD.getName(), rateLimitConfig.bucket));
        // eslint-disable-next-line no-param-reassign
        request.rateLimitBucketAlreadyChecked = true;
    }

    if (!request.rateLimitAccountAlreadyChecked && rateLimitConfig.account !== undefined) {
        cache.setCachedConfig(
            cache.namespace.account,
            authInfo.getCanonicalID(),
            rateLimitConfig.account,
            config.rateLimiting.account.configCacheTTL
        );
        checks.push(...buildRateChecksFromConfig('account', authInfo.getCanonicalID(), rateLimitConfig.account));
        // eslint-disable-next-line no-param-reassign
        request.rateLimitAccountAlreadyChecked = true;
    }

    const { allowed, rateLimitSource } = checkRateLimitsForRequest(checks, log);
    if (!allowed) {
        log.addDefaultFields({
            rateLimited: true,
            rateLimitSource,
        });

        if (request.serverAccessLog) {
            /* eslint-disable no-param-reassign */
            request.serverAccessLog.rateLimited = true;
            request.serverAccessLog.rateLimitSource = rateLimitSource;
            /* eslint-enable no-param-reassign */
        }

        return process.nextTick(callback, config.rateLimiting.error);
    }

    return process.nextTick(callback, null);
}

/** standardMetadataValidateBucketAndObj - retrieve bucket and object md from metadata
 * and check if user is authorized to access them.