feat: make webhooks and documents editable instead of delete-and-recreate
Both could only be created and deleted. For a webhook that is actively harmful: recreating it issues a new signing secret, so the receiver that verifies the X-ApiCore-Signature header against the old one starts rejecting every delivery without anyone changing it on purpose. Backend: - New PATCH /webhooks/:id behind a new webhooks:update permission, covering the target URL, the event selection and the active flag - the last of which had no way to be set after creation at all, so a misbehaving receiver could only be deleted. The signing secret is deliberately left alone and stays out of the audit log. - A changed webhook URL runs through the same assertPublicWebhookUrl SSRF check as a new one; without that the edit would have been a way around the guard create() applies. Covered by a test. - New PATCH /documents/:id behind a new documents:update permission, for re-linking a document filed against the wrong record and correcting its display name. Re-linking validates the new target with the existing assertEntityExists; the stored file is untouched. Frontend: - New webhook edit dialog. The event labels and the toggle helper moved out of the create dialog into lib/webhooks/labels.ts so both use one copy. - Documents can be renamed from the attachment card. Re-linking a document to a different record has no UI yet: it needs a two-step picker (colony, then inspection) that is not worth building unprompted. Co-Authored-By: Claude Opus 5 (1M context) <[email protected]>
This commit is contained in:
1 parent
42ceb33844
commit
9a147ee123
18 files changed
+604
-26
No files matched your search
@@ -1,5 +1,5 @@
|
||||
import * as crypto from 'node:crypto';
|
||||
import { NotFoundException } from '@nestjs/common';
|
||||
import { BadRequestException, NotFoundException } from '@nestjs/common';
|
||||
import { WebhooksService } from './webhooks.service';
|
||||
import { PrismaService } from '../prisma/prisma.service';
|
||||
import { AuditLogService } from '../audit/audit-log.service';
|
||||
@@ -11,6 +11,7 @@ describe('WebhooksService', () => {
|
||||
findMany: jest.Mock;
|
||||
findUnique: jest.Mock;
|
||||
create: jest.Mock;
|
||||
update: jest.Mock;
|
||||
delete: jest.Mock;
|
||||
};
|
||||
};
|
||||
@@ -23,6 +24,7 @@ describe('WebhooksService', () => {
|
||||
findMany: jest.fn().mockResolvedValue([]),
|
||||
findUnique: jest.fn(),
|
||||
create: jest.fn(),
|
||||
update: jest.fn(),
|
||||
delete: jest.fn(),
|
||||
},
|
||||
};
|
||||
@@ -117,4 +119,68 @@ describe('WebhooksService', () => {
|
||||
service.dispatch('colony.created', { id: 'colony-1' }),
|
||||
).resolves.toBeUndefined();
|
||||
});
|
||||
|
||||
describe('update', () => {
|
||||
const existing = {
|
||||
id: 'wh-1',
|
||||
url: 'https://203.0.113.10/hook',
|
||||
events: ['colony.created'],
|
||||
secret: 'a'.repeat(64),
|
||||
createdByUserId: 'user-1',
|
||||
};
|
||||
|
||||
it('applies the SSRF guard to a changed URL, so an edit is no way around it', async () => {
|
||||
prisma.webhookSubscription.findUnique.mockResolvedValue(existing);
|
||||
|
||||
await expect(
|
||||
service.update('wh-1', { url: 'http://localhost/hook' }, 'user-1'),
|
||||
).rejects.toBeInstanceOf(BadRequestException);
|
||||
expect(prisma.webhookSubscription.update).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it('keeps the signing secret so a working receiver does not break', async () => {
|
||||
prisma.webhookSubscription.findUnique.mockResolvedValue(existing);
|
||||
prisma.webhookSubscription.update.mockResolvedValue({
|
||||
...existing,
|
||||
events: ['colony.created', 'harvest.created'],
|
||||
});
|
||||
|
||||
await service.update(
|
||||
'wh-1',
|
||||
{ events: ['colony.created', 'harvest.created'] },
|
||||
'user-1',
|
||||
);
|
||||
|
||||
const [[updateArgs]] = prisma.webhookSubscription.update.mock.calls as [
|
||||
[{ data: Record<string, unknown> }],
|
||||
];
|
||||
expect(updateArgs.data).not.toHaveProperty('secret');
|
||||
});
|
||||
|
||||
it('keeps the secret out of the audit log', async () => {
|
||||
prisma.webhookSubscription.findUnique.mockResolvedValue(existing);
|
||||
prisma.webhookSubscription.update.mockResolvedValue(existing);
|
||||
|
||||
await service.update('wh-1', { events: ['colony.created'] }, 'user-1');
|
||||
|
||||
const [[auditArgs]] = auditLog.record.mock.calls as [
|
||||
[
|
||||
{
|
||||
beforeData: Record<string, unknown>;
|
||||
afterData: Record<string, unknown>;
|
||||
},
|
||||
],
|
||||
];
|
||||
expect(auditArgs.beforeData).not.toHaveProperty('secret');
|
||||
expect(auditArgs.afterData).not.toHaveProperty('secret');
|
||||
});
|
||||
|
||||
it('throws NotFoundException for an unknown subscription', async () => {
|
||||
prisma.webhookSubscription.findUnique.mockResolvedValue(null);
|
||||
|
||||
await expect(
|
||||
service.update('missing', { events: ['colony.created'] }, 'user-1'),
|
||||
).rejects.toBeInstanceOf(NotFoundException);
|
||||
});
|
||||
});
|
||||
});
|
||||
Reference in new issue
Block a user