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

DO NOT MERGE [RND-643] Investigate Serializable Snapshot Isolation (SSI) in PostgreSQL #308

Closed
wants to merge 5 commits into from
Closed

DO NOT MERGE [RND-643] Investigate Serializable Snapshot Isolation (SSI) in PostgreSQL #308

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
dd333c1
[RND-643] Investigate Serializable Snapshot Isolation (SSI) in Postgr…
jleiva-gap Oct 17, 2023
6000f0b
Update create authorization to use SSI
jleiva-gap Oct 17, 2023
b85d845
Update Delete.test.ts
jleiva-gap Oct 17, 2023
fe703ca
Update Delete.test.ts
jleiva-gap Oct 17, 2023
d970bac
Update documentation
jleiva-gap Oct 17, 2023
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
2 changes: 2 additions & 0 deletions Meadowlark-js/.env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ OAUTH_SIGNING_KEY="<run `openssl rand -base64 256` to create a key>"

MONGODB_MAX_NUMBER_OF_RETRIES=1

# Set the maximum number of retries for PostgreSql.
POSTGRES_MAX_NUMBER_OF_RETRIES=1
#
# The settings below are typically good enough to get started
#
Expand Down
1 change: 1 addition & 0 deletions Meadowlark-js/backends/meadowlark-postgresql-backend/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
"@edfi/meadowlark-authz-server": "^v0.3.6-pre-36",
"@edfi/meadowlark-core": "^v0.3.6-pre-36",
"@edfi/meadowlark-utilities": "^v0.3.6-pre-36",
"async-retry": "^1.3.3",
"pg": "^8.11.3",
"pg-format": "^1.0.4",
"ramda": "0.29.1"
Expand Down
200 changes: 119 additions & 81 deletions Meadowlark-js/backends/meadowlark-postgresql-backend/src/repository/Delete.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
// The Ed-Fi Alliance licenses this file to you under the Apache License, Version 2.0.
// See the LICENSE and NOTICES files in the project root for more information.

import { Logger } from '@edfi/meadowlark-utilities';
import retry from 'async-retry';
import { Logger, Config } from '@edfi/meadowlark-utilities';
import type { DeleteResult, DeleteRequest, ReferringDocumentInfo, MeadowlarkId } from '@edfi/meadowlark-core';
import type { PoolClient } from 'pg';
import {
Expand All @@ -26,91 +27,128 @@ export async function deleteDocumentByDocumentUuid(
client: PoolClient,
): Promise<DeleteResult> {
Logger.debug(`${moduleName}.deleteDocumentByDocumentUuid ${documentUuid}`, traceId);

let deleteResult: DeleteResult = { response: 'UNKNOWN_FAILURE', failureMessage: '' };
let meadowlarkId: MeadowlarkId = '' as MeadowlarkId;
let retryCount = 0;

try {
await beginTransaction(client);
// Find the alias meadowlarkIds for the document to be deleted
const documentAliasIdsResult: MeadowlarkDocumentIdAndAliasId[] = await findAliasMeadowlarkIdsForDocumentByDocumentUuid(
client,
documentUuid,
);
// Each row contains documentUuid and corresponding meadowlarkId (meadowlark_id),
// we just need the first row to return the meadowlark_id
meadowlarkId = documentAliasIdsResult.length > 0 ? documentAliasIdsResult[0].meadowlark_id : ('' as MeadowlarkId);
if (validateNoReferencesToDocument) {
// All documents have alias meadowlarkIds. If no alias meadowlarkIds were found, the document doesn't exist
if (meadowlarkId === '') {
await rollbackTransaction(client);
Logger.debug(`${moduleName}.deleteDocumentByDocumentUuid: DocumentUuid ${documentUuid} does not exist`, traceId);
deleteResult = { response: 'DELETE_FAILURE_NOT_EXISTS' };
return deleteResult;
}

// Extract from the query result
const documentAliasMeadowlarkIds: MeadowlarkId[] = documentAliasIdsResult.map((ref) => ref.alias_meadowlark_id);

// Find any documents that reference this document, either it's own meadowlarkId or an alias
const referenceResult: MeadowlarkId[] = await findReferencingMeadowlarkIds(client, documentAliasMeadowlarkIds);

const references = referenceResult.filter((ref) => ref !== meadowlarkId);

// If this document is referenced, it's a validation failure
if (references.length > 0) {
Logger.debug(
`${moduleName}.deleteDocumentByDocumentUuid: Deleting document meadowlarkId ${meadowlarkId} failed due to existing references`,
traceId,
);

// Get the information of up to five referring documents for failure message purposes
const referenceIds = references.map((ref) => ref);
const referringDocumentInfo: ReferringDocumentInfo[] = await findReferringDocumentInfoForErrorReporting(
client,
referenceIds,
);

if (referringDocumentInfo.length === 0) {
const numberOfRetries: number = Config.get('POSTGRES_MAX_NUMBER_OF_RETRIES');
const deleteProcess = await retry(
async (bail) => {
let deleteResult: DeleteResult = { response: 'UNKNOWN_FAILURE', failureMessage: '' };
let meadowlarkId: MeadowlarkId = '' as MeadowlarkId;
try {
await beginTransaction(client);
// Find the alias meadowlarkIds for the document to be deleted
const documentAliasIdsResult: MeadowlarkDocumentIdAndAliasId[] =
await findAliasMeadowlarkIdsForDocumentByDocumentUuid(client, documentUuid);
// Each row contains documentUuid and corresponding meadowlarkId (meadowlark_id),
// we just need the first row to return the meadowlark_id
meadowlarkId = documentAliasIdsResult.length > 0 ? documentAliasIdsResult[0].meadowlark_id : ('' as MeadowlarkId);
if (validateNoReferencesToDocument) {
// All documents have alias meadowlarkIds. If no alias meadowlarkIds were found, the document doesn't exist
if (meadowlarkId === '') {
await rollbackTransaction(client);
Logger.debug(
`${moduleName}.deleteDocumentByDocumentUuid: DocumentUuid ${documentUuid} does not exist`,
traceId,
);
deleteResult = { response: 'DELETE_FAILURE_NOT_EXISTS' };
return deleteResult;
}

// Extract from the query result
const documentAliasMeadowlarkIds: MeadowlarkId[] = documentAliasIdsResult.map((ref) => ref.alias_meadowlark_id);

// Find any documents that reference this document, either it's own meadowlarkId or an alias
const referenceResult: MeadowlarkId[] = await findReferencingMeadowlarkIds(client, documentAliasMeadowlarkIds);

const references = referenceResult.filter((ref) => ref !== meadowlarkId);

// If this document is referenced, it's a validation failure
if (references.length > 0) {
Logger.debug(
`${moduleName}.deleteDocumentByDocumentUuid: Deleting document meadowlarkId ${meadowlarkId} failed due to existing references`,
traceId,
);

// Get the information of up to five referring documents for failure message purposes
const referenceIds = references.map((ref) => ref);
const referringDocumentInfo: ReferringDocumentInfo[] = await findReferringDocumentInfoForErrorReporting(
client,
referenceIds,
);

if (referringDocumentInfo.length === 0) {
await rollbackTransaction(client);
const errorMessage = `${moduleName}.deleteDocumentByDocumentUuid Error retrieving documents referenced by ${meadowlarkId}, a null result set was returned`;
deleteResult.failureMessage = errorMessage;
Logger.error(errorMessage, traceId);
return deleteResult;
}

deleteResult = {
response: 'DELETE_FAILURE_REFERENCE',
referringDocumentInfo,
};
await rollbackTransaction(client);
return deleteResult;
}
}

// Perform the document delete
Logger.debug(
`${moduleName}.deleteDocumentByDocumentUuid: Deleting document documentUuid ${documentUuid}`,
traceId,
);
deleteResult = await deleteDocumentRowByDocumentUuid(client, documentUuid);

// Delete references where this is the parent document
Logger.debug(
`${moduleName}.deleteDocumentByDocumentUuid Deleting references with documentUuid ${documentUuid} as parent meadowlarkId`,
traceId,
);
await deleteOutboundReferencesOfDocumentByMeadowlarkId(client, meadowlarkId);

// Delete this document from the aliases table
Logger.debug(
`${moduleName}.deleteDocumentByDocumentUuid Deleting alias entries with meadowlarkId ${meadowlarkId}`,
traceId,
);
await deleteAliasesForDocumentByMeadowlarkId(client, meadowlarkId);

await commitTransaction(client);
} catch (error) {
retryCount += 1;
await rollbackTransaction(client);
const errorMessage = `${moduleName}.deleteDocumentByDocumentUuid Error retrieving documents referenced by ${meadowlarkId}, a null result set was returned`;
deleteResult.failureMessage = errorMessage;
Logger.error(errorMessage, traceId);
return deleteResult;
// If there's a serialization failure, rollback the transaction
if (error.code === '40001') {
if (retryCount >= numberOfRetries) {
throw Error('Error after maximum retries');
}
// Throws the error to be handled by async-retry
throw error;
} else {
// If it's not a serialization failure, don't retry and rethrow the error
Logger.error(`${moduleName}.deleteDocumentByDocumentUuid`, traceId, error);
// Throws the error to be handled by the caller
bail(error);
}
}

deleteResult = {
response: 'DELETE_FAILURE_REFERENCE',
referringDocumentInfo,
};
await rollbackTransaction(client);
return deleteResult;
}
}

// Perform the document delete
Logger.debug(`${moduleName}.deleteDocumentByDocumentUuid: Deleting document documentUuid ${documentUuid}`, traceId);
deleteResult = await deleteDocumentRowByDocumentUuid(client, documentUuid);

// Delete references where this is the parent document
Logger.debug(
`${moduleName}.deleteDocumentByDocumentUuid Deleting references with documentUuid ${documentUuid} as parent meadowlarkId`,
traceId,
},
{
retries: numberOfRetries,
onRetry: (error, attempt) => {
if (attempt === numberOfRetries) {
Logger.error('Error after maximum retries', error);
} else {
Logger.error('Retrying transaction due to error:', error);
}
},
},
);
await deleteOutboundReferencesOfDocumentByMeadowlarkId(client, meadowlarkId);

// Delete this document from the aliases table
Logger.debug(
`${moduleName}.deleteDocumentByDocumentUuid Deleting alias entries with meadowlarkId ${meadowlarkId}`,
traceId,
);
await deleteAliasesForDocumentByMeadowlarkId(client, meadowlarkId);

await commitTransaction(client);
} catch (e) {
Logger.error(`${moduleName}.deleteDocumentByDocumentUuid`, traceId, e);
await rollbackTransaction(client);
return { response: 'UNKNOWN_FAILURE', failureMessage: '' };
return deleteProcess;
} catch (error) {
Logger.error(`${moduleName}.deleteDocumentByDocumentUuid`, traceId, error);
return { response: 'UNKNOWN_FAILURE', failureMessage: error.message ?? '' };
}
return deleteResult;
}
8 changes: 3 additions & 5 deletions Meadowlark-js/backends/meadowlark-postgresql-backend/src/repository/SqlHelper.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ types.setTypeParser(types.builtins.INT8, (bigintAsString) => parseInt(bigintAsSt
*/
export async function beginTransaction(client: PoolClient) {
await client.query('BEGIN');
await client.query('SET TRANSACTION ISOLATION LEVEL SERIALIZABLE');
}

/**
Expand Down Expand Up @@ -91,10 +92,7 @@ export async function findAliasMeadowlarkIdsForDocumentByMeadowlarkId(
client: PoolClient,
meadowlarkId: MeadowlarkId,
): Promise<MeadowlarkId[]> {
const querySelect = format(
`SELECT alias_meadowlark_id FROM meadowlark.aliases WHERE meadowlark_id = %L FOR SHARE NOWAIT`,
meadowlarkId,
);
const querySelect = format(`SELECT alias_meadowlark_id FROM meadowlark.aliases WHERE meadowlark_id = %L`, meadowlarkId);
const queryResult: QueryResult<any> = await client.query(querySelect);
return (hasResults(queryResult) ? queryResult.rows.map((ref) => ref.alias_meadowlark_id) : []) as MeadowlarkId[];
}
Expand All @@ -115,7 +113,7 @@ export async function findAliasMeadowlarkIdsForDocumentByDocumentUuid(
documentUuid: DocumentUuid,
): Promise<MeadowlarkDocumentIdAndAliasId[]> {
const querySelect = format(
`SELECT alias_meadowlark_id, meadowlark_id FROM meadowlark.aliases WHERE document_uuid = %L FOR SHARE NOWAIT`,
`SELECT alias_meadowlark_id, meadowlark_id FROM meadowlark.aliases WHERE document_uuid = %L`,
documentUuid,
);
const queryResult: QueryResult<any> = await client.query(querySelect);
Expand Down
Loading
Loading