Powershell Code is working well on Powershell.exe and Powershell ISE but not working on VS Code

[vladpopov]

I'm trying to validate Json against Schema using Powershell and Newtonsoft dlls. My script is working well as expected if I run it on Powershell.exe or Powershell ISE but it isn't working if I run it using VS Code (on same PC).

$Json_file = "D:\Json\file_sample.json"
$Json_file_wrong = "D:\Json\file_sample_wrong.json"
$Json_Schema_file = "D:\Json\schema_sample.json"

$Json = Get-Content $Json_file
$Json_wrong = Get-Content $Json_file_wrong
$SchemaJson = Get-Content $Json_Schema_file

$Json_dll = "D:\Json\Json110r1\Bin\net45\Newtonsoft.Json.dll"
$Json_Schema_dll = "D:\Json\JsonSchema30r9\Bin\net45\Newtonsoft.Json.Schema.dll"

Add-Type -Path $Json_dll
Add-Type -Path $Json_Schema_dll

$source = @'
    public class Validator
    {
        public static System.Collections.Generic.IList<string> Validate(Newtonsoft.Json.Linq.JToken token, Newtonsoft.Json.Schema.JSchema schema)
        {
            System.Collections.Generic.IList<string> messages;
            Newtonsoft.Json.Schema.SchemaExtensions.IsValid(token, schema, out messages);

            return messages;
        }
    }
'@
Add-Type -TypeDefinition $source -ReferencedAssemblies $Json_dll, $Json_Schema_dll

function Validate_Json_Against_Schema {
    param (
    [Parameter(Mandatory=$True)] $Json_param,
    [Parameter(Mandatory=$True)] $Schema_param
    )
$valid = $false

$Token = [Newtonsoft.Json.Linq.JToken]::Parse($Json_param)
$Schema = [Newtonsoft.Json.Schema.JSchema]::Parse($Schema_param)

$result = [Validator]::Validate($Token,$Schema)

if ($result.Count -eq 0)
    {
    $valid = $true
    }
return $valid
}

Validate_Json_Against_Schema $Json $SchemaJson
Validate_Json_Against_Schema $Json_wrong $SchemaJson

If I run it using VS Code (version 1.12.1, Powershell extension version 1.6.0) I have such error:

Cannot convert argument "token", with value: "{
  "shipping_address": {
    "street_address": "1600 Pennsylvania Avenue NW",
    "city": "Washington",
    "state": "DC"
  }
}", for "Validate" to type "Newtonsoft.Json.Linq.JToken": "Cannot convert the "{
  "shipping_address": {
    "street_address": "1600 Pennsylvania Avenue NW",
    "city": "Washington",
    "state": "DC"
  }
}" value of type "Newtonsoft.Json.Linq.JObject" to type "Newtonsoft.Json.Linq.JToken"."
At C:\Users\popovvg\Desktop\123.ps1:39 char:1
+ $result = [Validator]::Validate($Token,$Schema)
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : NotSpecified: (:) [], MethodException
    + FullyQualifiedErrorId : MethodArgumentConversionInvalidCastArgument

My OS is fully updates Windows 10 x64.

$PSVersionTable

Name                           Value                                                                                                                               
----                           -----                                                                                                                               
PSVersion                      5.1.16299.98                                                                                                                        
PSEdition                      Desktop                                                                                                                             
PSCompatibleVersions           {1.0, 2.0, 3.0, 4.0...}                                                                                                             
BuildVersion                   10.0.16299.98                                                                                                                       
CLRVersion                     4.0.30319.42000                                                                                                                     
WSManStackVersion              3.0                                                                                                                                 
PSRemotingProtocolVersion      2.3                                                                                                                                 
SerializationVersion           1.1.0.1 

Json file:

{
  "shipping_address": {
    "street_address": "1600 Pennsylvania Avenue NW",
    "city": "Washington",
    "state": "DC",
    "type": "business"
  }
}

Schema file:

{
  "$schema": "http://json-schema.org/draft-04/schema#",

  "definitions": {
    "address": {
      "type": "object",
      "properties": {
        "street_address": { "type": "string" },
        "city":           { "type": "string" },
        "state":          { "type": "string" }
      },
      "required": ["street_address", "city", "state"]
    }
  },

  "type": "object",

  "properties": {
    "billing_address": { "$ref": "#/definitions/address" },
    "shipping_address": {
      "allOf": [
        { "$ref": "#/definitions/address" },
        { "properties":
          { "type": { "enum": [ "residential", "business" ] } },
          "required": ["type"]
        }
      ]
    }
  }
}

I tried to run it on Windows 7 x86 - same result. What am I doing wrong?

code -v
1.21.1
79b44aa704ce542d8ca4a3cc44cfca566e7720f1
x64

$pseditor.EditorServicesVersion

Major  Minor  Build  Revision
-----  -----  -----  --------
1      6      0      0

code --list-extensions --show-versions
ms-vscode.PowerShell@1.6.0

Also I asked about my problem on stackoverflow:
https://stackoverflow.com/questions/49383121/powershell-code-is-working-well-on-powershell-exe-and-powershell-ise-but-not-wor

[TylerLeonhardt]

Thanks for the report! If you run this "line-by-line" using F8 to run the selection, does it work in the PowerShell Integrated Console or does it still fail?

[danlorb]

I have the same Issue. Environment is the same. It fails also in the integrated Console.

My Environment is
Windows 7 x64
VSCode 1.23.1
EditorServices 1.7.0.0
PS Extension 1.7.0.0

[rjmholt]

Hi @rolbre, by the same issue do you mean you're also validating against JSON schemas using Newtonsoft DLLs? If not, could you give more information on what you're trying to do so we can try and reproduce it and ideally upload or send us the logs written by the extension as the failure occurs?

[danlorb]

Hi @rjmholt, yes i do the same way as @vladpopov did.
But for now I have an Workaround to avoid this Error. I think Newtonsoft have a Problem when it will used in VSCode. My Workaround is, that i pass string into the C# Codeblock and work only in this Codeblock with Newtonsoft. In PowerShell i will not parsing json with Newtonsoft anymore. So the Problem is gone away ;-) . Tomorrow i will post an Code Snippet to show my Solution.

[rjmholt]

@rolbre That would be fantastic, thanks!

One other possible cause of this problem is that EditorServices itself already has JSON.NET loaded (it is used to deserialise protocol messages). So this may be a side-by-side assembly loading issue. That's the most significant difference I can think of between the Integrated Console and the VSCode PowerShell console/Windows Powershell.

[danlorb]

Here is my Workaround

$source= @"
public class ConfigurationValidator
{
    public static System.Collections.Generic.IList<Newtonsoft.Json.Schema.ValidationError> Validate(string jsonFile, string schemaFile)
    {
        var json = System.IO.File.ReadAllText(jsonFile);
        var schema = System.IO.File.ReadAllText(schemaFile);

        var jToken = Newtonsoft.Json.Linq.JToken.Parse(json);
        var jSchema = Newtonsoft.Json.Schema.JSchema.Parse(schema);

        System.Collections.Generic.IList<Newtonsoft.Json.Schema.ValidationError> errors = new System.Collections.Generic.List<Newtonsoft.Json.Schema.ValidationError>();
        Newtonsoft.Json.Schema.SchemaExtensions.IsValid(jToken, jSchema, out errors);

        return errors;
    }
}
"@

try
{
    $newtonsoftJsonPath="$PSScriptRoot\dlls\net45\Newtonsoft.Json.dll"
    $newtonsoftJsonSchemaPath="$PSScriptRoot\dlls\net45\Newtonsoft.Json.Schema.dll"

    Add-Type -Path $newtonsoftJsonPath
    Add-Type -Path $newtonsoftJsonSchemaPath

    $exists= [System.Type]::GetType("ConfigurationValidator")
    if($exists -eq $null)
    {
        Add-Type -TypeDefinition $source -IgnoreWarnings -ReferencedAssemblies $newtonsoftJsonPath, $newtonsoftJsonSchemaPath
    }
}
catch
{
    Write-Host $_.Exception.Message
}

# How to Use
$validationErrors=[ConfigurationValidator]::Validate($ConfigFile, $SchemeFile)

[TylerLeonhardt]

If this is a side-by-side assembly loading issue, I recommend taking a look at this issue:
#1316

where someone used a binding redirect in order specify the version of Newtonsoft.json they wanted to use.