Skip to content

Implement error and unauthorized #130

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
cloutierMat merged 4 commits into from
Jun 26, 2025
Merged

Implement error and unauthorized #130

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
adfb74f
implement error and unauthorized
cloutierMat Jun 25, 2025
909baa4
add testing
cloutierMat Jun 25, 2025
574aedc
comments and logging
cloutierMat Jun 25, 2025
7375b2b
pr comment
cloutierMat Jun 26, 2025
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
12 changes: 12 additions & 0 deletions __tests__/__snapshots__/resolvers.test.js.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,18 @@ exports[`dynamodb resolvers something 2`] = `
]
`;

exports[`error handling error 1`] = `
{
"message": "foo",
}
`;

exports[`error handling unauthorized 1`] = `
{
"message": "Unauthorized",
}
`;

exports[`rds resolvers attributeExists nested or 1`] = `
{
"statements": [
Expand Down
12 changes: 11 additions & 1 deletion __tests__/helpers.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,9 @@ const runResolverFunctionOnAWS = async (code, context, functionName) => {
});

const result = await client.send(command);
if (result.error) {
return result.error;
}
try {
return JSON.parse(result.evaluationResult);
} catch (e) {
Expand Down Expand Up @@ -72,7 +75,14 @@ export const checkResolverValid = async (code, context, functionName) => {
const fn = module[functionName];

transformContextForAppSync(context);
result = fn(context);
try {
result = fn(context);
} catch (e) {
if (e.name !== "AppSyncUserError") {
throw e;
}
result = {"message": e.message}
}
}
expect(result).toMatchSnapshot();
};
Expand Down
20 changes: 20 additions & 0 deletions __tests__/resolvers.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1016,3 +1016,23 @@ describe("rds resolvers", () => {
});
});

describe("error handling", () => {
test("error", async () => {
const code = `
export function request(ctx) {
util.error("foo")
}
export function response(ctx) {}
`;
await checkResolverValid(code, {}, "request");
})
test("unauthorized", async () => {
const code = `
export function request(ctx) {
util.unauthorized()
}
export function response(ctx) {}
`;
await checkResolverValid(code, {}, "request");
})
})
28 changes: 26 additions & 2 deletions index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,16 @@
import { v4 as uuidv4 } from 'uuid';
import { toJsonObject } from './rds/index.js'

class AppSyncUserError extends Error {
constructor(message, errorType, data, errorInfo) {
super(message);
this.name = "AppSyncUserError";
this.errorType = errorType;
this.data = data;
this.errorInfo = errorInfo;
}
}

export const dynamodbUtils = {
toDynamoDB: function(value) {
if (typeof (value) === "number") {
Expand Down Expand Up @@ -121,8 +131,22 @@ export const util = {
return uuidv4();
},
appendError: function(message, errorType, data, errorInfo) {
// This will be handled in LocalStack in a side channel by printing to stderr
console.error({ message, errorType, data, errorInfo });
const error = { message, errorType, data, errorInfo }
if( console.appendError ) {
// LocalStack is adding `appendError` to console, allowing to push errors to context.outErrors
console.appendError(error)
Copy link
Copy Markdown
Collaborator

@simonrw simonrw Jun 26, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will impact users who want to use this package directly (outside of LocalStack 😱 ) right?

I guess the workaround is to add an appendError attribute to the console global in their own code, so perhaps this will encourage more people to use LocalStack!

Copy link
Copy Markdown
Member Author

@cloutierMat cloutierMat Jun 26, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since it is inside a if block, the previous behaviour of console.error will apply when console.appendError is undefined. So it will still work as it previously did.

With that consideration in mind though, I will remove the TODO and leave a comment to explain.

} else {
// TODO: remove this legacy implementation. We are still supporting it for backward compatibility and prevent
// breaking user's code calling appendError.
// This will be handled in LocalStack in a side channel by printing to stderr
console.error({ message, errorType, data, errorInfo });
}
},
error: function(message, errorType, data, errorInfo) {
throw new AppSyncUserError(message, errorType, data, errorInfo)
},
unauthorized: function() {
throw new AppSyncUserError("Unauthorized", "UnauthorizedException")
},
time: {
nowFormatted: function(pattern) {
Expand Down