Canonical directory structure for Functions (#8918)

.github/workflows/functions.yml

@@ -3,7 +3,7 @@ name: functions
 on:
   pull_request:
     paths:
-    - 'Functions**'
+    - 'FirebaseFunctions/**'
     - '.github/workflows/functions.yml'
     - 'Interop/Auth/Public/*.h'
     - 'FirebaseMessaging/Sources/Interop/*.h'
@@ -31,7 +31,7 @@ jobs:
     - name: Setup Bundler
       run: scripts/setup_bundler.sh
     - name: Integration Test Server
-      run: Functions/Backend/start.sh synchronous
+      run: FirebaseFunctions/Backend/start.sh synchronous
     - name: Build and test
       run: |
         scripts/third_party/travis/retry.sh scripts/pod_lib_lint.rb FirebaseFunctions.podspec \
@@ -119,19 +119,20 @@ jobs:
     - name: Setup Bundler
       run: scripts/setup_bundler.sh
     - name: Integration Test Server
-      run: Functions/Backend/start.sh synchronous
+      run: FirebaseFunctions/Backend/start.sh synchronous
     - name: PodLibLint Functions Cron
       run: |
         scripts/third_party/travis/retry.sh scripts/pod_lib_lint.rb \
           FirebaseFunctions.podspec --platforms=${{ matrix.target }} ${{ matrix.flags }}
 
-  podspec-presubmit:
+  #TODO - reenable once there's a tag with the new directory structure. See #8918 and #8299
+  # podspec-presubmit:
     # Don't run on private repo unless it is a PR.
-    if: github.repository == 'Firebase/firebase-ios-sdk' && github.event.pull_request.merged != true && github.event.action != 'closed'
-    runs-on: macos-11
-    steps:
-    - uses: actions/checkout@v2
-    - name: Setup Bundler
-      run: scripts/setup_bundler.sh
-    - name: Build and test
-      run: scripts/third_party/travis/retry.sh pod spec lint FirebaseFunctions.podspec --skip-tests --sources='https://github.com/firebase/SpecsTesting','https://github.com/firebase/SpecsDev.git','https://github.com/firebase/SpecsStaging.git','https://cdn.cocoapods.org/'
+    # if: github.repository == 'Firebase/firebase-ios-sdk' && github.event.pull_request.merged != true && github.event.action != 'closed'
+    # runs-on: macos-11
+    # steps:
+    # - uses: actions/checkout@v2
+    # - name: Setup Bundler
+    #   run: scripts/setup_bundler.sh
+    # - name: Build and test
+    #   run: scripts/third_party/travis/retry.sh pod spec lint FirebaseFunctions.podspec --skip-tests --sources='https://github.com/firebase/SpecsTesting','https://github.com/firebase/SpecsDev.git','https://github.com/firebase/SpecsStaging.git','https://cdn.cocoapods.org/'

Dangerfile

@@ -92,8 +92,8 @@ has_license_changes = didModify(["LICENSE"])
 @has_dynamiclinks_api_changes = hasChangesIn("FirebaseDynamicLinks/Sources/Public/")
 @has_firestore_changes = hasChangesIn(["Firestore/", "FirebaseFirestore.podspec"])
 @has_firestore_api_changes = hasChangesIn("Firestore/Source/Public/")
-@has_functions_changes = hasChangesIn(["Functions/", "FirebaseFunctions.podspec"])
-@has_functions_api_changes = hasChangesIn("Functions/FirebaseFunctions/Public/")
+@has_functions_changes = hasChangesIn(["FirebaseFunctions/", "FirebaseFunctions.podspec"])
+@has_functions_api_changes = hasChangesIn("FirebaseFunctions/Sources/Public/")
 @has_inappmessaging_changes = hasChangesIn(["FirebaseInAppMessaging"])
 @has_inappmessaging_api_changes = hasChangesIn(["FirebaseInAppMessaging/Sources/Public/"])
 @has_installations_changes = hasChangesIn("FirebaseInstallations")

FirebaseCombineSwift/Tests/Unit/FirebaseCombine-unit-Bridging-Header.h

@@ -22,7 +22,7 @@
 #import "FirebaseCore/Sources/Private/FirebaseCoreInternal.h"
 
 // Firebase Functions
-#import "Functions/FirebaseFunctions/FIRFunctions+Internal.h"
+#import "FirebaseFunctions/Sources/FIRFunctions+Internal.h"
 
 // Firebase Auth
 #import <FirebaseAuth/FIRAuth.h>

FirebaseFunctions.podspec

@@ -24,13 +24,13 @@ Cloud Functions for Firebase.
   s.prefix_header_file = false
 
   s.source_files = [
-    'Functions/FirebaseFunctions/**/*',
+    'FirebaseFunctions/Sources/**/*',
     'Interop/Auth/Public/*.h',
     'FirebaseAppCheck/Sources/Interop/*.h',
     'FirebaseCore/Sources/Private/*.h',
     'FirebaseMessaging/Sources/Interop/FIRMessagingInterop.h',
   ]
-  s.public_header_files = 'Functions/FirebaseFunctions/Public/FirebaseFunctions/*.h'
+  s.public_header_files = 'FirebaseFunctions/Sources/Public/FirebaseFunctions/*.h'
 
   s.dependency 'FirebaseCore', '~> 8.0'
   s.dependency 'GTMSessionFetcher/Core', '~> 1.5'
@@ -43,8 +43,8 @@ Cloud Functions for Firebase.
   s.test_spec 'unit' do |unit_tests|
     unit_tests.scheme = { :code_coverage => true }
     unit_tests.source_files = [
-      'Functions/Example/Test*/*.[mh]',
-      'Functions/Tests/Unit/Swift/**/*',
+      'FirebaseFunctions/Tests/Unit/*.[mh]',
+      'FirebaseFunctions/Tests/SwiftUnit/**/*',
       'SharedTestUtilities/FIRAuthInteropFake*',
       'SharedTestUtilities/FIRMessagingInteropFake*',
       'SharedTestUtilities/AppCheckFake/*.[mh]',
@@ -53,10 +53,9 @@ Cloud Functions for Firebase.
 
   s.test_spec 'integration' do |int_tests|
     int_tests.scheme = { :code_coverage => true }
-    int_tests.source_files = 'Functions/Example/IntegrationTests/*.[mh]',
-                             'Functions/Example/TestUtils/*.[mh]',
+    int_tests.source_files = 'FirebaseFunctions/Tests/Integration/*.[mh]',
+                             'FirebaseFunctions/Tests/Integration/*.plist',
                              'SharedTestUtilities/FIRAuthInteropFake*',
-                             'SharedTestUtilities/FIRMessagingInteropFake*',
-                             'Functions/Example/GoogleService-Info.plist'
+                             'SharedTestUtilities/FIRMessagingInteropFake*'
   end
 end

Functions/FirebaseFunctions/FIRFunctions+Internal.h → FirebaseFunctions/Sources/FIRFunctions+Internal.h

@@ -14,7 +14,7 @@
 
 #import <Foundation/Foundation.h>
 
-#import "Functions/FirebaseFunctions/Public/FirebaseFunctions/FIRFunctions.h"
+#import "FirebaseFunctions/Sources/Public/FirebaseFunctions/FIRFunctions.h"
 
 @protocol FIRAppCheckInterop;
 @protocol FIRAuthInterop;

Functions/FirebaseFunctions/FIRFunctions.m → FirebaseFunctions/Sources/FIRFunctions.m

@@ -14,21 +14,21 @@
 
 #import "FirebaseCore/Sources/Private/FirebaseCoreInternal.h"
 
-#import "Functions/FirebaseFunctions/FIRFunctions+Internal.h"
-#import "Functions/FirebaseFunctions/Public/FirebaseFunctions/FIRFunctions.h"
+#import "FirebaseFunctions/Sources/FIRFunctions+Internal.h"
+#import "FirebaseFunctions/Sources/Public/FirebaseFunctions/FIRFunctions.h"
 
 #import "FirebaseAppCheck/Sources/Interop/FIRAppCheckInterop.h"
+#import "FirebaseFunctions/Sources/FIRFunctionsComponent.h"
 #import "FirebaseMessaging/Sources/Interop/FIRMessagingInterop.h"
-#import "Functions/FirebaseFunctions/FIRFunctionsComponent.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"
+#import "FirebaseFunctions/Sources/FIRHTTPSCallable+Internal.h"
+#import "FirebaseFunctions/Sources/FUNContext.h"
+#import "FirebaseFunctions/Sources/FUNError.h"
+#import "FirebaseFunctions/Sources/FUNSerializer.h"
+#import "FirebaseFunctions/Sources/FUNUsageValidation.h"
+#import "FirebaseFunctions/Sources/Public/FirebaseFunctions/FIRError.h"
+#import "FirebaseFunctions/Sources/Public/FirebaseFunctions/FIRHTTPSCallable.h"
 
 #if SWIFT_PACKAGE
 @import GTMSessionFetcherCore;

Functions/FirebaseFunctions/FIRFunctionsComponent.m → FirebaseFunctions/Sources/FIRFunctionsComponent.m

@@ -14,9 +14,9 @@
 
 #import <os/lock.h>
 
-#import "Functions/FirebaseFunctions/FIRFunctionsComponent.h"
+#import "FirebaseFunctions/Sources/FIRFunctionsComponent.h"
 
-#import "Functions/FirebaseFunctions/FIRFunctions_Private.h"
+#import "FirebaseFunctions/Sources/FIRFunctions_Private.h"
 
 #import "FirebaseCore/Sources/Private/FirebaseCoreInternal.h"
 

Functions/FirebaseFunctions/FIRFunctions_Private.h → FirebaseFunctions/Sources/FIRFunctions_Private.h

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-#import "Functions/FirebaseFunctions/Public/FirebaseFunctions/FIRFunctions.h"
+#import "FirebaseFunctions/Sources/Public/FirebaseFunctions/FIRFunctions.h"
 
 NS_ASSUME_NONNULL_BEGIN
 

Functions/FirebaseFunctions/FIRHTTPSCallable+Internal.h → FirebaseFunctions/Sources/FIRHTTPSCallable+Internal.h

@@ -14,7 +14,7 @@
 
 #import <Foundation/Foundation.h>
 
-#import "Functions/FirebaseFunctions/Public/FirebaseFunctions/FIRHTTPSCallable.h"
+#import "FirebaseFunctions/Sources/Public/FirebaseFunctions/FIRHTTPSCallable.h"
 
 @class FIRFunctions;
 

Functions/FirebaseFunctions/FIRHTTPSCallable.m → FirebaseFunctions/Sources/FIRHTTPSCallable.m

@@ -12,11 +12,11 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-#import "Functions/FirebaseFunctions/Public/FirebaseFunctions/FIRHTTPSCallable.h"
-#import "Functions/FirebaseFunctions/FIRHTTPSCallable+Internal.h"
+#import "FirebaseFunctions/Sources/Public/FirebaseFunctions/FIRHTTPSCallable.h"
+#import "FirebaseFunctions/Sources/FIRHTTPSCallable+Internal.h"
 
-#import "Functions/FirebaseFunctions/FIRFunctions+Internal.h"
-#import "Functions/FirebaseFunctions/FUNUsageValidation.h"
+#import "FirebaseFunctions/Sources/FIRFunctions+Internal.h"
+#import "FirebaseFunctions/Sources/FUNUsageValidation.h"
 
 NS_ASSUME_NONNULL_BEGIN
 

Functions/FirebaseFunctions/FUNContext.m → FirebaseFunctions/Sources/FUNContext.m

@@ -13,7 +13,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-#import "Functions/FirebaseFunctions/FUNContext.h"
+#import "FirebaseFunctions/Sources/FUNContext.h"
 
 #import "FirebaseAppCheck/Sources/Interop/FIRAppCheckInterop.h"
 #import "FirebaseAppCheck/Sources/Interop/FIRAppCheckTokenResultInterop.h"

Functions/FirebaseFunctions/FUNError.h → FirebaseFunctions/Sources/FUNError.h

@@ -14,7 +14,7 @@
 // limitations under the License.
 
 #import <Foundation/Foundation.h>
-#import "Functions/FirebaseFunctions/Public/FirebaseFunctions/FIRError.h"
+#import "FirebaseFunctions/Sources/Public/FirebaseFunctions/FIRError.h"
 
 @class FUNSerializer;
 

Functions/FirebaseFunctions/FUNError.m → FirebaseFunctions/Sources/FUNError.m

@@ -13,9 +13,9 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-#import "Functions/FirebaseFunctions/FUNError.h"
+#import "FirebaseFunctions/Sources/FUNError.h"
 
-#import "Functions/FirebaseFunctions/FUNSerializer.h"
+#import "FirebaseFunctions/Sources/FUNSerializer.h"
 
 NS_ASSUME_NONNULL_BEGIN
 

Functions/FirebaseFunctions/FUNSerializer.m → FirebaseFunctions/Sources/FUNSerializer.m

@@ -12,10 +12,10 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-#import "Functions/FirebaseFunctions/FUNSerializer.h"
+#import "FirebaseFunctions/Sources/FUNSerializer.h"
 
-#import "Functions/FirebaseFunctions/FUNUsageValidation.h"
-#import "Functions/FirebaseFunctions/Public/FirebaseFunctions/FIRError.h"
+#import "FirebaseFunctions/Sources/FUNUsageValidation.h"
+#import "FirebaseFunctions/Sources/Public/FirebaseFunctions/FIRError.h"
 
 NS_ASSUME_NONNULL_BEGIN
 

Functions/FirebaseFunctions/FUNUsageValidation.m → FirebaseFunctions/Sources/FUNUsageValidation.m

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-#import "Functions/FirebaseFunctions/FUNUsageValidation.h"
+#import "FirebaseFunctions/Sources/FUNUsageValidation.h"
 
 NS_ASSUME_NONNULL_BEGIN
 

Functions/Example/IntegrationTests/FIRIntegrationTests.m → FirebaseFunctions/Tests/Integration/FIRIntegrationTests.m

@@ -16,11 +16,11 @@
 
 #import "FirebaseCore/Sources/Private/FirebaseCoreInternal.h"
 
-#import "FIRAuthInteropFake.h"
-#import "Functions/FirebaseFunctions/FIRFunctions+Internal.h"
-#import "Functions/FirebaseFunctions/Public/FirebaseFunctions/FIRError.h"
-#import "Functions/FirebaseFunctions/Public/FirebaseFunctions/FIRFunctions.h"
-#import "Functions/FirebaseFunctions/Public/FirebaseFunctions/FIRHTTPSCallable.h"
+#import "FirebaseFunctions/Sources/FIRFunctions+Internal.h"
+#import "FirebaseFunctions/Sources/Public/FirebaseFunctions/FIRError.h"
+#import "FirebaseFunctions/Sources/Public/FirebaseFunctions/FIRFunctions.h"
+#import "FirebaseFunctions/Sources/Public/FirebaseFunctions/FIRHTTPSCallable.h"
+#import "SharedTestUtilities/FIRAuthInteropFake.h"
 #import "SharedTestUtilities/FIRMessagingInteropFake.h"
 
 // Project ID used by these tests.

Functions/Example/Tests/FIRFunctionsTests.m → FirebaseFunctions/Tests/Unit/FIRFunctionsTests.m

@@ -14,8 +14,8 @@
 
 #import <XCTest/XCTest.h>
 
-#import "Functions/FirebaseFunctions/FIRFunctions+Internal.h"
-#import "Functions/FirebaseFunctions/Public/FirebaseFunctions/FIRFunctions.h"
+#import "FirebaseFunctions/Sources/FIRFunctions+Internal.h"
+#import "FirebaseFunctions/Sources/Public/FirebaseFunctions/FIRFunctions.h"
 
 #import "SharedTestUtilities/AppCheckFake/FIRAppCheckFake.h"
 #import "SharedTestUtilities/AppCheckFake/FIRAppCheckTokenResultFake.h"

Functions/Example/Tests/FUNContextProviderTests.m → FirebaseFunctions/Tests/Unit/FUNContextProviderTests.m

@@ -14,11 +14,11 @@
 
 #import <XCTest/XCTest.h>
 
-#import "FIRAuthInteropFake.h"
-#import "Functions/FirebaseFunctions/FUNContext.h"
+#import "FirebaseFunctions/Sources/FUNContext.h"
 
 #import "SharedTestUtilities/AppCheckFake/FIRAppCheckFake.h"
 #import "SharedTestUtilities/AppCheckFake/FIRAppCheckTokenResultFake.h"
+#import "SharedTestUtilities/FIRAuthInteropFake.h"
 #import "SharedTestUtilities/FIRMessagingInteropFake.h"
 
 @interface FUNContextProviderTests : XCTestCase

Functions/Example/Tests/FUNSerializerTests.m → FirebaseFunctions/Tests/Unit/FUNSerializerTests.m

@@ -14,8 +14,8 @@
 
 #import <XCTest/XCTest.h>
 
-#import "Functions/FirebaseFunctions/FUNSerializer.h"
-#import "Functions/FirebaseFunctions/Public/FirebaseFunctions/FIRError.h"
+#import "FirebaseFunctions/Sources/FUNSerializer.h"
+#import "FirebaseFunctions/Sources/Public/FirebaseFunctions/FIRError.h"
 
 @interface FUNSerializerTests : XCTestCase
 @end

Functions/Example/GoogleService-Info.plist

@@ -1,28 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
-<plist version="1.0">
-<dict>
-	<key>API_KEY</key>
-	<string>correct_api_key</string>
-	<key>TRACKING_ID</key>
-	<string>correct_tracking_id</string>
-	<key>CLIENT_ID</key>
-	<string>correct_client_id</string>
-	<key>REVERSED_CLIENT_ID</key>
-	<string>correct_reversed_client_id</string>
-	<key>GOOGLE_APP_ID</key>
-	<string>1:123:ios:123abc</string>
-	<key>GCM_SENDER_ID</key>
-	<string>correct_gcm_sender_id</string>
-	<key>PLIST_VERSION</key>
-	<string>1</string>
-	<key>BUNDLE_ID</key>
-	<string>com.google.FirebaseSDKTests</string>
-	<key>PROJECT_ID</key>
-	<string>abc-xyz-123</string>
-	<key>DATABASE_URL</key>
-	<string>https://abc-xyz-123.firebaseio.com</string>
-	<key>STORAGE_BUCKET</key>
-	<string>project-id-123.storage.firebase.com</string>
-</dict>
-</plist>

Package.swift

@@ -662,7 +662,7 @@ let package = Package(
         "FirebaseCore",
         .product(name: "GTMSessionFetcherCore", package: "GTMSessionFetcher"),
       ],
-      path: "Functions/FirebaseFunctions",
+      path: "FirebaseFunctions/Sources",
       publicHeadersPath: "Public",
       cSettings: [
         .headerSearchPath("../../"),
@@ -678,13 +678,13 @@ let package = Package(
       dependencies: ["FirebaseFunctionsCombineSwift",
                      "FirebaseFunctionsTestingSupport",
                      "SharedTestUtilities"],
-      path: "Functions/Tests/CombineUnit"
+      path: "FirebaseFunctions/Tests/CombineUnit"
     ),
     .testTarget(
       name: "FunctionsUnit",
       dependencies: ["FirebaseFunctions",
                      "SharedTestUtilities"],
-      path: "Functions/Example/Tests/",
+      path: "FirebaseFunctions/Tests/Unit",
       cSettings: [
         .headerSearchPath("../../../"),
       ]
@@ -692,7 +692,7 @@ let package = Package(
     .testTarget(
       name: "FunctionsUnitSwift",
       dependencies: ["FirebaseFunctions"],
-      path: "Functions/Tests/Unit/Swift"
+      path: "FirebaseFunctions/Tests/SwiftUnit"
     ),
     .target(
       name: "FirebaseFunctionsTestingSupport",

scripts/change_headers.swift

@@ -26,7 +26,7 @@ let findHeaders = ["FirebaseMessaging"]
 let changeImports = ["GoogleUtilities", "FirebaseAuth", "FirebaseCore", "Firebase",
                      "FirebaseDatabase", "GoogleDataTransport",
                      "FirebaseDynamicLinks", "FirebaseInAppMessaging", "FirebaseMessaging",
-                     "FirebaseRemoteConfig", "FirebaseInstallations", "Functions",
+                     "FirebaseRemoteConfig", "FirebaseInstallations", "FirebaseFunctions",
                      "FirebaseABTesting",
                      "FirebaseAppDistribution", "Example", "Crashlytics", "FirebaseStorage"]
 
@@ -34,7 +34,7 @@ let changeImports = ["GoogleUtilities", "FirebaseAuth", "FirebaseCore", "Firebas
 // and unit tests.
 let skipDirPatterns = ["/Sample/", "/Pods/", "FirebaseStorage/Tests/Integration",
                        "FirebaseInAppMessaging/Tests/Integration/",
-                       ".build/", "Functions/Example/FirebaseFunctions"]
+                       ".build/"]
 
 // Get a Dictionary mapping a simple header name to a repo-relative path.
 

scripts/check_no_module_imports.sh

@@ -35,7 +35,8 @@ git grep "${options[@]}" \
      ':(exclude,glob)FirebaseStorage/**' \
      ':(exclude,glob)SwiftPMTests/**' \
      ':(exclude,glob)FirebaseTestingSupport/**' \
-     ':(exclude)Functions/FirebaseFunctions/FIRFunctions.m' \
+     ':(exclude)FirebaseFunctions/Sources/FIRFunctions.m' \
+     ':(exclude)FirebaseFunctions/Tests/Unit/FIRFunctionsTests.m' \
      ':(exclude)HeadersImports.md' && exit_with_error
 
 # Tests are under the Example directory, so we have to separately grep them for

scripts/install_prereqs.sh

@@ -91,7 +91,7 @@ case "$project-$platform-$method" in
 
   Functions-*)
     # Start server for Functions integration tests.
-    ./Functions/Backend/start.sh synchronous
+    ./FirebaseFunctions/Backend/start.sh synchronous
     ;;
 
   Storage-*)

scripts/make_release_notes.py

@@ -41,7 +41,7 @@ PRODUCTS = {
     'FirebaseMessaging/CHANGELOG.md': '{{messaging}}',
     'FirebaseStorage/CHANGELOG.md': '{{storage}}',
     'Firestore/CHANGELOG.md': '{{firestore}}',
-    'Functions/CHANGELOG.md': '{{cloud_functions}}',
+    'FirebaseFunctions/CHANGELOG.md': '{{cloud_functions}}',
     'FirebaseRemoteConfig/CHANGELOG.md': '{{remote_config}}',
     'FirebasePerformance/CHANGELOG.md': '{{perfmon}}',
 }