Source Conditions

Source conditions allow you to specify criteria for matching network requests. These criteria define where the rules should be applied, such as specific URLs, hosts, or paths.

Let's explore the elements of source conditions from left to right:

Select Source to Match

Select whether the matching should be performed on the host or the full URL.

Operator

Choose from four operators to define how the matching should be performed:

Equals: Matches exactly the specified value.
Contains: Matches if the value includes the specified substring.
Regex: Enables pattern matching using regular expressions.
Wildcard: Allows flexible pattern matching using wildcard characters.

Source Matching Field

The value of this field varies based on the operator selected. For Equals, enter the exact string to match, such as the full URL if you select the URL in the source. For Contains, provide a substring for broad matching across all URLs containing this string. For Regex, enter a regex pattern to match. For Wildcard, use a wildcard pattern to specify the matching criteria.

Advanced Filters

Enhance your source conditions with additional filters. These can be accessed using the filters button next to the input field:

Page Domain Name
- Targets requests based on the domain of the page making the request.
- Useful when the same request (e.g., a CDN file) is made from multiple websites
Resource Type
- Filter by the type of resource being requested.
- Common types include:
  - script
  - stylesheet
  - image
  - xhr (XMLHttpRequest or fetch)
  - document, etc.
Request Method
- Filters requests based on the HTTP method (e.g., GET, POST, PUT, PATCH, DELETE, OPTIONS).

Test URL Condition

The test URL condition feature is only applicable when using regex or wildcard operators. A button labeled Test Regex or Test Wildcard appears when you select these options. This feature helps you validate whether the rule source URL condition you have set up works for the request URL you want it to work with, improving the rule creation and editing experience.

To test a URL condition:

Open a Rule Editor

Start by opening any rule editor in the interface where you can define and edit source URL conditions.

Enter the Source URL Condition

Input the source URL condition using either the Regex or Wildcard operator, depending on your requirements.

Test the URL Condition

Click on the Test Regex or Test Wildcard button (depending on the selected operator). This will open a test URL popup modal for validation.

This popup modal includes the following components:

Source Condition: Displays the source condition defined in the rule editor. It is editable, allowing adjustments as needed.
URL Field: Enter the complete URL you want the rule to be applied to.
Result: Displays whether the rule will apply to the entered URL.

Testing URL with Regex Condition

To test a URL with a regex pattern in the source URL condition, enter the complete URL in the URL field. The result will indicate whether the rule applies to the URL based on the regex pattern.

Examples:

Source Condition	Match with URL	Is Matched
`/^https://.github./`	`https://subdomain.github.io/`	Yes
`/^https://blog\\..*\\.com$/`	`https://blog.example.com/`	Yes
`/^((?!example).)*$/`	`https://www.examplewebsite.com/`	No

Ensure the regex pattern in the source condition is valid and enclosed with slashes (/).

Examples:

/^https://.*github.*/ ✅ Valid regex
/^https://.*github.* ❌ Invalid regex

Testing URL with Wildcard Condition

To test a URL with a wildcard pattern in the source URL condition, enter the complete URL in the URL field. The result will indicate whether the rule applies to the URL based on the wildcard pattern.

Examples:

Source Condition	Match with URL	Is Matched
`://*.yahoo.com`	`http://cricket.yahoo.com`	Yes
`google.com?param=*`	`https://www.google.com/page?param=value`	Yes
`example.com?param=*`	`https://www.examplewebsite.com/page?param=test`	No

Using Variables in Wildcard Patterns

When you use the wildcard (*) operator, each * acts as a capturing group. The matched values are automatically stored in corresponding variables like $1, $2, and so on. These variables can then be used in the destination configuration (e.g., redirect URL, response modification, etc.) to dynamically refer to parts of the matched URL.

Example:

Wildcard Pattern: https://example.com/product/*/details/*
Matched URL: https://example.com/product/123/details/shoes
Captured Variables:
- $1 = 123
- $2 = shoes

You can then use $1 and $2 in your rule actions, such as:

Redirect to: https://newstore.com/items/$1/info/$2
Result: https://newstore.com/items/123/info/shoes

This allows for powerful and dynamic rule creation using flexible wildcard patterns and extracted values.