mirror of
https://github.com/Cacti/cacti.git
synced 2026-10-30 00:26:50 +09:00
TheWitnessandTheWitness
3ab4c69fb7
* PHPStan Level 8 - Phase 1 Conversion
Reduces the real (no-baseline) PHPStan level 8 error count from ~2,724 to 425
and regenerates phpstan-baseline.neon accordingly (8,941 -> 1,921 lines).
Core type-safety changes
- lib/database.php: narrow db_fetch_row()/db_fetch_row_prepared() to return
array (was bool|array) and db_fetch_assoc()/db_fetch_assoc_prepared() to
return array (was mixed); the _prepared workers coerce the connection-failure
path to an empty array so the declared type is honest. empty()/cacti_sizeof()
checks are unaffected.
- lib/database.php: narrow $db_conn guards from is_object() to instanceof PDO in
the transaction/quote/insert-id helpers so the PDO calls resolve.
- lib/mib_cache.php: the fluent MibCache methods mib()/object()/table()/row()
now return self instead of a bare object so chained calls type-check.
Type-safety casts and guards (mechanical, behaviour-preserving)
- Cast string|false/|null builtin results feeding string parameters
(json_decode, base64_encode, trim, htmle, preg_replace, explode, etc.).
- Cast int|string / int|false values feeding int id/pid parameters.
- Guard resource|false fopen()/popen() handles before fwrite/fclose/fread, and
wrap foreach over array|false/list|false results with `?: []`.
Genuine bugs found and fixed
- cli/add_tree.php / lib/api_tree.php: site tree nodes could not be created via
the CLI - the --site-id option was never parsed, $nodeTypes had no 'site'
entry (passing null to api_tree_item_save(int $type) -> TypeError), and
api_tree_item_save() never persisted site_id. All three fixed.
- tree.php: leaves_exist() is typed : int but returned db_fetch_assoc_prepared()
(an array of rows) for a SELECT COUNT(*); now uses db_fetch_cell_prepared()
and returns the scalar count.
- lib/mib_cache.php: $entries_per_object was a float (division / ceil) used as
an array key (PHP 8.1 implicit float-to-int key deprecation); now cast to int.
Config
- .phpstan.neon: add notIdentical.alwaysTrue and booleanAnd.alwaysFalse to the
existing always-true/false ignore family (same "PHPStan gets confused"
dynamic-constant cause already covered by identical.alwaysTrue,
notEqual.alwaysTrue, booleanAnd.leftAlwaysTrue, etc.).
- phpstan-baseline.neon: regenerated; the remaining 425 entries are the
untouched long tail for Phase 2.
* Remove redundant @phpstan-ignore comments
Follow-up cleanup for the level 8 Phase 1 work. Removes 14 inline
@phpstan-ignore comments that no longer suppress any reported error:
- cli/repair_database.php: `@phpstan-ignore booleanAnd.alwaysFalse` is now
covered by the global booleanAnd.alwaysFalse ignore added to .phpstan.neon.
- 13 others (host.php, include/global.php, include/session.php,
lib/api_automation.php x2, lib/functions.php x2, lib/html_utility.php x2,
lib/installer.php, lib/package.php, lib/reports.php, lib/rrd.php) no longer
match any reported error after the type-safety fixes (e.g. the
db_fetch_row_prepared() return-type narrowing removed the offset-assign
errors the api_automation ignores were suppressing).
Verified with reportUnmatchedIgnoredErrors enabled: 0 unmatched ignores
remain and the full level 8 run still reports 0 errors.
* ci: satisfy validator ratchet and refresh security sink baselines
- lib/api_tree.php: give the new tree-item site_id a real numeric
constraint ('^[-0-9]+$', matching html_reports.php) instead of an
empty regex, so the validator constraint ratchet passes without
bumping its baseline.
- tests/security/baselines: refresh the three sink/hotspot signatures
whose code text changed from the (string) casts added in this branch
(lib/poller.php setsid, cli/rrdresize.php json_encode, lib/import.php
simplexml_load_string).
* ci(js): allow DOMPurify 3.4.16 and update sync_js pin test
The dependabot bump (#8134) moved package.json/package-lock.json to
DOMPurify 3.4.16 on develop but left tests/js/sync_js.test.mjs pinned to
3.4.15, so the PR merge commit fails the 'DOMPurify is pinned' contract.
Bring package.json/package-lock.json to 3.4.16 (matching develop) and
update the pin test to expect 3.4.16.
* test: update sql.php null-handling assertion for the (string) cast
This branch changed scripts/sql.php from trim(\ ?? '') to
trim((string) \) (the phpstan-safe form that coerces both null and
false from shell_exec()). Update SqlScriptsTest's null-return assertion
to match the new cast instead of the removed '?? ''.
* fix: address Copilot review - ownership IDs, fopen guards, mib_cache bound
- chown()/chgrp(): pass integer UID/GID from fileowner()/filegroup()
(guarding the false lookup) instead of string-casting them, which made
them resolve account/group names like '1001' and fail. Covers
lib/api_device.php, lib/boost.php and poller_maintenance.php (x2).
- fopen() failure now short-circuits instead of reporting success:
lib/package.php returns false, lib/clog_webapi.php and utilities.php
render an error, and snmpagent_mibcachechild.php skips the cache write
and sentinel unlink so a concurrent writer's lock is preserved.
- lib/mib_cache.php: keep the float quotient as the loop bound and cast
only the array offset, so a non-even entries/columns split no longer
truncates the loop and drops a cached row.
* revert: keep db_fetch_* returning false on error; baseline Level 8 instead
Per review, restoring the intentional fail-safe: db_fetch_row[_prepared]()
return bool|array and db_fetch_assoc[_prepared]() return mixed again, so a
genuine SQL error (not just a missing connection) is signalled as false and
the === false checks in cdef_is_in_use(), boost_process_* and aggregate.php
work as before. Dropped the is_array() ? : [] coercion.
Level 8 stays green by regenerating phpstan-baseline.neon to capture the
re-introduced bool|array/mixed call-site errors (the ~1,850 the narrowing
had eliminated). Tightening those callers to drop them from the baseline is
Phase 2 work.
---------
Co-authored-by: TheWitness <copilot@users.noreply.github.com>
93 lines
2.8 KiB
JavaScript
93 lines
2.8 KiB
JavaScript
import assert from 'node:assert/strict';
|
|
import { execFileSync } from 'node:child_process';
|
|
import { mkdirSync, mkdtempSync, readFileSync, writeFileSync } from 'node:fs';
|
|
import { tmpdir } from 'node:os';
|
|
import { dirname, join, resolve } from 'node:path';
|
|
import { test } from 'node:test';
|
|
import { assetMap, syncAssets } from '../../build/sync-js.mjs';
|
|
|
|
function fixture() {
|
|
const root = mkdtempSync(join(tmpdir(), 'cacti-js-assets-'));
|
|
|
|
for (const [source] of Object.entries(assetMap)) {
|
|
const path = join(root, source);
|
|
mkdirSync(dirname(path), { recursive: true });
|
|
writeFileSync(path, fixtureContent(source));
|
|
}
|
|
|
|
return root;
|
|
}
|
|
|
|
function fixtureContent(source) {
|
|
if (source === 'node_modules/screenfull/index.js') {
|
|
return `// fixture:${source}\nlet screenfull = {};\nexport default screenfull;\n`;
|
|
}
|
|
|
|
return `fixture:${source}\n`;
|
|
}
|
|
|
|
function assertSynced(root) {
|
|
for (const [source, destination] of Object.entries(assetMap)) {
|
|
const actual = readFileSync(join(root, destination), 'utf8');
|
|
|
|
if (source === 'node_modules/screenfull/index.js') {
|
|
assert.equal(actual, `// fixture:${source}\nlet screenfull = {};\nwindow.screenfull = screenfull;\n`);
|
|
} else {
|
|
assert.equal(actual, fixtureContent(source));
|
|
}
|
|
}
|
|
}
|
|
|
|
test('syncAssets copies every managed asset and reports each destination', () => {
|
|
const root = fixture();
|
|
const messages = [];
|
|
|
|
syncAssets(root, message => messages.push(message));
|
|
|
|
assertSynced(root);
|
|
assert.deepEqual(
|
|
messages,
|
|
Object.values(assetMap).map(destination => `synced ${destination}`),
|
|
);
|
|
});
|
|
|
|
test('the command-line entry point builds a release-tree checkout', () => {
|
|
const root = fixture();
|
|
const script = resolve('build/sync-js.mjs');
|
|
|
|
execFileSync(process.execPath, [script], { cwd: root });
|
|
|
|
assertSynced(root);
|
|
});
|
|
|
|
test('DOMPurify is pinned and generated from the matching npm release', () => {
|
|
const packageJson = JSON.parse(readFileSync('package.json', 'utf8'));
|
|
const source = 'node_modules/dompurify/dist/purify.js';
|
|
|
|
assert.equal(packageJson.dependencies.dompurify, '3.4.16');
|
|
assert.equal(assetMap[source], 'include/js/purify.js');
|
|
assert.match(readFileSync(source, 'utf8'), /DOMPurify 3\.4\.16/);
|
|
});
|
|
|
|
test("screenfull's ESM export is rewritten to a global assignment", () => {
|
|
const root = fixture();
|
|
|
|
syncAssets(root, () => {});
|
|
|
|
const rewritten = readFileSync(join(root, 'include/js/screenfull.js'), 'utf8');
|
|
|
|
assert.match(rewritten, /window\.screenfull = screenfull;/);
|
|
assert.doesNotMatch(rewritten, /export default/);
|
|
});
|
|
|
|
test('syncAssets fails loudly if screenfull stops shipping the expected ESM export', () => {
|
|
const root = fixture();
|
|
|
|
writeFileSync(join(root, 'node_modules/screenfull/index.js'), 'const screenfull = {};\nexport {screenfull as default};\n');
|
|
|
|
assert.throws(
|
|
() => syncAssets(root, () => {}),
|
|
/expected 'export default screenfull;'/,
|
|
);
|
|
});
|