Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Log history #597

Merged
merged 4 commits into from
May 4, 2017
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions Source/ARTLog+Private.h
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

ART_ASSUME_NONNULL_BEGIN

@interface ARTLogLine : NSObject
@interface ARTLogLine : NSObject <NSCoding>

@property(nonatomic, readonly, strong) NSDate *date;
@property(nonatomic, readonly) ARTLogLevel level;
Expand All @@ -27,9 +27,11 @@ ART_ASSUME_NONNULL_BEGIN

@interface ARTLog ()

@property(readonly, getter=getCaptured) __GENERIC(NSArray, ARTLogLine *) *captured;
@property (readonly) NSArray<ARTLogLine *> *captured;
@property (readonly) NSArray<ARTLogLine *> *history;

- (instancetype)initCapturingOutput:(BOOL)capturing;
- (instancetype)initCapturingOutput:(BOOL)capturing historyLines:(NSUInteger)historyLines;

@end

Expand Down
45 changes: 42 additions & 3 deletions Source/ARTLog.m
Original file line number Diff line number Diff line change
Expand Up @@ -43,23 +43,54 @@ - (NSString *)toString {
return [NSString stringWithFormat:@"%s: %@", logLevelName(self.level), self.message];
}

- (NSString *)description {
return [self toString];
}

#pragma mark - NSCoding
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is this for?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To save the object in disk with NSUserDefaults.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If necessary. Currently, the logger does not store the history.


- (id)initWithCoder:(NSCoder *)decoder {
self = [super init];
if (!self) {
return nil;
}
_date = [decoder decodeObjectForKey:@"date"];
_level = [[decoder decodeObjectForKey:@"level"] unsignedIntValue];
_message = [decoder decodeObjectForKey:@"message"];
return self;
}

- (void)encodeWithCoder:(NSCoder *)encoder {
[encoder encodeObject:self.date forKey:@"date"];
[encoder encodeObject:[NSNumber numberWithUnsignedInteger:self.level] forKey:@"level"];
[encoder encodeObject:self.message forKey:@"message"];
}

@end

@implementation ARTLog {
NSMutableArray *_captured;
NSMutableArray<ARTLogLine *> *_captured;
NSMutableArray<ARTLogLine *> *_history;
NSUInteger _historyLines;
}

- (instancetype)init {
return [self initCapturingOutput:false];
return [self initCapturingOutput:true];
}

- (instancetype)initCapturingOutput:(BOOL)capturing {
return [self initCapturingOutput:true historyLines:10];
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

10 seems awfully low, should we bump to say 50 or 100?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done c3afa25.

}

- (instancetype)initCapturingOutput:(BOOL)capturing historyLines:(NSUInteger)historyLines {
if (self = [super init]) {
// Default
self->_logLevel = ARTLogLevelWarn;
if (capturing) {
self->_captured = [[NSMutableArray alloc] init];
}
_history = [[NSMutableArray alloc] init];
_historyLines = historyLines;
}
return self;
}
Expand All @@ -72,9 +103,17 @@ - (void)log:(NSString *)message level:(ARTLogLevel)level {
[_captured addObject:logLine];
}
}
[_history insertObject:logLine atIndex:0];
if (_history.count > _historyLines) {
[_history removeLastObject];
}
}

- (NSArray<ARTLogLine *> *)history {
return _history;
}

- (NSArray *)getCaptured {
- (NSArray *)captured {
if (!_captured) {
[NSException raise:NSInternalInconsistencyException format:@"tried to get captured output in non-capturing instance; use initCapturingOutput:true if you want captured output."];
}
Expand Down
21 changes: 21 additions & 0 deletions Spec/Utilities.swift
Original file line number Diff line number Diff line change
Expand Up @@ -386,6 +386,27 @@ class Utilities: QuickSpec {
}
}
}

context("Logger") {

it("should have a history of logs") {
let options = AblyTests.commonAppSetup()
let realtime = ARTRealtime(options: options)
let channel = realtime.channels.get("foo")

waitUntil(timeout: testTimeout) { done in
channel.attach { error in
expect(error).to(beNil())
done()
}
}

expect(realtime.logger.history).to(haveCount(10))
expect(realtime.logger.history.map{ $0.message }.first).to(contain("channel state transitions to 2 - Attached"))
expect(realtime.logger.history.filter{ $0.message.containsString("realtime state transitions to 2 - Connected") }).to(haveCount(1))
}

}
}
}
}
Expand Down