prevent-requestAnimationFrame.js

import {
    hit,
    noopFunc,
    parseMatchArg,
    isValidStrPattern,
    isValidCallback,
    logMessage,
    escapeRegExp,
    toRegExp,
} from '../helpers';

/* eslint-disable max-len */
/**
 * @scriptlet prevent-requestAnimationFrame
 *
 * @description
 * Prevents a `requestAnimationFrame` call
 * if the text of the callback is matching the specified search string which does not start with `!`;
 * otherwise mismatched calls should be defused.
 *
 * Related UBO scriptlet:
 * https://github.com/gorhill/uBlock/wiki/Resources-Library#no-requestanimationframe-ifjs-
 *
 * ### Syntax
 *
 * ```text
 * example.org#%#//scriptlet('prevent-requestAnimationFrame'[, search])
 * ```
 *
 * - `search` — optional, string or regular expression;
 *   invalid regular expression will be skipped and all callbacks will be matched.
 *   If starts with `!`, scriptlet will not match the stringified callback but all other will be defused.
 *   If do not start with `!`, the stringified callback will be matched.
 *
 * > Call with no argument will log all requestAnimationFrame calls,
 * > it may be useful for debugging but it is not allowed for prod versions of filter lists.
 *
 * ### Examples
 *
 * 1. Prevents `requestAnimationFrame` calls if the callback matches `/\.test/`
 *
 *     ```adblock
 *     example.org#%#//scriptlet('prevent-requestAnimationFrame', '/\.test/')
 *     ```
 *
 *     For instance, the following call will be prevented:
 *
 *     ```javascript
 *     var times = 0;
 *     requestAnimationFrame(function change() {
 *         window.test = 'new value';
 *         if (times < 2) {
 *             times += 1;
 *             requestAnimationFrame(change);
 *         }
 *     });
 *     ```
 *
 * 1. Prevents `requestAnimationFrame` calls if **does not match** 'check'
 *
 *     ```adblock
 *     example.org#%#//scriptlet('prevent-requestAnimationFrame', '!check')
 *     ```
 *
 *     For instance, only the first call will be prevented:
 *
 *     ```javascript
 *     var timesFirst = 0;
 *     requestAnimationFrame(function changeFirst() {
 *         window.check = 'should not be prevented';
 *         if (timesFirst < 2) {
 *             timesFirst += 1;
 *             requestAnimationFrame(changeFirst);
 *         }
 *     });
 *
 *     var timesSecond = 0;
 *     requestAnimationFrame(function changeSecond() {
 *         window.second = 'should be prevented';
 *         if (timesSecond < 2) {
 *             timesSecond += 1;
 *             requestAnimationFrame(changeSecond);
 *         }
 *     });
 *     ```
 *
 * @added v1.1.15.
 */
/* eslint-enable max-len */

export function preventRequestAnimationFrame(source, match) {
    const nativeRequestAnimationFrame = window.requestAnimationFrame;

    // logs requestAnimationFrame to console if no arguments have been specified
    const shouldLog = typeof match === 'undefined';

    const { isInvertedMatch, matchRegexp } = parseMatchArg(match);

    const rafWrapper = (callback, ...args) => {
        let shouldPrevent = false;
        if (shouldLog) {
            hit(source);
            logMessage(source, `requestAnimationFrame(${String(callback)})`, true);
        } else if (isValidCallback(callback) && isValidStrPattern(match)) {
            shouldPrevent = matchRegexp.test(callback.toString()) !== isInvertedMatch;
        }

        if (shouldPrevent) {
            hit(source);
            return nativeRequestAnimationFrame(noopFunc);
        }

        return nativeRequestAnimationFrame.apply(window, [callback, ...args]);
    };

    window.requestAnimationFrame = rafWrapper;
}

export const preventRequestAnimationFrameNames = [
    'prevent-requestAnimationFrame',
    // aliases are needed for matching the related scriptlet converted into our syntax
    'no-requestAnimationFrame-if.js',
    'ubo-no-requestAnimationFrame-if.js',
    'norafif.js',
    'ubo-norafif.js',
    'ubo-no-requestAnimationFrame-if',
    'ubo-norafif',
];

// eslint-disable-next-line prefer-destructuring
preventRequestAnimationFrame.primaryName = preventRequestAnimationFrameNames[0];

preventRequestAnimationFrame.injections = [
    hit,
    noopFunc,
    parseMatchArg,
    isValidStrPattern,
    isValidCallback,
    logMessage,
    // following helpers should be injected as helpers above use them
    escapeRegExp,
    toRegExp,
];