Custom URL Scheme Implementation #657

hassan31 · 2024-09-06T05:55:01Z

Implemented custom url scheme to support launching the Quran Application from outside the application
For example, enter this in browser quran-ios:// and it will redirect you to the Quran Application

Example Video

RPReplay_Final1725599281.MP4

iman2153

lgtm

hassan31 · 2024-09-07T04:53:21Z

@mohamede1945 could you please review this pr and approve so that it can be merged. Thanks

mohamede1945 · 2024-09-07T16:34:47Z

Salam alikom Muhammad, thank you for the contribution. But the code is empty. There's nothing implemented to parse the query parameters and navigate to a specific Ayah as mentioned in #348.

hassan31 · 2024-09-07T16:37:08Z

@mohamede1945 Wa Alaikumuslaam, Yes, this is the partial implementation, in which I have launched the application from outside link. In followup pr I will write the code to parse. So if you could approve and merge that would be really great.

mohamede1945

Sounds good. I've added a couple of comments, please take a look. Also, please make sure to run make format-autocorrect to fix formatting issues.

Thank you!

mohamede1945 · 2024-09-07T16:40:38Z

Example/QuranEngineApp/Classes/AppDelegate.swift

+
+    func application(_ app: UIApplication, open url: URL, options: [UIApplication.OpenURLOptionsKey: Any] = [:]) -> Bool {
+        // Check if the URL scheme matches the custom scheme
+        if url.scheme == "quran-ios" {


Let's handle "quran" and "quran-ios" schemes please.

mohamede1945 · 2024-09-07T16:41:03Z

Example/QuranEngineApp/Classes/AppDelegate.swift

@@ -49,6 +49,27 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
        let downloadManager = container.downloadManager
        downloadManager.setBackgroundSessionCompletion(completionHandler)
    }
+
+    func application(_ app: UIApplication, open url: URL, options: [UIApplication.OpenURLOptionsKey: Any] = [:]) -> Bool {
+        // Check if the URL scheme matches the custom scheme


Please remove this redundant comment. The code is clear. Same with the other inline comments below.

mohamede1945 · 2024-09-07T16:42:06Z

Example/QuranEngineApp/Classes/AppDelegate.swift

+        // Check if the URL scheme matches the custom scheme
+        if url.scheme == "quran-ios" {
+            // Parse the URL to determine the desired action
+            let path = url.host ?? ""


host is not the path. We should look at the url.path rather than the host.

mohamede1945 · 2024-09-07T16:44:41Z

Example/QuranEngineApp/Classes/AppDelegate.swift

+        return false
+    }
+
+    private func handleCustomURL(path: String) {


handle seems very generic. I would rename it to navigateTo(path: String). Also let's make this method return false if it can't parse and navigate to the path.

mohamede1945 · 2024-09-07T16:45:06Z

Example/QuranEngineApp/Info.plist

+			<string>com.quran.QuranEngineApp</string>
+			<key>CFBundleURLSchemes</key>
+			<array>
+				<string>quran-ios</string>


Let's add an entry for quran scheme please.

mohamede1945 · 2024-09-07T16:53:41Z

Oh actually, please move the validation, parsing and navigation code to the QuranEngine instead of the example app. The example app would simply just implement the delegate method but then calls the QuranEngine to do the actual logic, this way the code can be shared among different apps.

hassan31 · 2024-09-08T04:19:30Z

Oh actually, please move the validation, parsing and navigation code to the QuranEngine instead of the example app. The example app would simply just implement the delegate method but then calls the QuranEngine to do the actual logic, this way the code can be shared among different apps.

AOA @mohamede1945 I have addressed your comments, kindly review again. Also regarding move the validation, parsing and navigation code to QuranEngine, i can see the same code there, but in pr it reflects in Example/QuranEngine app. May be if you guide how to move then I would do. Please check below screenshot.

mohamede1945 · 2024-09-08T16:00:07Z

You see here how the code in the example project delegates the business logic to the DownloadManager and ReadingResourcesService. These live in the QuranEngine library not in the Example project. The example project just delegates the call to these services.

In url scheme navigation logic, I think it makes sense to live in the AppStructureFeature.

hassan31 · 2024-09-08T17:33:33Z

You see here how the code in the example project delegates the business logic to the DownloadManager and ReadingResourcesService. These live in the QuranEngine library not in the Example project. The example project just delegates the call to these services.

In url scheme navigation logic, I think it makes sense to live in the AppStructureFeature.

@mohamede1945 can we connect through some communication tools, like slack or google meet, I wanted to learn more about the structure?

hassan31 · 2024-09-09T19:13:39Z

@mohamede1945 are you still available to review the latest changes?

mohamede1945 · 2024-09-10T02:47:07Z

Jazak Allah khyrn for the changes. I'm going to merge it after CI finishes. You can reach out to me on discord with the same username used here in github.

codecov · 2024-09-10T03:05:25Z

Codecov Report

Attention: Patch coverage is 0% with 12 lines in your changes missing coverage. Please review.

Project coverage is 39.69%. Comparing base (d9fc366) to head (5223a5b).
Report is 17 commits behind head on main.

Files with missing lines	Patch %	Lines
...res/AppStructureFeature/Launch/LaunchBuilder.swift	0.00%	12 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #657      +/-   ##
==========================================
- Coverage   40.92%   39.69%   -1.24%     
==========================================
  Files         525      526       +1     
  Lines       20880    19453    -1427     
==========================================
- Hits         8546     7721     -825     
+ Misses      12334    11732     -602

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

hassan31 · 2024-09-10T03:38:13Z

Jazak Allah khyrn for the changes. I'm going to merge it after CI finishes. You can reach out to me on discord with the same username used here in github.

Merge is blocked, because of some checks are not successful. I also installed the swiftlint, but looks good on my side. May be you can help to find what is wrong with which format.

Also, I sent you request on discord. Please accept. Jazakallah Khair.

Custom URL Scheme Implementation

62806bb

iman2153 approved these changes Sep 7, 2024

View reviewed changes

iman2153 mentioned this pull request Sep 7, 2024

Allow other apps to launch this app and jump to a particular Ayah #348

Open

hassan31 requested a review from iman2153 September 7, 2024 04:48

mohamede1945 requested changes Sep 7, 2024

View reviewed changes

pr comments addressed

6bc0f26

moved the url parsing and navigation logic to QuranEngine

c1caf02

code refactored, moved to AppStructureFeature

5223a5b

mohamede1945 approved these changes Sep 11, 2024

View reviewed changes

mohamede1945 merged commit 7bd3f18 into quran:main Sep 11, 2024
2 of 3 checks passed

iman2153 mentioned this pull request Sep 13, 2024

Custom URL Scheme Implementation Supporting Sura and Verse Number #659

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Custom URL Scheme Implementation #657

Custom URL Scheme Implementation #657

hassan31 commented Sep 6, 2024

iman2153 left a comment

hassan31 commented Sep 7, 2024

mohamede1945 commented Sep 7, 2024

hassan31 commented Sep 7, 2024

mohamede1945 left a comment

mohamede1945 Sep 7, 2024

hassan31 Sep 8, 2024

mohamede1945 Sep 7, 2024

hassan31 Sep 8, 2024

mohamede1945 Sep 7, 2024

hassan31 Sep 8, 2024

mohamede1945 Sep 7, 2024

hassan31 Sep 8, 2024

mohamede1945 Sep 7, 2024

hassan31 Sep 8, 2024

mohamede1945 commented Sep 7, 2024

hassan31 commented Sep 8, 2024

mohamede1945 commented Sep 8, 2024

hassan31 commented Sep 8, 2024

hassan31 commented Sep 9, 2024

mohamede1945 commented Sep 10, 2024

codecov bot commented Sep 10, 2024 •

edited

Loading

hassan31 commented Sep 10, 2024 •

edited

Loading

Custom URL Scheme Implementation #657

Custom URL Scheme Implementation #657

Conversation

hassan31 commented Sep 6, 2024

iman2153 left a comment

Choose a reason for hiding this comment

hassan31 commented Sep 7, 2024

mohamede1945 commented Sep 7, 2024

hassan31 commented Sep 7, 2024

mohamede1945 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mohamede1945 commented Sep 7, 2024

hassan31 commented Sep 8, 2024

mohamede1945 commented Sep 8, 2024

hassan31 commented Sep 8, 2024

hassan31 commented Sep 9, 2024

mohamede1945 commented Sep 10, 2024

codecov bot commented Sep 10, 2024 • edited Loading

Codecov Report

hassan31 commented Sep 10, 2024 • edited Loading

codecov bot commented Sep 10, 2024 •

edited

Loading

hassan31 commented Sep 10, 2024 •

edited

Loading