ResourceLoaderModuleTest.php

Go to the documentation of this file.

<?php
 
class ResourceLoaderModuleTest extends ResourceLoaderTestCase {
 
    public function testGetVersionHash() {
        $context = $this->getResourceLoaderContext();
 
        $baseParams = [
            'scripts' => [ 'foo.js', 'bar.js' ],
            'dependencies' => [ 'jquery', 'mediawiki' ],
            'messages' => [ 'hello', 'world' ],
        ];
 
        $module = new ResourceLoaderFileModule( $baseParams );
        $version = json_encode( $module->getVersionHash( $context ) );
 
        // Exactly the same
        $module = new ResourceLoaderFileModule( $baseParams );
        $this->assertEquals(
            $version,
            json_encode( $module->getVersionHash( $context ) ),
            'Instance is insignificant'
        );
 
        // Re-order dependencies
        $module = new ResourceLoaderFileModule( [
            'dependencies' => [ 'mediawiki', 'jquery' ],
        ] + $baseParams );
        $this->assertEquals(
            $version,
            json_encode( $module->getVersionHash( $context ) ),
            'Order of dependencies is insignificant'
        );
 
        // Re-order messages
        $module = new ResourceLoaderFileModule( [
            'messages' => [ 'world', 'hello' ],
        ] + $baseParams );
        $this->assertEquals(
            $version,
            json_encode( $module->getVersionHash( $context ) ),
            'Order of messages is insignificant'
        );
 
        // Re-order scripts
        $module = new ResourceLoaderFileModule( [
            'scripts' => [ 'bar.js', 'foo.js' ],
        ] + $baseParams );
        $this->assertNotEquals(
            $version,
            json_encode( $module->getVersionHash( $context ) ),
            'Order of scripts is significant'
        );
 
        // Subclass
        $module = new ResourceLoaderFileModuleTestModule( $baseParams );
        $this->assertNotEquals(
            $version,
            json_encode( $module->getVersionHash( $context ) ),
            'Class is significant'
        );
    }
 
    public function testGetVersionHash_parentDefinition() {
        $context = $this->getResourceLoaderContext();
        $module = $this->getMockBuilder( ResourceLoaderModule::class )
            ->setMethods( [ 'getDefinitionSummary' ] )->getMock();
        $module->method( 'getDefinitionSummary' )->willReturn( [ 'a' => 'summary' ] );
 
        $this->setExpectedException( LogicException::class, 'must call parent' );
        $module->getVersionHash( $context );
    }
 
    public function testValidateScriptFile() {
        $this->setMwGlobals( 'wgResourceLoaderValidateJS', true );
 
        $context = $this->getResourceLoaderContext();
 
        $module = new ResourceLoaderTestModule( [
            'script' => "var a = 'this is';\n {\ninvalid"
        ] );
        $this->assertEquals(
            'mw.log.error(' .
                '"JavaScript parse error: Parse error: Unexpected token; ' .
                'token } expected in file \'input\' on line 3"' .
            ');',
            $module->getScript( $context ),
            'Replace invalid syntax with error logging'
        );
 
        $module = new ResourceLoaderTestModule( [
            'script' => "\n'valid';"
        ] );
        $this->assertEquals(
            "\n'valid';",
            $module->getScript( $context ),
            'Leave valid scripts as-is'
        );
    }
 
    public static function provideBuildContentScripts() {
        return [
            [
                "mw.foo()",
                "mw.foo()\n",
            ],
            [
                "mw.foo();",
                "mw.foo();\n",
            ],
            [
                "mw.foo();\n",
                "mw.foo();\n",
            ],
            [
                "mw.foo()\n",
                "mw.foo()\n",
            ],
            [
                "mw.foo()\n// mw.bar();",
                "mw.foo()\n// mw.bar();\n",
            ],
            [
                "mw.foo()\n// mw.bar()",
                "mw.foo()\n// mw.bar()\n",
            ],
            [
                "mw.foo()// mw.bar();",
                "mw.foo()// mw.bar();\n",
            ],
        ];
    }
 
    public function testBuildContentScripts( $raw, $build, $message = null ) {
        $context = $this->getResourceLoaderContext();
        $module = new ResourceLoaderTestModule( [
            'script' => $raw
        ] );
        $this->assertEquals( $raw, $module->getScript( $context ), 'Raw script' );
        $this->assertEquals(
            $build,
            $module->getModuleContent( $context )[ 'scripts' ],
            $message
        );
    }
 
    public function testPlaceholderize() {
        $getRelativePaths = new ReflectionMethod( ResourceLoaderModule::class, 'getRelativePaths' );
        $getRelativePaths->setAccessible( true );
        $expandRelativePaths = new ReflectionMethod( ResourceLoaderModule::class, 'expandRelativePaths' );
        $expandRelativePaths->setAccessible( true );
 
        $this->setMwGlobals( [
            'IP' => '/srv/example/mediawiki/core',
        ] );
        $raw = [
                '/srv/example/mediawiki/core/resources/foo.js',
                '/srv/example/mediawiki/core/extensions/Example/modules/bar.js',
                '/srv/example/mediawiki/skins/Example/baz.css',
                '/srv/example/mediawiki/skins/Example/images/quux.png',
        ];
        $canonical = [
                'resources/foo.js',
                'extensions/Example/modules/bar.js',
                '../skins/Example/baz.css',
                '../skins/Example/images/quux.png',
        ];
        $this->assertEquals(
            $canonical,
            $getRelativePaths->invoke( null, $raw ),
            'Insert placeholders'
        );
        $this->assertEquals(
            $raw,
            $expandRelativePaths->invoke( null, $canonical ),
            'Substitute placeholders'
        );
    }
 
    public function testGetHeaders() {
        $context = $this->getResourceLoaderContext();
 
        $module = new ResourceLoaderTestModule();
        $this->assertSame( [], $module->getHeaders( $context ), 'Default' );
 
        $module = $this->getMockBuilder( ResourceLoaderTestModule::class )
            ->setMethods( [ 'getPreloadLinks' ] )->getMock();
        $module->method( 'getPreloadLinks' )->willReturn( [
             'https://example.org/script.js' => [ 'as' => 'script' ],
        ] );
        $this->assertSame(
            [
                'Link: <https://example.org/script.js>;rel=preload;as=script'
            ],
            $module->getHeaders( $context ),
            'Preload one resource'
        );
 
        $module = $this->getMockBuilder( ResourceLoaderTestModule::class )
            ->setMethods( [ 'getPreloadLinks' ] )->getMock();
        $module->method( 'getPreloadLinks' )->willReturn( [
             'https://example.org/script.js' => [ 'as' => 'script' ],
             '/example.png' => [ 'as' => 'image' ],
        ] );
        $this->assertSame(
            [
                'Link: <https://example.org/script.js>;rel=preload;as=script,' .
                    '</example.png>;rel=preload;as=image'
            ],
            $module->getHeaders( $context ),
            'Preload two resources'
        );
    }
}