Skip to content

Repository navigation

fix: diagnose unsupported stored configuration with safe recovery #642

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
efraespada merged 4 commits into from
Oct 21, 2026
Merged

fix: diagnose unsupported stored configuration with safe recovery #642

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ff3410b
fix: diagnose unsupported stored configuration with safe recovery
efraespada Oct 21, 2026
aa9bb01
Merge develop into bugfix/635-improve-diagnostics-and-recovery-for-un…
vypbot Oct 21, 2026
69e5f8f
Merge develop into bugfix/635-improve-diagnostics-and-recovery-for-un…
vypbot Oct 21, 2026
aafb613
Merge develop into bugfix/635-improve-diagnostics-and-recovery-for-un…
vypbot Oct 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions build/api/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5171,6 +5171,9 @@ exports.APPLICATION_ERROR_RECOVERY_IDS = Object.freeze([
'workspace-changes-rejected',
'closed-issue-reconciliation-failed',
'approval-evidence-read-failed',
'stored-configuration-schema-missing',
'stored-configuration-schema-unsupported',
'stored-configuration-invalid',
]);
const PRESERVED_STATE = 'Existing persisted state and completed external effects were preserved.';
const UNCHANGED_STATE = 'No new state or external effect was created.';
Expand Down Expand Up @@ -5362,6 +5365,9 @@ class ApplicationError extends Error {
exports.ApplicationError = ApplicationError;
_ApplicationError_cause = new WeakMap();
const RECOVERY_VARIABLE_KEYS = Object.freeze({
'stored-configuration-schema-missing': Object.freeze(['issueNumber', 'expectedVersion']),
'stored-configuration-schema-unsupported': Object.freeze(['issueNumber', 'expectedVersion', 'actualVersion']),
'stored-configuration-invalid': Object.freeze(['issueNumber', 'expectedVersion']),
'closed-issue-reconciliation-failed': Object.freeze(['resultId', 'phase', 'state', 'reason', 'changed', 'remaining']),
'approval-evidence-read-failed': Object.freeze(['operation', 'reason', 'permission']),
'pull-request-link-restored': Object.freeze([]),
Expand Down Expand Up @@ -5391,6 +5397,13 @@ function normalizeApplicationErrorRecovery(recovery) {
|| actualKeys.some((key, index) => key !== expectedKeys[index])) {
throw new TypeError(`Application error recovery variables are invalid for ${recovery.id}.`);
}
if (recovery.id.startsWith('stored-configuration-')
&& (![variables.issueNumber, variables.expectedVersion].every(value => typeof value === 'number' && Number.isSafeInteger(value) && value > 0)
|| (recovery.id === 'stored-configuration-schema-unsupported'
&& !(typeof variables.actualVersion === 'number'
&& Number.isSafeInteger(variables.actualVersion) && variables.actualVersion >= 0)))) {
throw new TypeError('Stored configuration diagnostic is invalid.');
}
if (recovery.id === 'managed-branch-enrichment-failed'
&& (typeof variables.branchName !== 'string'
|| !/^[A-Za-z0-9][A-Za-z0-9._/-]{0,254}$/u.test(variables.branchName))) {
Expand Down
15 changes: 14 additions & 1 deletion build/api/src/data/model/application_error.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,22 @@ import { type ApprovalEvidenceDiagnostic } from '../../domain/approval_evidence_
import { type BranchSyncValidationCode } from '../../domain/branch_sync_validation';
export type ApplicationErrorKind = 'configuration' | 'authorization' | 'provider' | 'agent' | 'validation' | 'workflow' | 'unknown';
export type ApplicationErrorCode = 'configuration.invalid' | 'configuration.unsupported' | 'authorization.denied' | 'authorization.credential-invalid' | 'provider.not-found' | 'provider.conflict' | 'provider.rate-limited' | 'provider.unavailable' | 'provider.contract-invalid' | 'agent.policy-rejected' | 'agent.failed' | 'locale.output-invalid' | 'locale.translation-failed' | 'validation.invalid-input' | 'validation.evidence-too-large' | 'validation.evidence-unavailable' | 'workflow.invalid-event' | 'workflow.stale' | 'workflow.cancelled' | 'workflow.failed' | 'workflow.presentation-pending' | 'timeout' | 'unexpected';
export declare const APPLICATION_ERROR_RECOVERY_IDS: readonly ["pull-request-link-restored", "pull-request-link-base-retained", "pull-request-link-reference-retained", "pull-request-link-base-and-reference-retained", "managed-branch-enrichment-failed", "inactivity-explanation-failed", "bugbot-review-blocks-pending", "branch-sync-agent-disabled", "branch-sync-fixer-unavailable", "branch-sync-resolution-invalid", "sdd-draft-size-exceeded", "sdd-draft-format-invalid", "workspace-changes-rejected", "closed-issue-reconciliation-failed", "approval-evidence-read-failed"];
export declare const APPLICATION_ERROR_RECOVERY_IDS: readonly ["pull-request-link-restored", "pull-request-link-base-retained", "pull-request-link-reference-retained", "pull-request-link-base-and-reference-retained", "managed-branch-enrichment-failed", "inactivity-explanation-failed", "bugbot-review-blocks-pending", "branch-sync-agent-disabled", "branch-sync-fixer-unavailable", "branch-sync-resolution-invalid", "sdd-draft-size-exceeded", "sdd-draft-format-invalid", "workspace-changes-rejected", "closed-issue-reconciliation-failed", "approval-evidence-read-failed", "stored-configuration-schema-missing", "stored-configuration-schema-unsupported", "stored-configuration-invalid"];
export type ApplicationErrorRecoveryId = typeof APPLICATION_ERROR_RECOVERY_IDS[number];
interface ApplicationErrorRecoveryVariables {
readonly 'stored-configuration-schema-missing': Readonly<{
issueNumber: number;
expectedVersion: number;
}>;
readonly 'stored-configuration-schema-unsupported': Readonly<{
issueNumber: number;
expectedVersion: number;
actualVersion: number;
}>;
readonly 'stored-configuration-invalid': Readonly<{
issueNumber: number;
expectedVersion: number;
}>;
readonly 'closed-issue-reconciliation-failed': ClosedIssueReconciliationFacts;
readonly 'approval-evidence-read-failed': ApprovalEvidenceDiagnostic;
readonly 'pull-request-link-restored': Readonly<Record<string, never>>;
Expand Down
112 changes: 104 additions & 8 deletions build/cli/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39313,7 +39313,26 @@ const SPANISH_CONTENT = Object.freeze({
retainedState: PRESERVED_STATE_ES,
}),
});
const STORED_CONFIGURATION_ACTION_EN = 'A maintainer must review {recoveryGuide}. Preserve a copy before removing only a verified obsolete unmanaged block. If managed branch, release, hotfix or orchestration state may exist, stop and restore verified supported state with a maintainer. Do not just add a schema version or delete managed state. Correct the configuration before rerunning; retrying unchanged state will fail again.';
const STORED_CONFIGURATION_ACTION_ES = 'Un mantenedor debe revisar {recoveryGuide}. Conserva una copia antes de retirar solo un bloque obsoleto confirmado como no gestionado. Si puede existir estado gestionado de ramas, releases, hotfixes u orquestación, detente y restaura estado compatible verificado con un mantenedor. No añadas simplemente una versión de esquema ni borres estado gestionado. Corrige la configuración antes de reejecutar; el mismo estado volverá a fallar.';
const STORED_CONFIGURATION_RETAINED_EN = 'The issue/PR description and stored configuration were not changed by this read.';
const STORED_CONFIGURATION_RETAINED_ES = 'Esta lectura no modificó la descripción de la issue/PR ni su configuración almacenada.';
const ENGLISH_RECOVERY_CONTENT = Object.freeze({
'stored-configuration-schema-missing': Object.freeze({
impact: 'Automation stopped for issue/PR #{issueNumber}: the stored configuration has no schema version; version {expectedVersion} is required.',
action: STORED_CONFIGURATION_ACTION_EN,
retainedState: STORED_CONFIGURATION_RETAINED_EN,
}),
'stored-configuration-schema-unsupported': Object.freeze({
impact: 'Automation stopped for issue/PR #{issueNumber}: stored schema version {actualVersion} is unsupported; version {expectedVersion} is required.',
action: STORED_CONFIGURATION_ACTION_EN,
retainedState: STORED_CONFIGURATION_RETAINED_EN,
}),
'stored-configuration-invalid': Object.freeze({
impact: 'Automation stopped for issue/PR #{issueNumber}: the stored configuration, markers or schema value are malformed; valid schema version {expectedVersion} is required.',
action: STORED_CONFIGURATION_ACTION_EN,
retainedState: STORED_CONFIGURATION_RETAINED_EN,
}),
'closed-issue-reconciliation-failed': Object.freeze({
impact: 'Issue cleanup remains unverified: {resultId}, phase {phase}; native state {state}, reason {reason}.',
action: 'Inspect the closed-issue or merged-PR run and current native state. Retry cleanup only if the issue is still closed with the intended reason; leave reopened work open. Resolve the named failure before retrying.',
Expand Down Expand Up @@ -39391,6 +39410,21 @@ const ENGLISH_RECOVERY_CONTENT = Object.freeze({
}),
});
const SPANISH_RECOVERY_CONTENT = Object.freeze({
'stored-configuration-schema-missing': Object.freeze({
impact: 'La automatización se detuvo para la issue/PR #{issueNumber}: la configuración almacenada no tiene versión de esquema; se requiere la versión {expectedVersion}.',
action: STORED_CONFIGURATION_ACTION_ES,
retainedState: STORED_CONFIGURATION_RETAINED_ES,
}),
'stored-configuration-schema-unsupported': Object.freeze({
impact: 'La automatización se detuvo para la issue/PR #{issueNumber}: la versión de esquema almacenada {actualVersion} no es compatible; se requiere la versión {expectedVersion}.',
action: STORED_CONFIGURATION_ACTION_ES,
retainedState: STORED_CONFIGURATION_RETAINED_ES,
}),
'stored-configuration-invalid': Object.freeze({
impact: 'La automatización se detuvo para la issue/PR #{issueNumber}: la configuración almacenada, sus delimitadores o el valor del esquema no son válidos; se requiere un esquema válido de versión {expectedVersion}.',
action: STORED_CONFIGURATION_ACTION_ES,
retainedState: STORED_CONFIGURATION_RETAINED_ES,
}),
'closed-issue-reconciliation-failed': Object.freeze({
impact: 'La limpieza de la issue sigue sin verificarse: {resultId}, fase {phase}; estado nativo {state}, motivo {reason}.',
action: 'Revisa la ejecución de cierre o de la PR fusionada y el estado nativo actual. Reintenta la limpieza solo si la issue sigue cerrada con el motivo previsto; conserva abierto el trabajo reabierto. Resuelve el fallo indicado antes de reintentar.',
Expand Down Expand Up @@ -39520,12 +39554,16 @@ exports.buildApplicationErrorPresentation = buildApplicationErrorPresentation;
exports.renderApplicationErrorText = renderApplicationErrorText;
exports.renderApplicationErrorMarkdown = renderApplicationErrorMarkdown;
const application_error_message_catalog_1 = __nccwpck_require__(64809);
// This trusted destination is inserted after localization, never supplied by a body or translation.
const STORED_CONFIGURATION_RECOVERY_URL = 'https://docs.page/vypdev/copilot/security-operations/operations/troubleshooting#unsupported-stored-configuration';
/** Shared semantic view model for terminal, GitHub, and API presentation. */
function buildApplicationErrorPresentation(error, message = application_error_message_catalog_1.readEnglishApplicationErrorMessage) {
const descriptor = error.recovery
? `error.recovery.${error.recovery.id}`
: `error.${error.code}`;
const variables = error.recovery?.variables;
const variables = error.recovery?.id.startsWith('stored-configuration-')
? { ...error.recovery.variables, recoveryGuide: STORED_CONFIGURATION_RECOVERY_URL }
: error.recovery?.variables;
return {
impact: message(`${descriptor}.impact`, variables),
code: error.code,
Expand Down Expand Up @@ -78373,6 +78411,9 @@ exports.APPLICATION_ERROR_RECOVERY_IDS = Object.freeze([
'workspace-changes-rejected',
'closed-issue-reconciliation-failed',
'approval-evidence-read-failed',
'stored-configuration-schema-missing',
'stored-configuration-schema-unsupported',
'stored-configuration-invalid',
]);
const PRESERVED_STATE = 'Existing persisted state and completed external effects were preserved.';
const UNCHANGED_STATE = 'No new state or external effect was created.';
Expand Down Expand Up @@ -78564,6 +78605,9 @@ class ApplicationError extends Error {
exports.ApplicationError = ApplicationError;
_ApplicationError_cause = new WeakMap();
const RECOVERY_VARIABLE_KEYS = Object.freeze({
'stored-configuration-schema-missing': Object.freeze(['issueNumber', 'expectedVersion']),
'stored-configuration-schema-unsupported': Object.freeze(['issueNumber', 'expectedVersion', 'actualVersion']),
'stored-configuration-invalid': Object.freeze(['issueNumber', 'expectedVersion']),
'closed-issue-reconciliation-failed': Object.freeze(['resultId', 'phase', 'state', 'reason', 'changed', 'remaining']),
'approval-evidence-read-failed': Object.freeze(['operation', 'reason', 'permission']),
'pull-request-link-restored': Object.freeze([]),
Expand Down Expand Up @@ -78593,6 +78637,13 @@ function normalizeApplicationErrorRecovery(recovery) {
|| actualKeys.some((key, index) => key !== expectedKeys[index])) {
throw new TypeError(`Application error recovery variables are invalid for ${recovery.id}.`);
}
if (recovery.id.startsWith('stored-configuration-')
&& (![variables.issueNumber, variables.expectedVersion].every(value => typeof value === 'number' && Number.isSafeInteger(value) && value > 0)
|| (recovery.id === 'stored-configuration-schema-unsupported'
&& !(typeof variables.actualVersion === 'number'
&& Number.isSafeInteger(variables.actualVersion) && variables.actualVersion >= 0)))) {
throw new TypeError('Stored configuration diagnostic is invalid.');
}
if (recovery.id === 'managed-branch-enrichment-failed'
&& (typeof variables.branchName !== 'string'
|| !/^[A-Za-z0-9][A-Za-z0-9._/-]{0,254}$/u.test(variables.branchName))) {
Expand Down Expand Up @@ -83899,6 +83950,7 @@ function combineOrganizationAccess(secrets, variables) {

Object.defineProperty(exports, "__esModule", ({ value: true }));
exports.isGithubAlreadyExists = exports.isGithubPermissionDenied = exports.isGithubRateLimited = exports.isGithubNotFound = exports.getGithubErrorStatus = void 0;
exports.githubReadErrorCode = githubReadErrorCode;
const getGithubErrorStatus = (error) => {
if (typeof error !== "object" || error === null)
return undefined;
Expand All @@ -83908,6 +83960,23 @@ const getGithubErrorStatus = (error) => {
exports.getGithubErrorStatus = getGithubErrorStatus;
const isGithubNotFound = (error) => (0, exports.getGithubErrorStatus)(error) === 404;
exports.isGithubNotFound = isGithubNotFound;
/** Maps failed metadata reads without copying untrusted provider text. */
function githubReadErrorCode(error) {
const status = (0, exports.getGithubErrorStatus)(error);
if (status === 401)
return 'authorization.credential-invalid';
if ((0, exports.isGithubRateLimited)(error))
return 'provider.rate-limited';
if (status === 403)
return 'authorization.denied';
if (status === 404)
return 'provider.not-found';
if (status === 409 || status === 412)
return 'provider.conflict';
if (status === 400 || status === 422)
return 'provider.contract-invalid';
return 'provider.unavailable';
}
const isGithubRateLimited = (error) => {
const status = (0, exports.getGithubErrorStatus)(error);
if (status === 429)
Expand Down Expand Up @@ -84618,8 +84687,9 @@ class IssueContentRepository {
return issue.body ?? '';
}
catch (error) {
(0, logger_1.logError)((0, application_error_1.toApplicationError)(error, 'provider.unavailable', `Unable to read issue #${issueNumber} description.`));
throw error;
const semanticError = (0, application_error_1.toApplicationError)(error, (0, github_error_policy_1.githubReadErrorCode)(error), 'Unable to read the issue or pull-request description.');
(0, logger_1.logError)(semanticError);
throw semanticError;
}
};
this.getIssueDescription = async (owner, repository, issueNumber, token) => {
Expand Down Expand Up @@ -102753,18 +102823,44 @@ class ConfigurationHandler extends issue_content_interface_1.IssueContentInterfa
return this.internalUpdate(query, (0, configuration_payload_policy_1.buildConfigurationPayload)(context, storedRaw));
};
this.get = async (query) => {
let description;
try {
description = await this.issueDescriptionPort.getDescription(query.owner, query.repository, query.issueNumber, query.token);
}
catch (cause) {
const semanticError = (0, application_error_1.toApplicationError)(cause, 'provider.unavailable', 'Unable to read issue configuration.');
(0, logger_1.logError)(semanticError);
throw semanticError;
}
const variables = { issueNumber: query.issueNumber, expectedVersion: config_1.CONFIG_SCHEMA_VERSION };
let recovery = { id: 'stored-configuration-invalid', variables };
try {
const description = await this.issueDescriptionPort.getDescription(query.owner, query.repository, query.issueNumber, query.token);
const config = this.getContent(description);
if (config === undefined) {
if (description?.includes('<!-- copilot-configuration-start')
|| description?.includes('copilot-configuration-end -->')) {
throw new Error('Stored configuration markers are inconsistent.');
}
return undefined;
}
const branchConfig = (0, config_1.requireCurrentConfigurationPayload)(JSON.parse(config));
const parsed = JSON.parse(config);
if (parsed !== null && typeof parsed === 'object' && !Array.isArray(parsed)) {
const version = parsed.schemaVersion;
if (version === undefined) {
recovery = { id: 'stored-configuration-schema-missing', variables };
}
else if (typeof version === 'number' && Number.isSafeInteger(version)
&& version >= 0 && version !== config_1.CONFIG_SCHEMA_VERSION) {
recovery = { id: 'stored-configuration-schema-unsupported', variables: { ...variables, actualVersion: version } };
}
}
const branchConfig = (0, config_1.requireCurrentConfigurationPayload)(parsed);
return new config_1.Config(branchConfig);
}
catch (error) {
(0, logger_1.logError)((0, application_error_1.toApplicationError)(error, 'configuration.invalid', 'Unable to read issue configuration.'));
throw error;
catch (cause) {
const semanticError = (0, application_error_1.toApplicationError)(cause, 'configuration.invalid', 'Stored issue/PR configuration is invalid.', { recovery });
(0, logger_1.logError)(semanticError);
throw semanticError;
}
};
}
Expand Down
Loading
Loading