Skip to content

Commit 2b5f56c

Browse files
authored
Merge pull request #2573 from surishubham/testmuCom
Merge pull request #2572 from keys-github/salman-stage
2 parents 1a5bcda + 9606eb1 commit 2b5f56c

File tree

3 files changed

+43
-54
lines changed

3 files changed

+43
-54
lines changed

docs/appium-custom-headers.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ canonical: https://www.testmuai.com/support/docs/appium-custom-headers/
1717

1818
# CustomHeaders support for automation
1919

20-
Custom h?ad?rs provid? you th? ability to k??p crucial information about th? r?qu?st or r?spons?, such as th? m?thod, URL, and body cont?nt. You can modify th? param?t?rs of th? HTTP r?qu?sts d?liv?r?d by your t?sts by manipulating with th?s? h?ad?rs, th?r?by around fir?wall r?strictions.
20+
Custom headers provide you the ability to keep crucial information about the request or response, such as the method, URL, and body content. You can modify the parameters of the HTTP requests delivered by your tests by manipulating with these headers, thereby around firewall restrictions.
2121

22-
In this docum?ntation, w? will look at LambdaT?st CustomH?ad?rs, a `capability` that allows you to add custom h?ad?rs to your t?sts and bypass fir?wall r?strictions whil? p?rforming automat?d browser t?sting.
22+
In this documentation, we will look at LambdaTest CustomHeaders, a `capability` that allows you to add custom headers to your tests and bypass firewall restrictions while performing automated browser testing.
2323

2424

2525
## How to use CustomHeaders Capability on <BrandName />?
@@ -58,15 +58,15 @@ Custom headers serves different purposes for development and network communicati
5858
X-Session-ID: 1234567890
5959
```
6060

61-
2. **Content Negotiation**: D?t?rmin?s how th? cli?nt and s?rv?r d?cid? on th? data format to ?xchang?. For instanc?, th? "Acc?pt" h?ad?r can sp?cify th? format (lik? JSON or XML) that th? cli?nt pr?f?rs for th? r?spons? data.
61+
2. **Content Negotiation**: Determines how the client and server decide on the data format to exchange. For instance, the "Accept" header can specify the format (like JSON or XML) that the client prefers for the response data.
6262

6363
**Example**: `Accept` header specifies the client-preferred format of the response data.
6464

6565
```java
6666
Accept: application/json
6767
```
6868

69-
3. **Rate Limiting**: Custom h?ad?rs ar? oft?n us?d by APIs to provid? information about rat? limits. Th?y might s?nd h?ad?rs indicating how many r?qu?sts a cli?nt can mak? in a giv?n tim? p?riod, how many r?qu?sts th?y hav? l?ft, or wh?n th?y can mak? n?w r?qu?sts.
69+
3. **Rate Limiting**: Custom headers are often used by APIs to provide information about rate limits. They might send headers indicating how many requests a client can make in a given time period, how many requests they have left, or when they can make new requests.
7070

7171
**Example**
7272

@@ -76,55 +76,55 @@ X-RateLimit-Remaining: 56
7676
X-RateLimit-Reset: 1372700873
7777
```
7878

79-
4. **Debugging and Performance Tracking**: Som? s?rvic?s includ? custom h?ad?rs in th?ir r?spons?s to provid? additional information that can help in d?bugging or p?rformanc? tracking. This can includ? s?rv?r v?rsion numb?rs, ?x?cution tim?s, or oth?r int?rnal d?tails.
79+
4. **Debugging and Performance Tracking**: Some services include custom headers in their responses to provide additional information that can help in debugging or performance tracking. This can include server version numbers, execution times, or other internal details.
8080

8181
**Example**
8282

8383
```java
8484
X-Session-ID: 1234567890 //custom header X-Session-ID to track user sessions.
8585
```
8686

87-
5. **CORS (Cross-Origin Resource Sharing)**: Th? CORS standard us?s custom h?ad?rs to allow brows?rs and s?rv?rs to int?ract s?cur?ly with r?sourc?s from diff?r?nt origins. This includ?s h?ad?rs lik? "Acc?ss-Control-Allow-Origin" and "Acc?ss-Control-Allow-M?thods".
87+
5. **CORS (Cross-Origin Resource Sharing)**: The CORS standard uses custom headers to allow browsers and servers to interact securely with resources from different origins. This includes headers like "Access-Control-Allow-Origin" and "Access-Control-Allow-Methods".
8888

8989
**Example**
9090

9191
```java
9292
X-Session-ID: 1234567890 //custom header X-Session-ID to track user sessions.
9393
```
9494

95-
6. **Custom Application Logic**: Custom h?ad?rs can also b? us?d to impl?m?nt sp?cific application-l?v?l logic. For instanc?, a custom h?ad?r could b? us?d to d?t?rmin? th? languag? of th? r?spons?, to ?nabl? or disabl? f?atur?s, or to sp?cify v?rsion numb?rs for API v?rsioning.
95+
6. **Custom Application Logic**: Custom headers can also be used to implement specific application-level logic. For instance, a custom header could be used to determine the language of the response, to enable or disable features, or to specify version numbers for API versioning.
9696

9797
**Example**
9898

9999
```java
100100
X-Session-ID: 1234567890 //custom header X-Session-ID to track user sessions.
101101
```
102102

103-
7. **Bypassing Firewalls or Proxies**: In som? cas?s, custom h?ad?rs can b? us?d to bypass c?rtain n?twork r?strictions, such as fir?walls or proxy s?rv?rs. This should, how?v?r, b? don? r?sponsibly and in accordanc? with s?curity polici?s.
103+
7. **Bypassing Firewalls or Proxies**: In some cases, custom headers can be used to bypass certain network restrictions, such as firewalls or proxy servers. This should, however, be done responsibly and in accordance with security policies.
104104

105105
**Example**
106106

107107
```java
108108
X-Session-ID: 1234567890 //custom header X-Session-ID to track user sessions.
109109
```
110110

111-
8. **Server Health and Status Information**: Som? applications us? custom h?ad?rs to provid? h?alth and status information about th? s?rv?r or application. This can b? us?d for monitoring and maintaining th? h?alth of th? syst?m.
111+
8. **Server Health and Status Information**: Some applications use custom headers to provide health and status information about the server or application. This can be used for monitoring and maintaining the health of the system.
112112

113113
**Example**
114114

115115
```java
116116
X-Session-ID: 1234567890 //custom header X-Session-ID to track user sessions.
117117
```
118118

119-
9. **SEO Optimization**: Custom h?ad?rs lik? canonical and pagination h?ad?rs can b? us?d to guid? s?arch ?ngin?s and optimiz? SEO.
119+
9. **SEO Optimization**: Custom headers like canonical and pagination headers can be used to guide search engines and optimize SEO.
120120

121121
**Example**
122122

123123
```java
124124
X-Session-ID: 1234567890 //custom header X-Session-ID to track user sessions.
125125
```
126126

127-
10. **A/B Testing**: Custom h?ad?rs can b? us?d to control or track A/B t?sting, wh?r? diff?r?nt v?rsions of a s?rvic? ar? t?st?d against ?ach oth?r to d?t?rmin? which p?rforms b?tt?r.
127+
10. **A/B Testing**: Custom headers can be used to control or track A/B testing, where different versions of a service are tested against each other to determine which performs better.
128128

129129
**Example**
130130

docs/custom-headers.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -20,16 +20,16 @@ canonical: https://www.testmuai.com/support/docs/custom-headers/
2020

2121
import BrandName, { BRAND_URL } from '@site/src/component/BrandName';
2222

23-
Every modern software company knows the importance of robust testing. As the development environment becomes increasingly complex, the tools we use for testing have to evolve to keep up. But sometimes, obstacles arise that make testing more difficultone such obstacle being corporate firewalls. Designed to keep networks secure, these firewalls can occasionally interfere with your testing process.
23+
Every modern software company knows the importance of robust testing. As the development environment becomes increasingly complex, the tools we use for testing have to evolve to keep up. But sometimes, obstacles arise that make testing more difficultone such obstacle being corporate firewalls. Designed to keep networks secure, these firewalls can occasionally interfere with your testing process.
2424

2525
However, the software testing industry is nothing if not innovative. One solution that's gaining traction is the use of custom headers to bypass firewalls. Specifically, we'll explore how <BrandName />'s customHeaders and customUrlFilters capabilities give developers precise control over network requests and firewall bypassing during testing.
2626

27-
In this docum?ntation, w? will look at LambdaT?st CustomH?ad?rs, a capability that allows you to add custom h?ad?rs to your t?sts and bypass fir?wall r?strictions whil? p?rforming automat?d browser t?sting.
27+
In this documentation, we will look at LambdaTest CustomHeaders, a capability that allows you to add custom headers to your tests and bypass firewall restrictions while performing automated browser testing.
2828

2929
## About CustomHeaders
3030
---
3131

32-
Custom h?ad?rs provid? you th? ability to k??p crucial information about th? r?qu?st or r?spons?, such as th? m?thod, URL, and body cont?nt. You can modify th? param?t?rs of th? HTTP r?qu?sts d?liv?r?d by your t?sts by manipulating with th?s? h?ad?rs, th?r?by around fir?wall r?strictions.
32+
Custom headers provide you the ability to keep crucial information about the request or response, such as the method, URL, and body content. You can modify the parameters of the HTTP requests delivered by your tests by manipulating with these headers, thereby around firewall restrictions.
3333

3434
## How to use CustomHeaders Capability on <BrandName />?
3535
---
@@ -63,15 +63,15 @@ Custom headers serves different purposes for web development and network communi
6363
X-Session-ID: 1234567890
6464
```
6565

66-
2. **Content Negotiation**: D?t?rmin?s how th? cli?nt and s?rv?r d?cid? on th? data format to ?xchang?. For instanc?, th? "Acc?pt" h?ad?r can sp?cify th? format (lik? JSON or XML) that th? cli?nt pr?f?rs for th? r?spons? data.
66+
2. **Content Negotiation**: Determines how the client and server decide on the data format to exchange. For instance, the "Accept" header can specify the format (like JSON or XML) that the client prefers for the response data.
6767

6868
**Example**: `Accept` header specifies the client-preferred format of the response data.
6969

7070
```java
7171
Accept: application/json
7272
```
7373

74-
3. **Rate Limiting**: Custom h?ad?rs ar? oft?n us?d by APIs to provid? information about rat? limits. Th?y might s?nd h?ad?rs indicating how many r?qu?sts a cli?nt can mak? in a giv?n tim? p?riod, how many r?qu?sts th?y hav? l?ft, or wh?n th?y can mak? n?w r?qu?sts.
74+
3. **Rate Limiting**: Custom headers are often used by APIs to provide information about rate limits. They might send headers indicating how many requests a client can make in a given time period, how many requests they have left, or when they can make new requests.
7575

7676
**Example**
7777

@@ -81,55 +81,55 @@ X-RateLimit-Remaining: 56
8181
X-RateLimit-Reset: 1372700873
8282
```
8383

84-
4. **Debugging and Performance Tracking**: Som? s?rvic?s includ? custom h?ad?rs in th?ir r?spons?s to provid? additional information that can help in d?bugging or p?rformanc? tracking. This can includ? s?rv?r v?rsion numb?rs, ?x?cution tim?s, or oth?r int?rnal d?tails.
84+
4. **Debugging and Performance Tracking**: Some services include custom headers in their responses to provide additional information that can help in debugging or performance tracking. This can include server version numbers, execution times, or other internal details.
8585

8686
**Example**
8787

8888
```java
8989
X-Session-ID: 1234567890 //custom header X-Session-ID to track user sessions.
9090
```
9191

92-
5. **CORS (Cross-Origin Resource Sharing)**: Th? CORS standard us?s custom h?ad?rs to allow brows?rs and s?rv?rs to int?ract s?cur?ly with r?sourc?s from diff?r?nt origins. This includ?s h?ad?rs lik? "Acc?ss-Control-Allow-Origin" and "Acc?ss-Control-Allow-M?thods".
92+
5. **CORS (Cross-Origin Resource Sharing)**: The CORS standard uses custom headers to allow browsers and servers to interact securely with resources from different origins. This includes headers like "Access-Control-Allow-Origin" and "Access-Control-Allow-Methods".
9393

9494
**Example**
9595

9696
```java
9797
X-Session-ID: 1234567890 //custom header X-Session-ID to track user sessions.
9898
```
9999

100-
6. **Custom Application Logic**: Custom h?ad?rs can also b? us?d to impl?m?nt sp?cific application-l?v?l logic. For instanc?, a custom h?ad?r could b? us?d to d?t?rmin? th? languag? of th? r?spons?, to ?nabl? or disabl? f?atur?s, or to sp?cify v?rsion numb?rs for API v?rsioning.
100+
6. **Custom Application Logic**: Custom headers can also be used to implement specific application-level logic. For instance, a custom header could be used to determine the language of the response, to enable or disable features, or to specify version numbers for API versioning.
101101

102102
**Example**
103103

104104
```java
105105
X-Session-ID: 1234567890 //custom header X-Session-ID to track user sessions.
106106
```
107107

108-
7. **Bypassing Firewalls or Proxies**: In som? cas?s, custom h?ad?rs can b? us?d to bypass c?rtain n?twork r?strictions, such as fir?walls or proxy s?rv?rs. This should, how?v?r, b? don? r?sponsibly and in accordanc? with s?curity polici?s.
108+
7. **Bypassing Firewalls or Proxies**: In some cases, custom headers can be used to bypass certain network restrictions, such as firewalls or proxy servers. This should, however, be done responsibly and in accordance with security policies.
109109

110110
**Example**
111111

112112
```java
113113
X-Session-ID: 1234567890 //custom header X-Session-ID to track user sessions.
114114
```
115115

116-
8. **Server Health and Status Information**: Som? applications us? custom h?ad?rs to provid? h?alth and status information about th? s?rv?r or application. This can b? us?d for monitoring and maintaining th? h?alth of th? syst?m.
116+
8. **Server Health and Status Information**: Some applications use custom headers to provide health and status information about the server or application. This can be used for monitoring and maintaining the health of the system.
117117

118118
**Example**
119119

120120
```java
121121
X-Session-ID: 1234567890 //custom header X-Session-ID to track user sessions.
122122
```
123123

124-
9. **SEO Optimization**: Custom h?ad?rs lik? canonical and pagination h?ad?rs can b? us?d to guid? s?arch ?ngin?s and optimiz? SEO.
124+
9. **SEO Optimization**: Custom headers like canonical and pagination headers can be used to guide search engines and optimize SEO.
125125

126126
**Example**
127127

128128
```java
129129
X-Session-ID: 1234567890 //custom header X-Session-ID to track user sessions.
130130
```
131131

132-
10. **A/B Testing**: Custom h?ad?rs can b? us?d to control or track A/B t?sting, wh?r? diff?r?nt v?rsions of a s?rvic? ar? t?st?d against ?ach oth?r to d?t?rmin? which p?rforms b?tt?r.
132+
10. **A/B Testing**: Custom headers can be used to control or track A/B testing, where different versions of a service are tested against each other to determine which performs better.
133133

134134
**Example**
135135

@@ -149,7 +149,7 @@ Custom headers are an integral part of HTTP requests and responses. They can car
149149

150150
## Targeted Control with customUrlFilters
151151

152-
To provide even more precise control, <BrandName /> introduces the customUrlFilters capability. When used in conjunction with customHeaders, it allows you to specify exactly which URLs should receive the custom headers. This ensures that headers are not indiscriminately applied to every requestonly those matching your defined filters will carry the custom headers.
152+
To provide even more precise control, <BrandName /> introduces the customUrlFilters capability. When used in conjunction with customHeaders, it allows you to specify exactly which URLs should receive the custom headers. This ensures that headers are not indiscriminately applied to every requestonly those matching your defined filters will carry the custom headers.
153153

154154
### Key Behavior:
155155

@@ -186,7 +186,7 @@ A request to `https://lambdatest.github.io/sample-todo-app/` will not contain an
186186

187187
## A Responsible Approach to Bypassing Firewalls
188188

189-
While the ability to add and control custom headers is powerful, it's crucial to use it responsibly. Always follow your organization's security and compliance policies. These capabilities are designed to facilitate secure, realistic testingnot to bypass security controls inappropriately.
189+
While the ability to add and control custom headers is powerful, it's crucial to use it responsibly. Always follow your organization's security and compliance policies. These capabilities are designed to facilitate secure, realistic testingnot to bypass security controls inappropriately.
190190

191191
## Use Cases
192192

@@ -272,7 +272,7 @@ X-Experiment-ID: variant_b
272272

273273
## Conclusion
274274

275-
<BrandName />s customHeaders and customUrlFilters capabilities empower you to simulate complex request scenarios, bypass firewalls responsibly, and selectively apply network rulesproviding a flexible, developer-centric approach to browser testing.
275+
<BrandName />s customHeaders and customUrlFilters capabilities empower you to simulate complex request scenarios, bypass firewalls responsibly, and selectively apply network rulesproviding a flexible, developer-centric approach to browser testing.
276276

277277
By turning obstacles like firewalls into controllable conditions, <BrandName /> not only simplifies testing but enhances the realism and effectiveness of your QA process.
278278

0 commit comments

Comments
 (0)