[#8] [KMM] [Backend] Set Up Network layer Core with Ktor #51

blyscuit · 2022-09-20T08:47:00Z

close #8

What Happened

Create a network layer class for calling API with Ktor.
Create a unit test for network layer.
Add BuildKonfig for flavor.
Add Native Coroutines for using Flow as Combine.
Use Koin for DI from this article https://medium.com/@uwaisalqadri/elegant-koin-injection-for-swift-in-kotlin-multiplatform-mobile-9a803f6efb2e.

Insight

Move dependencies to buildsrc files.
Use new memory manager for iOS.
BuildKonfig is generated from CICD.
Use a special github.com/nimblehq/jsonapi-kotlin as submodule.

Proof of Work

shared/src/commonMain/kotlin/co/nimblehq/blisskmmic/data/network/core/NetworkClient.kt

shared/src/commonMain/kotlin/co/nimblehq/blisskmmic/data/network/helpers/UrlPath.kt

github-actions · 2022-09-20T10:14:08Z

	11 Warnings
⚠️	Big PR
⚠️	Please remove period from end of commit subject line. `82a5165`
⚠️	Please remove period from end of commit subject line. `b05e2a5`
⚠️	Uh oh! Koin.kt is under 95% coverage!
⚠️	Uh oh! NetworkClient.kt is under 95% coverage!
⚠️	Uh oh! NetworkMockModel.kt is under 95% coverage!
⚠️	Uh oh! NetworkModule.kt is under 95% coverage!
⚠️	Uh oh! RepositoryModule.kt is under 95% coverage!
⚠️	Uh oh! Start.kt is under 95% coverage!
⚠️	Uh oh! UseCaseModule.kt is under 95% coverage!
⚠️	Uh oh! Your project is under 80% coverage!

🧛 shared Code Coverage: `73.89%`

Coverage of Modified Files:

File	Coverage
`JsonMockEngine.kt`	`100.00%`
`Koin.kt`	`0.00%`
`NetworkClient.kt`	`76.83%`
`NetworkClientTest.kt`	`100.00%`
`NetworkMockModel.kt`	`86.61%`
`NetworkModule.kt`	`0.00%`
`RepositoryModule.kt`	`0.00%`
`Start.kt`	`0.00%`
`UseCaseModule.kt`	`0.00%`

Modified Files Not Found In Coverage Report:

.gitignore
.gitmodules
AndroidManifest.xml
BuildKonfig.kt.example
Dangerfile
Dependency.kt
KoinApplication.swift
LazyKoin.swift
Module.kt
Plugin.kt
Podfile
Podfile.lock
Typealias+Koin.swift
Versions.kt
build.gradle.kts
build.gradle.kts
deploy_ios_firebase.yml
deploy_ios_release_firebase.yml
gradle.properties
ios_review_pull_request.yml
kmm_review_pull_request.yml
nimble-jsonapi-kotlin
project.pbxproj
settings.gradle.kts

Codebase cunningly covered by count Shroud 🧛

Generated by 🚫 Danger

shared/src/commonTest/kotlin/co/nimblehq/blisskmmic/helpers/mock/NetworkMockModel.kt

github-actions · 2022-09-20T10:33:18Z

Current coverage for Survey is `58.05%`

Files changed	-	-
LazyKoin.swift	`0.00%`	💀
KoinApplication.swift	`0.00%`	💀

Powered by xcov

Generated by 🚫 Danger

minhnimble

Anyhow, LGTM now 🚀

luongvo

rest lgtm

.github/workflows/deploy_ios_release_firebase.yml

.github/workflows/deploy_ios_firebase.yml

.github/workflows/deploy_ios_release_firebase.yml

.github/workflows/kmm_review_pull_request.yml

.gitmodules

buildSrc/src/main/kotlin/myPackage/Modules.kt

shared/build.gradle.kts

shared/src/commonMain/kotlin/co/nimblehq/blisskmmic/data/network/core/NetworkClient.kt

shared/build.gradle.kts

shared/src/commonMain/kotlin/co/nimblehq/blisskmmic/data/network/core/NetworkClient.kt

luongvo

@blyscuit 1 issue left, rest lgtm

luongvo

lgtm

luongvo · 2022-10-27T07:30:04Z

shared/build.gradle.kts

+buildkonfig {
+    packageName = "co.nimblehq.blisskmmic"
+
+    defaultConfigs {
+        buildConfigField(
+            STRING,
+            "CLIENT_ID",
+            BuildKonfig.CLIENT_ID
+        )
+        buildConfigField(
+            STRING,
+            "CLIENT_SECRET",
+            BuildKonfig.CLIENT_SECRET
+        )
+        buildConfigField(
+            STRING,
+            "BASE_URL",
+            BuildKonfig.STAGING_BASE_URL
+        )
+    }
+
+    defaultConfigs("production") {
+        buildConfigField(
+            STRING,
+            "CLIENT_ID",
+            BuildKonfig.CLIENT_ID
+        )
+        buildConfigField(
+            STRING,
+            "CLIENT_SECRET",
+            BuildKonfig.CLIENT_SECRET
+        )
+        buildConfigField(
+            STRING,
+            "BASE_URL",
+            BuildKonfig.PRODUCTION_BASE_URL
+        )
+    }
+
+    defaultConfigs("staging") {
+        buildConfigField(
+            STRING,
+            "CLIENT_ID",
+            BuildKonfig.CLIENT_ID_STAGING
+        )
+        buildConfigField(
+            STRING,
+            "CLIENT_SECRET",
+            BuildKonfig.CLIENT_SECRET_STAGING
+        )
+        buildConfigField(
+            STRING,
+            "BASE_URL",
+            BuildKonfig.STAGING_BASE_URL
+        )
+    }


@blyscuit Sorry for recalling you on a merged PR, I think there is still something wrong here. We need to define a properties file for BuildKonfig and read them from the properties file instead of a BuildKonfig class. The logic here is BuildKonfig lib helps us to create BuildKonfig class file to use in runtime from a properties config, so BuildKonfig class is the result, not the source of this gradle config.

luongvo · 2022-10-27T07:31:57Z

buildSrc/src/main/kotlin/appPackage/BuildKonfig.kt.example

+object BuildKonfig {
+    const val CLIENT_ID = ""
+    const val CLIENT_SECRET = ""
+    const val STAGING_BASE_URL = ""
+    const val PRODUCTION_BASE_URL = ""
+    const val CLIENT_ID_STAGING = ""
+    const val CLIENT_SECRET_STAGING = ""
+    const val UI_TEST_EMAIL = ""
+    const val UI_TEST_PASSWORD = ""
+}


This sample file is incorrect. It should be a properties file when working with Gradle build system 💭

blyscuit self-assigned this Sep 20, 2022

blyscuit force-pushed the feature/#8-set-up-network-layer branch 5 times, most recently from c200409 to 527870e Compare September 20, 2022 10:10

github-actions bot reviewed Sep 20, 2022

View reviewed changes

shared/src/commonMain/kotlin/co/nimblehq/blisskmmic/data/network/core/NetworkClient.kt Show resolved Hide resolved

github-actions bot reviewed Sep 20, 2022

View reviewed changes

shared/src/commonMain/kotlin/co/nimblehq/blisskmmic/data/network/helpers/UrlPath.kt Outdated Show resolved Hide resolved

github-actions bot reviewed Sep 20, 2022

View reviewed changes

shared/src/commonTest/kotlin/co/nimblehq/blisskmmic/helpers/mock/NetworkMockModel.kt Outdated Show resolved Hide resolved

blyscuit added this to the 0.0.1 milestone Sep 20, 2022

blyscuit added type: feature platform: KMM type: chore and removed type: feature labels Sep 20, 2022

blyscuit force-pushed the chore/#4-ci-kmm branch from f9ed8e1 to 9fb1826 Compare September 20, 2022 11:11

blyscuit force-pushed the feature/#8-set-up-network-layer branch from f60eee4 to 078d5d5 Compare September 21, 2022 10:10

blyscuit force-pushed the chore/#4-ci-kmm branch from 9fb1826 to 20409e7 Compare September 21, 2022 10:11

blyscuit force-pushed the feature/#8-set-up-network-layer branch 8 times, most recently from f818f06 to e71863f Compare September 22, 2022 08:22

blyscuit marked this pull request as ready for review September 22, 2022 09:49

blyscuit requested review from suho and edgarss as code owners September 22, 2022 09:49

blyscuit force-pushed the feature/#8-set-up-network-layer branch from d1d0b55 to 0d404e8 Compare September 27, 2022 08:38

blyscuit requested a review from minhnimble September 27, 2022 09:44

minhnimble approved these changes Sep 28, 2022

View reviewed changes

blyscuit requested a review from luongvo September 29, 2022 05:34

edgarss approved these changes Sep 30, 2022

View reviewed changes

luongvo reviewed Oct 18, 2022

View reviewed changes

blyscuit requested a review from luongvo October 18, 2022 09:37

blyscuit added 15 commits October 19, 2022 12:34

[#8] Move lib to constants

f9afe23

[#8] Add Ktor

e175992

[#8] Add NetworkClient class

326e0fd

[#8] Add NativeCoroutine class

f57b2b4

[#8] Add BuildKonfig class

32b0dbd

[#8] Add Test for Network layer

a95cd9f

[#8] Fix CI

9e12acf

[#8] Fix lint

5f6a60e

[#8] Refactor network test

cc1fa72

[#8] Add Koin

b52d47f

[#8] Use custom json mapper

8df6a57

[#8] Remove unsed module

ead335b

[#8] Remove unsed module

7910fae

[#8] Fix Dangerfile typo

08f1aa2

[#8] Fix PR comment. Renaming files.

b05e2a5

blyscuit force-pushed the feature/#8-set-up-network-layer branch from ed98f64 to b05e2a5 Compare October 19, 2022 06:05

luongvo reviewed Oct 27, 2022

View reviewed changes

shared/build.gradle.kts Outdated Show resolved Hide resolved

shared/src/commonMain/kotlin/co/nimblehq/blisskmmic/data/network/core/NetworkClient.kt Outdated Show resolved Hide resolved

luongvo reviewed Oct 27, 2022

View reviewed changes

[#8] Fix PR comment typo on Konfig.

82a5165

luongvo approved these changes Oct 27, 2022

View reviewed changes

blyscuit merged commit 2e3aee7 into develop Oct 27, 2022

blyscuit deleted the feature/#8-set-up-network-layer branch October 27, 2022 04:45

luongvo reviewed Oct 27, 2022

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[#8] [KMM] [Backend] Set Up Network layer Core with Ktor #51

[#8] [KMM] [Backend] Set Up Network layer Core with Ktor #51

blyscuit commented Sep 20, 2022 •

edited

Loading

github-actions bot commented Sep 20, 2022 •

edited

Loading

github-actions bot commented Sep 20, 2022 •

edited

Loading

minhnimble left a comment

luongvo left a comment

luongvo left a comment

luongvo left a comment

luongvo Oct 27, 2022

luongvo Oct 27, 2022

[#8] [KMM] [Backend] Set Up Network layer Core with Ktor #51

[#8] [KMM] [Backend] Set Up Network layer Core with Ktor #51

Conversation

blyscuit commented Sep 20, 2022 • edited Loading

What Happened

Insight

Proof of Work

github-actions bot commented Sep 20, 2022 • edited Loading

🧛 shared Code Coverage: 73.89%

Coverage of Modified Files:

Modified Files Not Found In Coverage Report:

github-actions bot commented Sep 20, 2022 • edited Loading

Current coverage for Survey is 58.05%

minhnimble left a comment

Choose a reason for hiding this comment

luongvo left a comment

Choose a reason for hiding this comment

luongvo left a comment

Choose a reason for hiding this comment

luongvo left a comment

Choose a reason for hiding this comment

luongvo Oct 27, 2022

Choose a reason for hiding this comment

luongvo Oct 27, 2022

Choose a reason for hiding this comment

blyscuit commented Sep 20, 2022 •

edited

Loading

github-actions bot commented Sep 20, 2022 •

edited

Loading

🧛 shared Code Coverage: `73.89%`

github-actions bot commented Sep 20, 2022 •

edited

Loading

Current coverage for Survey is `58.05%`