From 966b1ac84bc54c625cdea28f8cc21aa846527a04 Mon Sep 17 00:00:00 2001 From: Michael Kirk Date: Tue, 22 May 2018 12:14:38 -0400 Subject: [PATCH] Treat `id` as reserved word, use consistent setter style // FREEBIE --- .../protobuf/WebSocketResources.proto | 4 +- .../src/Network/WebSockets/TSSocketManager.m | 8 +- .../WebSockets/WebSocketResources.pb.h | 36 ++--- .../WebSockets/WebSocketResources.pb.m | 128 +++++++++--------- 4 files changed, 88 insertions(+), 88 deletions(-) diff --git a/SignalServiceKit/protobuf/WebSocketResources.proto b/SignalServiceKit/protobuf/WebSocketResources.proto index c56e65c5c..ad4c135b6 100644 --- a/SignalServiceKit/protobuf/WebSocketResources.proto +++ b/SignalServiceKit/protobuf/WebSocketResources.proto @@ -19,12 +19,12 @@ message WebSocketRequestMessage optional string path = 2; optional bytes body = 3; repeated string headers = 5; - optional uint64 id = 4; + optional uint64 requestId = 4; } message WebSocketResponseMessage { - optional uint64 id = 1; + optional uint64 requestId = 1; optional uint32 status = 2; optional string message = 3; repeated string headers = 5; diff --git a/SignalServiceKit/src/Network/WebSockets/TSSocketManager.m b/SignalServiceKit/src/Network/WebSockets/TSSocketManager.m index 85ea9245e..d900c3127 100644 --- a/SignalServiceKit/src/Network/WebSockets/TSSocketManager.m +++ b/SignalServiceKit/src/Network/WebSockets/TSSocketManager.m @@ -475,7 +475,7 @@ NSString *const kNSNotification_SocketManagerStateDidChange = @"kNSNotification_ WebSocketResourcesWebSocketRequestMessageBuilder *requestBuilder = [WebSocketResourcesWebSocketRequestMessageBuilder new]; - requestBuilder.id = socketMessage.requestId; + [requestBuilder setRequestId:socketMessage.requestId]; [requestBuilder setVerb:request.HTTPMethod]; [requestBuilder setPath:requestPath]; if (jsonData) { @@ -542,7 +542,7 @@ NSString *const kNSNotification_SocketManagerStateDidChange = @"kNSNotification_ DDLogInfo(@"%@ received WebSocket response.", self.logTag); - if (![message hasId]) { + if (![message hasRequestId]) { DDLogError(@"%@ received incomplete WebSocket response.", self.logTag); return; } @@ -551,7 +551,7 @@ NSString *const kNSNotification_SocketManagerStateDidChange = @"kNSNotification_ [self requestSocketAliveForAtLeastSeconds:kMakeRequestKeepSocketAliveDurationSeconds]; }); - UInt64 requestId = message.id; + UInt64 requestId = message.requestId; UInt32 responseStatus = 0; if (message.hasStatus) { responseStatus = message.status; @@ -752,7 +752,7 @@ NSString *const kNSNotification_SocketManagerStateDidChange = @"kNSNotification_ WebSocketResourcesWebSocketResponseMessageBuilder *response = [WebSocketResourcesWebSocketResponseMessage builder]; [response setStatus:200]; [response setMessage:@"OK"]; - [response setId:request.id]; + [response setRequestId:request.requestId]; WebSocketResourcesWebSocketMessageBuilder *message = [WebSocketResourcesWebSocketMessage builder]; [message setResponse:response.build]; diff --git a/SignalServiceKit/src/Network/WebSockets/WebSocketResources.pb.h b/SignalServiceKit/src/Network/WebSockets/WebSocketResources.pb.h index 7cfcb03e5..dec3ca504 100644 --- a/SignalServiceKit/src/Network/WebSockets/WebSocketResources.pb.h +++ b/SignalServiceKit/src/Network/WebSockets/WebSocketResources.pb.h @@ -76,14 +76,14 @@ NSString *NSStringFromWebSocketResourcesWebSocketMessageType(WebSocketResourcesW #define WebSocketRequestMessage_path @"path" #define WebSocketRequestMessage_body @"body" #define WebSocketRequestMessage_headers @"headers" -#define WebSocketRequestMessage_id @"id" +#define WebSocketRequestMessage_requestId @"requestId" @interface WebSocketResourcesWebSocketRequestMessage : PBGeneratedMessage { @private - BOOL hasId_:1; + BOOL hasRequestId_:1; BOOL hasVerb_:1; BOOL hasPath_:1; BOOL hasBody_:1; - UInt64 id; + UInt64 requestId; NSString* verb; NSString* path; NSData* body; @@ -92,12 +92,12 @@ NSString *NSStringFromWebSocketResourcesWebSocketMessageType(WebSocketResourcesW - (BOOL) hasVerb; - (BOOL) hasPath; - (BOOL) hasBody; -- (BOOL) hasId; +- (BOOL) hasRequestId; @property (readonly, strong) NSString* verb; @property (readonly, strong) NSString* path; @property (readonly, strong) NSData* body; @property (readonly, strong) NSArray * headers; -@property (readonly) UInt64 id; +@property (readonly) UInt64 requestId; - (NSString*)headersAtIndex:(NSUInteger)index; + (instancetype) defaultInstance; @@ -156,34 +156,34 @@ NSString *NSStringFromWebSocketResourcesWebSocketMessageType(WebSocketResourcesW - (WebSocketResourcesWebSocketRequestMessageBuilder *)setHeadersArray:(NSArray *)array; - (WebSocketResourcesWebSocketRequestMessageBuilder *)clearHeaders; -- (BOOL) hasId; -- (UInt64) id; -- (WebSocketResourcesWebSocketRequestMessageBuilder*) setId:(UInt64) value; -- (WebSocketResourcesWebSocketRequestMessageBuilder*) clearId; +- (BOOL) hasRequestId; +- (UInt64) requestId; +- (WebSocketResourcesWebSocketRequestMessageBuilder*) setRequestId:(UInt64) value; +- (WebSocketResourcesWebSocketRequestMessageBuilder*) clearRequestId; @end -#define WebSocketResponseMessage_id @"id" +#define WebSocketResponseMessage_requestId @"requestId" #define WebSocketResponseMessage_status @"status" #define WebSocketResponseMessage_message @"message" #define WebSocketResponseMessage_headers @"headers" #define WebSocketResponseMessage_body @"body" @interface WebSocketResourcesWebSocketResponseMessage : PBGeneratedMessage { @private - BOOL hasId_:1; + BOOL hasRequestId_:1; BOOL hasMessage_:1; BOOL hasBody_:1; BOOL hasStatus_:1; - UInt64 id; + UInt64 requestId; NSString* message; NSData* body; UInt32 status; NSMutableArray * headersArray; } -- (BOOL) hasId; +- (BOOL) hasRequestId; - (BOOL) hasStatus; - (BOOL) hasMessage; - (BOOL) hasBody; -@property (readonly) UInt64 id; +@property (readonly) UInt64 requestId; @property (readonly) UInt32 status; @property (readonly, strong) NSString* message; @property (readonly, strong) NSArray * headers; @@ -225,10 +225,10 @@ NSString *NSStringFromWebSocketResourcesWebSocketMessageType(WebSocketResourcesW - (WebSocketResourcesWebSocketResponseMessageBuilder*) mergeFromCodedInputStream:(PBCodedInputStream*) input; - (WebSocketResourcesWebSocketResponseMessageBuilder*) mergeFromCodedInputStream:(PBCodedInputStream*) input extensionRegistry:(PBExtensionRegistry*) extensionRegistry; -- (BOOL) hasId; -- (UInt64) id; -- (WebSocketResourcesWebSocketResponseMessageBuilder*) setId:(UInt64) value; -- (WebSocketResourcesWebSocketResponseMessageBuilder*) clearId; +- (BOOL) hasRequestId; +- (UInt64) requestId; +- (WebSocketResourcesWebSocketResponseMessageBuilder*) setRequestId:(UInt64) value; +- (WebSocketResourcesWebSocketResponseMessageBuilder*) clearRequestId; - (BOOL) hasStatus; - (UInt32) status; diff --git a/SignalServiceKit/src/Network/WebSockets/WebSocketResources.pb.m b/SignalServiceKit/src/Network/WebSockets/WebSocketResources.pb.m index 3e5f0f30d..1ac8b524c 100644 --- a/SignalServiceKit/src/Network/WebSockets/WebSocketResources.pb.m +++ b/SignalServiceKit/src/Network/WebSockets/WebSocketResources.pb.m @@ -26,7 +26,7 @@ static PBExtensionRegistry* extensionRegistry = nil; @property (strong) NSString* path; @property (strong) NSData* body; @property (strong) NSMutableArray * headersArray; -@property UInt64 id; +@property UInt64 requestId; @end @implementation WebSocketResourcesWebSocketRequestMessage @@ -54,19 +54,19 @@ static PBExtensionRegistry* extensionRegistry = nil; @synthesize body; @synthesize headersArray; @dynamic headers; -- (BOOL) hasId { - return !!hasId_; +- (BOOL) hasRequestId { + return !!hasRequestId_; } -- (void) setHasId:(BOOL) _value_ { - hasId_ = !!_value_; +- (void) setHasRequestId:(BOOL) _value_ { + hasRequestId_ = !!_value_; } -@synthesize id; +@synthesize requestId; - (instancetype) init { if ((self = [super init])) { self.verb = @""; self.path = @""; self.body = [NSData data]; - self.id = 0L; + self.requestId = 0L; } return self; } @@ -101,8 +101,8 @@ static WebSocketResourcesWebSocketRequestMessage* defaultWebSocketResourcesWebSo if (self.hasBody) { [output writeData:3 value:self.body]; } - if (self.hasId) { - [output writeUInt64:4 value:self.id]; + if (self.hasRequestId) { + [output writeUInt64:4 value:self.requestId]; } [self.headersArray enumerateObjectsUsingBlock:^(NSString *element, NSUInteger idx, BOOL *stop) { [output writeString:5 value:element]; @@ -125,8 +125,8 @@ static WebSocketResourcesWebSocketRequestMessage* defaultWebSocketResourcesWebSo if (self.hasBody) { size_ += computeDataSize(3, self.body); } - if (self.hasId) { - size_ += computeUInt64Size(4, self.id); + if (self.hasRequestId) { + size_ += computeUInt64Size(4, self.requestId); } { __block SInt32 dataSize = 0; @@ -181,8 +181,8 @@ static WebSocketResourcesWebSocketRequestMessage* defaultWebSocketResourcesWebSo if (self.hasBody) { [output appendFormat:@"%@%@: %@\n", indent, @"body", self.body]; } - if (self.hasId) { - [output appendFormat:@"%@%@: %@\n", indent, @"id", [NSNumber numberWithLongLong:self.id]]; + if (self.hasRequestId) { + [output appendFormat:@"%@%@: %@\n", indent, @"requestId", [NSNumber numberWithLongLong:self.requestId]]; } [self.headersArray enumerateObjectsUsingBlock:^(id obj, NSUInteger idx, BOOL *stop) { [output appendFormat:@"%@%@: %@\n", indent, @"headers", obj]; @@ -199,8 +199,8 @@ static WebSocketResourcesWebSocketRequestMessage* defaultWebSocketResourcesWebSo if (self.hasBody) { [dictionary setObject: self.body forKey: @"body"]; } - if (self.hasId) { - [dictionary setObject: [NSNumber numberWithLongLong:self.id] forKey: @"id"]; + if (self.hasRequestId) { + [dictionary setObject: [NSNumber numberWithLongLong:self.requestId] forKey: @"requestId"]; } [dictionary setObject:self.headers forKey: @"headers"]; [self.unknownFields storeInDictionary:dictionary]; @@ -220,8 +220,8 @@ static WebSocketResourcesWebSocketRequestMessage* defaultWebSocketResourcesWebSo (!self.hasPath || [self.path isEqual:otherMessage.path]) && self.hasBody == otherMessage.hasBody && (!self.hasBody || [self.body isEqual:otherMessage.body]) && - self.hasId == otherMessage.hasId && - (!self.hasId || self.id == otherMessage.id) && + self.hasRequestId == otherMessage.hasRequestId && + (!self.hasRequestId || self.requestId == otherMessage.requestId) && [self.headersArray isEqualToArray:otherMessage.headersArray] && (self.unknownFields == otherMessage.unknownFields || (self.unknownFields != nil && [self.unknownFields isEqual:otherMessage.unknownFields])); } @@ -236,8 +236,8 @@ static WebSocketResourcesWebSocketRequestMessage* defaultWebSocketResourcesWebSo if (self.hasBody) { hashCode = hashCode * 31 + [self.body hash]; } - if (self.hasId) { - hashCode = hashCode * 31 + [[NSNumber numberWithLongLong:self.id] hash]; + if (self.hasRequestId) { + hashCode = hashCode * 31 + [[NSNumber numberWithLongLong:self.requestId] hash]; } [self.headersArray enumerateObjectsUsingBlock:^(NSString *element, NSUInteger idx, BOOL *stop) { hashCode = hashCode * 31 + [element hash]; @@ -301,8 +301,8 @@ static WebSocketResourcesWebSocketRequestMessage* defaultWebSocketResourcesWebSo [resultWebSocketRequestMessage.headersArray addObjectsFromArray:other.headersArray]; } } - if (other.hasId) { - [self setId:other.id]; + if (other.hasRequestId) { + [self setRequestId:other.requestId]; } [self mergeUnknownFields:other.unknownFields]; return self; @@ -338,7 +338,7 @@ static WebSocketResourcesWebSocketRequestMessage* defaultWebSocketResourcesWebSo break; } case 32: { - [self setId:[input readUInt64]]; + [self setRequestId:[input readUInt64]]; break; } case 42: { @@ -417,26 +417,26 @@ static WebSocketResourcesWebSocketRequestMessage* defaultWebSocketResourcesWebSo resultWebSocketRequestMessage.headersArray = nil; return self; } -- (BOOL) hasId { - return resultWebSocketRequestMessage.hasId; +- (BOOL) hasRequestId { + return resultWebSocketRequestMessage.hasRequestId; } -- (UInt64) id { - return resultWebSocketRequestMessage.id; +- (UInt64) requestId { + return resultWebSocketRequestMessage.requestId; } -- (WebSocketResourcesWebSocketRequestMessageBuilder*) setId:(UInt64) value { - resultWebSocketRequestMessage.hasId = YES; - resultWebSocketRequestMessage.id = value; +- (WebSocketResourcesWebSocketRequestMessageBuilder*) setRequestId:(UInt64) value { + resultWebSocketRequestMessage.hasRequestId = YES; + resultWebSocketRequestMessage.requestId = value; return self; } -- (WebSocketResourcesWebSocketRequestMessageBuilder*) clearId { - resultWebSocketRequestMessage.hasId = NO; - resultWebSocketRequestMessage.id = 0L; +- (WebSocketResourcesWebSocketRequestMessageBuilder*) clearRequestId { + resultWebSocketRequestMessage.hasRequestId = NO; + resultWebSocketRequestMessage.requestId = 0L; return self; } @end @interface WebSocketResourcesWebSocketResponseMessage () -@property UInt64 id; +@property UInt64 requestId; @property UInt32 status; @property (strong) NSString* message; @property (strong) NSMutableArray * headersArray; @@ -445,13 +445,13 @@ static WebSocketResourcesWebSocketRequestMessage* defaultWebSocketResourcesWebSo @implementation WebSocketResourcesWebSocketResponseMessage -- (BOOL) hasId { - return !!hasId_; +- (BOOL) hasRequestId { + return !!hasRequestId_; } -- (void) setHasId:(BOOL) _value_ { - hasId_ = !!_value_; +- (void) setHasRequestId:(BOOL) _value_ { + hasRequestId_ = !!_value_; } -@synthesize id; +@synthesize requestId; - (BOOL) hasStatus { return !!hasStatus_; } @@ -477,7 +477,7 @@ static WebSocketResourcesWebSocketRequestMessage* defaultWebSocketResourcesWebSo @synthesize body; - (instancetype) init { if ((self = [super init])) { - self.id = 0L; + self.requestId = 0L; self.status = 0; self.message = @""; self.body = [NSData data]; @@ -506,8 +506,8 @@ static WebSocketResourcesWebSocketResponseMessage* defaultWebSocketResourcesWebS return YES; } - (void) writeToCodedOutputStream:(PBCodedOutputStream*) output { - if (self.hasId) { - [output writeUInt64:1 value:self.id]; + if (self.hasRequestId) { + [output writeUInt64:1 value:self.requestId]; } if (self.hasStatus) { [output writeUInt32:2 value:self.status]; @@ -530,8 +530,8 @@ static WebSocketResourcesWebSocketResponseMessage* defaultWebSocketResourcesWebS } size_ = 0; - if (self.hasId) { - size_ += computeUInt64Size(1, self.id); + if (self.hasRequestId) { + size_ += computeUInt64Size(1, self.requestId); } if (self.hasStatus) { size_ += computeUInt32Size(2, self.status); @@ -586,8 +586,8 @@ static WebSocketResourcesWebSocketResponseMessage* defaultWebSocketResourcesWebS return [WebSocketResourcesWebSocketResponseMessage builderWithPrototype:self]; } - (void) writeDescriptionTo:(NSMutableString*) output withIndent:(NSString*) indent { - if (self.hasId) { - [output appendFormat:@"%@%@: %@\n", indent, @"id", [NSNumber numberWithLongLong:self.id]]; + if (self.hasRequestId) { + [output appendFormat:@"%@%@: %@\n", indent, @"requestId", [NSNumber numberWithLongLong:self.requestId]]; } if (self.hasStatus) { [output appendFormat:@"%@%@: %@\n", indent, @"status", [NSNumber numberWithInteger:self.status]]; @@ -604,8 +604,8 @@ static WebSocketResourcesWebSocketResponseMessage* defaultWebSocketResourcesWebS [self.unknownFields writeDescriptionTo:output withIndent:indent]; } - (void) storeInDictionary:(NSMutableDictionary *)dictionary { - if (self.hasId) { - [dictionary setObject: [NSNumber numberWithLongLong:self.id] forKey: @"id"]; + if (self.hasRequestId) { + [dictionary setObject: [NSNumber numberWithLongLong:self.requestId] forKey: @"requestId"]; } if (self.hasStatus) { [dictionary setObject: [NSNumber numberWithInteger:self.status] forKey: @"status"]; @@ -628,8 +628,8 @@ static WebSocketResourcesWebSocketResponseMessage* defaultWebSocketResourcesWebS } WebSocketResourcesWebSocketResponseMessage *otherMessage = other; return - self.hasId == otherMessage.hasId && - (!self.hasId || self.id == otherMessage.id) && + self.hasRequestId == otherMessage.hasRequestId && + (!self.hasRequestId || self.requestId == otherMessage.requestId) && self.hasStatus == otherMessage.hasStatus && (!self.hasStatus || self.status == otherMessage.status) && self.hasMessage == otherMessage.hasMessage && @@ -641,8 +641,8 @@ static WebSocketResourcesWebSocketResponseMessage* defaultWebSocketResourcesWebS } - (NSUInteger) hash { __block NSUInteger hashCode = 7; - if (self.hasId) { - hashCode = hashCode * 31 + [[NSNumber numberWithLongLong:self.id] hash]; + if (self.hasRequestId) { + hashCode = hashCode * 31 + [[NSNumber numberWithLongLong:self.requestId] hash]; } if (self.hasStatus) { hashCode = hashCode * 31 + [[NSNumber numberWithInteger:self.status] hash]; @@ -699,8 +699,8 @@ static WebSocketResourcesWebSocketResponseMessage* defaultWebSocketResourcesWebS if (other == [WebSocketResourcesWebSocketResponseMessage defaultInstance]) { return self; } - if (other.hasId) { - [self setId:other.id]; + if (other.hasRequestId) { + [self setRequestId:other.requestId]; } if (other.hasStatus) { [self setStatus:other.status]; @@ -740,7 +740,7 @@ static WebSocketResourcesWebSocketResponseMessage* defaultWebSocketResourcesWebS break; } case 8: { - [self setId:[input readUInt64]]; + [self setRequestId:[input readUInt64]]; break; } case 16: { @@ -762,20 +762,20 @@ static WebSocketResourcesWebSocketResponseMessage* defaultWebSocketResourcesWebS } } } -- (BOOL) hasId { - return resultWebSocketResponseMessage.hasId; +- (BOOL) hasRequestId { + return resultWebSocketResponseMessage.hasRequestId; } -- (UInt64) id { - return resultWebSocketResponseMessage.id; +- (UInt64) requestId { + return resultWebSocketResponseMessage.requestId; } -- (WebSocketResourcesWebSocketResponseMessageBuilder*) setId:(UInt64) value { - resultWebSocketResponseMessage.hasId = YES; - resultWebSocketResponseMessage.id = value; +- (WebSocketResourcesWebSocketResponseMessageBuilder*) setRequestId:(UInt64) value { + resultWebSocketResponseMessage.hasRequestId = YES; + resultWebSocketResponseMessage.requestId = value; return self; } -- (WebSocketResourcesWebSocketResponseMessageBuilder*) clearId { - resultWebSocketResponseMessage.hasId = NO; - resultWebSocketResponseMessage.id = 0L; +- (WebSocketResourcesWebSocketResponseMessageBuilder*) clearRequestId { + resultWebSocketResponseMessage.hasRequestId = NO; + resultWebSocketResponseMessage.requestId = 0L; return self; } - (BOOL) hasStatus {