Skip to content

fix(firestore-send-email): improve attachments validation error message #2583

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

Open
HassanBahati wants to merge 9 commits into
base: next
Choose a base branch
from
Open

fix(firestore-send-email): improve attachments validation error message #2583

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
6d500a4
feat(storage-resize-images): Add onStartResize event and trigger for …
HassanBahati Dec 2, 2025
d157015
fix(firestore-send-email): improve attachments validation error message
HassanBahati Jan 12, 2026
b244b6f
fix(firestore-send-email): improve attachments validation error message
HassanBahati Jan 12, 2026
cd3205d
tests(firestore-send-email): fix tests
HassanBahati Jan 12, 2026
80265a4
tests(firestore-send-email): fix tests
HassanBahati Jan 12, 2026
b31f3eb
tests(firestore-send-email): refactor tests
HassanBahati Jan 12, 2026
4021e36
tests(firestore-send-email): fix tests
HassanBahati Jan 12, 2026
f259167
tests(firestore-send-email): refactor tests
HassanBahati Jan 12, 2026
4d5c608
chore: revert irrelevant changes
IzaakGough Apr 20, 2026
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: 1 addition & 1 deletion firestore-send-email/functions/__tests__/validation.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -615,7 +615,7 @@ describe("validatePayload", () => {
};
expect(() => validatePayload(invalidPayload)).toThrow(ValidationError);
expect(() => validatePayload(invalidPayload)).toThrow(
"Invalid message configuration: Field 'message.attachments' must be an array"
"Invalid message configuration: Field 'message.attachments' must be an array. If you have a single attachment object, wrap it in an array (e.g., [{ filename: '...', path: '...' }])"
);
});
});
Expand Down
16 changes: 15 additions & 1 deletion firestore-send-email/functions/src/validation.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,10 @@ export const attachmentSchema = z
});

export const attachmentsSchema = z
.array(attachmentSchema)
.array(attachmentSchema, {
invalid_type_error:
Comment thread
cabljac marked this conversation as resolved.
"Field 'attachments' must be an array. If you have a single attachment object, wrap it in an array (e.g., [{ filename: '...', path: '...' }])",
})
.optional()
.transform((attachments) =>
attachments
Expand Down Expand Up @@ -182,10 +185,21 @@ function formatZodError(
const path = issue.path.length > 0 ? issue.path.join(".") : context;
switch (issue.code) {
case "invalid_type":
if (issue.received === "undefined") {
return `Field '${path}' must be a ${issue.expected}`;
}

Copy link
Copy Markdown
Contributor

@cabljac cabljac Jan 12, 2026 •
edited
Loading

Choose a reason for hiding this comment

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

Actually i think a cleaner fix is I think in here we need

case "invalid_type":
  
  // Missing required field (received undefined)
  if (issue.received === "undefined") {
    return `Field '${path}' must be a ${issue.expected}`;
  }

  // Type mismatch cases
  if (issue.expected === "string") {
    return `Field '${path}' must be a string`;
  }
  if (issue.expected === "array") {
    return `Field '${path}' must be an array`;
  }

Copy link
Copy Markdown
Contributor

@cabljac cabljac Jan 12, 2026

Choose a reason for hiding this comment

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

@HassanBahati did you push changes taking this approach? i dont see them

if (issue.expected === "string") {
return `Field '${path}' must be a string`;
}
if (issue.expected === "array") {
if (issue.message && !issue.message.startsWith("Expected")) {
const customMessage = issue.message.replace(
/Field 'attachments'/g,
`Field '${path}'`
);
return customMessage;
}
return `Field '${path}' must be an array`;
}
if (issue.expected === "object") {
Expand Down
Loading