-
Notifications
You must be signed in to change notification settings - Fork 4.7k
/
WasmAppBuilder.cs
391 lines (335 loc) · 13.5 KB
/
WasmAppBuilder.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
using System;
using System.Collections.Generic;
using System.Collections.Specialized;
using System.Diagnostics.CodeAnalysis;
using System.IO;
using System.Linq;
using System.Text.Json;
using System.Text.Json.Serialization;
using Microsoft.Build.Framework;
using Microsoft.Build.Utilities;
public class WasmAppBuilder : Task
{
[NotNull]
[Required]
public string? AppDir { get; set; }
[NotNull]
[Required]
public string? MainJS { get; set; }
[NotNull]
[Required]
public string[]? Assemblies { get; set; }
[NotNull]
[Required]
public ITaskItem[]? NativeAssets { get; set; }
private List<string> _fileWrites = new();
[Output]
public string[]? FileWrites => _fileWrites.ToArray();
// full list of ICU data files we produce can be found here:
// https://github.com/dotnet/icu/tree/maint/maint-67/icu-filters
public string? IcuDataFileName { get; set; }
public int DebugLevel { get; set; }
public ITaskItem[]? SatelliteAssemblies { get; set; }
public ITaskItem[]? FilesToIncludeInFileSystem { get; set; }
public ITaskItem[]? RemoteSources { get; set; }
public bool InvariantGlobalization { get; set; }
public ITaskItem[]? ExtraFilesToDeploy { get; set; }
// <summary>
// Extra json elements to add to mono-config.json
//
// Metadata:
// - Value: can be a number, bool, quoted string, or json string
//
// Examples:
// <WasmExtraConfig Include="enable_profiler" Value="true" />
// <WasmExtraConfig Include="json" Value="{ "abc": 4 }" />
// <WasmExtraConfig Include="string_val" Value=""abc"" />
// <WasmExtraConfig Include="string_with_json" Value=""{ "abc": 4 }"" />
// </summary>
public ITaskItem[]? ExtraConfig { get; set; }
private sealed class WasmAppConfig
{
[JsonPropertyName("assembly_root")]
public string AssemblyRoot { get; set; } = "managed";
[JsonPropertyName("debug_level")]
public int DebugLevel { get; set; } = 0;
[JsonPropertyName("assets")]
public List<object> Assets { get; } = new List<object>();
[JsonPropertyName("remote_sources")]
public List<string> RemoteSources { get; set; } = new List<string>();
[JsonExtensionData]
public Dictionary<string, object?> Extra { get; set; } = new();
}
private class AssetEntry
{
protected AssetEntry (string name, string behavior)
{
Name = name;
Behavior = behavior;
}
[JsonPropertyName("behavior")]
public string Behavior { get; init; }
[JsonPropertyName("name")]
public string Name { get; init; }
}
private sealed class AssemblyEntry : AssetEntry
{
public AssemblyEntry(string name) : base(name, "assembly") {}
}
private sealed class SatelliteAssemblyEntry : AssetEntry
{
public SatelliteAssemblyEntry(string name, string culture) : base(name, "resource")
{
CultureName = culture;
}
[JsonPropertyName("culture")]
public string CultureName { get; set; }
}
private sealed class VfsEntry : AssetEntry
{
public VfsEntry(string name) : base(name, "vfs") {}
[JsonPropertyName("virtual_path")]
public string? VirtualPath { get; set; }
}
private sealed class IcuData : AssetEntry
{
public IcuData(string name) : base(name, "icu") {}
[JsonPropertyName("load_remote")]
public bool LoadRemote { get; set; }
}
public override bool Execute ()
{
try
{
return ExecuteInternal();
}
catch (LogAsErrorException laee)
{
Log.LogError(laee.Message);
return false;
}
}
private bool ExecuteInternal ()
{
if (!File.Exists(MainJS))
throw new LogAsErrorException($"File MainJS='{MainJS}' doesn't exist.");
if (!InvariantGlobalization && string.IsNullOrEmpty(IcuDataFileName))
throw new LogAsErrorException("IcuDataFileName property shouldn't be empty if InvariantGlobalization=false");
if (Assemblies?.Length == 0)
{
Log.LogError("Cannot build Wasm app without any assemblies");
return false;
}
var _assemblies = new List<string>();
foreach (var asm in Assemblies!)
{
if (!_assemblies.Contains(asm))
_assemblies.Add(asm);
}
var config = new WasmAppConfig ();
// Create app
var asmRootPath = Path.Combine(AppDir, config.AssemblyRoot);
Directory.CreateDirectory(AppDir!);
Directory.CreateDirectory(asmRootPath);
foreach (var assembly in _assemblies)
{
FileCopyChecked(assembly, Path.Combine(asmRootPath, Path.GetFileName(assembly)), "Assemblies");
if (DebugLevel != 0)
{
var pdb = assembly;
pdb = Path.ChangeExtension(pdb, ".pdb");
if (File.Exists(pdb))
FileCopyChecked(pdb, Path.Combine(asmRootPath, Path.GetFileName(pdb)), "Assemblies");
}
}
foreach (ITaskItem item in NativeAssets)
{
string dest = Path.Combine(AppDir!, Path.GetFileName(item.ItemSpec));
if (!FileCopyChecked(item.ItemSpec, dest, "NativeAssets"))
return false;
}
var mainFileName=Path.GetFileName(MainJS);
Log.LogMessage(MessageImportance.Low, $"MainJS path: '{MainJS}', fileName : '{mainFileName}', destination: '{Path.Combine(AppDir, mainFileName)}'");
FileCopyChecked(MainJS!, Path.Combine(AppDir, mainFileName), string.Empty);
string indexHtmlPath = Path.Combine(AppDir, "index.html");
if (!File.Exists(indexHtmlPath))
{
var html = @"<html><body><script type=""text/javascript"" src=""" + mainFileName + @"""></script></body></html>";
File.WriteAllText(indexHtmlPath, html);
}
foreach (var assembly in _assemblies)
{
config.Assets.Add(new AssemblyEntry(Path.GetFileName(assembly)));
if (DebugLevel != 0) {
var pdb = assembly;
pdb = Path.ChangeExtension(pdb, ".pdb");
if (File.Exists(pdb))
config.Assets.Add(new AssemblyEntry(Path.GetFileName(pdb)));
}
}
config.DebugLevel = DebugLevel;
if (SatelliteAssemblies != null)
{
foreach (var assembly in SatelliteAssemblies)
{
string culture = assembly.GetMetadata("CultureName") ?? string.Empty;
string fullPath = assembly.GetMetadata("Identity");
if (string.IsNullOrEmpty(culture))
{
Log.LogWarning($"Missing CultureName metadata for satellite assembly {fullPath}");
continue;
}
// FIXME: validate the culture?
string name = Path.GetFileName(fullPath);
string directory = Path.Combine(AppDir, config.AssemblyRoot, culture);
Directory.CreateDirectory(directory);
FileCopyChecked(fullPath, Path.Combine(directory, name), "SatelliteAssemblies");
config.Assets.Add(new SatelliteAssemblyEntry(name, culture));
}
}
if (FilesToIncludeInFileSystem != null)
{
string supportFilesDir = Path.Combine(AppDir, "supportFiles");
Directory.CreateDirectory(supportFilesDir);
var i = 0;
StringDictionary targetPathTable = new();
foreach (var item in FilesToIncludeInFileSystem)
{
string? targetPath = item.GetMetadata("TargetPath");
if (string.IsNullOrEmpty(targetPath))
{
targetPath = Path.GetFileName(item.ItemSpec);
}
// We normalize paths from `\` to `/` as MSBuild items could use `\`.
targetPath = targetPath.Replace('\\', '/');
if (targetPathTable.ContainsKey(targetPath))
{
string firstPath = Path.GetFullPath(targetPathTable[targetPath]!);
string secondPath = Path.GetFullPath(item.ItemSpec);
if (firstPath == secondPath)
{
Log.LogWarning($"Found identical vfs mappings for target path: {targetPath}, source file: {firstPath}. Ignoring.");
continue;
}
throw new LogAsErrorException($"Found more than one file mapping to the target VFS path: {targetPath}. Source files: {firstPath}, and {secondPath}");
}
targetPathTable[targetPath] = item.ItemSpec;
var generatedFileName = $"{i++}_{Path.GetFileName(item.ItemSpec)}";
FileCopyChecked(item.ItemSpec, Path.Combine(supportFilesDir, generatedFileName), "FilesToIncludeInFileSystem");
var asset = new VfsEntry ($"supportFiles/{generatedFileName}") {
VirtualPath = targetPath
};
config.Assets.Add(asset);
}
}
if (!InvariantGlobalization)
config.Assets.Add(new IcuData(IcuDataFileName!) { LoadRemote = RemoteSources?.Length > 0 });
config.Assets.Add(new VfsEntry ("dotnet.timezones.blat") { VirtualPath = "/usr/share/zoneinfo/"});
if (RemoteSources?.Length > 0)
{
foreach (var source in RemoteSources)
if (source != null && source.ItemSpec != null)
config.RemoteSources.Add(source.ItemSpec);
}
foreach (ITaskItem extra in ExtraConfig ?? Enumerable.Empty<ITaskItem>())
{
string name = extra.ItemSpec;
if (!TryParseExtraConfigValue(extra, out object? valueObject))
return false;
config.Extra[name] = valueObject;
}
string tmpMonoConfigPath = Path.GetTempFileName();
using (var sw = File.CreateText(tmpMonoConfigPath))
{
var json = JsonSerializer.Serialize (config, new JsonSerializerOptions { WriteIndented = true });
sw.Write(json);
}
string monoConfigPath = Path.Combine(AppDir, "mono-config.json");
Utils.CopyIfDifferent(tmpMonoConfigPath, monoConfigPath, useHash: false);
_fileWrites.Add(monoConfigPath);
if (ExtraFilesToDeploy != null)
{
foreach (ITaskItem item in ExtraFilesToDeploy!)
{
string src = item.ItemSpec;
string dst;
string tgtPath = item.GetMetadata("TargetPath");
if (!string.IsNullOrEmpty(tgtPath))
{
dst = Path.Combine(AppDir!, tgtPath);
string? dstDir = Path.GetDirectoryName(dst);
if (!string.IsNullOrEmpty(dstDir) && !Directory.Exists(dstDir))
Directory.CreateDirectory(dstDir!);
}
else
{
dst = Path.Combine(AppDir!, Path.GetFileName(src));
}
if (!FileCopyChecked(src, dst, "ExtraFilesToDeploy"))
return false;
}
}
return !Log.HasLoggedErrors;
}
private bool TryParseExtraConfigValue(ITaskItem extraItem, out object? valueObject)
{
valueObject = null;
string? rawValue = extraItem.GetMetadata("Value");
if (string.IsNullOrEmpty(rawValue))
return true;
if (TryConvert(rawValue, typeof(double), out valueObject) || TryConvert(rawValue, typeof(bool), out valueObject))
return true;
// Try parsing as a quoted string
if (rawValue!.Length > 1 && rawValue![0] == '"' && rawValue![rawValue!.Length - 1] == '"')
{
valueObject = rawValue!.Substring(1, rawValue!.Length - 2);
return true;
}
// try parsing as json
try
{
JsonDocument jdoc = JsonDocument.Parse(rawValue);
valueObject = jdoc.RootElement;
return true;
}
catch (JsonException je)
{
Log.LogError($"ExtraConfig: {extraItem.ItemSpec} with Value={rawValue} cannot be parsed as a number, boolean, string, or json object/array: {je.Message}");
return false;
}
}
private static bool TryConvert(string str, Type type, out object? value)
{
value = null;
try
{
value = Convert.ChangeType(str, type);
return true;
}
catch (Exception ex) when (ex is FormatException || ex is InvalidCastException || ex is OverflowException)
{
return false;
}
}
private bool FileCopyChecked(string src, string dst, string label)
{
if (!File.Exists(src))
{
Log.LogError($"{label} file '{src}' not found");
return false;
}
Log.LogMessage(MessageImportance.Low, $"Copying file from '{src}' to '{dst}'");
try
{
File.Copy(src, dst, true);
_fileWrites.Add(dst);
return true;
}
catch (Exception ex) when (ex is IOException or UnauthorizedAccessException)
{
throw new LogAsErrorException($"{label} Failed to copy {src} to {dst} because {ex.Message}");
}
}
}