ClearScript.Runtime
C# PowerShell JavaScript HTML CSS Shell
Latest commit 8cd528d Mar 4, 2015 @eswann Updated version number
Permalink
Failed to load latest commit information.
deploy
img
src
.gitignore
LICENSE
README.md

README.md

ClearScript.Manager

Build status

ClearScript Manager was created to encapsulate the use of the ClearScript V8 engine in multi-use scenarios, like in a hosted server project (Ex: for use in a Web App or Web API).

ClearScript is an awesome library that was created to allow execution of JavaScript via V8 from the .Net runtime. It's a great project but it needed a few extra things in certain situations that aren't in the core goals of ClearScript itself. ClearScript also runs VBScript and JScript but those are not in the scope of ClearScript.Manager at the current time.

It should be noted that the package also installs the latest version of ClearScript (5.4) via ClearScript.Installer. In addition, both ClearScript and ClearScript.Manager are compiled against .Net 4.5.

Here are a couple of the related discussions on the clearscript forum:

https://clearscript.codeplex.com/discussions/535693
https://clearscript.codeplex.com/discussions/533516

And the ClearScript site: https://clearscript.codeplex.com

Along those lines, ClearScript.Manager does the following to make certain things easier in your server project:

  • Downloads and adds the ClearScript dlls appropriately.
  • Creates a configurable pool of V8 Runtimes that are cached and reused.
    • Pools have a configurable number of max instances.
    • Behavior when attempting to retrieve a V8 Runtime is to block until a V8 engine becomes available.
  • Because V8 Runtimes have affinity for compiled scripts, it compiles and caches scripts for each V8 Runtime instance.
  • Attempts to better contain running V8 scripts by:
    • Setting up a Task in which the script is run with a configurable timeout.
    • Allow easy management of the memory usage of each instance of the V8 Runtime and sets the limits to a much lower threshold than the default V8 settings.

Configuration Parameters

These settings can be set manually or added to the AppSettings of your application config file.

//V8 Max Executable Size in bytes:  
int MaxExecutableBytes { get; }

//V8 Max New Space in bytes:
int MaxNewSpaceBytes { get; }

//V8 Max Old Space in bytes:  
int MaxOldSpaceBytes { get; }

//Default script timeout in ms.  
//If the script timeout is set to 0, the script will not execute within a Task with a timeout.
int ScriptTimeoutMilliSeconds { get; }  

//Max number of simultaneous V8 Runtimes:  
int RuntimeMaxCount { get; }

//Per Runtime, the maximum number of cached scripts:  
int ScriptCacheMaxCount { get; }

//The default script cache expiration in seconds:  
int ScriptCacheExpirationSeconds { get; }

//Is V8 debugging enabled
bool V8DebugEnabled {get;}

//What is the V8 Debug port to connect on.  Default is 9222.
bool V8DebugPort {get;}

Using the Runtime Manager

Running Basic JavaScript

Grab a runtime manager and use the ExecuteAsync method.

var manager = new RuntimeManager(new ManagerSettings());  
await manager.ExecuteAsync("test", "var i = 0; i++;");

The V8 scripting engine can be accessed as the return from ExecuteAsync() in order to access the script variables via dynamic properties.

var manager = new RuntimeManager(new ManagerSettings());  
var engine = await manager.ExecuteAsync("test", "var i = 0; i++;");
var val = engine.Script.i;

Running Multiple Scripts

To run multiple scripts, use the ExecuteAsync that accepts an enumerable of scripts. Scripts will be run in order.
Settings will be applied to all scripts in the collection. Scripts can be actual code, a local file path or a Uri. Using an http Uri is dependent on the ClearScript.Manager.Http package as that installs the newest Microsoft.Net.Http package.

await manager.ExecuteAsync(new List<IncludeScript>
{
    new IncludeScript {Uri = ".\\TestMainScript.js", ScriptId = "testScript"},
    new IncludeScript {Code = "subject.TestString = 'test string3';", ScriptId = "testScript3"},
    //Requires ClearScript.Manager.Http
    new IncludeScript {Uri = "https://www.myscriptishere.org/script.txt", ScriptId = "TestScript4"}
});

Execution Options

Execution options are the new way of passing options to the ClearScript runtime manager.

/// Objects to inject into the JavaScript runtime.
public IEnumerable<HostObject> HostObjects

/// Types to make available to the JavaScript runtime.
public IEnumerable<HostType> HostTypes

/// Indicates that this script should be added to the script cache once compiled.  
/// Default is True.
public bool AddToCache

/// External JavaScripts to import before executing the current script.
public IList<IncludeScript> Scripts

Passing in Host Objects

Host objects are a way of passing an object instance to JavaScript from .Net.

var subject = new TestObject{Name = "Name", Count = 0};
var manager = new RuntimeManager(new ManualManagerSettings());

await manager.ExecuteAsync("testscript", "subject.Count = 10;",
    new ExecutionOptions{HostObjects = 
        new List<HostObject> {new HostObject {Name = "subject", Target = subject}}});

Passing in Host Types

Host types allow you to instantiate a .Net type or types in the JavaScript runtime.

var manager = new RuntimeManager(new ManagerSettings());
var hostType = new HostType
{
    Name = "MathStuff",
    Type = typeof(System.Math)
};
var subject = new TestObject();

await manager.ExecuteAsync("testscript", "subject.Result = MathStuff.Pow(10,2);", 
    new ExecutionOptions{
    HostObjects = new List<HostObject> { new HostObject { Name = "subject", Target = subject } }, 
    HostTypes = new List<HostType> { hostType }});

Passing in Included Scripts

Included scripts can also be run by setting the IncludeScripts property on the ExecutionOptions. These scripts are intended to set up reused libraries and will be run before the execution of the main script.

A script can be set up in a couple of ways:

  • Set a file path or url in the Uri property.
  • Set the code property to the code to execute.

The script will be compiled and cached in the same way as a normal script.

public class IncludeScript
{
    /// Unique name of the script to execute.
    public string Name { get; set; }

    /// Uri (file or Url) of the script to execute.  Need to include script code or script Url.
    public string Uri { get; set; }

    /// Code of the script to include.  Need to include script code or script Url.
    public string Code { get; set; }
}

Using Require

Another way to include scripts and host objects is to use the require. Require is meant to bring in dependencies for the current script in the manner that javascript frameworks (like node) do. So instead of including scripts, your script can instead use require in the script itself.

//In javscript, import the request object/library
//FYI: request is a require package included as part of the ClearScript.Manager.Http nuget package
var request = require('request');
//Now use it to perform a request
request({url: 'http://api.icndb.com/jokes/random/1', json: true},
        function (error, response, body) {
            subject.Response = response; 
            subject.Body = body; 
            subject.Joke = body.value[0].joke; 
            scriptAwaiter.Callback();
        });

Require can accept:

  • The name of an existing RequirePackage

    var subject = new TestObject(); var manager = new RuntimeManager(new ManualManagerSettings {ScriptTimeoutMilliSeconds = 0});

    //Use the require manager to add a package - probably at startup RequireManager.RegisterPackage( new RequiredPackage { PackageId = "testRequire", ScriptUri = ".\TestRequire.js" });

    //Require the package from inside of javascript await manager.ExecuteAsync("testscript", "var testObject = require('testRequire'); subject.Count = 10; subject.TestString = testObject.getText();", new ExecutionOptions { HostObjects = new List {new HostObject {Name = "subject", Target = subject}}, });

  • A file path to a local script

    var subject = new TestObject(); var manager = new RuntimeManager(new ManualManagerSettings {ScriptTimeoutMilliSeconds = 0});

    await manager.ExecuteAsync("testscript", @"var testObject = require('.\TestRequire.js'); subject.Count = 10; subject.TestString = testObject.getText();", new ExecutionOptions { HostObjects = new List {new HostObject {Name = "subject", Target = subject}}, });

  • An http Uri to a script (if ClearScript.Manager.Http is installed)

    var subject = new TestObject(); var manager = new RuntimeManager(new ManualManagerSettings {ScriptTimeoutMilliSeconds = 0});

    await manager.ExecuteAsync("testscript", @"var testObject = require('https://randomendpoint.com/testRequire'); subject.Count = 10; subject.TestString = testObject.getText();", new ExecutionOptions { HostObjects = new List {new HostObject {Name = "subject", Target = subject}}, });

Using the Manager Pool

Initialize the Manager Pool

//ManagerSettings should contain the maximum pool count
ManagerPool.InitializeCurrentPool(new ManagerSettings());

Using the Manager Scope to automatically Get/Return a Runtime Manager

using (var scope = new ManagerScope())
{
    await scope.RuntimeManager.ExecuteAsync(name, "var i = 0; i++;");
}

Getting and Returning a Runtime Manager

var runtimeManager = ManagerPool.CurrentPool.GetRuntime()
ManagerPool.CurrentPool.ReturnToPool(runtimeManager);

ClearScript.Manager.Http

This package enables a couple of things. As mentioned above, it lets script references use an http uri as a loading source. But in addition, it also allows you to make node-like http calls from within your script. Currently, this has only been tested in Http Get scenarios, will add better support shortly.

public async void Basic_Http_Get_Body_Is_Retrieved()
{
    var subject = new TestObject();
    var manager = new RuntimeManager(new ManualManagerSettings { ScriptTimeoutMilliSeconds = 0 });

    //Add packages that will be required to perform an http request.
    //These packages are included as part of ClearScript.Manager.Http.
    Requirer.RegisterPackage(new HttpPackage());
    Requirer.RegisterPackage(new RequestPackage());

    //Add in the host object to operate on
    var options = new ExecutionOptions();
    options.HostObjects.Add(new HostObject { Name = "subject", Target = subject });

    //Create a script awaiter...this is to force .net to wait until the javascript is finished on the callback
    //Notice that the scriptAwaiter.Callback is called in javscript http callback.
    //The ScriptAwaiter is included in the ClearScript.Manager.Http package.
    var scriptAwaiter = new ScriptAwaiter();
    options.HostObjects.Add(new HostObject { Name = "scriptAwaiter", Target = scriptAwaiter });

    //Grab a random Chuck Norris joke and assign it to our object in the callback
    var code = "var request = require('request');" +
                "request({url: 'http://api.icndb.com/jokes/random/1', json: true}," +
                " function (error, response, body) {subject.Response = response; subject.Body = body; subject.Joke = body.value[0].joke; scriptAwaiter.Callback();});";

    //Execute the script and await the script awaiter so that we pause until the javascript callback has completed.
    await manager.ExecuteAsync("testScript", code, options);
    await scriptAwaiter.T;

     //Hilarity ensues
    subject.Joke.ShouldNotBeNull();
}

Included Require Packages

  • HttpPackage (http) - Gives access to the .Net Http object.
  • RequestPackage (request) - Gives access to a node-like request object.

Additional examples are available in the unit tests.