Skip to content

OpenAI's Codex Security CLI and TypeScript SDK for finding, validating, and fixing security vulnerabilities. npm: https://www.npmjs.com/package/@openai/codex-security

refactor(workbench): remove repeated Python message projections (#1576)

Michael D'Angelo0395dcab7e86
diff --git a/plugins/codex-security/scripts/workbench_db.py b/plugins/codex-security/scripts/workbench_db.py
index 9b4492450..2e79a7757 100644
--- a/plugins/codex-security/scripts/workbench_db.py
+++ b/plugins/codex-security/scripts/workbench_db.py
@@ -785,10 +785,7 @@ def save_workspace(connection: sqlite3.Connection, args: argparse.Namespace) ->
scope,
args.mode,
user_context_argument(args),
- diff_target["kind"] if diff_target else None,
- diff_target["baseRevision"] if diff_target else None,
- diff_target["headRevision"] if diff_target else None,
- diff_target.get("contentDigest") if diff_target else None,
+ *scan_diff_identity(diff_target or None),
timestamp,
workspace["id"],
),
@@ -2088,12 +2085,7 @@ def request_finding_remediation_action(
occurrence = require_occurrence(connection, args.occurrence_id)
require_finding_open(connection, occurrence["id"])
scan = require_scan(connection, occurrence["scan_id"])
- current = connection.execute(
- "SELECT * FROM finding_remediation_attempts WHERE request_id = ?",
- (request_id,),
- ).fetchone()
- if current is None or current["occurrence_id"] != occurrence["id"]:
- raise SystemExit("Codex Security finding remediation request not found.")
+ current = remediation_state.require_request(connection, request_id, occurrence)
if current["pending_action"] is not None:
if (
current["pending_action"] == args.action
@@ -2161,12 +2153,7 @@ def claim_finding_remediation_resend(
timestamp = now()
occurrence = require_occurrence(connection, args.occurrence_id)
require_finding_open(connection, occurrence["id"])
- current = connection.execute(
- "SELECT * FROM finding_remediation_attempts WHERE request_id = ?",
- (request_id,),
- ).fetchone()
- if current is None or current["occurrence_id"] != occurrence["id"]:
- raise SystemExit("Codex Security finding remediation request not found.")
+ current = remediation_state.require_request(connection, request_id, occurrence)
if current["pending_action"] is None:
raise SystemExit("This remediation attempt does not have a pending host request.")
if current["pending_action_claim_token"] == action_token:
@@ -2176,7 +2163,6 @@ def claim_finding_remediation_resend(
return result
delivered_at = current["pending_action_delivered_at"]
if delivered_at is not None:
- claimed_token = action_token
updated = connection.execute(
"""
UPDATE finding_remediation_attempts
@@ -2199,7 +2185,6 @@ def claim_finding_remediation_resend(
"This remediation worker is still within its execution lease. Retry later."
)
else:
- claimed_token = action_token
updated = connection.execute(
"""
UPDATE finding_remediation_attempts
@@ -2225,7 +2210,7 @@ def claim_finding_remediation_resend(
if updated.rowcount != 1:
raise SystemExit(unavailable)
result = scan_context(connection, occurrence["scan_id"])
- result["actionToken"] = claimed_token
+ result["actionToken"] = action_token
return result
@@ -2285,12 +2270,7 @@ def set_finding_remediation(
occurrence = require_occurrence(connection, args.occurrence_id)
require_finding_open(connection, occurrence["id"])
scan = require_scan(connection, occurrence["scan_id"])
- current = connection.execute(
- "SELECT * FROM finding_remediation_attempts WHERE request_id = ?",
- (request_id,),
- ).fetchone()
- if current is None or current["occurrence_id"] != occurrence["id"]:
- raise SystemExit("Codex Security finding remediation request not found.")
+ current = remediation_state.require_request(connection, request_id, occurrence)
if current["version"] != args.expected_version:
raise SystemExit(
"This remediation request changed. Refresh it before recording an update."
@@ -2784,13 +2764,10 @@ def scan_result(
"status": "canceled" if scan["canceled_at"] else scan["status"],
"updatedAt": progress["updated_at"],
}
+ review_updated_at = ""
if independent_reviews is not None:
- progress_result["independentReviews"] = {
- "active": independent_reviews["active"],
- "completed": independent_reviews["completed"],
- "maximum": independent_reviews["maximum"],
- "consolidating": independent_reviews["consolidating"],
- }
+ review_updated_at = str(independent_reviews.pop("updatedAt"))
+ progress_result["independentReviews"] = independent_reviews
relations = scan_history.finding_relations(
connection, scan["id"], (row["id"] for row in occurrence_rows)
)
@@ -2835,7 +2812,7 @@ def scan_result(
"updatedAt": max(
scan["updated_at"],
progress["updated_at"],
- str(independent_reviews["updatedAt"]) if independent_reviews is not None else "",
+ review_updated_at,
finding_management_updated_at(connection, scan["id"]) or "",
),
"userContext": scan["user_context"],
@@ -3139,8 +3116,7 @@ def finding_remediation_result(
row = connection.execute(
"""
SELECT remediation.request_id, remediation.state, remediation.version,
- remediation.base_revision, remediation.base_content_digest,
- remediation.applied_content_digest, remediation.pending_action,
+ remediation.base_revision, remediation.pending_action,
remediation.pending_action_claimed_at, remediation.pending_action_claim_token,
remediation.pending_action_delivered_at,
remediation.patch_path, remediation.patch_digest, remediation.summary,
diff --git a/plugins/codex-security/scripts/workbench_publication.py b/plugins/codex-security/scripts/workbench_publication.py
index 3124a9701..b82034b45 100644
--- a/plugins/codex-security/scripts/workbench_publication.py
+++ b/plugins/codex-security/scripts/workbench_publication.py
@@ -136,6 +136,15 @@ def verify_linear_publication_scan(
return scan
+def _linear_publication_record(row: sqlite3.Row) -> dict[str, str]:
+ return {
+ "findingId": row["finding_id"],
+ "occurrenceId": row["occurrence_id"],
+ "issueIdentifier": row["external_id"],
+ **({"url": row["external_url"]} if row["external_url"] is not None else {}),
+ }
+
+
def inspect_linear_publication(
db: Any,
payload: dict[str, Any],
@@ -164,15 +173,7 @@ def inspect_linear_publication(
destination.get("projectId"),
),
):
- recorded.setdefault(
- row["occurrence_id"],
- {
- "findingId": row["finding_id"],
- "occurrenceId": row["occurrence_id"],
- "issueIdentifier": row["external_id"],
- **({"url": row["external_url"]} if row["external_url"] is not None else {}),
- },
- )
+ recorded.setdefault(row["occurrence_id"], _linear_publication_record(row))
return {
"scanId": scan["id"],
"destination": destination,
@@ -194,12 +195,11 @@ def prepare_linear_publication(
connection.execute("BEGIN IMMEDIATE")
with connection:
scan = verify_linear_publication_scan(db, connection, payload, findings)
- result = {
+ return {
"scanId": scan["id"],
"destination": destination,
"findingCount": len(findings),
}
- return result
def record_linear_publications(
@@ -319,16 +319,8 @@ def record_linear_publications(
).fetchone()
if row is None:
raise SystemExit("A created Linear issue could not be read from scan history.")
- created.append(
- {
- "findingId": row["finding_id"],
- "occurrenceId": row["occurrence_id"],
- "issueIdentifier": row["external_id"],
- **({"url": row["external_url"]} if row["external_url"] is not None else {}),
- }
- )
- result = {"scanId": scan["id"], "destination": destination, "created": created}
- return result
+ created.append(_linear_publication_record(row))
+ return {"scanId": scan["id"], "destination": destination, "created": created}
def export_findings(
diff --git a/plugins/codex-security/scripts/workbench_remediation.py b/plugins/codex-security/scripts/workbench_remediation.py
index 4115cc759..a8ecc4f8c 100644
--- a/plugins/codex-security/scripts/workbench_remediation.py
+++ b/plugins/codex-security/scripts/workbench_remediation.py
@@ -34,6 +34,18 @@ def require_available(connection: sqlite3.Connection, args: Any, require_scan: A
raise SystemExit(SCAN_STATUS_ERROR)
+def require_request(
+ connection: sqlite3.Connection, request_id: str, occurrence: sqlite3.Row
+) -> sqlite3.Row:
+ current = connection.execute(
+ "SELECT * FROM finding_remediation_attempts WHERE request_id = ?",
+ (request_id,),
+ ).fetchone()
+ if current is None or current["occurrence_id"] != occurrence["id"]:
+ raise SystemExit("Codex Security finding remediation request not found.")
+ return current
+
+
def remediation_claim_is_active(remediation: sqlite3.Row) -> bool:
if remediation["pending_action_claim_token"] is None:
return False
diff --git a/plugins/codex-security/scripts/workbench_validation.py b/plugins/codex-security/scripts/workbench_validation.py
index 52e6cd1bd..81a561614 100644
--- a/plugins/codex-security/scripts/workbench_validation.py
+++ b/plugins/codex-security/scripts/workbench_validation.py
@@ -16,7 +16,10 @@ from typing import Any
# Some plugin hosts launch Python with safe-path isolation enabled.
sys.path.insert(0, str(Path(__file__).resolve().parent))
import finalize_scan_contract as finalizer
-from workbench_scan_usage import _reject_nonstandard_json_number as reject_nonstandard_json_number
+from workbench_scan_usage import TOKEN_FIELDS
+from workbench_scan_usage import (
+ _reject_nonstandard_json_number as reject_nonstandard_json_number,
+)
reject_non_finite_json = finalizer._reject_non_finite_json
@@ -60,14 +63,7 @@ def user_context_argument(args: argparse.Namespace) -> str | None:
return optional_text(value)
-SCAN_USAGE_TOKEN_KEYS = (
- "inputTokens",
- "cachedInputTokens",
- "cacheWriteInputTokens",
- "outputTokens",
- "reasoningOutputTokens",
- "totalTokens",
-)
+SCAN_USAGE_TOKEN_KEYS = tuple(TOKEN_FIELDS.values())
def _valid_legacy_scan_cost(cost: object) -> bool: