- OCActivity

- fill API gaps - implement missing pieces of OCSyncRecordActivity - OCCoreItemListTask now is an OCActivitySource, OCCore+ItemList now emits activity updates - OCCore - use localID instead of fileID to track progress on a per-item basis - now posts OCCoreItemBeginsHavingProgress and OCCoreItemStopsHavingProgress notifications when an item starts having progress, and when the last progress has completed for an item - add localID property to NSProgress - Sync Engine - OCSyncAction now properly serialized/deserializes the localizedDescription - gated access to OCDatabase for adding, updating and removing SyncRecords, used to emit activity updates
owncloud · Jan 28, 2019 · ab78777 · ab78777
1 parent 8dcda9c
commit ab78777
Show file tree

Hide file tree

Showing 17 changed files with 217 additions and 65 deletions.
diff --git a/ownCloudSDK/Activity/OCActivity.h b/ownCloudSDK/Activity/OCActivity.h
@@ -79,6 +79,8 @@ NS_ASSUME_NONNULL_BEGIN
 
 + (instancetype)withIdentifier:(OCActivityIdentifier)identifier description:(NSString *)description statusMessage:(nullable NSString *)statusMessage ranking:(NSInteger)ranking;
 
+- (instancetype)initWithIdentifier:(OCActivityIdentifier)identifier;
+
 - (NSError *)applyUpdate:(OCActivityUpdate *)update; //!< Applies an update to the activity. Returns nil if the update could be applied, an error otherwise.
 - (NSError *)applyValue:(nullable id <NSObject>)value forKeyPath:(NSString *)keyPath; //!< Applies a new value to a keypath (entrypoint for subclassing)
 

diff --git a/ownCloudSDK/Activity/OCActivity.m b/ownCloudSDK/Activity/OCActivity.m
@@ -47,6 +47,16 @@ + (instancetype)withIdentifier:(OCActivityIdentifier)identifier description:(NSS
 	return (activity);
 }
 
+- (instancetype)initWithIdentifier:(OCActivityIdentifier)identifier
+{
+	if ((self = [super init]) != nil)
+	{
+		_identifier = identifier;
+	}
+
+	return (self);
+}
+
 - (void)cancel
 {
 	if (_isCancellable)

diff --git a/ownCloudSDK/Activity/OCActivityUpdate.h b/ownCloudSDK/Activity/OCActivityUpdate.h
@@ -29,6 +29,11 @@ typedef NS_ENUM(NSUInteger,OCActivityUpdateType)
 };
 
 @interface OCActivityUpdate : NSObject
+{
+	OCActivityUpdateType _type;
+	OCActivityIdentifier _identifier;
+	NSMutableDictionary <NSString *, id<NSObject>> *_updatesByKeyPath;
+}
 
 @property(readonly) OCActivityUpdateType type; //!< The type of activity
 

diff --git a/ownCloudSDK/Activity/OCActivityUpdate.m b/ownCloudSDK/Activity/OCActivityUpdate.m
@@ -18,15 +18,6 @@
 
 #import "OCActivityUpdate.h"
 
-@interface OCActivityUpdate ()
-{
-	OCActivityUpdateType _type;
-	OCActivityIdentifier _identifier;
-	NSMutableDictionary <NSString *, id<NSObject>> *_updatesByKeyPath;
-}
-
-@end
-
 @implementation OCActivityUpdate
 
 @synthesize type = _type;

diff --git a/ownCloudSDK/Activity/OCSyncRecordActivity.h b/ownCloudSDK/Activity/OCSyncRecordActivity.h
@@ -31,7 +31,13 @@ NS_ASSUME_NONNULL_BEGIN
 @property(assign) OCEventType type;
 @property(assign,nonatomic) OCSyncRecordState recordState;
 
-- (instancetype)initWithSyncRecord:(OCSyncRecord *)syncRecord;
+- (instancetype)initWithSyncRecord:(OCSyncRecord *)syncRecord identifier:(OCActivityIdentifier)identifier;
+
+@end
+
+@interface OCActivityUpdate (OCSyncRecord)
+
+- (instancetype)withRecordState:(OCSyncRecordState)recordState;
 
 @end
 

diff --git a/ownCloudSDK/Activity/OCSyncRecordActivity.m b/ownCloudSDK/Activity/OCSyncRecordActivity.m
@@ -21,9 +21,9 @@
 
 @implementation OCSyncRecordActivity
 
-- (instancetype)initWithSyncRecord:(OCSyncRecord *)syncRecord
+- (instancetype)initWithSyncRecord:(OCSyncRecord *)syncRecord identifier:(OCActivityIdentifier)identifier
 {
-	if ((self = [super init]) != nil)
+	if ((self = [super initWithIdentifier:identifier]) != nil)
 	{
 		_recordID = syncRecord.recordID;
 		_type = syncRecord.action.actionEventType;
@@ -47,21 +47,35 @@ - (void)setRecordState:(OCSyncRecordState)recordState
 		switch (_recordState)
 		{
 			case OCSyncRecordStatePending:
-			break;
-
 			case OCSyncRecordStateReady:
+				self.state = OCActivityStatePending;
+				self.localizedStatusMessage = OCLocalized(@"Pending");
 			break;
 
 			case OCSyncRecordStateProcessing:
-			break;
-
 			case OCSyncRecordStateCompleted:
+				self.state = OCActivityStateRunning;
+				self.localizedStatusMessage = OCLocalized(@"Running");
 			break;
 
 			case OCSyncRecordStateFailed:
+				self.state = OCActivityStateFailed;
+				self.localizedStatusMessage = OCLocalized(@"Failed");
 			break;
 		}
 	}
 }
 
 @end
+
+@implementation OCActivityUpdate (OCSyncRecord)
+
+- (instancetype)withRecordState:(OCSyncRecordState)recordState
+{
+	_updatesByKeyPath[@"recordState"] = @(recordState);
+
+	return (self);
+}
+
+@end
+
diff --git a/ownCloudSDK/Core/ItemList/OCCore+ItemList.m b/ownCloudSDK/Core/ItemList/OCCore+ItemList.m
@@ -115,6 +115,8 @@ - (OCCoreItemListTask *)_scheduleItemListTaskForPath:(OCPath)path
 		{
 			_itemListTasksByPath[task.path] = task;
 
+			[self.activityManager update:[OCActivityUpdate publishingActivityFor:task]];
+
 			// Start item list task
 			if (task.syncAnchorAtStart == nil)
 			{
@@ -153,6 +155,8 @@ - (void)_finishedItemListTask:(OCCoreItemListTask *)finishedTask
 				[self scheduleNextItemListTask];
 			}
 		}
+
+		[self.activityManager update:[OCActivityUpdate unpublishActivityFor:finishedTask]];
 	}
 }
 
@@ -726,7 +730,6 @@ - (void)startCheckingForUpdates
 - (void)_checkForUpdatesNotBefore:(NSDate *)notBefore
 {
 	OCEventTarget *eventTarget;
-	OCActivityIdentifier activityIdentifier = [@"CheckForUpdates." stringByAppendingString:NSUUID.UUID.UUIDString];
 
 	if (self.state != OCCoreStateRunning)
 	{
@@ -735,17 +738,13 @@ - (void)_checkForUpdatesNotBefore:(NSDate *)notBefore
 
 	[self beginActivity:@"Check for updates"];
 
-	eventTarget = [OCEventTarget eventTargetWithEventHandlerIdentifier:self.eventHandlerIdentifier userInfo:@{ @"activityIdentifier" : activityIdentifier } ephermalUserInfo:@{ @"endActivity" : @(YES)  }];
-
-	[self.activityManager update:[OCActivityUpdate publishingActivity:[OCActivity withIdentifier:activityIdentifier description:@"Scanning for changes.." statusMessage:nil ranking:0]]];
+	eventTarget = [OCEventTarget eventTargetWithEventHandlerIdentifier:self.eventHandlerIdentifier userInfo:nil ephermalUserInfo:@{ @"endActivity" : @(YES)  }];
 
 	[self.connection retrieveItemListAtPath:@"/" depth:0 notBefore:notBefore options:((notBefore != nil) ? @{ OCConnectionOptionIsNonCriticalKey : @(YES) } : nil) resultTarget:eventTarget];
 }
 
 - (void)_handleRetrieveItemListEvent:(OCEvent *)event sender:(id)sender
 {
-	OCActivityIdentifier activityIdentifier = (OCActivityIdentifier)event.userInfo[@"activityIdentifier"];
-
 	OCLogDebug(@"Handling background retrieved items: error=%@, path=%@, depth=%d, items=%@", OCLogPrivate(event.error), OCLogPrivate(event.path), event.depth, OCLogPrivate(event.result));
 
 	// Handle result
@@ -779,12 +778,6 @@ - (void)_handleRetrieveItemListEvent:(OCEvent *)event sender:(id)sender
 		}
 	}
 
-	// Update activity
-	if (activityIdentifier != nil)
-	{
-		[self.activityManager update:[OCActivityUpdate unpublishActivityForIdentifier:activityIdentifier]];
-	}
-
 	// Schedule next
 	if ((event.depth == 0) && ([event.path isEqual:@"/"]))
 	{

diff --git a/ownCloudSDK/Core/ItemList/OCCoreItemListTask.h b/ownCloudSDK/Core/ItemList/OCCoreItemListTask.h
@@ -20,6 +20,7 @@
 #import "OCTypes.h"
 #import "OCItem.h"
 #import "OCCoreItemList.h"
+#import "OCActivity.h"
 
 @class OCCore;
 @class OCCoreItemListTask;
@@ -32,7 +33,7 @@ typedef NS_ENUM(NSUInteger, OCCoreTaskMergeStatus)
 
 typedef void(^OCCoreItemListTaskChangeHandler)(OCCore *core, OCCoreItemListTask *task);
 
-@interface OCCoreItemListTask : NSObject
+@interface OCCoreItemListTask : NSObject <OCActivitySource>
 
 @property(weak) OCCore *core;
 @property(strong) OCPath path;

diff --git a/ownCloudSDK/Core/ItemList/OCCoreItemListTask.m b/ownCloudSDK/Core/ItemList/OCCoreItemListTask.m
@@ -26,6 +26,14 @@
 #import "OCCore+ConnectionStatus.h"
 #import "OCCore+ItemList.h"
 #import "OCMacros.h"
+#import "NSProgress+OCExtensions.h"
+
+@interface OCCoreItemListTask ()
+{
+	OCActivityIdentifier _activityIdentifier;
+}
+
+@end
 
 @implementation OCCoreItemListTask
 
@@ -136,7 +144,9 @@ - (void)_updateRetrievedSet
 		void (^RetrieveItems)(OCItem *parentDirectoryItem) = ^(OCItem *parentDirectoryItem){
 			[self->_core queueConnectivityBlock:^{
 				[self->_core queueRequestJob:^(dispatch_block_t completionHandler) {
-					[self->_core.connection retrieveItemListAtPath:self.path depth:1 completionHandler:^(NSError *error, NSArray<OCItem *> *items) {
+					NSProgress *retrievalProgress;
+
+					retrievalProgress = [self->_core.connection retrieveItemListAtPath:self.path depth:1 completionHandler:^(NSError *error, NSArray<OCItem *> *items) {
 						[self->_core queueBlock:^{ // Update inside the core's serial queue to make sure we never change the data while the core is also working on it
 							OCSyncAnchor latestSyncAnchor = [self.core retrieveLatestSyncAnchorWithError:NULL];
 
@@ -221,6 +231,11 @@ - (void)_updateRetrievedSet
 							completionHandler();
 						}];
 					}];
+
+					if (retrievalProgress != nil)
+					{
+						[self.core.activityManager update:[[OCActivityUpdate updatingActivityFor:self] withProgress:retrievalProgress]];
+					}
 				}];
 			}];
 		};
@@ -299,4 +314,24 @@ - (void)_update
 	[_core endActivity:@"update unstarted sets"];
 }
 
+#pragma mark - Activity source
+- (OCActivityIdentifier)activityIdentifier
+{
+	if (_activityIdentifier == nil)
+	{
+		_activityIdentifier = [@"ItemListTask:" stringByAppendingString:NSUUID.UUID.UUIDString];
+	}
+
+	return (_activityIdentifier);
+}
+
+- (OCActivity *)provideActivity
+{
+	OCActivity *activity = [OCActivity withIdentifier:self.activityIdentifier description:[NSString stringWithFormat:@"Retrieving items for %@", self.path] statusMessage:nil ranking:0];
+
+	activity.progress = NSProgress.indeterminateProgress;
+
+	return (activity);
+}
+
 @end
diff --git a/ownCloudSDK/Core/OCCore.h b/ownCloudSDK/Core/OCCore.h
@@ -163,7 +163,7 @@ NS_ASSUME_NONNULL_BEGIN
 	BOOL _automaticItemListUpdatesEnabled;
 	NSDate *_lastScheduledItemListUpdateDate;
 
-	NSMutableDictionary <OCFileID, NSMutableArray<NSProgress *> *> *_progressByFileID;
+	NSMutableDictionary <OCFileID, NSMutableArray<NSProgress *> *> *_progressByLocalID;
 
 	__weak id <OCCoreDelegate> _delegate;
 }
@@ -293,3 +293,6 @@ extern OCConnectionSignalID OCConnectionSignalIDCoreOnline;
 extern OCCoreOption OCCoreOptionImportByCopying; //!< [BOOL] Determines whether -[OCCore importFileNamed:..] should make a copy of the provided file, or move it (default).
 extern OCCoreOption OCCoreOptionImportTransformation; //!< [OCCoreImportTransformation] Transformation to be applied on local item before upload
 extern OCCoreOption OCCoreOptionReturnImmediatelyIfOfflineOrUnavailable; //!< [BOOL] Determines whether -[OCCore downloadItem:..] should return immediately if the core is currently offline or unavailable.
+
+extern NSNotificationName OCCoreItemBeginsHavingProgress; //!< Notification sent when an item starts having progress. The object is the localID of the item.
+extern NSNotificationName OCCoreItemStopsHavingProgress; //!< Notification sent when an item no longer has any progress. The object is the localID of the item.