[Hack Week] ApiFaker: introduce new module and logic #13052

hichamboushaba · 2024-12-03T11:35:36Z

Description

As part of my Hack Week, I'm bringing back the ApiFaker project paqN3M-SI-p2, and I'm splitting the feature into multiple PRs.

This PR adds the apifaker gradle module, and with it the following changes:

A Room database to hold the list of faked endpoints.
The EndpointProcessor class is responsible for matching and finding the faked endpoints.
The OkHttp interceptor that replaces the response when needed.

Steps to reproduce

Code review and green CI should be enough.

But if you prefer to do some tests, you can use the following PR #13070

I have considered if this change warrants release notes and have added them to RELEASE-NOTES.txt if necessary. Use the "[Internal]" label for non-user-facing changes.

Reviewer (or Author, in the case of optional code reviews):

Please make sure these conditions are met before approving the PR, or request changes if the PR needs improvement:

The PR is small and has a clear, single focus, or a valid explanation is provided in the description. If needed, please request to split it into smaller PRs.
Ensure Adequate Unit Test Coverage: The changes are reasonably covered by unit tests or an explanation is provided in the PR description.
Manual Testing: The author listed all the tests they ran, including smoke tests when needed (e.g., for refactorings). The reviewer confirmed that the PR works as expected on big (tablet) and small (phone) in case of UI changes, and no regressions are added.

dangermattic · 2024-12-03T11:36:29Z

	11 Warnings
⚠️	This PR is larger than 300 lines of changes. Please consider splitting it into smaller PRs for easier and faster reviews.
⚠️	Class `ApiFakerConfig` is missing tests, but `unit-tests-exemption` label was set to ignore this.
⚠️	Class `ApiFakerInterceptor` is missing tests, but `unit-tests-exemption` label was set to ignore this.
⚠️	Class `ApiFakerUiHelper` is missing tests, but `unit-tests-exemption` label was set to ignore this.
⚠️	Class `ApiFakerDatabase` is missing tests, but `unit-tests-exemption` label was set to ignore this.
⚠️	Class `EndpointTypeConverter` is missing tests, but `unit-tests-exemption` label was set to ignore this.
⚠️	Class `QueryParameterConverter` is missing tests, but `unit-tests-exemption` label was set to ignore this.
⚠️	Class `Screen` is missing tests, but `unit-tests-exemption` label was set to ignore this.
⚠️	Class `EndpointDetailsViewModel` is missing tests, but `unit-tests-exemption` label was set to ignore this.
⚠️	Class `HomeViewModel` is missing tests, but `unit-tests-exemption` label was set to ignore this.
⚠️	This PR is assigned to the milestone 21.3. This milestone is due in less than 2 days. Please make sure to get it merged by then or assign it to a milestone with a later deadline.

Generated by 🚫 Danger

wpmobilebot · 2024-12-03T11:40:42Z

📲 You can test the changes from this Pull Request in WooCommerce-Wear Android by scanning the QR code below to install the corresponding build.

	App Name	WooCommerce-Wear Android
	Platform	⌚️ Wear OS
	Flavor	Jalapeno
	Build Type	Debug
	Commit	`1f7edf5`
	Direct Download	`woocommerce-wear-prototype-build-pr13052-1f7edf5.apk`

wpmobilebot · 2024-12-03T11:47:33Z

📲 You can test the changes from this Pull Request in WooCommerce Android by scanning the QR code below to install the corresponding build.

	App Name	WooCommerce Android
	Platform	📱 Mobile
	Flavor	Jalapeno
	Build Type	Debug
	Commit	`1f7edf5`
	Direct Download	`woocommerce-prototype-build-pr13052-1f7edf5.apk`

codecov-commenter · 2024-12-03T14:40:08Z

Codecov Report

Attention: Patch coverage is 1.93705% with 405 lines in your changes missing coverage. Please review.

Project coverage is 40.22%. Comparing base (71e0fae) to head (1f7edf5).
Report is 227 commits behind head on trunk.

Files with missing lines	Patch %	Lines
.../woocommerce/android/apifaker/EndpointProcessor.kt	0.00%	82 Missing ⚠️
...id/apifaker/ui/details/EndpointDetailsViewModel.kt	0.00%	76 Missing ⚠️
...m/woocommerce/android/apifaker/ApiFakerUiHelper.kt	0.00%	68 Missing ⚠️
...om/woocommerce/android/apifaker/ui/DropDownMenu.kt	0.00%	36 Missing ⚠️
...oocommerce/android/apifaker/ApiFakerInterceptor.kt	0.00%	26 Missing ⚠️
...com/woocommerce/android/apifaker/ApiFakerConfig.kt	0.00%	21 Missing ⚠️
...woocommerce/android/apifaker/ui/ApiFakerNavHost.kt	0.00%	21 Missing ⚠️
...commerce/android/apifaker/ui/home/HomeViewModel.kt	0.00%	16 Missing ⚠️
...merce/android/apifaker/db/EndpointTypeConverter.kt	0.00%	10 Missing ⚠️
...oocommerce/android/apifaker/db/ApiFakerDatabase.kt	0.00%	8 Missing ⚠️
... and 11 more

Additional details and impacted files

@@             Coverage Diff              @@
##              trunk   #13052      +/-   ##
============================================
- Coverage     40.43%   40.22%   -0.22%     
  Complexity     6230     6230              
============================================
  Files          1302     1321      +19     
  Lines         75458    75870     +412     
  Branches      10358    10404      +46     
============================================
+ Hits          30513    30520       +7     
- Misses        42285    42690     +405     
  Partials       2660     2660

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

JorgeMucientes

Great job @hichamboushaba, looking forward to see this in action in subsequent PRs. Code looks clean and well organised. I just left a couple minor questions, but nothing blocking.

JorgeMucientes · 2024-12-09T15:47:58Z

libs/apifaker/build.gradle

+            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"


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 tracks, mediapicker, wellsql, wordpress ?

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 includeGroup statements won't have any impact here, they are just used for defining the repo itself.

JorgeMucientes · 2024-12-09T15:58:30Z

libs/apifaker/src/main/java/com/woocommerce/android/apifaker/ApiFakerInterceptor.kt

+                .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


Since the body of the faked request is anything the user inputs from the app, wouldn't it make more sense to leave MediaType null? For example sometimes we get and html body for API errors. Haven't tested yet, but what happens if we keep this application/json content type and enter non json body?

This is a good point; but for now I'll keep it like this, my rationale for hardcording application/json here is that all of the API requests we have in the app use JSON responses, the HTML errors are an exception that can be caused by a specific site setup that returns an error before the site handles the error.

what happens if we keep this application/json content type and enter non json body?

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 API org.json.JSONException: Value <!DOCTYPE of type java.lang.String cannot be converted to JSONObject)

JorgeMucientes · 2024-12-09T16:16:20Z

libs/apifaker/src/main/java/com/woocommerce/android/apifaker/EndpointProcessor.kt

+            url.encodedPath.trimEnd('/').matches(Regex(JETPACK_TUNNEL_REGEX)) &&
+            !startsWith("{\"data\":")
+        ) {
+            "{\"data\": $this}"


This brings up the same question from above. What if we don't want to have JSON formatted body with data { } as the root of if? Like the example mentioned above when simulating an error that returns html?

This makes sure the log is not printed when the matched endpoints use different query parameters.

[Hack Week] ApiFaker: match endpoints using query parameters

[Hack Week] ApiFaker: display a hint on the main app UI when the ApiFaker is enabled

[Hack Week] ApiFaker: Adding, deleting and deleting endpoints

[Hack Week] ApiFaker: Home screen and integration with the app

# Conflicts: # WooCommerce/src/main/res/values/strings.xml

hichamboushaba added type: task An internally driven task. milestone-not-required Prevents the Milestone check to fail the build labels Dec 3, 2024

hichamboushaba force-pushed the task/api-faker-prep branch from 010ba46 to 5dc003f Compare December 3, 2024 11:44

hichamboushaba force-pushed the task/api-faker-prep branch from 8ea9816 to c944700 Compare December 3, 2024 13:20

hichamboushaba force-pushed the task/api-faker-1 branch from 07950ea to 3f4341b Compare December 3, 2024 14:10

hichamboushaba added the unit-tests-exemption label Dec 3, 2024

hichamboushaba added 10 commits December 3, 2024 15:46

Create a new module for the Api Faker

d64107d

Add Room DB for holding the endpoints

61c9e55

Add initial logic for intercepting and faking responses

571b1b4

Some changes to the DB schema

bea598f

Handle extracting data from the request for matching

e3c4cbb

Add some logging, and handle errors in parsing

dccd118

Add some improvements to the DB schema and dao

cbf04b6

Rename classes

a9ad0ca

Fix detekt issues

9864ff6

Run unit tests of all libraries in CI

7586064

hichamboushaba force-pushed the task/api-faker-1 branch from 3f4341b to 7586064 Compare December 3, 2024 14:46

hichamboushaba added 4 commits December 3, 2024 16:01

Disable schema export

97f8325

Enable destructive migration

566bb53

Improve the query statement

cd04882

Add ability to delete requests

e637209

hichamboushaba force-pushed the task/api-faker-1 branch from dc8591c to 350bcf2 Compare December 4, 2024 10:52

Add HttpMethod to the DB entities

1eb669e

hichamboushaba force-pushed the task/api-faker-1 branch 2 times, most recently from 185c0cb to c5117e3 Compare December 4, 2024 13:43

Fix endpoint extraction from Jetpack tunnel endpoints

9a5c208

hichamboushaba added 9 commits December 5, 2024 20:37

Add query parameters to the DB model

43b60e2

Filter requests using query parameters

c58a989

Bump db version

ddd80ea

Add a way to add query parameters in the UI

f2c6ad6

Some fixes

67ffb03

Handle query parameters extraction for Jetpack tunnel requests

a27be3a

Fix detekt issues

c41e820

Log a warning message if multiple endpoints are matched

f090305

Add more tests

a85c17c

JorgeMucientes self-assigned this Dec 6, 2024

Base automatically changed from task/api-faker-prep to trunk December 6, 2024 16:47

JorgeMucientes approved these changes Dec 9, 2024

View reviewed changes

hichamboushaba added 7 commits December 10, 2024 08:37

Make DB flow collection lifecycle aware

9375f2d

Fix UI with long endpoint paths

d4b929e

Improve logic of warning log

ad5f00f

This makes sure the log is not printed when the matched endpoints use different query parameters.

Merge pull request #13083 from woocommerce/task/api-faker-5

60ba59a

[Hack Week] ApiFaker: match endpoints using query parameters

Merge pull request #13076 from woocommerce/task/api-faker-4

e02f25c

[Hack Week] ApiFaker: display a hint on the main app UI when the ApiFaker is enabled

Merge pull request #13070 from woocommerce/task/api-faker-3

d209625

[Hack Week] ApiFaker: Adding, deleting and deleting endpoints

Merge pull request #13064 from woocommerce/task/api-faker-2

933fbbb

[Hack Week] ApiFaker: Home screen and integration with the app

hichamboushaba removed the status: do not merge Dependent on another PR, ready for review but not ready for merge. label Dec 17, 2024

hichamboushaba enabled auto-merge December 17, 2024 12:33

hichamboushaba disabled auto-merge December 19, 2024 08:16

hichamboushaba enabled auto-merge December 19, 2024 08:17

hichamboushaba added 2 commits December 19, 2024 09:20

Merge branch 'trunk' into task/api-faker-1

b29b2e6

# Conflicts: # WooCommerce/src/main/res/values/strings.xml

Add Compose icons dependency to the apiFaker lib

1f7edf5

hichamboushaba force-pushed the task/api-faker-1 branch from 9444ce6 to 1f7edf5 Compare December 19, 2024 08:27

hichamboushaba merged commit 2f219c5 into trunk Dec 19, 2024
15 checks passed

hichamboushaba deleted the task/api-faker-1 branch December 19, 2024 08:50

wzieba mentioned this pull request Jan 14, 2025

Unify Gradle repositories #13307

Merged

4 tasks

ParaskP7 mentioned this pull request Jan 15, 2025

[Dependency Cache] Enable Dependency Cache on CI #13303

Merged

10 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[Hack Week] ApiFaker: introduce new module and logic #13052

[Hack Week] ApiFaker: introduce new module and logic #13052

Uh oh!

hichamboushaba commented Dec 3, 2024 •

edited by JorgeMucientes

Loading

Uh oh!

dangermattic commented Dec 3, 2024 •

edited

Loading

Uh oh!

wpmobilebot commented Dec 3, 2024 •

edited

Loading

Uh oh!

wpmobilebot commented Dec 3, 2024 •

edited

Loading

Uh oh!

codecov-commenter commented Dec 3, 2024 •

edited

Loading

Uh oh!

JorgeMucientes left a comment

Uh oh!

JorgeMucientes Dec 9, 2024

Uh oh!

hichamboushaba Dec 10, 2024

Uh oh!

JorgeMucientes Dec 9, 2024

Uh oh!

hichamboushaba Dec 10, 2024

Uh oh!

JorgeMucientes Dec 9, 2024

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

[Hack Week] ApiFaker: introduce new module and logic #13052

[Hack Week] ApiFaker: introduce new module and logic #13052

Uh oh!

Conversation

hichamboushaba commented Dec 3, 2024 • edited by JorgeMucientes Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Steps to reproduce

Reviewer (or Author, in the case of optional code reviews):

Uh oh!

dangermattic commented Dec 3, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

wpmobilebot commented Dec 3, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

wpmobilebot commented Dec 3, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov-commenter commented Dec 3, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

JorgeMucientes left a comment

Choose a reason for hiding this comment

Uh oh!

JorgeMucientes Dec 9, 2024

Choose a reason for hiding this comment

Uh oh!

hichamboushaba Dec 10, 2024

Choose a reason for hiding this comment

Uh oh!

JorgeMucientes Dec 9, 2024

Choose a reason for hiding this comment

Uh oh!

hichamboushaba Dec 10, 2024

Choose a reason for hiding this comment

Uh oh!

JorgeMucientes Dec 9, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

hichamboushaba commented Dec 3, 2024 •

edited by JorgeMucientes

Loading

dangermattic commented Dec 3, 2024 •

edited

Loading

wpmobilebot commented Dec 3, 2024 •

edited

Loading

wpmobilebot commented Dec 3, 2024 •

edited

Loading

codecov-commenter commented Dec 3, 2024 •

edited

Loading