Merge branch 'main' into v3.0.0-dev

Author: rwaskiewicz

.github/dependabot.yml

@@ -16,3 +16,12 @@ updates:
         versions: ['17', '18']
       - dependency-name: 'typescript'
         versions: ['4.8']
+      # disable Jest updates until the new testing architecture is in place
+      - dependency-name: '@types/jest'
+        versions: ['>=28']
+      - dependency-name: 'jest'
+        versions: ['>=28']
+      - dependency-name: 'jest-cli'
+        versions: ['>=28']
+      - dependency-name: 'jest-environment-node'
+        versions: ['>=28']

package-lock.json

@@ -62,7 +62,7 @@
     "@rollup/plugin-json": "4.1.0",
     "@rollup/plugin-node-resolve": "9.0.0",
     "@rollup/plugin-replace": "2.3.4",
-    "@rollup/pluginutils": "4.1.0",
+    "@rollup/pluginutils": "4.2.1",
     "@types/eslint": "^8.4.6",
     "@types/exit": "^0.1.31",
     "@types/fs-extra": "^9.0.8",
@@ -71,10 +71,10 @@
     "@types/inquirer": "^7.3.1",
     "@types/jest": "^27.0.3",
     "@types/listr": "^0.14.4",
-    "@types/node": "^14.14.35",
+    "@types/node": "^16.11.62",
     "@types/parse5": "^6.0.0",
     "@types/pixelmatch": "^5.2.4",
-    "@types/pngjs": "^3.4.2",
+    "@types/pngjs": "^6.0.1",
     "@types/prompts": "^2.0.9",
     "@types/semver": "^7.3.12",
     "@types/sizzle": "^2.3.2",
@@ -87,7 +87,7 @@
     "ansi-colors": "4.1.1",
     "autoprefixer": "10.2.5",
     "conventional-changelog-cli": "^2.2.2",
-    "dts-bundle-generator": "~6.12.0",
+    "dts-bundle-generator": "~6.13.0",
     "eslint": "^8.23.1",
     "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-jest": "^27.0.4",
@@ -107,7 +107,7 @@
     "magic-string": "^0.26.3",
     "merge-source-map": "^1.1.0",
     "mime-db": "^1.46.0",
-    "minimatch": "3.0.4",
+    "minimatch": "5.1.0",
     "node-fetch": "2.6.7",
     "open": "^8.4.0",
     "open-in-editor": "2.2.0",
@@ -116,7 +116,7 @@
     "pixelmatch": "5.3.0",
     "postcss": "^8.2.8",
     "prettier": "2.7.1",
-    "prompts": "2.4.0",
+    "prompts": "2.4.2",
     "puppeteer": "~10.0.0",
     "rollup": "2.42.3",
     "rollup-plugin-sourcemaps": "^0.6.3",

package.json

@@ -205,7 +205,17 @@ const getImagesUpdated = (buildCtx: d.BuildCtx, outputTargetsWww: d.OutputTarget
   return imageFiles.sort();
 };
 
-const excludeHmrFiles = (config: d.Config, excludeHmr: string[], filesChanged: string[]) => {
+/**
+ * Determine a list of files (if any) which should be excluded from HMR updates.
+ *
+ * @param config a user-supplied config
+ * @param excludeHmr a list of glob patterns that should be used to determine
+ * whether to exclude a file or not (a file will be excluded if it matches one
+ * @param filesChanged an array of files which are changed in the HMR update
+ * currently under consideration
+ * @returns a sorted list of files to exclude
+ */
+const excludeHmrFiles = (config: d.Config, excludeHmr: string[], filesChanged: string[]): string[] => {
   const excludeFiles: string[] = [];
 
   if (!excludeHmr || excludeHmr.length === 0) {

src/compiler/build/build-hmr.ts

@@ -554,6 +554,10 @@ export interface StencilDevServerConfig {
 export interface DevServerConfig extends StencilDevServerConfig {
   browserUrl?: string;
   devServerDir?: string;
+  /**
+   * A list of glob patterns like `subdir/*.js`  to exclude from hot-module
+   * reloading updates.
+   */
   excludeHmr?: string[];
   historyApiFallback?: HistoryApiFallback;
   openBrowser?: boolean;

src/declarations/stencil-public-compiler.ts

@@ -56,6 +56,7 @@ describe('request-handler', () => {
 
     res.end = () => {
       res.$content = res.$contentWrite;
+      return this;
     };
 
     sendMsg = () => {};

src/dev-server/test/req-handler.spec.ts

@@ -28,7 +28,8 @@ export function createJestPuppeteerEnvironment() {
 
       const page = await newBrowserPage(this.browser);
       this.pages.push(page);
-      const env: E2EProcessEnv = process.env;
+      // during E2E tests, we can safely assume that the current environment is a `E2EProcessEnv`
+      const env: E2EProcessEnv = process.env as E2EProcessEnv;
       if (typeof env.__STENCIL_DEFAULT_TIMEOUT__ === 'string') {
         page.setDefaultTimeout(parseInt(env.__STENCIL_DEFAULT_TIMEOUT__, 10));
       }

src/testing/jest/jest-environment.ts

@@ -1,5 +1,6 @@
 import { BUILD, Env } from '@app-data';
 import type * as d from '@stencil/core/internal';
+import { E2EProcessEnv } from '@stencil/core/internal';
 import {
   modeResolutionChain,
   resetPlatform,
@@ -56,7 +57,8 @@ export function jestSetupTestFramework() {
 
   global.screenshotDescriptions = new Set();
 
-  const env: d.E2EProcessEnv = process.env;
+  // during E2E tests, we can safely assume that the current environment is a `E2EProcessEnv`
+  const env: E2EProcessEnv = process.env as E2EProcessEnv;
 
   if (typeof env.__STENCIL_DEFAULT_TIMEOUT__ === 'string') {
     const time = parseInt(env.__STENCIL_DEFAULT_TIMEOUT__, 10);

src/testing/jest/jest-setup-test-framework.ts

@@ -6,7 +6,8 @@ export async function startPuppeteerBrowser(config: ValidatedConfig) {
     return null;
   }
 
-  const env: E2EProcessEnv = process.env;
+  // during E2E tests, we can safely assume that the current environment is a `E2EProcessEnv`
+  const env: E2EProcessEnv = process.env as E2EProcessEnv;
   const puppeteerDep = config.testing.browserExecutablePath ? 'puppeteer-core' : 'puppeteer';
 
   const puppeteerModulePath = config.sys.lazyRequire.getModulePath(config.rootDir, puppeteerDep);
@@ -73,7 +74,9 @@ export async function connectBrowser() {
   // a web socket is because jest probably has us
   // in a different thread, this is also why this
   // uses process.env for data
-  const env: E2EProcessEnv = process.env;
+  //
+  // during E2E tests, we can safely assume that the current environment is a `E2EProcessEnv`
+  const env: E2EProcessEnv = process.env as E2EProcessEnv;
 
   const wsEndpoint = env.__STENCIL_BROWSER_WS_ENDPOINT__;
   if (!wsEndpoint) {

src/testing/puppeteer/puppeteer-browser.ts

@@ -15,7 +15,8 @@ import { initPageScreenshot } from './puppeteer-screenshot';
 
 declare const global: JestEnvironmentGlobal;
 
-const env: E2EProcessEnv = process.env;
+// during E2E tests, we can safely assume that the current environment is a `E2EProcessEnv`
+const env: E2EProcessEnv = process.env as E2EProcessEnv;
 export async function newE2EPage(opts: NewE2EPageOptions = {}): Promise<E2EPage> {
   if (!global.__NEW_TEST_PAGE__) {
     throw new Error(`newE2EPage() is only available from E2E tests, and ran with the --e2e cmd line flag.`);