Fix slow reloading conversation view. (signalapp#1397)

Fix animation memory leak exacerbated every time you reload a
conversation with expiration timers.

Stop animation on cells that aren't currently being displayed. This is
relatively minor compared to the above, but still, no reason to waste
cycles.

// FREEBIE

Author: michaelkirk

Podfile

@@ -3,7 +3,7 @@ source 'https://github.com/CocoaPods/Specs.git'
 
 target 'Signal' do
     pod 'SocketRocket',               :git => 'https://github.com/facebook/SocketRocket.git'
-    pod 'SignalServiceKit',           git: 'https://github.com/WhisperSystems/SignalServiceKit.git', branch: 'mkirk/empty-bubble-disappearing-self#1393'
+    pod 'SignalServiceKit',           git: 'https://github.com/WhisperSystems/SignalServiceKit.git'
     #pod 'SignalServiceKit',           path: '../SignalServiceKit'
     pod 'OpenSSL',                    '~> 1.0.208'
     pod 'PastelogKit',                '~> 1.3'

Podfile.lock

@@ -122,13 +122,12 @@ DEPENDENCIES:
   - OpenSSL (~> 1.0.208)
   - PastelogKit (~> 1.3)
   - SCWaveformView (~> 1.0)
-  - SignalServiceKit (from `https://github.com/WhisperSystems/SignalServiceKit.git`, branch `mkirk/empty-bubble-disappearing-self#1393`)
+  - SignalServiceKit (from `https://github.com/WhisperSystems/SignalServiceKit.git`)
   - SocketRocket (from `https://github.com/facebook/SocketRocket.git`)
   - ZXingObjC
 
 EXTERNAL SOURCES:
   SignalServiceKit:
-    :branch: mkirk/empty-bubble-disappearing-self#1393
     :git: https://github.com/WhisperSystems/SignalServiceKit.git
   SocketRocket:
     :git: https://github.com/facebook/SocketRocket.git
@@ -167,6 +166,6 @@ SPEC CHECKSUMS:
   YapDatabase: b1e43555a34a5298e23a045be96817a5ef0da58f
   ZXingObjC: bf15b3814f7a105b6d99f47da2333c93a063650a
 
-PODFILE CHECKSUM: e8495fa75a157c62674121b7f0faf30ee7542ec6
+PODFILE CHECKSUM: f5e3e3b84c4c471518f4e3a32746e6a0e13808f6
 
 COCOAPODS: 1.0.1

Signal/Signal-Info.plist

@@ -21,7 +21,7 @@
 	<key>CFBundlePackageType</key>
 	<string>APPL</string>
 	<key>CFBundleShortVersionString</key>
-	<string>2.6.1</string>
+	<string>2.6.2</string>
 	<key>CFBundleSignature</key>
 	<string>????</string>
 	<key>CFBundleURLTypes</key>
@@ -38,7 +38,7 @@
 		</dict>
 	</array>
 	<key>CFBundleVersion</key>
-	<string>2.6.1.3</string>
+	<string>2.6.2.0</string>
 	<key>ITSAppUsesNonExemptEncryption</key>
 	<false/>
 	<key>LOGS_EMAIL</key>

Signal/src/view controllers/MessagesViewController.m

@@ -664,6 +664,9 @@ - (void)didPressSendButton:(UIButton *)button
     }
 }
 
+#pragma mark - UICollectionViewDelegate
+
+// Override JSQMVC
 - (BOOL)collectionView:(JSQMessagesCollectionView *)collectionView shouldShowMenuForItemAtIndexPath:(NSIndexPath *)indexPath
 {
     if (indexPath == nil) {
@@ -679,6 +682,16 @@ - (BOOL)collectionView:(JSQMessagesCollectionView *)collectionView shouldShowMen
     return YES;
 }
 
+- (void)collectionView:(UICollectionView *)collectionView
+    didEndDisplayingCell:(nonnull UICollectionViewCell *)cell
+      forItemAtIndexPath:(nonnull NSIndexPath *)indexPath
+{
+    if ([cell conformsToProtocol:@protocol(OWSExpirableMessageView)]) {
+        id<OWSExpirableMessageView> expirableView = (id<OWSExpirableMessageView>)cell;
+        [expirableView stopExpirationTimer];
+    }
+}
+
 #pragma mark - JSQMessages CollectionView DataSource
 
 - (id<OWSMessageData>)collectionView:(JSQMessagesCollectionView *)collectionView

Signal/src/views/OWSExpirableMessageView.h

@@ -15,6 +15,8 @@ static const CGFloat OWSExpirableMessageViewTimerWidth = 10.0f;
 - (void)startExpirationTimerWithExpiresAtSeconds:(uint64_t)expiresAtSeconds
                           initialDurationSeconds:(uint32_t)initialDurationSeconds;
 
+- (void)stopExpirationTimer;
+
 @end
 
 NS_ASSUME_NONNULL_END

Signal/src/views/OWSExpirationTimerView.h

@@ -10,7 +10,7 @@ NS_ASSUME_NONNULL_BEGIN
 - (void)startTimerWithExpiresAtSeconds:(uint64_t)expiresAtSeconds
                 initialDurationSeconds:(uint32_t)initialDurationSeconds;
 
-- (void)stopBlinking;
+- (void)stopTimer;
 
 @end
 

Signal/src/views/OWSExpirationTimerView.m

@@ -85,9 +85,10 @@ - (void)layoutSubviews
     self.fullHourglassImageView.bounds = hourglassFrame;
 }
 
-- (void)restartAnimation:(NSNotification *)notification
+- (void)handleReappearNotification:(NSNotification *)notification
 {
-    [self startTimerWithExpiresAtSeconds:self.expiresAtSeconds initialDurationSeconds:self.initialDurationSeconds];
+    DDLogVerbose(@"%@ handleReappearNotification", self.logTag);
+    [self startAnimation];
 }
 
 - (void)startTimerWithExpiresAtSeconds:(uint64_t)expiresAtSeconds
@@ -100,17 +101,26 @@ - (void)startTimerWithExpiresAtSeconds:(uint64_t)expiresAtSeconds
             initialDurationSeconds);
     }
 
-    DDLogVerbose(@"%@ Starting animation timer with expiresAtSeconds: %llu initialDurationSeconds: %d",
+    DDLogVerbose(@"%@ Starting timer with expiresAtSeconds: %llu initialDurationSeconds: %d",
         self.logTag,
         expiresAtSeconds,
         initialDurationSeconds);
 
     self.expiresAtSeconds = expiresAtSeconds;
     self.initialDurationSeconds = initialDurationSeconds;
     [[NSNotificationCenter defaultCenter] addObserver:self
-                                             selector:@selector(restartAnimation:)
+                                             selector:@selector(handleReappearNotification:)
                                                  name:OWSMessagesViewControllerDidAppearNotification
                                                object:nil];
+    [self startAnimation];
+}
+
+- (void)startAnimation
+{
+    DDLogVerbose(@"%@ Starting animation with expiresAtSeconds: %llu initialDurationSeconds: %d",
+        self.logTag,
+        self.expiresAtSeconds,
+        self.initialDurationSeconds);
 
     double secondsLeft = (double)self.expiresAtSeconds - [NSDate new].timeIntervalSince1970;
 
@@ -154,14 +164,26 @@ - (void)startTimerWithExpiresAtSeconds:(uint64_t)expiresAtSeconds
     [maskLayer addAnimation:revealAnimation forKey:@"revealAnimation"];
     maskLayer.position = finalPosition; // don't snap back
 
+    __weak typeof(self) wself = self;
     dispatch_after(dispatch_time(DISPATCH_TIME_NOW,
                        (long long)((secondsLeft - OWSExpirationTimerViewBlinkingSeconds) * NSEC_PER_SEC)),
         dispatch_get_main_queue(),
         ^{
-            [self startBlinking];
+            [wself startBlinking];
         });
 }
 
+- (void)stopTimer
+{
+    DDLogVerbose(@"%@ Stopping Timer.", self.logTag);
+    [[NSNotificationCenter defaultCenter] removeObserver:self
+                                                    name:OWSMessagesViewControllerDidAppearNotification
+                                                  object:nil];
+
+    [self.layer removeAnimationForKey:@"alphaBlink"];
+    self.layer.opacity = 1;
+}
+
 - (BOOL)itIsTimeToBlink
 {
     double secondsLeft = (double)self.expiresAtSeconds - [NSDate new].timeIntervalSince1970;
@@ -185,12 +207,6 @@ - (void)startBlinking
     [self.layer addAnimation:blinkAnimation forKey:@"alphaBlink"];
 }
 
-- (void)stopBlinking
-{
-    [self.layer removeAnimationForKey:@"alphaBlink"];
-    self.layer.opacity = 1;
-}
-
 #pragma mark - Logging
 
 + (NSString *)logTag

Signal/src/views/OWSIncomingMessageCollectionViewCell.m

@@ -24,7 +24,6 @@ - (void)awakeFromNib
 - (void)prepareForReuse
 {
     [super prepareForReuse];
-    [self.expirationTimerView stopBlinking];
     self.expirationTimerViewWidthConstraint.constant = 0.0f;
 }
 
@@ -38,6 +37,11 @@ - (void)startExpirationTimerWithExpiresAtSeconds:(uint64_t)expiresAtSeconds
                                       initialDurationSeconds:initialDurationSeconds];
 }
 
+- (void)stopExpirationTimer
+{
+    [self.expirationTimerView stopTimer];
+}
+
 @end
 
 NS_ASSUME_NONNULL_END

Signal/src/views/OWSOutgoingMessageCollectionViewCell.m

@@ -24,7 +24,6 @@ - (void)awakeFromNib
 - (void)prepareForReuse
 {
     [super prepareForReuse];
-    [self.expirationTimerView stopBlinking];
     self.expirationTimerViewWidthConstraint.constant = 0.0f;
 }
 
@@ -38,6 +37,11 @@ - (void)startExpirationTimerWithExpiresAtSeconds:(uint64_t)expiresAtSeconds
                                       initialDurationSeconds:initialDurationSeconds];
 }
 
+- (void)stopExpirationTimer
+{
+    [self.expirationTimerView stopTimer];
+}
+
 @end
 
 NS_ASSUME_NONNULL_END