Skip to content

Commit

Permalink
handle noop modifier as multiple underscores. AG-23891
Browse files Browse the repository at this point in the history 
Squashed commit of the following:

commit 8046efe
Author: David Tota <[email protected]>
Date:   Wed Aug 9 11:14:11 2023 +0300

    specify comment for special case

commit efa067d
Author: Slava Leleka <[email protected]>
Date:   Tue Aug 8 18:46:36 2023 +0300

    revert check-compatibility-tables

commit 601fce7
Author: Slava Leleka <[email protected]>
Date:   Tue Aug 8 18:45:55 2023 +0300

    handle noop modifier as multiple underscores

commit eea2cba
Merge: 967b677 2dd7e89
Author: Slava Leleka <[email protected]>
Date:   Tue Aug 8 16:21:43 2023 +0300

    Merge branch 'master' of ssh://bit.adguard.com:7999/adguard-filters/tsurlfilter

commit 967b677
Merge: 15b9b3a 3fa26b5
Author: Slava Leleka <[email protected]>
Date:   Tue Aug 8 14:25:58 2023 +0300

    Merge branch 'master' of ssh://bit.adguard.com:7999/adguard-filters/tsurlfilter

commit 15b9b3a
Merge: 86198ef 43db0f5
Author: Slava Leleka <[email protected]>
Date:   Tue Aug 8 13:28:01 2023 +0300

    Merge branch 'master' of ssh://bit.adguard.com:7999/adguard-filters/tsurlfilter

commit 86198ef
Merge: 9b099fb 7de315b
Author: Slava Leleka <[email protected]>
Date:   Mon Jul 31 19:46:51 2023 +0300

    Merge branch 'master' of ssh://bit.adguard.com:7999/adguard-filters/tsurlfilter

commit 9b099fb
Merge: a7d6b21 5c9457a
Author: Slava Leleka <[email protected]>
Date:   Fri Jul 28 17:55:30 2023 +0300

    Merge branch 'master' of ssh://bit.adguard.com:7999/adguard-filters/tsurlfilter

commit a7d6b21
Merge: 0045b38 9b26e0b
Author: Slava Leleka <[email protected]>
Date:   Mon Jul 24 16:35:23 2023 +0300

    Merge branch 'master' of ssh://bit.adguard.com:7999/adguard-filters/tsurlfilter

commit 0045b38
Author: Slava Leleka <[email protected]>
Date:   Wed Jul 19 20:58:46 2023 +0300

    Revert "add simple value_format for app modifier"

    This reverts commit a5b3f70.

commit 691c0c5
Author: Slava Leleka <[email protected]>
Date:   Wed Jul 19 20:54:16 2023 +0300

    improve check-compatibility-tables

commit a5b3f70
Author: Slava Leleka <[email protected]>
Date:   Wed Jul 19 20:53:21 2023 +0300

    add simple value_format for app modifier
  • Loading branch information
@slavaleleka
slavaleleka committed Aug 9, 2023
1 parent 2dd7e89 commit 71dffc2
Show file tree
Hide file tree
Showing 3 changed files with 52 additions and 6 deletions.
1 change: 1 addition & 0 deletions packages/agtree/src/validator/constants.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,5 @@ export const INVALID_ERROR_PREFIX = {
NOT_NEGATABLE: 'Not negatable modifier',
VALUE_REQUIRED: 'Value is required for the modifier',
VALUE_FORBIDDEN: 'Value is not allowed for the modifier',
INVALID_NOOP: 'Invalid noop modifier',
};
32 changes: 31 additions & 1 deletion packages/agtree/src/validator/index.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
* @file Validator for modifiers.
*/

import cloneDeep from 'clone-deep';

import {
type ModifierData,
type ModifierDataMap,
Expand All @@ -10,6 +12,7 @@ import {
} from '../compatibility-tables';
import { Modifier } from '../parser/common';
import { AdblockSyntax } from '../utils/adblockers';
import { UNDERSCORE } from '../utils/constants';
import { INVALID_ERROR_PREFIX } from './constants';

const BLOCKER_PREFIX = {
Expand Down Expand Up @@ -209,6 +212,17 @@ const getBlockerDocumentationLink = (
return specificBlockerData?.docs || null;
};

/**
* Validates the noop modifier (i.e. only underscores).
*
* @param value Value of the modifier.
*
* @returns True if the modifier is valid, false otherwise.
*/
const isValidNoopModifier = (value: string): boolean => {
return value.split('').every((char) => char === UNDERSCORE);
};

/**
* Modifier validator class.
*/
Expand Down Expand Up @@ -259,7 +273,23 @@ class ModifierValidator {
*
* @returns Result of modifier validation.
*/
public validate = (syntax: AdblockSyntax, modifier: Modifier, isException = false): ValidationResult => {
public validate = (syntax: AdblockSyntax, rawModifier: Modifier, isException = false): ValidationResult => {
const modifier = cloneDeep(rawModifier);

// special case: handle noop modifier which may be used as multiple underscores (not just one)
// https://adguard.com/kb/general/ad-filtering/create-own-filters/#noop-modifier
if (modifier.modifier.value.startsWith(UNDERSCORE)) {
// check whether the modifier value contains something else besides underscores
if (!isValidNoopModifier(modifier.modifier.value)) {
return getInvalidValidationResult(
`${INVALID_ERROR_PREFIX.INVALID_NOOP}: '${modifier.modifier.value}'`,
);
}
// otherwise, replace the modifier value with single underscore.
// it is needed to check whether the modifier is supported by specific adblocker due to the syntax
modifier.modifier.value = UNDERSCORE;
}

if (!this.exists(modifier)) {
return getInvalidValidationResult(`${INVALID_ERROR_PREFIX.NOT_EXISTENT}: '${modifier.modifier.value}'`);
}
Expand Down
25 changes: 20 additions & 5 deletions packages/agtree/test/validator/index.test.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -174,6 +174,8 @@ describe('ModifierValidator', () => {
'app=com.test.app',
'~third-party',
'badfilter',
// valid noop modifiers may be used like this:
'____',
];
test.each(supportedModifiers)('%s', (rawModifier) => {
const modifier = getModifier(rawModifier);
Expand All @@ -196,7 +198,7 @@ describe('ModifierValidator', () => {
});
});

describe('unsupported', () => {
describe('invalid', () => {
const unsupportedModifiersCases = [
{
actual: 'not-existent',
Expand Down Expand Up @@ -246,6 +248,10 @@ describe('ModifierValidator', () => {
actual: 'third-party=true',
expected: INVALID_ERROR_PREFIX.VALUE_FORBIDDEN,
},
{
actual: '__noop__',
expected: INVALID_ERROR_PREFIX.INVALID_NOOP,
},
];
test.each(unsupportedModifiersCases)('$actual', ({ actual, expected }) => {
const modifier = getModifier(actual);
Expand Down Expand Up @@ -322,12 +328,13 @@ describe('ModifierValidator', () => {
});

describe('validate for UblockOrigin', () => {
describe('supported', () => {
describe('valid', () => {
const supportedModifiers = [
'all',
'~third-party',
'badfilter',
'popunder',
'____',
];
test.each(supportedModifiers)('%s', (rawModifier) => {
const modifier = getModifier(rawModifier);
Expand All @@ -336,7 +343,7 @@ describe('ModifierValidator', () => {
});
});

describe('unsupported', () => {
describe('invalid', () => {
const unsupportedModifiersCases = [
{
actual: 'not-existent',
Expand Down Expand Up @@ -386,6 +393,10 @@ describe('ModifierValidator', () => {
actual: 'third-party=true',
expected: INVALID_ERROR_PREFIX.VALUE_FORBIDDEN,
},
{
actual: '__-__',
expected: INVALID_ERROR_PREFIX.INVALID_NOOP,
},
];
test.each(unsupportedModifiersCases)('$actual', ({ actual, expected }) => {
const modifier = getModifier(actual);
Expand Down Expand Up @@ -451,7 +462,7 @@ describe('ModifierValidator', () => {
});

describe('validate for AdblockPlus', () => {
describe('supported', () => {
describe('valid', () => {
const supportedModifiers = [
'domain=example.com',
'third-party',
Expand All @@ -465,7 +476,7 @@ describe('ModifierValidator', () => {
});
});

describe('unsupported', () => {
describe('invalid', () => {
const unsupportedModifiersCases = [
{
actual: 'not-existent',
Expand Down Expand Up @@ -507,6 +518,10 @@ describe('ModifierValidator', () => {
actual: 'third-party=true',
expected: INVALID_ERROR_PREFIX.VALUE_FORBIDDEN,
},
{
actual: '___',
expected: INVALID_ERROR_PREFIX.NOT_SUPPORTED,
},
];
test.each(unsupportedModifiersCases)('$actual', ({ actual, expected }) => {
const modifier = getModifier(actual);
Expand Down

0 comments on commit 71dffc2

Please sign in to comment.