feat(functions): support Cloud Functions locations (#660)

capawesome-team · Jul 1, 2024 · 549585d · 549585d
1 parent 2df9693
commit 549585d
Show file tree

Hide file tree

Showing 9 changed files with 52 additions and 14 deletions.
diff --git a/packages/functions/README.md b/packages/functions/README.md
@@ -129,9 +129,10 @@ Call a callable function by URL.
 
 #### CallByNameOptions
 
-| Prop       | Type                | Description                        | Since |
-| ---------- | ------------------- | ---------------------------------- | ----- |
-| **`name`** | <code>string</code> | The name of the callable function. | 6.1.0 |
+| Prop         | Type                | Description                          | Since |
+| ------------ | ------------------- | ------------------------------------ | ----- |
+| **`name`**   | <code>string</code> | The name of the callable function.   | 6.1.0 |
+| **`region`** | <code>string</code> | The region of the callable function. | 6.1.0 |
 
 
 #### CallByUrlOptions

diff --git a/...src/main/java/io/capawesome/capacitorjs/plugins/firebase/functions/FirebaseFunctions.java b/...src/main/java/io/capawesome/capacitorjs/plugins/firebase/functions/FirebaseFunctions.java
@@ -1,6 +1,7 @@
 package io.capawesome.capacitorjs.plugins.firebase.functions;
 
 import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
 import io.capawesome.capacitorjs.plugins.firebase.functions.classes.options.CallByNameOptions;
 import io.capawesome.capacitorjs.plugins.firebase.functions.classes.options.CallByUrlOptions;
 import io.capawesome.capacitorjs.plugins.firebase.functions.classes.results.CallResult;
@@ -16,9 +17,10 @@ public FirebaseFunctions(FirebaseFunctionsPlugin plugin) {
 
     public void callByName(@NonNull CallByNameOptions options, @NonNull NonEmptyResultCallback callback) {
         String name = options.getName();
+        String region = options.getRegion();
         Object data = options.getData();
 
-        getFirebaseFunctionsInstance()
+        getFirebaseFunctionsInstance(region)
             .getHttpsCallable(name)
             .call(data)
             .addOnSuccessListener(
@@ -38,7 +40,7 @@ public void callByUrl(@NonNull CallByUrlOptions options, @NonNull NonEmptyResult
         String url = options.getUrl();
         Object data = options.getData();
 
-        getFirebaseFunctionsInstance()
+        getFirebaseFunctionsInstance(null)
             .getHttpsCallable(url)
             .call(data)
             .addOnSuccessListener(
@@ -54,7 +56,11 @@ public void callByUrl(@NonNull CallByUrlOptions options, @NonNull NonEmptyResult
             );
     }
 
-    private com.google.firebase.functions.FirebaseFunctions getFirebaseFunctionsInstance() {
-        return com.google.firebase.functions.FirebaseFunctions.getInstance();
+    private com.google.firebase.functions.FirebaseFunctions getFirebaseFunctionsInstance(@Nullable String regionOrCustomDomain) {
+        if (regionOrCustomDomain == null) {
+            return com.google.firebase.functions.FirebaseFunctions.getInstance();
+        } else {
+            return com.google.firebase.functions.FirebaseFunctions.getInstance(regionOrCustomDomain);
+        }
     }
 }
diff --git a/...in/java/io/capawesome/capacitorjs/plugins/firebase/functions/FirebaseFunctionsPlugin.java b/...in/java/io/capawesome/capacitorjs/plugins/firebase/functions/FirebaseFunctionsPlugin.java
@@ -28,14 +28,15 @@ public void load() {
     public void callByName(PluginCall call) {
         try {
             JSObject json = call.getData();
-            String name = json.getString("name");
+            String name = json.getString("name", null);
             if (name == null) {
                 call.reject(ERROR_NAME_MISSING);
                 return;
             }
+            String region = json.getString("region", null);
             Object data = json.opt("data");
 
-            CallByNameOptions options = new CallByNameOptions(name, data);
+            CallByNameOptions options = new CallByNameOptions(name, region, data);
             NonEmptyResultCallback callback = new NonEmptyResultCallback() {
                 @Override
                 public void success(Result result) {

diff --git a/.../capawesome/capacitorjs/plugins/firebase/functions/classes/options/CallByNameOptions.java b/.../capawesome/capacitorjs/plugins/firebase/functions/classes/options/CallByNameOptions.java
@@ -1,19 +1,29 @@
 package io.capawesome.capacitorjs.plugins.firebase.functions.classes.options;
 
 import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
 
 public class CallByNameOptions extends CallOptions {
 
     @NonNull
     private String name;
 
-    public CallByNameOptions(@NonNull String name, Object data) {
+    @Nullable
+    private String region;
+
+    public CallByNameOptions(@NonNull String name, @Nullable String region, Object data) {
         super(data);
         this.name = name;
+        this.region = region;
     }
 
     @NonNull
     public String getName() {
         return name;
     }
+
+    @Nullable
+    public String getRegion() {
+        return region;
+    }
 }
diff --git a/packages/functions/ios/Plugin/Classes/Options/CallByNameOptions.swift b/packages/functions/ios/Plugin/Classes/Options/CallByNameOptions.swift
@@ -2,13 +2,19 @@ import Foundation
 
 @objc public class CallByNameOptions: CallOptions {
     private var name: String
+    private var region: String?
 
-    init(name: String, data: Any?) {
+    init(name: String, region: String?, data: Any?) {
         self.name = name
+        self.region = region
         super.init(data: data)
     }
 
     func getName() -> String {
         return name
     }
+
+    func getRegion() -> String? {
+        return region
+    }
 }
diff --git a/packages/functions/ios/Plugin/FirebaseFunctions.swift b/packages/functions/ios/Plugin/FirebaseFunctions.swift
@@ -15,9 +15,15 @@ import FirebaseFunctions
 
     @objc public func callByName(_ options: CallByNameOptions, completion: @escaping (Result?, Error?) -> Void) {
         let name = options.getName()
+        let region = options.getRegion()
         let data = options.getData()
 
-        let functions = Functions.functions()
+        let functions: Functions
+        if let region = region {
+            functions = Functions.functions(region: region)
+        } else {
+            functions = Functions.functions()
+        }
         let callable = functions.httpsCallable(name)
         callable.call(data) { (result, error) in
             if let error = error {

diff --git a/packages/functions/ios/Plugin/FirebaseFunctionsPlugin.swift b/packages/functions/ios/Plugin/FirebaseFunctionsPlugin.swift
@@ -20,9 +20,10 @@ public class FirebaseFunctionsPlugin: CAPPlugin {
             call.reject(errorNameMissing)
             return
         }
+        let region = call.getString("region")
         let data = call.getValue("data")
 
-        let options = CallByNameOptions(name: name, data: data)
+        let options = CallByNameOptions(name: name, region: region, data: data)
 
         implementation?.callByName(options, completion: { result, error in
             if let error = error {

diff --git a/packages/functions/src/definitions.ts b/packages/functions/src/definitions.ts
@@ -24,6 +24,13 @@ export interface CallByNameOptions extends CallOptions {
    * @since 6.1.0
    */
   name: string;
+  /**
+   * The region of the callable function.
+   *
+   * @example 'us-central1'
+   * @since 6.1.0
+   */
+  region?: string;
 }
 
 /**

diff --git a/packages/functions/src/web.ts b/packages/functions/src/web.ts
@@ -20,7 +20,7 @@ export class FirebaseFunctionsWeb
   public async callByName(
     options: CallByNameOptions,
   ): Promise<CallByNameResult> {
-    const functions = getFunctions();
+    const functions = getFunctions(undefined, options.region);
     const callable = httpsCallable(functions, options.name);
     const result = await callable(options.data);
     return {