[Hack Week] ApiFaker: introduce new module and logic #13052
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,32 @@ | ||
| package com.woocommerce.android.apifaker | ||
|
|
||
| import android.os.Bundle | ||
| import android.view.LayoutInflater | ||
| import android.view.View | ||
| import android.view.ViewGroup | ||
| import androidx.compose.ui.platform.ComposeView | ||
| import androidx.compose.ui.platform.ViewCompositionStrategy | ||
| import androidx.navigation.findNavController | ||
| import com.woocommerce.android.apifaker.ui.ApiFakerNavHost | ||
| import com.woocommerce.android.ui.base.BaseFragment | ||
| import com.woocommerce.android.ui.compose.theme.WooThemeWithBackground | ||
| import com.woocommerce.android.ui.main.AppBarStatus | ||
|
|
||
| class ApiFakerHostFragment : BaseFragment() { | ||
| override val activityAppBarStatus: AppBarStatus | ||
| get() = AppBarStatus.Hidden | ||
|
|
||
| override fun onCreateView(inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle?): View? { | ||
| return ComposeView(requireContext()).apply { | ||
| setViewCompositionStrategy(ViewCompositionStrategy.DisposeOnViewTreeLifecycleDestroyed) | ||
|
|
||
| setContent { | ||
| WooThemeWithBackground { | ||
| ApiFakerNavHost( | ||
| onExit = { findNavController().navigateUp() } | ||
| ) | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } |
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
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,81 @@ | ||
| plugins { | ||
| alias(libs.plugins.android.library) | ||
| alias(libs.plugins.kotlin.android) | ||
| alias(libs.plugins.kotlin.compose) | ||
| alias(libs.plugins.google.dagger.hilt) | ||
| alias(libs.plugins.ksp) | ||
| } | ||
|
|
||
| repositories { | ||
| maven { | ||
| url 'https://a8c-libs.s3.amazonaws.com/android' | ||
| content { | ||
| includeGroup "org.wordpress" | ||
| includeGroup "org.wordpress.fluxc" | ||
| includeGroup "org.wordpress.fluxc.plugins" | ||
| includeGroup "org.wordpress.wellsql" | ||
| includeGroup "org.wordpress.mediapicker" | ||
| includeGroup "com.automattic" | ||
| includeGroup "com.automattic.tracks" | ||
|
Comment on lines
+13
to
+19
Contributor
There was a problem hiding this comment. Do you need all these? I see you only add FluxC as dependency (which also makes sense since it's where all the requests happen). But why include
Member
Author
There was a problem hiding this comment. I don't like this either, but I tried to just keep the same setup as what we have in the other modules, personally I think this code should be in the root build.gradle file, or better in a convention plugin, but since this is not the setup we have yet, I prefer to keep the same setup as the other modules here, as the |
||
| } | ||
| } | ||
|
|
||
| maven { | ||
| url "https://a8c-libs.s3.amazonaws.com/android/jcenter-mirror" | ||
| content { | ||
| includeVersion "com.android.volley", "volley", "1.1.1" | ||
| } | ||
| } | ||
| } | ||
|
|
||
| android { | ||
| namespace 'com.woocommerce.android.apifaker' | ||
|
|
||
| defaultConfig { | ||
| minSdkVersion gradle.ext.minSdkVersion | ||
| targetSdk gradle.ext.targetSdkVersion | ||
| compileSdk gradle.ext.compileSdkVersion | ||
|
|
||
| testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner" | ||
| } | ||
|
|
||
| buildFeatures { | ||
| compose true | ||
| } | ||
|
|
||
| compileOptions { | ||
| sourceCompatibility libs.versions.java.get() | ||
| targetCompatibility libs.versions.java.get() | ||
| } | ||
| } | ||
|
|
||
| dependencies { | ||
| implementation(libs.androidx.core.ktx) | ||
| implementation(libs.androidx.appcompat) | ||
| implementation(libs.androidx.navigation.compose) | ||
| implementation(libs.androidx.lifecycle.runtime.compose) | ||
|
|
||
| implementation(platform(libs.androidx.compose.bom)) | ||
| implementation(libs.androidx.compose.material.main) | ||
| implementation(libs.androidx.compose.runtime.livedata) | ||
| implementation(libs.androidx.compose.ui.tooling.preview) | ||
| implementation(libs.androidx.compose.material.icons.extended) | ||
| debugImplementation(libs.androidx.compose.ui.tooling.main) | ||
|
|
||
| implementation("${gradle.ext.fluxCBinaryPath}:${libs.versions.wordpress.fluxc.get()}") { | ||
| exclude group: "com.android.support" | ||
| exclude group: "org.wordpress", module: "utils" | ||
| } | ||
|
|
||
| implementation(libs.androidx.room.runtime) | ||
| implementation(libs.androidx.room.ktx) | ||
| ksp(libs.androidx.room.compiler) | ||
|
|
||
| implementation(libs.google.dagger.hilt.android.main) | ||
| implementation(libs.androidx.hilt.navigation.compose) | ||
| ksp(libs.google.dagger.hilt.compiler) | ||
|
|
||
| testImplementation(libs.junit) | ||
| testImplementation(libs.mockito.kotlin) | ||
| testImplementation(libs.mockito.inline) | ||
| } | ||
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,4 @@ | ||
| <?xml version="1.0" encoding="utf-8"?> | ||
| <manifest xmlns:android="http://schemas.android.com/apk/res/android"> | ||
|
|
||
| </manifest> |
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,51 @@ | ||
| package com.woocommerce.android.apifaker | ||
|
|
||
| import android.content.Context | ||
| import android.content.SharedPreferences | ||
| import com.woocommerce.android.apifaker.db.EndpointDao | ||
| import kotlinx.coroutines.CoroutineScope | ||
| import kotlinx.coroutines.Dispatchers | ||
| import kotlinx.coroutines.channels.awaitClose | ||
| import kotlinx.coroutines.flow.SharingStarted | ||
| import kotlinx.coroutines.flow.callbackFlow | ||
| import kotlinx.coroutines.flow.combine | ||
| import kotlinx.coroutines.flow.map | ||
| import kotlinx.coroutines.flow.stateIn | ||
| import javax.inject.Inject | ||
| import javax.inject.Singleton | ||
|
|
||
| private const val PREF_FILE_NAME = "api_faker" | ||
| private const val PREFERENCE_KEY = "api_faker_enabled" | ||
|
|
||
| @Singleton | ||
| internal class ApiFakerConfig @Inject constructor( | ||
| context: Context, | ||
| endpointDao: EndpointDao | ||
| ) { | ||
| private val configScope = CoroutineScope(Dispatchers.Main) | ||
| private val preferences = context.getSharedPreferences(PREF_FILE_NAME, Context.MODE_PRIVATE) | ||
|
|
||
| private val prefFlow = preferences.prefFlow(PREFERENCE_KEY, false) | ||
|
|
||
| val enabled = combine( | ||
| prefFlow, | ||
| endpointDao.observeEndpointsCount().map { it == 0 } | ||
| ) { pref, isEmpty -> | ||
| pref && !isEmpty | ||
| }.stateIn(configScope, SharingStarted.Eagerly, false) | ||
|
|
||
| fun setStatus(enabled: Boolean) { | ||
| preferences.edit().putBoolean(PREFERENCE_KEY, enabled).apply() | ||
| } | ||
|
|
||
| private fun SharedPreferences.prefFlow(key: String, defaultValue: Boolean) = callbackFlow { | ||
| val listener = SharedPreferences.OnSharedPreferenceChangeListener { _, listenerKey -> | ||
| if (listenerKey == key) { | ||
| trySend(getBoolean(key, defaultValue)) | ||
| } | ||
| } | ||
| registerOnSharedPreferenceChangeListener(listener) | ||
| trySend(getBoolean(key, defaultValue)) | ||
| awaitClose { unregisterOnSharedPreferenceChangeListener(listener) } | ||
| } | ||
| } |
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,53 @@ | ||
| package com.woocommerce.android.apifaker | ||
|
|
||
| import android.util.Log | ||
| import okhttp3.Interceptor | ||
| import okhttp3.Interceptor.Chain | ||
| import okhttp3.MediaType.Companion.toMediaType | ||
| import okhttp3.Protocol | ||
| import okhttp3.Response | ||
| import okhttp3.ResponseBody.Companion.toResponseBody | ||
| import okhttp3.internal.EMPTY_RESPONSE | ||
| import javax.inject.Inject | ||
|
|
||
| private const val ARTIFICIAL_DELAY_MS = 500L | ||
|
|
||
| internal class ApiFakerInterceptor @Inject constructor( | ||
| private val apiFakerConfig: ApiFakerConfig, | ||
| private val endpointProcessor: EndpointProcessor | ||
| ) : Interceptor { | ||
| @Suppress("TooGenericExceptionCaught", "SwallowedException") | ||
| override fun intercept(chain: Chain): Response { | ||
| if (!apiFakerConfig.enabled.value) { | ||
| return chain.proceed(chain.request()) | ||
| } | ||
|
|
||
| Log.d(LOG_TAG, "Intercepting request: ${chain.request().url}") | ||
| val request = chain.request() | ||
| val fakeResponse = try { | ||
| endpointProcessor.fakeRequestIfNeeded(request) | ||
| } catch (e: Exception) { | ||
| Log.w(LOG_TAG, "Faking request: ${chain.request()} failed, ignoring") | ||
| null | ||
| } | ||
|
|
||
| return if (fakeResponse != null) { | ||
| Log.d(LOG_TAG, "Matched request: ${chain.request().url}:\nSending Mocked Response: $fakeResponse") | ||
| Thread.sleep(ARTIFICIAL_DELAY_MS) | ||
| Response.Builder() | ||
| .request(request) | ||
| .protocol(Protocol.HTTP_1_1) | ||
| .message("Fake Response") | ||
| .code(fakeResponse.statusCode) | ||
| // TODO check if it's safe to always use JSON as the content type | ||
|
Contributor
There was a problem hiding this comment. Since the body of the faked request is anything the user inputs from the app, wouldn't it make more sense to leave
Member
Author
There was a problem hiding this comment. This is a good point; but for now I'll keep it like this, my rationale for hardcording
It should work as you expect from the app, the upper layer will try to deserialize the content, and would fail, then return a JSON error, this is what happens when we receive HTML instead of JSON (for example this case: p1723565504566789/1720009283.216679-slack-C6H8C3G23 |
||
| .body( | ||
| fakeResponse.body?.toResponseBody("application/json".toMediaType()) | ||
| ?: EMPTY_RESPONSE | ||
| ) | ||
| .addHeader("content-type", "application/json") | ||
| .build() | ||
| } else { | ||
| 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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This allows running unit tests for all modules instead of having to list all of them