Jsdom: jsdomはビデオとオーディオの要素をサポートしていますか?

作成日 2018年02月19日  ·  14コメント  ·  ソース: jsdom/jsdom

基本情報:

  • Node.jsバージョン: 8.94
  • jsdomバージョン: 11.6.2

情報

画像、音声、動画のプリロードをサポートするアセットローダーの単体テスト( avabrowser-env )を実行したいと思います。 jsdomがオーディオ要素とビデオ要素をサポートしているかどうかを知りたいと思いました。 私が作成して呼び出すようにしようとするとvideo.load() (video要素にHTMLVideoElementでそれ自体HTMLMediaElement )、jsdomはこのエラーを返します。

Error: Not implemented: HTMLMediaElement.prototype.load

ビデオとオーディオ要素はサポートされていないと思います。 jsdomでのビデオとオーディオのサポートについては何も見つかりませんでした。おそらく不足していますか?

最も参考になるコメント

jsdomは、メディアの読み込みまたは再生操作をサポートしていません。 回避策として、テストセットアップにいくつかのスタブを追加できます。

window.HTMLMediaElement.prototype.load = () => { /* do nothing */ };
window.HTMLMediaElement.prototype.play = () => { /* do nothing */ };
window.HTMLMediaElement.prototype.pause = () => { /* do nothing */ };
window.HTMLMediaElement.prototype.addTextTrack = () => { /* do nothing */ };

全てのコメント14件

jsdomは、メディアの読み込みまたは再生操作をサポートしていません。 回避策として、テストセットアップにいくつかのスタブを追加できます。

window.HTMLMediaElement.prototype.load = () => { /* do nothing */ };
window.HTMLMediaElement.prototype.play = () => { /* do nothing */ };
window.HTMLMediaElement.prototype.pause = () => { /* do nothing */ };
window.HTMLMediaElement.prototype.addTextTrack = () => { /* do nothing */ };

それが私がここで必要としているものです: HTMLMediaElementsのロード/フェッチをシミュレートする方法。 これを行うことにより、実際のブラウザのようにオーディオとビデオをプリロードしませんよね?

通常、このようなテストにはフェッチは必要ありません。 これらのスタブはjsdom例外を抑制し、ビデオ要素から手動でディスパッチされたイベント( videoElement.dispatchEvent(new window.Event("loading")); )を使用してロジックをテストできるようになります。

了解しました。助けてくれてありがとう、ついにテストを修正しました。 👍

これは私が始めるのに役立ちましたが、私の場合、特定の条件が再生に正しく影響しているかどうかをテストしたいと思います。 play関数とpause関数を置き換えて、メディア要素のpaused変数を設定しようとしましたが、その変数のゲッターしかないというエラーが表示されます。 これはそれをあざけるのを少し難しくします。

私はJSに少し慣れていません。 このような読み取り専用変数をモックアウトする方法はありますか?

@BenBergmanあなたができること:

Object.defineProperty(HTMLMediaElement.prototype, "paused", {
  get() {
    // Your own getter, where `this` refers to the HTMLMediaElement.
  }
});

優れたありがとう! 後世のために、私のゲッターはデフォルト値を説明するために次のように見えます:

get() {
    if (this.mockPaused === undefined) {
        return true;
    }
    return this.mockPaused;
}

この方法でさらに単純にすることができます。

Object.defineProperty(mediaTag, "paused", {
  writable: true,
  value: true,
});

次に、テストでmediaTag.paused = trueまたはmediaTag.paused = falseします。

このアプローチの利点は、TypeScriptを使用している場合にタイプセーフであるということです。 (mediaTag as any).mockPaused = trueようにモックプロパティを設定しないでください。

さらに良い、ありがとう!

ビデオ再生をシミュレートするにはどうすればよいですか?
再生と読み込みをスタブしましたが、ビデオの再生を開始する方法がわかりません(または、再生していると思うので、必要なのは後で何が起こるかだけです)。
Object.defineProperty(HTMLMediaElement.prototype, "play", { get() { document.getElementsByTagName('video')[0].dispatchEvent(new Event('play')); } });

jsdomは、メディアのロードまたは再生操作をサポートしていません。 回避策として、テストセットアップにいくつかのスタブを追加できます。

回避策をありがとう。 ただし、これがデフォルトでサポートされていない理由を尋ねてもよいですか?

jsdomにビデオまたはオーディオプレーヤーを実装した人はまだいません。

これは、 play pauseメソッドとloadedmetadataplayも送信します。 pause ):

// Jest's setup file, setup.js

// Mock data and helper methods
global.window.HTMLMediaElement.prototype._mock = {
  paused: true,
  duration: NaN,
  _loaded: false,
   // Emulates the audio file loading
  _load: function audioInit(audio) {
    // Note: we could actually load the file from this.src and get real duration
    // and other metadata.
    // See for example: https://github.com/59naga/mock-audio-element/blob/master/src/index.js
    // For now, the 'duration' and other metadata has to be set manually in test code.
    audio.dispatchEvent(new Event('loadedmetadata'))
    audio.dispatchEvent(new Event('canplaythrough'))
  },
  // Reset audio object mock data to the initial state
  _resetMock: function resetMock(audio) {
    audio._mock = Object.assign(
      {},
      global.window.HTMLMediaElement.prototype._mock,
    )
  },
}

// Get "paused" value, it is automatically set to true / false when we play / pause the audio.
Object.defineProperty(global.window.HTMLMediaElement.prototype, 'paused', {
  get() {
    return this._mock.paused
  },
})

// Get and set audio duration
Object.defineProperty(global.window.HTMLMediaElement.prototype, 'duration', {
  get() {
    return this._mock.duration
  },
  set(value) {
    // Reset the mock state to initial (paused) when we set the duration.
    this._mock._resetMock(this)
    this._mock.duration = value
  },
})

// Start the playback.
global.window.HTMLMediaElement.prototype.play = function playMock() {
  if (!this._mock._loaded) {
    // emulate the audio file load and metadata initialization
    this._mock._load(this)
  }
  this._mock.paused = false
  this.dispatchEvent(new Event('play'))
  // Note: we could
}

// Pause the playback
global.window.HTMLMediaElement.prototype.pause = function pauseMock() {
  this._mock.paused = true
  this.dispatchEvent(new Event('pause'))
}

そして、テストの例( audio.durationを手動で設定する必要があることに注意してください:

  // Test
  it('creates audio player', async () => {
    // `page` is a wrapper for a page being tested, created in beforeEach
    let player = page.player()

    // Useful to see which properties are defined where.
    // console.log(Object.getOwnPropertyDescriptors(HTMLMediaElement.prototype))
    // console.log(Object.getOwnPropertyDescriptors(HTMLMediaElement))
    // console.log(Object.getOwnPropertyDescriptors(audio))

    let audio = player.find('audio').element as HTMLAudioElement

    let audioEventReceived = false
    audio.addEventListener('play', () => {
      audioEventReceived = true
    })

    // @ts-ignore: error TS2540: Cannot assign to 'duration' because it is a read-only property.
    audio.duration = 300

    expect(audio.paused).toBe(true)
    expect(audio.duration).toBe(300)
    expect(audio.currentTime).toBe(0)

    audio.play()
    audio.currentTime += 30

    expect(audioEventReceived).toBe(true)

    expect(audio.paused).toBe(false)
    expect(audio.duration).toBe(300)
    expect(audio.currentTime).toBe(30.02)
  })

これらの回避策を使用することを検討しましたが、機能を再生するようにブラウザーを再実装する代わりに、 puppeteer使用することにしました。つまり、実際のブラウザーでテストを実行することにしました。 これは私の設定です:

src / reviewer.tests.ts

jest.disableAutomock()
// Use this in a test to pause its execution, allowing you to open the chrome console
// and while keeping the express server running: chrome://inspect/#devices
// jest.setTimeout(2000000000);
// debugger; await new Promise(function(resolve) {});

test('renders test site', async function() {
    let self: any = global;
    let page = self.page;
    let address = process.env.SERVER_ADDRESS;
    console.log(`The server address is '${address}'.`);
    await page.goto(`${address}/single_audio_file.html`);
    await page.waitForSelector('[data-attibute]');

    let is_paused = await page.evaluate(() => {
        let audio = document.getElementById('silence1.mp3') as HTMLAudioElement;
        return audio.paused;
    });
    expect(is_paused).toEqual(true);
});

testfiles / single_audio_file.html

<html>
    <head>
        <title>main webview</title>
        <script src="importsomething.js"></script>
    </head>
    <body>
    <div id="qa">
        <audio id="silence1.mp3" src="silence1.mp3" data-attibute="some" controls></audio>
        <script type="text/javascript">
            // doSomething();
        </script>
    </div>
    </body>
</html>

** globalTeardown.js **

module.exports = async () => {
    global.server.close();
};
** globalSetup.js **
const express = require('express');

module.exports = async () => {
    let server;
    const app = express();

    await new Promise(function(resolve) {
        server = app.listen(0, "127.0.0.1", function() {
            let address = server.address();
            process.env.SERVER_ADDRESS = `http://${address.address}:${address.port}`;
            console.log(`Running static file server on '${process.env.SERVER_ADDRESS}'...`);
            resolve();
        });
    });

    global.server = server;
    app.get('/favicon.ico', (req, res) => res.sendStatus(200));
    app.use(express.static('./testfiles'));
};
** testEnvironment.js **
const puppeteer = require('puppeteer');

// const TestEnvironment = require('jest-environment-node'); // for server node apps
const TestEnvironment = require('jest-environment-jsdom'); // for browser js apps

class ExpressEnvironment extends TestEnvironment {
    constructor(config, context) {
        let cloneconfig = Object.assign({}, config);
        cloneconfig.testURL = process.env.SERVER_ADDRESS;
        super(cloneconfig, context);
    }

    async setup() {
        await super.setup();
        let browser = await puppeteer.launch({
            // headless: false, // show the Chrome window
            // slowMo: 250, // slow things down by 250 ms
            ignoreDefaultArgs: [
                "--mute-audio",
            ],
            args: [
                "--autoplay-policy=no-user-gesture-required",
            ],
        });
        let [page] = await browser.pages(); // reuses/takes the default blank page
        // let page = await this.global.browser.newPage();

        page.on('console', async msg => console[msg._type](
            ...await Promise.all(msg.args().map(arg => arg.jsonValue()))
        ));
        this.global.page = page;
        this.global.browser = browser;
        this.global.jsdom = this.dom;
    }

    async teardown() {
        await this.global.browser.close();
        await super.teardown();
    }

    runScript(script) {
        return super.runScript(script);
    }
}

module.exports = ExpressEnvironment;
** tsconfig.json **
{
  "compilerOptions": {
    "target": "es2017"
  },
  "include": [
    "src/**/*"
  ],
  "exclude": [
    "src/**/*.test.ts"
  ]
}
** package.json **
{
  "scripts": {
    "test": "jest",
  },
  "jest": {
    "testEnvironment": "./testEnvironment.js",
    "globalSetup": "./globalSetup.js",
    "globalTeardown": "./globalTeardown.js",
    "transform": {
      "^.+\\.(ts|tsx)$": "ts-jest"
    }
  },
  "jshintConfig": {
    "esversion": 8
  },
  "dependencies": {
    "typescript": "^3.7.3"
  },
  "devDependencies": {
    "@types/express": "^4.17.6",
    "@types/jest": "^25.2.1",
    "@types/node": "^13.11.1",
    "@types/puppeteer": "^2.0.1",
    "express": "^4.17.1",
    "jest": "^25.3.0",
    "puppeteer": "^3.0.0",
    "ts-jest": "^25.3.1"
  }
}

このページは役に立ちましたか?
0 / 5 - 0 評価