Skip to content
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

Jump to bottom

Isolate STF failures to the single input that caused them #368

Merged
merged 2 commits into from
May 24, 2024
Merged

Isolate STF failures to the single input that caused them #368

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ae91c66
Isolate STF failures to the single input that caused them
SebastienGllmt May 24, 2024
70898ae
Skip creating savepoint if there are no SQL queries
SebastienGllmt May 24, 2024
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
126 changes: 75 additions & 51 deletions packages/engine/paima-sm/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ import {
updateCardanoEpoch,
updateCardanoPaginationCursor,
} from '@paima/db';
import type { SQLUpdate } from '@paima/db';
import Prando from '@paima/prando';

import { randomnessRouter } from './randomness.js';
Expand Down Expand Up @@ -211,44 +212,56 @@ const SM: GameStateMachineInitializer = {

await processInternalEvents(latestChainData.internalEvents, dbTx);

const checkpointName = `game_sm_start`;
await dbTx.query(`SAVEPOINT ${checkpointName}`);
try {
// Fetch and execute scheduled input data
const scheduledInputsLength = await processScheduledData(
latestChainData,
dbTx,
gameStateTransition,
randomnessGenerator
);
// Fetch and execute scheduled input data
const scheduledInputsLength = await processScheduledData(
latestChainData,
dbTx,
gameStateTransition,
randomnessGenerator
);

// Execute user submitted input data
const userInputsLength = await processUserInputs(
latestChainData,
dbTx,
gameStateTransition,
randomnessGenerator
// Execute user submitted input data
const userInputsLength = await processUserInputs(
latestChainData,
dbTx,
gameStateTransition,
randomnessGenerator
);

// Extra logging
if (cdeDataLength + userInputsLength + scheduledInputsLength > 0)
doLog(
`Processed ${userInputsLength} user inputs, ${scheduledInputsLength} scheduled inputs and ${cdeDataLength} CDE events in block #${latestChainData.blockNumber}`
);

// Extra logging
if (cdeDataLength + userInputsLength + scheduledInputsLength > 0)
doLog(
`Processed ${userInputsLength} user inputs, ${scheduledInputsLength} scheduled inputs and ${cdeDataLength} CDE events in block #${latestChainData.blockNumber}`
);
} catch (e) {
await dbTx.query(`ROLLBACK TO SAVEPOINT ${checkpointName}`);
throw e;
} finally {
await dbTx.query(`RELEASE SAVEPOINT ${checkpointName}`);

// Commit finishing of processing to DB
await blockHeightDone.run({ block_height: latestChainData.blockNumber }, dbTx);
}
// Commit finishing of processing to DB
await blockHeightDone.run({ block_height: latestChainData.blockNumber }, dbTx);
},
};
},
};

/**
* We need to process all the SQL calls of an STF update in an all-or-nothing manner
* STF updates can fail (since the data for them comes from arbitrary onchain data)
* But we can't allow a single user's bad transaction to DOS the game for everybody else
* So failures should be isolated to just the specific input, and not the full block
* (recall: without this, in psql, if a query fails during a db transaction, the entire dbTx becomes invalid)
*/
async function tryOrRollback<T>(dbTx: PoolClient, func: () => Promise<T>): Promise<undefined | T> {
const checkpointName = `game_state_transition`;
await dbTx.query(`SAVEPOINT ${checkpointName}`);
try {
return await func();
} catch (err) {
await dbTx.query(`ROLLBACK TO SAVEPOINT ${checkpointName}`);
doLog(`[paima-sm] Database error on ${checkpointName}. Rolling back.`, err);
return undefined;
} finally {
await dbTx.query(`RELEASE SAVEPOINT ${checkpointName}`);
}
}

async function processCdeDataBase(
cdeData: ChainDataExtensionDatum[] | undefined,
dbTx: PoolClient,
Expand Down Expand Up @@ -362,21 +375,27 @@ async function processScheduledData(
scheduled: true,
};
// Trigger STF
const sqlQueries = await gameStateTransition(
inputData,
data.block_height,
randomnessGenerator,
DBConn
);
let sqlQueries: SQLUpdate[] = [];
try {
sqlQueries = await gameStateTransition(
inputData,
data.block_height,
randomnessGenerator,
DBConn
);
} catch (err) {
// skip scheduled data where the STF fails
doLog(`[paima-sm] Error on scheduled data STF call. Skipping`, err);
continue;
}
if (sqlQueries.length === 0) continue;

await tryOrRollback(DBConn, async () => {
for (const [query, params] of sqlQueries) {
await query.run(params, DBConn);
}
await deleteScheduled.run({ id: data.id }, DBConn);
} catch (err) {
doLog(`[paima-sm] Database error on deleteScheduled: ${err}`);
throw err;
}
});
}
return scheduledData.length;
}
Expand Down Expand Up @@ -430,14 +449,22 @@ async function processUserInputs(
}

// Trigger STF
const sqlQueries = await gameStateTransition(
inputData,
latestChainData.blockNumber,
randomnessGenerator,
DBConn
);

let sqlQueries: SQLUpdate[] = [];
try {
sqlQueries = await gameStateTransition(
inputData,
latestChainData.blockNumber,
randomnessGenerator,
DBConn
);
} catch (err) {
// skip inputs where the STF fails
doLog(`[paima-sm] Error on user input STF call. Skipping`, err);
continue;
}
if (sqlQueries.length === 0) continue;

await tryOrRollback(DBConn, async () => {
for (const [query, params] of sqlQueries) {
await query.run(params, DBConn);
}
Expand All @@ -458,10 +485,7 @@ async function processUserInputs(
DBConn
);
}
} catch (err) {
doLog(`[paima-sm] Database error on gameStateTransition: ${err}`);
throw err;
}
});
}
return latestChainData.submittedData.length;
}
Expand Down