Skip to content

Commit da02221

Browse files
stainless-app[bot]stainless-app[bot]
committed
chore(internal): codegen related update
1 parent f5206be commit da02221

File tree

8 files changed

+139
-34
lines changed

8 files changed

+139
-34
lines changed

‎image-kit-java-client-okhttp/src/main/kotlin/com/imagekit/api/client/okhttp/ImageKitOkHttpClient.kt‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ import com.fasterxml.jackson.databind.json.JsonMapper
66
import com.imagekit.api.client.ImageKitClient
77
import com.imagekit.api.client.ImageKitClientImpl
88
import com.imagekit.api.core.ClientOptions
9+
import com.imagekit.api.core.Sleeper
910
import com.imagekit.api.core.Timeout
1011
import com.imagekit.api.core.http.Headers
1112
import com.imagekit.api.core.http.HttpClient
@@ -120,6 +121,17 @@ class ImageKitOkHttpClient private constructor() {
120121
*/
121122
fun jsonMapper(jsonMapper: JsonMapper) = apply { clientOptions.jsonMapper(jsonMapper) }
122123

124+
/**
125+
* The interface to use for delaying execution, like during retries.
126+
*
127+
* This is primarily useful for using fake delays in tests.
128+
*
129+
* Defaults to real execution delays.
130+
*
131+
* This class takes ownership of the sleeper and closes it when closed.
132+
*/
133+
fun sleeper(sleeper: Sleeper) = apply { clientOptions.sleeper(sleeper) }
134+
123135
/**
124136
* The clock to use for operations that require timing, like retries.
125137
*

‎image-kit-java-client-okhttp/src/main/kotlin/com/imagekit/api/client/okhttp/ImageKitOkHttpClientAsync.kt‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ import com.fasterxml.jackson.databind.json.JsonMapper
66
import com.imagekit.api.client.ImageKitClientAsync
77
import com.imagekit.api.client.ImageKitClientAsyncImpl
88
import com.imagekit.api.core.ClientOptions
9+
import com.imagekit.api.core.Sleeper
910
import com.imagekit.api.core.Timeout
1011
import com.imagekit.api.core.http.Headers
1112
import com.imagekit.api.core.http.HttpClient
@@ -120,6 +121,17 @@ class ImageKitOkHttpClientAsync private constructor() {
120121
*/
121122
fun jsonMapper(jsonMapper: JsonMapper) = apply { clientOptions.jsonMapper(jsonMapper) }
122123

124+
/**
125+
* The interface to use for delaying execution, like during retries.
126+
*
127+
* This is primarily useful for using fake delays in tests.
128+
*
129+
* Defaults to real execution delays.
130+
*
131+
* This class takes ownership of the sleeper and closes it when closed.
132+
*/
133+
fun sleeper(sleeper: Sleeper) = apply { clientOptions.sleeper(sleeper) }
134+
123135
/**
124136
* The clock to use for operations that require timing, like retries.
125137
*

‎image-kit-java-core/src/main/kotlin/com/imagekit/api/core/ClientOptions.kt‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,16 @@ private constructor(
4141
* needs to be overridden.
4242
*/
4343
@get:JvmName("jsonMapper") val jsonMapper: JsonMapper,
44+
/**
45+
* The interface to use for delaying execution, like during retries.
46+
*
47+
* This is primarily useful for using fake delays in tests.
48+
*
49+
* Defaults to real execution delays.
50+
*
51+
* This class takes ownership of the sleeper and closes it when closed.
52+
*/
53+
@get:JvmName("sleeper") val sleeper: Sleeper,
4454
/**
4555
* The clock to use for operations that require timing, like retries.
4656
*
@@ -154,6 +164,7 @@ private constructor(
154164
private var httpClient: HttpClient? = null
155165
private var checkJacksonVersionCompatibility: Boolean = true
156166
private var jsonMapper: JsonMapper = jsonMapper()
167+
private var sleeper: Sleeper? = null
157168
private var clock: Clock = Clock.systemUTC()
158169
private var baseUrl: String? = null
159170
private var headers: Headers.Builder = Headers.builder()
@@ -170,6 +181,7 @@ private constructor(
170181
httpClient = clientOptions.originalHttpClient
171182
checkJacksonVersionCompatibility = clientOptions.checkJacksonVersionCompatibility
172183
jsonMapper = clientOptions.jsonMapper
184+
sleeper = clientOptions.sleeper
173185
clock = clientOptions.clock
174186
baseUrl = clientOptions.baseUrl
175187
headers = clientOptions.headers.toBuilder()
@@ -212,6 +224,17 @@ private constructor(
212224
*/
213225
fun jsonMapper(jsonMapper: JsonMapper) = apply { this.jsonMapper = jsonMapper }
214226

227+
/**
228+
* The interface to use for delaying execution, like during retries.
229+
*
230+
* This is primarily useful for using fake delays in tests.
231+
*
232+
* Defaults to real execution delays.
233+
*
234+
* This class takes ownership of the sleeper and closes it when closed.
235+
*/
236+
fun sleeper(sleeper: Sleeper) = apply { this.sleeper = PhantomReachableSleeper(sleeper) }
237+
215238
/**
216239
* The clock to use for operations that require timing, like retries.
217240
*
@@ -430,6 +453,7 @@ private constructor(
430453
*/
431454
fun build(): ClientOptions {
432455
val httpClient = checkRequired("httpClient", httpClient)
456+
val sleeper = sleeper ?: PhantomReachableSleeper(DefaultSleeper())
433457
val privateKey = checkRequired("privateKey", privateKey)
434458

435459
val headers = Headers.builder()
@@ -458,11 +482,13 @@ private constructor(
458482
httpClient,
459483
RetryingHttpClient.builder()
460484
.httpClient(httpClient)
485+
.sleeper(sleeper)
461486
.clock(clock)
462487
.maxRetries(maxRetries)
463488
.build(),
464489
checkJacksonVersionCompatibility,
465490
jsonMapper,
491+
sleeper,
466492
clock,
467493
baseUrl,
468494
headers.build(),
@@ -489,5 +515,6 @@ private constructor(
489515
*/
490516
fun close() {
491517
httpClient.close()
518+
sleeper.close()
492519
}
493520
}

‎image-kit-java-core/src/main/kotlin/com/imagekit/api/core/DefaultSleeper.kt‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
package com.imagekit.api.core
2+
3+
import java.time.Duration
4+
import java.util.Timer
5+
import java.util.TimerTask
6+
import java.util.concurrent.CompletableFuture
7+
8+
class DefaultSleeper : Sleeper {
9+
10+
private val timer = Timer("DefaultSleeper", true)
11+
12+
override fun sleep(duration: Duration) = Thread.sleep(duration.toMillis())
13+
14+
override fun sleepAsync(duration: Duration): CompletableFuture<Void> {
15+
val future = CompletableFuture<Void>()
16+
timer.schedule(
17+
object : TimerTask() {
18+
override fun run() {
19+
future.complete(null)
20+
}
21+
},
22+
duration.toMillis(),
23+
)
24+
return future
25+
}
26+
27+
override fun close() = timer.cancel()
28+
}

‎image-kit-java-core/src/main/kotlin/com/imagekit/api/core/PhantomReachableSleeper.kt‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
package com.imagekit.api.core
2+
3+
import java.time.Duration
4+
import java.util.concurrent.CompletableFuture
5+
6+
/**
7+
* A delegating wrapper around a [Sleeper] that closes it once it's only phantom reachable.
8+
*
9+
* This class ensures the [Sleeper] is closed even if the user forgets to do it.
10+
*/
11+
internal class PhantomReachableSleeper(private val sleeper: Sleeper) : Sleeper {
12+
13+
init {
14+
closeWhenPhantomReachable(this, sleeper)
15+
}
16+
17+
override fun sleep(duration: Duration) = sleeper.sleep(duration)
18+
19+
override fun sleepAsync(duration: Duration): CompletableFuture<Void> =
20+
sleeper.sleepAsync(duration)
21+
22+
override fun close() = sleeper.close()
23+
}

‎image-kit-java-core/src/main/kotlin/com/imagekit/api/core/Sleeper.kt‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
package com.imagekit.api.core
2+
3+
import java.time.Duration
4+
import java.util.concurrent.CompletableFuture
5+
6+
/**
7+
* An interface for delaying execution for a specified amount of time.
8+
*
9+
* Useful for testing and cleaning up resources.
10+
*/
11+
interface Sleeper : AutoCloseable {
12+
13+
/** Synchronously pauses execution for the given [duration]. */
14+
fun sleep(duration: Duration)
15+
16+
/** Asynchronously pauses execution for the given [duration]. */
17+
fun sleepAsync(duration: Duration): CompletableFuture<Void>
18+
19+
/** Overridden from [AutoCloseable] to not have a checked exception in its signature. */
20+
override fun close()
21+
}

‎image-kit-java-core/src/main/kotlin/com/imagekit/api/core/http/RetryingHttpClient.kt‎

Lines changed: 9 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
package com.imagekit.api.core.http
22

3+
import com.imagekit.api.core.DefaultSleeper
34
import com.imagekit.api.core.RequestOptions
5+
import com.imagekit.api.core.Sleeper
46
import com.imagekit.api.core.checkRequired
57
import com.imagekit.api.errors.ImageKitIoException
68
import com.imagekit.api.errors.ImageKitRetryableException
@@ -11,8 +13,6 @@ import java.time.OffsetDateTime
1113
import java.time.format.DateTimeFormatter
1214
import java.time.format.DateTimeParseException
1315
import java.time.temporal.ChronoUnit
14-
import java.util.Timer
15-
import java.util.TimerTask
1616
import java.util.UUID
1717
import java.util.concurrent.CompletableFuture
1818
import java.util.concurrent.ThreadLocalRandom
@@ -130,7 +130,10 @@ private constructor(
130130
return executeWithRetries(modifiedRequest, requestOptions)
131131
}
132132

133-
override fun close() = httpClient.close()
133+
override fun close() {
134+
httpClient.close()
135+
sleeper.close()
136+
}
134137

135138
private fun isRetryable(request: HttpRequest): Boolean =
136139
// Some requests, such as when a request body is being streamed, cannot be retried because
@@ -235,33 +238,14 @@ private constructor(
235238
class Builder internal constructor() {
236239

237240
private var httpClient: HttpClient? = null
238-
private var sleeper: Sleeper =
239-
object : Sleeper {
240-
241-
private val timer = Timer("RetryingHttpClient", true)
242-
243-
override fun sleep(duration: Duration) = Thread.sleep(duration.toMillis())
244-
245-
override fun sleepAsync(duration: Duration): CompletableFuture<Void> {
246-
val future = CompletableFuture<Void>()
247-
timer.schedule(
248-
object : TimerTask() {
249-
override fun run() {
250-
future.complete(null)
251-
}
252-
},
253-
duration.toMillis(),
254-
)
255-
return future
256-
}
257-
}
241+
private var sleeper: Sleeper? = null
258242
private var clock: Clock = Clock.systemUTC()
259243
private var maxRetries: Int = 2
260244
private var idempotencyHeader: String? = null
261245

262246
fun httpClient(httpClient: HttpClient) = apply { this.httpClient = httpClient }
263247

264-
@JvmSynthetic internal fun sleeper(sleeper: Sleeper) = apply { this.sleeper = sleeper }
248+
fun sleeper(sleeper: Sleeper) = apply { this.sleeper = sleeper }
265249

266250
fun clock(clock: Clock) = apply { this.clock = clock }
267251

@@ -272,17 +256,10 @@ private constructor(
272256
fun build(): HttpClient =
273257
RetryingHttpClient(
274258
checkRequired("httpClient", httpClient),
275-
sleeper,
259+
sleeper ?: DefaultSleeper(),
276260
clock,
277261
maxRetries,
278262
idempotencyHeader,
279263
)
280264
}
281-
282-
internal interface Sleeper {
283-
284-
fun sleep(duration: Duration)
285-
286-
fun sleepAsync(duration: Duration): CompletableFuture<Void>
287-
}
288265
}

‎image-kit-java-core/src/test/kotlin/com/imagekit/api/core/http/RetryingHttpClientTest.kt‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ import com.github.tomakehurst.wiremock.junit5.WireMockTest
66
import com.github.tomakehurst.wiremock.stubbing.Scenario
77
import com.imagekit.api.client.okhttp.OkHttpClient
88
import com.imagekit.api.core.RequestOptions
9+
import com.imagekit.api.core.Sleeper
910
import com.imagekit.api.errors.ImageKitRetryableException
1011
import java.io.InputStream
1112
import java.time.Duration
@@ -294,12 +295,14 @@ internal class RetryingHttpClientTest {
294295
.httpClient(failingHttpClient)
295296
.maxRetries(2)
296297
.sleeper(
297-
object : RetryingHttpClient.Sleeper {
298+
object : Sleeper {
298299

299300
override fun sleep(duration: Duration) {}
300301

301302
override fun sleepAsync(duration: Duration): CompletableFuture<Void> =
302303
CompletableFuture.completedFuture(null)
304+
305+
override fun close() {}
303306
}
304307
)
305308
.build()
@@ -333,12 +336,14 @@ internal class RetryingHttpClientTest {
333336
.httpClient(httpClient)
334337
// Use a no-op `Sleeper` to make the test fast.
335338
.sleeper(
336-
object : RetryingHttpClient.Sleeper {
339+
object : Sleeper {
337340

338341
override fun sleep(duration: Duration) {}
339342

340343
override fun sleepAsync(duration: Duration): CompletableFuture<Void> =
341344
CompletableFuture.completedFuture(null)
345+
346+
override fun close() {}
342347
}
343348
)
344349

0 commit comments

Comments
 (0)