/
FIRFunctions.m
306 lines (272 loc) · 10.8 KB
/
FIRFunctions.m
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
// Copyright 2017 Google
//
// 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 "Functions/FirebaseFunctions/Public/FirebaseFunctions/FIRFunctions.h"
#import "Functions/FirebaseFunctions/FIRFunctions+Internal.h"
#import "FirebaseCore/Sources/Private/FirebaseCoreInternal.h"
#import "Interop/Auth/Public/FIRAuthInterop.h"
#import "Functions/FirebaseFunctions/FIRHTTPSCallable+Internal.h"
#import "Functions/FirebaseFunctions/FUNContext.h"
#import "Functions/FirebaseFunctions/FUNError.h"
#import "Functions/FirebaseFunctions/FUNSerializer.h"
#import "Functions/FirebaseFunctions/FUNUsageValidation.h"
#import "Functions/FirebaseFunctions/Public/FirebaseFunctions/FIRError.h"
#import "Functions/FirebaseFunctions/Public/FirebaseFunctions/FIRHTTPSCallable.h"
#if SWIFT_PACKAGE
@import GTMSessionFetcherCore;
#else
#import <GTMSessionFetcher/GTMSessionFetcherService.h>
#endif
// The following two macros supply the incantation so that the C
// preprocessor does not try to parse the version as a floating
// point number. See
// https://www.guyrutenberg.com/2008/12/20/expanding-macros-into-string-constants-in-c/
#define STR(x) STR_EXPAND(x)
#define STR_EXPAND(x) #x
NS_ASSUME_NONNULL_BEGIN
NSString *const kFUNInstanceIDTokenHeader = @"Firebase-Instance-ID-Token";
NSString *const kFUNDefaultRegion = @"us-central1";
/// Empty protocol to register Functions as a component with Core.
@protocol FIRFunctionsInstanceProvider
@end
@interface FIRFunctions () <FIRLibrary, FIRFunctionsInstanceProvider> {
// The network client to use for http requests.
GTMSessionFetcherService *_fetcherService;
// The projectID to use for all function references.
NSString *_projectID;
// The region to use for all function references.
NSString *_region;
// A serializer to encode/decode data and return values.
FUNSerializer *_serializer;
// A factory for getting the metadata to include with function calls.
FUNContextProvider *_contextProvider;
// For testing only. If this is set, functions will be called against it instead of Firebase.
NSString *_emulatorOrigin;
}
// Re-declare this initializer here in order to attribute it as the designated initializer.
- (instancetype)initWithProjectID:(NSString *)projectID
region:(NSString *)region
auth:(nullable id<FIRAuthInterop>)auth NS_DESIGNATED_INITIALIZER;
@end
@implementation FIRFunctions
+ (void)load {
NSString *version = [NSString stringWithUTF8String:(const char *const)STR(FIRFunctions_VERSION)];
[FIRApp registerInternalLibrary:(Class<FIRLibrary>)self withName:@"fire-fun" withVersion:version];
}
+ (NSArray<FIRComponent *> *)componentsToRegister {
FIRComponentCreationBlock creationBlock =
^id _Nullable(FIRComponentContainer *container, BOOL *isCacheable) {
*isCacheable = YES;
return [self functionsForApp:container.app];
};
FIRDependency *auth = [FIRDependency dependencyWithProtocol:@protocol(FIRAuthInterop)
isRequired:NO];
FIRComponent *internalProvider =
[FIRComponent componentWithProtocol:@protocol(FIRFunctionsInstanceProvider)
instantiationTiming:FIRInstantiationTimingLazy
dependencies:@[ auth ]
creationBlock:creationBlock];
return @[ internalProvider ];
}
+ (instancetype)functions {
return [[self alloc] initWithApp:[FIRApp defaultApp] region:kFUNDefaultRegion];
}
+ (instancetype)functionsForApp:(FIRApp *)app {
return [[self alloc] initWithApp:app region:kFUNDefaultRegion];
}
+ (instancetype)functionsForRegion:(NSString *)region {
return [[self alloc] initWithApp:[FIRApp defaultApp] region:region];
}
+ (instancetype)functionsForApp:(FIRApp *)app region:(NSString *)region {
return [[self alloc] initWithApp:app region:region];
}
- (instancetype)initWithApp:(FIRApp *)app region:(NSString *)region {
return [self initWithProjectID:app.options.projectID
region:region
auth:FIR_COMPONENT(FIRAuthInterop, app.container)];
}
- (instancetype)initWithProjectID:(NSString *)projectID
region:(NSString *)region
auth:(nullable id<FIRAuthInterop>)auth {
self = [super init];
if (self) {
if (!region) {
FUNThrowInvalidArgument(@"FIRFunctions region cannot be nil.");
}
_fetcherService = [[GTMSessionFetcherService alloc] init];
_projectID = [projectID copy];
_region = [region copy];
_serializer = [[FUNSerializer alloc] init];
_contextProvider = [[FUNContextProvider alloc] initWithAuth:auth];
_emulatorOrigin = nil;
}
return self;
}
- (void)useLocalhost {
[self useFunctionsEmulatorOrigin:@"http://localhost:5005"];
}
- (void)useFunctionsEmulatorOrigin:(NSString *)origin {
_emulatorOrigin = origin;
}
- (NSString *)URLWithName:(NSString *)name {
if (!name) {
FUNThrowInvalidArgument(@"FIRFunctions function name cannot be nil.");
}
if (!_projectID) {
FUNThrowInvalidArgument(@"FIRFunctions app projectID cannot be nil.");
}
if (_emulatorOrigin) {
return [NSString stringWithFormat:@"%@/%@/%@/%@", _emulatorOrigin, _projectID, _region, name];
}
return
[NSString stringWithFormat:@"https://%@-%@.cloudfunctions.net/%@", _region, _projectID, name];
}
- (void)callFunction:(NSString *)name
withObject:(nullable id)data
timeout:(NSTimeInterval)timeout
completion:(void (^)(FIRHTTPSCallableResult *_Nullable result,
NSError *_Nullable error))completion {
[_contextProvider getContext:^(FUNContext *_Nullable context, NSError *_Nullable error) {
if (error) {
if (completion) {
completion(nil, error);
}
return;
}
return [self callFunction:name
withObject:data
timeout:timeout
context:context
completion:completion];
}];
}
- (void)callFunction:(NSString *)name
withObject:(nullable id)data
timeout:(NSTimeInterval)timeout
context:(FUNContext *)context
completion:(void (^)(FIRHTTPSCallableResult *_Nullable result,
NSError *_Nullable error))completion {
NSURL *url = [NSURL URLWithString:[self URLWithName:name]];
NSURLRequest *request = [NSURLRequest requestWithURL:url
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:timeout];
GTMSessionFetcher *fetcher = [_fetcherService fetcherWithRequest:request];
NSMutableDictionary *body = [NSMutableDictionary dictionary];
// Encode the data in the body.
if (!data) {
data = [NSNull null];
}
id encoded = [_serializer encode:data];
if (!encoded) {
FUNThrowInvalidArgument(@"FIRFunctions data encoded as nil. This should not happen.");
}
body[@"data"] = encoded;
NSError *error = nil;
NSData *payload = [NSJSONSerialization dataWithJSONObject:body options:0 error:&error];
if (error) {
if (completion) {
dispatch_async(dispatch_get_main_queue(), ^{
completion(nil, error);
});
}
return;
}
fetcher.bodyData = payload;
// Set the headers.
[fetcher setRequestValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
if (context.authToken) {
NSString *value = [NSString stringWithFormat:@"Bearer %@", context.authToken];
[fetcher setRequestValue:value forHTTPHeaderField:@"Authorization"];
}
if (context.instanceIDToken) {
[fetcher setRequestValue:context.instanceIDToken forHTTPHeaderField:kFUNInstanceIDTokenHeader];
}
// Override normal security rules if this is a local test.
if (_emulatorOrigin) {
fetcher.allowLocalhostRequest = YES;
fetcher.allowedInsecureSchemes = @[ @"http" ];
}
FUNSerializer *serializer = _serializer;
[fetcher beginFetchWithCompletionHandler:^(NSData *_Nullable data, NSError *_Nullable error) {
// If there was an HTTP error, convert it to our own error domain.
if (error) {
if ([error.domain isEqualToString:kGTMSessionFetcherStatusDomain]) {
error = FUNErrorForResponse(error.code, data, serializer);
}
if ([error.domain isEqualToString:NSURLErrorDomain]) {
if (error.code == NSURLErrorTimedOut) {
error = FUNErrorForCode(FIRFunctionsErrorCodeDeadlineExceeded);
}
}
} else {
// If there wasn't an HTTP error, see if there was an error in the body.
error = FUNErrorForResponse(200, data, serializer);
}
// If there was an error, report it to the user and stop.
if (error) {
if (completion) {
completion(nil, error);
}
return;
}
id responseJSON = [NSJSONSerialization JSONObjectWithData:data options:0 error:&error];
if (error) {
if (completion) {
completion(nil, error);
}
return;
}
if (![responseJSON isKindOfClass:[NSDictionary class]]) {
NSDictionary *userInfo = @{NSLocalizedDescriptionKey : @"Response was not a dictionary."};
error = [NSError errorWithDomain:FIRFunctionsErrorDomain
code:FIRFunctionsErrorCodeInternal
userInfo:userInfo];
if (completion) {
completion(nil, error);
}
return;
}
id dataJSON = responseJSON[@"data"];
// TODO(klimt): Allow "result" instead of "data" for now, for backwards compatibility.
if (!dataJSON) {
dataJSON = responseJSON[@"result"];
}
if (!dataJSON) {
NSDictionary *userInfo = @{NSLocalizedDescriptionKey : @"Response is missing data field."};
error = [NSError errorWithDomain:FIRFunctionsErrorDomain
code:FIRFunctionsErrorCodeInternal
userInfo:userInfo];
if (completion) {
completion(nil, error);
}
return;
}
id resultData = [serializer decode:dataJSON error:&error];
if (error) {
if (completion) {
completion(nil, error);
}
return;
}
id result = [[FIRHTTPSCallableResult alloc] initWithData:resultData];
if (completion) {
// If there's no result field, this will return nil, which is fine.
completion(result, nil);
}
}];
}
- (FIRHTTPSCallable *)HTTPSCallableWithName:(NSString *)name {
return [[FIRHTTPSCallable alloc] initWithFunctions:self name:name];
}
@end
NS_ASSUME_NONNULL_END