Files
renovate/lib/modules/datasource/go/goproxy-parser.spec.ts
Sebastian Poxhofer a1971afa78 fix(linters): add linting rule to enforce usage of our regEx utility (#44690)
* ci(linter): add renovate/require-regex-util rule

Adds a custom oxlint rule that flags raw RegExp usage in lib/
production code: any `new RegExp(...)` call and any regex literal
that is not the direct first argument of `regEx(...)`. The regEx()
helper from lib/util/regex.ts uses the RE2 engine for ReDoS-safe
matching and caches compiled patterns. lib/util/regex.ts itself is
exempt.

The rule is disabled for **/*.spec.ts, test/**, and tools/** via
config overrides, because vitest APIs such as expect.stringMatching
need bare RegExp instances (a past commit reverted regEx() there).

Severity is set to "warn" instead of "error": the repo currently has
197 pre-existing violations (above the agreed mechanical-fix
threshold of 80), and a number of them are deliberately
RE2-incompatible patterns (lookahead/lookbehind/named backreferences,
see TODO #12872/#12875 markers in e.g. lib/modules/versioning/rez/
pattern.ts and lib/modules/manager/dockerfile/extract.ts) that need
per-site judgment before they can be wrapped in regEx() or suppressed
with a justified disable comment. No violation fixes are included in
this commit.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* ci(linter): enforce renovate/require-regex-util at error

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* refactor: use regEx() for regex literals and RegExp construction in lib

Burn down all renovate/require-regex-util violations (197):

- wrap RE2-compatible regex literals and RegExp constructions in regEx()
- rewrite lookaround patterns where behavior is provably preserved:
  goproxy separator split, sbt-package link extraction, leiningen
  comment stripping and keyword search, npm GitHub owner validation
  (unit-count bound replaced by an explicit length check)
- keep native RegExp with disable comments where RE2 cannot be used:
  moo / good-enough-parser lexer patterns (moo rejects RE2 instances),
  MigrationsService propertyName (matched via isRegExp, which RE2
  instances fail), rez named backreferences and lookaheads, GitHub
  markdown link negative lookbehind, emoji astral-plane matching
- drop stale TODO #12875 comments for patterns current re2 handles

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* refactor: reduce require-regex-util disable comments

Rewrite the github massage-markdown-links URL regex to capture an
optional `api.` prefix in a named group (skipped in code) instead of
relying on a negative lookbehind, so both the base and global variants
can use regEx()/RE2 and their two disable comments are removed. Add
spec cases for api-prefixed URLs that match the URL shape.

Consolidate the four related line disables in rez/pattern.ts (bound and
range patterns emulating Python conditional patterns via named
backreferences and lookaheads, which RE2 cannot express) into a single
block disable/enable pair, matching the treatment of the lexer files.

Disable comment count drops from 13 to 8.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* refactor(datasource/sbt-package): use named capture group in link regex

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* refactor(manager/cake): restore original multiLineComment regex spelling

The [^] -> [\\s\\S] rewrite was only needed for an RE2 wrap that was
later reverted; keep the diff minimal.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* fix(datasource/go): skip empty GOPROXY segments

The switch from a lookahead split to a capture-group split (needed because
RE2 has no lookahead support) changed how empty GOPROXY segments parse:
`a|,b` yielded `{ url: ',', fallback: '|' }` before and
`{ url: '', fallback: ',' }` after. The comma fallback only continues on
404/410, so a failing proxy ahead of an empty segment silently stopped the
lookup instead of falling through to the remaining proxies.

Empty segments carry no url to query, so drop them.

* refactor(datasource/go): use isTruthy for empty segment filter

* fix(datasource/go): filter empty segments before mapping

Filtering after the map broke the contextual typing from the
GoproxyItem[] annotation, widening fallback to string.

* refactor(platform/github): use regEx() for merge queue query stripping

---------

Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
2026-08-14 14:30:46 +00:00

149 lines
6.3 KiB
TypeScript

import * as memCache from '../../../util/cache/memory/index.ts';
import { parseGoproxy, parseNoproxy } from './goproxy-parser.ts';
describe('modules/datasource/go/goproxy-parser', () => {
beforeEach(() => {
memCache.init();
});
describe('parseGoproxy', () => {
it('parses single url', () => {
const result = parseGoproxy('foo');
expect(result).toMatchObject([{ url: 'foo' }]);
});
it('parses multiple urls', () => {
const result = parseGoproxy('foo,bar|baz,qux');
expect(result).toMatchObject([
{ url: 'foo', fallback: ',' },
{ url: 'bar', fallback: '|' },
{ url: 'baz', fallback: ',' },
{ url: 'qux' },
]);
});
it('ignores everything starting from "direct" and "off" keywords', () => {
expect(parseGoproxy(undefined)).toBeEmpty();
expect(parseGoproxy(undefined)).toBeEmpty();
expect(parseGoproxy('')).toBeEmpty();
expect(parseGoproxy('off')).toMatchObject([
{ url: 'off', fallback: '|' },
]);
expect(parseGoproxy('direct')).toMatchObject([
{ url: 'direct', fallback: '|' },
]);
expect(parseGoproxy('foo,off|direct,qux')).toMatchObject([
{ url: 'foo', fallback: ',' },
{ url: 'off', fallback: '|' },
{ url: 'direct', fallback: ',' },
{ url: 'qux', fallback: '|' },
]);
});
it('skips empty segments', () => {
expect(parseGoproxy(',foo')).toMatchObject([{ url: 'foo' }]);
expect(parseGoproxy('|')).toBeEmpty();
expect(parseGoproxy('foo,,bar')).toMatchObject([
{ url: 'foo', fallback: ',' },
{ url: 'bar', fallback: '|' },
]);
expect(parseGoproxy('foo|,bar')).toMatchObject([
{ url: 'foo', fallback: '|' },
{ url: 'bar', fallback: '|' },
]);
});
it('caches results', () => {
expect(parseGoproxy('foo,bar')).toBe(parseGoproxy('foo,bar'));
});
});
describe('parseNoproxy', () => {
it('produces regex', () => {
expect(parseNoproxy(undefined)).toBeNull();
expect(parseNoproxy(null)).toBeNull();
expect(parseNoproxy('')).toBeNull();
expect(parseNoproxy('/')).toBeNull();
expect(parseNoproxy('*')?.source).toBe('^(?:[^\\/]*)(?:\\/.*)?$');
expect(parseNoproxy('?')?.source).toBe('^(?:[^\\/])(?:\\/.*)?$');
expect(parseNoproxy('foo')?.source).toBe('^(?:foo)(?:\\/.*)?$');
expect(parseNoproxy('\\f\\o\\o')?.source).toBe('^(?:foo)(?:\\/.*)?$');
expect(parseNoproxy('foo,bar')?.source).toBe('^(?:foo|bar)(?:\\/.*)?$');
expect(parseNoproxy('[abc]')?.source).toBe('^(?:[abc])(?:\\/.*)?$');
expect(parseNoproxy('[a-c]')?.source).toBe('^(?:[a-c])(?:\\/.*)?$');
expect(parseNoproxy('[\\a-\\c]')?.source).toBe('^(?:[a-c])(?:\\/.*)?$');
expect(parseNoproxy('a.b.c')?.source).toBe('^(?:a\\.b\\.c)(?:\\/.*)?$');
expect(parseNoproxy('trailing/')?.source).toBe(
'^(?:trailing)(?:\\/.*)?$',
);
});
it('matches on real package prefixes', () => {
expect(parseNoproxy('ex.co')?.test('ex.co/foo')).toBeTrue();
expect(parseNoproxy('ex.co/')?.test('ex.co/foo')).toBeTrue();
expect(parseNoproxy('ex.co/foo/bar')?.test('ex.co/foo/bar')).toBeTrue();
expect(parseNoproxy('ex.co/foo/bar')?.test('ex.co/foo/bar')).toBeTrue();
expect(parseNoproxy('*/foo/*')?.test('example.com/foo/bar')).toBeTrue();
expect(parseNoproxy('ex.co/foo/*')?.test('ex.co/foo/bar')).toBeTrue();
expect(parseNoproxy('ex.co/foo/*')?.test('ex.co/foo/baz')).toBeTrue();
expect(parseNoproxy('ex.co')?.test('ex.co/foo/v2')).toBeTrue();
expect(parseNoproxy('ex.co/foo/bar')?.test('ex.co/foo/bar')).toBeTrue();
expect(parseNoproxy('*/foo/*')?.test('example.com/foo/bar')).toBeTrue();
expect(parseNoproxy('ex.co/foo/*')?.test('ex.co/foo/bar')).toBeTrue();
expect(parseNoproxy('ex.co/foo/*')?.test('ex.co/foo/baz')).toBeTrue();
expect(
parseNoproxy('ex.co/foo/bar,ex.co/foo/baz')?.test('ex.co/foo/bar'),
).toBeTrue();
expect(
parseNoproxy('ex.co/foo/bar,ex.co/foo/baz')?.test('ex.co/foo/baz'),
).toBeTrue();
expect(
parseNoproxy('ex.co/foo/bar,ex.co/foo/baz')?.test('ex.co/foo/qux'),
).toBeFalse();
expect(parseNoproxy('ex')?.test('ex.co/foo')).toBeFalse();
expect(parseNoproxy('aba')?.test('x/aba')).toBeFalse();
expect(parseNoproxy('x/b')?.test('x/aba')).toBeFalse();
expect(parseNoproxy('x/ab')?.test('x/aba')).toBeFalse();
expect(parseNoproxy('x/ab[a-b]')?.test('x/aba')).toBeTrue();
});
it('matches on wildcards', () => {
expect(parseNoproxy('/*/')?.test('ex.co/foo')).toBeFalse();
expect(parseNoproxy('*/foo')?.test('ex.co/foo')).toBeTrue();
expect(parseNoproxy('*/fo')?.test('ex.co/foo')).toBeFalse();
expect(parseNoproxy('*/fo?')?.test('ex.co/foo')).toBeTrue();
expect(parseNoproxy('*/fo*')?.test('ex.co/foo')).toBeTrue();
expect(parseNoproxy('*fo*')?.test('ex.co/foo')).toBeFalse();
expect(parseNoproxy('*.co')?.test('ex.co/foo')).toBeTrue();
expect(parseNoproxy('ex*')?.test('ex.co/foo')).toBeTrue();
expect(parseNoproxy('*/foo')?.test('ex.co/foo/v2')).toBeTrue();
expect(parseNoproxy('*/foo/')?.test('ex.co/foo/v2')).toBeTrue();
expect(parseNoproxy('*/foo/*')?.test('ex.co/foo/v2')).toBeTrue();
expect(parseNoproxy('*/foo/*/')?.test('ex.co/foo/v2')).toBeTrue();
expect(parseNoproxy('*/v2')?.test('ex.co/foo/v2')).toBeFalse();
expect(parseNoproxy('*/*/v2')?.test('ex.co/foo/v2')).toBeTrue();
expect(parseNoproxy('*/*/*')?.test('ex.co/foo/v2')).toBeTrue();
expect(parseNoproxy('*/*/*/')?.test('ex.co/foo/v2')).toBeTrue();
expect(parseNoproxy('*/*/*')?.test('ex.co/foo')).toBeFalse();
expect(parseNoproxy('*/*/*/')?.test('ex.co/foo')).toBeFalse();
expect(parseNoproxy('*/*/*,,')?.test('ex.co/repo')).toBeFalse();
expect(parseNoproxy('*/*/*,,*/repo')?.test('ex.co/repo')).toBeTrue();
expect(parseNoproxy(',,*/repo')?.test('ex.co/repo')).toBeTrue();
});
it('matches on character ranges', () => {
expect(parseNoproxy('x/ab[a-b]')?.test('x/aba')).toBeTrue();
expect(parseNoproxy('x/ab[a-b]')?.test('x/abc')).toBeFalse();
});
it('caches results', () => {
expect(parseNoproxy('foo/bar')).toBe(parseNoproxy('foo/bar'));
});
});
});