feat(core): Improve error formatting in ZodErrors integration

[jahands]

• Include full key path rather than the top level key in title
• Improve message for validation issues with no path
• Add option to include extended issue information as an attachment

Background

I tried using this integration, but found the error format in Sentry to be lacking.
I added tests to demonstrate how this will format issues.

Screenshots

---

Before submitting a pull request, please take a look at our
Contributing guidelines and verify:

• If you've added code that should be tested, please add tests.
• Ensure your code lints and the test suite passes (yarn lint) & (yarn test).

[jahands]

Wasn't sure if adding deps was okay, but it made adding tests a lot easier

[AbhiPrasad]

This is fine for testing

[AbhiPrasad]

@jahands thanks for the PR! could you share a link to a sentry event / screenshot of a sentry event that shows the changes from this PR?

[jahands]

@AbhiPrasad done!

[AbhiPrasad]

Assigning myself so I can help review and merge this in! On my todo to review tomorrow morning :)

[AbhiPrasad]

This is fine for testing

[AbhiPrasad]

I'm not sure we want to duplicate entries here, I think [0].foo.[1].bar is more valuable than <array>.foo.<array>.bar, and we want to make sure that different array entries will lead to different issues.

What do you think?

[jahands]

This is only applied to the issue message, not event.extra or attachments which still include all unique issues with the full path including indexes.

In practice, we found that having the indexes in the message is more noise than helpful for understanding the issue at a glance, which was the primary motivation for me making this improvement in our internal fork.

[AbhiPrasad]

Sounds good to me, let's keep what is here then

[AbhiPrasad]

Hmm tests seem to be failing because the attachment doesn't match the issues being sent anymore. I wonder why 🤔

 FAIL test/lib/integrations/zoderrrors.test.ts
● applyZodErrorsToEvent() › should add all ZodError issues as attachment
expect(received).toMatchInlineSnapshot(snapshot)
Snapshot name: `applyZodErrorsToEvent() should add all ZodError issues as attachment 1`
- Snapshot - 8
+ Received + 0
@@ -6,15 +6,7 @@
"keys": "[\"extra\"]",
"message": "Invalid input: expected string, received number",
"path": "names.1",
"received": "number",
},
- Object {
- "code": "invalid_type",
- "expected": "string",
- "keys": "[\"extra2\"]",
- "message": "Invalid input: expected string, received number",
- "path": "foo.1",
- "received": "number",
- },
],
}
168 | }
169 | expect(attachment.filename).toBe('zod_issues.json');
> 170 | expect(JSON.parse(attachment.data.toString())).toMatchInlineSnapshot(`
| ^
171 | Object {
172 | "issues": Array [
173 | Object {
at Object.<anonymous> (test/lib/integrations/zoderrrors.test.ts:170:52)

[jahands]

Hmm tests seem to be failing because the attachment doesn't match the issues being sent anymore. I wonder why 🤔

 FAIL test/lib/integrations/zoderrrors.test.ts
● applyZodErrorsToEvent() › should add all ZodError issues as attachment
expect(received).toMatchInlineSnapshot(snapshot)
Snapshot name: `applyZodErrorsToEvent() should add all ZodError issues as attachment 1`
- Snapshot - 8
+ Received + 0
@@ -6,15 +6,7 @@
"keys": "[\"extra\"]",
"message": "Invalid input: expected string, received number",
"path": "names.1",
"received": "number",
},
- Object {
- "code": "invalid_type",
- "expected": "string",
- "keys": "[\"extra2\"]",
- "message": "Invalid input: expected string, received number",
- "path": "foo.1",
- "received": "number",
- },
],
}
168 | }
169 | expect(attachment.filename).toBe('zod_issues.json');
> 170 | expect(JSON.parse(attachment.data.toString())).toMatchInlineSnapshot(`
| ^
171 | Object {
172 | "issues": Array [
173 | Object {
at Object.<anonymous> (test/lib/integrations/zoderrrors.test.ts:170:52)

Oh I see, we need to skip slicing the list of issues before flattening if save attachment is enabled so that the full list is included in the attachment. Will fix

[jahands]

@AbhiPrasad fixed that bug, tests pass for me locally now

[jahands]

• Include full key path rather than the top level key in title
• Improve message for validation issues with no path
• Add option to include extended issue information as an attachment

Background

I tried using this integration, but found the error format in Sentry to be lacking.
I added tests to demonstrate how this will format issues.

Screenshots

---

Before submitting a pull request, please take a look at our
Contributing guidelines and verify:

• If you've added code that should be tested, please add tests.
• Ensure your code lints and the test suite passes (yarn lint) & (yarn test).

[jahands]

Wasn't sure if adding deps was okay, but it made adding tests a lot easier

[AbhiPrasad]

This is fine for testing

[AbhiPrasad]

@jahands thanks for the PR! could you share a link to a sentry event / screenshot of a sentry event that shows the changes from this PR?

[jahands]

@AbhiPrasad done!

[AbhiPrasad]

Assigning myself so I can help review and merge this in! On my todo to review tomorrow morning :)

[AbhiPrasad]

This is fine for testing

[AbhiPrasad]

I'm not sure we want to duplicate entries here, I think [0].foo.[1].bar is more valuable than <array>.foo.<array>.bar, and we want to make sure that different array entries will lead to different issues.

What do you think?

[jahands]

This is only applied to the issue message, not event.extra or attachments which still include all unique issues with the full path including indexes.

In practice, we found that having the indexes in the message is more noise than helpful for understanding the issue at a glance, which was the primary motivation for me making this improvement in our internal fork.

[AbhiPrasad]

Sounds good to me, let's keep what is here then

[AbhiPrasad]

Hmm tests seem to be failing because the attachment doesn't match the issues being sent anymore. I wonder why 🤔

 FAIL test/lib/integrations/zoderrrors.test.ts
● applyZodErrorsToEvent() › should add all ZodError issues as attachment
expect(received).toMatchInlineSnapshot(snapshot)
Snapshot name: `applyZodErrorsToEvent() should add all ZodError issues as attachment 1`
- Snapshot - 8
+ Received + 0
@@ -6,15 +6,7 @@
"keys": "[\"extra\"]",
"message": "Invalid input: expected string, received number",
"path": "names.1",
"received": "number",
},
- Object {
- "code": "invalid_type",
- "expected": "string",
- "keys": "[\"extra2\"]",
- "message": "Invalid input: expected string, received number",
- "path": "foo.1",
- "received": "number",
- },
],
}
168 | }
169 | expect(attachment.filename).toBe('zod_issues.json');
> 170 | expect(JSON.parse(attachment.data.toString())).toMatchInlineSnapshot(`
| ^
171 | Object {
172 | "issues": Array [
173 | Object {
at Object.<anonymous> (test/lib/integrations/zoderrrors.test.ts:170:52)

[jahands]

Hmm tests seem to be failing because the attachment doesn't match the issues being sent anymore. I wonder why 🤔

 FAIL test/lib/integrations/zoderrrors.test.ts
● applyZodErrorsToEvent() › should add all ZodError issues as attachment
expect(received).toMatchInlineSnapshot(snapshot)
Snapshot name: `applyZodErrorsToEvent() should add all ZodError issues as attachment 1`
- Snapshot - 8
+ Received + 0
@@ -6,15 +6,7 @@
"keys": "[\"extra\"]",
"message": "Invalid input: expected string, received number",
"path": "names.1",
"received": "number",
},
- Object {
- "code": "invalid_type",
- "expected": "string",
- "keys": "[\"extra2\"]",
- "message": "Invalid input: expected string, received number",
- "path": "foo.1",
- "received": "number",
- },
],
}
168 | }
169 | expect(attachment.filename).toBe('zod_issues.json');
> 170 | expect(JSON.parse(attachment.data.toString())).toMatchInlineSnapshot(`
| ^
171 | Object {
172 | "issues": Array [
173 | Object {
at Object.<anonymous> (test/lib/integrations/zoderrrors.test.ts:170:52)

Oh I see, we need to skip slicing the list of issues before flattening if save attachment is enabled so that the full list is included in the attachment. Will fix

[jahands]

@AbhiPrasad fixed that bug, tests pass for me locally now

[jahands]

• Include full key path rather than the top level key in title
• Improve message for validation issues with no path
• Add option to include extended issue information as an attachment

Background

I tried using this integration, but found the error format in Sentry to be lacking.
I added tests to demonstrate how this will format issues.

Screenshots

---

Before submitting a pull request, please take a look at our
Contributing guidelines and verify:

• If you've added code that should be tested, please add tests.
• Ensure your code lints and the test suite passes (yarn lint) & (yarn test).

[jahands]

Wasn't sure if adding deps was okay, but it made adding tests a lot easier

[AbhiPrasad]

This is fine for testing

[AbhiPrasad]

@jahands thanks for the PR! could you share a link to a sentry event / screenshot of a sentry event that shows the changes from this PR?

[jahands]

@AbhiPrasad done!

[AbhiPrasad]

Assigning myself so I can help review and merge this in! On my todo to review tomorrow morning :)

[AbhiPrasad]

This is fine for testing

[AbhiPrasad]

I'm not sure we want to duplicate entries here, I think [0].foo.[1].bar is more valuable than <array>.foo.<array>.bar, and we want to make sure that different array entries will lead to different issues.

What do you think?

[jahands]

This is only applied to the issue message, not event.extra or attachments which still include all unique issues with the full path including indexes.

In practice, we found that having the indexes in the message is more noise than helpful for understanding the issue at a glance, which was the primary motivation for me making this improvement in our internal fork.

[AbhiPrasad]

Sounds good to me, let's keep what is here then

[AbhiPrasad]

Hmm tests seem to be failing because the attachment doesn't match the issues being sent anymore. I wonder why 🤔

 FAIL test/lib/integrations/zoderrrors.test.ts
● applyZodErrorsToEvent() › should add all ZodError issues as attachment
expect(received).toMatchInlineSnapshot(snapshot)
Snapshot name: `applyZodErrorsToEvent() should add all ZodError issues as attachment 1`
- Snapshot - 8
+ Received + 0
@@ -6,15 +6,7 @@
"keys": "[\"extra\"]",
"message": "Invalid input: expected string, received number",
"path": "names.1",
"received": "number",
},
- Object {
- "code": "invalid_type",
- "expected": "string",
- "keys": "[\"extra2\"]",
- "message": "Invalid input: expected string, received number",
- "path": "foo.1",
- "received": "number",
- },
],
}
168 | }
169 | expect(attachment.filename).toBe('zod_issues.json');
> 170 | expect(JSON.parse(attachment.data.toString())).toMatchInlineSnapshot(`
| ^
171 | Object {
172 | "issues": Array [
173 | Object {
at Object.<anonymous> (test/lib/integrations/zoderrrors.test.ts:170:52)

[jahands]

Hmm tests seem to be failing because the attachment doesn't match the issues being sent anymore. I wonder why 🤔

 FAIL test/lib/integrations/zoderrrors.test.ts
● applyZodErrorsToEvent() › should add all ZodError issues as attachment
expect(received).toMatchInlineSnapshot(snapshot)
Snapshot name: `applyZodErrorsToEvent() should add all ZodError issues as attachment 1`
- Snapshot - 8
+ Received + 0
@@ -6,15 +6,7 @@
"keys": "[\"extra\"]",
"message": "Invalid input: expected string, received number",
"path": "names.1",
"received": "number",
},
- Object {
- "code": "invalid_type",
- "expected": "string",
- "keys": "[\"extra2\"]",
- "message": "Invalid input: expected string, received number",
- "path": "foo.1",
- "received": "number",
- },
],
}
168 | }
169 | expect(attachment.filename).toBe('zod_issues.json');
> 170 | expect(JSON.parse(attachment.data.toString())).toMatchInlineSnapshot(`
| ^
171 | Object {
172 | "issues": Array [
173 | Object {
at Object.<anonymous> (test/lib/integrations/zoderrrors.test.ts:170:52)

Oh I see, we need to skip slicing the list of issues before flattening if save attachment is enabled so that the full list is included in the attachment. Will fix

[jahands]

@AbhiPrasad fixed that bug, tests pass for me locally now

[jahands]

• Include full key path rather than the top level key in title
• Improve message for validation issues with no path
• Add option to include extended issue information as an attachment

Background

I tried using this integration, but found the error format in Sentry to be lacking.
I added tests to demonstrate how this will format issues.

Screenshots

---

Before submitting a pull request, please take a look at our
Contributing guidelines and verify:

• If you've added code that should be tested, please add tests.
• Ensure your code lints and the test suite passes (yarn lint) & (yarn test).

[jahands]

Wasn't sure if adding deps was okay, but it made adding tests a lot easier

[AbhiPrasad]

This is fine for testing

[AbhiPrasad]

@jahands thanks for the PR! could you share a link to a sentry event / screenshot of a sentry event that shows the changes from this PR?

[jahands]

@AbhiPrasad done!

[AbhiPrasad]

Assigning myself so I can help review and merge this in! On my todo to review tomorrow morning :)

[AbhiPrasad]

This is fine for testing

[AbhiPrasad]

I'm not sure we want to duplicate entries here, I think [0].foo.[1].bar is more valuable than <array>.foo.<array>.bar, and we want to make sure that different array entries will lead to different issues.

What do you think?

[jahands]

This is only applied to the issue message, not event.extra or attachments which still include all unique issues with the full path including indexes.

In practice, we found that having the indexes in the message is more noise than helpful for understanding the issue at a glance, which was the primary motivation for me making this improvement in our internal fork.

[AbhiPrasad]

Sounds good to me, let's keep what is here then

[AbhiPrasad]

Hmm tests seem to be failing because the attachment doesn't match the issues being sent anymore. I wonder why 🤔

 FAIL test/lib/integrations/zoderrrors.test.ts
● applyZodErrorsToEvent() › should add all ZodError issues as attachment
expect(received).toMatchInlineSnapshot(snapshot)
Snapshot name: `applyZodErrorsToEvent() should add all ZodError issues as attachment 1`
- Snapshot - 8
+ Received + 0
@@ -6,15 +6,7 @@
"keys": "[\"extra\"]",
"message": "Invalid input: expected string, received number",
"path": "names.1",
"received": "number",
},
- Object {
- "code": "invalid_type",
- "expected": "string",
- "keys": "[\"extra2\"]",
- "message": "Invalid input: expected string, received number",
- "path": "foo.1",
- "received": "number",
- },
],
}
168 | }
169 | expect(attachment.filename).toBe('zod_issues.json');
> 170 | expect(JSON.parse(attachment.data.toString())).toMatchInlineSnapshot(`
| ^
171 | Object {
172 | "issues": Array [
173 | Object {
at Object.<anonymous> (test/lib/integrations/zoderrrors.test.ts:170:52)

[jahands]

Hmm tests seem to be failing because the attachment doesn't match the issues being sent anymore. I wonder why 🤔

 FAIL test/lib/integrations/zoderrrors.test.ts
● applyZodErrorsToEvent() › should add all ZodError issues as attachment
expect(received).toMatchInlineSnapshot(snapshot)
Snapshot name: `applyZodErrorsToEvent() should add all ZodError issues as attachment 1`
- Snapshot - 8
+ Received + 0
@@ -6,15 +6,7 @@
"keys": "[\"extra\"]",
"message": "Invalid input: expected string, received number",
"path": "names.1",
"received": "number",
},
- Object {
- "code": "invalid_type",
- "expected": "string",
- "keys": "[\"extra2\"]",
- "message": "Invalid input: expected string, received number",
- "path": "foo.1",
- "received": "number",
- },
],
}
168 | }
169 | expect(attachment.filename).toBe('zod_issues.json');
> 170 | expect(JSON.parse(attachment.data.toString())).toMatchInlineSnapshot(`
| ^
171 | Object {
172 | "issues": Array [
173 | Object {
at Object.<anonymous> (test/lib/integrations/zoderrrors.test.ts:170:52)

Oh I see, we need to skip slicing the list of issues before flattening if save attachment is enabled so that the full list is included in the attachment. Will fix

[jahands]

@AbhiPrasad fixed that bug, tests pass for me locally now

[jahands]

• Include full key path rather than the top level key in title
• Improve message for validation issues with no path
• Add option to include extended issue information as an attachment

Background

I tried using this integration, but found the error format in Sentry to be lacking.
I added tests to demonstrate how this will format issues.

Screenshots

---

Before submitting a pull request, please take a look at our
Contributing guidelines and verify:

• If you've added code that should be tested, please add tests.
• Ensure your code lints and the test suite passes (yarn lint) & (yarn test).

[jahands]

Wasn't sure if adding deps was okay, but it made adding tests a lot easier

[AbhiPrasad]

This is fine for testing

[AbhiPrasad]

@jahands thanks for the PR! could you share a link to a sentry event / screenshot of a sentry event that shows the changes from this PR?

[jahands]

@AbhiPrasad done!

[AbhiPrasad]

Assigning myself so I can help review and merge this in! On my todo to review tomorrow morning :)

[AbhiPrasad]

This is fine for testing

[AbhiPrasad]

I'm not sure we want to duplicate entries here, I think [0].foo.[1].bar is more valuable than <array>.foo.<array>.bar, and we want to make sure that different array entries will lead to different issues.

What do you think?

[jahands]

This is only applied to the issue message, not event.extra or attachments which still include all unique issues with the full path including indexes.

In practice, we found that having the indexes in the message is more noise than helpful for understanding the issue at a glance, which was the primary motivation for me making this improvement in our internal fork.

[AbhiPrasad]

Sounds good to me, let's keep what is here then

[AbhiPrasad]

Hmm tests seem to be failing because the attachment doesn't match the issues being sent anymore. I wonder why 🤔

 FAIL test/lib/integrations/zoderrrors.test.ts
● applyZodErrorsToEvent() › should add all ZodError issues as attachment
expect(received).toMatchInlineSnapshot(snapshot)
Snapshot name: `applyZodErrorsToEvent() should add all ZodError issues as attachment 1`
- Snapshot - 8
+ Received + 0
@@ -6,15 +6,7 @@
"keys": "[\"extra\"]",
"message": "Invalid input: expected string, received number",
"path": "names.1",
"received": "number",
},
- Object {
- "code": "invalid_type",
- "expected": "string",
- "keys": "[\"extra2\"]",
- "message": "Invalid input: expected string, received number",
- "path": "foo.1",
- "received": "number",
- },
],
}
168 | }
169 | expect(attachment.filename).toBe('zod_issues.json');
> 170 | expect(JSON.parse(attachment.data.toString())).toMatchInlineSnapshot(`
| ^
171 | Object {
172 | "issues": Array [
173 | Object {
at Object.<anonymous> (test/lib/integrations/zoderrrors.test.ts:170:52)

[jahands]

Hmm tests seem to be failing because the attachment doesn't match the issues being sent anymore. I wonder why 🤔

 FAIL test/lib/integrations/zoderrrors.test.ts
● applyZodErrorsToEvent() › should add all ZodError issues as attachment
expect(received).toMatchInlineSnapshot(snapshot)
Snapshot name: `applyZodErrorsToEvent() should add all ZodError issues as attachment 1`
- Snapshot - 8
+ Received + 0
@@ -6,15 +6,7 @@
"keys": "[\"extra\"]",
"message": "Invalid input: expected string, received number",
"path": "names.1",
"received": "number",
},
- Object {
- "code": "invalid_type",
- "expected": "string",
- "keys": "[\"extra2\"]",
- "message": "Invalid input: expected string, received number",
- "path": "foo.1",
- "received": "number",
- },
],
}
168 | }
169 | expect(attachment.filename).toBe('zod_issues.json');
> 170 | expect(JSON.parse(attachment.data.toString())).toMatchInlineSnapshot(`
| ^
171 | Object {
172 | "issues": Array [
173 | Object {
at Object.<anonymous> (test/lib/integrations/zoderrrors.test.ts:170:52)

Oh I see, we need to skip slicing the list of issues before flattening if save attachment is enabled so that the full list is included in the attachment. Will fix

[jahands]

@AbhiPrasad fixed that bug, tests pass for me locally now

[jahands]

• Include full key path rather than the top level key in title
• Improve message for validation issues with no path
• Add option to include extended issue information as an attachment

Background

I tried using this integration, but found the error format in Sentry to be lacking.
I added tests to demonstrate how this will format issues.

Screenshots

---

Before submitting a pull request, please take a look at our
Contributing guidelines and verify:

• If you've added code that should be tested, please add tests.
• Ensure your code lints and the test suite passes (yarn lint) & (yarn test).

[jahands]

Wasn't sure if adding deps was okay, but it made adding tests a lot easier

[AbhiPrasad]

This is fine for testing

[AbhiPrasad]

@jahands thanks for the PR! could you share a link to a sentry event / screenshot of a sentry event that shows the changes from this PR?

[jahands]

@AbhiPrasad done!

[AbhiPrasad]

Assigning myself so I can help review and merge this in! On my todo to review tomorrow morning :)

[AbhiPrasad]

This is fine for testing

[AbhiPrasad]

I'm not sure we want to duplicate entries here, I think [0].foo.[1].bar is more valuable than <array>.foo.<array>.bar, and we want to make sure that different array entries will lead to different issues.

What do you think?

[jahands]

This is only applied to the issue message, not event.extra or attachments which still include all unique issues with the full path including indexes.

In practice, we found that having the indexes in the message is more noise than helpful for understanding the issue at a glance, which was the primary motivation for me making this improvement in our internal fork.

[AbhiPrasad]

Sounds good to me, let's keep what is here then

[AbhiPrasad]

Hmm tests seem to be failing because the attachment doesn't match the issues being sent anymore. I wonder why 🤔

 FAIL test/lib/integrations/zoderrrors.test.ts
● applyZodErrorsToEvent() › should add all ZodError issues as attachment
expect(received).toMatchInlineSnapshot(snapshot)
Snapshot name: `applyZodErrorsToEvent() should add all ZodError issues as attachment 1`
- Snapshot - 8
+ Received + 0
@@ -6,15 +6,7 @@
"keys": "[\"extra\"]",
"message": "Invalid input: expected string, received number",
"path": "names.1",
"received": "number",
},
- Object {
- "code": "invalid_type",
- "expected": "string",
- "keys": "[\"extra2\"]",
- "message": "Invalid input: expected string, received number",
- "path": "foo.1",
- "received": "number",
- },
],
}
168 | }
169 | expect(attachment.filename).toBe('zod_issues.json');
> 170 | expect(JSON.parse(attachment.data.toString())).toMatchInlineSnapshot(`
| ^
171 | Object {
172 | "issues": Array [
173 | Object {
at Object.<anonymous> (test/lib/integrations/zoderrrors.test.ts:170:52)

[jahands]

Hmm tests seem to be failing because the attachment doesn't match the issues being sent anymore. I wonder why 🤔

 FAIL test/lib/integrations/zoderrrors.test.ts
● applyZodErrorsToEvent() › should add all ZodError issues as attachment
expect(received).toMatchInlineSnapshot(snapshot)
Snapshot name: `applyZodErrorsToEvent() should add all ZodError issues as attachment 1`
- Snapshot - 8
+ Received + 0
@@ -6,15 +6,7 @@
"keys": "[\"extra\"]",
"message": "Invalid input: expected string, received number",
"path": "names.1",
"received": "number",
},
- Object {
- "code": "invalid_type",
- "expected": "string",
- "keys": "[\"extra2\"]",
- "message": "Invalid input: expected string, received number",
- "path": "foo.1",
- "received": "number",
- },
],
}
168 | }
169 | expect(attachment.filename).toBe('zod_issues.json');
> 170 | expect(JSON.parse(attachment.data.toString())).toMatchInlineSnapshot(`
| ^
171 | Object {
172 | "issues": Array [
173 | Object {
at Object.<anonymous> (test/lib/integrations/zoderrrors.test.ts:170:52)

Oh I see, we need to skip slicing the list of issues before flattening if save attachment is enabled so that the full list is included in the attachment. Will fix

[jahands]

@AbhiPrasad fixed that bug, tests pass for me locally now

[jahands]

• Include full key path rather than the top level key in title
• Improve message for validation issues with no path
• Add option to include extended issue information as an attachment

Background

I tried using this integration, but found the error format in Sentry to be lacking.
I added tests to demonstrate how this will format issues.

Screenshots

---

Before submitting a pull request, please take a look at our
Contributing guidelines and verify:

• If you've added code that should be tested, please add tests.
• Ensure your code lints and the test suite passes (yarn lint) & (yarn test).

[jahands]

Wasn't sure if adding deps was okay, but it made adding tests a lot easier

[AbhiPrasad]

This is fine for testing

[AbhiPrasad]

@jahands thanks for the PR! could you share a link to a sentry event / screenshot of a sentry event that shows the changes from this PR?

[jahands]

@AbhiPrasad done!

[AbhiPrasad]

Assigning myself so I can help review and merge this in! On my todo to review tomorrow morning :)

[AbhiPrasad]

This is fine for testing

[AbhiPrasad]

I'm not sure we want to duplicate entries here, I think [0].foo.[1].bar is more valuable than <array>.foo.<array>.bar, and we want to make sure that different array entries will lead to different issues.

What do you think?

[jahands]

This is only applied to the issue message, not event.extra or attachments which still include all unique issues with the full path including indexes.

In practice, we found that having the indexes in the message is more noise than helpful for understanding the issue at a glance, which was the primary motivation for me making this improvement in our internal fork.

[AbhiPrasad]

Sounds good to me, let's keep what is here then

[AbhiPrasad]

Hmm tests seem to be failing because the attachment doesn't match the issues being sent anymore. I wonder why 🤔

 FAIL test/lib/integrations/zoderrrors.test.ts
● applyZodErrorsToEvent() › should add all ZodError issues as attachment
expect(received).toMatchInlineSnapshot(snapshot)
Snapshot name: `applyZodErrorsToEvent() should add all ZodError issues as attachment 1`
- Snapshot - 8
+ Received + 0
@@ -6,15 +6,7 @@
"keys": "[\"extra\"]",
"message": "Invalid input: expected string, received number",
"path": "names.1",
"received": "number",
},
- Object {
- "code": "invalid_type",
- "expected": "string",
- "keys": "[\"extra2\"]",
- "message": "Invalid input: expected string, received number",
- "path": "foo.1",
- "received": "number",
- },
],
}
168 | }
169 | expect(attachment.filename).toBe('zod_issues.json');
> 170 | expect(JSON.parse(attachment.data.toString())).toMatchInlineSnapshot(`
| ^
171 | Object {
172 | "issues": Array [
173 | Object {
at Object.<anonymous> (test/lib/integrations/zoderrrors.test.ts:170:52)

[jahands]

Hmm tests seem to be failing because the attachment doesn't match the issues being sent anymore. I wonder why 🤔

 FAIL test/lib/integrations/zoderrrors.test.ts
● applyZodErrorsToEvent() › should add all ZodError issues as attachment
expect(received).toMatchInlineSnapshot(snapshot)
Snapshot name: `applyZodErrorsToEvent() should add all ZodError issues as attachment 1`
- Snapshot - 8
+ Received + 0
@@ -6,15 +6,7 @@
"keys": "[\"extra\"]",
"message": "Invalid input: expected string, received number",
"path": "names.1",
"received": "number",
},
- Object {
- "code": "invalid_type",
- "expected": "string",
- "keys": "[\"extra2\"]",
- "message": "Invalid input: expected string, received number",
- "path": "foo.1",
- "received": "number",
- },
],
}
168 | }
169 | expect(attachment.filename).toBe('zod_issues.json');
> 170 | expect(JSON.parse(attachment.data.toString())).toMatchInlineSnapshot(`
| ^
171 | Object {
172 | "issues": Array [
173 | Object {
at Object.<anonymous> (test/lib/integrations/zoderrrors.test.ts:170:52)

Oh I see, we need to skip slicing the list of issues before flattening if save attachment is enabled so that the full list is included in the attachment. Will fix

[jahands]

@AbhiPrasad fixed that bug, tests pass for me locally now

[jahands]

• Include full key path rather than the top level key in title
• Improve message for validation issues with no path
• Add option to include extended issue information as an attachment

Background

I tried using this integration, but found the error format in Sentry to be lacking.
I added tests to demonstrate how this will format issues.

Screenshots

---

Before submitting a pull request, please take a look at our
Contributing guidelines and verify:

• If you've added code that should be tested, please add tests.
• Ensure your code lints and the test suite passes (yarn lint) & (yarn test).

[jahands]

Wasn't sure if adding deps was okay, but it made adding tests a lot easier

[AbhiPrasad]

This is fine for testing

[AbhiPrasad]

@jahands thanks for the PR! could you share a link to a sentry event / screenshot of a sentry event that shows the changes from this PR?

[jahands]

@AbhiPrasad done!

[AbhiPrasad]

Assigning myself so I can help review and merge this in! On my todo to review tomorrow morning :)

[AbhiPrasad]

This is fine for testing

[AbhiPrasad]

I'm not sure we want to duplicate entries here, I think [0].foo.[1].bar is more valuable than <array>.foo.<array>.bar, and we want to make sure that different array entries will lead to different issues.

What do you think?

[jahands]

This is only applied to the issue message, not event.extra or attachments which still include all unique issues with the full path including indexes.

In practice, we found that having the indexes in the message is more noise than helpful for understanding the issue at a glance, which was the primary motivation for me making this improvement in our internal fork.

[AbhiPrasad]

Sounds good to me, let's keep what is here then

[AbhiPrasad]

Hmm tests seem to be failing because the attachment doesn't match the issues being sent anymore. I wonder why 🤔

 FAIL test/lib/integrations/zoderrrors.test.ts
● applyZodErrorsToEvent() › should add all ZodError issues as attachment
expect(received).toMatchInlineSnapshot(snapshot)
Snapshot name: `applyZodErrorsToEvent() should add all ZodError issues as attachment 1`
- Snapshot - 8
+ Received + 0
@@ -6,15 +6,7 @@
"keys": "[\"extra\"]",
"message": "Invalid input: expected string, received number",
"path": "names.1",
"received": "number",
},
- Object {
- "code": "invalid_type",
- "expected": "string",
- "keys": "[\"extra2\"]",
- "message": "Invalid input: expected string, received number",
- "path": "foo.1",
- "received": "number",
- },
],
}
168 | }
169 | expect(attachment.filename).toBe('zod_issues.json');
> 170 | expect(JSON.parse(attachment.data.toString())).toMatchInlineSnapshot(`
| ^
171 | Object {
172 | "issues": Array [
173 | Object {
at Object.<anonymous> (test/lib/integrations/zoderrrors.test.ts:170:52)

[jahands]

Hmm tests seem to be failing because the attachment doesn't match the issues being sent anymore. I wonder why 🤔

 FAIL test/lib/integrations/zoderrrors.test.ts
● applyZodErrorsToEvent() › should add all ZodError issues as attachment
expect(received).toMatchInlineSnapshot(snapshot)
Snapshot name: `applyZodErrorsToEvent() should add all ZodError issues as attachment 1`
- Snapshot - 8
+ Received + 0
@@ -6,15 +6,7 @@
"keys": "[\"extra\"]",
"message": "Invalid input: expected string, received number",
"path": "names.1",
"received": "number",
},
- Object {
- "code": "invalid_type",
- "expected": "string",
- "keys": "[\"extra2\"]",
- "message": "Invalid input: expected string, received number",
- "path": "foo.1",
- "received": "number",
- },
],
}
168 | }
169 | expect(attachment.filename).toBe('zod_issues.json');
> 170 | expect(JSON.parse(attachment.data.toString())).toMatchInlineSnapshot(`
| ^
171 | Object {
172 | "issues": Array [
173 | Object {
at Object.<anonymous> (test/lib/integrations/zoderrrors.test.ts:170:52)

Oh I see, we need to skip slicing the list of issues before flattening if save attachment is enabled so that the full list is included in the attachment. Will fix

[jahands]

@AbhiPrasad fixed that bug, tests pass for me locally now