FormatJsonTest.php

Go to the documentation of this file.

<?php

class FormatJsonTest extends MediaWikiTestCase {

    public static function provideEncoderPrettyPrinting() {
        return [
            // Four spaces
            [ true, '    ' ],
            [ '    ', '    ' ],
            // Two spaces
            [ '  ', '  ' ],
            // One tab
            [ "\t", "\t" ],
        ];
    }

    public function testEncoderPrettyPrinting( $pretty, $expectedIndent ) {
        $obj = [
            'emptyObject' => new stdClass,
            'emptyArray' => [],
            'string' => 'foobar\\',
            'filledArray' => [
                [
                    123,
                    456,
                ],
                // Nested json works without problems
                '"7":["8",{"9":"10"}]',
                // Whitespace clean up doesn't touch strings that look alike
                "{\n\t\"emptyObject\": {\n\t},\n\t\"emptyArray\": [ ]\n}",
            ],
        ];

        // No trailing whitespace, no trailing linefeed
        $json = '{
    "emptyObject": {},
    "emptyArray": [],
    "string": "foobar\\\\",
    "filledArray": [
        [
            123,
            456
        ],
        "\"7\":[\"8\",{\"9\":\"10\"}]",
        "{\n\t\"emptyObject\": {\n\t},\n\t\"emptyArray\": [ ]\n}"
    ]
}';

        $json = str_replace( "\r", '', $json ); // Windows compat
        $json = str_replace( "\t", $expectedIndent, $json );
        $this->assertSame( $json, FormatJson::encode( $obj, $pretty ) );
    }

    public static function provideEncodeDefault() {
        return self::getEncodeTestCases( [] );
    }

    public function testEncodeDefault( $from, $to ) {
        $this->assertSame( $to, FormatJson::encode( $from ) );
    }

    public static function provideEncodeUtf8() {
        return self::getEncodeTestCases( [ 'unicode' ] );
    }

    public function testEncodeUtf8( $from, $to ) {
        $this->assertSame( $to, FormatJson::encode( $from, false, FormatJson::UTF8_OK ) );
    }

    public static function provideEncodeXmlMeta() {
        return self::getEncodeTestCases( [ 'xmlmeta' ] );
    }

    public function testEncodeXmlMeta( $from, $to ) {
        $this->assertSame( $to, FormatJson::encode( $from, false, FormatJson::XMLMETA_OK ) );
    }

    public static function provideEncodeAllOk() {
        return self::getEncodeTestCases( [ 'unicode', 'xmlmeta' ] );
    }

    public function testEncodeAllOk( $from, $to ) {
        $this->assertSame( $to, FormatJson::encode( $from, false, FormatJson::ALL_OK ) );
    }

    public function testEncodePhpBug46944() {
        $this->assertNotEquals(
            '\ud840\udc00',
            strtolower( FormatJson::encode( "\xf0\xa0\x80\x80" ) ),
            'Test encoding an broken json_encode character (U+20000)'
        );
    }

    public function testDecodeReturnType() {
        $this->assertInternalType(
            'object',
            FormatJson::decode( '{"Name": "Cheeso", "Rank": 7}' ),
            'Default to object'
        );

        $this->assertInternalType(
            'array',
            FormatJson::decode( '{"Name": "Cheeso", "Rank": 7}', true ),
            'Optional array'
        );
    }

    public static function provideParse() {
        return [
            [ null ],
            [ true ],
            [ false ],
            [ 0 ],
            [ 1 ],
            [ 1.2 ],
            [ '' ],
            [ 'str' ],
            [ [ 0, 1, 2 ] ],
            [ [ 'a' => 'b' ] ],
            [ [ 'a' => 'b' ] ],
            [ [ 'a' => 'b', 'x' => [ 'c' => 'd' ] ] ],
        ];
    }

    public static function toObject( $value ) {
        return !is_array( $value ) ? $value : (object) array_map( __METHOD__, $value );
    }

    public function testParse( $value ) {
        $expected = self::toObject( $value );
        $json = FormatJson::encode( $expected, false, FormatJson::ALL_OK );
        $this->assertJson( $json );

        $st = FormatJson::parse( $json );
        $this->assertInstanceOf( 'Status', $st );
        $this->assertTrue( $st->isGood() );
        $this->assertEquals( $expected, $st->getValue() );

        $st = FormatJson::parse( $json, FormatJson::FORCE_ASSOC );
        $this->assertInstanceOf( 'Status', $st );
        $this->assertTrue( $st->isGood() );
        $this->assertEquals( $value, $st->getValue() );
    }

    public static function provideParseTryFixing() {
        return [
            [ "[,]", '[]', false ],
            [ "[ , ]", '[]', false ],
            [ "[ , }", false ],
            [ '[1],', false, true, '[1]' ],
            [ "[1,]", '[1]' ],
            [ "[1\n,]", '[1]' ],
            [ "[1,\n]", '[1]' ],
            [ "[1,]\n", '[1]' ],
            [ "[1\n,\n]\n", '[1]' ],
            [ '["a,",]', '["a,"]' ],
            [ "[[1,]\n,[2,\n],[3\n,]]", '[[1],[2],[3]]' ],
            // I wish we could parse this, but would need quote parsing
            [ '[[1,],[2,],[3,]]', false, true, '[[1],[2],[3]]' ],
            [ '[1,,]', false, false, '[1]' ],
        ];
    }

    public function testParseTryFixing(
        $value, $expected,
        $jsoncParses = true, $expectedJsonc = null
    ) {
        // PHP5 results are always expected to have isGood() === false
        $expectedGoodStatus = false;

        // Check to see if json parser allows trailing commas
        if ( json_decode( '[1,]' ) !== null ) {
            // Use json-c specific expected result if provided
            $expected = ( $expectedJsonc === null ) ? $expected : $expectedJsonc;
            // If json-c parses the value natively, expect isGood() === true
            $expectedGoodStatus = $jsoncParses;
        }

        $st = FormatJson::parse( $value, FormatJson::TRY_FIXING );
        $this->assertInstanceOf( 'Status', $st );
        if ( $expected === false ) {
            $this->assertFalse( $st->isOK(), 'Expected isOK() == false' );
        } else {
            $this->assertSame( $expectedGoodStatus, $st->isGood(),
                'Expected isGood() == ' . ( $expectedGoodStatus ? 'true' : 'false' )
            );
            $this->assertTrue( $st->isOK(), 'Expected isOK == true' );
            $val = FormatJson::encode( $st->getValue(), false, FormatJson::ALL_OK );
            $this->assertEquals( $expected, $val );
        }
    }

    public static function provideParseErrors() {
        return [
            [ 'aaa' ],
            [ '{"j": 1 ] }' ],
        ];
    }

    public function testParseErrors( $value ) {
        $st = FormatJson::parse( $value );
        $this->assertInstanceOf( 'Status', $st );
        $this->assertFalse( $st->isOK() );
    }

    public function provideStripComments() {
        return [
            [ '{"a":"b"}', '{"a":"b"}' ],
            [ "{\"a\":\"b\"}\n", "{\"a\":\"b\"}\n" ],
            [ '/*c*/{"c":"b"}', '{"c":"b"}' ],
            [ '{"a":"c"}/*c*/', '{"a":"c"}' ],
            [ '/*c//d*/{"c":"b"}', '{"c":"b"}' ],
            [ '{/*c*/"c":"b"}', '{"c":"b"}' ],
            [ "/*\nc\r\n*/{\"c\":\"b\"}", '{"c":"b"}' ],
            [ "//c\n{\"c\":\"b\"}", '{"c":"b"}' ],
            [ "//c\r\n{\"c\":\"b\"}", '{"c":"b"}' ],
            [ '{"a":"c"}//c', '{"a":"c"}' ],
            [ "{\"a-c\"://c\n\"b\"}", '{"a-c":"b"}' ],
            [ '{"/*a":"b"}', '{"/*a":"b"}' ],
            [ '{"a":"//b"}', '{"a":"//b"}' ],
            [ '{"a":"b/*c*/"}', '{"a":"b/*c*/"}' ],
            [ "{\"\\\"/*a\":\"b\"}", "{\"\\\"/*a\":\"b\"}" ],
            [ '', '' ],
            [ '/*c', '' ],
            [ '//c', '' ],
            [ '"http://example.com"', '"http://example.com"' ],
            [ "\0", "\0" ],
            [ '"Blåbærsyltetøy"', '"Blåbærsyltetøy"' ],
        ];
    }

    public function testStripComments( $json, $expect ) {
        $this->assertSame( $expect, FormatJson::stripComments( $json ) );
    }

    public function provideParseStripComments() {
        return [
            [ '/* blah */true', true ],
            [ "// blah \ntrue", true ],
            [ '[ "a" , /* blah */ "b" ]', [ 'a', 'b' ] ],
        ];
    }

    public function testParseStripComments( $json, $expect ) {
        $st = FormatJson::parse( $json, FormatJson::STRIP_COMMENTS );
        $this->assertInstanceOf( 'Status', $st );
        $this->assertTrue( $st->isGood() );
        $this->assertEquals( $expect, $st->getValue() );
    }

    private static function getEncodeTestCases( array $unescapedGroups ) {
        $groups = [
            'always' => [
                // Forward slash (always unescaped)
                '/' => '/',

                // Control characters
                "\0" => '\u0000',
                "\x08" => '\b',
                "\t" => '\t',
                "\n" => '\n',
                "\r" => '\r',
                "\f" => '\f',
                "\x1f" => '\u001f', // representative example

                // Double quotes
                '"' => '\"',

                // Backslashes
                '\\' => '\\\\',
                '\\\\' => '\\\\\\\\',
                '\\u00e9' => '\\\u00e9', // security check for Unicode unescaping

                // Line terminators
                "\xe2\x80\xa8" => '\u2028',
                "\xe2\x80\xa9" => '\u2029',
            ],
            'unicode' => [
                "\xc3\xa9" => '\u00e9',
                "\xf0\x9d\x92\x9e" => '\ud835\udc9e', // U+1D49E, outside the BMP
            ],
            'xmlmeta' => [
                '<' => '\u003C', // JSON_HEX_TAG uses uppercase hex digits
                '>' => '\u003E',
                '&' => '\u0026',
            ],
        ];

        $cases = [];
        foreach ( $groups as $name => $rules ) {
            $leaveUnescaped = in_array( $name, $unescapedGroups );
            foreach ( $rules as $from => $to ) {
                $cases[] = [ $from, '"' . ( $leaveUnescaped ? $from : $to ) . '"' ];
            }
        }

        return $cases;
    }
}