SHARD 2711: debugFailToCommit flag for skipping account data savings

[S0naliThakur]

PR Type

Enhancement

---

Description

• Added debugFailToCommit flag to skip transaction commits for debugging

• Implemented external endpoint to toggle debugFailToCommit at runtime

• Updated transaction commit logic to respect the new debug flag

• Minor formatting and initialization improvements in StateManager

---

Changes walkthrough 📝

Relevant files

Enhancement

TransactionQueue.ts Add debug flag check to transaction commit logic                  src/state-manager/TransactionQueue.ts Added logic to skip transaction commit if debugFailToCommit is enabled Logs debug message and marks account data as set when skipping +6/-0      index.ts Add flag and endpoint for debug transaction commit skipping src/state-manager/index.ts Introduced debugFailToCommit property to StateManager Initialized flag to false in constructor Registered external GET endpoint to toggle debugFailToCommit via API Endpoint uses debug mode middleware and responds with current flag state +12/-0

---

Need help?

Type /help how to ... in the comments thread for any questions about PR-Agent usage.

Check out the documentation for more information.

[github-actions]

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪

🏅 Score: 92

🧪 No relevant tests

🔒 Security concerns Debug Endpoint Exposure: The addition of an external endpoint to toggle debugFailToCommit introduces a potential risk if the endpoint is not properly secured. If isDebugModeMiddleware is misconfigured or bypassed, this could allow unauthorized users to disable transaction commits, impacting data integrity. Carefully review access controls and deployment configurations to mitigate this risk.

⚡ Recommended focus areas for review Debug Flag Bypass The debugFailToCommit flag allows bypassing transaction commits, which could mask issues or be misused if not properly restricted. Ensure this flag is only enabled in safe, controlled environments and is not accessible in production unintentionally. // Debug flag to intentionally skip committing account data if (this.stateManager.debugFailToCommit) { /* prettier-ignore */ if (logFlags.debug) this.mainLogger.debug(`debugFailToCommit active. Skipping commit for tx: ${queueEntry.logID}`) queueEntry.accountDataSet = true return { success: true } } Debug Endpoint Exposure The new external endpoint for toggling debugFailToCommit should be carefully reviewed to ensure it is only accessible in debug or development environments. Confirm that isDebugModeMiddleware reliably restricts access and cannot be bypassed. // Debug endpoint to toggle fail-to-commit flag Context.network.registerExternalGet('debugFailToCommit', isDebugModeMiddleware, (req, res) => { const { enable } = req.query if (enable !== undefined) { const val = enable === 'true' || enable === '1' this.debugFailToCommit = val } res.json({ debugFailToCommit: this.debugFailToCommit }) })

[github-actions]

PR Code Suggestions ✨

No code suggestions found for the PR.