@playwright/experimental-ct-core 1.33.0-alpha-apr-18-2023

package/LICENSE

@@ -0,0 +1,202 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Portions Copyright (c) Microsoft Corporation.
+   Portions Copyright 2017 Google Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,3 @@
+> **BEWARE** This package is EXPERIMENTAL and does not respect semver.
+
+Read more at https://playwright.dev/docs/test-components

package/cli.js

@@ -0,0 +1,17 @@
+#!/usr/bin/env node
+/**
+ * Copyright (c) Microsoft Corporation.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+module.exports = require('@playwright/test/cli');

package/lib/vitePlugin.js

@@ -0,0 +1,312 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createPlugin = createPlugin;
+var _fs = _interopRequireDefault(require("fs"));
+var _path = _interopRequireDefault(require("path"));
+var _babelBundle = require("@playwright/test/lib/common/babelBundle");
+var _utilsBundle = require("@playwright/test/lib/utilsBundle");
+var _tsxTransform = require("@playwright/test/lib/common/tsxTransform");
+var _utils = require("playwright-core/lib/utils");
+var _compilationCache = require("@playwright/test/lib/common/compilationCache");
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+/**
+ * Copyright (c) Microsoft Corporation.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+let stoppableServer;
+const playwrightVersion = (0, _utils.getPlaywrightVersion)();
+const importReactRE = /(^|\n|;)import\s+(\*\s+as\s+)?React(,|\s+)/;
+const compiledReactRE = /(const|var)\s+React\s*=/;
+function createPlugin(registerSourceFile, frameworkPluginFactory) {
+  let configDir;
+  let config;
+  return {
+    name: 'playwright-vite-plugin',
+    setup: async (configObject, configDirectory) => {
+      config = configObject;
+      configDir = configDirectory;
+    },
+    begin: async suite => {
+      var _viteConfig$build;
+      const use = config.projects[0].use;
+      const port = use.ctPort || 3100;
+      const viteConfig = typeof use.ctViteConfig === 'function' ? await use.ctViteConfig() : use.ctViteConfig || {};
+      const relativeTemplateDir = use.ctTemplateDir || 'playwright';
+      const rootDir = viteConfig.root || configDir;
+      const templateDir = _path.default.join(rootDir, relativeTemplateDir);
+      const outDir = (viteConfig === null || viteConfig === void 0 ? void 0 : (_viteConfig$build = viteConfig.build) === null || _viteConfig$build === void 0 ? void 0 : _viteConfig$build.outDir) || (use.ctCacheDir ? _path.default.resolve(rootDir, use.ctCacheDir) : _path.default.resolve(templateDir, '.cache'));
+      const buildInfoFile = _path.default.join(outDir, 'metainfo.json');
+      let buildExists = false;
+      let buildInfo;
+      const registerSource = await _fs.default.promises.readFile(registerSourceFile, 'utf-8');
+      const registerSourceHash = (0, _utils.calculateSha1)(registerSource);
+      const {
+        version: viteVersion
+      } = require('vite/package.json');
+      try {
+        buildInfo = JSON.parse(await _fs.default.promises.readFile(buildInfoFile, 'utf-8'));
+        (0, _utils.assert)(buildInfo.version === playwrightVersion);
+        (0, _utils.assert)(buildInfo.viteVersion === viteVersion);
+        (0, _utils.assert)(buildInfo.registerSourceHash === registerSourceHash);
+        buildExists = true;
+      } catch (e) {
+        buildInfo = {
+          version: playwrightVersion,
+          viteVersion,
+          registerSourceHash,
+          components: [],
+          tests: {},
+          sources: {}
+        };
+      }
+      const componentRegistry = new Map();
+      // 1. Re-parse changed tests and collect required components.
+      const hasNewTests = await checkNewTests(suite, buildInfo, componentRegistry);
+      // 2. Check if the set of required components has changed.
+      const hasNewComponents = await checkNewComponents(buildInfo, componentRegistry);
+      // 3. Check component sources.
+      const sourcesDirty = !buildExists || hasNewComponents || (await checkSources(buildInfo));
+      // 4. Update component info.
+      buildInfo.components = [...componentRegistry.values()];
+      viteConfig.root = rootDir;
+      viteConfig.preview = {
+        port,
+        ...viteConfig.preview
+      };
+
+      // React heuristic. If we see a component in a file with .js extension,
+      // consider it a potential JSX-in-JS scenario and enable JSX loader for all
+      // .js files.
+      if (hasJSComponents(buildInfo.components)) {
+        viteConfig.esbuild = {
+          loader: 'jsx',
+          include: /.*\.jsx?$/,
+          exclude: []
+        };
+        viteConfig.optimizeDeps = {
+          esbuildOptions: {
+            loader: {
+              '.js': 'jsx'
+            }
+          }
+        };
+      }
+      const {
+        build,
+        preview
+      } = require('vite');
+      // Build config unconditionally, either build or build & preview will use it.
+      viteConfig.plugins = viteConfig.plugins || [await frameworkPluginFactory()];
+      // But only add out own plugin when we actually build / transform.
+      if (sourcesDirty) viteConfig.plugins.push(vitePlugin(registerSource, relativeTemplateDir, buildInfo, componentRegistry));
+      viteConfig.configFile = viteConfig.configFile || false;
+      viteConfig.define = viteConfig.define || {};
+      viteConfig.define.__VUE_PROD_DEVTOOLS__ = true;
+      viteConfig.css = viteConfig.css || {};
+      viteConfig.css.devSourcemap = true;
+      viteConfig.build = {
+        ...viteConfig.build,
+        outDir,
+        target: 'esnext',
+        minify: false,
+        rollupOptions: {
+          treeshake: false,
+          input: {
+            index: _path.default.join(templateDir, 'index.html')
+          }
+        },
+        sourcemap: true
+      };
+      if (sourcesDirty) {
+        await build(viteConfig);
+        await _fs.default.promises.rename(`${outDir}/${relativeTemplateDir}/index.html`, `${outDir}/index.html`);
+      }
+      if (hasNewTests || hasNewComponents || sourcesDirty) await _fs.default.promises.writeFile(buildInfoFile, JSON.stringify(buildInfo, undefined, 2));
+      for (const [filename, testInfo] of Object.entries(buildInfo.tests)) (0, _compilationCache.setExternalDependencies)(filename, testInfo.deps);
+      const previewServer = await preview(viteConfig);
+      stoppableServer = (0, _utilsBundle.stoppable)(previewServer.httpServer, 0);
+      const isAddressInfo = x => x === null || x === void 0 ? void 0 : x.address;
+      const address = previewServer.httpServer.address();
+      if (isAddressInfo(address)) {
+        const protocol = viteConfig.preview.https ? 'https:' : 'http:';
+        process.env.PLAYWRIGHT_TEST_BASE_URL = `${protocol}//localhost:${address.port}`;
+      }
+    },
+    end: async () => {
+      await new Promise(f => stoppableServer.stop(f));
+    }
+  };
+}
+async function checkSources(buildInfo) {
+  for (const [source, sourceInfo] of Object.entries(buildInfo.sources)) {
+    try {
+      const timestamp = (await _fs.default.promises.stat(source)).mtimeMs;
+      if (sourceInfo.timestamp !== timestamp) return true;
+    } catch (e) {
+      return true;
+    }
+  }
+  return false;
+}
+async function checkNewTests(suite, buildInfo, componentRegistry) {
+  const testFiles = new Set();
+  for (const project of suite.suites) {
+    for (const file of project.suites) testFiles.add(file.location.file);
+  }
+  let hasNewTests = false;
+  for (const testFile of testFiles) {
+    var _buildInfo$tests$test;
+    const timestamp = (await _fs.default.promises.stat(testFile)).mtimeMs;
+    if (((_buildInfo$tests$test = buildInfo.tests[testFile]) === null || _buildInfo$tests$test === void 0 ? void 0 : _buildInfo$tests$test.timestamp) !== timestamp) {
+      const components = await parseTestFile(testFile);
+      for (const component of components) componentRegistry.set(component.fullName, component);
+      buildInfo.tests[testFile] = {
+        timestamp,
+        components: components.map(c => c.fullName),
+        deps: []
+      };
+      hasNewTests = true;
+    }
+  }
+  return hasNewTests;
+}
+async function checkNewComponents(buildInfo, componentRegistry) {
+  const newComponents = [...componentRegistry.keys()];
+  const oldComponents = new Map(buildInfo.components.map(c => [c.fullName, c]));
+  let hasNewComponents = false;
+  for (const c of newComponents) {
+    if (!oldComponents.has(c)) {
+      hasNewComponents = true;
+      break;
+    }
+  }
+  for (const c of oldComponents.values()) componentRegistry.set(c.fullName, c);
+  return hasNewComponents;
+}
+async function parseTestFile(testFile) {
+  const text = await _fs.default.promises.readFile(testFile, 'utf-8');
+  const ast = (0, _babelBundle.parse)(text, {
+    errorRecovery: true,
+    plugins: ['typescript', 'jsx'],
+    sourceType: 'module'
+  });
+  const componentUsages = (0, _tsxTransform.collectComponentUsages)(ast);
+  const result = [];
+  (0, _babelBundle.traverse)(ast, {
+    enter: p => {
+      if (_babelBundle.types.isImportDeclaration(p.node)) {
+        const importNode = p.node;
+        if (!_babelBundle.types.isStringLiteral(importNode.source)) return;
+        for (const specifier of importNode.specifiers) {
+          if (!componentUsages.names.has(specifier.local.name)) continue;
+          if (_babelBundle.types.isImportNamespaceSpecifier(specifier)) continue;
+          result.push((0, _tsxTransform.componentInfo)(specifier, importNode.source.value, testFile));
+        }
+      }
+    }
+  });
+  return result;
+}
+function vitePlugin(registerSource, relativeTemplateDir, buildInfo, componentRegistry) {
+  buildInfo.sources = {};
+  let moduleResolver;
+  return {
+    name: 'playwright:component-index',
+    configResolved(config) {
+      moduleResolver = config.createResolver();
+    },
+    async transform(content, id) {
+      const queryIndex = id.indexOf('?');
+      const file = queryIndex !== -1 ? id.substring(0, queryIndex) : id;
+      if (!buildInfo.sources[file]) {
+        try {
+          const timestamp = (await _fs.default.promises.stat(file)).mtimeMs;
+          buildInfo.sources[file] = {
+            timestamp
+          };
+        } catch {
+          // Silent if can't read the file.
+        }
+      }
+
+      // Vite React plugin will do this for .jsx files, but not .js files.
+      if (id.endsWith('.js') && content.includes('React.createElement') && !content.match(importReactRE) && !content.match(compiledReactRE)) {
+        const code = `import React from 'react';\n${content}`;
+        return {
+          code,
+          map: {
+            mappings: ''
+          }
+        };
+      }
+      const indexTs = _path.default.join(relativeTemplateDir, 'index.ts');
+      const indexTsx = _path.default.join(relativeTemplateDir, 'index.tsx');
+      const indexJs = _path.default.join(relativeTemplateDir, 'index.js');
+      const indexJsx = _path.default.join(relativeTemplateDir, 'index.jsx');
+      const idResolved = _path.default.resolve(id);
+      if (!idResolved.endsWith(indexTs) && !idResolved.endsWith(indexTsx) && !idResolved.endsWith(indexJs) && !idResolved.endsWith(indexJsx)) return;
+      const folder = _path.default.dirname(id);
+      const lines = [content, ''];
+      lines.push(registerSource);
+      for (const [alias, value] of componentRegistry) {
+        const importPath = value.isModuleOrAlias ? value.importPath : './' + _path.default.relative(folder, value.importPath).replace(/\\/g, '/');
+        if (value.importedName) lines.push(`import { ${value.importedName} as ${alias} } from '${importPath}';`);else lines.push(`import ${alias} from '${importPath}';`);
+      }
+      lines.push(`pwRegister({ ${[...componentRegistry.keys()].join(',\n  ')} });`);
+      return {
+        code: lines.join('\n'),
+        map: {
+          mappings: ''
+        }
+      };
+    },
+    async writeBundle() {
+      const componentDeps = new Map();
+      for (const component of componentRegistry.values()) {
+        const id = await moduleResolver(component.importPath);
+        if (!id) continue;
+        const deps = new Set();
+        collectViteModuleDependencies(this, id, deps);
+        componentDeps.set(component.fullName, deps);
+      }
+      for (const testInfo of Object.values(buildInfo.tests)) {
+        const deps = new Set();
+        for (const fullName of testInfo.components) {
+          for (const dep of componentDeps.get(fullName) || []) deps.add(dep);
+        }
+        testInfo.deps = [...deps];
+      }
+    }
+  };
+}
+function collectViteModuleDependencies(context, id, deps) {
+  if (!_path.default.isAbsolute(id)) return;
+  const normalizedId = _path.default.normalize(id);
+  if (deps.has(normalizedId)) return;
+  deps.add(normalizedId);
+  const module = context.getModuleInfo(id);
+  for (const importedId of (module === null || module === void 0 ? void 0 : module.importedIds) || []) collectViteModuleDependencies(context, importedId, deps);
+  for (const importedId of (module === null || module === void 0 ? void 0 : module.dynamicallyImportedIds) || []) collectViteModuleDependencies(context, importedId, deps);
+}
+function hasJSComponents(components) {
+  for (const component of components) {
+    const extname = _path.default.extname(component.importPath);
+    if (extname === '.js' || !extname && _fs.default.existsSync(component.importPath + '.js')) return true;
+  }
+  return false;
+}

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "@playwright/experimental-ct-core",
+  "version": "1.33.0-alpha-apr-18-2023",
+  "description": "Playwright Component Testing Helpers",
+  "repository": "github:Microsoft/playwright",
+  "homepage": "https://playwright.dev",
+  "engines": {
+    "node": ">=14"
+  },
+  "author": {
+    "name": "Microsoft Corporation"
+  },
+  "license": "Apache-2.0",
+  "exports": {
+    "./cli": "./cli.js",
+    "./lib/vitePlugin": "./lib/vitePlugin.js"
+  },
+  "dependencies": {
+    "vite": "^4.2.1",
+    "@playwright/test": "1.33.0-alpha-apr-18-2023"
+  },
+  "bin": {
+    "playwright": "./cli.js"
+  }
+}