fix: Allow names other than rules_playwright (#13)

Within the repository rule there were a number of places where
rules_playwright was hard coded so that build rules and platform
constraints from this repo could be referenced within the generated
repositories.

With this change, those hard codings are replaced with a command line
flag to be passed to the CLI. For WORKSPACE dependencies the
rules_playwright_cannonical_name will match the name used to download
rules_playwright in the first place. For bzlmod the rules_playwright_cannonical_name
is derived using bazel using `Label("rules_playwright").repo_name`

Fixes #10

Author: mrmeku

examples/rules_js/.bazelrc

@@ -1,4 +1,4 @@
 startup --host_jvm_args=-DBAZEL_TRACK_SOURCE_DIRECTORIES=1
 common --enable_bzlmod
-common --@rules_playwright//:macos_version=14
+common --@mrmeku_rules_playwright//:macos_version=14
 common --symlink_prefix=/

examples/rules_js/MODULE.bazel

@@ -1,18 +1,18 @@
-bazel_dep(name = "rules_playwright", version = "0.0.0")
+bazel_dep(name = "rules_playwright", version = "0.0.0", repo_name = "mrmeku_rules_playwright")
 local_path_override(
     module_name = "rules_playwright",
     path = "../..",
 )
 
-playwright = use_extension("@rules_playwright//playwright:extensions.bzl", "playwright")
+playwright = use_extension("@mrmeku_rules_playwright//playwright:extensions.bzl", "playwright")
 playwright.repo(
     name = "playwright",
+    browsers_json = "//:browsers.1.50.1.json",
     integrity_map = {
         "firefox-mac14-arm64": "sha256-+FLEjmC1ypnAI/DQY4uJhtx3kQPN4mX8LC0TWEt9x9Y=",
         "chromium-headless-shell-mac14-arm64": "sha256-pJnv5Nfost7BtlSlG1JPzpQHgzXlxerZHyDoV3/1NM0=",
         "webkit-mac14-arm64": "sha256-RiHUDBPVDRlnkgHXzaoeQeAxeSvMiWNOphl/GlEj5aA=",
     },
-    browsers_json = "//:browsers.1.50.1.json",
 )
 use_repo(playwright, "playwright")
 

examples/workspace/WORKSPACE.bazel

@@ -1,6 +1,6 @@
 workspace(name = "workspace_example")
 
-load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive", "http_file")
+load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
 
 http_archive(
     name = "aspect_rules_js",
@@ -29,7 +29,7 @@ load("@npm//:repositories.bzl", "npm_repositories")
 npm_repositories()
 
 local_repository(
-    name = "rules_playwright",
+    name = "mrmeku_rules_playwright",
     path = "../..",
 )
 
@@ -45,7 +45,7 @@ exports_files([
     url = "https://registry.npmjs.org/playwright-core/-/playwright-core-1.51.0.tgz",
 )
 
-load("@rules_playwright//playwright:repositories.bzl", "define_browsers", "playwright_repository")
+load("@mrmeku_rules_playwright//playwright:repositories.bzl", "define_browsers", "playwright_repository")
 
 define_browsers(
     name = "browsers_index",
@@ -58,8 +58,9 @@ fetch_browsers()
 
 playwright_repository(
     name = "playwright",
+    browsers_workspace_name_prefix = "browsers_index",
     playwright_version = "1.51.0",
-    user_workspace_name = "browsers_index",
+    rules_playwright_cannonical_name = "mrmeku_rules_playwright",
 )
 
 # ###########################################################
@@ -68,6 +69,7 @@ playwright_repository(
 
 playwright_repository(
     name = "playwright_2",
+    browsers_workspace_name_prefix = "browsers_index",
     playwright_version_from = "//:package.json",
-    user_workspace_name = "browsers_index",
+    rules_playwright_cannonical_name = "mrmeku_rules_playwright",
 )

playwright/extensions.bzl

@@ -60,8 +60,8 @@ def _extension_impl(module_ctx):
                     "http-files",
                     "--browser-json-path",
                     get_browsers_json_path(module_ctx, repo.playwright_version, repo.browsers_json),
-                    "--workspace-name",
-                    name,
+                    "--browsers-workspace-name-prefix",
+                    repo.name,
                 ],
             )
             if result.return_code != 0:
@@ -91,7 +91,10 @@ def _extension_impl(module_ctx):
                 name = name,
                 playwright_version = repo.playwright_version,
                 browsers_json = repo.browsers_json,
-                user_workspace_name = name,
+                browsers_workspace_name_prefix = name,
+                # Map the apparant name of the module to the cannonical name
+                # See https://bazel.build/external/module
+                rules_playwright_cannonical_name = "@" + Label("rules_playwright").repo_name,
             )
 
 playwright = module_extension(

playwright/private/cli/src/browser_targets.rs

@@ -34,7 +34,7 @@ impl From<BrowserTarget> for HttpFile {
 }
 
 pub fn get_browser_rules(
-    workspace_name: &str,
+    browsers_workspace_name_prefix: &str,
     browser_json_path: &PathBuf,
 ) -> std::io::Result<Vec<BrowserTarget>> {
     let browsers_json = std::fs::read_to_string(browser_json_path)?;
@@ -97,7 +97,7 @@ pub fn get_browser_rules(
 
                             Some(BrowserTarget {
                                 http_file_workspace_name: format!(
-                                    "{workspace_name}-{browser_name}-{platform_str}"
+                                    "{browsers_workspace_name_prefix}-{browser_name}-{platform_str}"
                                 ),
                                 http_file_path: template.replace("%s", revision),
                                 label: format!("{browser_name}-{platform_str}"),

playwright/private/cli/src/main.rs

@@ -17,11 +17,12 @@ mod flags {
         cmd rules-playwright {
             cmd workspace  {
                 required --browser-json-path browser_json_path: PathBuf
-                required --workspace-name workspace_name: String
+                required --browsers-workspace-name-prefix browsers_workspace_name_prefix: String
+                required --rules-playwright-cannonical-name rules_playwright_cannonical_name: String
             }
             cmd http-files {
                 required --browser-json-path browser_json_path: PathBuf
-                required --workspace-name workspace_name: String
+                required --browsers-workspace-name-prefix browsers_workspace_name_prefix: String
             }
             cmd unzip {
                 required --input-path input_path: PathBuf
@@ -46,12 +47,13 @@ pub fn main() -> std::io::Result<()> {
         flags::RulesPlaywrightCmd::Workspace(cmd) => {
             templates::write_workspace(
                 &out_dir,
-                get_browser_rules(&cmd.workspace_name, &cmd.browser_json_path)?,
+                get_browser_rules(&cmd.browsers_workspace_name_prefix, &cmd.browser_json_path)?,
+                &cmd.rules_playwright_cannonical_name,
             )?;
         }
         flags::RulesPlaywrightCmd::HttpFiles(cmd) => {
             let http_files: Vec<HttpFile> =
-                get_browser_rules(&cmd.workspace_name, &cmd.browser_json_path)?
+                get_browser_rules(&cmd.browsers_workspace_name_prefix, &cmd.browser_json_path)?
                     .into_iter()
                     .map(|b| b.into())
                     .collect();

playwright/private/cli/src/templates/aliases.rs

@@ -40,6 +40,7 @@ struct AliasTargetSelect {
 pub fn write_build_file(
     out_dir: &Path,
     root_targets: &HashMap<String, RootTarget>,
+    rules_playwright_cannonical_name: &str,
 ) -> io::Result<()> {
     let template = AliasBuildFileTemplate {
         alias_targets: root_targets
@@ -55,7 +56,7 @@ pub fn write_build_file(
                             .iter()
                             .map(|(platform, platform_target)| AliasTargetSelect {
                                 key: format!(
-                                    "@rules_playwright//tools/platforms:{}",
+                                    "@{rules_playwright_cannonical_name}//tools/platforms:{}",
                                     platform.base_name()
                                 ),
                                 value: format!("//browsers:{}", platform_target.name),

playwright/private/cli/src/templates/browsers.rs

@@ -7,7 +7,7 @@ use crate::browser_targets::BrowserTarget;
 #[derive(Template)]
 #[template(
     source = r#"
-load("@rules_playwright//playwright:unzip_browser.bzl", "unzip_browser")
+load("@{{ rules_playwright_cannonical_name }}//playwright:unzip_browser.bzl", "unzip_browser")
 
 package(default_visibility = ["//visibility:public"])
 
@@ -24,15 +24,23 @@ unzip_browser(
 )]
 struct BrowsersBuildFileTemplate<'a> {
     browser_targets: &'a Vec<BrowserTarget>,
+    rules_playwright_cannonical_name: &'a str,
 }
 
-pub fn write_build_file(out_dir: &Path, browser_targets: &Vec<BrowserTarget>) -> io::Result<()> {
+pub fn write_build_file(
+    out_dir: &Path,
+    browser_targets: &Vec<BrowserTarget>,
+    rules_playwright_cannonical_name: &str,
+) -> io::Result<()> {
     let browsers_dir = out_dir.join("browsers");
     fs::create_dir(browsers_dir)?;
     fs::write(
         out_dir.join("browsers/BUILD.bazel"),
-        BrowsersBuildFileTemplate { browser_targets }
-            .render()
-            .unwrap(),
+        BrowsersBuildFileTemplate {
+            browser_targets,
+            rules_playwright_cannonical_name,
+        }
+        .render()
+        .unwrap(),
     )
 }

playwright/private/cli/src/templates/mod.rs

@@ -8,8 +8,12 @@ mod aliases;
 mod browsers;
 mod root;
 
-pub fn write_workspace(out_dir: &Path, browser_targets: Vec<BrowserTarget>) -> io::Result<()> {
-    browsers::write_build_file(out_dir, &browser_targets)?;
+pub fn write_workspace(
+    out_dir: &Path,
+    browser_targets: Vec<BrowserTarget>,
+    rules_playwright_cannonical_name: &str,
+) -> io::Result<()> {
+    browsers::write_build_file(out_dir, &browser_targets, rules_playwright_cannonical_name)?;
 
     let mut root_targets: HashMap<String, RootTarget> = HashMap::new();
     for target in browser_targets {
@@ -39,8 +43,8 @@ pub fn write_workspace(out_dir: &Path, browser_targets: Vec<BrowserTarget>) -> i
         );
     }
 
-    root::write_build_file(out_dir, &root_targets)?;
-    aliases::write_build_file(out_dir, &root_targets)
+    root::write_build_file(out_dir, &root_targets, rules_playwright_cannonical_name)?;
+    aliases::write_build_file(out_dir, &root_targets, rules_playwright_cannonical_name)
 }
 
 struct RootTarget {

playwright/private/cli/src/templates/root.rs

@@ -6,7 +6,7 @@ use super::RootTarget;
 #[derive(Template)]
 #[template(
     source = r#"
-load("@rules_playwright//playwright:select_exec.bzl", "select_exec")
+load("@{{ rules_playwright_cannonical_name }}//playwright:select_exec.bzl", "select_exec")
 
 package(default_visibility = ["//visibility:public"])
 {% for target in select_targets %}
@@ -25,6 +25,7 @@ select_exec(
     ext = "txt"
 )]
 struct RootBuildFileTemplate<'a> {
+    rules_playwright_cannonical_name: &'a str,
     select_targets: &'a [SelectTarget],
 }
 
@@ -41,6 +42,7 @@ struct SelectPlatformGroup {
 pub fn write_build_file(
     out_dir: &Path,
     root_targets: &HashMap<String, RootTarget>,
+    rules_playwright_cannonical_name: &str,
 ) -> io::Result<()> {
     let select_targets: Vec<SelectTarget> = root_targets
         .iter()
@@ -53,7 +55,10 @@ pub fn write_build_file(
                     let name_label: String = platform_group.clone().into();
 
                     SelectPlatformGroup {
-                        name: format!("@rules_playwright//tools/platforms:{}", name_label),
+                        name: format!(
+                            "@{rules_playwright_cannonical_name}//tools/platforms:{}",
+                            name_label
+                        ),
                         alias_label: format!(
                             "//aliases:{}_{}",
                             root_target.name, platform_group_target.name
@@ -68,6 +73,7 @@ pub fn write_build_file(
         out_dir.join("BUILD.bazel"),
         RootBuildFileTemplate {
             select_targets: &select_targets,
+            rules_playwright_cannonical_name,
         }
         .render()
         .unwrap(),

playwright/repositories.bzl

@@ -48,13 +48,15 @@ def _playwright_repo_impl(ctx):
             "workspace",
             "--browser-json-path",
             get_browsers_json_path(ctx, playwright_version, ctx.attr.browsers_json),
-            "--workspace-name",
-            ctx.attr.user_workspace_name,
+            "--browsers-workspace-name-prefix",
+            ctx.attr.browsers_workspace_name_prefix,
+            "--rules-playwright-cannonical-name",
+            ctx.attr.rules_playwright_cannonical_name,
         ],
     )
 
     if result.return_code != 0:
-        fail(ctx.attr.user_workspace_name, "workspace command failed", result.stdout, result.stderr)
+        fail(ctx.attr.name, "workspace command failed", result.stdout, result.stderr)
 
 playwright_repository = repository_rule(
     _playwright_repo_impl,
@@ -73,7 +75,14 @@ playwright_repository = repository_rule(
             allow_single_file = True,
             doc = "The browsers.json file to use. For example https://unpkg.com/playwright-core@1.51.0/browsers.json",
         ),
-        "user_workspace_name": attr.string(mandatory = True),
+        "browsers_workspace_name_prefix": attr.string(
+            mandatory = True,
+            doc = "The namespace prefix used when defining browser workspace repositories.",
+        ),
+        "rules_playwright_cannonical_name": attr.string(
+            mandatory = True,
+            doc = "The cannonical name given to the rules_playwright repository. See https://bazel.build/external/module",
+        ),
     },
 )
 
@@ -84,8 +93,8 @@ def _define_browsers_impl(rctx):
             "http-files",
             "--browser-json-path",
             rctx.path(rctx.attr.browsers_json),
-            "--workspace-name",
-            rctx.name,
+            "--browsers-workspace-name-prefix",
+            rctx.attr.name,
         ],
     )
     if result.return_code != 0:

run_gen.sh

@@ -59,10 +59,10 @@ native_binary(
     name = "cli",
     src = select(
         {
-            "@rules_playwright//tools/platforms:macos_x86_64": ":artifacts/cli-x86_64-apple-darwin",
-            "@rules_playwright//tools/platforms:macos_arm64": ":artifacts/cli-arm64-apple-darwin",
-            "@rules_playwright//tools/platforms:linux_x86_64": ":artifacts/cli-x86_64-unknown-linux-musl",
-            "@rules_playwright//tools/platforms:linux_arm64": ":artifacts/cli-arm64-unknown-linux-musl",
+            "//tools/platforms:macos_x86_64": ":artifacts/cli-x86_64-apple-darwin",
+            "//tools/platforms:macos_arm64": ":artifacts/cli-arm64-apple-darwin",
+            "//tools/platforms:linux_x86_64": ":artifacts/cli-x86_64-unknown-linux-musl",
+            "//tools/platforms:linux_arm64": ":artifacts/cli-arm64-unknown-linux-musl",
         },
     ),
     out = "cli",