feat(cypress): remove browiserify preprocessor

Author: Dan Muller

docs/Cypress.html

@@ -17,14 +17,14 @@ The Cypress rules run tests under the Cypress e2e testing framework with Bazel.
 
 ## Installation
 
-Add `@bazel/cypress`, `cypress` and `@cypress/browserify-preprocessor` npm packages to your `devDependencies` in `package.json`.
+Add `@bazel/cypress` and `cypress` npm packages to your `devDependencies` in `package.json`.
 
 ```
-npm install --save-dev @bazel/cypress cypress @cypress/browserify-preprocessor
+npm install --save-dev @bazel/cypress cypress
 ```
 or using yarn
 ```
-yarn add -D @bazel/cypress cypress @cypress/browserify-preprocessor
+yarn add -D @bazel/cypress cypress
 ```
 
 Then, load and invoke `cypress_repository` within your `WORKSPACE` file.

docs/Cypress.md

@@ -9,12 +9,11 @@
         "@bazel/cypress": "^2.2.2",
         "@bazel/ibazel": "^0.13.2",
         "@bazel/typescript": "^2.2.2",
-        "@cypress/browserify-preprocessor": "^3.0.0",
         "@types/node": "14.0.13",
         "cypress": "^4.8.0",
         "typescript": "3.9.5"
     },
     "scripts": {
         "test": "bazel test //..."
     }
-}
+}

examples/cypress/package.json

@@ -95,7 +95,6 @@ pkg_npm(
         "@build_bazel_rules_nodejs//packages/cypress:internal/plugins/base.js": "TEMPLATED_node_modules_workspace_name//@bazel/cypress:internal/plugins/base.js",
         "@build_bazel_rules_nodejs//packages/cypress:internal/plugins/index.template.js": "TEMPLATED_node_modules_workspace_name//@bazel/cypress:internal/plugins/index.template.js",
         "@build_bazel_rules_nodejs//packages/cypress:internal/run-cypress.js": "TEMPLATED_node_modules_workspace_name//@bazel/cypress:internal/run-cypress.js",
-        "\\${cwd}/../cypress_deps/node_modules/@cypress/browserify-preprocessor/index": "@cypress/browserify-preprocessor",
     },
     deps = [
         ":npm_version_check",

packages/cypress/BUILD.bazel

@@ -4,14 +4,14 @@ The Cypress rules run tests under the Cypress e2e testing framework with Bazel.
 
 ## Installation
 
-Add `@bazel/cypress`, `cypress` and `@cypress/browserify-preprocessor` npm packages to your `devDependencies` in `package.json`.
+Add `@bazel/cypress` and `cypress` npm packages to your `devDependencies` in `package.json`.
 
 ```
-npm install --save-dev @bazel/cypress cypress @cypress/browserify-preprocessor
+npm install --save-dev @bazel/cypress cypress
 ```
 or using yarn
 ```
-yarn add -D @bazel/cypress cypress @cypress/browserify-preprocessor
+yarn add -D @bazel/cypress cypress
 ```
 
 Then, load and invoke `cypress_repository` within your `WORKSPACE` file.

packages/cypress/install.md

@@ -27,6 +27,12 @@ def _cypress_repository_impl(repository_ctx):
         {},
     )
 
+    repository_ctx.template(
+        "plugins/base.js",
+        repository_ctx.path(repository_ctx.attr._base_plugin),
+        {},
+    )
+
     repository_ctx.template(
         "packages/cypress/internal/cypress_web_test.bzl",
         repository_ctx.path(repository_ctx.attr._cypress_web_test),
@@ -59,6 +65,10 @@ cypress_repository = repository_rule(
             default = True,
             doc = "If stdout and stderr should be printed to the terminal",
         ),
+        "_base_plugin": attr.label(
+            allow_single_file = True,
+            default = "//packages/cypress:internal/plugins/base.js",
+        ),
         "_cypress_web_test": attr.label(
             allow_single_file = True,
             default = "//packages/cypress:internal/template.cypress_web_test.bzl",

packages/cypress/internal/cypress_repository.bzl

@@ -1,4 +1,4 @@
-const {join, normalize} = require('path');
+const {join} = require('path');
 
 const basePluginShortPath = 'TEMPLATED_pluginsFile';
 const integrationFileShortPaths = TEMPLATED_integrationFileShortPaths;
@@ -7,9 +7,6 @@ const runfiles = require(process.env['BAZEL_NODE_RUNFILES_HELPER']);
 const basePlugin = require(runfiles.resolveWorkspaceRelative(basePluginShortPath));
 const cwd = process.cwd();
 
-const browserifyFactory = require(normalize(`TEMPLATED_@cypress/browserify-preprocessor`));
-const browserify = browserifyFactory(browserifyFactory.defaultOptions);
-
 module.exports = (on, config) => {
   // Set env variables needed usually set by for `bazel test` invocations
   // (they are not set automatically for `bazel run`).
@@ -25,13 +22,6 @@ module.exports = (on, config) => {
   config.screenshotsFolder = process.env['TEST_UNDECLARED_OUTPUTS_DIR'] || process.env.RUNFILES_DIR;
   config.videosFolder = process.env['TEST_UNDECLARED_OUTPUTS_DIR'] || process.env.RUNFILES_DIR;
 
-  // Set file preprocessing output path to writable directory.
-  on('file:preprocessor', (file) => {
-    file.outputPath =
-        join(process.env['TEST_TMPDIR'], file.outputPath.split('/bundles/').slice(1).join());
-    return browserify(file);
-  });
-
   // Load in the user's cypress plugin
   return basePlugin(on, config);
 };

packages/cypress/internal/plugins/index.template.js

@@ -40,7 +40,6 @@ def _cypress_plugin_impl(ctx):
         output = ctx.outputs.plugin,
         template = ctx.file._plugin_template,
         substitutions = {
-            "TEMPLATED_@cypress/browserify-preprocessor": "${cwd}/../cypress_deps/node_modules/@cypress/browserify-preprocessor/index",
             "TEMPLATED_integrationFileShortPaths": "[\n  {files}\n]".format(files = ",\n  ".join(integration_files_short_paths)),
             "TEMPLATED_pluginsFile": plugins_file.short_path,
         },
@@ -78,9 +77,7 @@ def cypress_web_test(
         name,
         config_file,
         srcs = [],
-        plugins_file = Label("@build_bazel_rules_nodejs//packages/cypress:internal/plugins/base.js"),
-        cypress = Label("TEMPLATED_node_modules_workspace_name//cypress:cypress"),
-        cypress_browserify_preprocessor = Label("TEMPLATED_node_modules_workspace_name//@cypress/browserify-preprocessor"),
+        plugins_file = Label("//plugins/base.js"),
         data = [],
         templated_args = [],
         cypress_cache = Label("//:cypress_cache"),
@@ -104,8 +101,6 @@ def cypress_web_test(
         tags = tags,
         data = data + [
             plugins_file,
-            cypress,
-            cypress_browserify_preprocessor,
             cypress_cache,
             cypress_executable,
             "{cypress_plugin}".format(cypress_plugin = cypress_plugin),
@@ -127,7 +122,6 @@ def cypress_web_test_global_cache(
         srcs = [],
         plugins_file = Label("@build_bazel_rules_nodejs//packages/cypress:plugins/base.js"),
         cypress = Label("TEMPLATED_node_modules_workspace_name//cypress:cypress"),
-        cypress_browserify_preprocessor = Label("TEMPLATED_node_modules_workspace_name//@cypress/browserify-preprocessor"),
         data = [],
         templated_args = [],
         **kwargs):
@@ -150,7 +144,6 @@ def cypress_web_test_global_cache(
         data = data + [
             plugins_file,
             cypress,
-            cypress_browserify_preprocessor,
             "{cypress_plugin}".format(cypress_plugin = cypress_plugin),
             "{config_file}".format(config_file = config_file),
         ] + srcs,

packages/cypress/internal/template.cypress_web_test.bzl

@@ -1,8 +1,7 @@
 {
   "name": "@bazel/cypress",
   "peerDependencies": {
-    "cypress": ">=4.7.0",
-    "@cypress/browserify-preprocessor": ">=3.0.0"
+    "cypress": ">=4.7.0"
   },
   "description": "Run Cypress e2e testing framework under Bazel",
   "license": "Apache-2.0",
@@ -22,4 +21,4 @@
   "scripts": {
     "postinstall": "node npm_version_check.js"
   }
-}
+}

packages/cypress/package.json

@@ -3,8 +3,7 @@
     "private": true,
     "dependencies": {
         "express": "4.17.1",
-        "cypress": "^4.8.0",
-        "@cypress/browserify-preprocessor": "^3.0.0",
+        "cypress": "^5.2.0",
         "@types/node": "14.0.14",
         "typescript": "3.9.5"
     }