Skip to content

Add objc_library binary to outputs of apple_framework_packaging rule when virtualized frameworks feature is enabled #931

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
+51 −38
Open

Add objc_library binary to outputs of apple_framework_packaging rule when virtualized frameworks feature is enabled #931

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0e8d404
When the VFS feature is enabled, include the objc_library binary in t…
jschear Dec 12, 2024
cb1c99f
Format imports
jschear Dec 12, 2024
f9011ec
Merge branch 'master' into js/add_objc_library_to_vfs_framework_outputs
jschear Jan 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
89 changes: 51 additions & 38 deletions rules/framework.bzl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,36 +1,36 @@
"""Framework rules"""

load("//rules/framework:vfs_overlay.bzl", "VFSOverlayInfo", "make_vfsoverlay")
load("//rules:features.bzl", "feature_names")
load("//rules:library.bzl", "PrivateHeadersInfo", "apple_library")
load("//rules:plists.bzl", "process_infoplists")
load("//rules:providers.bzl", "AvoidDepsInfo", "FrameworkInfo")
load("//rules:transition_support.bzl", "transition_support")
load("//rules:utils.bzl", "is_bazel_7")
load("//rules/internal:objc_provider_utils.bzl", "objc_provider_utils")
load("@bazel_skylib//lib:partial.bzl", "partial")
load("@bazel_skylib//lib:paths.bzl", "paths")
load("@bazel_tools//tools/cpp:toolchain_utils.bzl", "find_cpp_toolchain", "use_cpp_toolchain")
load("@build_bazel_rules_apple//apple/internal:apple_product_type.bzl", "apple_product_type")
load("@build_bazel_rules_apple//apple/internal:apple_toolchains.bzl", "AppleMacToolsToolchainInfo", "AppleXPlatToolsToolchainInfo")
load("@build_bazel_rules_apple//apple/internal:features_support.bzl", "features_support")
load("@build_bazel_rules_apple//apple/internal:linking_support.bzl", "linking_support")
load("@build_bazel_rules_apple//apple/internal:outputs.bzl", "outputs")
load("@build_bazel_rules_apple//apple/internal:partials.bzl", "partials")
load("@build_bazel_rules_apple//apple/internal:platform_support.bzl", "platform_support")
load("@build_bazel_rules_apple//apple/internal:processor.bzl", "processor")
load("@build_bazel_rules_apple//apple/internal:providers.bzl", "AppleBundleInfo", "ApplePlatformInfo", "IosFrameworkBundleInfo", "new_applebundleinfo", "new_iosframeworkbundleinfo")
load("@build_bazel_rules_apple//apple/internal:resource_actions.bzl", "resource_actions")
load("@build_bazel_rules_apple//apple/internal:resources.bzl", "resources")
load("@build_bazel_rules_apple//apple/internal:rule_support.bzl", "rule_support")
load("@build_bazel_rules_apple//apple/internal:apple_toolchains.bzl", "AppleMacToolsToolchainInfo", "AppleXPlatToolsToolchainInfo")
load("@build_bazel_rules_apple//apple/internal:swift_support.bzl", "swift_support")
load("@build_bazel_rules_apple//apple/internal/utils:clang_rt_dylibs.bzl", "clang_rt_dylibs")
load("@build_bazel_rules_apple//apple/internal:providers.bzl", "AppleBundleInfo", "ApplePlatformInfo", "IosFrameworkBundleInfo", "new_applebundleinfo", "new_iosframeworkbundleinfo")
load("@build_bazel_rules_swift//swift:swift.bzl", "SwiftInfo", "swift_clang_module_aspect", "swift_common")
load(
"@build_bazel_rules_apple//apple/internal/aspects:resource_aspect.bzl",
"apple_resource_aspect",
)
load("@build_bazel_rules_apple//apple/internal/utils:clang_rt_dylibs.bzl", "clang_rt_dylibs")
load("@build_bazel_rules_swift//swift:swift.bzl", "SwiftInfo", "swift_clang_module_aspect", "swift_common")
load("//rules:features.bzl", "feature_names")
load("//rules:force_load_direct_deps.bzl", "force_load_direct_deps")
load("//rules:library.bzl", "PrivateHeadersInfo", "apple_library")
load("//rules:plists.bzl", "process_infoplists")
load("//rules:providers.bzl", "AvoidDepsInfo", "FrameworkInfo")
load("//rules:transition_support.bzl", "transition_support")
load("//rules:utils.bzl", "is_bazel_7")
load("//rules/framework:vfs_overlay.bzl", "VFSOverlayInfo", "make_vfsoverlay")
load("//rules/internal:objc_provider_utils.bzl", "objc_provider_utils")

_APPLE_FRAMEWORK_PACKAGING_KWARGS = [
"visibility",
Expand Down Expand Up @@ -221,11 +221,6 @@ def _framework_packaging_multi(ctx, action, inputs, outputs, manifest = None):
return []
if inputs == [None]:
return []

virtualize_frameworks = feature_names.virtualize_frameworks in ctx.features
if virtualize_frameworks:
return inputs
Copy link
Contributor

@gyfelton gyfelton Jan 9, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

before this change, swiftmodule_out equals to [swiftmodule_in] when VFS is enabled
with this PR, swiftmodule_out equals to swiftmodule_in instead when VFS is enabled. Am I understanding this diff correctly?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think swiftmodule_out is equal to swiftmodule_in both before and after this change.

Before:

swiftmodule_out = _framework_packaging_single(ctx, "swiftmodule", [swiftmodule_in], swiftmodule_out, framework_manifest)

def _framework_packaging_single(ctx, action, inputs, output, manifest = None):
    outputs = _framework_packaging_multi(ctx, action, inputs, [output], manifest = manifest)
    return outputs[0] if outputs else None

def _framework_packaging_multi(ctx, action, inputs, outputs, manifest = None):
   # ...
    virtualize_frameworks = feature_names.virtualize_frameworks in ctx.features
    if virtualize_frameworks:
        return inputs
   # ...

_framework_packaging_multi just returns the inputs list, and _framework_packaging_single returns the first item of that list. Does that make sense?


if action in ctx.attr.skip_packaging:
return []
action_inputs = [manifest] + inputs if manifest else inputs
Expand Down Expand Up @@ -456,26 +451,41 @@ def _get_framework_files(ctx, deps):
else:
framework_manifest = None

# Package each part of the framework separately,
# so inputs that do not depend on compilation
# are available before those that do,
# improving parallelism
binary_out = _framework_packaging_single(ctx, "binary", binaries_in, binary_out, framework_manifest)
headers_out = _framework_packaging_multi(ctx, "header", headers_in, headers_out, framework_manifest)
private_headers_out = _framework_packaging_multi(ctx, "private_header", private_headers_in, private_headers_out, framework_manifest)

# Instead of creating a symlink of the modulemap, we need to copy it to modulemap_out.
# It's a hacky fix to guarantee running the clean action before compiling objc files depending on this framework in non-sandboxed mode.
# Otherwise, stale header files under framework_root will cause compilation failure in non-sandboxed mode.
modulemap_out = _framework_packaging_single(ctx, "modulemap", [modulemap_in], modulemap_out, framework_manifest)
swiftmodule_out = _framework_packaging_single(ctx, "swiftmodule", [swiftmodule_in], swiftmodule_out, framework_manifest)
swiftinterface_out = _framework_packaging_single(ctx, "swiftinterface", [swiftinterface_in], swiftinterface_out, framework_manifest)
swiftdoc_out = _framework_packaging_single(ctx, "swiftdoc", [swiftdoc_in], swiftdoc_out, framework_manifest)
infoplist_out = _framework_packaging_single(ctx, "infoplist", [infoplist_in], infoplist_out, framework_manifest)
symbol_graph_out = _framework_packaging_single(ctx, "symbol_graph", [symbol_graph_in], symbol_graph_out, framework_manifest)
if virtualize_frameworks:
# When using virtualized frameworks, we skip the packaging step.
binaries_out = binaries_in
headers_out = headers_in
private_headers_out = private_headers_in
modulemap_out = modulemap_in
swiftmodule_out = swiftmodule_in
swiftinterface_out = swiftinterface_in
swiftdoc_out = swiftdoc_in
infoplist_out = infoplist_in
symbol_graph_out = symbol_graph_in
else:
# Package each part of the framework separately,
# so inputs that do not depend on compilation
# are available before those that do,
# improving parallelism
binaries_out = _compact([_framework_packaging_single(ctx, "binary", binaries_in, binary_out, framework_manifest)])
headers_out = _framework_packaging_multi(ctx, "header", headers_in, headers_out, framework_manifest)
private_headers_out = _framework_packaging_multi(ctx, "private_header", private_headers_in, private_headers_out, framework_manifest)

# Instead of creating a symlink of the modulemap, we need to copy it to modulemap_out.
# It's a hacky fix to guarantee running the clean action before compiling objc files depending on this framework in non-sandboxed mode.
# Otherwise, stale header files under framework_root will cause compilation failure in non-sandboxed mode.
modulemap_out = _framework_packaging_single(ctx, "modulemap", [modulemap_in], modulemap_out, framework_manifest)
swiftmodule_out = _framework_packaging_single(ctx, "swiftmodule", [swiftmodule_in], swiftmodule_out, framework_manifest)
swiftinterface_out = _framework_packaging_single(ctx, "swiftinterface", [swiftinterface_in], swiftinterface_out, framework_manifest)
swiftdoc_out = _framework_packaging_single(ctx, "swiftdoc", [swiftdoc_in], swiftdoc_out, framework_manifest)
infoplist_out = _framework_packaging_single(ctx, "infoplist", [infoplist_in], infoplist_out, framework_manifest)
symbol_graph_out = _framework_packaging_single(ctx, "symbol_graph", [symbol_graph_in], symbol_graph_out, framework_manifest)

outputs = struct(
binary = binary_out,
# When the virtualized frameworks feature is disabled, this contains a single binary, merged with libtool.
# When the virtualized frameworks feature is enabled, this contains both the objc_library and swift_library binaries, so that
# both binaries are included in the output files of this rule.
binaries = binaries_out,
headers = headers_out,
infoplist = infoplist_out,
private_headers = private_headers_out,
Expand Down Expand Up @@ -517,10 +527,10 @@ def _get_symlinked_framework_clean_action(ctx, framework_files, compilation_cont

framework_contents = _compact(
[
outputs.binary,
outputs.swiftmodule,
outputs.swiftdoc,
] +
outputs.binaries +
outputs.modulemaps +
outputs.headers +
outputs.private_headers,
Expand Down Expand Up @@ -988,7 +998,9 @@ def _bundle_static_framework(ctx, is_extension_safe, current_apple_platform, out
new_applebundleinfo(
archive = None,
archive_root = None,
binary = outputs.binary,
# When the virtualized frameworks feature is enabled, outputs.binaries can contain two binaries:
# the swift_library binary and the objc_library binary. Arbitrarily use the first, matching previous behavior.
binary = outputs.binaries[0] if outputs.binaries else None,
bundle_id = ctx.attr.bundle_id,
bundle_name = ctx.attr.framework_name,
bundle_extension = ctx.attr.bundle_extension,
Expand Down Expand Up @@ -1134,7 +1146,8 @@ def _apple_framework_packaging_impl(ctx):
swift_info = _get_merged_swift_info(ctx, framework_files, transitive_deps, clang_module)

# Build out the default info provider
out_files = _compact([outputs.binary, outputs.swiftmodule, outputs.infoplist])
out_files = _compact([outputs.swiftmodule, outputs.infoplist])
out_files.extend(outputs.binaries)
out_files.extend(outputs.headers)
out_files.extend(outputs.private_headers)
out_files.extend(outputs.modulemaps)
Expand Down