Add the ability to read persisted (.clsrecord) crash files (#4762)

Author: jasonhu-g

Crashlytics/Crashlytics/Models/Record/FIRCLSRecordAdapter.h

@@ -0,0 +1,33 @@
+/*
+ * Copyright 2020 Google
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#import <Foundation/Foundation.h>
+
+/**
+ * The class will be responsible for aggregating the data from the persisted crash files
+ * and returning a report object used for FireLog.
+ **/
+@interface FIRCLSRecordAdapter : NSObject
+
+- (instancetype)init NS_UNAVAILABLE;
+
+/// Initializer
+/// @param folderPath Path where the persisted crash files reside
+- (instancetype)initWithPath:(NSString *)folderPath;
+
+// TODO: Add function to return the nanopb/FireLog report
+
+@end

Crashlytics/Crashlytics/Models/Record/FIRCLSRecordAdapter.m

@@ -0,0 +1,149 @@
+/*
+ * Copyright 2020 Google
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#import "FIRCLSRecordAdapter.h"
+
+#import "FIRCLSInternalReport.h"
+#import "FIRCLSLogger.h"
+#import "FIRCLSRecordApplication.h"
+#import "FIRCLSRecordBinaryImage.h"
+#import "FIRCLSRecordExecutable.h"
+#import "FIRCLSRecordHost.h"
+#import "FIRCLSRecordIdentity.h"
+#import "FIRCLSRecordKeyValue.h"
+#import "FIRCLSRecordProcessStats.h"
+#import "FIRCLSRecordRegister.h"
+#import "FIRCLSRecordRuntime.h"
+#import "FIRCLSRecordSignal.h"
+#import "FIRCLSRecordStorage.h"
+#import "FIRCLSRecordThread.h"
+
+@interface FIRCLSRecordAdapter ()
+
+@property(nonatomic, strong) NSString *folderPath;
+
+@property(nonatomic, strong) FIRCLSRecordSignal *signal;
+@property(nonatomic, strong) NSArray<FIRCLSRecordThread *> *threads;
+@property(nonatomic, strong) FIRCLSRecordProcessStats *processStats;
+@property(nonatomic, strong) FIRCLSRecordStorage *storage;
+@property(nonatomic, strong) NSArray<FIRCLSRecordBinaryImage *> *binaryImages;
+@property(nonatomic, strong) FIRCLSRecordRuntime *runtime;
+@property(nonatomic, strong) FIRCLSRecordIdentity *identity;
+@property(nonatomic, strong) FIRCLSRecordHost *host;
+@property(nonatomic, strong) FIRCLSRecordApplication *application;
+@property(nonatomic, strong) FIRCLSRecordExecutable *executable;
+@property(nonatomic, strong) NSArray<FIRCLSRecordKeyValue *> *keyValues;
+
+@end
+
+@implementation FIRCLSRecordAdapter
+
+- (instancetype)initWithPath:(NSString *)folderPath {
+  self = [super init];
+  if (self) {
+    _folderPath = folderPath;
+
+    [self loadBinaryImagesFile];
+    [self loadMetaDataFile];
+    [self loadSignalFile];
+    [self loadKeyValuesFile];
+  }
+  return self;
+}
+
+- (void)loadBinaryImagesFile {
+  NSString *path = [self.folderPath stringByAppendingPathComponent:CLSReportBinaryImageFile];
+  self.binaryImages = [FIRCLSRecordBinaryImage
+      binaryImagesFromDictionaries:[FIRCLSRecordAdapter dictionariesFromEachLineOfFile:path]];
+}
+
+- (void)loadMetaDataFile {
+  NSString *path = [self.folderPath stringByAppendingPathComponent:CLSReportMetadataFile];
+  NSDictionary *dict = [FIRCLSRecordAdapter combinedDictionariesFromFilePath:path];
+
+  self.identity = [[FIRCLSRecordIdentity alloc] initWithDict:dict[@"identity"]];
+  self.host = [[FIRCLSRecordHost alloc] initWithDict:dict[@"host"]];
+  self.application = [[FIRCLSRecordApplication alloc] initWithDict:dict[@"application"]];
+  self.executable = [[FIRCLSRecordExecutable alloc] initWithDict:dict[@"executable"]];
+}
+
+- (void)loadSignalFile {
+  NSString *path = [self.folderPath stringByAppendingPathComponent:CLSReportSignalFile];
+  NSDictionary *dicts = [FIRCLSRecordAdapter combinedDictionariesFromFilePath:path];
+
+  self.signal = [[FIRCLSRecordSignal alloc] initWithDict:dicts[@"signal"]];
+  self.runtime = [[FIRCLSRecordRuntime alloc] initWithDict:dicts[@"runtime"]];
+  self.processStats = [[FIRCLSRecordProcessStats alloc] initWithDict:dicts[@"process_stats"]];
+  self.storage = [[FIRCLSRecordStorage alloc] initWithDict:dicts[@"storage"]];
+
+  // The thread's objc_selector_name is set with the runtime's info
+  self.threads = [FIRCLSRecordThread threadsFromDictionaries:dicts[@"threads"]
+                                                   withNames:dicts[@"thread_names"]
+                                                 withRuntime:self.runtime];
+}
+
+- (void)loadKeyValuesFile {
+  NSString *path =
+      [self.folderPath stringByAppendingPathComponent:CLSReportInternalIncrementalKVFile];
+  self.keyValues = [FIRCLSRecordKeyValue
+      keyValuesFromDictionaries:[FIRCLSRecordAdapter dictionariesFromEachLineOfFile:path]];
+}
+
+/// Return the persisted crash file as a combined dictionary that way lookups can occur with a key
+/// (to avoid ordering dependency)
+/// @param filePath Persisted crash file path
++ (NSDictionary *)combinedDictionariesFromFilePath:(NSString *)filePath {
+  NSMutableDictionary *joinedDict = [[NSMutableDictionary alloc] init];
+  for (NSDictionary *dict in [self dictionariesFromEachLineOfFile:filePath]) {
+    [joinedDict addEntriesFromDictionary:dict];
+  }
+  return joinedDict;
+}
+
+/// The persisted crash files contains JSON on separate lines. Read each line and return the JSON
+/// data as a dictionary.
+/// @param filePath Persisted crash file path
++ (NSArray<NSDictionary *> *)dictionariesFromEachLineOfFile:(NSString *)filePath {
+  NSString *content = [[NSString alloc] initWithContentsOfFile:filePath
+                                                      encoding:NSUTF8StringEncoding
+                                                         error:nil];
+  NSArray *lines =
+      [content componentsSeparatedByCharactersInSet:NSCharacterSet.newlineCharacterSet];
+
+  NSMutableArray<NSDictionary *> *array = [[NSMutableArray<NSDictionary *> alloc] init];
+
+  int lineNum = 1;
+  for (NSString *line in lines) {
+    NSError *error;
+    NSDictionary *dict =
+        [NSJSONSerialization JSONObjectWithData:[line dataUsingEncoding:NSUTF8StringEncoding]
+                                        options:0
+                                          error:&error];
+
+    if (error) {
+      FIRCLSErrorLog(@"Failed to read JSON from file (%@) line (%d) with error: %@", filePath,
+                     lineNum, error);
+    } else {
+      [array addObject:dict];
+    }
+
+    lineNum++;
+  }
+
+  return array;
+}
+
+@end

Crashlytics/Crashlytics/Models/Record/FIRCLSRecordApplication.h

@@ -0,0 +1,25 @@
+/*
+ * Copyright 2020 Google
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#import "FIRCLSRecordBase.h"
+
+@interface FIRCLSRecordApplication : FIRCLSRecordBase
+
+@property(nonatomic, copy) NSString *bundle_id;
+@property(nonatomic, copy) NSString *build_version;
+@property(nonatomic, copy) NSString *display_version;
+
+@end

Crashlytics/Crashlytics/Models/Record/FIRCLSRecordApplication.m

@@ -0,0 +1,31 @@
+/*
+ * Copyright 2020 Google
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#import "FIRCLSRecordApplication.h"
+
+@implementation FIRCLSRecordApplication
+
+- (instancetype)initWithDict:(NSDictionary *)dict {
+  self = [super initWithDict:dict];
+  if (self) {
+    _bundle_id = dict[@"bundle_id"];
+    _display_version = dict[@"display_version"];
+    _build_version = dict[@"build_version"];
+  }
+  return self;
+}
+
+@end

Crashlytics/Crashlytics/Models/Record/FIRCLSRecordBase.h

@@ -0,0 +1,42 @@
+/*
+ * Copyright 2020 Google
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#import <Foundation/Foundation.h>
+
+/**
+ * This is the base class to represent the data in the persisted crash (.clsrecord) files.
+ * The properties these subclasses are nullable on purpose. If there is an issue reading values
+ * from the crash files, continue as if those fields are optional so a report can still be uploaded.
+ * That way the issue can potentially be monitored through the backend.
+ **/
+@interface FIRCLSRecordBase : NSObject
+
+/**
+ * Mark the default initializer as unavailable so  the subclasses do not have to add the same line
+ **/
+- (instancetype)init NS_UNAVAILABLE;
+
+/**
+ * All subclasses should define an initializer taking in a dictionary
+ **/
+- (instancetype)initWithDict:(NSDictionary *)dict;
+
+/**
+ * Decode hex encoded string
+ **/
++ (NSString *)decodedHexStringWithValue:(NSString *)hexEncodedString;
+
+@end

Crashlytics/Crashlytics/Models/Record/FIRCLSRecordBase.m

@@ -0,0 +1,38 @@
+/*
+ * Copyright 2020 Google
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#import "FIRCLSRecordBase.h"
+
+@implementation FIRCLSRecordBase
+
+- (instancetype)initWithDict:(NSDictionary *)dict {
+  return [super init];
+}
+
++ (NSString *)decodedHexStringWithValue:(NSString *)hexEncodedString {
+  NSMutableString *decodedString = [[NSMutableString alloc] init];
+  int index = 0;
+  while (index < hexEncodedString.length) {
+    NSString *hexChar = [hexEncodedString substringWithRange:NSMakeRange(index, 2)];
+    int value = 0;
+    sscanf([hexChar cStringUsingEncoding:NSASCIIStringEncoding], "%x", &value);
+    [decodedString appendFormat:@"%c", (char)value];
+    index += 2;
+  }
+  return decodedString;
+}
+
+@end

Crashlytics/Crashlytics/Models/Record/FIRCLSRecordBinaryImage.h

@@ -0,0 +1,31 @@
+/*
+ * Copyright 2020 Google
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#import "FIRCLSRecordBase.h"
+
+@interface FIRCLSRecordBinaryImage : FIRCLSRecordBase
+
+@property(nonatomic, copy) NSString *path;
+@property(nonatomic, copy) NSString *uuid;
+@property(nonatomic, assign) NSUInteger base;
+@property(nonatomic, assign) NSUInteger size;
+
+/// Return an array of binary images
+/// @param dicts Dictionary describing the binary images
++ (NSArray<FIRCLSRecordBinaryImage *> *)binaryImagesFromDictionaries:
+    (NSArray<NSDictionary *> *)dicts;
+
+@end

Crashlytics/Crashlytics/Models/Record/FIRCLSRecordBinaryImage.m

@@ -0,0 +1,42 @@
+/*
+ * Copyright 2020 Google
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#import "FIRCLSRecordBinaryImage.h"
+
+@implementation FIRCLSRecordBinaryImage
+
++ (NSArray<FIRCLSRecordBinaryImage *> *)binaryImagesFromDictionaries:
+    (NSArray<NSDictionary *> *)dicts {
+  NSMutableArray<FIRCLSRecordBinaryImage *> *images =
+      [[NSMutableArray<FIRCLSRecordBinaryImage *> alloc] init];
+  for (NSDictionary *dict in dicts) {
+    [images addObject:[[FIRCLSRecordBinaryImage alloc] initWithDict:dict[@"load"]]];
+  }
+  return images;
+}
+
+- (instancetype)initWithDict:(NSDictionary *)dict {
+  self = [super initWithDict:dict];
+  if (self) {
+    _path = dict[@"path"];
+    _uuid = dict[@"uuid"];
+    _base = (NSUInteger)dict[@"base"];
+    _size = (NSUInteger)dict[@"size"];
+  }
+  return self;
+}
+
+@end