|
| 1 | +// Copyright 2013 The Flutter Authors. All rights reserved. |
| 2 | +// Use of this source code is governed by a BSD-style license that can be |
| 3 | +// found in the LICENSE file. |
| 4 | + |
| 5 | +import 'dart:convert' show json; |
| 6 | +import 'dart:io'; |
| 7 | + |
| 8 | +import 'package:path/path.dart' as pathlib; |
| 9 | +import 'package:yaml/yaml.dart'; |
| 10 | + |
| 11 | +import 'environment.dart'; |
| 12 | +import 'utils.dart'; |
| 13 | + |
| 14 | +/// Rolls CanvasKit to the version specified in `dev/canvaskit_lock.yaml`. |
| 15 | +/// |
| 16 | +/// Detailed instructions for how to use this script can be found in |
| 17 | +/// `lib/web_ui/README.md`. |
| 18 | +Future<void> main(List<String> args) async { |
| 19 | + final String canvaskitVersion = _readCanvaskitVersion(); |
| 20 | + print('Rolling CanvasKit to version $canvaskitVersion'); |
| 21 | + |
| 22 | + final Directory canvaskitDirectory = await Directory.systemTemp.createTemp('canvaskit-roll-$canvaskitVersion-'); |
| 23 | + print('Will use ${canvaskitDirectory.path} as staging directory.'); |
| 24 | + |
| 25 | + final String baseUrl = 'https://unpkg.com/canvaskit-wasm@$canvaskitVersion/bin/'; |
| 26 | + print('Downloading CanvasKit from $baseUrl'); |
| 27 | + final HttpClient client = HttpClient(); |
| 28 | + for (final String assetPath in _canvaskitAssets) { |
| 29 | + final String assetUrl = '$baseUrl/$assetPath'; |
| 30 | + final File assetFile = File(pathlib.joinAll(<String>[ |
| 31 | + canvaskitDirectory.path, |
| 32 | + 'canvaskit', |
| 33 | + ...assetPath.split('/'), // so it's compatible with Windows |
| 34 | + ])); |
| 35 | + await assetFile.parent.create(recursive: true); |
| 36 | + final HttpClientRequest request = await client.getUrl(Uri.parse(assetUrl)); |
| 37 | + final HttpClientResponse response = await request.close(); |
| 38 | + final IOSink fileSink = assetFile.openWrite(); |
| 39 | + await response.pipe(fileSink); |
| 40 | + } |
| 41 | + client.close(); |
| 42 | + |
| 43 | + final File cipdConfigFile = File(pathlib.join( |
| 44 | + canvaskitDirectory.path, |
| 45 | + 'cipd.yaml', |
| 46 | + )); |
| 47 | + await cipdConfigFile.writeAsString(''' |
| 48 | +package: flutter/web/canvaskit_bundle |
| 49 | +description: A build of CanvasKit bundled with Flutter Web apps |
| 50 | +preserve_writable: true |
| 51 | +data: |
| 52 | + - dir: canvaskit |
| 53 | +'''); |
| 54 | + |
| 55 | + print('Uploading to CIPD'); |
| 56 | + await runProcess('cipd', <String>[ |
| 57 | + 'create', |
| 58 | + '--tag=version:$canvaskitVersion', |
| 59 | + '--pkg-def=cipd.yaml', |
| 60 | + '--json-output=result.json', |
| 61 | + ], workingDirectory: canvaskitDirectory.path); |
| 62 | + |
| 63 | + final Map<String, dynamic> cipdResult = json.decode(File(pathlib.join( |
| 64 | + canvaskitDirectory.path, |
| 65 | + 'result.json', |
| 66 | + )).readAsStringSync()) as Map<String, dynamic>; |
| 67 | + final String cipdInstanceId = (cipdResult['result'] as Map<dynamic, dynamic>)['instance_id'] as String; |
| 68 | + |
| 69 | + print('CIPD instance information:'); |
| 70 | + final String cipdInfo = await evalProcess('cipd', <String>[ |
| 71 | + 'describe', |
| 72 | + 'flutter/web/canvaskit_bundle', |
| 73 | + '--version=$cipdInstanceId', |
| 74 | + ], workingDirectory: canvaskitDirectory.path); |
| 75 | + print(cipdInfo.trim().split('\n').map((String line) => ' • $line').join('\n')); |
| 76 | + |
| 77 | + print('Updating DEPS file'); |
| 78 | + await _updateDepsFile(cipdInstanceId); |
| 79 | + await _updateCanvaskitInitializationCode(canvaskitVersion); |
| 80 | + |
| 81 | + print('\nATTENTION: the roll process is not complete yet.'); |
| 82 | + print('Last step: for the roll to take effect submit an engine pull request from local git changes.'); |
| 83 | +} |
| 84 | + |
| 85 | +const List<String> _canvaskitAssets = <String>[ |
| 86 | + 'canvaskit.js', |
| 87 | + 'canvaskit.wasm', |
| 88 | + 'profiling/canvaskit.js', |
| 89 | + 'profiling/canvaskit.wasm', |
| 90 | +]; |
| 91 | + |
| 92 | +String _readCanvaskitVersion() { |
| 93 | + final YamlMap canvaskitLock = loadYaml(File(pathlib.join( |
| 94 | + environment.webUiDevDir.path, |
| 95 | + 'canvaskit_lock.yaml', |
| 96 | + )).readAsStringSync()) as YamlMap; |
| 97 | + return canvaskitLock['canvaskit_version'] as String; |
| 98 | +} |
| 99 | + |
| 100 | +Future<void> _updateDepsFile(String cipdInstanceId) async { |
| 101 | + final File depsFile = File(pathlib.join( |
| 102 | + environment.flutterDirectory.path, |
| 103 | + 'DEPS', |
| 104 | + )); |
| 105 | + |
| 106 | + final String originalDepsCode = await depsFile.readAsString(); |
| 107 | + final List<String> rewrittenDepsCode = <String>[]; |
| 108 | + const String kCanvasKitDependencyKeyInDeps = "'canvaskit_cipd_instance': '"; |
| 109 | + bool canvaskitDependencyFound = false; |
| 110 | + for (final String line in originalDepsCode.split('\n')) { |
| 111 | + if (line.trim().startsWith(kCanvasKitDependencyKeyInDeps)) { |
| 112 | + canvaskitDependencyFound = true; |
| 113 | + rewrittenDepsCode.add( |
| 114 | + " 'canvaskit_cipd_instance': '$cipdInstanceId',", |
| 115 | + ); |
| 116 | + } else { |
| 117 | + rewrittenDepsCode.add(line); |
| 118 | + } |
| 119 | + } |
| 120 | + |
| 121 | + if (!canvaskitDependencyFound) { |
| 122 | + stderr.writeln( |
| 123 | + 'Failed to update the DEPS file.\n' |
| 124 | + 'Could not to locate CanvasKit dependency in the DEPS file. Make sure the ' |
| 125 | + 'DEPS file contains a line like this:\n' |
| 126 | + '\n' |
| 127 | + " 'canvaskit_cipd_instance': 'SOME_VALUE'," |
| 128 | + ); |
| 129 | + exit(1); |
| 130 | + } |
| 131 | + |
| 132 | + await depsFile.writeAsString(rewrittenDepsCode.join('\n')); |
| 133 | +} |
| 134 | + |
| 135 | +Future<void> _updateCanvaskitInitializationCode(String canvaskitVersion) async { |
| 136 | + const String kCanvasKitVersionKey = 'const String _canvaskitVersion'; |
| 137 | + const String kPathToConfigurationCode = 'lib/src/engine/configuration.dart'; |
| 138 | + final File initializationFile = File(pathlib.join( |
| 139 | + environment.webUiRootDir.path, |
| 140 | + kPathToConfigurationCode, |
| 141 | + )); |
| 142 | + final String originalInitializationCode = await initializationFile.readAsString(); |
| 143 | + |
| 144 | + final List<String> rewrittenCode = <String>[]; |
| 145 | + bool canvaskitVersionFound = false; |
| 146 | + for (final String line in originalInitializationCode.split('\n')) { |
| 147 | + if (line.trim().startsWith(kCanvasKitVersionKey)) { |
| 148 | + canvaskitVersionFound = true; |
| 149 | + rewrittenCode.add( |
| 150 | + "const String _canvaskitVersion = '$canvaskitVersion';", |
| 151 | + ); |
| 152 | + } else { |
| 153 | + rewrittenCode.add(line); |
| 154 | + } |
| 155 | + } |
| 156 | + |
| 157 | + if (!canvaskitVersionFound) { |
| 158 | + stderr.writeln( |
| 159 | + 'Failed to update CanvasKit version in $kPathToConfigurationCode.\n' |
| 160 | + 'Could not to locate the constant that defines the version. Make sure the ' |
| 161 | + '$kPathToConfigurationCode file contains a line like this:\n' |
| 162 | + '\n' |
| 163 | + "const String _canvaskitVersion = 'VERSION';" |
| 164 | + ); |
| 165 | + exit(1); |
| 166 | + } |
| 167 | + |
| 168 | + await initializationFile.writeAsString(rewrittenCode.join('\n')); |
| 169 | +} |
0 commit comments