[build] add copyright headers to rbs, pyi, ts, mjs, and erb files by titusfortner · Pull Request #17720 · SeleniumHQ/selenium

titusfortner · 2026-06-26T15:27:08Z

🔗 Related Issues

💥 What does this PR do?

Extends the copyright script to cover file types it was silently skipping, so license headers stay enforced instead of drifting.

Newly covered: .rbs, .pyi, .ts, .mjs, .cjs, and .rb.erb. Third-party RBS stubs (rb/sig/gems/) and generated .d.ts files are excluded. Running the script stamps 209 previously-uncovered files; it also corrected an outdated notice already present on the .pyi stubs.

🔧 Implementation Notes

.rbs uses # comments but does not get the # frozen_string_literal: true prefix that .rb files use — that magic comment is meaningless in a signature file.
.rb.erb is scoped to that exact suffix (not all .erb) so a future non-Ruby template wouldn't wrongly inherit the Ruby prefix.
Python's glob skips dotfiles, so javascript/grid-ui/.eslintrc.cjs remains unstamped — left as-is since it's a lint-config dotfile.

🤖 AI assistance

AI assisted (complete below)
- Tool(s): Claude Code
- What was generated: Script changes and the generated headers
- I reviewed all AI output and can explain the change

💡 Additional Considerations

🔄 Types of changes

Cleanup (formatting, renaming)

selenium-ci · 2026-06-26T15:27:35Z

Thank you, @titusfortner for this code suggestion.

The support packages contain example code that many users find helpful, but they do not necessarily represent
the best practices for using Selenium, and the Selenium team is not currently merging changes to them.

After reviewing the change, unless it is a critical fix or a feature that is needed for Selenium
to work, we will likely close the PR.

We actively encourage people to add the wrapper and helper code that makes sense for them to their own frameworks.
If you have any questions, please contact us

qodo-code-review · 2026-06-26T15:31:36Z

Code Review by Qodo

🐞 Bugs (1) 📘 Rule violations (0) 📜 Skill insights (0)

Context used

✅ Compliance rules (platform): 25 rules

1. Header update drops comments 🐞 Bug ⚙ Maintainability

Description

update_copyright.py treats any leading comment line as part of an existing header and, when it
decides the header is “wrong/outdated”, rewrites the file starting after that comment block—dropping
unrelated preamble comments/directives. Expanding the script to run on
.mjs/.cjs/.ts/.pyi/.rbs/.rb.erb increases the chance of losing meaningful preambles (e.g., lint
disables, @ts-check, reference directives, generated markers).

Code

scripts/update_copyright.py[R124-146]

+    update_files(f"{ROOT}/javascript/**/*.mjs", JS_EXCLUSIONS)
+    update_files(f"{ROOT}/javascript/**/*.cjs", JS_EXCLUSIONS)
    update_files(f"{ROOT}/javascript/**/*.tsx", [])
+    update_files(f"{ROOT}/javascript/**/*.ts", [f"{ROOT}/javascript/**/*.d.ts"])
    update_files(f"{ROOT}/py/**/*.py", PY_EXCLUSIONS, comment_characters="#")
+    update_files(f"{ROOT}/py/**/*.pyi", PY_EXCLUSIONS, comment_characters="#")
    update_files(
        f"{ROOT}/rb/**/*.rb",
        [],
        comment_characters="#",
        prefix=["# frozen_string_literal: true\n", "\n"],
    )
+    update_files(
+        f"{ROOT}/rb/**/*.rb.erb",
+        [],
+        comment_characters="#",
+        prefix=["# frozen_string_literal: true\n", "\n"],
+    )
+    update_files(
+        f"{ROOT}/rb/**/*.rbs",
+        [f"{ROOT}/rb/sig/gems/**/*.rbs"],
+        comment_characters="#",
+    )

Evidence

Copyright.update() expands the “existing header” region across arbitrary leading comments
(line.startswith(self._comment_characters)), and if the collected block doesn’t exactly equal the
expected notice it rewrites the file using only lines[index+1:], which drops those preamble
comments. This PR adds new update_files(...) invocations for additional extensions, which makes
that behavior apply to more file types (and it already resulted in a previously-present top-of-file
TS comment being removed during stamping).

scripts/update_copyright.py[30-48]
scripts/update_copyright.py[122-146]
javascript/grid-ui/src/config.ts[1-23]

Agent prompt

The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

## Issue description
The header detection in `Copyright.update()` treats *any* leading comment as part of the copyright block. When updating an “outdated” notice it calls `write_update_notice(file, lines[index+1:])`, which discards all those leading comment lines (even if they are not part of the notice).

With this PR expanding stamping to `.mjs`, `.cjs`, `.ts`, `.pyi`, `.rbs`, and `.rb.erb`, this can remove important file preambles (e.g., `// eslint-disable`, `// @ts-check`, `# typed: strict`, generated-file markers, etc.).

## Issue Context
The logic currently increments `index` for any line that starts with the comment prefix, not just for lines that match the expected notice/prefix. This makes any non-license preamble comments vulnerable to being dropped on update.

## Fix Focus Areas
- scripts/update_copyright.py[30-48]
- scripts/update_copyright.py[122-146]

## Suggested fix approach
1. Change the header detection to match only the *expected* prefix+notice lines (and possibly the exact notice block), rather than any comment line.
2. If the file begins with other comments that are not part of the notice, insert the notice *above* them (or update only the specific notice block) instead of discarding them.
3. Add a small test/fixture (or at least a scripted example) showing preservation of a non-license preamble comment when stamping/updating.

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

qodo-code-review · 2026-06-26T15:42:45Z

PR Summary by Qodo

Extend copyright stamping to RBS/PYI/TS/MJS/CJS and rb.erb files
⚙️ Configuration changes 🕐 10-20 Minutes

Description

• Extend scripts/update_copyright.py to cover .mjs, .cjs, .ts (excluding .d.ts), .pyi,
 .rbs (excluding rb/sig/gems/), and .rb.erb.
• Stamp Apache 2.0 headers onto previously-uncovered JS/TS, Python stubs, and Ruby RBS signature
 files.
• Normalize the existing .pyi notices by restoring the missing “You may obtain a copy…” clause.

Diagram

graph TD
  script["scripts/update_copyright.py"] --> js["javascript/**/*.mjs|cjs|ts"] --> out1["Headers added"]
  script --> py["py/**/*.pyi"] --> out2["Headers fixed"]
  script --> rb["rb/**/*.rbs & rb/**/*.rb.erb"] --> out3["Headers added"]
  script --> excl{{"Exclusions"}} --> gems["rb/sig/gems/**/*.rbs"]
  excl --> dts["javascript/**/*.d.ts"]

High-Level Assessment

The following are alternative approaches to this PR:

1. Use a dedicated license-header tool (e.g., REUSE/Apache RAT/pre-commit hook)

➕ Centralizes header rules across languages with standard tooling
➕ Easier CI enforcement and reporting for missing headers
➕ Often supports exclusions/dotfiles consistently
➖ Introduces new dependency/tooling and configuration surface
➖ May require adapting repo conventions and CI integration

2. Add CI check that fails on missing headers (without auto-stamping)

➕ Prevents drift without rewriting files in bulk
➕ Keeps formatting changes out of feature PRs
➖ Doesn’t remediate existing gaps automatically
➖ More manual work for contributors to add headers correctly

Recommendation: The current approach (extending the existing stamping script) is the lowest-friction fix and aligns with existing repo practice. Consider adding a lightweight CI assertion (or pre-commit) later to prevent regressions, but replacing the script with a new tool would be higher-cost for little immediate benefit.

Files changed (210) +3639 / -9

Other (210) +3639 / -9

update_copyright.pyExtend stamping to .mjs/.cjs/.ts/.pyi/.rbs and .rb.erb with exclusions +15/-0

Extend stamping to .mjs/.cjs/.ts/.pyi/.rbs and .rb.erb with exclusions

• Adds new glob patterns so the header-stamping script also covers MJS/CJS/TS, Python .pyi stubs, Ruby .rbs signatures, and Ruby ERB templates. Excludes generated TypeScript declarations (.d.ts) and third-party RBS stubs under rb/sig/gems/.

scripts/update_copyright.py

esbuild.base.config.mjsAdd Apache 2.0 license header +18/-0

Add Apache 2.0 license header
• Prepends the standard SFC Apache 2.0 license header to the esbuild base config module.
javascript/grid-ui/esbuild.base.config.mjs

esbuild.bazel.config.mjsAdd Apache 2.0 license header +18/-0

Add Apache 2.0 license header
• Prepends the standard SFC Apache 2.0 license header to the Bazel esbuild config module.
javascript/grid-ui/esbuild.bazel.config.mjs

esbuild.npm.config.mjsAdd Apache 2.0 license header +18/-0

Add Apache 2.0 license header
• Prepends the standard SFC Apache 2.0 license header to the npm esbuild config module.
javascript/grid-ui/esbuild.npm.config.mjs

config.tsAdd Apache 2.0 license header to TypeScript config +18/-1

Add Apache 2.0 license header to TypeScript config
• Prepends the standard SFC Apache 2.0 license header to the Grid UI config file, replacing the previous single-line file comment at the top.
javascript/grid-ui/src/config.ts

grid.tsAdd Apache 2.0 license header +18/-0

Add Apache 2.0 license header
• Prepends the standard SFC Apache 2.0 license header to the GraphQL grid client code.
javascript/grid-ui/src/graphql/grid.ts

nodes.tsAdd Apache 2.0 license header +18/-0

Add Apache 2.0 license header
• Prepends the standard SFC Apache 2.0 license header to the GraphQL nodes client code.
javascript/grid-ui/src/graphql/nodes.ts

sessions.tsAdd Apache 2.0 license header +18/-0

Add Apache 2.0 license header
• Prepends the standard SFC Apache 2.0 license header to the GraphQL sessions client code.
javascript/grid-ui/src/graphql/sessions.ts

session-data.tsAdd Apache 2.0 license header +18/-0

Add Apache 2.0 license header
• Prepends the standard SFC Apache 2.0 license header to the session-data model definition.
javascript/grid-ui/src/models/session-data.ts

session-info.tsAdd Apache 2.0 license header +18/-0

Add Apache 2.0 license header
• Prepends the standard SFC Apache 2.0 license header to the session-info model definition.
javascript/grid-ui/src/models/session-info.ts

simple.tsAdd Apache 2.0 license header +17/-0

Add Apache 2.0 license header
• Prepends the standard SFC Apache 2.0 license header to the simplified Grid UI entry/module.
javascript/grid-ui/src/simple.ts