242dfd2bce
Currently, only some `JobQueue` types are initialized during startup (as part of `Environment`, or `SSKEnvironment`). Initialization is required, however, for a `JobQueue` type to restart any latent jobs. That means that, for example, a durable `SendGiftBadge` job that failed, and should be reattempted at a later date, will not in fact be restarted since no `SendGiftBadgeJobQueue` will be initialized at launch. This change adds `SSKJobQueues` and `SignalMessagingJobQueues` types, which are intended to be singletons that hold within them a singleton job queue for each of our `JobQueue` types. These wrappers are added to `SSKEnvironment` and `Environment` (from SignalMessaging) respectively, ensuring that all the `JobQueue`s they contain are initialized as part of environment setup. The wrappers also avoid the need to add a new property to the (already large) environment types for each new future `JobQueue`. This change also updates all existing call sites that accessed a `JobQueue` from an environment object, to direct that access now through the wrapper type.
57 lines
1.9 KiB
Objective-C
57 lines
1.9 KiB
Objective-C
//
|
|
// Copyright 2014 Signal Messenger, LLC
|
|
// SPDX-License-Identifier: AGPL-3.0-only
|
|
//
|
|
|
|
#import <SignalServiceKit/SSKEnvironment.h>
|
|
|
|
NS_ASSUME_NONNULL_BEGIN
|
|
|
|
@class AvatarBuilder;
|
|
@class LaunchJobs;
|
|
@class LightweightCallManager;
|
|
@class OWSOrphanDataCleaner;
|
|
@class OWSPreferences;
|
|
@class OWSSounds;
|
|
@class SignalMessagingJobQueues;
|
|
|
|
@protocol OWSProximityMonitoringManager;
|
|
|
|
/**
|
|
*
|
|
* Environment is a data and data accessor class.
|
|
* It handles application-level component wiring in order to support mocks for testing.
|
|
* It also handles network configuration for testing/deployment server configurations.
|
|
*
|
|
**/
|
|
// TODO: Rename to SMGEnvironment?
|
|
@interface Environment : NSObject
|
|
|
|
+ (instancetype)new NS_UNAVAILABLE;
|
|
- (instancetype)init NS_UNAVAILABLE;
|
|
|
|
- (instancetype)initWithLaunchJobs:(LaunchJobs *)launchJobs
|
|
preferences:(OWSPreferences *)preferences
|
|
proximityMonitoringManager:(id<OWSProximityMonitoringManager>)proximityMonitoringManager
|
|
sounds:(OWSSounds *)sounds
|
|
orphanDataCleaner:(OWSOrphanDataCleaner *)orphanDataCleaner
|
|
avatarBuilder:(AvatarBuilder *)avatarBuilder
|
|
smJobQueues:(SignalMessagingJobQueues *)smJobQueues;
|
|
|
|
@property (nonatomic, readonly) LaunchJobs *launchJobsRef;
|
|
@property (nonatomic, readonly) id<OWSProximityMonitoringManager> proximityMonitoringManagerRef;
|
|
@property (nonatomic, readonly) OWSPreferences *preferencesRef;
|
|
@property (nonatomic, readonly) OWSSounds *soundsRef;
|
|
@property (nonatomic, readonly) OWSOrphanDataCleaner *orphanDataCleanerRef;
|
|
@property (nonatomic, readonly) AvatarBuilder *avatarBuilderRef;
|
|
@property (nonatomic, readonly) SignalMessagingJobQueues *signalMessagingJobQueuesRef;
|
|
|
|
// This property is configured after Environment is created.
|
|
@property (atomic, nullable) LightweightCallManager *lightweightCallManagerRef;
|
|
|
|
@property (class, nonatomic) Environment *shared;
|
|
|
|
@end
|
|
|
|
NS_ASSUME_NONNULL_END
|