Initial library setup by navratan-soni · Pull Request #70 · adobe/aepsdk-ui-android

navratan-soni · 2024-08-28T15:57:26Z

Description

Related Issue

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

I have signed the Adobe Open Source CLA.
My code follows the code style of this project.
My change requires a change to the documentation.
I have updated the documentation accordingly.
I have read the CONTRIBUTING document.
I have added tests to cover my changes.
All new and existing tests passed.

codecov · 2024-08-28T16:06:28Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.08%. Comparing base (0f1e0e9) to head (32feb97).
Report is 8 commits behind head on feature/content-card.

Additional details and impacted files

@@                   Coverage Diff                   @@
##             feature/content-card      #70   +/-   ##
=======================================================
  Coverage                   92.08%   92.08%           
  Complexity                    289      289           
=======================================================
  Files                          38       38           
  Lines                        1871     1871           
  Branches                      174      174           
=======================================================
  Hits                         1723     1723           
  Misses                         86       86           
  Partials                       62       62

Flag	Coverage Δ
unit-tests	`92.08% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

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

spoorthipujariadobe · 2024-09-27T17:17:51Z

code/aepcomposeui/src/main/java/com/adobe/marketing/mobile/aepcomposeui/aepui/AepUi.kt

+}
+
+
+class SmallImageAepUi(


Can we move this to its own file?

Can we decide if it needs to be Aep or AEP and apply it across all file and class names? I vote for the latter since its an acronym and it would be consistent with the class names in Core UI service

Can we also change ui to UI?

spoorthipujariadobe · 2024-09-27T17:19:31Z

...pcomposeui/src/main/java/com/adobe/marketing/mobile/aepcomposeui/aepui/components/AepList.kt

+/**
+ * Composable for rendering a list of AEP UI components.
+ * Maintains a list of AEP UI components and renders them using the provided container.
+ */


Let's add descriptions of what the @params mean here

spoorthipujariadobe · 2024-09-27T17:29:16Z

...pcomposeui/src/main/java/com/adobe/marketing/mobile/aepcomposeui/aepui/components/AepList.kt

+            uiAsComposable.invoke()
+        }
+
+        Button(onClick = { viewModel.loadMore() }, Modifier.fillMaxWidth()) {


This button was added for testing. We don't need it in the actual implementation

spoorthipujariadobe · 2024-09-27T17:35:12Z

...pcomposeui/src/main/java/com/adobe/marketing/mobile/aepcomposeui/aepui/components/AepList.kt

+        }
+    }
+
+    fun loadMore() {


can we call this refreshList? The content provider is expected to update the contentFlow when this is called thereby refreshing the list view

Also we don't need to support this right now. It was just there for POC. We can add it later if needed

spoorthipujariadobe · 2024-09-27T17:36:46Z

...eui/src/main/java/com/adobe/marketing/mobile/aepcomposeui/aepui/components/SmallImageCard.kt

+
+/**
+ * Composable for rendering a Small Image Card
+ */


Please add description for @params
Also let's make this public. Apps should be able to use this composable, just like the list one

spoorthipujariadobe · 2024-09-27T17:39:56Z

...aepcomposeui/src/main/java/com/adobe/marketing/mobile/aepcomposeui/aepui/state/AepUiState.kt

+sealed interface AepUiState
+
+data class SmallImageUIState(val title: String?, val dismissed: Boolean = false) : AepUiState
+data class LargeImageUIState(val dismissed: Boolean = false) : AepUiState


LargeImageUIState is out of the scope of this release let's remove it

spoorthipujariadobe · 2024-09-27T17:40:34Z

...aepcomposeui/src/main/java/com/adobe/marketing/mobile/aepcomposeui/aepui/state/AepUiState.kt

+
+sealed interface AepUiState
+
+data class SmallImageUIState(val title: String?, val dismissed: Boolean = false) : AepUiState


Let's move this to its own file
It will need to be changed in future PRs to reflect actual values the state needs to hold

spoorthipujariadobe · 2024-09-27T17:42:56Z

...aepcomposeui/src/main/java/com/adobe/marketing/mobile/aepcomposeui/aepui/style/AEPTextExt.kt

+import androidx.compose.ui.text.style.TextAlign
+
+// only needed when we support server side styling
+fun AEPText.getComposeTextStyle(): TextStyle {


Can we remove this class? There's no support for server side styling in AJO. We can add it when we need to

spoorthipujariadobe · 2024-09-27T17:43:22Z

...aepcomposeui/src/main/java/com/adobe/marketing/mobile/aepcomposeui/aepui/style/AepUiStyle.kt

+    val smallImageAepUiStyle: SmallImageAepUiStyle = SmallImageAepUiStyle()
+)
+
+class SmallImageAepUiStyle(


Let's move this also to its own file

spoorthipujariadobe · 2024-09-27T17:45:22Z

...rc/main/java/com/adobe/marketing/mobile/aepcomposeui/contentprovider/AepUiContentProvider.kt

+     */
+    suspend fun getContent(): Flow<List<AepUiTemplate>>
+
+    suspend fun refreshContent()


Please add a description for this method

/** * Refreshes the content for the UI by updating the flow provided in getContent` */

spoorthipujariadobe · 2024-09-27T17:50:52Z

code/aepcomposeui/src/main/java/com/adobe/marketing/mobile/aepcomposeui/interactions/UiEvent.kt

+import com.adobe.marketing.mobile.aepcomposeui.aepui.AepUI
+import com.adobe.marketing.mobile.aepcomposeui.aepui.state.AepUiState
+
+sealed interface UIEvent<T : AepUiTemplate, S : AepUiState> {


Let's add some description for this interface and what T and S mean

spoorthipujariadobe · 2024-09-27T17:52:38Z

...poseui/src/main/java/com/adobe/marketing/mobile/aepcomposeui/observers/AepUiEventObserver.kt

+
+import com.adobe.marketing.mobile.aepcomposeui.interactions.UIEvent
+
+interface AepUiEventObserver {


Same comment here. Let's add a description for the interface and what onEvent is for

spoorthipujariadobe · 2024-09-27T17:53:52Z

...aepuitemplates/src/main/java/com/adobe/marketing/mobile/aepuitemplates/SmallImageTemplate.kt

+
+import com.adobe.marketing.mobile.aepuitemplates.utils.AepUiTemplateType
+
+class SmallImageTemplate() : AepUiTemplate {


This is a public class. Please provide some description here

spoorthipujariadobe · 2024-09-27T17:54:22Z

...templates/src/main/java/com/adobe/marketing/mobile/aepuitemplates/utils/AepUiTemplateType.kt

+enum class AepUiTemplateType(val typeName: String) {
+
+    SMALL_IMAGE("SmallImage"),
+    LARGE_IMAGE("LargeImage")


We're not adding large image in the first iteration. Can we remove this enum?

spoorthipujariadobe · 2024-09-27T17:55:11Z

code/gradle.properties

 notificationbuilderMavenRepoDescription=Android Notification Builder library for Adobe Mobile Marketing

+aepComposeUiModuleName = aepcomposeui
+aepComposeUiVersion=1.0.1


This needs to be 3.0.0. We align major versions of all SDKs

spoorthipujariadobe · 2024-09-27T17:55:27Z

code/gradle.properties

+aepComposeUiMavenRepoDescription = Android AEP Compose UI library for Adobe Mobile Marketing
+
+aepUiTemplatesModuleName = aepuitemplates
+aepUiTemplatesVersion=1.0.1


Same comment here. Let's make it 3.0.0

spoorthipujariadobe

How about we have a folder structure like this inside aepui

composable
           interfaces
           <implementation of the interface for a specific type>

Same for aepUi, style and state

spoorthipujariadobe · 2024-09-27T20:13:27Z

code/aepuitemplates/build.gradle.kts

+}
+
+dependencies {
+    implementation("com.adobe.marketing.mobile:core:$mavenCoreVersion")


Why does this library need MobileCore dependency?

spoorthipujariadobe · 2024-09-27T20:19:42Z

code/aepuitemplates/build.gradle.kts

+val aepUiTemplatesMavenRepoDescription: String by project
+
+aepLibrary {
+    namespace = "com.adobe.marketing.mobile.aepcomposeui"


namespace needs to be com.adobe.marketing.mobile.aepuitemplates

spoorthipujariadobe · 2024-09-27T20:20:56Z

code/aepcomposeui/build.gradle.kts

+}
+
+dependencies {
+    implementation("com.adobe.marketing.mobile:core:$mavenCoreVersion")


Why do we need core dependency here?

spoorthipujariadobe · 2024-09-27T20:39:16Z

code/gradle/libs.versions.toml

+[plugins]
+android-application = { id = "com.android.application", version.ref = "agp" }
+jetbrains-kotlin-android = { id = "org.jetbrains.kotlin.android", version.ref = "kotlin" }
+android-library = { id = "com.android.library", version.ref = "agp" }
+


All these 3 are included in aep-plugin
https://github.com/adobe/aepsdk-commons/blob/c47af348a5cb10213c36d40603422c0307a87ea9/android/aepsdk-gradle-plugin/aepsdk-gradle-plugin/src/main/kotlin/com/adobe/marketing/mobile/gradle/BuildConstants.kt#L112-L114

spoorthipujariadobe · 2024-09-27T20:41:22Z

code/gradle/libs.versions.toml

+androidx-core-ktx = { group = "androidx.core", name = "core-ktx", version.ref = "coreKtx" }
+junit = { group = "junit", name = "junit", version.ref = "junit" }
+androidx-junit = { group = "androidx.test.ext", name = "junit", version.ref = "junitVersion" }
+androidx-espresso-core = { group = "androidx.test.espresso", name = "espresso-core", version.ref = "espressoCore" }
+androidx-lifecycle-runtime-ktx = { group = "androidx.lifecycle", name = "lifecycle-runtime-ktx", version.ref = "lifecycleRuntimeKtx" }


Same comment here. All of them are included in aep-plugin

spoorthipujariadobe · 2024-09-27T20:48:18Z

code/gradle/libs.versions.toml

+androidx-lifecycle-runtime-compose = { group = "androidx.lifecycle", name = "lifecycle-runtime-compose", version.ref = "lifecycleRuntimeCompose" }
+androidx-lifecycle-viewmodel-compose = {group = "androidx.lifecycle", name = "lifecycle-viewmodel-compose", version.ref = "lifecycleViewModelCompose"}
+androidx-activity-compose = { group = "androidx.activity", name = "activity-compose", version.ref = "activityCompose" }
+androidx-compose-bom = { group = "androidx.compose", name = "compose-bom", version.ref = "composeBom" }


Do we need to use compose bom? aep-plugin has almost all the dependencies you need. can we include the ones not present there directly using the same version through the BuildConstants?
Example from core https://github.com/adobe/aepsdk-core-android/blob/main/code/core/build.gradle.kts#L27-L32

spoorthipujariadobe · 2024-09-27T20:50:47Z

code/gradle/libs.versions.toml

@@ -0,0 +1,40 @@
+[versions]


can we verify if we need this file? most of them are included in aep-plugin

Initial library setup

3b0656a

navratan-soni requested a review from spoorthipujariadobe August 28, 2024 15:57

navratan-soni added 5 commits September 25, 2024 14:40

aep-ui-templates setup

e5b41f9

Added classes AepUiTemplate

c5370ea

temp commit

6282a8e

Cleanup

027e071

Changes package

32feb97

spoorthipujariadobe requested a review from prudrabhat September 27, 2024 15:43

spoorthipujariadobe reviewed Sep 27, 2024

View reviewed changes


		sealed interface AepUiState

		data class SmallImageUIState(val title: String?, val dismissed: Boolean = false) : AepUiState


		import com.adobe.marketing.mobile.aepcomposeui.interactions.UIEvent

		interface AepUiEventObserver {


		import com.adobe.marketing.mobile.aepuitemplates.utils.AepUiTemplateType

		class SmallImageTemplate() : AepUiTemplate {

Conversation

navratan-soni commented Aug 28, 2024

Description

Related Issue

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

Checklist:

Uh oh!

codecov bot commented Aug 28, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

spoorthipujariadobe Sep 27, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

spoorthipujariadobe Sep 27, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

spoorthipujariadobe left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

codecov bot commented Aug 28, 2024 •

edited

Loading

spoorthipujariadobe Sep 27, 2024 •

edited

Loading

spoorthipujariadobe Sep 27, 2024 •

edited

Loading

spoorthipujariadobe left a comment •

edited

Loading