chore: roll driver, mark 1.20.1 (#862)

microsoft · Mar 23, 2022 · fc07c91 · fc07c91
1 parent 6ae0df8
commit fc07c91
Show file tree

Hide file tree

Showing 14 changed files with 35 additions and 18 deletions.
diff --git a/driver-bundle/pom.xml b/driver-bundle/pom.xml
@@ -6,7 +6,7 @@
   <parent>
     <groupId>com.microsoft.playwright</groupId>
     <artifactId>parent-pom</artifactId>
-    <version>1.20.0</version>
+    <version>1.20.1</version>
   </parent>
 
   <artifactId>driver-bundle</artifactId>

diff --git a/driver/pom.xml b/driver/pom.xml
@@ -6,7 +6,7 @@
   <parent>
     <groupId>com.microsoft.playwright</groupId>
     <artifactId>parent-pom</artifactId>
-    <version>1.20.0</version>
+    <version>1.20.1</version>
   </parent>
 
   <artifactId>driver</artifactId>

diff --git a/examples/pom.xml b/examples/pom.xml
@@ -6,7 +6,7 @@
 
   <groupId>org.example</groupId>
   <artifactId>examples</artifactId>
-  <version>1.20.0</version>
+  <version>1.20.1</version>
   <name>Playwright Client Examples</name>
   <properties>
     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>

diff --git a/playwright/pom.xml b/playwright/pom.xml
@@ -7,7 +7,7 @@
   <parent>
     <groupId>com.microsoft.playwright</groupId>
     <artifactId>parent-pom</artifactId>
-    <version>1.20.0</version>
+    <version>1.20.1</version>
   </parent>
 
   <artifactId>playwright</artifactId>

diff --git a/playwright/src/main/java/com/microsoft/playwright/APIRequest.java b/playwright/src/main/java/com/microsoft/playwright/APIRequest.java
@@ -21,9 +21,9 @@
 import java.util.*;
 
 /**
- * Exposes API that can be used for the Web API testing. Each Playwright browser context has a APIRequestContext instance
- * attached which shares cookies with the page context. Its also possible to create a new APIRequestContext instance
- * manually. For more information see <a href="https://playwright.dev/java/docs/class-apirequestcontext">here</a>.
+ * Exposes API that can be used for the Web API testing. This class is used for creating {@code APIRequestContext} instance which
+ * in turn can be used for sending web requests. An instance of this class can be obtained via {@link Playwright#request
+ * Playwright.request()}. For more information see {@code APIRequestContext}.
  */
 public interface APIRequest {
   class NewContextOptions {

diff --git a/playwright/src/main/java/com/microsoft/playwright/APIRequestContext.java b/playwright/src/main/java/com/microsoft/playwright/APIRequestContext.java
@@ -21,9 +21,24 @@
 
 /**
  * This API is used for the Web API testing. You can use it to trigger API endpoints, configure micro-services, prepare
- * environment or the service to your e2e test. When used on {@code Page} or a {@code BrowserContext}, this API will automatically use
- * the cookies from the corresponding {@code BrowserContext}. This means that if you log in using this API, your e2e test will be
- * logged in and vice versa.
+ * environment or the service to your e2e test.
+ *
+ * <p> Each Playwright browser context has associated with it {@code APIRequestContext} instance which shares cookie storage with the
+ * browser context and can be accessed via {@link BrowserContext#request BrowserContext.request()} or {@link Page#request
+ * Page.request()}. It is also possible to create a new APIRequestContext instance manually by calling {@link
+ * APIRequest#newContext APIRequest.newContext()}.
+ *
+ * <p> **Cookie management**
+ *
+ * <p> {@code APIRequestContext} retuned by {@link BrowserContext#request BrowserContext.request()} and {@link Page#request
+ * Page.request()} shares cookie storage with the corresponding {@code BrowserContext}. Each API request will have {@code Cookie}
+ * header populated with the values from the browser context. If the API response contains {@code Set-Cookie} header it will
+ * automatically update {@code BrowserContext} cookies and requests made from the page will pick them up. This means that if you
+ * log in using this API, your e2e test will be logged in and vice versa.
+ *
+ * <p> If you want API requests to not interfere with the browser cookies you shoud create a new {@code APIRequestContext} by calling
+ * {@link APIRequest#newContext APIRequest.newContext()}. Such {@code APIRequestContext} object will have its own isolated cookie
+ * storage.
  */
 public interface APIRequestContext {
   class StorageStateOptions {

diff --git a/playwright/src/main/java/com/microsoft/playwright/Page.java b/playwright/src/main/java/com/microsoft/playwright/Page.java
@@ -4684,7 +4684,9 @@ default Response reload() {
    */
   Response reload(ReloadOptions options);
   /**
-   * API testing helper associated with this page. Requests made with this API will use page cookies.
+   * API testing helper associated with this page. This method returns the same instance as {@link BrowserContext#request
+   * BrowserContext.request()} on the page's context. See {@link BrowserContext#request BrowserContext.request()} for more
+   * details.
    */
   APIRequestContext request();
   /**

diff --git a/pom.xml b/pom.xml
@@ -6,7 +6,7 @@
 
   <groupId>com.microsoft.playwright</groupId>
   <artifactId>parent-pom</artifactId>
-  <version>1.20.0</version>
+  <version>1.20.1</version>
   <packaging>pom</packaging>
   <name>Playwright Parent Project</name>
   <description>Java library to automate Chromium, Firefox and WebKit with a single API.

diff --git a/scripts/CLI_VERSION b/scripts/CLI_VERSION
@@ -1 +1 @@
-1.20.0
+1.20.1
diff --git a/tools/api-generator/pom.xml b/tools/api-generator/pom.xml
@@ -6,7 +6,7 @@
 
   <groupId>com.microsoft.playwright</groupId>
   <artifactId>api-generator</artifactId>
-  <version>1.20.0</version>
+  <version>1.20.1</version>
   <name>Playwright - API Generator</name>
   <description>
     This is an internal module used to generate Java API from the upstream Playwright

diff --git a/tools/test-cli-version/pom.xml b/tools/test-cli-version/pom.xml
@@ -4,7 +4,7 @@
   <modelVersion>4.0.0</modelVersion>
   <groupId>com.microsoft.playwright</groupId>
   <artifactId>test-cli-version</artifactId>
-  <version>1.20.0</version>
+  <version>1.20.1</version>
   <name>Test Playwright Command Line Version</name>
   <properties>
     <compiler.version>1.8</compiler.version>

diff --git a/tools/test-local-installation/pom.xml b/tools/test-local-installation/pom.xml
@@ -4,7 +4,7 @@
   <modelVersion>4.0.0</modelVersion>
   <groupId>com.microsoft.playwright</groupId>
   <artifactId>test-local-installation</artifactId>
-  <version>1.20.0</version>
+  <version>1.20.1</version>
   <name>Test local installation</name>
   <description>Runs Playwright test suite (copied from playwright module) against locally cached Playwright</description>
   <properties>

diff --git a/tools/test-spring-boot-starter/pom.xml b/tools/test-spring-boot-starter/pom.xml
@@ -9,7 +9,7 @@
   </parent>
   <groupId>com.microsoft.playwright</groupId>
   <artifactId>test-spring-boot-starter</artifactId>
-  <version>1.20.0</version>
+  <version>1.20.1</version>
   <name>Test Playwright With Spring Boot</name>
   <properties>
     <spring.version>2.4.3</spring.version>

diff --git a/tools/update-docs-version/pom.xml b/tools/update-docs-version/pom.xml
@@ -6,7 +6,7 @@
 
   <groupId>com.microsoft.playwright</groupId>
   <artifactId>update-version</artifactId>
-  <version>1.20.0</version>
+  <version>1.20.1</version>
   <name>Playwright - Update Version in Documentation</name>
   <description>
     This is an internal module used to update versions in the documentation based on