Fix unclear API

SignalServiceKit/src/Loki/Messaging/LKAddressMessage.m

@@ -24,8 +24,8 @@
     return self;
 }
 
-- (SSKProtoContentBuilder *)contentBuilder:(SignalRecipient *)recipient {
+- (SSKProtoContentBuilder *)prepareCustomContentBuilder:(SignalRecipient *)recipient {
-    SSKProtoContentBuilder *contentBuilder = [super contentBuilder:recipient];
+    SSKProtoContentBuilder *contentBuilder = SSKProtoContent.builder;
   
     SSKProtoLokiAddressMessageBuilder *addressBuilder = [SSKProtoLokiAddressMessage builder];
     [addressBuilder setPtpAddress:self.address];
@@ -35,7 +35,7 @@
     NSError *error;
     SSKProtoLokiAddressMessage *addressMessage = [addressBuilder buildAndReturnError:&error];
     if (error || !addressMessage) {
-        OWSFailDebug(@"Failed to build LokiAddressMessage for %@: %@.", recipient.recipientId, error);
+        OWSFailDebug(@"Failed to build Loki address message for: %@ due to error: %@.", recipient.recipientId, error);
     } else {
         [contentBuilder setLokiAddressMessage:addressMessage];
     }

SignalServiceKit/src/Loki/Messaging/LKDeviceLinkMessage.m

@@ -31,27 +31,23 @@
 }
 
 #pragma mark Building
-- (SSKProtoContentBuilder *)contentBuilder:(SignalRecipient *)recipient
+- (SSKProtoContentBuilder *)prepareCustomContentBuilder:(SignalRecipient *)recipient {
-{
+    SSKProtoContentBuilder *contentBuilder = SSKProtoContent.builder;
-    SSKProtoContentBuilder *contentBuilder = [super contentBuilder:recipient];
+    // If this is a request then we should attach a pre key bundle
-       
+    if (self.kind == LKDeviceLinkMessageKindRequest) {
-    // If it's a linking request then we should send a prekey bundle
-    if (self.masterSignature == nil) {
         PreKeyBundle *bundle = [OWSPrimaryStorage.sharedManager generatePreKeyBundleForContact:recipient.recipientId];
         SSKProtoPrekeyBundleMessageBuilder *preKeyBuilder = [SSKProtoPrekeyBundleMessage builderFromPreKeyBundle:bundle];
-
+        // Build the pre key bundle message
-        // Build the prekey bundle message
         NSError *error;
-        SSKProtoPrekeyBundleMessage *_Nullable message = [preKeyBuilder buildAndReturnError:&error];
+        SSKProtoPrekeyBundleMessage *message = [preKeyBuilder buildAndReturnError:&error];
         if (error || !message) {
-            OWSFailDebug(@"Failed to build pre key bundle for %@: %@", recipient.recipientId, error);
+            OWSFailDebug(@"Failed to build pre key bundle for: %@ due to error: %@.", recipient.recipientId, error);
             return nil;
         } else {
             [contentBuilder setPrekeyBundleMessage:message];
         }
     }
-    
+    // Build the device link message
-    // Device link message
     NSError *error;
     SSKProtoLokiDeviceLinkMessageBuilder *deviceLinkMessageBuilder = [SSKProtoLokiDeviceLinkMessage builder];
     [deviceLinkMessageBuilder setMasterHexEncodedPublicKey:self.masterHexEncodedPublicKey];
@@ -60,12 +56,12 @@
     [deviceLinkMessageBuilder setSlaveSignature:self.slaveSignature];
     SSKProtoLokiDeviceLinkMessage *deviceLinkMessage = [deviceLinkMessageBuilder buildAndReturnError:&error];
     if (error || deviceLinkMessage == nil) {
-        OWSFailDebug(@"Failed to build device link message due to error: %@.", error);
+        OWSFailDebug(@"Failed to build device link message for: %@ due to error: %@.", recipient.recipientId, error);
         return nil;
     } else {
         [contentBuilder setLokiDeviceLinkMessage:deviceLinkMessage];
     }
-    
+    // Return
     return contentBuilder;
 }
 

SignalServiceKit/src/Loki/Messaging/LKFriendRequestMessage.m

@@ -6,17 +6,17 @@
 
 @implementation LKFriendRequestMessage
 
-- (SSKProtoContentBuilder *)contentBuilder:(SignalRecipient *)recipient {
+- (SSKProtoContentBuilder *)prepareCustomContentBuilder:(SignalRecipient *)recipient {
-    SSKProtoContentBuilder *contentBuilder = [super contentBuilder:recipient];
+    SSKProtoContentBuilder *contentBuilder = SSKProtoContent.builder;
     
     PreKeyBundle *bundle = [OWSPrimaryStorage.sharedManager generatePreKeyBundleForContact:recipient.recipientId];
     SSKProtoPrekeyBundleMessageBuilder *preKeyBuilder = [SSKProtoPrekeyBundleMessage builderFromPreKeyBundle:bundle];
     
-    // Build the prekey bundle message
+    // Build the pre key bundle message
     NSError *error;
     SSKProtoPrekeyBundleMessage *_Nullable message = [preKeyBuilder buildAndReturnError:&error];
     if (error || !message) {
-        OWSFailDebug(@"Failed to build pre key bundle for %@: %@", recipient.recipientId, error);
+        OWSFailDebug(@"Failed to build pre key bundle for: %@ due to error: %@.", recipient.recipientId, error);
     } else {
          [contentBuilder setPrekeyBundleMessage:message];
     }

SignalServiceKit/src/Messages/Interactions/OWSEndSessionMessage.m

@@ -48,17 +48,17 @@ NS_ASSUME_NONNULL_BEGIN
     return builder;
 }
 
-- (SSKProtoContentBuilder *)contentBuilder:(SignalRecipient *)recipient {
+- (SSKProtoContentBuilder *)prepareCustomContentBuilder:(SignalRecipient *)recipient {
-    SSKProtoContentBuilder *builder = [super contentBuilder:recipient];
+    SSKProtoContentBuilder *builder = SSKProtoContent.builder;
     
     PreKeyBundle *bundle = [OWSPrimaryStorage.sharedManager generatePreKeyBundleForContact:recipient.recipientId];
     SSKProtoPrekeyBundleMessageBuilder *preKeyBuilder = [SSKProtoPrekeyBundleMessage builderFromPreKeyBundle:bundle];
     
-    // Build the prekey bundle message
+    // Build the pre key bundle message
     NSError *error;
     SSKProtoPrekeyBundleMessage *_Nullable message = [preKeyBuilder buildAndReturnError:&error];
     if (error || !message) {
-        OWSFailDebug(@"Failed to build preKeyBundle for %@: %@", recipient.recipientId, error);
+        OWSFailDebug(@"Failed to build pre key bundle for: %@ due to error: %@.", recipient.recipientId, error);
     } else {
         [builder setPrekeyBundleMessage:message];
     }

SignalServiceKit/src/Messages/Interactions/TSOutgoingMessage.h

@@ -162,10 +162,9 @@ typedef NS_ENUM(NSInteger, TSGroupMetaMessage) {
 - (nullable SSKProtoDataMessage *)buildDataMessage:(NSString *_Nullable)recipientId;
 
 /**
- * Intermediate protobuf representation
+ * Allows subclasses to supply a custom content builder that has already prepared part of the message.
- * Subclasses can augment if they want to manipulate the content message before building.
  */
-- (SSKProtoContentBuilder *)contentBuilder:(SignalRecipient *)recipient;
+- (SSKProtoContentBuilder *)prepareCustomContentBuilder:(SignalRecipient *)recipient;
 
 /**
  * Should this message be synced to the users other registered devices? This is

SignalServiceKit/src/Messages/Interactions/TSOutgoingMessage.m

@@ -1122,11 +1122,6 @@ NSString *NSStringForOutgoingMessageRecipientState(OWSOutgoingMessageRecipientSt
     return dataProto;
 }
 
-- (SSKProtoContentBuilder *)contentBuilder:(SignalRecipient *)recipient
-{
-    return SSKProtoContent.builder;
-}
-
 - (nullable NSData *)buildPlainTextData:(SignalRecipient *)recipient
 {
     NSError *error;
@@ -1136,8 +1131,7 @@ NSString *NSStringForOutgoingMessageRecipientState(OWSOutgoingMessageRecipientSt
         return nil;
     }
 
-    SSKProtoContentBuilder *contentBuilder = [self contentBuilder:recipient];
+    SSKProtoContentBuilder *contentBuilder = [self prepareCustomContentBuilder:recipient] ?: SSKProtoContent.builder;
-    if (contentBuilder == nil) { return nil; }
     
     [contentBuilder setDataMessage:dataMessage];
     NSData *_Nullable contentData = [contentBuilder buildSerializedDataAndReturnError:&error];
@@ -1145,6 +1139,7 @@ NSString *NSStringForOutgoingMessageRecipientState(OWSOutgoingMessageRecipientSt
         OWSFailDebug(@"could not serialize protobuf: %@", error);
         return nil;
     }
+    
     return contentData;
 }