Skip to content
This repository was archived by the owner on Feb 25, 2025. It is now read-only.

[iOS] Bundle dSYM packages in Flutter.xcframework #54414

Merged
merged 1 commit into from
Aug 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
28 changes: 18 additions & 10 deletions sky/tools/create_full_ios_framework.py
Original file line number Diff line number Diff line change
Expand Up @@ -143,11 +143,20 @@ def create_framework( # pylint: disable=too-many-arguments
print('Cannot find iOS simulator dylib at %s' % simulator_x64_dylib)
return 1

# Compute dsym output paths, if enabled.
framework_dsym = None
simulator_dsym = None
if args.dsym:
framework_dsym = os.path.splitext(framework)[0] + '.dSYM'
simulator_dsym = os.path.splitext(simulator_framework)[0] + '.dSYM'

# Emit the framework for physical devices.
shutil.rmtree(framework, True)
shutil.copytree(arm64_framework, framework)
framework_binary = os.path.join(framework, 'Flutter')
process_framework(args, dst, framework, framework_binary)
process_framework(args, dst, framework_binary, framework_dsym)

# Emit the framework for simulators.
if args.simulator_arm64_out_dir is not None:
shutil.rmtree(simulator_framework, True)
shutil.copytree(simulator_arm64_framework, simulator_framework)
Expand All @@ -159,22 +168,23 @@ def create_framework( # pylint: disable=too-many-arguments
'lipo', simulator_x64_dylib, simulator_arm64_dylib, '-create', '-output',
simulator_framework_binary
])
process_framework(args, dst, simulator_framework, simulator_framework_binary)
process_framework(args, dst, simulator_framework_binary, simulator_dsym)
else:
simulator_framework = simulator_x64_framework

# Create XCFramework from the arm-only fat framework and the arm64/x64
# simulator frameworks, or just the x64 simulator framework if only that one
# exists.
xcframeworks = [simulator_framework, framework]
create_xcframework(location=dst, name='Flutter', frameworks=xcframeworks)
dsyms = [simulator_dsym, framework_dsym] if args.dsym else None
create_xcframework(location=dst, name='Flutter', frameworks=xcframeworks, dsyms=dsyms)

# Add the x64 simulator into the fat framework
# Add the x64 simulator into the fat framework.
subprocess.check_call([
'lipo', arm64_dylib, simulator_x64_dylib, '-create', '-output', framework_binary
])

process_framework(args, dst, framework, framework_binary)
process_framework(args, dst, framework_binary, framework_dsym)
return 0


Expand Down Expand Up @@ -215,16 +225,14 @@ def zip_archive(dst):
subprocess.check_call(['zip', '-r', 'extension_safe_Flutter.dSYM.zip', 'Flutter.dSYM'], cwd=dst)


def process_framework(args, dst, framework, framework_binary):
if args.dsym:
dsym_out = os.path.splitext(framework)[0] + '.dSYM'
subprocess.check_call([DSYMUTIL, '-o', dsym_out, framework_binary])
def process_framework(args, dst, framework_binary, dsym):
if dsym:
subprocess.check_call([DSYMUTIL, '-o', dsym, framework_binary])

if args.strip:
# copy unstripped
unstripped_out = os.path.join(dst, 'Flutter.unstripped')
shutil.copyfile(framework_binary, unstripped_out)

subprocess.check_call(['strip', '-x', '-S', framework_binary])


Expand Down
19 changes: 14 additions & 5 deletions sky/tools/create_xcframework.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,22 @@ def main():
help='The framework paths used to create the XCFramework.',
required=True
)
parser.add_argument(
Copy link
Member

Choose a reason for hiding this comment

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

It looks like the new argument isn't passed in this PR. What's the plan for using the new code in this file?

Copy link
Member Author

@cbracken cbracken Aug 8, 2024

Choose a reason for hiding this comment

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

It's passed from create_full_ios_framework.py (here), which uses it because the invocation in mac_ios_engine.json already uses the --dsym flag.

Copy link
Member

Choose a reason for hiding this comment

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

YOU ARE IN A MAZE OF TWISTY PYTHON SCRIPTS, ALL ALIKE. YOU ARE LIKELY TO BE EATEN BY A GRUE.

Copy link
Member Author

Choose a reason for hiding this comment

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

LIGHT LAMP.

'--dsyms', nargs='+', help='The dSYM paths to be bundled in the XCFramework.', required=False
)
parser.add_argument('--name', help='Name of the XCFramework', type=str, required=True)
parser.add_argument('--location', help='Output directory', type=str, required=True)

args = parser.parse_args()

create_xcframework(args.location, args.name, args.frameworks)
create_xcframework(args.location, args.name, args.frameworks, args.dsyms)


def create_xcframework(location, name, frameworks, dsyms=None):
if dsyms and len(frameworks) != len(dsyms):
print('Number of --dsyms must match number of --frameworks exactly.', file=sys.stderr)
sys.exit(1)

def create_xcframework(location, name, frameworks):
output_dir = os.path.abspath(location)
output_xcframework = os.path.join(output_dir, '%s.xcframework' % name)

Expand All @@ -45,11 +52,13 @@ def create_xcframework(location, name, frameworks):
# -framework bar/baz.framework -output output/
command = ['xcrun', 'xcodebuild', '-quiet', '-create-xcframework']

for framework in frameworks:
command.extend(['-framework', os.path.abspath(framework)])

command.extend(['-output', output_xcframework])

for i in range(len(frameworks)): # pylint: disable=consider-using-enumerate
command.extend(['-framework', os.path.abspath(frameworks[i])])
if dsyms:
command.extend(['-debug-symbols', os.path.abspath(dsyms[i])])

subprocess.check_call(command, stdout=open(os.devnull, 'w'))


Expand Down