xref: /expo/ios/Exponent/Kernel/AppLoader/EXAbstractLoader.h (revision b8addc5d)

// Copyright 2015-present 650 Industries. All rights reserved.

#import <Foundation/Foundation.h>
#import "EXAppFetcher.h"
#import "EXCachedResource.h"

@class EXKernelAppRecord;
@class EXAbstractLoader;
@class EXManifestsManifest;

NS_ASSUME_NONNULL_BEGIN

FOUNDATION_EXPORT NSTimeInterval const kEXAppLoaderDefaultTimeout;
FOUNDATION_EXPORT NSTimeInterval const kEXJSBundleTimeout;

typedef enum EXAppLoaderStatus {
  kEXAppLoaderStatusNew,
  kEXAppLoaderStatusHasManifest, // possibly optimistic
  kEXAppLoaderStatusHasManifestAndBundle,
  kEXAppLoaderStatusError,
} EXAppLoaderStatus;

typedef enum EXAppLoaderRemoteUpdateStatus {
  kEXAppLoaderRemoteUpdateStatusChecking,
  kEXAppLoaderRemoteUpdateStatusDownloading
} EXAppLoaderRemoteUpdateStatus;

@protocol EXAppLoaderDelegate <NSObject>

- (void)appLoader:(EXAbstractLoader *)appLoader didLoadOptimisticManifest:(EXManifestsManifest *)manifest;
- (void)appLoader:(EXAbstractLoader *)appLoader didLoadBundleWithProgress:(EXLoadingProgress *)progress;
- (void)appLoader:(EXAbstractLoader *)appLoader didFinishLoadingManifest:(EXManifestsManifest *)manifest bundle:(NSData *)data;
- (void)appLoader:(EXAbstractLoader *)appLoader didFailWithError:(NSError *)error;
- (void)appLoader:(EXAbstractLoader *)appLoader didResolveUpdatedBundleWithManifest:(EXManifestsManifest * _Nullable)manifest isFromCache:(BOOL)isFromCache error:(NSError * _Nullable)error;

@end

/**
 Class with stub methods to load apps.
 It has two subclasses: EXHomeLoader (for loading the home app), and
 EXAppLoaderExpoUpdates (for loading and displaying apps in the home UI)
 */
@interface EXAbstractLoader : NSObject <EXAppFetcherDelegate, EXAppFetcherCacheDataSource>

@property (nonatomic, readonly) NSURL *manifestUrl;
@property (nonatomic, readonly) EXManifestsManifest * _Nullable manifest; // possibly optimistic
@property (nonatomic, readonly) EXManifestsManifest * _Nullable cachedManifest; // we definitely have this manifest and its bundle on the device
@property (nonatomic, readonly) NSData * _Nullable bundle;
@property (nonatomic, readonly) EXAppLoaderStatus status;
@property (nonatomic, readonly) EXAppLoaderRemoteUpdateStatus remoteUpdateStatus;
@property (nonatomic, readonly) BOOL shouldShowRemoteUpdateStatus;
@property (nonatomic, readonly) BOOL isUpToDate;

@property (nonatomic, weak) id<EXAppLoaderDelegate> delegate;
@property (nonatomic, weak) id<EXAppFetcherDataSource> dataSource;

- (instancetype)initWithManifestUrl:(NSURL *)url;
- (instancetype)initWithLocalManifest:(EXManifestsManifest * _Nonnull)manifest;

/**
 *  Begin a new request.
 *  In production, this will fetch a manifest and a bundle using the caching behavior specified by the Updates API.
 *  If the manifest enables developer tools, this will stop after it gets a manifest, and wait for `forceBundleReload`.
 */
- (void)request;

/**
 *  Begin a new request, but only use the most recently cached manifest.
 *  In production, this will fetch a manifest and a bundle using the caching behavior specified by the Updates API.
 *  If the manifest enables developer tools, this will stop after it gets a manifest, and wait for `forceBundleReload`.
 */
- (void)requestFromCache;

/**
 *  Tell this AppLoader that everything has finished successfully and its manifest resource can be cached.
 */
- (void)writeManifestToCache;

/**
 *  Reset status to `kEXAppLoaderStatusHasManifest` and fetch the bundle at the existing
 *  manifest. This is called when RN devtools reload an AppManager/RCTBridge directly
 *  via reload, live reload, etc.
 *
 *  This will throw if not supported, i.e. if `supportsBundleReload` returns false.
 */
- (void)forceBundleReload;

/**
 *  Return whether this AppLoader supports directly reloading the bundle. Right now the only case
 *  where that's possible is if we're running an app in dev mode.
 */
- (BOOL)supportsBundleReload;

/**
 * Fetch manifest without any side effects or interaction with the timer.
 */
- (void)fetchManifestWithCacheBehavior:(EXManifestCacheBehavior)cacheBehavior success:(void (^)(EXManifestsManifest *))success failure:(void (^)(NSError *))failure;

@end

NS_ASSUME_NONNULL_END