FLEXNetworkLib to SKFLEXNetworkLib

Summary:
rename FLEXNetworkLib to SKFLEXNetworkLib so it doesnt clash with Stock FLEX if embedded in the app too

also 'fix' 3 warnings by adding explicit casts

Reviewed By: lblasa

Differential Revision: D35200011

fbshipit-source-id: 82bdecc5076b86958ea0cb80260584c012940045
This commit is contained in:
Dominik Pich
2022-03-31 12:35:22 -07:00
committed by Facebook GitHub Bot
parent fd23a9d626
commit 8cbb5c4d46
9 changed files with 331 additions and 325 deletions

View File

@@ -38,13 +38,13 @@
#import <Foundation/Foundation.h> #import <Foundation/Foundation.h>
FOUNDATION_EXTERN NSString* const FOUNDATION_EXTERN NSString* const
kFLEXNetworkObserverEnabledStateChangedNotification; kSKFLEXNetworkObserverEnabledStateChangedNotification;
/// This class swizzles NSURLConnection and NSURLSession delegate methods to /// This class swizzles NSURLConnection and NSURLSession delegate methods to
/// observe events in the URL loading system. High level network events are sent /// observe events in the URL loading system. High level network events are sent
/// to the default FLEXNetworkRecorder instance which maintains the request /// to the default SKFLEXNetworkRecorder instance which maintains the request
/// history and caches response bodies. /// history and caches response bodies.
@interface FLEXNetworkObserver : NSObject @interface SKFLEXNetworkObserver : NSObject
+ (void)start; + (void)start;

View File

@@ -49,14 +49,14 @@
#import <FlipperKitNetworkPlugin/SKNetworkReporter.h> #import <FlipperKitNetworkPlugin/SKNetworkReporter.h>
// Notifications posted when the record is updated // Notifications posted when the record is updated
extern NSString* const kFLEXNetworkRecorderNewTransactionNotification; extern NSString* const kSKFLEXNetworkRecorderNewTransactionNotification;
extern NSString* const kFLEXNetworkRecorderTransactionUpdatedNotification; extern NSString* const kSKFLEXNetworkRecorderTransactionUpdatedNotification;
extern NSString* const kFLEXNetworkRecorderUserInfoTransactionKey; extern NSString* const kSKFLEXNetworkRecorderUserInfoTransactionKey;
extern NSString* const kFLEXNetworkRecorderTransactionsClearedNotification; extern NSString* const kSKFLEXNetworkRecorderTransactionsClearedNotification;
@class FLEXNetworkTransaction; @class SKFLEXNetworkTransaction;
@interface FLEXNetworkRecorder : NSObject @interface SKFLEXNetworkRecorder : NSObject
/// In general, it only makes sense to have one recorder for the entire /// In general, it only makes sense to have one recorder for the entire
/// application. /// application.
@@ -76,13 +76,13 @@ extern NSString* const kFLEXNetworkRecorderTransactionsClearedNotification;
// Accessing recorded network activity // Accessing recorded network activity
/// Array of FLEXNetworkTransaction objects ordered by start time with the /// Array of SKFLEXNetworkTransaction objects ordered by start time with the
/// newest first. /// newest first.
- (NSArray<FLEXNetworkTransaction*>*)networkTransactions; - (NSArray<SKFLEXNetworkTransaction*>*)networkTransactions;
/// The full response data IFF it hasn't been purged due to memory pressure. /// The full response data IFF it hasn't been purged due to memory pressure.
- (NSData*)cachedResponseBodyForTransaction: - (NSData*)cachedResponseBodyForTransaction:
(FLEXNetworkTransaction*)transaction; (SKFLEXNetworkTransaction*)transaction;
/// Dumps all network transactions and cached response bodies. /// Dumps all network transactions and cached response bodies.
- (void)clearRecordedActivity; - (void)clearRecordedActivity;

View File

@@ -44,43 +44,43 @@
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE. // POSSIBILITY OF SUCH DAMAGE.
#import "FLEXNetworkRecorder.h" #import "SKFLEXNetworkRecorder.h"
#import "FLEXNetworkTransaction.h" #import "SKFLEXNetworkTransaction.h"
#import "FLEXUtility.h" #import "SKFLEXUtility.h"
NSString* const kFLEXNetworkRecorderNewTransactionNotification = NSString* const kSKFLEXNetworkRecorderNewTransactionNotification =
@"kFLEXNetworkRecorderNewTransactionNotification"; @"kSKFLEXNetworkRecorderNewTransactionNotification";
NSString* const kFLEXNetworkRecorderTransactionUpdatedNotification = NSString* const kSKFLEXNetworkRecorderTransactionUpdatedNotification =
@"kFLEXNetworkRecorderTransactionUpdatedNotification"; @"kSKFLEXNetworkRecorderTransactionUpdatedNotification";
NSString* const kFLEXNetworkRecorderUserInfoTransactionKey = @"transaction"; NSString* const kSKFLEXNetworkRecorderUserInfoTransactionKey = @"transaction";
NSString* const kFLEXNetworkRecorderTransactionsClearedNotification = NSString* const kSKFLEXNetworkRecorderTransactionsClearedNotification =
@"kFLEXNetworkRecorderTransactionsClearedNotification"; @"kSKFLEXNetworkRecorderTransactionsClearedNotification";
NSString* const kFLEXNetworkRecorderResponseCacheLimitDefaultsKey = NSString* const kSKFLEXNetworkRecorderResponseCacheLimitDefaultsKey =
@"com.flex.responseCacheLimit"; @"com.skflex.responseCacheLimit";
@interface FLEXNetworkRecorder () @interface SKFLEXNetworkRecorder ()
@property(nonatomic, strong) NSCache* responseCache; @property(nonatomic, strong) NSCache* responseCache;
@property(nonatomic, strong) @property(nonatomic, strong)
NSMutableArray<FLEXNetworkTransaction*>* orderedTransactions; NSMutableArray<SKFLEXNetworkTransaction*>* orderedTransactions;
@property(nonatomic, strong) @property(nonatomic, strong)
NSMutableDictionary<NSString*, FLEXNetworkTransaction*>* NSMutableDictionary<NSString*, SKFLEXNetworkTransaction*>*
networkTransactionsForRequestIdentifiers; networkTransactionsForRequestIdentifiers;
@property(nonatomic, strong) dispatch_queue_t queue; @property(nonatomic, strong) dispatch_queue_t queue;
@property(nonatomic, strong) @property(nonatomic, strong)
NSMutableDictionary<NSString*, NSNumber*>* identifierDict; NSMutableDictionary<NSString*, NSNumber*>* identifierDict;
@end @end
@implementation FLEXNetworkRecorder @implementation SKFLEXNetworkRecorder
- (instancetype)init { - (instancetype)init {
self = [super init]; self = [super init];
if (self) { if (self) {
_responseCache = [NSCache new]; _responseCache = [NSCache new];
NSUInteger responseCacheLimit = [[[NSUserDefaults standardUserDefaults] NSUInteger responseCacheLimit = [[[NSUserDefaults standardUserDefaults]
objectForKey:kFLEXNetworkRecorderResponseCacheLimitDefaultsKey] objectForKey:kSKFLEXNetworkRecorderResponseCacheLimitDefaultsKey]
unsignedIntegerValue]; unsignedIntegerValue];
if (responseCacheLimit) { if (responseCacheLimit) {
[_responseCache setTotalCostLimit:responseCacheLimit]; [_responseCache setTotalCostLimit:responseCacheLimit];
@@ -95,14 +95,14 @@ NSString* const kFLEXNetworkRecorderResponseCacheLimitDefaultsKey =
// Serial queue used because we use mutable objects that are not thread safe // Serial queue used because we use mutable objects that are not thread safe
_queue = dispatch_queue_create( _queue = dispatch_queue_create(
"com.flex.FLEXNetworkRecorder", DISPATCH_QUEUE_SERIAL); "com.skflex.SKFLEXNetworkRecorder", DISPATCH_QUEUE_SERIAL);
_identifierDict = [NSMutableDictionary dictionary]; _identifierDict = [NSMutableDictionary dictionary];
} }
return self; return self;
} }
+ (instancetype)defaultRecorder { + (instancetype)defaultRecorder {
static FLEXNetworkRecorder* defaultRecorder = nil; static SKFLEXNetworkRecorder* defaultRecorder = nil;
static dispatch_once_t onceToken; static dispatch_once_t onceToken;
dispatch_once(&onceToken, ^{ dispatch_once(&onceToken, ^{
defaultRecorder = [[[self class] alloc] init]; defaultRecorder = [[[self class] alloc] init];
@@ -124,11 +124,11 @@ NSString* const kFLEXNetworkRecorderResponseCacheLimitDefaultsKey =
[self.responseCache setTotalCostLimit:responseCacheByteLimit]; [self.responseCache setTotalCostLimit:responseCacheByteLimit];
[[NSUserDefaults standardUserDefaults] [[NSUserDefaults standardUserDefaults]
setObject:@(responseCacheByteLimit) setObject:@(responseCacheByteLimit)
forKey:kFLEXNetworkRecorderResponseCacheLimitDefaultsKey]; forKey:kSKFLEXNetworkRecorderResponseCacheLimitDefaultsKey];
} }
- (NSArray<FLEXNetworkTransaction*>*)networkTransactions { - (NSArray<SKFLEXNetworkTransaction*>*)networkTransactions {
__block NSArray<FLEXNetworkTransaction*>* transactions = nil; __block NSArray<SKFLEXNetworkTransaction*>* transactions = nil;
dispatch_sync(self.queue, ^{ dispatch_sync(self.queue, ^{
transactions = [self.orderedTransactions copy]; transactions = [self.orderedTransactions copy];
}); });
@@ -136,7 +136,7 @@ NSString* const kFLEXNetworkRecorderResponseCacheLimitDefaultsKey =
} }
- (NSData*)cachedResponseBodyForTransaction: - (NSData*)cachedResponseBodyForTransaction:
(FLEXNetworkTransaction*)transaction { (SKFLEXNetworkTransaction*)transaction {
return [self.responseCache objectForKey:transaction.requestID]; return [self.responseCache objectForKey:transaction.requestID];
} }
@@ -167,12 +167,12 @@ NSString* const kFLEXNetworkRecorderResponseCacheLimitDefaultsKey =
SKRequestInfo* info = [[SKRequestInfo alloc] SKRequestInfo* info = [[SKRequestInfo alloc]
initWithIdentifier:self.identifierDict[requestID].longLongValue initWithIdentifier:self.identifierDict[requestID].longLongValue
timestamp:[NSDate timestamp] timestamp:(uint64_t)[NSDate timestamp]
request:request request:request
data:request.HTTPBody]; data:request.HTTPBody];
[self.delegate didObserveRequest:info]; [self.delegate didObserveRequest:info];
FLEXNetworkTransaction* transaction = [FLEXNetworkTransaction new]; SKFLEXNetworkTransaction* transaction = [SKFLEXNetworkTransaction new];
transaction.requestID = requestID; transaction.requestID = requestID;
transaction.request = request; transaction.request = request;
transaction.startTime = requestDate; transaction.startTime = requestDate;
@@ -180,7 +180,8 @@ NSString* const kFLEXNetworkRecorderResponseCacheLimitDefaultsKey =
[self.orderedTransactions insertObject:transaction atIndex:0]; [self.orderedTransactions insertObject:transaction atIndex:0];
[self.networkTransactionsForRequestIdentifiers setObject:transaction [self.networkTransactionsForRequestIdentifiers setObject:transaction
forKey:requestID]; forKey:requestID];
transaction.transactionState = FLEXNetworkTransactionStateAwaitingResponse; transaction.transactionState =
SKFLEXNetworkTransactionStateAwaitingResponse;
}); });
} }
@@ -190,13 +191,13 @@ NSString* const kFLEXNetworkRecorderResponseCacheLimitDefaultsKey =
NSDate* responseDate = [NSDate date]; NSDate* responseDate = [NSDate date];
dispatch_async(self.queue, ^{ dispatch_async(self.queue, ^{
FLEXNetworkTransaction* transaction = SKFLEXNetworkTransaction* transaction =
self.networkTransactionsForRequestIdentifiers[requestID]; self.networkTransactionsForRequestIdentifiers[requestID];
if (!transaction) { if (!transaction) {
return; return;
} }
transaction.response = response; transaction.response = response;
transaction.transactionState = FLEXNetworkTransactionStateReceivingData; transaction.transactionState = SKFLEXNetworkTransactionStateReceivingData;
transaction.latency = transaction.latency =
-[transaction.startTime timeIntervalSinceDate:responseDate]; -[transaction.startTime timeIntervalSinceDate:responseDate];
}); });
@@ -206,7 +207,7 @@ NSString* const kFLEXNetworkRecorderResponseCacheLimitDefaultsKey =
- (void)recordDataReceivedWithRequestID:(NSString*)requestID - (void)recordDataReceivedWithRequestID:(NSString*)requestID
dataLength:(int64_t)dataLength { dataLength:(int64_t)dataLength {
dispatch_async(self.queue, ^{ dispatch_async(self.queue, ^{
FLEXNetworkTransaction* transaction = SKFLEXNetworkTransaction* transaction =
self.networkTransactionsForRequestIdentifiers[requestID]; self.networkTransactionsForRequestIdentifiers[requestID];
if (!transaction) { if (!transaction) {
return; return;
@@ -220,17 +221,17 @@ NSString* const kFLEXNetworkRecorderResponseCacheLimitDefaultsKey =
responseBody:(NSData*)responseBody { responseBody:(NSData*)responseBody {
NSDate* finishedDate = [NSDate date]; NSDate* finishedDate = [NSDate date];
dispatch_async(self.queue, ^{ dispatch_async(self.queue, ^{
FLEXNetworkTransaction* transaction = SKFLEXNetworkTransaction* transaction =
self.networkTransactionsForRequestIdentifiers[requestID]; self.networkTransactionsForRequestIdentifiers[requestID];
if (!transaction) { if (!transaction) {
return; return;
} }
transaction.transactionState = FLEXNetworkTransactionStateFinished; transaction.transactionState = SKFLEXNetworkTransactionStateFinished;
transaction.duration = transaction.duration =
-[transaction.startTime timeIntervalSinceDate:finishedDate]; -[transaction.startTime timeIntervalSinceDate:finishedDate];
SKResponseInfo* responseInfo = [[SKResponseInfo alloc] SKResponseInfo* responseInfo = [[SKResponseInfo alloc]
initWithIndentifier:self.identifierDict[requestID].longLongValue initWithIndentifier:self.identifierDict[requestID].longLongValue
timestamp:[NSDate timestamp] timestamp:(uint64_t)[NSDate timestamp]
response:transaction.response response:transaction.response
data:responseBody]; data:responseBody];
self.identifierDict[requestID] = nil; // Clear the entry self.identifierDict[requestID] = nil; // Clear the entry
@@ -257,7 +258,7 @@ NSString* const kFLEXNetworkRecorderResponseCacheLimitDefaultsKey =
- (void)recordLoadingFailedWithRequestID:(NSString*)requestID - (void)recordLoadingFailedWithRequestID:(NSString*)requestID
error:(NSError*)error { error:(NSError*)error {
dispatch_async(self.queue, ^{ dispatch_async(self.queue, ^{
FLEXNetworkTransaction* transaction = SKFLEXNetworkTransaction* transaction =
self.networkTransactionsForRequestIdentifiers[requestID]; self.networkTransactionsForRequestIdentifiers[requestID];
if (!transaction) { if (!transaction) {
return; return;
@@ -265,12 +266,12 @@ NSString* const kFLEXNetworkRecorderResponseCacheLimitDefaultsKey =
SKResponseInfo* responseInfo = [[SKResponseInfo alloc] SKResponseInfo* responseInfo = [[SKResponseInfo alloc]
initWithIndentifier:self.identifierDict[requestID].longLongValue initWithIndentifier:self.identifierDict[requestID].longLongValue
timestamp:[NSDate timestamp] timestamp:(uint64_t)[NSDate timestamp]
response:transaction.response response:transaction.response
data:nil]; data:nil];
self.identifierDict[requestID] = nil; // Clear the entry self.identifierDict[requestID] = nil; // Clear the entry
[self.delegate didObserveResponse:responseInfo]; [self.delegate didObserveResponse:responseInfo];
transaction.transactionState = FLEXNetworkTransactionStateFailed; transaction.transactionState = SKFLEXNetworkTransactionStateFailed;
transaction.duration = -[transaction.startTime timeIntervalSinceNow]; transaction.duration = -[transaction.startTime timeIntervalSinceNow];
transaction.error = error; transaction.error = error;
}); });
@@ -278,7 +279,7 @@ NSString* const kFLEXNetworkRecorderResponseCacheLimitDefaultsKey =
- (void)recordMechanism:(NSString*)mechanism forRequestID:(NSString*)requestID { - (void)recordMechanism:(NSString*)mechanism forRequestID:(NSString*)requestID {
dispatch_async(self.queue, ^{ dispatch_async(self.queue, ^{
FLEXNetworkTransaction* transaction = SKFLEXNetworkTransaction* transaction =
self.networkTransactionsForRequestIdentifiers[requestID]; self.networkTransactionsForRequestIdentifiers[requestID];
if (!transaction) { if (!transaction) {
return; return;

View File

@@ -46,22 +46,22 @@
#import <Foundation/Foundation.h> #import <Foundation/Foundation.h>
typedef NS_ENUM(NSInteger, FLEXNetworkTransactionState) { typedef NS_ENUM(NSInteger, SKFLEXNetworkTransactionState) {
FLEXNetworkTransactionStateUnstarted, SKFLEXNetworkTransactionStateUnstarted,
FLEXNetworkTransactionStateAwaitingResponse, SKFLEXNetworkTransactionStateAwaitingResponse,
FLEXNetworkTransactionStateReceivingData, SKFLEXNetworkTransactionStateReceivingData,
FLEXNetworkTransactionStateFinished, SKFLEXNetworkTransactionStateFinished,
FLEXNetworkTransactionStateFailed SKFLEXNetworkTransactionStateFailed
}; };
@interface FLEXNetworkTransaction : NSObject @interface SKFLEXNetworkTransaction : NSObject
@property(nonatomic, copy) NSString* requestID; @property(nonatomic, copy) NSString* requestID;
@property(nonatomic, strong) NSURLRequest* request; @property(nonatomic, strong) NSURLRequest* request;
@property(nonatomic, strong) NSURLResponse* response; @property(nonatomic, strong) NSURLResponse* response;
@property(nonatomic, copy) NSString* requestMechanism; @property(nonatomic, copy) NSString* requestMechanism;
@property(nonatomic, assign) FLEXNetworkTransactionState transactionState; @property(nonatomic, assign) SKFLEXNetworkTransactionState transactionState;
@property(nonatomic, strong) NSError* error; @property(nonatomic, strong) NSError* error;
@property(nonatomic, strong) NSDate* startTime; @property(nonatomic, strong) NSDate* startTime;
@@ -74,6 +74,6 @@ typedef NS_ENUM(NSInteger, FLEXNetworkTransactionState) {
@property(nonatomic, strong, readonly) NSData* cachedRequestBody; @property(nonatomic, strong, readonly) NSData* cachedRequestBody;
+ (NSString*)readableStringFromTransactionState: + (NSString*)readableStringFromTransactionState:
(FLEXNetworkTransactionState)state; (SKFLEXNetworkTransactionState)state;
@end @end

View File

@@ -44,15 +44,15 @@
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE. // POSSIBILITY OF SUCH DAMAGE.
#import "FLEXNetworkTransaction.h" #import "SKFLEXNetworkTransaction.h"
@interface FLEXNetworkTransaction () @interface SKFLEXNetworkTransaction ()
@property(nonatomic, strong, readwrite) NSData* cachedRequestBody; @property(nonatomic, strong, readwrite) NSData* cachedRequestBody;
@end @end
@implementation FLEXNetworkTransaction @implementation SKFLEXNetworkTransaction
- (NSString*)description { - (NSString*)description {
NSString* description = [super description]; NSString* description = [super description];
@@ -94,26 +94,26 @@
} }
+ (NSString*)readableStringFromTransactionState: + (NSString*)readableStringFromTransactionState:
(FLEXNetworkTransactionState)state { (SKFLEXNetworkTransactionState)state {
NSString* readableString = nil; NSString* readableString = nil;
switch (state) { switch (state) {
case FLEXNetworkTransactionStateUnstarted: case SKFLEXNetworkTransactionStateUnstarted:
readableString = @"Unstarted"; readableString = @"Unstarted";
break; break;
case FLEXNetworkTransactionStateAwaitingResponse: case SKFLEXNetworkTransactionStateAwaitingResponse:
readableString = @"Awaiting Response"; readableString = @"Awaiting Response";
break; break;
case FLEXNetworkTransactionStateReceivingData: case SKFLEXNetworkTransactionStateReceivingData:
readableString = @"Receiving Data"; readableString = @"Receiving Data";
break; break;
case FLEXNetworkTransactionStateFinished: case SKFLEXNetworkTransactionStateFinished:
readableString = @"Finished"; readableString = @"Finished";
break; break;
case FLEXNetworkTransactionStateFailed: case SKFLEXNetworkTransactionStateFailed:
readableString = @"Failed"; readableString = @"Failed";
break; break;
} }

View File

@@ -62,7 +62,7 @@
@end @end
@interface FLEXUtility : NSObject @interface SKFLEXUtility : NSObject
// Swizzling utilities // Swizzling utilities

View File

@@ -44,7 +44,7 @@
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE. // POSSIBILITY OF SUCH DAMAGE.
#import "FLEXUtility.h" #import "SKFLEXUtility.h"
#include <assert.h> #include <assert.h>
#include <mach/mach.h> #include <mach/mach.h>
@@ -54,11 +54,11 @@
#import <ImageIO/ImageIO.h> #import <ImageIO/ImageIO.h>
@implementation FLEXUtility @implementation SKFLEXUtility
+ (SEL)swizzledSelectorForSelector:(SEL)selector { + (SEL)swizzledSelectorForSelector:(SEL)selector {
return NSSelectorFromString( return NSSelectorFromString(
[NSString stringWithFormat:@"_flex_swizzle_%x_%@", [NSString stringWithFormat:@"_skflex_swizzle_%x_%@",
arc4random(), arc4random(),
NSStringFromSelector(selector)]); NSStringFromSelector(selector)]);
} }

View File

@@ -8,8 +8,8 @@
#if FB_SONARKIT_ENABLED #if FB_SONARKIT_ENABLED
#import "SKIOSNetworkAdapter.h" #import "SKIOSNetworkAdapter.h"
#import "FLEXNetworkLib/FLEXNetworkObserver.h" #import "SKFLEXNetworkLib/SKFLEXNetworkObserver.h"
#import "FLEXNetworkLib/FLEXNetworkRecorder.h" #import "SKFLEXNetworkLib/SKFLEXNetworkRecorder.h"
@implementation SKIOSNetworkAdapter @implementation SKIOSNetworkAdapter
@synthesize delegate = _delegate; @synthesize delegate = _delegate;
@@ -22,8 +22,8 @@
- (void)setDelegate:(id<SKNetworkReporterDelegate>)delegate { - (void)setDelegate:(id<SKNetworkReporterDelegate>)delegate {
_delegate = delegate; _delegate = delegate;
[FLEXNetworkObserver start]; [SKFLEXNetworkObserver start];
[FLEXNetworkRecorder defaultRecorder].delegate = _delegate; [SKFLEXNetworkRecorder defaultRecorder].delegate = _delegate;
} }
@end @end