Feature/in app review system #148

IvanStepanok · 2023-11-03T11:55:09Z

RPReplay_Final1699274174.mp4

Simulator.Screen.Recording.-.iPhone.15.Pro.-.2023-11-03.at.13.24.57.mp4

openedx-webhooks · 2023-11-03T11:55:15Z

Thanks for the pull request, @IvanStepanok! Please note that it may take us up to several weeks or months to complete a review and merge your PR.

Feel free to add as much of the following information to the ticket as you can:

supporting documentation
Open edX discussion forum threads
timeline information ("this must be merged by XX date", and why that is)
partner information ("this is a course on edx.org")
any other information that can help Product understand the context for the PR

All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here.

Please let us know once your PR is ready for our review and all tests are green.

[header] the system bar disappears if a user used the rate us pop-up [rate_us] the user isn't able to submit a feedback in the landscape mode [email_feedback] the email template formatting must have a user/device info [email_agent] iOS agent displays bit a user cannot use it (the icon isn't clickable)

sdaitzman · 2023-11-13T16:58:26Z

This looks great to me! It would be ideal to collect feedback directly in-app, but that requires some backend communication and is probably not in-scope for now.

Two questions about the interface:

What currently triggers this dialog? Is it timing-based? Could it be triggered only when a video is not actively playing, maybe immediately after a video?
Is the mail client picker that appears at the bottom custom? I believe iOS supports changing default mail apps now, so I think it would be better to use the user's chosen mail client without prompting them to choose one

mumer92 · 2023-11-13T21:29:31Z

@rnr one feedback i have to to make a separate directory and place 3rd party libraries we are using in project to that directory. in that way, we will be able to see what external dependencies we are using, it will have better organization of of code base. what are your thoughts?

rnr · 2023-11-13T21:47:18Z

@rnr one feedback i have to to make a separate directory and place 3rd party libraries we are using in project to that directory. in that way, we will be able to see what external dependencies we are using, it will have better organization of of code base. what are your thoughts?

@mumer92 do you mean something else except Pods and Swift Packages (I believe these two Sources are organised well already)? Thank you

mumer92 · 2023-11-13T21:52:47Z

@rnr one feedback i have to to make a separate directory and place 3rd party libraries we are using in project to that directory. in that way, we will be able to see what external dependencies we are using, it will have better organization of of code base. what are your thoughts?

@mumer92 do you mean something else except Pods and Swift Packages (I believe these two Sources are organised well already)? Thank you

My understanding is ThirdPartyMailClient external library? If it is, we should create a separate folder on root level and place files to that folder, e.g. ExternalLibraries/ThirdPartyMailClient and same with other third party files that are added to project.

volodymyr-chekyrta · 2023-11-14T09:40:24Z

This looks great to me! It would be ideal to collect feedback directly in-app, but that requires some backend communication and is probably not in-scope for now.

Two questions about the interface:

What currently triggers this dialog? Is it timing-based? Could it be triggered only when a video is not actively playing, maybe immediately after a video?

Is the mail client picker that appears at the bottom custom? I believe iOS supports changing default mail apps now, so I think it would be better to use the user's chosen mail client without prompting them to choose one

Yes, it's based on timing here, it appears at 99.9% of the video.

After chatting with @marcotuts, we thought it's a good idea to give users a choice.
Most people have the Apple client by default, but there's a bunch who prefer Gmail.

We can make changes if needed.

volodymyr-chekyrta · 2023-11-14T09:45:57Z

@rnr one feedback i have to to make a separate directory and place 3rd party libraries we are using in project to that directory. in that way, we will be able to see what external dependencies we are using, it will have better organization of of code base. what are your thoughts?

@mumer92 do you mean something else except Pods and Swift Packages (I believe these two Sources are organised well already)? Thank you

My understanding is ThirdPartyMailClient external library? If it is, we should create a separate folder on root level and place files to that folder, e.g. ExternalLibraries/ThirdPartyMailClient and same with other third party files that are added to project.

That's not the library we're going to update in the future.
Here it's just a part of the App Review feature, so it's located there.

rnr · 2023-11-14T12:09:44Z

Core/Core/View/Base/AppReview/AppReviewViewModel.swift

+    }
+
+    func requestReview() {
+        SKStoreReviewController.requestReview()


Hello @IvanStepanok
As I know SKStoreReviewController can be showed three times per year only
https://developer.apple.com/documentation/storekit/requesting_app_store_reviews
All other times 'Rate Us' button won't work, right?
Thank you

mumer92 · 2023-11-14T16:38:55Z

That's not the library we're going to update in the future.
Here it's just a part of the App Review feature, so it's located there.

@volodymyr-chekyrta ThirdPartMailer is available as a library via pod, i believe this is the link to github project. https://github.com/vtourraine/ThirdPartyMailer

My main feedback is to separate out the external or third party code we are using in our code base, e.g in a separate folder called External Libraries and place all the code, not written by and we think is not going to be changed by us there, this way we can have clarity over the code of what is written by us, what code needs to be reviewed, and what external library or code files we are using.

There are other instances of third party code that we are relying in our code base, e.g.

swiftui-pull-to-refresh https://github.com/globulus/swiftui-pull-to-refresh

marcotuts · 2023-11-14T16:41:16Z

A new notes - can we trigger the rating once the video ends instead of at 99.99% - this way the interrupt isn't near the end of an activity but right as it ends.

Similarly on the note about rating visibility, I can review the code next but ensuring this doesnt appear more than a certain number of times is important. the requirements only specified that the modal should appear at most ever 3 months, but if you chose to rate the app we should actually have a timer that is less frequent / perhaps yearly? Thoughts on this change in logic / addition to the logic @IvanStepanok ?

I wasn't familiar with the 3 limit max @rnr thanks for f lagging that.

volodymyr-chekyrta · 2023-11-14T18:22:00Z

@volodymyr-chekyrta ThirdPartMailer is available as a library via pod, i believe this is the link to github project. https://github.com/vtourraine/ThirdPartyMailer

@mumer92,
We know the library is available via pods, yet it is not currently under active development.
Its most recent update was on April 18, 2022, and it does not utilize the latest version of Swift.
Therefore, we have opted to implement only the necessary features instead of relying on this framework.

volodymyr-chekyrta · 2023-11-14T18:28:00Z

A new notes - can we trigger the rating once the video ends instead of at 99.99% - this way the interrupt isn't near the end of an activity but right as it ends.

99.99% of the time, this serves as a workaround for the YouTube player, which does not consistently report full 100% progress.
However, we've conducted tests on a wide array of videos and found that typically, the final second marked by 99.99% progress does not contain any significant content.

volodymyr-chekyrta · 2023-11-14T18:44:26Z

@marcotuts, we didn't see major releases coming more than three times a year, but that's a good point you've raised with @rnr.
We'll add an additional check to the logic.
What do you think works better - limiting it to once every four months or every six months?

sdaitzman · 2023-11-14T20:19:42Z

Yes, it's based on timing here, it appears at 99.9% of the video.

After chatting with @marcotuts, we thought it's a good idea to give users a choice. Most people have the Apple client by default, but there's a bunch who prefer Gmail.

We can make changes if needed.

That makes sense, I think it's reasonable to include the choice. In that case, the UI looks good to me!

saeedbashir · 2023-11-15T07:37:16Z

We know the library is available via pods, yet it is not currently under active development.

@volodymyr-chekyrta I guess what Umer is saying is that there should be clarity in what code we wrote and what code we are using from a third-party or external source.

And for that clarity, he was suggesting to create a folder named (ExternalLibraries/3rdPartyLibraries) at root in the framework where we are using a third-party library and place the 3rd party code in that folder instead of having it in the subdirectory. For example, in the rating feature, a folder named ExternalLibraries would be created in the Core framework and ThirdPartyMailClient.swift placed in that folder.

volodymyr-chekyrta · 2023-11-15T08:30:36Z

We know the library is available via pods, yet it is not currently under active development.

@volodymyr-chekyrta I guess what Umer is saying is that there should be clarity in what code we wrote and what code we are using from a third-party or external source.

And for that clarity, he was suggesting to create a folder named (ExternalLibraries/3rdPartyLibraries) at root in the framework where we are using a third-party library and place the 3rd party code in that folder instead of having it in the subdirectory. For example, in the rating feature, a folder named ExternalLibraries would be created in the Core framework and ThirdPartyMailClient.swift placed in that folder.

I understand, but I'm not quite sure why we need to create a new folder and relocate these files into it for this specific feature.
I strongly believe that this is redundant in this particular situation.

saeedbashir · 2023-11-15T11:34:08Z

but I'm not quite sure why we need to create a new folder and relocate these files into it for this specific feature

There are multiple reasons why we are suggesting moving 3rd party libraries to a central location:

Most of the open-source libraries are available under the MIT license; in given case, ThirdPartyMailer is available under MIT license which means we should attribute the author
We don't need to review the third-party code, but if there isn't any indication of 3rd-party code then we will end up reviewing that code as well
It will be much easier to list down all the third-party libraries that we are using.

volodymyr-chekyrta · 2023-11-15T12:24:32Z

Most of the open-source libraries are available under the MIT license; in given case, ThirdPartyMailer is available under MIT license which means we should attribute the author

@saeedbashir Could you please specify how we should attribute the author?
An example from the old repo would be great.

saeedbashir · 2023-11-15T13:21:36Z

Most of the open-source libraries are available under the MIT license; in given case, ThirdPartyMailer is available under MIT license which means we should attribute the author

@saeedbashir Could you please specify how we should attribute the author? An example from the old repo would be great.

There are two steps involved, but the first is a must:

Add the library or files with the author details along with the license.
Highlight the usage of the library somewhere in the app or codebase.

We were using the first step. You can find details about all the external libraries that were being used in edX as local libraries here

Added a check to ensure that the rating window is displayed no more than once every 4 months. Corrected copyright in ThirdPartyMailer

volodymyr-chekyrta · 2023-11-15T18:45:16Z

@marcotuts, upgraded logic in the last commit, so now the review popup only shows once every four months.

mumer92 · 2023-11-16T03:46:43Z

Core/Core/View/Base/AppReview/AppReviewViewModel.swift

+    }
+
+    func requestReview() {
+        SKStoreReviewController.requestReview()


app has minimum target of iOS 15, this api was deprecated in iOS 14, how about using the updated api?

Replace to @Environment(\.requestReview) var requestReview and move logic from AppReviewViewModel to AppReviewView.

mumer92 · 2023-11-16T03:47:48Z

Core/Core/View/Base/AppReview/AppReviewViewModel.swift

+    func openMailClient(_ with: ThirdPartyMailClient) {
+
+        let osVersion = UIDevice.current.systemVersion
+        let appVersion = Bundle.main.infoDictionary?["CFBundleShortVersionString"] as? String ?? ""


Bundle.main.infoDictionary?["CFBundleShortVersionString"] is being used at multiple places, i think we should centralize this somewhere, what are your thoughts?

We'll need to think about this as part of the next refactoring.

mumer92 · 2023-11-16T03:49:02Z

Core/Core/View/Base/AppReview/AppReviewView.swift

+                })
+            } else {
+                VStack(spacing: 20) {
+                    if viewModel.state == .thanksForFeedback || viewModel.state == .thanksForVote {


how about using switch here instead of if else?

Good idea, done!

move requestReview logic to AppReviewView replace if/else logic to switch in AppReviewViewModel

Conflicts: Core/Core/Data/CoreStorage.swift

push SKStoreReviewController logic to extension for iOS 15 compatibility

openedx-webhooks · 2023-11-17T11:51:04Z

@IvanStepanok 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.

Stepanokdev added 8 commits October 27, 2023 11:13

add AppReviewView

ad7ad56

add viewmodel

fb01410

work in progress

84c3e83

Add third party mail clients support

986e753

In-App Review system

c9f0ac2

add localizations

17d7357

Merge branch 'develop' into feature/in-app-review-system

0cf6b14

Update Assets.swift

ddb28c2

openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Nov 3, 2023

rnr reviewed Nov 14, 2023

View reviewed changes

Update AppReview logic

fad46a8

Added a check to ensure that the rating window is displayed no more than once every 4 months. Corrected copyright in ThirdPartyMailer

mumer92 suggested changes Nov 16, 2023

View reviewed changes

fixes

29185f7

move requestReview logic to AppReviewView replace if/else logic to switch in AppReviewViewModel

mumer92 approved these changes Nov 16, 2023

View reviewed changes

Stepanokdev added 2 commits November 16, 2023 18:04

Merge branch 'develop'

e79dec2

Conflicts: Core/Core/Data/CoreStorage.swift

Fix merge conflicts

f40a840

push SKStoreReviewController logic to extension for iOS 15 compatibility

volodymyr-chekyrta approved these changes Nov 16, 2023

View reviewed changes

volodymyr-chekyrta merged commit 0d28f7d into openedx:develop Nov 17, 2023
2 checks passed

volodymyr-chekyrta deleted the feature/in-app-review-system branch November 17, 2023 11:51

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature/in app review system #148

Feature/in app review system #148

IvanStepanok commented Nov 3, 2023 •

edited

Loading

openedx-webhooks commented Nov 3, 2023

sdaitzman commented Nov 13, 2023

mumer92 commented Nov 13, 2023

rnr commented Nov 13, 2023

mumer92 commented Nov 13, 2023

volodymyr-chekyrta commented Nov 14, 2023

volodymyr-chekyrta commented Nov 14, 2023

rnr Nov 14, 2023

mumer92 commented Nov 14, 2023 •

edited

Loading

marcotuts commented Nov 14, 2023

volodymyr-chekyrta commented Nov 14, 2023

volodymyr-chekyrta commented Nov 14, 2023

volodymyr-chekyrta commented Nov 14, 2023

sdaitzman commented Nov 14, 2023 •

edited

Loading

saeedbashir commented Nov 15, 2023

volodymyr-chekyrta commented Nov 15, 2023

saeedbashir commented Nov 15, 2023

volodymyr-chekyrta commented Nov 15, 2023

saeedbashir commented Nov 15, 2023

volodymyr-chekyrta commented Nov 15, 2023

mumer92 Nov 16, 2023

IvanStepanok Nov 16, 2023

mumer92 Nov 16, 2023

IvanStepanok Nov 16, 2023

mumer92 Nov 16, 2023

IvanStepanok Nov 16, 2023

openedx-webhooks commented Nov 17, 2023

Feature/in app review system #148

Feature/in app review system #148

Conversation

IvanStepanok commented Nov 3, 2023 • edited Loading

openedx-webhooks commented Nov 3, 2023

sdaitzman commented Nov 13, 2023

mumer92 commented Nov 13, 2023

rnr commented Nov 13, 2023

mumer92 commented Nov 13, 2023

volodymyr-chekyrta commented Nov 14, 2023

volodymyr-chekyrta commented Nov 14, 2023

rnr Nov 14, 2023

Choose a reason for hiding this comment

mumer92 commented Nov 14, 2023 • edited Loading

marcotuts commented Nov 14, 2023

volodymyr-chekyrta commented Nov 14, 2023

volodymyr-chekyrta commented Nov 14, 2023

volodymyr-chekyrta commented Nov 14, 2023

sdaitzman commented Nov 14, 2023 • edited Loading

saeedbashir commented Nov 15, 2023

volodymyr-chekyrta commented Nov 15, 2023

saeedbashir commented Nov 15, 2023

volodymyr-chekyrta commented Nov 15, 2023

saeedbashir commented Nov 15, 2023

volodymyr-chekyrta commented Nov 15, 2023

mumer92 Nov 16, 2023

Choose a reason for hiding this comment

IvanStepanok Nov 16, 2023

Choose a reason for hiding this comment

mumer92 Nov 16, 2023

Choose a reason for hiding this comment

IvanStepanok Nov 16, 2023

Choose a reason for hiding this comment

mumer92 Nov 16, 2023

Choose a reason for hiding this comment

IvanStepanok Nov 16, 2023

Choose a reason for hiding this comment

openedx-webhooks commented Nov 17, 2023

IvanStepanok commented Nov 3, 2023 •

edited

Loading

mumer92 commented Nov 14, 2023 •

edited

Loading

sdaitzman commented Nov 14, 2023 •

edited

Loading