Add support for intercepting CDN file requests #6295
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| /* | ||
| * Copyright (c) 2014-2026 Stream.io Inc. All rights reserved. | ||
| * | ||
| * Licensed under the Stream License; | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * https://github.com/GetStream/stream-chat-android/blob/main/LICENSE | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package io.getstream.chat.android.client.cdn | ||
|
|
||
| /** | ||
| * Class defining a CDN (Content Delivery Network) interface. | ||
| * Override to transform requests loading images/files from the custom CDN. | ||
| */ | ||
| public interface CDN { | ||
|
|
||
| /** | ||
| * Transforms a request for loading an image from the CDN. | ||
| * | ||
| * Implementations that perform blocking or network I/O must use `withContext` to switch to the | ||
| * appropriate dispatcher (e.g. `Dispatchers.IO`). | ||
| * | ||
| * @param url Original CDN url for the image. | ||
| * @return A [CDNRequest] holding the modified request URL and/or custom headers to include with the request. | ||
| */ | ||
| public suspend fun imageRequest(url: String): CDNRequest = CDNRequest(url) | ||
|
|
||
| /** | ||
| * Transforms a request for loading a non-image file from the CDN. | ||
| * | ||
| * Implementations that perform blocking or network I/O must use `withContext` to switch to the | ||
| * appropriate dispatcher (e.g. `Dispatchers.IO`). | ||
| * | ||
| * @param url Original CDN url for the file. | ||
| * @return A [CDNRequest] holding the modified request URL and/or custom headers to include with the request. | ||
| */ | ||
| public suspend fun fileRequest(url: String): CDNRequest = CDNRequest(url) | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| /* | ||
| * Copyright (c) 2014-2026 Stream.io Inc. All rights reserved. | ||
| * | ||
| * Licensed under the Stream License; | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * https://github.com/GetStream/stream-chat-android/blob/main/LICENSE | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package io.getstream.chat.android.client.cdn | ||
|
|
||
| /** | ||
| * Model representing the request for loading a file from a CDN. | ||
| * | ||
| * @param url Url of the file to load. | ||
| * @param headers Map of headers added to the request. | ||
| */ | ||
| public data class CDNRequest( | ||
| val url: String, | ||
| val headers: Map<String, String>? = null, | ||
| ) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,104 @@ | ||
| /* | ||
| * Copyright (c) 2014-2026 Stream.io Inc. All rights reserved. | ||
| * | ||
| * Licensed under the Stream License; | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * https://github.com/GetStream/stream-chat-android/blob/main/LICENSE | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package io.getstream.chat.android.client.cdn.internal | ||
|
|
||
| import android.net.Uri | ||
| import androidx.core.net.toUri | ||
| import androidx.media3.common.util.UnstableApi | ||
| import androidx.media3.datasource.DataSource | ||
| import androidx.media3.datasource.DataSpec | ||
| import androidx.media3.datasource.DefaultHttpDataSource | ||
| import androidx.media3.datasource.TransferListener | ||
| import io.getstream.chat.android.client.cdn.CDN | ||
| import io.getstream.chat.android.client.cdn.CDNRequest | ||
| import io.getstream.log.taggedLogger | ||
| import kotlinx.coroutines.Dispatchers | ||
| import kotlinx.coroutines.runBlocking | ||
|
|
||
| /** | ||
| * A [DataSource.Factory] that creates [CDNDataSource] instances which transform | ||
| * media requests through the [CDN.fileRequest] method before delegating to an upstream data source. | ||
| * | ||
| * @param cdn The CDN used to transform file request URLs and headers. | ||
| * @param upstreamFactory The factory for creating the upstream data source that performs the actual HTTP requests. | ||
| */ | ||
| @UnstableApi | ||
| internal class CDNDataSourceFactory( | ||
| private val cdn: CDN, | ||
| private val upstreamFactory: DataSource.Factory = DefaultHttpDataSource.Factory(), | ||
| ) : DataSource.Factory { | ||
| override fun createDataSource(): DataSource { | ||
| return CDNDataSource(cdn, upstreamFactory.createDataSource()) | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * A [DataSource] that transforms media requests through [CDN.fileRequest] before | ||
| * delegating to an upstream data source. This allows custom CDN implementations | ||
| * to rewrite URLs and inject headers for video/audio/voice recording playback via ExoPlayer. | ||
| * | ||
| * [CDN.fileRequest] is a suspend function and is called via [runBlocking] on [Dispatchers.IO]. | ||
| * This is safe because ExoPlayer always calls [open] from its loader thread, never the main thread. | ||
| */ | ||
| @UnstableApi | ||
| private class CDNDataSource( | ||
| private val cdn: CDN, | ||
| private val upstream: DataSource, | ||
| ) : DataSource { | ||
|
|
||
| private val logger by taggedLogger("Chat:CDNDataSource") | ||
|
|
||
| override fun open(dataSpec: DataSpec): Long { | ||
| val scheme = dataSpec.uri.scheme | ||
| if (scheme != "http" && scheme != "https") { | ||
| return upstream.open(dataSpec) | ||
| } | ||
| val url = dataSpec.uri.toString() | ||
| val cdnRequest = try { | ||
| runBlocking { | ||
| cdn.fileRequest(url) | ||
| } | ||
| } catch (@Suppress("TooGenericExceptionCaught") e: Exception) { | ||
| logger.e(e) { "[open] CDN.fileRequest() failed for url: $url. Falling back to original request." } | ||
| CDNRequest(url) | ||
| } | ||
| val mergedHeaders = buildMap { | ||
| putAll(dataSpec.httpRequestHeaders) | ||
| cdnRequest.headers?.let { putAll(it) } | ||
| } | ||
| val transformedSpec = dataSpec.buildUpon() | ||
| .setUri(cdnRequest.url.toUri()) | ||
| .setHttpRequestHeaders(mergedHeaders) | ||
| .build() | ||
| return upstream.open(transformedSpec) | ||
| } | ||
|
|
||
| override fun read(buffer: ByteArray, offset: Int, length: Int): Int = | ||
|
Check warning on line 90 in stream-chat-android-client/src/main/java/io/getstream/chat/android/client/cdn/internal/CDNDataSourceFactory.kt
|
||
| upstream.read(buffer, offset, length) | ||
|
|
||
| override fun close() { | ||
|
Check warning on line 93 in stream-chat-android-client/src/main/java/io/getstream/chat/android/client/cdn/internal/CDNDataSourceFactory.kt
|
||
| upstream.close() | ||
| } | ||
|
|
||
| override fun getUri(): Uri? = upstream.uri | ||
|
|
||
| override fun getResponseHeaders(): Map<String, List<String>> = upstream.responseHeaders | ||
|
|
||
| override fun addTransferListener(transferListener: TransferListener) { | ||
|
Check warning on line 101 in stream-chat-android-client/src/main/java/io/getstream/chat/android/client/cdn/internal/CDNDataSourceFactory.kt
|
||
| upstream.addTransferListener(transferListener) | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| /* | ||
| * Copyright (c) 2014-2026 Stream.io Inc. All rights reserved. | ||
| * | ||
| * Licensed under the Stream License; | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * https://github.com/GetStream/stream-chat-android/blob/main/LICENSE | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package io.getstream.chat.android.client.cdn.internal | ||
|
|
||
| import io.getstream.chat.android.client.cdn.CDN | ||
| import io.getstream.chat.android.client.cdn.CDNRequest | ||
| import io.getstream.log.taggedLogger | ||
| import kotlinx.coroutines.runBlocking | ||
| import okhttp3.Interceptor | ||
| import okhttp3.Response | ||
|
|
||
| /** | ||
| * OkHttp interceptor applying transformations to CDN requests. | ||
| */ | ||
| internal class CDNOkHttpInterceptor(private val cdn: CDN) : Interceptor { | ||
|
|
||
| private val logger by taggedLogger("Chat:CDNOkHttpInterceptor") | ||
|
|
||
| override fun intercept(chain: Interceptor.Chain): Response { | ||
| val originalUrl = chain.request().url.toString() | ||
| val (url, headers) = try { | ||
| runBlocking { | ||
| cdn.fileRequest(originalUrl) | ||
| } | ||
| } catch (@Suppress("TooGenericExceptionCaught") e: Exception) { | ||
| logger.e(e) { | ||
| "[intercept] CDN.fileRequest() failed for url: $originalUrl. " + | ||
| "Falling back to original request." | ||
| } | ||
VelikovPetar marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| CDNRequest(originalUrl) | ||
| } | ||
| val request = chain.request().newBuilder() | ||
| .url(url) | ||
| .apply { | ||
| headers?.forEach { | ||
| header(it.key, it.value) | ||
| } | ||
| } | ||
| .build() | ||
| return chain.proceed(request) | ||
| } | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.