[wasm] Convert mono-config.js to mono-config.json #53248

Daniel-Genkin · 2021-05-25T19:33:52Z

WORK IN PROGRESS

This PR renames the mono-config.js file to mono-config.json, updates the contents accordingly and moves it's loading from the DOM to JS.

Why is this needed?
This change is step 0 before adding NodeJS support to the wasm runtime. As NodeJS doesn't have a DOM, we need to load the config file from JS. Moreover, by moving the variable declaration out of the file, we can reduce ambiguity as to what the config variable is. This will also have the added benefit of being able to rename the variable if needed.

What's changed

mono-config.js has been renamed to mono-config.json and the config variable declaration has been removed.
there is now a new js_support.js file that is copied directly (via emssdk pre-js flag) to dotnet.js. This file loads the config file and then fires a callback (onConfigLoaded(config)) once it is loaded with the contents of the config file in the config parameter.
the wasm and debugger samples have been updated to work with this change.
This PR builds on a bunch of fixes that @lewing made in one of his draft PRs. (Should this be removed as it isn't directly related to this PR?)

How it works
Since I use the --pre-js flag, the load_config() is the first function to execute in dotnet.js (even before the emsdk runtime is initialized). Then the emsdk runtime initializes as normal. Lastly the mono runtime is initialized (load config -> runtime initialized -> load mono runtime with args). This solves the previous open question and a few of the comments. Plus it involves minimal changes to other projects that use wasm as they simply just need to add the snippet below to their existing code to make it work.

    config: null,
    onConfigLoaded: function (config) {
        if (!config || config.error){
            console.log("An error occured while loading the config file");
            return;
        }
        Module.config = config;
    },

Things to consider
Since the config file is loaded asynchronously (or at least may be loaded asynchronously), code that requires the use of the config variable must be run after the callback. Therefore, it cannot simply be placed in script tags within HTML as it could before.
Open questions
Is there a better way to do this loading such that there is no need for the callback? Could we include it in the loading process of wasm? If so, how should that be done?
This has been resolved by loading the config before the runtime init.

Also, note that I am very new to this project (I am an intern) so please let me know if there is anything else that should be improved including coding style, better techniques for loading the files and/or anything else.

ghost · 2021-05-25T19:33:57Z

Tagging subscribers to this area: @CoffeeFlux
See info in area-owners.md if you want to be subscribed.

Issue Details

This PR renames the mono-config.js file to mono-config.json, updates the contents accordingly and moves it's loading from the DOM to JS.

Why is this needed?
This change is step 0 before adding NodeJS support to the wasm runtime. As NodeJS doesn't have a DOM, we need to load the config file from JS. Moreover, by moving the variable declaration out of the file, we can reduce ambiguity as to what the config variable is. This will also have the added benefit of being able to rename the variable if needed.

What's changed

mono-config.js has been renamed to mono-config.json and the config variable declaration has been removed.
there is now a new JSSupportLibrary module that is copied directly (via emssdk post-js flag) to dotnet.js. This module has a function load_config which loads the config file and then fires a callback once it is loaded with the contents of the config file.
the wasm and debugger samples have been updated to work with this change.
This PR builds on a bunch of fixes that @lewing made in one of his draft PRs.

Things to consider
Since the config file is loaded asynchronously (or at least may be loaded asynchronously), code that requires the use of the config variable must be run after the callback. Therefore, it cannot simply be placed in script tags within HTML as it could before.

Open questions

Is there a better way to do this loading such that there is no need for the callback? Could we include it in the loading process of wasm? If so, how should that be done?

Also, note that I am very new to this project (I am an intern) so please let me know if there is anything else that should be improved including coding style, better techniques for loading the files and/or anything else.

Author:	Daniel-Genkin
Assignees:	-
Labels:	`area-VM-meta-mono`
Milestone:	-

dnfadmin · 2021-05-25T19:34:06Z

All CLA requirements met.

ghost · 2021-05-25T20:04:35Z

Tagging subscribers to 'arch-wasm': @lewing
See info in area-owners.md if you want to be subscribed.

Issue Details

WORK IN PROGRESS

This PR renames the mono-config.js file to mono-config.json, updates the contents accordingly and moves it's loading from the DOM to JS.

Why is this needed?
This change is step 0 before adding NodeJS support to the wasm runtime. As NodeJS doesn't have a DOM, we need to load the config file from JS. Moreover, by moving the variable declaration out of the file, we can reduce ambiguity as to what the config variable is. This will also have the added benefit of being able to rename the variable if needed.

What's changed

mono-config.js has been renamed to mono-config.json and the config variable declaration has been removed.
there is now a new JSSupportLibrary module that is copied directly (via emssdk post-js flag) to dotnet.js. This module has a function load_config which loads the config file and then fires a callback once it is loaded with the contents of the config file.
the wasm and debugger samples have been updated to work with this change.
This PR builds on a bunch of fixes that @lewing made in one of his draft PRs.

Things to consider
Since the config file is loaded asynchronously (or at least may be loaded asynchronously), code that requires the use of the config variable must be run after the callback. Therefore, it cannot simply be placed in script tags within HTML as it could before.

Open questions

Is there a better way to do this loading such that there is no need for the callback? Could we include it in the loading process of wasm? If so, how should that be done?

Also, note that I am very new to this project (I am an intern) so please let me know if there is anything else that should be improved including coding style, better techniques for loading the files and/or anything else.

Author:	Daniel-Genkin
Assignees:	-
Labels:	`arch-wasm`, `area-VM-meta-mono`
Milestone:	-

src/mono/wasm/runtime/js_support.js

src/mono/sample/wasm/browser-bench/runtime.js

src/mono/wasm/debugger/tests/debugger-test/runtime-debugger.js

src/tests/FunctionalTests/WebAssembly/Browser/AOT/runtime.js

src/mono/wasm/wasm.proj

src/mono/wasm/runtime/js_support.js

src/mono/wasm/debugger/tests/debugger-test/runtime-debugger.js

radical · 2021-05-25T21:03:48Z

src/mono/wasm/runtime-test.js

+if (is_node) {
+	eval (read ("dotnet.js").toString());
+} else {
+	loadScript ("dotnet.js");
+}


Can we fold this into loadScript itself?

src/mono/wasm/runtime/js_support.js

* Moved R2RDump statistics from console to --out file * Automated the fixup statistics report into a self-maintaining component. * Optimized the minimum values by setting them at the beginning, and removing the Math.Max() calls.

* Hot Reload: test on WebAssembly 1. Always build the assemblies in the ApplyUpdate/ subdirectory without optimization, with debug info. Hot reload depends on it. 2. Pass the required environment variable to the runtime via xharness to enable support for applying updates. * Add ApplyUpdate test assemblies to test project linker descriptor * Fix wasm EnableAggressiveTrimming lane

…53135)

* add NotNullWhen attribute * add usings

* Parse DOTNET_PROCESSOR_COUNT with a 10 radix not 16 * Update test for DOTNET_PROCESSOR_COUNT

…vents on Mono. (#53020) * Add native JIT event into EventPipe. * Emit module/assembly load native events into EventPipe. * Emit MethodDCEnd_V1 and MethodILToNativeMap EventPipe events.

…ons ref (#53199)

#3601 Bundling should generate id based on the content in order to secure unique but reproducible ids

We're still having capacity issues even after doubling the number of devices. Only run device tests on the rolling build for the time being. Co-authored-by: Steve Pfister <steve.pfister@microsoft.com>

- More code sharing for System.Exception - Some support for default interface methods - Move callling convention helpers around to avoid duplication - Unify Environment.StackTrace

…eue (#52771) * Clean up the ExternalObjectContext cache for ComWrappers' RCWs. * Add testing for verifying internal cache clean up.

SymReader::InitializeFromFile opens file handles which were not closed causing resource leaks on each call. Fix #50422 Co-authored-by: Artem Kliatchkine <eldog@rambler.ru>

create SSL dev cert via powershell on helix

* Reduce DefaultPooledConnectionIdleTimeout default - Change DefaultPooledConnectionIdleTimeout from 120 seconds to 60 seconds - This should reduce the occurrence of socket errors when connected to IIS or Kestrel

…-to-json

…el-Genkin/runtime into wasm-convert-config-to-json

Daniel-Genkin · 2021-06-01T19:10:09Z

Just to clarify what just happened, I originally made this branch from one of Larry's. So now I rebased to remove Larry's changes and then merged the current dotnet/runtime main into this branch.

EDIT: This inadvertently made the PR a mess. So I am going to close this one and open another that will do the same thing but be much more clear with it's history and number of commits.

Daniel-Genkin · 2021-06-02T14:55:12Z

Closing as I have made a new PR that is cleaner: #53606

lewing and others added 4 commits May 20, 2021 14:39

Generalize the test runner a bit

cf801ca

checkpoint

ed4f9be

converted mono-config.js to mono-config.json

5177380

Fixed tests as config is loaded async now

5b24b97

dotnet-issue-labeler bot added the area-VM-meta-mono label May 25, 2021

Daniel-Genkin added 3 commits May 25, 2021 15:55

added line to end of file + more comments

03856e1

Merge branch 'main' into wasm-convert-config-to-json

0bd956f

added space that was accidentally removed

b2b93b8

thaystg added the arch-wasm WebAssembly architecture label May 25, 2021

thaystg reviewed May 25, 2021

View reviewed changes

src/mono/wasm/runtime/js_support.js Outdated Show resolved Hide resolved

thaystg reviewed May 25, 2021

View reviewed changes

src/mono/sample/wasm/browser-bench/runtime.js Outdated Show resolved Hide resolved

thaystg reviewed May 25, 2021

View reviewed changes

src/mono/wasm/debugger/tests/debugger-test/runtime-debugger.js Outdated Show resolved Hide resolved

thaystg reviewed May 25, 2021

View reviewed changes

src/tests/FunctionalTests/WebAssembly/Browser/AOT/runtime.js Outdated Show resolved Hide resolved

radical reviewed May 25, 2021

View reviewed changes

src/mono/wasm/runtime/js_support.js Outdated Show resolved Hide resolved

Daniel-Genkin added 5 commits May 25, 2021 17:08

Addressed some PR comments

77d39db

Addressed a few more PR comments

a2f48fb

changed post-js to pre-js

7fe322f

Fixed samples

8438e67

Fixed console sample

261c133

This was referenced May 27, 2021

FileSystemWatcher_DirectorySymbolicLink_TargetsFile_Fails #53366

Open

leakwheel failing in CI #53452

Closed

Daniel-Genkin and others added 4 commits June 1, 2021 13:51

converted mono-config.js to mono-config.json

dca4bbc

Fixed tests as config is loaded async now

c3d996d

added line to end of file + more comments

f14f412

jkotas and others added 26 commits June 1, 2021 13:56

Delete redundant area-owners entries (#53188)

82053b5

Add more natvis visualizations for base VM types. (#53052)

9853434

Fix handling of non-mergeable char classes in regex prefix analyzer (#…

e3d66af

…53135)

System.ComponentModel.* missed Equals nullable annotations (#52163)

e6d833c

* add NotNullWhen attribute * add usings

GT_COPY source should be marked as consume during resolution (#53041)

129d20e

Delete now unused *AsyncResult files from Sockets (#53192)

5cea8eb

Parse DOTNET_PROCESSOR_COUNT with a 10 radix not 16 (#53208)

d0d7705

* Parse DOTNET_PROCESSOR_COUNT with a 10 radix not 16 * Update test for DOTNET_PROCESSOR_COUNT

Emit JITStarting, MethodLoad, ModuleLoad and AssemblyLoad EventPipe e…

fff0076

…vents on Mono. (#53020) * Add native JIT event into EventPipe. * Emit module/assembly load native events into EventPipe. * Emit MethodDCEnd_V1 and MethodILToNativeMap EventPipe events.

make networking easier to debug with console (#53178)

9e81f6d

Fix missing nullable enable in Microsoft.Extensions.Logging.Abstracti…

1388775

…ons ref (#53199)

Deterministic bundling issue 3601 (#52930)

ae88cc0

#3601 Bundling should generate id based on the content in order to secure unique but reproducible ids

[Android] Revert arm and arm64 device PR runs (#53210)

60c0b90

We're still having capacity issues even after doubling the number of devices. Only run device tests on the rolling build for the time being. Co-authored-by: Steve Pfister <steve.pfister@microsoft.com>

Integrate selected changes from nativeaot branch (#53185)

d8efff2

- More code sharing for System.Exception - Some support for default interface methods - Move callling convention helpers around to avoid duplication - Unify Environment.StackTrace

Cleanup internal ComWrappers cache when object enters Finalization qu…

1e5199b

…eue (#52771) * Clean up the ExternalObjectContext cache for ComWrappers' RCWs. * Add testing for verifying internal cache clean up.

Remove unused code from old IJW path (#53190)

8162eb2

Closing opened handles to avoid resource leak. (#51950)

6218d6e

SymReader::InitializeFromFile opens file handles which were not closed causing resource leaks on each call. Fix #50422 Co-authored-by: Artem Kliatchkine <eldog@rambler.ru>

[wasm][testing] create dev cert via powershell on helix (#53225)

b0cb47a

create SSL dev cert via powershell on helix

Reduce DefaultPooledConnectionIdleTimeout default (#52687)

faeba22

* Reduce DefaultPooledConnectionIdleTimeout default - Change DefaultPooledConnectionIdleTimeout from 120 seconds to 60 seconds - This should reduce the occurrence of socket errors when connected to IIS or Kestrel

Addressed some PR comments

3c0cf22

Addressed a few more PR comments

9469eec

changed post-js to pre-js

9e8af01

Fixed samples

c0ba6d4

Fixed console sample

9c93d7a

Merge remote-tracking branch 'upstream/main' into wasm-convert-config…

2927c77

…-to-json

Merge branch 'wasm-convert-config-to-json' of https://github.com/Dani…

93a7f31

…el-Genkin/runtime into wasm-convert-config-to-json

Daniel-Genkin closed this Jun 2, 2021

ghost locked as resolved and limited conversation to collaborators Jul 2, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[wasm] Convert mono-config.js to mono-config.json #53248

[wasm] Convert mono-config.js to mono-config.json #53248

Daniel-Genkin commented May 25, 2021 •

edited

Loading

ghost commented May 25, 2021

dnfadmin commented May 25, 2021 •

edited

Loading

ghost commented May 25, 2021

WORK IN PROGRESS

radical May 25, 2021

Daniel-Genkin commented Jun 1, 2021 •

edited

Loading

Daniel-Genkin commented Jun 2, 2021

[wasm] Convert mono-config.js to mono-config.json #53248

[wasm] Convert mono-config.js to mono-config.json #53248

Conversation

Daniel-Genkin commented May 25, 2021 • edited Loading

WORK IN PROGRESS

ghost commented May 25, 2021

dnfadmin commented May 25, 2021 • edited Loading

ghost commented May 25, 2021

WORK IN PROGRESS

radical May 25, 2021

Choose a reason for hiding this comment

Daniel-Genkin commented Jun 1, 2021 • edited Loading

Daniel-Genkin commented Jun 2, 2021

Daniel-Genkin commented May 25, 2021 •

edited

Loading

dnfadmin commented May 25, 2021 •

edited

Loading

Daniel-Genkin commented Jun 1, 2021 •

edited

Loading