Mirroristas/CommunitySolidServer
2
0
Fork 0
mirror of https://github.com/CommunitySolidServer/CommunitySolidServer.git synced 2024-10-03 14:55:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

refactor: Rename WebHook to Webhook

Browse Source
This commit is contained in:
Joachim Van Herwegen
2023-10-05 16:19:43 +02:00
parent 1e3684bcf3
commit 531c299c7b
16 changed files with 77 additions and 73 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
src/server/notifications/WebHookChannel2023/WebhookChannel2023Type.ts → src/server/notifications/WebhookChannel2023/WebhookChannel2023Type.ts
View File

@@ -8,11 +8,11 @@ import type { NotificationChannel } from '../NotificationChannel';
import type { StateHandler } from '../StateHandler';
/**
* A {@link NotificationChannel} containing the necessary fields for a WebHookChannel2023 channel.
* A {@link NotificationChannel} containing the necessary fields for a WebhookChannel2023 channel.
*/
export interface WebhookChannel2023 extends NotificationChannel {
/**
* The "WebHookChannel2023" type.
* The "WebhookChannel2023" type.
*/
type: typeof NOTIFY.WebhookChannel2023;
/**
@@ -21,12 +21,12 @@ export interface WebhookChannel2023 extends NotificationChannel {
sendTo: string;
}
export function isWebHook2023Channel(channel: NotificationChannel): channel is WebhookChannel2023 {
export function isWebhook2023Channel(channel: NotificationChannel): channel is WebhookChannel2023 {
return channel.type === NOTIFY.WebhookChannel2023;
}
/**
* The notification channel type WebHookChannel2023 as described in
* The notification channel type WebhookChannel2023 as described in
* https://solid.github.io/notifications/webhook-channel-2023
*
* Requires read permissions on a resource to be able to receive notifications.

20
src/server/notifications/WebHookChannel2023/WebHookEmitter.ts → src/server/notifications/WebhookChannel2023/WebhookEmitter.ts
View File

@@ -10,10 +10,10 @@ import { readableToString } from '../../../util/StreamUtil';
import type { NotificationEmitterInput } from '../NotificationEmitter';
import { NotificationEmitter } from '../NotificationEmitter';
import type { WebhookChannel2023 } from './WebhookChannel2023Type';
import { isWebHook2023Channel } from './WebhookChannel2023Type';
import { isWebhook2023Channel } from './WebhookChannel2023Type';
/**
* Emits a notification representation using the WebHookChannel2023 specification.
* Emits a notification representation using the WebhookChannel2023 specification.
*
* At the time of writing it is not specified how exactly a notification sender should make its requests verifiable,
* so for now we use a token similar to those from Solid-OIDC, signed by the server itself.
@@ -23,7 +23,7 @@ import { isWebHook2023Channel } from './WebhookChannel2023Type';
* The `expiration` input parameter is how long the generated token should be valid in minutes.
* Default is 20.
*/
export class WebHookEmitter extends NotificationEmitter {
export class WebhookEmitter extends NotificationEmitter {
protected readonly logger = getLoggerFor(this);
private readonly issuer: string;
@@ -40,15 +40,15 @@ export class WebHookEmitter extends NotificationEmitter {
}
public async canHandle({ channel }: NotificationEmitterInput): Promise<void> {
if (!isWebHook2023Channel(channel)) {
throw new NotImplementedHttpError(`${channel.id} is not a WebHookChannel2023 channel.`);
if (!isWebhook2023Channel(channel)) {
throw new NotImplementedHttpError(`${channel.id} is not a WebhookChannel2023 channel.`);
}
}
public async handle({ channel, representation }: NotificationEmitterInput): Promise<void> {
// Cast was checked in `canHandle`
const webHookChannel = channel as WebhookChannel2023;
this.logger.debug(`Emitting WebHook notification with target ${webHookChannel.sendTo}`);
const webhookChannel = channel as WebhookChannel2023;
this.logger.debug(`Emitting Webhook notification with target ${webhookChannel.sendTo}`);
const privateKey = await this.jwkGenerator.getPrivateKey();
const publicKey = await this.jwkGenerator.getPublicKey();
@@ -78,14 +78,14 @@ export class WebHookEmitter extends NotificationEmitter {
// https://datatracker.ietf.org/doc/html/draft-ietf-oauth-dpop#section-4.2
const dpopProof = await new SignJWT({
htu: webHookChannel.sendTo,
htu: webhookChannel.sendTo,
htm: 'POST',
}).setProtectedHeader({ alg: privateKey.alg, jwk: publicKey, typ: 'dpop+jwt' })
.setIssuedAt(time)
.setJti(v4())
.sign(privateKeyObject);
const response = await fetch(webHookChannel.sendTo, {
const response = await fetch(webhookChannel.sendTo, {
method: 'POST',
headers: {
'content-type': representation.metadata.contentType!,
@@ -95,7 +95,7 @@ export class WebHookEmitter extends NotificationEmitter {
body: await readableToString(representation.data),
});
if (response.status >= 400) {
this.logger.error(`There was an issue emitting a WebHook notification with target ${webHookChannel.sendTo}: ${
this.logger.error(`There was an issue emitting a Webhook notification with target ${webhookChannel.sendTo}: ${
await response.text()}`);
}
}

6
src/server/notifications/WebHookChannel2023/WebHookWebId.ts → src/server/notifications/WebhookChannel2023/WebhookWebId.ts
View File

@@ -9,11 +9,11 @@ import type { OperationHttpHandlerInput } from '../../OperationHttpHandler';
import { OperationHttpHandler } from '../../OperationHttpHandler';
/**
* Generates a fixed WebID that we use to identify the server for notifications sent using a WebHookChannel2023.
* This is used in tandem with the tokens generated by the {@link WebHookEmitter}.
* Generates a fixed WebID that we use to identify the server for notifications sent using a WebhookChannel2023.
* This is used in tandem with the tokens generated by the {@link WebhookEmitter}.
* This is a minimal WebID with only the `solid:oidcIssuer` triple.
*/
export class WebHookWebId extends OperationHttpHandler {
export class WebhookWebId extends OperationHttpHandler {
private readonly turtle: string;
public constructor(baseUrl: string) {