feat(environment-jsdom): allow passing html content to jsdom environm…

…ent (#11950)
jestjs · Oct 16, 2021 · 7f39f0a · 7f39f0a
1 parent ae1f04b
commit 7f39f0a
Show file tree

Hide file tree

Showing 6 changed files with 65 additions and 14 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,8 @@
 
 ### Features
 
+- `[jest-config]` Add `testEnvironmentOptions.html` to apply to jsdom input ([11950](https://github.com/facebook/jest/pull/11950))
+
 ### Fixes
 
 - `[expect]` Tweak and improve types ([#11949](https://github.com/facebook/jest/pull/11949))

diff --git a/docs/Configuration.md b/docs/Configuration.md
@@ -1170,7 +1170,7 @@ beforeAll(() => {
 
 Default: `{}`
 
-Test environment options that will be passed to the `testEnvironment`. The relevant options depend on the environment. For example, you can override options given to [jsdom](https://github.com/jsdom/jsdom) such as `{userAgent: "Agent/007"}`.
+Test environment options that will be passed to the `testEnvironment`. The relevant options depend on the environment. For example, you can override options given to [jsdom](https://github.com/jsdom/jsdom) such as `{html: "<html lang="zh-cmn-Hant"></html>", userAgent: "Agent/007"}`.
 
 ### `testFailureExitCode` \[number]
 

diff --git a/e2e/custom-jsdom-html/__tests__/test.js b/e2e/custom-jsdom-html/__tests__/test.js
@@ -0,0 +1,11 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+test('jsdom custom html', () => {
+  /* eslint-disable-next-line no-undef */
+  expect(document.getElementById('root')).toBeTruthy();
+});
diff --git a/e2e/custom-jsdom-html/babel.config.js b/e2e/custom-jsdom-html/babel.config.js
@@ -0,0 +1,19 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+module.exports = {
+  presets: [
+    [
+      '@babel/env',
+      {
+        targets: {
+          node: 'current',
+        },
+      },
+    ],
+  ],
+};
diff --git a/e2e/custom-jsdom-html/package.json b/e2e/custom-jsdom-html/package.json
@@ -0,0 +1,12 @@
+{
+  "dependencies": {
+    "@babel/core": "^7.2.2",
+    "@babel/preset-env": "^7.2.2"
+  },
+  "jest": {
+    "testEnvironment": "jsdom",
+    "testEnvironmentOptions": {
+      "html": "<div id=\"root\"></div>"
+    }
+  }
+}
diff --git a/packages/jest-environment-jsdom/src/index.ts b/packages/jest-environment-jsdom/src/index.ts
@@ -31,19 +31,26 @@ class JSDOMEnvironment implements JestEnvironment<number> {
   moduleMocker: ModuleMocker | null;
 
   constructor(config: Config.ProjectConfig, options?: EnvironmentContext) {
-    this.dom = new JSDOM('<!DOCTYPE html>', {
-      pretendToBeVisual: true,
-      resources:
-        typeof config.testEnvironmentOptions.userAgent === 'string'
-          ? new ResourceLoader({
-              userAgent: config.testEnvironmentOptions.userAgent,
-            })
-          : undefined,
-      runScripts: 'dangerously',
-      url: config.testURL,
-      virtualConsole: new VirtualConsole().sendTo(options?.console || console),
-      ...config.testEnvironmentOptions,
-    });
+    this.dom = new JSDOM(
+      typeof config.testEnvironmentOptions.html === 'string'
+        ? config.testEnvironmentOptions.html
+        : '<!DOCTYPE html>',
+      {
+        pretendToBeVisual: true,
+        resources:
+          typeof config.testEnvironmentOptions.userAgent === 'string'
+            ? new ResourceLoader({
+                userAgent: config.testEnvironmentOptions.userAgent,
+              })
+            : undefined,
+        runScripts: 'dangerously',
+        url: config.testURL,
+        virtualConsole: new VirtualConsole().sendTo(
+          options?.console || console,
+        ),
+        ...config.testEnvironmentOptions,
+      },
+    );
     const global = (this.global = this.dom.window.document
       .defaultView as unknown as Win);