Skip to content

CMM-2132: Send the app language slug when fetching blogging prompts #23057

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
nbradbury wants to merge 1 commit into
base: trunk
Choose a base branch
from
Draft

CMM-2132: Send the app language slug when fetching blogging prompts #23057

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion ...rdpress/android/ui/bloggingprompts/promptslist/usecase/FetchBloggingPromptsListUseCase.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package org.wordpress.android.ui.bloggingprompts.promptslist.usecase
import org.wordpress.android.fluxc.model.bloggingprompts.BloggingPromptModel
import org.wordpress.android.fluxc.store.bloggingprompts.BloggingPromptsStore
import org.wordpress.android.ui.mysite.SelectedSiteRepository
import org.wordpress.android.util.PerAppLocaleManager
import java.time.LocalDate
import java.time.ZoneId
import java.util.Date
Expand All @@ -11,6 +12,7 @@ import javax.inject.Inject
class FetchBloggingPromptsListUseCase @Inject constructor(
private val bloggingPromptsStore: BloggingPromptsStore,
private val selectedSiteRepository: SelectedSiteRepository,
private val perAppLocaleManager: PerAppLocaleManager,
) {
suspend fun execute(): Result {
return fetchBloggingPrompts()
Expand All @@ -35,7 +37,12 @@ class FetchBloggingPromptsListUseCase @Inject constructor(
.let { Date.from(it) }

return selectedSiteRepository.getSelectedSite()?.let { site ->
bloggingPromptsStore.fetchPrompts(site, NUMBER_OF_PROMPTS, fromDate)
bloggingPromptsStore.fetchPrompts(
site,
NUMBER_OF_PROMPTS,
fromDate,
perAppLocaleManager.getCurrentLocaleLanguageCode()
)
.takeUnless { it.isError }
?.model
}
Expand Down
11 changes: 9 additions & 2 deletions ...ess/android/ui/mysite/cards/dashboard/bloggingprompts/BloggingPromptCardViewModelSlice.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ import org.wordpress.android.ui.mysite.SiteNavigationAction
import org.wordpress.android.ui.pages.SnackbarMessageHolder
import org.wordpress.android.ui.prefs.AppPrefsWrapper
import org.wordpress.android.ui.utils.UiString
import org.wordpress.android.util.PerAppLocaleManager
import org.wordpress.android.viewmodel.Event
import java.time.LocalDate
import java.time.ZoneId
Expand All @@ -43,7 +44,8 @@ class BloggingPromptCardViewModelSlice @Inject constructor(
private val bloggingPromptsCardTrackHelper: BloggingPromptsCardTrackHelper,
private val bloggingPromptsPostTagProvider: BloggingPromptsPostTagProvider,
private val bloggingPromptCardBuilder: BloggingPromptCardBuilder,
private val promptsStore: BloggingPromptsStore
private val promptsStore: BloggingPromptsStore,
private val perAppLocaleManager: PerAppLocaleManager
) {
private val _onSnackbarMessage = MutableLiveData<Event<SnackbarMessageHolder>>()
val onSnackbarMessage = _onSnackbarMessage as LiveData<Event<SnackbarMessageHolder>>
Expand Down Expand Up @@ -91,7 +93,12 @@ class BloggingPromptCardViewModelSlice @Inject constructor(
isSinglePromptRefresh: Boolean = false
) {
val numOfPromptsToFetch = if (isSinglePromptRefresh) 1 else NUM_PROMPTS_TO_REQUEST
val result = promptsStore.fetchPrompts(selectedSite, numOfPromptsToFetch, Date())
val result = promptsStore.fetchPrompts(
selectedSite,
numOfPromptsToFetch,
Date(),
perAppLocaleManager.getCurrentLocaleLanguageCode()
)
when {
result.isError -> postLastState()
else -> {
Expand Down
16 changes: 12 additions & 4 deletions ...ess/android/ui/bloggingprompts/promptslist/usecase/FetchBloggingPromptsListUseCaseTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ import org.wordpress.android.ui.bloggingprompts.promptslist.BloggingPromptsListF
import org.wordpress.android.ui.bloggingprompts.promptslist.usecase.FetchBloggingPromptsListUseCase.Result.Failure
import org.wordpress.android.ui.bloggingprompts.promptslist.usecase.FetchBloggingPromptsListUseCase.Result.Success
import org.wordpress.android.ui.mysite.SelectedSiteRepository
import org.wordpress.android.util.PerAppLocaleManager
import java.util.Date

@ExperimentalCoroutinesApi
Expand All @@ -26,13 +27,17 @@ class FetchBloggingPromptsListUseCaseTest : BaseUnitTest() {

@Mock
lateinit var bloggingPromptsStore: BloggingPromptsStore

@Mock
lateinit var perAppLocaleManager: PerAppLocaleManager
lateinit var useCase: FetchBloggingPromptsListUseCase

@Before
fun setUp() {
useCase = FetchBloggingPromptsListUseCase(
bloggingPromptsStore = bloggingPromptsStore,
selectedSiteRepository = selectedSiteRepository
selectedSiteRepository = selectedSiteRepository,
perAppLocaleManager = perAppLocaleManager
)
}

Expand All @@ -48,7 +53,8 @@ class FetchBloggingPromptsListUseCaseTest : BaseUnitTest() {
@Test
fun `given fetching prompts fails, when execute is called, then return failure`() = test {
whenever(selectedSiteRepository.getSelectedSite()).thenReturn(SiteModel().apply { id = 1 })
whenever(bloggingPromptsStore.fetchPrompts(any(), any(), any()))
whenever(perAppLocaleManager.getCurrentLocaleLanguageCode()).thenReturn("en")
whenever(bloggingPromptsStore.fetchPrompts(any(), any(), any(), any()))
.thenReturn(BloggingPromptsResult(error = mock()))

val result = useCase.execute()
Expand All @@ -62,7 +68,8 @@ class FetchBloggingPromptsListUseCaseTest : BaseUnitTest() {
var initialDate: Date = now
var count: Int = 0
whenever(selectedSiteRepository.getSelectedSite()).thenReturn(SiteModel().apply { id = 1 })
whenever(bloggingPromptsStore.fetchPrompts(any(), any(), any()))
whenever(perAppLocaleManager.getCurrentLocaleLanguageCode()).thenReturn("en")
whenever(bloggingPromptsStore.fetchPrompts(any(), any(), any(), any()))
.doSuspendableAnswer {
count = it.getArgument(1)
initialDate = it.getArgument(2)
Expand Down Expand Up @@ -97,7 +104,8 @@ class FetchBloggingPromptsListUseCaseTest : BaseUnitTest() {
var initialDate: Date = now
var count: Int = 0
whenever(selectedSiteRepository.getSelectedSite()).thenReturn(SiteModel().apply { id = 1 })
whenever(bloggingPromptsStore.fetchPrompts(any(), any(), any()))
whenever(perAppLocaleManager.getCurrentLocaleLanguageCode()).thenReturn("en")
whenever(bloggingPromptsStore.fetchPrompts(any(), any(), any(), any()))
.doSuspendableAnswer {
count = it.getArgument(1)
initialDate = it.getArgument(2)
Expand Down
7 changes: 6 additions & 1 deletion ...android/ui/mysite/cards/dashboard/bloggingprompts/BloggingPromptCardViewModelSliceTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ import org.wordpress.android.ui.mysite.SiteNavigationAction
import org.wordpress.android.ui.pages.SnackbarMessageHolder
import org.wordpress.android.ui.prefs.AppPrefsWrapper
import org.wordpress.android.ui.utils.UiString
import org.wordpress.android.util.PerAppLocaleManager

@Suppress("LargeClass")
@ExperimentalCoroutinesApi
Expand Down Expand Up @@ -58,6 +59,9 @@ class BloggingPromptCardViewModelSliceTest : BaseUnitTest() {
@Mock
lateinit var promptsStore: BloggingPromptsStore

@Mock
lateinit var perAppLocaleManager: PerAppLocaleManager

private lateinit var viewModelSlice: BloggingPromptCardViewModelSlice

private lateinit var navigationActions: MutableList<SiteNavigationAction>
Expand All @@ -83,7 +87,8 @@ class BloggingPromptCardViewModelSliceTest : BaseUnitTest() {
bloggingPromptsCardTrackHelper,
bloggingPromptsPostTagProvider,
bloggingPromptCardBuilder,
promptsStore
promptsStore,
perAppLocaleManager
)

whenever(selectedSiteRepository.getSelectedSite()).thenReturn(site)
Expand Down
2 changes: 1 addition & 1 deletion ...uxc/src/main/java/org/wordpress/android/fluxc/network/rest/wpcom/BaseWPComRestClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ public Request add(WPComGsonRequest request) {
return add(request, true);
}

protected Request add(WPComGsonRequest request, boolean addLocaleParameter) {
public Request add(WPComGsonRequest request, boolean addLocaleParameter) {
if (addLocaleParameter) {
addLocaleToRequest(request);
}
Expand Down
5 changes: 3 additions & 2 deletions ...c/src/main/java/org/wordpress/android/fluxc/network/rest/wpcom/WPComGsonRequestBuilder.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,8 @@ class WPComGsonRequestBuilder
type: Type,
enableCaching: Boolean = false,
cacheTimeToLive: Int = BaseRequest.DEFAULT_CACHE_LIFETIME,
forced: Boolean = false
forced: Boolean = false,
addLocaleParameter: Boolean = true
) = suspendCancellableCoroutine<Response<T>> { cont ->
val request = WPComGsonRequest.buildGetRequest<T>(url, params, type, {
cont.resume(Success(it))
Expand All @@ -113,7 +114,7 @@ class WPComGsonRequestBuilder
if (forced) {
request.setShouldForceUpdate()
}
restClient.add(request)
restClient.add(request, addLocaleParameter)
}

/**
Expand Down
10 changes: 8 additions & 2 deletions ...g/wordpress/android/fluxc/network/rest/wpcom/bloggingprompts/BloggingPromptsRestClient.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,12 +38,17 @@ class BloggingPromptsRestClient @Inject constructor(
site: SiteModel,
perPage: Int,
after: Date,
locale: String,
ignoresYear: Boolean = true,
): BloggingPromptsPayload<BloggingPromptsListResponse> {
val url = WPCOMV3.sites.site(site.siteId).blogging_prompts.url
val params = mutableMapOf(
"per_page" to perPage.toString(),
"after" to BloggingPromptsUtils.dateToString(after, ignoresYear)
"after" to BloggingPromptsUtils.dateToString(after, ignoresYear),
// Send the app's language slug (e.g. "tr") explicitly so prompt content is localized.
// The framework's default _locale is region-qualified (e.g. "tr_TR"), which the endpoint
// doesn't resolve, so we disable it below (addLocaleParameter = false) and set our own.
"_locale" to locale
)
if (ignoresYear) {
// when ignoring the year we force the response to be for the current year
Expand All @@ -56,7 +61,8 @@ class BloggingPromptsRestClient @Inject constructor(
this,
url,
params,
BloggingPromptsListResponseTypeToken.type
BloggingPromptsListResponseTypeToken.type,
addLocaleParameter = false
)
return when (response) {
is Success -> BloggingPromptsPayload(response.data)
Expand Down
5 changes: 3 additions & 2 deletions ...c/src/main/java/org/wordpress/android/fluxc/store/bloggingprompts/BloggingPromptsStore.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,11 @@ class BloggingPromptsStore @Inject constructor(
suspend fun fetchPrompts(
site: SiteModel,
number: Int,
from: Date
from: Date,
locale: String
): BloggingPromptsResult<List<BloggingPromptModel>> {
return coroutineEngine.withDefaultContext(AppLog.T.API, this, "fetchPrompts") {
val payload = restClient.fetchPrompts(site, number, from)
val payload = restClient.fetchPrompts(site, number, from, locale)
storePrompts(site, payload)
}
}
Expand Down
26 changes: 19 additions & 7 deletions ...rdpress/android/fluxc/network/rest/wpcom/bloggingprompts/BloggingPromptsRestClientTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,7 @@ class BloggingPromptsRestClientTest {

private val siteId: Long = 1
private val numberOfPromptsToFetch: Int = 40
private val locale: String = "en"

@Before
fun setUp() {
Expand All @@ -123,21 +124,31 @@ class BloggingPromptsRestClientTest {
val json = UnitTestUtils.getStringFromResourceFile(javaClass, PROMPTS_JSON)
initFetchPrompts(data = getPromptsResponseFromJsonString(json))

restClient.fetchPrompts(site, numberOfPromptsToFetch, Date())
restClient.fetchPrompts(site, numberOfPromptsToFetch, Date(), locale)

assertEquals(
urlCaptor.firstValue,
"$API_SITE_PATH/${site.siteId}/$API_BLOGGING_PROMPTS_PATH"
)
}

@Test
fun `when fetch prompts gets triggered, then the given locale is sent as the _locale param`() = test {
val json = UnitTestUtils.getStringFromResourceFile(javaClass, PROMPTS_JSON)
initFetchPrompts(data = getPromptsResponseFromJsonString(json))

restClient.fetchPrompts(site, numberOfPromptsToFetch, Date(), locale)

assertEquals(locale, paramsCaptor.firstValue["_locale"])
}

@Test
fun `given success call, when fetch prompts gets triggered, then prompts response is returned`() =
test {
val json = UnitTestUtils.getStringFromResourceFile(javaClass, PROMPTS_JSON)
initFetchPrompts(data = getPromptsResponseFromJsonString(json))

val result = restClient.fetchPrompts(site, numberOfPromptsToFetch, Date())
val result = restClient.fetchPrompts(site, numberOfPromptsToFetch, Date(), locale)

assertSuccess(PROMPTS_RESPONSE, result)
}
Expand All @@ -147,7 +158,7 @@ class BloggingPromptsRestClientTest {
test {
initFetchPrompts(error = WPComGsonNetworkError(BaseNetworkError(GenericErrorType.UNKNOWN)))

val result = restClient.fetchPrompts(site, numberOfPromptsToFetch, Date())
val result = restClient.fetchPrompts(site, numberOfPromptsToFetch, Date(), locale)

assertError(GENERIC_ERROR, result)
}
Expand All @@ -157,7 +168,7 @@ class BloggingPromptsRestClientTest {
test {
initFetchPrompts(error = WPComGsonNetworkError(BaseNetworkError(GenericErrorType.TIMEOUT)))

val result = restClient.fetchPrompts(site, numberOfPromptsToFetch, Date())
val result = restClient.fetchPrompts(site, numberOfPromptsToFetch, Date(), locale)

assertError(TIMEOUT, result)
}
Expand All @@ -167,7 +178,7 @@ class BloggingPromptsRestClientTest {
test {
initFetchPrompts(error = WPComGsonNetworkError(BaseNetworkError(GenericErrorType.NETWORK_ERROR)))

val result = restClient.fetchPrompts(site, numberOfPromptsToFetch, Date())
val result = restClient.fetchPrompts(site, numberOfPromptsToFetch, Date(), locale)

assertError(API_ERROR, result)
}
Expand All @@ -177,7 +188,7 @@ class BloggingPromptsRestClientTest {
test {
initFetchPrompts(error = WPComGsonNetworkError(BaseNetworkError(GenericErrorType.INVALID_RESPONSE)))

val result = restClient.fetchPrompts(site, numberOfPromptsToFetch, Date())
val result = restClient.fetchPrompts(site, numberOfPromptsToFetch, Date(), locale)

assertError(INVALID_RESPONSE, result)
}
Expand All @@ -187,7 +198,7 @@ class BloggingPromptsRestClientTest {
test {
initFetchPrompts(error = WPComGsonNetworkError(BaseNetworkError(GenericErrorType.NOT_AUTHENTICATED)))

val result = restClient.fetchPrompts(site, numberOfPromptsToFetch, Date())
val result = restClient.fetchPrompts(site, numberOfPromptsToFetch, Date(), locale)

assertError(AUTHORIZATION_REQUIRED, result)
}
Expand All @@ -212,6 +223,7 @@ class BloggingPromptsRestClientTest {
eq(BloggingPromptsListResponseTypeToken.type),
eq(false),
any(),
eq(false),
eq(false)
)
).thenReturn(response)
Expand Down
24 changes: 16 additions & 8 deletions ...c/test/java/org/wordpress/android/fluxc/store/bloggingprompts/BloggingPromptsStoreTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,7 @@ class BloggingPromptsStoreTest {

private val numberOfPromptsToFetch = 40
private val requestedPromptDate = Date()
private val locale = "en"

@Before
fun setUp() {
Expand All @@ -190,11 +191,12 @@ class BloggingPromptsStoreTest {
restClient.fetchPrompts(
siteModel,
numberOfPromptsToFetch,
requestedPromptDate
requestedPromptDate,
locale
)
).thenReturn(payload)

promptsStore.fetchPrompts(siteModel, numberOfPromptsToFetch, requestedPromptDate)
promptsStore.fetchPrompts(siteModel, numberOfPromptsToFetch, requestedPromptDate, locale)

verify(dao).insertForSite(siteModel.id, PROMPT_MODELS)
}
Expand All @@ -207,7 +209,8 @@ class BloggingPromptsStoreTest {
restClient.fetchPrompts(
siteModel,
numberOfPromptsToFetch,
requestedPromptDate
requestedPromptDate,
locale
)
).thenReturn(
payload
Expand All @@ -216,7 +219,8 @@ class BloggingPromptsStoreTest {
val result = promptsStore.fetchPrompts(
siteModel,
numberOfPromptsToFetch,
requestedPromptDate
requestedPromptDate,
locale
)

assertThat(result.model).isEqualTo(PROMPT_MODELS)
Expand All @@ -231,7 +235,8 @@ class BloggingPromptsStoreTest {
restClient.fetchPrompts(
siteModel,
numberOfPromptsToFetch,
requestedPromptDate
requestedPromptDate,
locale
)
).thenReturn(
payload
Expand All @@ -246,7 +251,8 @@ class BloggingPromptsStoreTest {
val result = promptsStore.fetchPrompts(
siteModel,
numberOfPromptsToFetch,
requestedPromptDate
requestedPromptDate,
locale
)

assertThat(result.model).isNull()
Expand Down Expand Up @@ -311,14 +317,16 @@ class BloggingPromptsStoreTest {
restClient.fetchPrompts(
siteModel,
numberOfPromptsToFetch,
requestedPromptDate
requestedPromptDate,
locale
)
).thenReturn(payload)

val result = promptsStore.fetchPrompts(
siteModel,
numberOfPromptsToFetch,
requestedPromptDate
requestedPromptDate,
locale
)

assertThat(result.model).isNull()
Expand Down
Loading