Skip to content

Commit 27faa28

Browse files
morganchen12morganchen12
authored
Cache Functions instances by app (#8258)
* Cache FIRStorage instances by app * changelog * nuts * format * appease the code coverage bot * storage -> functions * style * appease codecov again * Go the component way * doc comments and style * fix copyrights * Fix bad import * nit * make it threadsafe * attempt to fix swift test * fix tests again * debug * Disable Combine tests
1 parent 8dd5fdd commit 27faa28

File tree

9 files changed

+280
-39
lines changed

9 files changed

+280
-39
lines changed

‎.github/workflows/functions.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,8 @@ jobs:
4646
run: scripts/setup_spm_tests.sh
4747
- name: iOS Unit Tests
4848
run: scripts/third_party/travis/retry.sh ./scripts/build.sh FirebaseFunctions iOS spmbuildonly
49-
- name: Combine Unit Tests
50-
run: scripts/third_party/travis/retry.sh ./scripts/build.sh FunctionsCombineUnit iOS spm
49+
# - name: Combine Unit Tests
50+
# run: scripts/third_party/travis/retry.sh ./scripts/build.sh FunctionsCombineUnit iOS spm
5151

5252
spm-cron:
5353
# Don't run on private repo.

‎Functions/CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
# v8.2.0
2+
- [fixed] Fixed an issue where factory class methods returned a new instance on every invocation, causing emulator settings to not persist between invocations (#7783).
3+
14
# v8.0.0
25
- [added] Added abuse reduction features. (#7928)
36

‎Functions/Example/Tests/FIRFunctionsTests.m

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@
2020
#import "SharedTestUtilities/AppCheckFake/FIRAppCheckFake.h"
2121
#import "SharedTestUtilities/AppCheckFake/FIRAppCheckTokenResultFake.h"
2222

23+
#import <FirebaseCore/FirebaseCore.h>
24+
2325
#if SWIFT_PACKAGE
2426
@import GTMSessionFetcherCore;
2527
#else
@@ -81,6 +83,37 @@ - (void)tearDown {
8183
[super tearDown];
8284
}
8385

86+
- (void)testFunctionsInstanceIsStablePerApp {
87+
FIROptions *options =
88+
[[FIROptions alloc] initWithGoogleAppID:@"0:0000000000000:ios:0000000000000000"
89+
GCMSenderID:@"00000000000000000-00000000000-000000000"];
90+
[FIRApp configureWithOptions:options];
91+
92+
FIRFunctions *functions1 = [FIRFunctions functions];
93+
FIRFunctions *functions2 = [FIRFunctions functionsForApp:[FIRApp defaultApp]];
94+
95+
XCTAssertEqualObjects(functions1, functions2);
96+
97+
[FIRApp configureWithName:@"test" options:options];
98+
FIRApp *app2 = [FIRApp appNamed:@"test"];
99+
100+
functions2 = [FIRFunctions functionsForApp:app2 region:@"us-central2"];
101+
102+
XCTAssertNotEqualObjects(functions1, functions2);
103+
104+
functions1 = [FIRFunctions functionsForApp:app2 region:@"us-central2"];
105+
106+
XCTAssertEqualObjects(functions1, functions2);
107+
108+
functions1 = [FIRFunctions functionsForCustomDomain:@"test_domain"];
109+
functions2 = [FIRFunctions functionsForRegion:@"us-central1"];
110+
111+
XCTAssertNotEqualObjects(functions1, functions2);
112+
113+
functions2 = [FIRFunctions functionsForApp:[FIRApp defaultApp] customDomain:@"test_domain"];
114+
XCTAssertEqualObjects(functions1, functions2);
115+
}
116+
84117
- (void)testURLWithName {
85118
NSString *url = [_functions URLWithName:@"my-endpoint"];
86119
XCTAssertEqualObjects(@"https://my-region-my-project.cloudfunctions.net/my-endpoint", url);

‎Functions/FirebaseFunctions/FIRFunctions.m

Lines changed: 28 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,14 @@
1212
// See the License for the specific language governing permissions and
1313
// limitations under the License.
1414

15-
#import "Functions/FirebaseFunctions/Public/FirebaseFunctions/FIRFunctions.h"
15+
#import "FirebaseCore/Sources/Private/FirebaseCoreInternal.h"
16+
1617
#import "Functions/FirebaseFunctions/FIRFunctions+Internal.h"
18+
#import "Functions/FirebaseFunctions/Public/FirebaseFunctions/FIRFunctions.h"
1719

1820
#import "FirebaseAppCheck/Sources/Interop/FIRAppCheckInterop.h"
19-
#import "FirebaseCore/Sources/Private/FirebaseCoreInternal.h"
2021
#import "FirebaseMessaging/Sources/Interop/FIRMessagingInterop.h"
22+
#import "Functions/FirebaseFunctions/FIRFunctionsComponent.h"
2123
#import "Interop/Auth/Public/FIRAuthInterop.h"
2224

2325
#import "Functions/FirebaseFunctions/FIRHTTPSCallable+Internal.h"
@@ -40,11 +42,7 @@
4042
NSString *const kFUNFCMTokenHeader = @"Firebase-Instance-ID-Token";
4143
NSString *const kFUNDefaultRegion = @"us-central1";
4244

43-
/// Empty protocol to register Functions as a component with Core.
44-
@protocol FIRFunctionsInstanceProvider
45-
@end
46-
47-
@interface FIRFunctions () <FIRLibrary, FIRFunctionsInstanceProvider> {
45+
@interface FIRFunctions () {
4846
// The network client to use for http requests.
4947
GTMSessionFetcherService *_fetcherService;
5048
// The projectID to use for all function references.
@@ -75,50 +73,37 @@ - (instancetype)initWithProjectID:(NSString *)projectID
7573

7674
@implementation FIRFunctions
7775

78-
+ (void)load {
79-
[FIRApp registerInternalLibrary:(Class<FIRLibrary>)self withName:@"fire-fun"];
80-
}
81-
82-
+ (NSArray<FIRComponent *> *)componentsToRegister {
83-
FIRComponentCreationBlock creationBlock =
84-
^id _Nullable(FIRComponentContainer *container, BOOL *isCacheable) {
85-
*isCacheable = YES;
86-
return [self functionsForApp:container.app];
87-
};
88-
FIRDependency *auth = [FIRDependency dependencyWithProtocol:@protocol(FIRAuthInterop)
89-
isRequired:NO];
90-
FIRComponent *internalProvider =
91-
[FIRComponent componentWithProtocol:@protocol(FIRFunctionsInstanceProvider)
92-
instantiationTiming:FIRInstantiationTimingLazy
93-
dependencies:@[ auth ]
94-
creationBlock:creationBlock];
95-
return @[ internalProvider ];
96-
}
97-
9876
+ (instancetype)functions {
99-
return [[self alloc] initWithApp:[FIRApp defaultApp] region:kFUNDefaultRegion customDomain:nil];
77+
return [self functionsForApp:[FIRApp defaultApp] region:kFUNDefaultRegion customDomain:nil];
10078
}
10179

10280
+ (instancetype)functionsForApp:(FIRApp *)app {
103-
return [[self alloc] initWithApp:app region:kFUNDefaultRegion customDomain:nil];
81+
return [self functionsForApp:app region:kFUNDefaultRegion customDomain:nil];
10482
}
10583

10684
+ (instancetype)functionsForRegion:(NSString *)region {
107-
return [[self alloc] initWithApp:[FIRApp defaultApp] region:region customDomain:nil];
85+
return [self functionsForApp:[FIRApp defaultApp] region:region customDomain:nil];
10886
}
10987

11088
+ (instancetype)functionsForCustomDomain:(NSString *)customDomain {
111-
return [[self alloc] initWithApp:[FIRApp defaultApp]
112-
region:kFUNDefaultRegion
113-
customDomain:customDomain];
89+
return [self functionsForApp:[FIRApp defaultApp]
90+
region:kFUNDefaultRegion
91+
customDomain:customDomain];
11492
}
11593

11694
+ (instancetype)functionsForApp:(FIRApp *)app region:(NSString *)region {
117-
return [[self alloc] initWithApp:app region:region customDomain:nil];
95+
return [self functionsForApp:app region:region customDomain:nil];
11896
}
11997

12098
+ (instancetype)functionsForApp:(FIRApp *)app customDomain:(NSString *)customDomain {
121-
return [[self alloc] initWithApp:app region:kFUNDefaultRegion customDomain:customDomain];
99+
return [self functionsForApp:app region:kFUNDefaultRegion customDomain:customDomain];
100+
}
101+
102+
+ (instancetype)functionsForApp:(FIRApp *)app
103+
region:(NSString *)region
104+
customDomain:(nullable NSString *)customDomain {
105+
id<FIRFunctionsProvider> provider = FIR_COMPONENT(FIRFunctionsProvider, app.container);
106+
return [provider functionsForApp:app region:region customDomain:customDomain];
122107
}
123108

124109
- (instancetype)initWithApp:(FIRApp *)app
@@ -357,6 +342,14 @@ - (nullable NSString *)emulatorOrigin {
357342
return _emulatorOrigin;
358343
}
359344

345+
- (nullable NSString *)customDomain {
346+
return _customDomain;
347+
}
348+
349+
- (NSString *)region {
350+
return _region;
351+
}
352+
360353
@end
361354

362355
NS_ASSUME_NONNULL_END

‎Functions/FirebaseFunctions/FIRFunctionsComponent.h

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
// Copyright 2021 Google LLC
2+
//
3+
// Licensed under the Apache License, Version 2.0 (the "License");
4+
// you may not use this file except in compliance with the License.
5+
// You may obtain a copy of the License at
6+
//
7+
// http://www.apache.org/licenses/LICENSE-2.0
8+
//
9+
// Unless required by applicable law or agreed to in writing, software
10+
// distributed under the License is distributed on an "AS IS" BASIS,
11+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
// See the License for the specific language governing permissions and
13+
// limitations under the License.
14+
15+
#import <Foundation/Foundation.h>
16+
17+
@class FIRFunctions, FIRApp;
18+
19+
NS_ASSUME_NONNULL_BEGIN
20+
21+
/// This protocol is used in the interop registration process to register an
22+
/// instance provider for individual FIRApps.
23+
@protocol FIRFunctionsProvider
24+
25+
- (FIRFunctions *)functionsForApp:(FIRApp *)app
26+
region:(nullable NSString *)region
27+
customDomain:(nullable NSString *)customDomain;
28+
29+
@end
30+
31+
@interface FIRFunctionsComponent : NSObject <FIRFunctionsProvider>
32+
33+
/// The FIRApp that instances will be set up with.
34+
@property(nonatomic, weak, readonly) FIRApp *app;
35+
36+
/// Unavailable, use `functionsForApp:region:customDomain:` instead.
37+
- (instancetype)init NS_UNAVAILABLE;
38+
39+
@end
40+
41+
NS_ASSUME_NONNULL_END

‎Functions/FirebaseFunctions/FIRFunctionsComponent.m

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
// Copyright 2021 Google LLC
2+
//
3+
// Licensed under the Apache License, Version 2.0 (the "License");
4+
// you may not use this file except in compliance with the License.
5+
// You may obtain a copy of the License at
6+
//
7+
// http://www.apache.org/licenses/LICENSE-2.0
8+
//
9+
// Unless required by applicable law or agreed to in writing, software
10+
// distributed under the License is distributed on an "AS IS" BASIS,
11+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
// See the License for the specific language governing permissions and
13+
// limitations under the License.
14+
15+
#import <os/lock.h>
16+
17+
#import "Functions/FirebaseFunctions/FIRFunctionsComponent.h"
18+
19+
#import "Functions/FirebaseFunctions/FIRFunctions_Private.h"
20+
21+
#import "FirebaseCore/Sources/Private/FirebaseCoreInternal.h"
22+
23+
#import "FirebaseAppCheck/Sources/Interop/FIRAppCheckInterop.h"
24+
#import "FirebaseMessaging/Sources/Interop/FIRMessagingInterop.h"
25+
#import "Interop/Auth/Public/FIRAuthInterop.h"
26+
27+
@interface FIRFunctionsComponent () <FIRLibrary, FIRFunctionsProvider>
28+
29+
/// A map of active instances, grouped by app. Keys are FIRApp names and values are arrays
30+
/// containing all instances of FIRFunctions associated with the given app.
31+
@property(nonatomic) NSMutableDictionary<NSString *, NSMutableArray<FIRFunctions *> *> *instances;
32+
33+
/// Internal intializer.
34+
- (instancetype)initWithApp:(FIRApp *)app;
35+
36+
@end
37+
38+
@implementation FIRFunctionsComponent {
39+
os_unfair_lock _instancesLock;
40+
}
41+
42+
#pragma mark - Initialization
43+
44+
- (instancetype)initWithApp:(FIRApp *)app {
45+
self = [super init];
46+
if (self) {
47+
_app = app;
48+
_instances = [NSMutableDictionary dictionary];
49+
_instancesLock = OS_UNFAIR_LOCK_INIT;
50+
}
51+
return self;
52+
}
53+
54+
#pragma mark - Lifecycle
55+
56+
+ (void)load {
57+
[FIRApp registerInternalLibrary:(Class<FIRLibrary>)self withName:@"fire-fun"];
58+
}
59+
60+
#pragma mark - FIRComponentRegistrant
61+
62+
+ (NSArray<FIRComponent *> *)componentsToRegister {
63+
FIRComponentCreationBlock creationBlock =
64+
^id _Nullable(FIRComponentContainer *container, BOOL *isCacheable) {
65+
*isCacheable = YES;
66+
return [[self alloc] initWithApp:container.app];
67+
};
68+
FIRDependency *auth = [FIRDependency dependencyWithProtocol:@protocol(FIRAuthInterop)
69+
isRequired:NO];
70+
FIRComponent *internalProvider =
71+
[FIRComponent componentWithProtocol:@protocol(FIRFunctionsProvider)
72+
instantiationTiming:FIRInstantiationTimingLazy
73+
dependencies:@[ auth ]
74+
creationBlock:creationBlock];
75+
return @[ internalProvider ];
76+
}
77+
78+
#pragma mark - Instance management
79+
80+
- (void)appWillBeDeleted:(FIRApp *)app {
81+
NSString *appName = app.name;
82+
if (appName == nil) {
83+
return;
84+
}
85+
86+
os_unfair_lock_lock(&_instancesLock);
87+
[self.instances removeObjectForKey:appName];
88+
os_unfair_lock_unlock(&_instancesLock);
89+
}
90+
91+
#pragma mark - FIRFunctionsProvider Conformance
92+
93+
- (FIRFunctions *)functionsForApp:(FIRApp *)app
94+
region:(NSString *)region
95+
customDomain:(NSString *_Nullable)customDomain {
96+
os_unfair_lock_lock(&_instancesLock);
97+
NSArray<FIRFunctions *> *associatedInstances = [self instances][app.name];
98+
if (associatedInstances.count > 0) {
99+
for (FIRFunctions *instance in associatedInstances) {
100+
// Domains may be nil, so handle with care
101+
BOOL equalDomains = NO;
102+
if (instance.customDomain != nil) {
103+
equalDomains = [customDomain isEqualToString:instance.customDomain];
104+
} else {
105+
equalDomains = customDomain == nil;
106+
}
107+
if ([instance.region isEqualToString:region] && equalDomains) {
108+
os_unfair_lock_unlock(&_instancesLock);
109+
return instance;
110+
}
111+
}
112+
}
113+
114+
FIRFunctions *newInstance = [[FIRFunctions alloc] initWithApp:app
115+
region:region
116+
customDomain:customDomain];
117+
118+
if (self.instances[app.name] == nil) {
119+
NSMutableArray *array = [NSMutableArray arrayWithObject:newInstance];
120+
self.instances[app.name] = array;
121+
} else {
122+
[self.instances[app.name] addObject:newInstance];
123+
}
124+
os_unfair_lock_unlock(&_instancesLock);
125+
return newInstance;
126+
}
127+
128+
@end

‎Functions/FirebaseFunctions/FIRFunctions_Private.h

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
// Copyright 2021 Google LLC
2+
//
3+
// Licensed under the Apache License, Version 2.0 (the "License");
4+
// you may not use this file except in compliance with the License.
5+
// You may obtain a copy of the License at
6+
//
7+
// http://www.apache.org/licenses/LICENSE-2.0
8+
//
9+
// Unless required by applicable law or agreed to in writing, software
10+
// distributed under the License is distributed on an "AS IS" BASIS,
11+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
// See the License for the specific language governing permissions and
13+
// limitations under the License.
14+
15+
#import "Functions/FirebaseFunctions/Public/FirebaseFunctions/FIRFunctions.h"
16+
17+
NS_ASSUME_NONNULL_BEGIN
18+
19+
@interface FIRFunctions (Private)
20+
21+
@property(nonatomic, readonly) NSString *region;
22+
@property(nonatomic, readonly, nullable) NSString *customDomain;
23+
24+
- (instancetype)initWithApp:(FIRApp *)app
25+
region:(NSString *)region
26+
customDomain:(nullable NSString *)customDomain;
27+
28+
@end
29+
30+
NS_ASSUME_NONNULL_END

‎Functions/FirebaseFunctions/Public/FirebaseFunctions/FIRFunctions.h

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,15 +58,17 @@ NS_SWIFT_NAME(Functions)
5858
NS_SWIFT_NAME(functions(customDomain:));
5959

6060
/**
61-
* Creates a Cloud Functions client with the given app and region.
61+
* Creates a Cloud Functions client with the given app and region, or returns a pre-existing
62+
* instance if one already exists.
6263
* @param app The app for the Firebase project.
6364
* @param region The region for the http trigger, such as "us-central1".
6465
*/
6566
+ (instancetype)functionsForApp:(FIRApp *)app
6667
region:(NSString *)region NS_SWIFT_NAME(functions(app:region:));
6768

6869
/**
69-
* Creates a Cloud Functions client with the given app and region.
70+
* Creates a Cloud Functions client with the given app and region, or returns a pre-existing
71+
* instance if one already exists.
7072
* @param app The app for the Firebase project.
7173
* @param customDomain A custom domain for the http trigger, such as "https://mydomain.com".
7274
*/

0 commit comments

Comments
 (0)