Skip to content

Commit

Permalink
Fix type gen bug (#449)
Browse files Browse the repository at this point in the history 
We have an issue where if the formatting of SQL is not current or we
encounter a case in which we do not support the type generation library
for the context method, we fail very abruptly.

This PR handles these errors better. 

- If sql/code encounters syntax error and formatting fails, we simply
return the unformatted code to the editor so the user can fix it.
- If code + sql both have syntax errors, the user will now see two
different alerts. One for each one of them.
- We throw the error, but we also log everything to console for
debugging purposes.
- We catch and throw type generation errors in a new variable.
  • Loading branch information
@roshaans
roshaans committed Dec 19, 2023
1 parent 8fb35fe commit 61f92a8
Showing 1 changed file with 53 additions and 90 deletions.
143 changes: 53 additions & 90 deletions frontend/src/components/Editor/Editor.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,10 @@ const Editor = ({
const CODE_STORAGE_KEY = `QueryAPI:Code:${indexerDetails.accountId}#${indexerDetails.indexerName || "new"
}`;

const [error, setError] = useState(undefined);
const [blockHeightError, setBlockHeightError] = useState(undefined);
const [codeFormattingError, setCodeFormattingError] = useState(undefined);
const [schemaFormattingError, setSchemaFormattingError] = useState(undefined);
const [typesGenerationError, setTypesGenerationError] = useState(undefined);

const [fileName, setFileName] = useState("indexingLogic.js");

Expand Down Expand Up @@ -91,20 +93,12 @@ const Editor = ({
}, [indexerDetails.code, indexerDetails.schema]);

useEffect(() => {

const savedSchema = localStorage.getItem(SCHEMA_STORAGE_KEY);
const savedCode = localStorage.getItem(CODE_STORAGE_KEY);

if (savedSchema) {
setSchema(savedSchema);
try {
setSchemaTypes(pgSchemaTypeGen.generateTypes(savedSchema));
setError(() => undefined);
} catch (error) {
handleCodeGenError(error);
}

}
}
if (savedCode) setIndexingCode(savedCode);
}, [indexerDetails.accountId, indexerDetails.indexerName]);

Expand All @@ -127,9 +121,10 @@ const Editor = ({
if (fileName === "indexingLogic.js") {
try {
setSchemaTypes(pgSchemaTypeGen.generateTypes(schema));
setError(() => undefined);
} catch (error) {
handleCodeGenError(error);
setTypesGenerationError(undefined);
} catch (typesError) {
console.log("typesGenerationError generating types for saved schema.\n", typesError);
setTypesGenerationError("There was an error generating types from your schema. Please fix your schema or file a support ticket.");
}
}
}, [fileName]);
Expand Down Expand Up @@ -161,18 +156,15 @@ const Editor = ({
let formatted_schema = formatted_sql;
try {
pgSchemaTypeGen.generateTypes(formatted_sql); // Sanity check
} catch (error) {
handleCodeGenError(error);
return undefined;
} catch (typesError) {
console.log("Error generating types from schema", typesError);
setTypesGenerationError("There was an error generating types from your schema. Please fix your schema or file a support ticket." );
}

setSchemaFormattingError(undefined);
return formatted_schema;
} catch (error) {
console.log("error", error);
setError(
() =>
"Please check your SQL schema formatting and specify an Indexer Name"
);
} catch (formattingError) {
console.log("formattingError", formattingError);
setSchemaFormattingError("Please check your SQL schema formatting and specify an Indexer Name");
return undefined;
}
};
Expand All @@ -194,14 +186,6 @@ const Editor = ({
let formatted_schema = checkSQLSchemaFormatting();
let innerCode = indexingCode.match(/getBlock\s*\([^)]*\)\s*{([\s\S]*)}/)[1];
indexerName = indexerName.replaceAll(" ", "_");
if (formatted_schema == undefined) {
setError(
() =>
"Please check your SQL schema formatting"
);
return;
}
setError(() => undefined);

request("register-function", {
indexerName: indexerName,
Expand Down Expand Up @@ -234,7 +218,6 @@ const Editor = ({
setIndexingCode(defaultCode);
setSchema(defaultSchema);
setSchemaTypes(defaultSchemaTypes);
setError(() => onLoadErrorText);
} else {
try {
let unformatted_wrapped_indexing_code = wrapCode(data.code)
Expand All @@ -247,16 +230,10 @@ const Editor = ({
setOriginalSQLCode(unformatted_schema);
setSchema(unformatted_schema);
}
// if (data.start_block_height) {
// setSelectedOption("specificBlockHeight");
// setBlockHeight(data.start_block_height);
// }
// if (data.filter) {
// setContractFilter(data.filter.matching_rule.affected_account_id)
// }
await reformat(unformatted_wrapped_indexing_code, unformatted_schema)
} catch (error) {
console.log(error);

reformatAll(unformatted_wrapped_indexing_code, unformatted_schema);
} catch (formattingError) {
console.log(formattingError);
}
}
setShowResetCodeModel(false);
Expand All @@ -268,64 +245,40 @@ const Editor = ({
return isUserIndexer ? actionButtonText : "Fork Indexer";
};


const handleFormattingError = (fileName) => {
const errorMessage =
fileName === "indexingLogic.js"
? "Oh snap! We could not format your code. Make sure it is proper Javascript code."
: "Oh snap! We could not format your SQL schema. Make sure it is proper SQL DDL";

setError(() => errorMessage);
};

const reformatAll = (indexingCode, schema) => {
const formattedCode = formatIndexingCode(indexingCode);
let formattedCode = indexingCode
let formattedSql = schema;
try {
formattedCode = formatIndexingCode(indexingCode);
setCodeFormattingError(undefined);
} catch (error) {
console.log("error", error)
setCodeFormattingError("Oh snap! We could not format your code. Make sure it is proper Javascript code.");
}
try {
formattedSql = formatSQL(schema);
setSchemaFormattingError(undefined);
} catch (error) {
setSchemaFormattingError("Could not format your SQL schema. Make sure it is proper SQL DDL");
}
setIndexingCode(formattedCode);

const formattedSchema = formatSQL(schema);
setSchema(formattedSchema);

return { formattedCode, formattedSchema }
}

const reformat = (indexingCode, schema) => {
return new Promise((resolve, reject) => {
try {
let formattedCode;
if (fileName === "indexingLogic.js") {
formattedCode = formatIndexingCode(indexingCode);
setIndexingCode(formattedCode);
} else if (fileName === "schema.sql") {
formattedCode = formatSQL(schema);
setSchema(formattedCode);
}
setError(() => undefined);
resolve(formattedCode);
} catch (error) {
handleFormattingError(fileName);
reject(error);
}
});
setSchema(formattedSql);
return { formattedCode, formattedSql }
};

function handleCodeGen() {
try {
setSchemaTypes(pgSchemaTypeGen.generateTypes(schema));
attachTypesToMonaco(); // Just in case schema types have been updated but weren't added to monaco
setError(() => undefined);
} catch (error) {
handleCodeGenError(error);
setTypesGenerationError(undefined);
} catch (typesError) {
console.log("typesGenerationError generating types for saved schema.\n", typesError);
setTypesGenerationError("Oh snap! We could not generate types for your SQL schema. Make sure it is proper SQL DDL.");
}
}

const handleCodeGenError = (error) => {
console.error("Error generating types for saved schema.\n", error);
const errorMessage = "Oh snap! We could not generate types for your SQL schema. Make sure it is proper SQL DDL."
setError(() => errorMessage);
};

async function handleFormating() {
await reformat(indexingCode, schema);
await reformatAll(indexingCode, schema);
}

function handleEditorMount(editor) {
Expand Down Expand Up @@ -423,9 +376,19 @@ const Editor = ({
height: "100%",
}}
>
{error && (
{codeFormattingError && (
<Alert className="px-3 pt-3" variant="danger">
{codeFormattingError}
</Alert>
)}
{schemaFormattingError && (
<Alert className="px-3 pt-3" variant="danger">
{schemaFormattingError}
</Alert>
)}
{typesGenerationError && (
<Alert className="px-3 pt-3" variant="danger">
{error}
{typesGenerationError}
</Alert>
)}
{debugMode && !debugModeInfoDisabled && (
Expand Down

0 comments on commit 61f92a8

Please sign in to comment.