Files
app-check/AppCheck/Sources/DebugProvider/GACAppCheckDebugProvider.m
T
Andrew Heard ab0f574162 Extract heartbeat logger from GACAppCheckAPIService (#11277)
Removed the direct dependency on FIRHeartbeatLoggerProtocol from GACAppCheckAPIService, moving it up into the App Check providers.

Added request hooks (blocks) to allow heartbeat logging headers to be added to requests before they are sent.
2023-07-20 10:35:11 -04:00

145 lines
5.1 KiB
Objective-C

/*
* Copyright 2020 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#import "AppCheck/Sources/Public/AppCheck/GACAppCheckDebugProvider.h"
#if __has_include(<FBLPromises/FBLPromises.h>)
#import <FBLPromises/FBLPromises.h>
#else
#import "FBLPromises.h"
#endif
#import "AppCheck/Sources/Core/APIService/GACAppCheckAPIService.h"
#import "AppCheck/Sources/Core/GACAppCheckLogger.h"
#import "AppCheck/Sources/Core/GACAppCheckValidator.h"
#import "AppCheck/Sources/DebugProvider/API/GACAppCheckDebugProviderAPIService.h"
#import "AppCheck/Sources/Public/AppCheck/GACAppCheckToken.h"
#import "FirebaseCore/Extension/FirebaseCoreInternal.h"
NS_ASSUME_NONNULL_BEGIN
// TODO(andrewheard): Remove from generic App Check SDK.
// FIREBASE_APP_CHECK_ONLY_BEGIN
static NSString *const kHeartbeatKey = @"X-firebase-client";
// FIREBASE_APP_CHECK_ONLY_END
static NSString *const kDebugTokenEnvKey = @"FIRAAppCheckDebugToken";
static NSString *const kDebugTokenUserDefaultsKey = @"FIRAAppCheckDebugToken";
@interface GACAppCheckDebugProvider ()
@property(nonatomic, readonly) id<GACAppCheckDebugProviderAPIServiceProtocol> APIService;
@end
@implementation GACAppCheckDebugProvider
- (instancetype)initWithAPIService:(id<GACAppCheckDebugProviderAPIServiceProtocol>)APIService {
self = [super init];
if (self) {
_APIService = APIService;
}
return self;
}
- (nullable instancetype)initWithApp:(FIRApp *)app {
NSArray<NSString *> *missingOptionsFields =
[GACAppCheckValidator tokenExchangeMissingFieldsInOptions:app.options];
if (missingOptionsFields.count > 0) {
GACLogError(kFIRLoggerAppCheckMessageDebugProviderIncompleteFIROptions,
@"Cannot instantiate `GACAppCheckDebugProvider` for app: %@. The following "
@"`FirebaseOptions` fields are missing: %@",
app.name, [missingOptionsFields componentsJoinedByString:@", "]);
return nil;
}
NSURLSession *URLSession = [NSURLSession
sessionWithConfiguration:[NSURLSessionConfiguration ephemeralSessionConfiguration]];
// TODO(andrewheard): Remove from generic App Check SDK.
// FIREBASE_APP_CHECK_ONLY_BEGIN
GACAppCheckAPIRequestHook heartbeatLoggerHook = ^(NSMutableURLRequest *request) {
[request setValue:FIRHeaderValueFromHeartbeatsPayload(
[app.heartbeatLogger flushHeartbeatsIntoPayload])
forHTTPHeaderField:kHeartbeatKey];
};
// FIREBASE_APP_CHECK_ONLY_END
GACAppCheckAPIService *APIService =
[[GACAppCheckAPIService alloc] initWithURLSession:URLSession
APIKey:app.options.APIKey
appID:app.options.googleAppID
requestHooks:@[ heartbeatLoggerHook ]];
GACAppCheckDebugProviderAPIService *debugAPIService =
[[GACAppCheckDebugProviderAPIService alloc] initWithAPIService:APIService
projectID:app.options.projectID
appID:app.options.googleAppID];
return [self initWithAPIService:debugAPIService];
}
- (NSString *)currentDebugToken {
NSString *envVariableValue = [[NSProcessInfo processInfo] environment][kDebugTokenEnvKey];
if (envVariableValue.length > 0) {
return envVariableValue;
} else {
return [self localDebugToken];
}
}
- (NSString *)localDebugToken {
return [self storedDebugToken] ?: [self generateAndStoreDebugToken];
}
- (nullable NSString *)storedDebugToken {
return [[NSUserDefaults standardUserDefaults] stringForKey:kDebugTokenUserDefaultsKey];
}
- (void)storeDebugToken:(nullable NSString *)token {
[[NSUserDefaults standardUserDefaults] setObject:token forKey:kDebugTokenUserDefaultsKey];
}
- (NSString *)generateAndStoreDebugToken {
NSString *token = [NSUUID UUID].UUIDString;
[self storeDebugToken:token];
return token;
}
#pragma mark - GACAppCheckProvider
- (void)getTokenWithCompletion:(void (^)(GACAppCheckToken *_Nullable token,
NSError *_Nullable error))handler {
[FBLPromise do:^NSString * {
return [self currentDebugToken];
}]
.then(^FBLPromise<GACAppCheckToken *> *(NSString *debugToken) {
return [self.APIService appCheckTokenWithDebugToken:debugToken];
})
.then(^id(GACAppCheckToken *appCheckToken) {
handler(appCheckToken, nil);
return nil;
})
.catch(^void(NSError *error) {
GACLogDebug(kFIRLoggerAppCheckMessageDebugProviderFailedExchange,
@"Failed to exchange debug token to app check token: %@", error);
handler(nil, error);
});
}
@end
NS_ASSUME_NONNULL_END