pkg/dartdev/lib/src/commands/build.dart - sdk - Git at Google

 // Copyright (c) 2023, the Dart project authors. Please see the AUTHORS file
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.

 import 'dart:async';
 import 'dart:io';

 import 'package:dart2native/generate.dart';
 import 'package:dartdev/src/commands/compile.dart';
 import 'package:dartdev/src/experiments.dart';
 import 'package:dartdev/src/sdk.dart';
 import 'package:front_end/src/api_prototype/compiler_options.dart'
     show Verbosity;
 import 'package:native_assets_builder/native_assets_builder.dart';
 import 'package:native_assets_cli/native_assets_cli.dart';
 import 'package:path/path.dart' as path;
 import 'package:vm/target_os.dart'; // For possible --target-os values.

 import '../core.dart';
 import '../native_assets.dart';

 class BuildCommand extends DartdevCommand {
   static const String cmdName = 'build';
   static const String outputOptionName = 'output';
   static const String formatOptionName = 'format';

   BuildCommand({bool verbose = false})
       : super(cmdName, 'Build a Dart application including native assets.',
             verbose) {
     argParser
       ..addOption(
         outputOptionName,
         abbr: 'o',
         help: '''
           Write the output to <folder name>.
           This can be an absolute or relative path.
           ''',
       )
       ..addOption(
         formatOptionName,
         abbr: 'f',
         allowed: ['exe', 'aot'],
         defaultsTo: 'exe',
       )
       ..addOption('target-os',
           help: 'Compile to a specific target operating system.',
           allowed: TargetOS.names)
       ..addOption(
         'verbosity',
         help: 'Sets the verbosity level of the compilation.',
         defaultsTo: Verbosity.defaultValue,
         allowed: Verbosity.allowedValues,
         allowedHelp: Verbosity.allowedValuesHelp,
       )
       ..addExperimentalFlags(verbose: verbose);
   }

   @override
   String get invocation => '${super.invocation} <dart entry point>';

   @override
   Future<int> run() async {
     if (!Sdk.checkArtifactExists(genKernel) ||
         !Sdk.checkArtifactExists(genSnapshot) ||
         !Sdk.checkArtifactExists(sdk.dart)) {
       return 255;
     }
     // AOT compilation isn't supported on ia32. Currently, generating an
     // executable only supports AOT runtimes, so these commands are disabled.
     if (Platform.version.contains('ia32')) {
       stderr.write("'dart build' is not supported on x86 architectures");
       return 64;
     }
     final args = argResults!;

     // We expect a single rest argument; the dart entry point.
     if (args.rest.length != 1) {
       // This throws.
       usageException('Missing Dart entry point.');
     }

     // TODO(https://dartbug.com/52458): Support `dart build <pkg>:<bin-script>`.
     // Similar to Dart run. Possibly also in `dart compile`.
     final sourceUri = Uri(path: args.rest[0].normalizeCanonicalizePath());
     if (!checkFile(sourceUri.toFilePath())) {
       return -1;
     }

     final outputUri = Uri.directory(
       (args[outputOptionName] as String?)
               ?.normalizeCanonicalizePath()
               .makeFolder() ??
           sourceUri.toFilePath().removeDotDart().makeFolder(),
     );

     final format = args[formatOptionName] as String;
     final outputExeUri = outputUri
         .resolve('${sourceUri.pathSegments.last.split('.').first}.$format');
     String? targetOS = args['target-os'];
     if (format != 'exe') {
       assert(format == 'aot');
       // If we're generating an AOT snapshot and not an executable, then
       // targetOS is allowed to be null for a platform-independent snapshot
       // or a different platform than the host.
     } else if (targetOS == null) {
       targetOS = Platform.operatingSystem;
     } else if (targetOS != Platform.operatingSystem) {
       stderr.writeln(
           "'dart build -f $format' does not support cross-OS compilation.");
       stderr.writeln('Host OS: ${Platform.operatingSystem}');
       stderr.writeln('Target OS: $targetOS');
       return 128;
     }

     final outputDir = Directory.fromUri(outputUri);
     if (await outputDir.exists()) {
       stdout.writeln('Deleting output directory: ${outputUri.toFilePath()}.');
       await outputDir.delete(recursive: true);
     }
     await outputDir.create(recursive: true);

     stdout.writeln('Building native assets.');
     final workingDirectory = Directory.current.uri;
     final target = Target.current;
     final buildResult = await NativeAssetsBuildRunner(
       dartExecutable: Uri.file(sdk.dart),
       logger: logger(verbose),
     ).build(
       workingDirectory: workingDirectory,
       target: target,
       linkModePreference: LinkModePreference.dynamic,
       buildMode: BuildMode.release,
       includeParentEnvironment: true,
     );
     final nativeAssets = buildResult.assets;
     if (!buildResult.success) {
       stderr.write('Native assets build failed.');
       return 255;
     }
     final staticAssets = nativeAssets.whereLinkMode(LinkMode.static);
     if (staticAssets.isNotEmpty) {
       stderr.write(
           """'dart build' does not yet support native artifacts packaged as ${LinkMode.static.name}.
 Use linkMode as dynamic library instead.""");
       return 255;
     }

     Uri? tempUri;
     Uri? nativeAssetsDartUri;
     final tempDir = Directory.systemTemp.createTempSync();
     if (nativeAssets.isNotEmpty) {
       stdout.writeln('Copying native assets.');
       Asset targetLocation(Asset asset) {
         final path = asset.path;
         switch (path.runtimeType) {
           case const (AssetSystemPath):
           case const (AssetInExecutable):
           case const (AssetInProcess):
             return asset;
           case const (AssetAbsolutePath):
             return asset.copyWith(
               path: AssetRelativePath(
                 Uri(
                   path: (path as AssetAbsolutePath).uri.pathSegments.last,
                 ),
               ),
             );
         }
         throw 'Unsupported asset path type ${path.runtimeType} in asset $asset';
       }

       final assetTargetLocations = {
         for (final asset in nativeAssets) asset: targetLocation(asset),
       };
       await Future.wait([
         for (final assetMapping in assetTargetLocations.entries)
           if (assetMapping.key != assetMapping.value)
             File.fromUri((assetMapping.key.path as AssetAbsolutePath).uri).copy(
                 outputUri
                     .resolveUri(
                         (assetMapping.value.path as AssetRelativePath).uri)
                     .toFilePath())
       ]);

       tempUri = tempDir.uri;
       nativeAssetsDartUri = tempUri.resolve('native_assets.yaml');
       final assetsContent =
           assetTargetLocations.values.toList().toNativeAssetsFile();
       await Directory.fromUri(nativeAssetsDartUri.resolve('.')).create();
       await File(nativeAssetsDartUri.toFilePath()).writeAsString(assetsContent);
     }
     final packageConfig = await packageConfigUri(sourceUri);

     await generateNative(
       kind: format,
       sourceFile: sourceUri.toFilePath(),
       outputFile: outputExeUri.toFilePath(),
       verbose: verbose,
       verbosity: args['verbosity'],
       defines: [],
       nativeAssets: nativeAssetsDartUri?.toFilePath(),
       packages: packageConfig?.toFilePath(),
       targetOS: targetOS,
       enableExperiment: args.enabledExperiments.join(','),
       resourcesFile: path.join(tempDir.path, 'resources.json'),
     );

     if (tempUri != null) {
       await Directory.fromUri(tempUri).delete(recursive: true);
     }

     return 0;
   }
 }

 extension on String {
   String normalizeCanonicalizePath() => path.canonicalize(path.normalize(this));
   String makeFolder() => endsWith('\\') || endsWith('/') ? this : '$this/';
   String removeDotDart() => replaceFirst(RegExp(r'\.dart$'), '');
 }

 // TODO(https://github.com/dart-lang/package_config/issues/126): Expose this
 // logic in package:package_config.
 Future<Uri?> packageConfigUri(Uri uri) async {
   while (true) {
     final candidate = uri.resolve('.dart_tool/package_config.json');
     if (await File.fromUri(candidate).exists()) {
       return candidate;
     }
     final parent = uri.resolve('..');
     if (parent == uri) {
       return null;
     }
     uri = parent;
   }
 }
	// Copyright (c) 2023, the Dart project authors. Please see the AUTHORS file
	// for details. All rights reserved. Use of this source code is governed by a
	// BSD-style license that can be found in the LICENSE file.

	import 'dart:async';
	import 'dart:io';

	import 'package:dart2native/generate.dart';
	import 'package:dartdev/src/commands/compile.dart';
	import 'package:dartdev/src/experiments.dart';
	import 'package:dartdev/src/sdk.dart';
	import 'package:front_end/src/api_prototype/compiler_options.dart'
	show Verbosity;
	import 'package:native_assets_builder/native_assets_builder.dart';
	import 'package:native_assets_cli/native_assets_cli.dart';
	import 'package:path/path.dart' as path;
	import 'package:vm/target_os.dart'; // For possible --target-os values.

	import '../core.dart';
	import '../native_assets.dart';

	class BuildCommand extends DartdevCommand {
	static const String cmdName = 'build';
	static const String outputOptionName = 'output';
	static const String formatOptionName = 'format';

	BuildCommand({bool verbose = false})
	: super(cmdName, 'Build a Dart application including native assets.',
	verbose) {
	argParser
	..addOption(
	outputOptionName,
	abbr: 'o',
	help: '''
	Write the output to <folder name>.
	This can be an absolute or relative path.
	''',
	)
	..addOption(
	formatOptionName,
	abbr: 'f',
	allowed: ['exe', 'aot'],
	defaultsTo: 'exe',
	)
	..addOption('target-os',
	help: 'Compile to a specific target operating system.',
	allowed: TargetOS.names)
	..addOption(
	'verbosity',
	help: 'Sets the verbosity level of the compilation.',
	defaultsTo: Verbosity.defaultValue,
	allowed: Verbosity.allowedValues,
	allowedHelp: Verbosity.allowedValuesHelp,
	)
	..addExperimentalFlags(verbose: verbose);
	}

	@override
	String get invocation => '${super.invocation} <dart entry point>';

	@override
	Future<int> run() async {
	if (!Sdk.checkArtifactExists(genKernel) \|\|
	!Sdk.checkArtifactExists(genSnapshot) \|\|
	!Sdk.checkArtifactExists(sdk.dart)) {
	return 255;
	}
	// AOT compilation isn't supported on ia32. Currently, generating an
	// executable only supports AOT runtimes, so these commands are disabled.
	if (Platform.version.contains('ia32')) {
	stderr.write("'dart build' is not supported on x86 architectures");
	return 64;
	}
	final args = argResults!;

	// We expect a single rest argument; the dart entry point.
	if (args.rest.length != 1) {
	// This throws.
	usageException('Missing Dart entry point.');
	}

	// TODO(https://dartbug.com/52458): Support `dart build <pkg>:<bin-script>`.
	// Similar to Dart run. Possibly also in `dart compile`.
	final sourceUri = Uri(path: args.rest[0].normalizeCanonicalizePath());
	if (!checkFile(sourceUri.toFilePath())) {
	return -1;
	}

	final outputUri = Uri.directory(
	(args[outputOptionName] as String?)
	?.normalizeCanonicalizePath()
	.makeFolder() ??
	sourceUri.toFilePath().removeDotDart().makeFolder(),
	);

	final format = args[formatOptionName] as String;
	final outputExeUri = outputUri
	.resolve('${sourceUri.pathSegments.last.split('.').first}.$format');
	String? targetOS = args['target-os'];
	if (format != 'exe') {
	assert(format == 'aot');
	// If we're generating an AOT snapshot and not an executable, then
	// targetOS is allowed to be null for a platform-independent snapshot
	// or a different platform than the host.
	} else if (targetOS == null) {
	targetOS = Platform.operatingSystem;
	} else if (targetOS != Platform.operatingSystem) {
	stderr.writeln(
	"'dart build -f $format' does not support cross-OS compilation.");
	stderr.writeln('Host OS: ${Platform.operatingSystem}');
	stderr.writeln('Target OS: $targetOS');
	return 128;
	}

	final outputDir = Directory.fromUri(outputUri);
	if (await outputDir.exists()) {
	stdout.writeln('Deleting output directory: ${outputUri.toFilePath()}.');
	await outputDir.delete(recursive: true);
	}
	await outputDir.create(recursive: true);

	stdout.writeln('Building native assets.');
	final workingDirectory = Directory.current.uri;
	final target = Target.current;
	final buildResult = await NativeAssetsBuildRunner(
	dartExecutable: Uri.file(sdk.dart),
	logger: logger(verbose),
	).build(
	workingDirectory: workingDirectory,
	target: target,
	linkModePreference: LinkModePreference.dynamic,
	buildMode: BuildMode.release,
	includeParentEnvironment: true,
	);
	final nativeAssets = buildResult.assets;
	if (!buildResult.success) {
	stderr.write('Native assets build failed.');
	return 255;
	}
	final staticAssets = nativeAssets.whereLinkMode(LinkMode.static);
	if (staticAssets.isNotEmpty) {
	stderr.write(
	"""'dart build' does not yet support native artifacts packaged as ${LinkMode.static.name}.
	Use linkMode as dynamic library instead.""");
	return 255;
	}

	Uri? tempUri;
	Uri? nativeAssetsDartUri;
	final tempDir = Directory.systemTemp.createTempSync();
	if (nativeAssets.isNotEmpty) {
	stdout.writeln('Copying native assets.');
	Asset targetLocation(Asset asset) {
	final path = asset.path;
	switch (path.runtimeType) {
	case const (AssetSystemPath):
	case const (AssetInExecutable):
	case const (AssetInProcess):
	return asset;
	case const (AssetAbsolutePath):
	return asset.copyWith(
	path: AssetRelativePath(
	Uri(
	path: (path as AssetAbsolutePath).uri.pathSegments.last,
	),
	),
	);
	}
	throw 'Unsupported asset path type ${path.runtimeType} in asset $asset';
	}

	final assetTargetLocations = {
	for (final asset in nativeAssets) asset: targetLocation(asset),
	};
	await Future.wait([
	for (final assetMapping in assetTargetLocations.entries)
	if (assetMapping.key != assetMapping.value)
	File.fromUri((assetMapping.key.path as AssetAbsolutePath).uri).copy(
	outputUri
	.resolveUri(
	(assetMapping.value.path as AssetRelativePath).uri)
	.toFilePath())
	]);

	tempUri = tempDir.uri;
	nativeAssetsDartUri = tempUri.resolve('native_assets.yaml');
	final assetsContent =
	assetTargetLocations.values.toList().toNativeAssetsFile();
	await Directory.fromUri(nativeAssetsDartUri.resolve('.')).create();
	await File(nativeAssetsDartUri.toFilePath()).writeAsString(assetsContent);
	}
	final packageConfig = await packageConfigUri(sourceUri);

	await generateNative(
	kind: format,
	sourceFile: sourceUri.toFilePath(),
	outputFile: outputExeUri.toFilePath(),
	verbose: verbose,
	verbosity: args['verbosity'],
	defines: [],
	nativeAssets: nativeAssetsDartUri?.toFilePath(),
	packages: packageConfig?.toFilePath(),
	targetOS: targetOS,
	enableExperiment: args.enabledExperiments.join(','),
	resourcesFile: path.join(tempDir.path, 'resources.json'),
	);

	if (tempUri != null) {
	await Directory.fromUri(tempUri).delete(recursive: true);
	}

	return 0;
	}
	}

	extension on String {
	String normalizeCanonicalizePath() => path.canonicalize(path.normalize(this));
	String makeFolder() => endsWith('\\') \|\| endsWith('/') ? this : '$this/';
	String removeDotDart() => replaceFirst(RegExp(r'\.dart$'), '');
	}

	// TODO(https://github.com/dart-lang/package_config/issues/126): Expose this
	// logic in package:package_config.
	Future<Uri?> packageConfigUri(Uri uri) async {
	while (true) {
	final candidate = uri.resolve('.dart_tool/package_config.json');
	if (await File.fromUri(candidate).exists()) {
	return candidate;
	}
	final parent = uri.resolve('..');
	if (parent == uri) {
	return null;
	}
	uri = parent;
	}
	}