MBL-1022: Add blocking mutation to iOS client #1890

amy-at-kickstarter · 2023-11-27T16:55:53Z

📲 What

Add BlockUser mutation to the app.

🤔 Why

So we can implement blocking in the UI!

amy-at-kickstarter · 2023-11-27T16:56:26Z

KsApi/GraphAPI.swift

@@ -6716,7 +6841,7 @@ public enum GraphAPI {
      }

      public struct Node: GraphQLSelectionSet {
-        public static let possibleTypes: [String] = ["Backing", "Reward", "Photo", "RewardItem", "Project", "Comment", "User", "Address", "Conversation", "Message", "CuratedPage", "Location", "Organization", "UserUrl", "Category", "AiDisclosure", "BusinessAddress", "ProjectFeaturedImage", "Flagging", "Video", "VideoTrack", "VideoTrackCue", "ProjectProfile", "AttachedAudio", "AttachedVideo", "Tag", "CreatorInterview", "InterviewAnswer", "InterviewQuestion", "CreatorPrompt", "FreeformPost", "ShippingRule", "Checkout", "Order", "OrderAddress", "Survey"]
+        public static let possibleTypes: [String] = ["Backing", "Reward", "Photo", "RewardItem", "Project", "Comment", "User", "Address", "Conversation", "Message", "CuratedPage", "Location", "Organization", "UserUrl", "Category", "AiDisclosure", "BusinessAddress", "Flagging", "Video", "VideoTrack", "VideoTrackCue", "ProjectProfile", "AttachedAudio", "AttachedVideo", "Tag", "CreatorInterview", "InterviewAnswer", "InterviewQuestion", "CreatorPrompt", "FreeformPost", "ShippingRule", "Checkout", "Order", "OrderAddress", "Survey"]


There were a few other changes in the GraphQL schema since it was last updated, so I assume these are part of that.

One point worth noting - right now we only update the schema when we need to update it on the client. But we should really be updating it any time changes to the web schema are pushed out - otherwise, we risk getting out of sync, and (say) using a feature that no longer actually exists on the web.

Obviously I'd hope that someone working on the web side would point this out to us before merging that change! But nice to enforce the same thing through code, not just socially.

amy-at-kickstarter · 2023-11-27T16:58:17Z

KsApi/Service.swift

+    return GraphQL.shared.client
+      .perform(mutation: GraphAPI.BlockUserMutation(input: GraphAPI.BlockUserInput(blockUserId: userId)))
+      .flatMap { _ in
+        SignalProducer(value: EmptyResponseEnvelope())


So BlockUser can return two fields: success and currentUser { blockedUsers } . However, based on my current understanding of the client designs, we don't need to read either of these fields: we'll fetch isBlocked directly on other User objects.

Is that correct? Based on that assumption I figured I'd take the simplest route out and return an EmptyResponseEnvelope.

Yep exactly. We only need to know if it was successful right now.

amy-at-kickstarter · 2023-11-27T16:59:50Z

KsApi/Service.swift

+  public func blockUser(userId: String)
+    -> SignalProducer<EmptyResponseEnvelope, ErrorEnvelope> {
+    return GraphQL.shared.client
+      .perform(mutation: GraphAPI.BlockUserMutation(input: GraphAPI.BlockUserInput(blockUserId: userId)))


GraphAPI.BlockUserMutation wants us to pass it a GraphQLID type, which can also be a String. It's not obvious to me if we'll need to turn the ID into a base64-encoded value, like a proper GraphQL identifier, or if it will be happy taking a plain, string-based user ID like "12345".

Let's follow the same "adapter" pattern that we're using elsewhere here. We can create an extension on GraphAPI.BlockUserInput for creating the input type. Extracting this allows us to test it more easily. See GraphAPI.WatchProjectInput.from(_ input:... for an example

codecov · 2023-11-27T17:19:20Z

Codecov Report

Attention: 7 lines in your changes are missing coverage. Please review.

Comparison is base (a164c48) 87.76% compared to head (670994a) 83.72%.

Files	Patch %	Lines
KsApi/Service.swift	0.00%	5 Missing ⚠️
KsApi/MockService.swift	0.00%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1890      +/-   ##
==========================================
- Coverage   87.76%   83.72%   -4.04%     
==========================================
  Files         858     1225     +367     
  Lines       77001   111519   +34518     
  Branches    20418    29673    +9255     
==========================================
+ Hits        67583    93374   +25791     
- Misses       8677    17125    +8448     
- Partials      741     1020     +279

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

scottkicks

Nice first run through! There's just a couple of things we need to add to stick to the existing pattern and keep things well tested. I added inline comments and you can use the linked PR below as a guide.

Let's create a BlockUserInput type to inject into our Service method as well as a .from(_ input...) helper extension to make it easier on ourselves to bundle up the expected properties once we implement this. Check out this PR out as a reference

Oh and we can add some tests around the input and extension as well 😄

scottkicks · 2023-11-27T17:10:31Z

KsApi/Service.swift

+  public func blockUser(userId: String)
+    -> SignalProducer<EmptyResponseEnvelope, ErrorEnvelope> {
+    return GraphQL.shared.client
+      .perform(mutation: GraphAPI.BlockUserMutation(input: GraphAPI.BlockUserInput(blockUserId: userId)))


Let's follow the same "adapter" pattern that we're using elsewhere here. We can create an extension on GraphAPI.BlockUserInput for creating the input type. Extracting this allows us to test it more easily. See GraphAPI.WatchProjectInput.from(_ input:... for an example

scottkicks · 2023-11-27T17:15:37Z

KsApi/Service.swift

+    return GraphQL.shared.client
+      .perform(mutation: GraphAPI.BlockUserMutation(input: GraphAPI.BlockUserInput(blockUserId: userId)))
+      .flatMap { _ in
+        SignalProducer(value: EmptyResponseEnvelope())


Yep exactly. We only need to know if it was successful right now.

scottkicks · 2023-11-27T17:16:48Z

KsApi/ServiceType.swift

@@ -380,6 +380,8 @@ public protocol ServiceType {

  func fetchBackedProjects(cursor: String?, limit: Int?)
    -> SignalProducer<FetchProjectsEnvelope, ErrorEnvelope>
+
+  func blockUser(userId: String) -> SignalProducer<EmptyResponseEnvelope, ErrorEnvelope>


So, this will be func blockUser(input: BlockUserInput) -> SignalProducer<EmptyResponseEnvelope, ErrorEnvelope>

nativeksr · 2023-11-27T19:00:15Z

	1 Warning
⚠️	Big PR

Generated by 🚫 Danger

amy-at-kickstarter · 2023-11-27T19:08:19Z

KsApi/mutations/inputs/BlockUserInput.swift

@@ -0,0 +1,5 @@
+import Foundation


@scottkicks Can you explain a little more about this input adapter pattern? Happy to follow it for now, but at least for a very teeny input like this, it doesn't seem obviously beneficial. I'm curious to hear more about why we've been using this pattern instead of using the GraphAPI.XYZInput objects directly.

scottkicks · 2023-11-29T15:42:02Z

@amy-at-kickstarter Until we can say this current mutation works and is testable as expected, we might want to hold off on merging this. In case Santiago has to make further changes. ref: https://kickstarter.slack.com/archives/C05HX9GS0CD/p1701219627599909?thread_ts=1701184665.560489&cid=C05HX9GS0CD

amy-at-kickstarter commented Nov 27, 2023

View reviewed changes

scottkicks reviewed Nov 27, 2023

View reviewed changes

amy-at-kickstarter commented Nov 27, 2023

View reviewed changes

amy-at-kickstarter self-assigned this Nov 27, 2023

amy-at-kickstarter added the enhancement label Nov 27, 2023

amy-at-kickstarter requested a review from ifosli November 27, 2023 19:29

amy-at-kickstarter marked this pull request as ready for review November 27, 2023 19:29

amy-at-kickstarter force-pushed the feat/adyer/mbl-1022/block-mutation branch from fea8e73 to 01c9bd4 Compare November 27, 2023 20:17

amy-at-kickstarter added 4 commits November 28, 2023 15:23

Update GraphQL schema

43f40ee

MBL-1022: Add blocking mutation to KsApi

3b2b0cc

MBL-1022: Add graphQL blocking calls to Service and MockService

5272f34

Create BlockUserInput and adapters

a730d13

amy-at-kickstarter force-pushed the feat/adyer/mbl-1022/block-mutation branch from 01c9bd4 to a730d13 Compare November 28, 2023 20:23

amy-at-kickstarter requested a review from scottkicks November 28, 2023 22:20

scottkicks approved these changes Nov 29, 2023

View reviewed changes

Merge branch 'main' into feat/adyer/mbl-1022/block-mutation

670994a

amy-at-kickstarter merged commit 3279b51 into main Nov 29, 2023
7 checks passed

amy-at-kickstarter deleted the feat/adyer/mbl-1022/block-mutation branch November 29, 2023 19:47

scottkicks mentioned this pull request Nov 30, 2023

[MBL-1024] Wire Up Block User Mutation #1893

Merged

9 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

MBL-1022: Add blocking mutation to iOS client #1890

MBL-1022: Add blocking mutation to iOS client #1890

amy-at-kickstarter commented Nov 27, 2023 •

edited

amy-at-kickstarter Nov 27, 2023 •

edited

amy-at-kickstarter Nov 27, 2023

amy-at-kickstarter Nov 27, 2023

scottkicks Nov 27, 2023

amy-at-kickstarter Nov 27, 2023 •

edited

scottkicks Nov 27, 2023

codecov bot commented Nov 27, 2023 •

edited

scottkicks left a comment

scottkicks Nov 27, 2023

scottkicks Nov 27, 2023

scottkicks Nov 27, 2023

nativeksr commented Nov 27, 2023

amy-at-kickstarter Nov 27, 2023

scottkicks commented Nov 29, 2023 •

edited

MBL-1022: Add blocking mutation to iOS client #1890

MBL-1022: Add blocking mutation to iOS client #1890

Conversation

amy-at-kickstarter commented Nov 27, 2023 • edited

📲 What

🤔 Why

amy-at-kickstarter Nov 27, 2023 • edited

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

amy-at-kickstarter Nov 27, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Nov 27, 2023 • edited

Codecov Report

scottkicks 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

nativeksr commented Nov 27, 2023

Choose a reason for hiding this comment

scottkicks commented Nov 29, 2023 • edited

amy-at-kickstarter commented Nov 27, 2023 •

edited

amy-at-kickstarter Nov 27, 2023 •

edited

amy-at-kickstarter Nov 27, 2023 •

edited

codecov bot commented Nov 27, 2023 •

edited

scottkicks commented Nov 29, 2023 •

edited