Merge pull request #195 from woshimaliang/dynamic_framework

woshimaliang · web-flow · commit f96b65754525 · 2021-09-24T10:32:09.000-07:00
Introduce is_dynamic_framework config for dynamic frameworks support
diff --git a/.gitignore b/.gitignore
@@ -16,3 +16,4 @@ Pods/
 PodsHost/
 *.xcworkspace
 PodToBUILD.zip
+.DS_Store
diff --git a/BazelExtensions/workspace.bzl b/BazelExtensions/workspace.bzl
@@ -151,6 +151,8 @@ def _impl(repository_ctx):
                 _cli_bool(repository_ctx.attr.generate_module_map),
                 "--vendorize",
                 _cli_bool(False),
+                "--is_dynamic_framework",
+                _cli_bool(repository_ctx.attr.is_dynamic_framework),
             ])
             substitutions[INIT_REPO_PLACEHOLDER] = " ".join(entry)
         else:
@@ -209,6 +211,7 @@ pod_repo_ = repository_rule(
         "enable_modules": attr.bool(default=False, mandatory=True),
         "generate_module_map": attr.bool(default=False, mandatory=True),
         "header_visibility": attr.string(),
+        "is_dynamic_framework": attr.bool(default=False, mandatory=False),
     }
 )
 
@@ -227,6 +230,7 @@ def new_pod_repository(name,
                        enable_modules=True,
                        generate_module_map=None,
                        header_visibility="pod_support",
+                       is_dynamic_framework=False,
                        ):
     """Declare a repository for a Pod
     Args:
@@ -289,6 +293,8 @@ def new_pod_repository(name,
 
          header_visibility: DEPRECATED: This is replaced by headermaps:
          https://github.com/bazelbuild/bazel/pull/3712
+
+         is_dynamic_framework: set to True if the pod uses prebuilt dynamic framework(s)
     """
     if generate_module_map == None:
         generate_module_map = enable_modules
@@ -316,5 +322,6 @@ def new_pod_repository(name,
         trace=trace,
         enable_modules=enable_modules,
         generate_module_map=generate_module_map,
-        header_visibility=header_visibility
+        header_visibility=header_visibility,
+        is_dynamic_framework=is_dynamic_framework,
     )
diff --git a/Examples/SnapSDK/.bazelrc b/Examples/SnapSDK/.bazelrc
@@ -0,0 +1,11 @@
+# A few settings for XCHammer's .bazelrc
+# Debugging: Use the remapping feature of rules_swift.
+build \
+ --spawn_strategy=local \
+ --strategy=SwiftCompile=worker \
+ --swiftcopt=-Xwrapped-swift=-debug-prefix-pwd-is-dot \
+ --experimental_strict_action_env=true
+
+test \
+ --spawn_strategy=local \
+
diff --git a/Examples/SnapSDK/.bazelversion b/Examples/SnapSDK/.bazelversion
@@ -0,0 +1 @@
+4.0.0
diff --git a/Examples/SnapSDK/BUILD b/Examples/SnapSDK/BUILD
@@ -0,0 +1,29 @@
+load("@build_bazel_rules_apple//apple:ios.bzl", "ios_application")
+load("@rules_cc//cc:defs.bzl", "objc_library")
+
+# This is needed for implicit entitlement rules created for
+# files.
+package(default_visibility = ["//visibility:public"])
+
+ios_application(
+    name = "ios-app",
+    bundle_id = "com.lma",
+    families = ["iphone"],
+    infoplists = ["Info.plist"],
+    visibility = ["//visibility:public"],
+    deps = ["ios-app-bin"],
+    minimum_os_version = "9.3"
+)
+
+objc_library(
+    name = "ios-app-bin",
+    srcs = [
+        "main.m",
+    ],
+    enable_modules = True,
+    deps = [
+        "//Vendor/SnapSDK:SCSDKCreativeKit",
+    ],
+    sdk_frameworks = ["UIKit", "CoreGraphics"]
+)
+
diff --git a/Examples/SnapSDK/Info.plist b/Examples/SnapSDK/Info.plist
@@ -0,0 +1,28 @@
+<?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>CFBundleDevelopmentRegion</key>
+	<string>en</string>
+	<key>CFBundleDisplayName</key>
+	<string>ios-app</string>
+	<key>CFBundleExecutable</key>
+	<string>ios-app</string>
+	<key>CFBundleIdentifier</key>
+	<string>com.lma</string>
+	<key>CFBundleInfoDictionaryVersion</key>
+	<string>6.0</string>
+	<key>CFBundleName</key>
+	<string>ios-app</string>
+	<key>CFBundlePackageType</key>
+	<string>APPL</string>
+	<key>CFBundleShortVersionString</key>
+	<string>1.0</string>
+	<key>CFBundleSignature</key>
+	<string>????</string>
+	<key>CFBundleVersion</key>
+	<string>1.0</string>
+	<key>LSRequiresIPhoneOS</key>
+	<true/>
+</dict>
+</plist>
diff --git a/Examples/SnapSDK/Makefile b/Examples/SnapSDK/Makefile
@@ -0,0 +1 @@
+../Example.Makefile
diff --git a/Examples/SnapSDK/Pods.WORKSPACE b/Examples/SnapSDK/Pods.WORKSPACE
@@ -0,0 +1,7 @@
+new_pod_repository(
+  name = "SnapSDK",
+  url = "https://storage.googleapis.com/snap-kit-build/scsdk/ios/release/latest/SCSDK-1.4.0.tar.gz",
+  podspec_url = "SnapSDK.podspec.json",
+  strip_prefix = "SCSDK",
+  is_dynamic_framework = True  # SnapSDK is dynamic framework, is_dynamic_framework:True will enable apple_dynamic_framework_import
+)
diff --git a/Examples/SnapSDK/SnapSDK.podspec.json b/Examples/SnapSDK/SnapSDK.podspec.json
@@ -0,0 +1,29 @@
+{
+  "name": "SnapSDK",
+  "version": "1.4.0",
+  "summary": "Snap Kit lets developers like you integrate some of Snapchat’s best features across your platform.",
+  "homepage": "https://kit.snapchat.com",
+  "license": {
+    "type": "Snap Developer Terms of Service",
+    "file": "LICENSE"
+  },
+  "authors": "Snap",
+  "platforms": {
+    "ios": "9.0"
+  },
+  "documentation_url": "https://docs.snapchat.com/docs/",
+  "source": {
+    "http": "https://storage.googleapis.com/snap-kit-build/scsdk/ios/release/latest/SCSDK-1.4.0.tar.gz",
+    "type": "tgz"
+  },
+  "default_subspecs": ["SCSDKCreativeKit"], 
+  "subspecs": [
+    {
+      "name": "SCSDKCreativeKit",
+      "vendored_frameworks": [
+        "SCSDKCreativeKit.framework",
+        "SCSDKCoreKit.framework"
+      ]
+    }
+  ]
+}
diff --git a/Examples/SnapSDK/WORKSPACE b/Examples/SnapSDK/WORKSPACE
@@ -0,0 +1,42 @@
+load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
+
+http_archive(
+    name = "rules_pods",
+    urls = ["https://note-this-is-overridden"],
+)
+
+load("@rules_pods//BazelExtensions:workspace.bzl", "new_pod_repository")
+
+http_archive(
+    name = "build_bazel_rules_apple",
+    sha256 = "a41a75c291c69676b9974458ceee09aea60cee0e1ee282e27cdc90b679dfd30f",
+    url = "https://github.com/bazelbuild/rules_apple/releases/download/0.21.2/rules_apple.0.21.2.tar.gz",
+)
+
+load(
+    "@build_bazel_rules_apple//apple:repositories.bzl",
+    "apple_rules_dependencies",
+)
+
+apple_rules_dependencies()
+
+load(
+    "@build_bazel_apple_support//lib:repositories.bzl",
+    "apple_support_dependencies",
+)
+
+apple_support_dependencies()
+
+load(
+    "@build_bazel_rules_swift//swift:repositories.bzl",
+    "swift_rules_dependencies",
+)
+
+swift_rules_dependencies()
+
+load(
+    "@com_google_protobuf//:protobuf_deps.bzl",
+    "protobuf_deps",
+)
+
+protobuf_deps()
diff --git a/Examples/SnapSDK/main.m b/Examples/SnapSDK/main.m
@@ -0,0 +1,9 @@
+#import <SnapSDK/SCSDKCreativeKit.h>
+
+int main(int argc, char * argv[]) {
+    
+    SCSDKSnapAPI *obj = [[SCSDKSnapAPI alloc] init];
+    NSLog(@"%@", obj);
+    
+    return 0;
+}
diff --git a/README.md b/README.md
@@ -249,6 +249,8 @@ there is no need to add an entry for them.
 
 `header_visibility`: DEPRECATED: This is replaced by headermaps: https://github.com/Bazelbuild/Bazel/pull/3712
 
+`is_dynamic_framework`: set to True if the pod uses prebuilt dynamic framework(s) 
+
 ### Known Complications
 
 ### Incompatible file paths
diff --git a/Sources/PodToBUILD/BuildFile.swift b/Sources/PodToBUILD/BuildFile.swift
@@ -44,12 +44,15 @@ public func makeLoadNodes(forConvertibles skylarkConvertibles: [SkylarkConvertib
     let hasSwift = skylarkConvertibles.first(where: { $0 is SwiftLibrary }) != nil
     let hasAppleBundleImport = skylarkConvertibles.first(where: { $0 is AppleBundleImport }) != nil
     let hasAppleResourceBundle = skylarkConvertibles.first(where: { $0 is AppleResourceBundle }) != nil
-    let hasAppleStaticFrameworkImport = skylarkConvertibles.first(where: { $0 is AppleStaticFrameworkImport }) != nil
+    let hasAppleFrameworkImport = skylarkConvertibles.first(where: { $0 is AppleFrameworkImport }) != nil
+    let isDynamicFramework = GetBuildOptions().isDynamicFramework
+    
     return .lines( [
         hasSwift ?  SkylarkNode.skylark("load('@build_bazel_rules_swift//swift:swift.bzl', 'swift_library')") : nil,
         hasAppleBundleImport ?  SkylarkNode.skylark("load('@build_bazel_rules_apple//apple:resources.bzl', 'apple_bundle_import')") : nil,
         hasAppleResourceBundle ?  SkylarkNode.skylark("load('@build_bazel_rules_apple//apple:resources.bzl', 'apple_resource_bundle')") : nil,
-        hasAppleStaticFrameworkImport ?  SkylarkNode.skylark("load('@build_bazel_rules_apple//apple:apple.bzl', 'apple_static_framework_import')") : nil,
+        hasAppleFrameworkImport && isDynamicFramework ?  SkylarkNode.skylark("load('@build_bazel_rules_apple//apple:apple.bzl', 'apple_dynamic_framework_import')") : nil,
+        hasAppleFrameworkImport && !isDynamicFramework ?  SkylarkNode.skylark("load('@build_bazel_rules_apple//apple:apple.bzl', 'apple_static_framework_import')") : nil,
         ].compactMap { $0 }
     )
 }
@@ -193,7 +196,7 @@ public struct PodBuildFile: SkylarkConvertible {
 
     private static func vendoredFrameworks(withPodspec spec: PodSpec) -> [BazelTarget] {
         let frameworks = spec.attr(\.vendoredFrameworks)
-        return frameworks.isEmpty ? [] : [AppleStaticFrameworkImport(name: "\(spec.moduleName ?? spec.name)_VendoredFrameworks", frameworkImports: frameworks)]
+        return frameworks.isEmpty ? [] : [AppleFrameworkImport(name: "\(spec.moduleName ?? spec.name)_VendoredFrameworks", frameworkImports: frameworks)]
     }
 
     private static func vendoredLibraries(withPodspec spec: PodSpec) -> [BazelTarget] {
diff --git a/Sources/PodToBUILD/BuildOptions.swift b/Sources/PodToBUILD/BuildOptions.swift
@@ -24,6 +24,7 @@ public protocol BuildOptions {
     var alwaysSplitRules: Bool { get }
     var vendorize: Bool { get }
     var childPaths: [String] { get }
+    var isDynamicFramework: Bool { get }
 }
 
 public struct BasicBuildOptions: BuildOptions {
@@ -40,6 +41,7 @@ public struct BasicBuildOptions: BuildOptions {
     public let alwaysSplitRules: Bool
     public let vendorize: Bool
     public let childPaths: [String]
+    public let isDynamicFramework: Bool
 
     public init(podName: String = "",
                 path: String = ".",
@@ -52,7 +54,8 @@ public struct BasicBuildOptions: BuildOptions {
                 headerVisibility: String = "",
                 alwaysSplitRules: Bool = true,
                 vendorize: Bool = true,
-                childPaths: [String] = []
+                childPaths: [String] = [],
+                isDynamicFramework: Bool = false
     ) {
         self.podName = podName
         self.path = path
@@ -66,6 +69,7 @@ public struct BasicBuildOptions: BuildOptions {
         self.alwaysSplitRules = alwaysSplitRules
         self.vendorize = vendorize
         self.childPaths = childPaths
+        self.isDynamicFramework = isDynamicFramework
     }
 
     public static let empty = BasicBuildOptions(podName: "")
diff --git a/Sources/PodToBUILD/ObjcLibrary.swift b/Sources/PodToBUILD/ObjcLibrary.swift
@@ -89,18 +89,14 @@ public struct ConfigSetting: BazelTarget {
 }
 
 // https://github.com/bazelbuild/rules_apple/blob/818e795208ae3ca1cf1501205549d46e6bc88d73/doc/rules-general.md#apple_static_framework_import
-public struct AppleStaticFrameworkImport: BazelTarget {
+public struct AppleFrameworkImport: BazelTarget {
     public let name: String // A unique name for this rule.
     public let frameworkImports: AttrSet<[String]> // The list of files under a .framework directory which are provided to Objective-C targets that depend on this target.
 
     public var acknowledged: Bool {
         return true
     }
 
-    // FIXME: provide an API for apple_dynamic_framework_import.
-    // Assume that every framework is static.
-    // Typically CocoaPods supports either dynamic or static,
-    // so for the most part, this should be fine.
     // apple_static_framework_import(
     //     name = "OCMock",
     //     framework_imports = [
@@ -109,8 +105,10 @@ public struct AppleStaticFrameworkImport: BazelTarget {
     //     visibility = ["visibility:public"]
     // )
     public func toSkylark() -> SkylarkNode {
+        let isDynamicFramework = GetBuildOptions().isDynamicFramework
+
         return SkylarkNode.functionCall(
-                name: "apple_static_framework_import",
+            name: isDynamicFramework ? "apple_dynamic_framework_import" : "apple_static_framework_import",
                 arguments: [SkylarkFunctionArgument]([
                     .named(name: "name", value: .string(name)),
                     .named(name: "framework_imports",
diff --git a/Sources/RepoToolsCore/RepoActions.swift b/Sources/RepoToolsCore/RepoActions.swift
@@ -106,6 +106,7 @@ public enum SerializedRepoToolsAction {
             "--vendorize": .bool,
             "--header_visibility": .string,
             "--child_path": .stringList,
+            "--is_dynamic_framework": .bool,
         ]
 
         var idx = 0
@@ -164,7 +165,8 @@ public enum SerializedRepoToolsAction {
                                  headerVisibility: parsed["--header_visibility"]?.first as? String ?? "",
                                  alwaysSplitRules: false,
                                  vendorize: parsed["--vendorize"]?.first as? Bool ?? true,
-                                 childPaths: parsed["--child_path"] as? [String] ?? []
+                                 childPaths: parsed["--child_path"] as? [String] ?? [],
+                                 isDynamicFramework: parsed["--is_dynamic_framework"]?.first as? Bool ?? false
         )
     }
 }
@@ -451,7 +453,7 @@ public enum RepoActions {
                         $0.formUnion($1.sourcesOnDisk())
                     })
                 }
-                if let fwImport = convertible as? AppleStaticFrameworkImport {
+                if let fwImport = convertible as? AppleFrameworkImport {
                     globResults.formUnion(fwImport.frameworkImports.trivialize(into: Set<String>()) {
                         accum, next in
                         let HeaderFileTypes = Set([".h", ".hpp", ".hxx"])
diff --git a/bin/update_pods.py b/bin/update_pods.py
@@ -97,6 +97,7 @@ def __init__(self,
             generate_module_map = False,
             generate_header_map = True,
             header_visibility = "pod_support",
+            is_dynamic_framework = False,
             src_root = None):
         self.target_name = target_name
         self.url = url
@@ -110,6 +111,7 @@ def __init__(self,
         self.generate_module_map = generate_module_map
         self.generate_header_map = generate_header_map
         self.header_visibility = header_visibility
+        self.is_dynamic_framework = is_dynamic_framework
         self.src_root = src_root
 
     def GetPodRootDir(self):
@@ -298,7 +300,9 @@ def _update_repo_impl(invocation_info):
                 "--generate_module_map",
                 _cli_bool(repository_ctx.generate_module_map),
                 "--generate_header_map",
-                _cli_bool(repository_ctx.generate_header_map)
+                _cli_bool(repository_ctx.generate_header_map),
+                "--is_dynamic_framework",
+                _cli_bool(repository_ctx.is_dynamic_framework)
             ])
 
             for child_pod in invocation_info.child_pods:
@@ -355,7 +359,8 @@ def new_pod_repository(name,
             generate_module_map = False,
             generate_header_map = False,
             owner = "", # This is a Noop
-            header_visibility = "pod_support"):
+            header_visibility = "pod_support",
+            is_dynamic_framework = False):
     """Declare a repository for a Pod
     Args:
          name: the name of this repo
@@ -416,6 +421,8 @@ def new_pod_repository(name,
 
          header_visibility: DEPRECATED: This is replaced by headermaps:
          https://github.com/bazelbuild/bazel/pull/3712
+
+         is_dynamic_framework: set to True if the pod uses prebuilt dynamic framework(s)
     """
 
     # The SRC_ROOT is the directory of the WORKSPACE and Pods.WORKSPACE
@@ -435,6 +442,7 @@ def new_pod_repository(name,
             generate_module_map = generate_module_map,
             generate_header_map = generate_header_map,
             header_visibility = header_visibility,
+            is_dynamic_framework = is_dynamic_framework,
             src_root = SRC_ROOT)
     WORKSPACE.add(repository_ctx)
 
