Merge branch 'release/0.20.16/master'

CHANGES.md

@@ -1,3 +1,15 @@
+## Changes in 0.20.16 (2022-01-11)
+
+🙌 Improvements
+
+- MXResponse has been frozen for binary compatibility when building as an XCFramework. ([#1002](https://github.com/matrix-org/matrix-ios-sdk/pull/1002))
+- MXTaskProfile: Add an MXTaskProfileName enum instead of individual strings for Name and Category. ([#5035](https://github.com/vector-im/element-ios/issues/5035))
+
+⚠️ API Changes
+
+- MXAnalyticsDelegate: The generic methods have been replaced with type safe ones for each event tracked. ([#5035](https://github.com/vector-im/element-ios/issues/5035))
+
+
 ## Changes in 0.20.15 (2021-12-14)
 
 🙌 Improvements

MatrixSDK.podspec

@@ -1,7 +1,7 @@
 Pod::Spec.new do |s|
 
  s.name = "MatrixSDK"
- s.version = "0.20.15"
+ s.version = "0.20.16"
  s.summary = "The iOS SDK to build apps compatible with Matrix (https://www.matrix.org)"
 
  s.description = <<-DESC

MatrixSDK.xcodeproj/project.pbxproj

@@ -49,6 +49,10 @@
  189CC082265E361D00BE1FD8 /* MXLog.h in Headers */ = {isa = PBXBuildFile; fileRef = 189CC07F265E361500BE1FD8 /* MXLog.h */; settings = {ATTRIBUTES = (Public, ); }; };
  189CC083265E362600BE1FD8 /* MXLog.swift in Sources */ = {isa = PBXBuildFile; fileRef = 189CC080265E361500BE1FD8 /* MXLog.swift */; };
  189CC084265E362700BE1FD8 /* MXLog.swift in Sources */ = {isa = PBXBuildFile; fileRef = 189CC080265E361500BE1FD8 /* MXLog.swift */; };
+ 18B22A7027707CDD00482170 /* MXEventContentLocation.h in Headers */ = {isa = PBXBuildFile; fileRef = 18B22A6E27707CDD00482170 /* MXEventContentLocation.h */; settings = {ATTRIBUTES = (Public, ); }; };
+ 18B22A7127707CDD00482170 /* MXEventContentLocation.h in Headers */ = {isa = PBXBuildFile; fileRef = 18B22A6E27707CDD00482170 /* MXEventContentLocation.h */; settings = {ATTRIBUTES = (Public, ); }; };
+ 18B22A7227707CDD00482170 /* MXEventContentLocation.m in Sources */ = {isa = PBXBuildFile; fileRef = 18B22A6F27707CDD00482170 /* MXEventContentLocation.m */; };
+ 18B22A7327707CDD00482170 /* MXEventContentLocation.m in Sources */ = {isa = PBXBuildFile; fileRef = 18B22A6F27707CDD00482170 /* MXEventContentLocation.m */; };
  18C26C3D273C031900805154 /* PollAggregator.swift in Sources */ = {isa = PBXBuildFile; fileRef = 18C26C3C273C031900805154 /* PollAggregator.swift */; };
  18C26C3E273C032900805154 /* PollAggregator.swift in Sources */ = {isa = PBXBuildFile; fileRef = 18C26C3C273C031900805154 /* PollAggregator.swift */; };
  18C26C4A273C0B3A00805154 /* PollAggregator.swift in Sources */ = {isa = PBXBuildFile; fileRef = 18C26C3C273C031900805154 /* PollAggregator.swift */; };
@@ -709,6 +713,8 @@
  91CC0FCB26A033AE00C2A387 /* MXURLPreview.h in Headers */ = {isa = PBXBuildFile; fileRef = 91CC0FC826A033AE00C2A387 /* MXURLPreview.h */; settings = {ATTRIBUTES = (Public, ); }; };
  91CC0FCC26A033AE00C2A387 /* MXURLPreview.m in Sources */ = {isa = PBXBuildFile; fileRef = 91CC0FC926A033AE00C2A387 /* MXURLPreview.m */; };
  91CC0FCD26A033AE00C2A387 /* MXURLPreview.m in Sources */ = {isa = PBXBuildFile; fileRef = 91CC0FC926A033AE00C2A387 /* MXURLPreview.m */; };
+ 91F0685D2767CA420079F8FA /* MXTaskProfileName.h in Headers */ = {isa = PBXBuildFile; fileRef = 91F0685C2767C9FF0079F8FA /* MXTaskProfileName.h */; settings = {ATTRIBUTES = (Public, ); }; };
+ 91F0685E2767CA430079F8FA /* MXTaskProfileName.h in Headers */ = {isa = PBXBuildFile; fileRef = 91F0685C2767C9FF0079F8FA /* MXTaskProfileName.h */; settings = {ATTRIBUTES = (Public, ); }; };
  92634B7F1EF2A37A00DB9F60 /* MXCallAudioSessionConfigurator.h in Headers */ = {isa = PBXBuildFile; fileRef = 92634B7E1EF2A37A00DB9F60 /* MXCallAudioSessionConfigurator.h */; settings = {ATTRIBUTES = (Public, ); }; };
  92634B821EF2E3C400DB9F60 /* MXCallKitConfiguration.h in Headers */ = {isa = PBXBuildFile; fileRef = 92634B801EF2E3C400DB9F60 /* MXCallKitConfiguration.h */; settings = {ATTRIBUTES = (Public, ); }; };
  92634B831EF2E3C400DB9F60 /* MXCallKitConfiguration.m in Sources */ = {isa = PBXBuildFile; fileRef = 92634B811EF2E3C400DB9F60 /* MXCallKitConfiguration.m */; };
@@ -1682,6 +1688,8 @@
  18937E79273A5AB000902626 /* MXPollRelationTests.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = MXPollRelationTests.m; sourceTree = "<group>"; };
  189CC07F265E361500BE1FD8 /* MXLog.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = MXLog.h; sourceTree = "<group>"; };
  189CC080265E361500BE1FD8 /* MXLog.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MXLog.swift; sourceTree = "<group>"; };
+ 18B22A6E27707CDD00482170 /* MXEventContentLocation.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = MXEventContentLocation.h; sourceTree = "<group>"; };
+ 18B22A6F27707CDD00482170 /* MXEventContentLocation.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = MXEventContentLocation.m; sourceTree = "<group>"; };
  18C26C3C273C031900805154 /* PollAggregator.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = PollAggregator.swift; sourceTree = "<group>"; };
  18C26C4C273C0E9A00805154 /* MXPollAggregatorTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MXPollAggregatorTests.swift; sourceTree = "<group>"; };
  18C26C51273C16C700805154 /* MXEventContentPollStart.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = MXEventContentPollStart.h; sourceTree = "<group>"; };
@@ -2207,6 +2215,7 @@
  918D30B6273951F400A16405 /* MXStoreService.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MXStoreService.swift; sourceTree = "<group>"; };
  91CC0FC826A033AE00C2A387 /* MXURLPreview.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = MXURLPreview.h; sourceTree = "<group>"; };
  91CC0FC926A033AE00C2A387 /* MXURLPreview.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = MXURLPreview.m; sourceTree = "<group>"; };
+ 91F0685C2767C9FF0079F8FA /* MXTaskProfileName.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = MXTaskProfileName.h; sourceTree = "<group>"; };
  92634B7E1EF2A37A00DB9F60 /* MXCallAudioSessionConfigurator.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = MXCallAudioSessionConfigurator.h; sourceTree = "<group>"; };
  92634B801EF2E3C400DB9F60 /* MXCallKitConfiguration.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = MXCallKitConfiguration.h; sourceTree = "<group>"; };
  92634B811EF2E3C400DB9F60 /* MXCallKitConfiguration.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = MXCallKitConfiguration.m; sourceTree = "<group>"; };
@@ -2910,6 +2919,7 @@
  323F878B25553D84009E9E67 /* MXTaskProfile.h */,
  323F878C25553D84009E9E67 /* MXTaskProfile.m */,
  323F879525554FF2009E9E67 /* MXTaskProfile_Private.h */,
+ 91F0685C2767C9FF0079F8FA /* MXTaskProfileName.h */,
  );
  path = Profiling;
  sourceTree = "<group>";
@@ -3198,6 +3208,8 @@
  18C26C52273C16C700805154 /* MXEventContentPollStart.m */,
  327E9ADF2285497100A98BC1 /* MXEventContentRelatesTo.h */,
  327E9AE02285497100A98BC1 /* MXEventContentRelatesTo.m */,
+ 18B22A6E27707CDD00482170 /* MXEventContentLocation.h */,
+ 18B22A6F27707CDD00482170 /* MXEventContentLocation.m */,
  );
  path = Content;
  sourceTree = "<group>";
@@ -4474,6 +4486,7 @@
  32AF928A240EA3880008A0FD /* MXSecretShareSend.h in Headers */,
  B14EECE52577F76100448735 /* MXLoginSSOFlow.h in Headers */,
  EC8A53E025B1BCC6004E0802 /* MXThirdPartyProtocolInstance.h in Headers */,
+ 91F0685D2767CA420079F8FA /* MXTaskProfileName.h in Headers */,
  B1798D0624091A0100308A8F /* MXBase64Tools.h in Headers */,
  32133015228AF4EF0070BA9B /* MXRealmAggregationsStore.h in Headers */,
  32CE6FB81A409B1F00317F1E /* MXFileStoreMetaData.h in Headers */,
@@ -4556,6 +4569,7 @@
  EC8A538B25B1BC77004E0802 /* MXCallCandidate.h in Headers */,
  F03EF5041DF01596009DF592 /* MXLRUCache.h in Headers */,
  EC8A539D25B1BC77004E0802 /* MXCallCandidatesEventContent.h in Headers */,
+ 18B22A7027707CDD00482170 /* MXEventContentLocation.h in Headers */,
  EC60EDC6265CFEA800B39A4E /* MXRoomSyncUnreadNotifications.h in Headers */,
  329FB1791A0A74B100A5E88E /* MXTools.h in Headers */,
  3AC135D92640335100EE1E74 /* MXDehydrationService.h in Headers */,
@@ -4872,6 +4886,7 @@
  EC60EDDB265CFF0600B39A4E /* MXInvitedRoomSync.h in Headers */,
  B14EF2C82397E90400758AF0 /* MXCallManager.h in Headers */,
  B14EF2C92397E90400758AF0 /* MXRealmReactionRelation.h in Headers */,
+ 91F0685E2767CA430079F8FA /* MXTaskProfileName.h in Headers */,
  B14EF2CA2397E90400758AF0 /* MXAnalyticsDelegate.h in Headers */,
  ECD289A626EB980200F268CF /* MXRoomSummaryDataTypes.h in Headers */,
  B14EF2CB2397E90400758AF0 /* MXCallAudioSessionConfigurator.h in Headers */,
@@ -4986,6 +5001,7 @@
  91CC0FCB26A033AE00C2A387 /* MXURLPreview.h in Headers */,
  B19A30AD2404257700FB6F35 /* MXSASKeyVerificationStart.h in Headers */,
  B14EF3142397E90400758AF0 /* MXLoginTerms.h in Headers */,
+ 18B22A7127707CDD00482170 /* MXEventContentLocation.h in Headers */,
  B14EF3152397E90400758AF0 /* MXIncomingRoomKeyRequestCancellation.h in Headers */,
  EC8A539E25B1BC77004E0802 /* MXCallCandidatesEventContent.h in Headers */,
  325AD44023BE3E7500FF5277 /* MXCrossSigningInfo.h in Headers */,
@@ -5525,6 +5541,7 @@
  EC8A53BF25B1BC77004E0802 /* MXCallRejectReplacementEventContent.m in Sources */,
  EC8A539125B1BC77004E0802 /* MXCallCandidate.m in Sources */,
  B17B2BDD2369FC81009D6650 /* MXUIKitBackgroundTask.m in Sources */,
+ 18B22A7227707CDD00482170 /* MXEventContentLocation.m in Sources */,
  3293C701214BBA4F009B3DDB /* MXPeekingRoomSummary.m in Sources */,
  C602B58C1F2268F700B67D87 /* MXRoom.swift in Sources */,
  EC8A53D825B1BCC6004E0802 /* MXThirdPartyProtocolInstance.m in Sources */,
@@ -5997,6 +6014,7 @@
  B14EF21E2397E90400758AF0 /* MXEventDecryptionResult.m in Sources */,
  EC60EDBF265CFE8600B39A4E /* MXRoomSyncAccountData.m in Sources */,
  320B393D239FD15E00BE2C06 /* MXKeyVerificationRequest.m in Sources */,
+ 18B22A7327707CDD00482170 /* MXEventContentLocation.m in Sources */,
  EC05473725FF8A3C0047ECD7 /* MXVirtualRoomInfo.m in Sources */,
  3290293524CB10D000DA7BB6 /* MatrixSDKVersion.m in Sources */,
  3A7509BC26FC61DF00B85773 /* MXSpaceNotificationCounter.swift in Sources */,

MatrixSDK/Aggregations/MXAggregatedEditsUpdater.m

@@ -71,7 +71,7 @@ - (MXHTTPOperation*)replaceTextMessageEvent:(MXEvent*)event
  return nil;
  }
 
- NSString *messageType = event.content[@"msgtype"];
+ NSString *messageType = event.content[kMXMessageTypeKey];
 
  if (![self.editSupportedMessageTypes containsObject:messageType])
  {
@@ -108,15 +108,11 @@ - (MXHTTPOperation*)replaceTextMessageEvent:(MXEvent*)event
  }
 
  NSMutableDictionary *content = [NSMutableDictionary new];
- NSMutableDictionary *compatibilityContent = [NSMutableDictionary dictionaryWithDictionary:@{
- @"msgtype": messageType,
- @"body": [NSString stringWithFormat:@"* %@", finalText]
- }];
+ NSMutableDictionary *compatibilityContent = [NSMutableDictionary dictionaryWithDictionary:@{ kMXMessageTypeKey: messageType,
+ kMXMessageBodyKey: [NSString stringWithFormat:@"* %@", finalText] }];
 
- NSMutableDictionary *newContent = [NSMutableDictionary dictionaryWithDictionary:@{
- @"msgtype": messageType,
- @"body": finalText
- }];
+ NSMutableDictionary *newContent = [NSMutableDictionary dictionaryWithDictionary:@{ kMXMessageTypeKey: messageType,
+ kMXMessageBodyKey: finalText }];
 
 
  if (finalFormattedText)

MatrixSDK/Background/MXBackgroundSyncService.swift

@@ -453,7 +453,7 @@ public enum MXBackgroundSyncServiceError: Error {
 
  private func decryptMessageWithOlm(message: [AnyHashable: Any], theirDeviceIdentityKey: String) -> String? {
  let sessionIds = olmDevice.sessionIds(forDevice: theirDeviceIdentityKey)
- let messageBody = message["body"] as? String
+ let messageBody = message[kMXMessageBodyKey] as? String
  let messageType = message["type"] as? UInt ?? 0
 
  for sessionId in sessionIds ?? [] {

MatrixSDK/Contrib/Swift/MXResponse.swift

@@ -47,9 +47,10 @@ import Foundation
  }
  
  */
-public enum MXResponse<T> {
+@frozen public enum MXResponse<T> {
  case success(T)
  case failure(Error)
+ // Note: Additional cases break binary compatibility
 
  /// Indicates whether the API call was successful
  public var isSuccess: Bool {

MatrixSDK/Crypto/Algorithms/Olm/MXOlmDecryption.m

@@ -254,17 +254,17 @@ - (MXHTTPOperation*)shareKeysWithDevice:(MXIncomingRoomKeyRequest*)keyRequest
 - (NSString*)decryptMessage:(NSDictionary*)message andTheirDeviceIdentityKey:(NSString*)theirDeviceIdentityKey
 {
  NSArray<NSString *> *sessionIds = [olmDevice sessionIdsForDevice:theirDeviceIdentityKey];
-
- NSString *messageBody = message[@"body"];
+ 
+ NSString *messageBody = message[kMXMessageBodyKey];
  NSUInteger messageType = [((NSNumber*)message[@"type"]) unsignedIntegerValue];
-
+ 
  // Try each session in turn
  for (NSString *sessionId in sessionIds)
  {
  NSString *payload = [olmDevice decryptMessage:messageBody
- withType:messageType
- sessionId:sessionId
- theirDeviceIdentityKey:theirDeviceIdentityKey];
+  withType:messageType
+  sessionId:sessionId
+  theirDeviceIdentityKey:theirDeviceIdentityKey];
 
  if (payload)
  {

MatrixSDK/Crypto/KeySharing/Data/MXIncomingRoomKeyRequest.m

@@ -34,7 +34,7 @@ - (instancetype)initWithMXEvent:(MXEvent *)event
  _userId = event.sender;
  _deviceId = content[@"requesting_device_id"];
  _requestId = content[@"request_id"];
- _requestBody = content[@"body"] ? content[@"body"] : [NSDictionary dictionary];
+ _requestBody = content[kMXMessageBodyKey] ? content[kMXMessageBodyKey] : [NSDictionary dictionary];
  }
  return self;
 }

MatrixSDK/Crypto/KeySharing/MXOutgoingRoomKeyRequestManager.m

@@ -292,14 +292,14 @@ - (void)sendOutgoingRoomKeyRequest:(MXOutgoingRoomKeyRequest*)request
  failure:(void (^)(NSError *error))failure
 {
  MXLogDebug(@"[MXOutgoingRoomKeyRequestManager] sendOutgoingRoomKeyRequest: Requesting key %@ using request id %@ to %@: %@", request.sessionId, request.requestId, request.recipients, request.requestBody);
-
+ 
  NSDictionary *requestMessage = @{
-  @"action": @"request",
-  @"requesting_device_id": deviceId,
-  @"request_id": request.requestId,
-  @"body": request.requestBody
-  };
-
+ @"action": @"request",
+ @"requesting_device_id": deviceId,
+ @"request_id": request.requestId,
+ kMXMessageBodyKey: request.requestBody
+ };
+ 
  MXWeakify(self);
  [self sendMessageToDevices:requestMessage recipients:request.recipients txnId:request.requestId success:^{
  MXStrongifyAndReturnIfNil(self);

MatrixSDK/Crypto/MXOlmDevice.m

@@ -268,11 +268,11 @@ - (NSDictionary *)encryptMessage:(NSString *)theirDeviceIdentityKey sessionId:(N
  }
  }
  }];
-
+ 
  return @{
-  @"body": olmMessage.ciphertext,
-  @"type": @(olmMessage.type)
-  };
+ kMXMessageBodyKey: olmMessage.ciphertext,
+ @"type": @(olmMessage.type)
+ };
 }
 
 - (NSString*)decryptMessage:(NSString*)ciphertext withType:(NSUInteger)messageType sessionId:(NSString*)sessionId theirDeviceIdentityKey:(NSString*)theirDeviceIdentityKey

MatrixSDK/Crypto/Verification/JSONModels/MXKeyVerificationRequestByDMJSONModel.m

@@ -25,8 +25,8 @@ + (instancetype)modelFromJSON:(NSDictionary *)JSONDictionary
  MXKeyVerificationRequestByDMJSONModel *request = [MXKeyVerificationRequestByDMJSONModel new];
  if (request)
  {
- MXJSONModelSetString(request.body, JSONDictionary[@"body"]);
- MXJSONModelSetString(request.msgtype, JSONDictionary[@"msgtype"]);
+ MXJSONModelSetString(request.body, JSONDictionary[kMXMessageBodyKey]);
+ MXJSONModelSetString(request.msgtype, JSONDictionary[kMXMessageTypeKey]);
  MXJSONModelSetArray(request.methods, JSONDictionary[@"methods"]);
  MXJSONModelSetString(request.to, JSONDictionary[@"to"]);
  MXJSONModelSetString(request.fromDevice, JSONDictionary[@"from_device"]);
@@ -46,8 +46,8 @@ + (instancetype)modelFromJSON:(NSDictionary *)JSONDictionary
 - (NSDictionary *)JSONDictionary
 {
  NSMutableDictionary *JSONDictionary = [NSMutableDictionary dictionary];
- JSONDictionary[@"body"] = _body;
- JSONDictionary[@"msgtype"] = _msgtype;
+ JSONDictionary[kMXMessageBodyKey] = _body;
+ JSONDictionary[kMXMessageTypeKey] = _msgtype;
  JSONDictionary[@"methods"] = _methods;
  JSONDictionary[@"to"] = _to;
  JSONDictionary[@"from_device"] = _fromDevice;

MatrixSDK/Crypto/Verification/MXKeyVerificationManager.m

@@ -559,7 +559,7 @@ - (nullable NSString *)keyVerificationIdFromDMEvent:(MXEvent*)event
 
  // Original event or one of the thread?
  if (event.eventType == MXEventTypeRoomMessage
- && [event.content[@"msgtype"] isEqualToString:kMXMessageTypeKeyVerificationRequest])
+ && [event.content[kMXMessageTypeKey] isEqualToString:kMXMessageTypeKeyVerificationRequest])
  {
  keyVerificationId = event.eventId;
  }
@@ -1383,7 +1383,7 @@ - (void)setupVericationByDMRequests
 
  [_crypto.mxSession listenToEventsOfTypes:types onEvent:^(MXEvent *event, MXTimelineDirection direction, id customObject) {
  if (direction == MXTimelineDirectionForwards
- && [event.content[@"msgtype"] isEqualToString:kMXMessageTypeKeyVerificationRequest])
+ && [event.content[kMXMessageTypeKey] isEqualToString:kMXMessageTypeKeyVerificationRequest])
  {
  MXKeyVerificationByDMRequest *requestByDM = [[MXKeyVerificationByDMRequest alloc] initWithEvent:event andManager:self];
  if (requestByDM)
@@ -1635,7 +1635,7 @@ - (BOOL)isOtherQRCodeDataKeysValid:(MXQRCodeData*)otherQRCodeData otherUserId:(N
 - (nullable MXKeyVerificationByDMRequest*)verificationRequestInDMEvent:(MXEvent*)event
 {
  MXKeyVerificationByDMRequest *request;
- if ([event.content[@"msgtype"] isEqualToString:kMXMessageTypeKeyVerificationRequest])
+ if ([event.content[kMXMessageTypeKey] isEqualToString:kMXMessageTypeKeyVerificationRequest])
  {
  request = [[MXKeyVerificationByDMRequest alloc] initWithEvent:event andManager:self];
  }

MatrixSDK/Crypto/Verification/Status/MXKeyVerificationStatusResolver.m

@@ -156,7 +156,7 @@ - (nullable MXKeyVerification *)makeKeyVerificationFromOriginalDMEvent:(nullable
 - (nullable MXKeyVerificationByDMRequest*)verificationRequestInDMEvent:(MXEvent*)event events:(NSArray<MXEvent*> *)events
 {
  MXKeyVerificationByDMRequest *request;
- if (![event.content[@"msgtype"] isEqualToString:kMXMessageTypeKeyVerificationRequest])
+ if (![event.content[kMXMessageTypeKey] isEqualToString:kMXMessageTypeKeyVerificationRequest])
  {
  return nil;
  }