AI: Generate product sharing message part 2: Functionality #9236

hafizrahman · 2023-06-15T13:59:09Z

Please do not merge before #9224 is merged.

Part of: #9216
Ref: pe5sF9-1AH-p2

Sorry if the PR is a bit large; a good chunk of it is just the Prompts text, and trackings.

Description

This PR continues from #9224 by adding the actual functionalities to the UI.

The added features are:

"Share" button now works, with or without sharing message.
Generating share message with AI now works,
Information button now opens to Automattic's AI guidelines page.
Error handling is now added in case AI completion fetching fails.
Analytics:

Event	Trigger	Properties
*_product_sharing_ai_displayed	When the sheet for AI-generated share content is displayed.
*_product_sharing_ai_generate_tapped	When the “Write with AI” button is tapped on the AI product share sheet.	is_retry: true \| false
*_product_sharing_ai_share_tapped	When the “Share” button is tapped on the AI product share sheet.	with_message: true \| false
*_product_sharing_ai_dismissed	When the AI product share sheet is dismissed.
*_product_sharing_ai_message_generated	When a message is generated on the AI product share sheet.
*_product_sharing_ai_message_generation_failed	When message generation fails on the AI product share sheet.	error_context: classname error_type: errorType error_description: errorDescription

Testing instructions

Start app, go to Products, select a published Product,
tap Share on option on top right, then the sharing dialog will show up,
Test sharing without a message,
Go back, test the Write with AI button and make sure a message is generated,
Test the "Regenerate" button,
Test sharing with your own manually written message,
Test the (i) icon and make sure it opens the webview to Automattic's AI Guidelines page.
Open share dialog, turn off internet, and check the error case.
Lastly, check logcat and find matching tracking events as outlined above.

Check video below for testing example:

Video

share-with-ai-android.webm

I have considered if this change warrants user-facing release notes and have added them to RELEASE-NOTES.txt if necessary.

…reused.

wpmobilebot · 2023-06-15T14:17:44Z

You can test the changes on this Pull Request by downloading an installable build, or scanning this QR code:

codecov-commenter · 2023-06-15T14:27:02Z

Codecov Report

Patch coverage: 4.66% and project coverage change: -0.06 ⚠️

Comparison is base (7241db3) 44.05% compared to head (f59f569) 43.99%.

❗ Current head f59f569 differs from pull request most recent head 501a406. Consider uploading reports for the commit 501a406 to get more accurate results

Additional details and impacted files

@@             Coverage Diff              @@
##              trunk    #9236      +/-   ##
============================================
- Coverage     44.05%   43.99%   -0.06%     
+ Complexity     4268     4251      -17     
============================================
  Files           859      859              
  Lines         45459    45454       -5     
  Branches       5965     5958       -7     
============================================
- Hits          20026    19997      -29     
- Misses        23676    23707      +31     
+ Partials       1757     1750       -7

Impacted Files	Coverage Δ
...src/main/kotlin/com/woocommerce/android/AppUrls.kt	`0.00% <ø> (ø)`
...ain/kotlin/com/woocommerce/android/ai/AIPrompts.kt	`0.00% <0.00%> (ø)`
.../kotlin/com/woocommerce/android/ai/AIRepository.kt	`0.00% <0.00%> (ø)`
.../woocommerce/android/analytics/AnalyticsTracker.kt	`20.76% <ø> (ø)`
...rce/android/ui/products/ProductNavigationTarget.kt	`16.37% <0.00%> (-0.59%)`	⬇️
...oocommerce/android/ui/products/ProductNavigator.kt	`0.00% <0.00%> (ø)`
...e/android/ui/products/ProductSharingBottomSheet.kt	`0.00% <0.00%> (ø)`
...rce/android/ui/products/ProductSharingViewModel.kt	`0.00% <0.00%> (ø)`
...kotlin/com/woocommerce/android/util/FeatureFlag.kt	`72.54% <0.00%> (ø)`
...om/woocommerce/android/analytics/AnalyticsEvent.kt	`100.00% <100.00%> (ø)`

... and 11 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

…m sheet is used. This allows actual sharing to happen.

The note itself is generated by ChatGPT.

hafizrahman · 2023-06-16T11:08:16Z

WooCommerce/src/main/kotlin/com/woocommerce/android/ai/AIPrompts.kt

+    private const val PRODUCT_DESCRIPTION_PROMPT = "Write a description for a product with title \"%1\$s\"%2\$s.\n" +
+        "Identify the language used in the product title and use the same language in your response.\n" +
+        "Make the description 50-60 words or less.\n" +
+        "Use a 9th grade reading level.\n" +
+        "Perform in-depth keyword research relating to the product in the same language of the product title, " +
+        "and use them in your sentences without listing them out."
+
+    fun generateProductDescriptionPrompt(name: String, features: String = ""): String {
+        val featuresPart = if (features.isNotEmpty()) " and features: \"$features\"" else ""
+        return String.format(PRODUCT_DESCRIPTION_PROMPT, name, featuresPart)
+    }


Unused yet, but will be very soon, so I thought to add it right away.

peril-woocommerce · 2023-06-16T11:11:02Z

	Warnings
⚠️	This PR is assigned to a milestone which is closing in less than 2 days Please, make sure to get it merged by then or assign it to a later expiring milestone
⚠️	PR has more than 300 lines of code changing. Consider splitting into smaller PRs if possible.

Generated by 🚫 dangerJS

hafizrahman · 2023-06-16T12:42:56Z

WooCommerce/src/main/kotlin/com/woocommerce/android/ui/products/ProductSharingViewModel.kt


+    fun onShareButtonClicked() {
+        val writtenMessage = _viewState.value.shareMessage
+        val messageToShare = writtenMessage.ifEmpty { navArgs.productName } + "\n" + navArgs.permalink


If user doesn't enter any share message, we default to "[product_name] [URL]" as the sharing text, otherwise it's "[written_message] [URL]"

JorgeMucientes · 2023-06-16T14:01:55Z

Hey @hafizrahman 👋🏼

I'm still reviewing the PR but, while testing, I couldn't generate the test with AI. I always get an error. I tested with a couple different products, with and without description:

GenerateDescription.mp4

Any idea what might be wrong?

JorgeMucientes · 2023-06-16T13:57:34Z

WooCommerce/src/main/kotlin/com/woocommerce/android/ui/products/ProductSharingViewModel.kt

+        val messageToShare = writtenMessage.ifEmpty { navArgs.productName } + "\n" + navArgs.permalink
+
+        tracker.track(
+            AnalyticsEvent.PRODUCT_SHARING_AI_GENERATE_TAPPED,


Np, I think this tracking should be PRODUCT_SHARING_AI_SHARE_TAPPED ??

Thank you! Great eye.

…ites for now. Otherwise it opens the old sharing feature as usual.

# Conflicts: # WooCommerce/src/main/kotlin/com/woocommerce/android/analytics/AnalyticsEvent.kt # WooCommerce/src/main/kotlin/com/woocommerce/android/analytics/AnalyticsTracker.kt # WooCommerce/src/main/kotlin/com/woocommerce/android/util/FeatureFlag.kt

JorgeMucientes · 2023-06-16T15:12:15Z

Just finished reviewing @hafizrahman

Thanks for quick fixing the tracking issue. About this:

I'm still reviewing the PR but, while testing, I couldn't generate the test with AI. I always get an error. I tested with a couple different products, with and without description:

As discussed over Slack, it didn't work because I wasn't testing with a WP.com site and, as you well noticed this feature only applies to WP.com accounts. Now that the check is added to only display AI sharing UI for WP.com sites, we are good to go!

Excellent job!! Ready to ship

Has to be a WPCom Atomic site, and is public.

hafizrahman added 11 commits June 15, 2023 18:12

Add: Use latest fluxC version to bring in JetpackAIStore.

c372cf1

Add: AI Repository class.

b7d8cf6

Add: AI Prompts class.

6eb314c

Feat: fetch sharing suggestion from AI and display it.

f6d69e3

Feat: handle share message editing. To be used later for actual sharing.

3d395f0

Refactor: use fold instead for result handling.

1d09516

Refactor: Remove unneeded LoadingState and simplify code.

76480e7

Add: state update on result failure.

42b5ba1

Refactor: make separate variables for button labels as they're to be …

5e80da3

…reused.

Add: result logging in AI Repository's fetching.

1149c51

Add: display error message on the UI during AI fetching error.

e13cbfd

hafizrahman added 14 commits June 16, 2023 12:57

Update: Prompt for product sharing.

b07c7db

Feat: Open sharing intent when "Share" button in the AI sharing botto…

be9fb50

…m sheet is used. This allows actual sharing to happen.

Refactor: put sharing subject formatting in viewmodel instead.

4765dad

Feat: Make info button open Automattic's AI guidelines page.

a0171df

Add: Analytics events for AI sharing.

5872af6

Add: Analytics tracking for sheet displayed.

ce3f00e

Add: Analytics tracking keys for AI sharing.

801311c

Add: Analytics tracking for button tapped.

010290d

Add: Analytics tracking for share button tapped (with some refactoring).

fcab87a

Add: Analytics tracking for share dialog dismissed.

b5d5588

Add: Analytics tracking for AI message generated.

92786e6

Add: Analytics tracking for AI message generation failure.

188d0ef

Refactor: Make onGenerateButtonClicked() smaller function.

1a92fbf

Feat: enable Sharing product AI in feature flag.

f60dfd5

hafizrahman added this to the 14.1 milestone Jun 16, 2023

Add: release note.

e3a7be7

The note itself is generated by ChatGPT.

hafizrahman commented Jun 16, 2023

View reviewed changes

Fix: Detekt.

f59f569

hafizrahman marked this pull request as ready for review June 16, 2023 11:11

hafizrahman requested a review from JorgeMucientes June 16, 2023 11:11

hafizrahman changed the title ~~Feature/ai share description functionality~~ AI: Generate product sharing message part 2: Functionality Jun 16, 2023

hafizrahman added the feature: product details Related to adding or editing products, includes product settings. label Jun 16, 2023

hafizrahman commented Jun 16, 2023

View reviewed changes

JorgeMucientes self-assigned this Jun 16, 2023

hafizrahman mentioned this pull request Jun 16, 2023

AI: Generate product sharing message part 1: UI #9224

Merged

JorgeMucientes reviewed Jun 16, 2023

View reviewed changes

Fix: use correct tracking for share.

4c51592

Base automatically changed from feature/ai-share-description-ui to trunk June 16, 2023 14:36

hafizrahman and others added 3 commits June 16, 2023 21:52

Refactor: Open product sharing feature only to WordPress.com-hosted s…

61b0269

…ites for now. Otherwise it opens the old sharing feature as usual.

Use the isWPComAtomic property to correctly determine if site is wpcom

08d1c53

JorgeMucientes approved these changes Jun 16, 2023

View reviewed changes

JorgeMucientes enabled auto-merge June 16, 2023 15:12

JorgeMucientes and others added 3 commits June 16, 2023 17:17

Fix detekt indentation issue after merge with trunk

501a406

Fix: add checking for allowing a site to use sharing with AI.

1a2c6e5

Has to be a WPCom Atomic site, and is public.

Fix detekt spacing issue

c1903e4

JorgeMucientes merged commit 36a7817 into trunk Jun 16, 2023

JorgeMucientes deleted the feature/ai-share-description-functionality branch June 16, 2023 15:59

hafizrahman mentioned this pull request Oct 11, 2023

Activate: Add AI support for sharing product messages #9216

Open

9 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

AI: Generate product sharing message part 2: Functionality #9236

AI: Generate product sharing message part 2: Functionality #9236

Uh oh!

hafizrahman commented Jun 15, 2023 •

edited

Loading

Uh oh!

wpmobilebot commented Jun 15, 2023 •

edited

Loading

Uh oh!

codecov-commenter commented Jun 15, 2023 •

edited

Loading

Uh oh!

hafizrahman Jun 16, 2023

Uh oh!

peril-woocommerce bot commented Jun 16, 2023 •

edited

Loading

Uh oh!

hafizrahman Jun 16, 2023

Uh oh!

JorgeMucientes commented Jun 16, 2023

Uh oh!

JorgeMucientes Jun 16, 2023

Uh oh!

hafizrahman Jun 16, 2023

Uh oh!

JorgeMucientes commented Jun 16, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

AI: Generate product sharing message part 2: Functionality #9236

AI: Generate product sharing message part 2: Functionality #9236

Uh oh!

Conversation

hafizrahman commented Jun 15, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Testing instructions

Video

Uh oh!

wpmobilebot commented Jun 15, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov-commenter commented Jun 15, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

hafizrahman Jun 16, 2023

Choose a reason for hiding this comment

Uh oh!

peril-woocommerce bot commented Jun 16, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

hafizrahman Jun 16, 2023

Choose a reason for hiding this comment

Uh oh!

JorgeMucientes commented Jun 16, 2023

Uh oh!

JorgeMucientes Jun 16, 2023

Choose a reason for hiding this comment

Uh oh!

hafizrahman Jun 16, 2023

Choose a reason for hiding this comment

Uh oh!

JorgeMucientes commented Jun 16, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

hafizrahman commented Jun 15, 2023 •

edited

Loading

wpmobilebot commented Jun 15, 2023 •

edited

Loading

codecov-commenter commented Jun 15, 2023 •

edited

Loading

peril-woocommerce bot commented Jun 16, 2023 •

edited

Loading