-
Notifications
You must be signed in to change notification settings - Fork 4.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
library: migrate public/feature layer of iOS library to Swift
Co-authored-by: Keith Smiley [email protected] Signed-off-by: Mike Schore [email protected] Description: We've decided to implement our public and platform-specific library layer primarily in Swift on iOS. Migrating to this has some repercussions for the build and for the time-being will require custom Bazel rules to compose the distributable static framework. This PR migrates the code to swift and introduces the build rules required. Note: this PR breaks objective-c. This is known and an issue has been filed #230. Risk Level: Medium - moves pieces of the library to swift, and introduces new build rules. Testing: CI Signed-off-by: Mike Schore <[email protected]> Signed-off-by: JP Simard <[email protected]>
- Loading branch information
Showing
11 changed files
with
338 additions
and
51 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,183 @@ | ||
| """ | ||
| This rules creates a fat static framework that can be included later with | ||
| static_framework_import | ||
| """ | ||
|
|
||
| load("@build_bazel_apple_support//lib:apple_support.bzl", "apple_support") | ||
| load("@build_bazel_rules_swift//swift:swift.bzl", "SwiftInfo", "swift_library") | ||
|
|
||
| MINIMUM_IOS_VERSION = "10.0" | ||
|
|
||
| _PLATFORM_TO_SWIFTMODULE = { | ||
| "ios_armv7": "arm", | ||
| "ios_arm64": "arm64", | ||
| "ios_i386": "i386", | ||
| "ios_x86_64": "x86_64", | ||
| } | ||
|
|
||
| def _zip_binary_arg(module_name, input_file): | ||
| return "{module_name}.framework/{module_name}={file_path}".format( | ||
| module_name = module_name, | ||
| file_path = input_file.path, | ||
| ) | ||
|
|
||
| def _zip_swift_arg(module_name, swift_identifier, input_file): | ||
| return "{module_name}.framework/Modules/{module_name}.swiftmodule/{swift_identifier}.{ext}={file_path}".format( | ||
| module_name = module_name, | ||
| swift_identifier = swift_identifier, | ||
| ext = input_file.extension, | ||
| file_path = input_file.path, | ||
| ) | ||
|
|
||
| def _swift_static_framework_impl(ctx): | ||
| module_name = ctx.attr.framework_name | ||
| fat_file = ctx.outputs.fat_file | ||
|
|
||
| input_archives = [] | ||
| input_modules_docs = [] | ||
| zip_args = [_zip_binary_arg(module_name, fat_file)] | ||
|
|
||
| for platform, archive in ctx.split_attr.archive.items(): | ||
| swiftmodule_identifier = _PLATFORM_TO_SWIFTMODULE[platform] | ||
| if not swiftmodule_identifier: | ||
| fail("Unhandled platform '{}'".format(platform)) | ||
|
|
||
| swift_info = archive[SwiftInfo] | ||
| swiftdoc = swift_info.direct_swiftdocs[0] | ||
| swiftmodule = swift_info.direct_swiftmodules[0] | ||
|
|
||
| libraries = archive[CcInfo].linking_context.libraries_to_link | ||
| archives = [] | ||
| for library in libraries: | ||
| archive = library.pic_static_library or library.static_library | ||
| if archive: | ||
| archives.append(archive) | ||
| else: | ||
| fail("All linked dependencies must be static") | ||
|
|
||
| platform_archive = ctx.actions.declare_file("{}.{}.a".format(module_name, platform)) | ||
|
|
||
| libtool_args = ["-no_warning_for_no_symbols", "-static", "-syslibroot", "__BAZEL_XCODE_SDKROOT__", "-o", platform_archive.path] + [x.path for x in archives] | ||
| apple_support.run( | ||
| ctx, | ||
| inputs = archives, | ||
| outputs = [platform_archive], | ||
| mnemonic = "LibtoolLinkedLibraries", | ||
| progress_message = "Combining libraries for {} on {}".format(module_name, platform), | ||
| executable = ctx.executable._libtool, | ||
| arguments = libtool_args, | ||
| ) | ||
|
|
||
| input_archives.append(platform_archive) | ||
|
|
||
| input_modules_docs += [swiftdoc, swiftmodule] | ||
| zip_args += [ | ||
| _zip_swift_arg(module_name, swiftmodule_identifier, swiftdoc), | ||
| _zip_swift_arg(module_name, swiftmodule_identifier, swiftmodule), | ||
| ] | ||
|
|
||
| ctx.actions.run( | ||
| inputs = input_archives, | ||
| outputs = [fat_file], | ||
| mnemonic = "LipoPlatformLibraries", | ||
| progress_message = "Creating fat library for {}".format(module_name), | ||
| executable = "lipo", | ||
| arguments = ["-create", "-output", fat_file.path] + [x.path for x in input_archives], | ||
| ) | ||
|
|
||
| output_file = ctx.outputs.output_file | ||
| ctx.actions.run( | ||
| inputs = input_modules_docs + [fat_file], | ||
| outputs = [output_file], | ||
| mnemonic = "CreateFrameworkZip", | ||
| progress_message = "Creating framework zip for {}".format(module_name), | ||
| executable = ctx.executable._zipper, | ||
| arguments = ["c", output_file.path] + zip_args, | ||
| ) | ||
|
|
||
| return [ | ||
| DefaultInfo( | ||
| files = depset([output_file]), | ||
| ), | ||
| ] | ||
|
|
||
| _swift_static_framework = rule( | ||
| attrs = dict( | ||
| apple_support.action_required_attrs(), | ||
| _libtool = attr.label( | ||
| default = "@bazel_tools//tools/objc:libtool", | ||
| cfg = "host", | ||
| executable = True, | ||
| ), | ||
| _zipper = attr.label( | ||
| default = "@bazel_tools//tools/zip:zipper", | ||
| cfg = "host", | ||
| executable = True, | ||
| ), | ||
| archive = attr.label( | ||
| mandatory = True, | ||
| providers = [ | ||
| CcInfo, | ||
| SwiftInfo, | ||
| ], | ||
| cfg = apple_common.multi_arch_split, | ||
| ), | ||
| framework_name = attr.string(mandatory = True), | ||
| minimum_os_version = attr.string(default = MINIMUM_IOS_VERSION), | ||
| platform_type = attr.string( | ||
| default = str(apple_common.platform_type.ios), | ||
| ), | ||
| ), | ||
| fragments = [ | ||
| "apple", | ||
| ], | ||
| outputs = { | ||
| "fat_file": "%{framework_name}.fat", | ||
| "output_file": "%{framework_name}.zip", | ||
| }, | ||
| implementation = _swift_static_framework_impl, | ||
| ) | ||
|
|
||
| def swift_static_framework( | ||
| name, | ||
| module_name = None, | ||
| srcs = [], | ||
| deps = [], | ||
| objc_includes = [], | ||
| copts = [], | ||
| swiftc_inputs = [], | ||
| visibility = []): | ||
| """Create a static library, and static framework target for a swift module | ||
| Args: | ||
| name: The name of the module, the framework's name will be this name | ||
| appending Framework so you can depend on this from other modules | ||
| srcs: Custom source paths for the swift files | ||
| objc_includes: Header files for any objective-c dependencies (required for linking) | ||
| copts: Any custom swiftc opts passed through to the swift_library | ||
| swiftc_inputs: Any labels that require expansion for copts (would also apply to linkopts) | ||
| deps: Any deps the swift_library requires | ||
| """ | ||
| archive_name = name + "_archive" | ||
| module_name = module_name or name + "_framework" | ||
| if objc_includes: | ||
| locations = ["$(location {})".format(x) for x in objc_includes] | ||
| copts = copts + ["-import-objc-header"] + locations | ||
| swiftc_inputs = swiftc_inputs + objc_includes | ||
|
|
||
| swift_library( | ||
| name = archive_name, | ||
| srcs = srcs, | ||
| copts = copts, | ||
| swiftc_inputs = swiftc_inputs, | ||
| module_name = module_name, | ||
| visibility = ["//visibility:public"], | ||
| deps = deps, | ||
| ) | ||
|
|
||
| _swift_static_framework( | ||
| name = name, | ||
| archive = archive_name, | ||
| framework_name = module_name, | ||
| visibility = visibility, | ||
| ) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| #import <Foundation/Foundation.h> | ||
|
|
||
| /// Wrapper layer to simplify calling into Envoy's C++ API. | ||
| @interface EnvoyEngine : NSObject | ||
|
|
||
| /// Run the Envoy engine with the provided config and log level. This call is synchronous | ||
| /// and will not yield. | ||
| + (int)runWithConfig:(NSString *)config; | ||
|
|
||
| /// Run the Envoy engine with the provided config and log level. This call is synchronous | ||
| /// and will not yield. | ||
| + (int)runWithConfig:(NSString *)config logLevel:(NSString *)logLevel; | ||
|
|
||
| @end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| #import "library/objective-c/EnvoyEngine.h" | ||
|
|
||
| #import "library/common/main_interface.h" | ||
|
|
||
| @implementation EnvoyEngine | ||
|
|
||
| + (int)runWithConfig:(NSString *)config { | ||
| return [self runWithConfig:config logLevel:@"info"]; | ||
| } | ||
|
|
||
| + (int)runWithConfig:(NSString *)config logLevel:(NSString *)logLevel { | ||
| try { | ||
| return run_envoy(config.UTF8String, logLevel.UTF8String); | ||
| } catch (NSException *e) { | ||
| NSLog(@"Envoy exception: %@", e); | ||
| NSDictionary *userInfo = @{@"exception" : e}; | ||
| [NSNotificationCenter.defaultCenter postNotificationName:@"EnvoyException" | ||
| object:self | ||
| userInfo:userInfo]; | ||
| return 1; | ||
| } | ||
| } | ||
|
|
||
| @end |
Oops, something went wrong.