Move VERSION to okhttp3.OkHttp.VERSION (#6059)

It was previously okhttp3.VERSION, which is awkward because either
you import the symbol (and then it's unclear whose VERSION you're
talking about) or your fully qualify it (and that's unusual on its
own when there are no conflicts.

Author: swankjesse

okhttp/src/main/java-templates/okhttp3/OkHttp.kt

@@ -13,7 +13,23 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-@file:JvmName("OkHttp")
 package okhttp3
 
-const val VERSION = "$projectVersion"
+object OkHttp {
+  /**
+   * This is a string like "4.5.0-RC1", "4.5.0", or "4.6.0-SNAPSHOT" indicating the version of
+   * OkHttp in the current runtime. Use this to include the OkHttp version in custom `User-Agent`
+   * headers.
+   *
+   * Official OkHttp releases follow [semantic versioning][semver]. Versions with the `-SNAPSHOT`
+   * qualifier are not unique and should only be used in development environments. If you create
+   * custom builds of OkHttp please include a qualifier your version name, like "4.7.0-mycompany.3".
+   * The version string is configured in the root project's `build.gradle`.
+   *
+   * Note that OkHttp's runtime version may be different from the version specified in your
+   * project's build file due to the dependency resolution features of your build tool.
+   *
+   * [semver]: https://semver.org
+   */
+  const val VERSION = "$projectVersion"
+}

okhttp/src/main/kotlin/okhttp3/internal/Util.kt

@@ -44,6 +44,7 @@ import okhttp3.EventListener
 import okhttp3.Headers
 import okhttp3.Headers.Companion.headersOf
 import okhttp3.HttpUrl
+import okhttp3.OkHttp
 import okhttp3.OkHttpClient
 import okhttp3.RequestBody.Companion.toRequestBody
 import okhttp3.Response
@@ -625,3 +626,5 @@ inline fun <T> Iterable<T>.filterList(predicate: T.() -> Boolean): List<T> {
   }
   return result
 }
+
+const val userAgent = "okhttp/${OkHttp.VERSION}"

okhttp/src/main/kotlin/okhttp3/internal/Version.kt

@@ -20,9 +20,10 @@
 import java.util.concurrent.TimeUnit;
 import java.util.concurrent.atomic.AtomicLong;
 import java.util.concurrent.atomic.AtomicReference;
-import okhttp3.internal.Version;
 import okio.ByteString;
 
+import static okhttp3.internal.Util.userAgent;
+
 /**
  * Exercises the web socket implementation against the <a
  * href="http://autobahn.ws/testsuite/">Autobahn Testsuite</a>.
@@ -131,7 +132,7 @@ private long getTestCount() throws IOException {
 
   private void updateReports() {
     final CountDownLatch latch = new CountDownLatch(1);
-    newWebSocket("/updateReports?agent=" + Version.userAgent, new WebSocketListener() {
+    newWebSocket("/updateReports?agent=" + userAgent, new WebSocketListener() {
       @Override public void onClosing(WebSocket webSocket, int code, String reason) {
         webSocket.close(1000, null);
         latch.countDown();

okhttp/src/test/java/okhttp3/AutobahnTester.java

@@ -62,7 +62,6 @@
 import okhttp3.internal.DoubleInetAddressDns;
 import okhttp3.internal.RecordingOkAuthenticator;
 import okhttp3.internal.Util;
-import okhttp3.internal.Version;
 import okhttp3.internal.http.RecordingProxySelector;
 import okhttp3.internal.io.InMemoryFileSystem;
 import okhttp3.mockwebserver.Dispatcher;
@@ -95,6 +94,7 @@
 import static okhttp3.CipherSuite.TLS_DH_anon_WITH_AES_128_GCM_SHA256;
 import static okhttp3.TestUtil.awaitGarbageCollection;
 import static okhttp3.internal.Internal.addHeaderLenient;
+import static okhttp3.internal.Util.userAgent;
 import static okhttp3.tls.internal.TlsUtil.localhost;
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.assertj.core.data.Offset.offset;
@@ -2711,7 +2711,7 @@ public void cancelWhileRequestHeadersAreSent_HTTP_2() throws Exception {
     executeSynchronously("/");
 
     RecordedRequest recordedRequest = server.takeRequest();
-    assertThat(recordedRequest.getHeader("User-Agent")).matches(Version.userAgent);
+    assertThat(recordedRequest.getHeader("User-Agent")).matches(userAgent);
   }
 
   @Test public void setFollowRedirectsFalse() throws Exception {
@@ -3024,7 +3024,7 @@ public void cancelWhileRequestHeadersAreSent_HTTP_2() throws Exception {
 
     RecordedRequest connect = server.takeRequest();
     assertThat(connect.getHeader("Private")).isNull();
-    assertThat(connect.getHeader("User-Agent")).isEqualTo(Version.userAgent);
+    assertThat(connect.getHeader("User-Agent")).isEqualTo(userAgent);
     assertThat(connect.getHeader("Proxy-Connection")).isEqualTo("Keep-Alive");
     assertThat(connect.getHeader("Host")).isEqualTo("android.com:443");
 

okhttp/src/test/java/okhttp3/CallTest.java

@@ -19,8 +19,8 @@ import org.assertj.core.api.Assertions.assertThat
 import org.junit.Test
 
 class OkHttpTest {
-    @Test
-    fun testVersion() {
-        assertThat(VERSION).matches("[0-9]+\\.[0-9]+\\.[0-9]+(-.+)?")
-    }
+  @Test
+  fun testVersion() {
+    assertThat(OkHttp.VERSION).matches("[0-9]+\\.[0-9]+\\.[0-9]+(-.+)?")
+  }
 }

okhttp/src/test/java/okhttp3/OkHttpTest.kt

@@ -63,7 +63,6 @@
 import okhttp3.internal.Internal;
 import okhttp3.internal.RecordingAuthenticator;
 import okhttp3.internal.RecordingOkAuthenticator;
-import okhttp3.internal.Version;
 import okhttp3.internal.platform.Platform;
 import okhttp3.mockwebserver.MockResponse;
 import okhttp3.mockwebserver.MockWebServer;
@@ -94,6 +93,7 @@
 import static java.util.concurrent.TimeUnit.NANOSECONDS;
 import static okhttp3.internal.Internal.addHeaderLenient;
 import static okhttp3.internal.Util.immutableListOf;
+import static okhttp3.internal.Util.userAgent;
 import static okhttp3.internal.http.StatusLine.HTTP_PERM_REDIRECT;
 import static okhttp3.internal.http.StatusLine.HTTP_TEMP_REDIRECT;
 import static okhttp3.mockwebserver.SocketPolicy.DISCONNECT_AFTER_REQUEST;
@@ -1002,7 +1002,7 @@ private void initResponseCache() {
     RecordedRequest connect = server.takeRequest();
     assertThat(connect.getHeader("Private")).isNull();
     assertThat(connect.getHeader("Proxy-Authorization")).isNull();
-    assertThat(connect.getHeader("User-Agent")).isEqualTo(Version.userAgent);
+    assertThat(connect.getHeader("User-Agent")).isEqualTo(userAgent);
     assertThat(connect.getHeader("Host")).isEqualTo("android.com:443");
     assertThat(connect.getHeader("Proxy-Connection")).isEqualTo("Keep-Alive");
 
@@ -3630,7 +3630,7 @@ private void zeroLengthPayload(String method) throws Exception {
     assertContent("abc", getResponse(newRequest("/")));
 
     RecordedRequest request = server.takeRequest();
-    assertThat(request.getHeader("User-Agent")).isEqualTo(Version.userAgent);
+    assertThat(request.getHeader("User-Agent")).isEqualTo(userAgent);
   }
 
   @Test public void urlWithSpaceInHost() {