Cleanup mpp utils (#5980)

* replace currentTimeMillis -> TimeMark

* cleanup mpp-utils

* move platform() to testing-support

* make compile

* fix coroutines test

Author: martinbonnin

libraries/apollo-mpp-utils/README.md

@@ -1,3 +1,5 @@
 # Module apollo-mpp-utils
 
-apollo-mpp-utils contains a few utilities for working with multiplatform projects. 
+apollo-mpp-utils contains a few utilities for working with multiplatform projects. 
+
+As of June 2024, it only contains `currentTimeMillis`. In most cases, we should replace that with `kotlin.time.TimeMark` but it's still used in `HttpInfo` as absolute timestamps, and we can't remove it just yet.

libraries/apollo-mpp-utils/api/apollo-mpp-utils.api

@@ -1,18 +1,4 @@
-public final class com/apollographql/apollo3/mpp/Platform : java/lang/Enum {
-	public static final field Js Lcom/apollographql/apollo3/mpp/Platform;
-	public static final field Jvm Lcom/apollographql/apollo3/mpp/Platform;
-	public static final field Native Lcom/apollographql/apollo3/mpp/Platform;
-	public static final field WasmJs Lcom/apollographql/apollo3/mpp/Platform;
-	public static fun getEntries ()Lkotlin/enums/EnumEntries;
-	public static fun valueOf (Ljava/lang/String;)Lcom/apollographql/apollo3/mpp/Platform;
-	public static fun values ()[Lcom/apollographql/apollo3/mpp/Platform;
-}
-
 public final class com/apollographql/apollo3/mpp/UtilsKt {
-	public static final fun currentThreadId ()Ljava/lang/String;
-	public static final fun currentThreadName ()Ljava/lang/String;
-	public static final fun currentTimeFormatted ()Ljava/lang/String;
 	public static final fun currentTimeMillis ()J
-	public static final fun platform ()Lcom/apollographql/apollo3/mpp/Platform;
 }
 

libraries/apollo-mpp-utils/api/apollo-mpp-utils.klib.api

@@ -6,18 +6,4 @@
 // - Show declarations: true
 
 // Library unique name: <com.apollographql.apollo3:apollo-mpp-utils>
-final enum class com.apollographql.apollo3.mpp/Platform : kotlin/Enum<com.apollographql.apollo3.mpp/Platform> { // com.apollographql.apollo3.mpp/Platform|null[0]
-    enum entry Js // com.apollographql.apollo3.mpp/Platform.Js|null[0]
-    enum entry Jvm // com.apollographql.apollo3.mpp/Platform.Jvm|null[0]
-    enum entry Native // com.apollographql.apollo3.mpp/Platform.Native|null[0]
-    enum entry WasmJs // com.apollographql.apollo3.mpp/Platform.WasmJs|null[0]
-    final fun valueOf(kotlin/String): com.apollographql.apollo3.mpp/Platform // com.apollographql.apollo3.mpp/Platform.valueOf|valueOf#static(kotlin.String){}[0]
-    final fun values(): kotlin/Array<com.apollographql.apollo3.mpp/Platform> // com.apollographql.apollo3.mpp/Platform.values|values#static(){}[0]
-    final val entries // com.apollographql.apollo3.mpp/Platform.entries|#static{}entries[0]
-        final fun <get-entries>(): kotlin.enums/EnumEntries<com.apollographql.apollo3.mpp/Platform> // com.apollographql.apollo3.mpp/Platform.entries.<get-entries>|<get-entries>#static(){}[0]
-}
-final fun com.apollographql.apollo3.mpp/currentThreadId(): kotlin/String // com.apollographql.apollo3.mpp/currentThreadId|currentThreadId(){}[0]
-final fun com.apollographql.apollo3.mpp/currentThreadName(): kotlin/String // com.apollographql.apollo3.mpp/currentThreadName|currentThreadName(){}[0]
-final fun com.apollographql.apollo3.mpp/currentTimeFormatted(): kotlin/String // com.apollographql.apollo3.mpp/currentTimeFormatted|currentTimeFormatted(){}[0]
 final fun com.apollographql.apollo3.mpp/currentTimeMillis(): kotlin/Long // com.apollographql.apollo3.mpp/currentTimeMillis|currentTimeMillis(){}[0]
-final fun com.apollographql.apollo3.mpp/platform(): com.apollographql.apollo3.mpp/Platform // com.apollographql.apollo3.mpp/platform|platform(){}[0]

libraries/apollo-mpp-utils/src/appleMain/kotlin/com/apollographql/apollo3/mpp/utils.kt

@@ -1,31 +1,8 @@
 package com.apollographql.apollo3.mpp
 
 import platform.Foundation.NSDate
-import platform.Foundation.NSDateFormatter
-import platform.Foundation.NSThread
 import platform.Foundation.timeIntervalSince1970
-import platform.posix.pthread_self
 
 actual fun currentTimeMillis(): Long {
   return (NSDate().timeIntervalSince1970 * 1000).toLong()
 }
-
-private val nsDateFormatter by lazy { NSDateFormatter().apply { dateFormat = "HH:mm:ss.SSS" } }
-
-actual fun currentTimeFormatted(): String {
-  return nsDateFormatter.stringFromDate(NSDate())
-}
-
-actual fun currentThreadId(): String {
-  return pthread_self()?.rawValue.toString()
-}
-
-actual fun currentThreadName(): String {
-  return if (NSThread.isMainThread) {
-    "main"
-  } else {
-    currentThreadId()
-  }
-}
-
-actual fun platform() = Platform.Native

libraries/apollo-mpp-utils/src/commonMain/kotlin/com/apollographql/apollo3/mpp/utils.kt

@@ -2,39 +2,7 @@
 
 package com.apollographql.apollo3.mpp
 
-import com.apollographql.apollo3.annotations.ApolloInternal
 import kotlin.jvm.JvmName
 
 expect fun currentTimeMillis(): Long
 
-/**
- * The current time as a human-readable String. Used for debugging.
- */
-@ApolloInternal
-expect fun currentTimeFormatted(): String
-
-expect fun currentThreadId(): String
-
-/**
- * The current thread name ("main" for the main thread). Used for debugging.
- */
-@ApolloInternal
-expect fun currentThreadName(): String
-
-enum class Platform {
-  Jvm,
-  Native,
-  Js,
-  WasmJs
-}
-
-/**
- * The current platform. This is used from tests because Double.toString() doesn't behave the same on JS and other platforms.
- * Prefer more specific functions like `assertMainThreadOnNative` when possible instead of checking the platform.
- */
-expect fun platform(): Platform
-
-// Helpful for debugging, but not wanted in the final library - uncomment as needed
-//fun log(message: String) {
-//  println("${currentTimeFormatted()} [${currentThreadName()}] $message")
-//}

libraries/apollo-mpp-utils/src/jsMain/kotlin/com/apollographql/apollo3/mpp/utils.kt

@@ -7,35 +7,3 @@ actual fun currentTimeMillis(): Long {
   return Date().getTime().toLong()
 }
 
-actual fun currentTimeFormatted(): String {
-  return Date().toISOString()
-}
-
-actual fun currentThreadId(): String {
-  return "js"
-}
-
-actual fun currentThreadName(): String {
-  return currentThreadId()
-}
-
-actual fun platform() = Platform.Js
-
-/**
- * Copyright 2014-2019 JetBrains s.r.o and contributors. Use of this source code is governed by the Apache 2.0 license.
- * From https://github.com/ktorio/ktor/blob/6cd529b2dcedfcfc4ca2af0f62704764e160d7fd/ktor-utils/js/src/io/ktor/util/PlatformUtilsJs.kt#L16
- */
-@ApolloInternal
-val isNode: Boolean by lazy {
-  js(
-      """
-      (typeof process !== 'undefined' 
-          && process.versions != null 
-          && process.versions.node != null) ||
-      (typeof window !== 'undefined' 
-          && typeof window.process !== 'undefined' 
-          && window.process.versions != null 
-          && window.process.versions.node != null)
-    """
-  ) as Boolean
-}

libraries/apollo-mpp-utils/src/jvmMain/kotlin/com/apollographql/apollo3/mpp/utils.kt

@@ -1,24 +1,6 @@
 package com.apollographql.apollo3.mpp
 
-import java.text.SimpleDateFormat
-import java.util.Locale
-
 actual fun currentTimeMillis(): Long {
   return System.currentTimeMillis()
 }
 
-private val simpleDateFormat by lazy { SimpleDateFormat("HH:mm:ss.SSS", Locale.ROOT) }
-
-actual fun currentTimeFormatted(): String {
-  return simpleDateFormat.format(currentTimeMillis())
-}
-
-actual fun currentThreadId(): String {
-  return Thread.currentThread().id.toString()
-}
-
-actual fun currentThreadName(): String {
-  return Thread.currentThread().name
-}
-
-actual fun platform() = Platform.Jvm

libraries/apollo-mpp-utils/src/wasmJsMain/kotlin/com/apollographql/apollo3/mpp/utils.wasmJs.kt

@@ -5,14 +5,3 @@ actual fun currentTimeMillis(): Long {
   return currentTimeMillis2().toLong()
 }
 
-actual fun currentTimeFormatted(): String = js("(new Date()).toISOString()")
-
-actual fun currentThreadId(): String {
-  return "wasm-js"
-}
-
-actual fun currentThreadName(): String {
-  return currentThreadId()
-}
-
-actual fun platform() = Platform.WasmJs

libraries/apollo-runtime/src/commonMain/kotlin/com/apollographql/apollo3/network/http/BatchingHttpInterceptor.kt

@@ -21,7 +21,6 @@ import com.apollographql.apollo3.exception.ApolloHttpException
 import com.apollographql.apollo3.exception.DefaultApolloException
 import com.apollographql.apollo3.exception.JsonDataException
 import com.apollographql.apollo3.internal.CloseableSingleThreadDispatcher
-import com.apollographql.apollo3.mpp.currentTimeMillis
 import kotlinx.coroutines.CompletableDeferred
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.async
@@ -35,6 +34,7 @@ import okio.BufferedSink
 import okio.use
 import kotlin.jvm.JvmOverloads
 import kotlin.jvm.JvmStatic
+import kotlin.time.TimeSource.Monotonic.markNow
 
 /**
  * An [HttpInterceptor] that batches HTTP queries to execute multiple at once.
@@ -68,7 +68,7 @@ class BatchingHttpInterceptor @JvmOverloads constructor(
     private val maxBatchSize: Int = 10,
     private val exposeErrorBody: Boolean = false,
 ) : HttpInterceptor {
-  private val creationTime = currentTimeMillis()
+  private val startMark = markNow()
   private val dispatcher = CloseableSingleThreadDispatcher()
   private val scope = CoroutineScope(dispatcher.coroutineDispatcher)
   private val mutex = Mutex()
@@ -107,7 +107,7 @@ class BatchingHttpInterceptor @JvmOverloads constructor(
       executePendingRequests()
     } else {
       scope.launch {
-        delay(batchIntervalMillis - ((currentTimeMillis() - creationTime) % batchIntervalMillis) - 1)
+        delay(batchIntervalMillis - (startMark.elapsedNow().inWholeMilliseconds % batchIntervalMillis) - 1)
         executePendingRequests()
       }
     }

libraries/apollo-runtime/src/commonMain/kotlin/com/apollographql/apollo3/network/websocket/internal/SubscribableWebSocket.kt

@@ -8,7 +8,6 @@ import com.apollographql.apollo3.exception.ApolloNetworkException
 import com.apollographql.apollo3.exception.ApolloWebSocketClosedException
 import com.apollographql.apollo3.exception.DefaultApolloException
 import com.apollographql.apollo3.exception.SubscriptionConnectionException
-import com.apollographql.apollo3.mpp.currentTimeMillis
 import com.apollographql.apollo3.network.websocket.CLOSE_GOING_AWAY
 import com.apollographql.apollo3.network.websocket.CLOSE_NORMAL
 import com.apollographql.apollo3.network.websocket.ClientMessage
@@ -35,6 +34,8 @@ import kotlinx.coroutines.Job
 import kotlinx.coroutines.cancel
 import kotlinx.coroutines.delay
 import kotlinx.coroutines.launch
+import kotlin.time.TimeMark
+import kotlin.time.TimeSource.Monotonic.markNow
 
 /**
  * A [SubscribableWebSocket] is the link between the lower level [WebSocket] and GraphQL.
@@ -63,7 +64,7 @@ internal class SubscribableWebSocket(
   private var shutdownCause: ApolloException? = null
   private var activeListeners = mutableMapOf<String, OperationListener>()
   private var pending = mutableListOf<ApolloRequest<*>>()
-  private var _lastActiveMillis: Long = 0
+  private var _lastActiveMark: TimeMark? = null
 
   private var webSocket: WebSocket
   init {
@@ -75,9 +76,9 @@ internal class SubscribableWebSocket(
     webSocket = webSocketEngine.newWebSocket(serverUrl, headers, this)
   }
 
-  val lastActiveMillis: Long
+  val lastActiveMark: TimeMark?
     get() = lock.withLock {
-      _lastActiveMillis
+      _lastActiveMark
     }
   val shutdown: Boolean
     get() = lock.withLock {
@@ -248,7 +249,7 @@ internal class SubscribableWebSocket(
       }
 
       if (activeListeners.isEmpty()) {
-        _lastActiveMillis = currentTimeMillis()
+        _lastActiveMark = markNow()
       }
       ret
     }
@@ -261,7 +262,7 @@ internal class SubscribableWebSocket(
   }
 
   fun markActive() = lock.withLock {
-    _lastActiveMillis = 0
+    _lastActiveMark = null
   }
 }