feat: UserWebhook/SystemWebhookのテスト送信機能を追加 #14489
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
packages/frontend
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## develop #14489 +/- ##
============================================
+ Coverage 19.72% 41.50% +21.77%
============================================
Files 714 1543 +829
Lines 100375 197423 +97048
Branches 996 2709 +1713
============================================
+ Hits 19802 81937 +62135
- Misses 80030 114924 +34894
- Partials 543 562 +19 ☔ View full report in Codecov by Sentry. |
|
このPRによるapi.jsonの差分 差分はこちら--- base
+++ head
@@ -16797,6 +16797,204 @@
}
}
},
+ "/admin/system-webhook/test": {
+ "post": {
+ "operationId": "admin___system-webhook___test",
+ "summary": "admin/system-webhook/test",
+ "description": "No description provided.\n\n**Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.\n**Credential required**: *Yes* / **Permission**: *read:admin:system-webhook*",
+ "externalDocs": {
+ "description": "Source code",
+ "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/system-webhook/test.ts"
+ },
+ "tags": [
+ "webhooks"
+ ],
+ "security": [
+ {
+ "bearerAuth": []
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "webhookId": {
+ "type": "string",
+ "format": "misskey:id"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "abuseReport",
+ "abuseReportResolved",
+ "userCreated"
+ ]
+ },
+ "override": {
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string"
+ },
+ "secret": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "required": [
+ "webhookId",
+ "type"
+ ]
+ }
+ }
+ }
+ },
+ "responses": {
+ "204": {
+ "description": "OK (without any results)"
+ },
+ "400": {
+ "description": "Client error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ },
+ "examples": {
+ "NO_SUCH_WEBHOOK": {
+ "value": {
+ "error": {
+ "message": "No such webhook.",
+ "code": "NO_SUCH_WEBHOOK",
+ "id": "0c52149c-e913-18f8-5dc7-74870bfe0cf9"
+ }
+ }
+ },
+ "INVALID_PARAM": {
+ "value": {
+ "error": {
+ "message": "Invalid param.",
+ "code": "INVALID_PARAM",
+ "id": "3d81ceae-475f-4600-b2a8-2bc116157532"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Authentication error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ },
+ "examples": {
+ "CREDENTIAL_REQUIRED": {
+ "value": {
+ "error": {
+ "message": "Credential required.",
+ "code": "CREDENTIAL_REQUIRED",
+ "id": "1384574d-a912-4b81-8601-c7b1c4085df1"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ },
+ "examples": {
+ "AUTHENTICATION_FAILED": {
+ "value": {
+ "error": {
+ "message": "Authentication failed. Please ensure your token is correct.",
+ "code": "AUTHENTICATION_FAILED",
+ "id": "b0a7f5f8-dc2f-4171-b91f-de88ad238e14"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "418": {
+ "description": "I'm Ai",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ },
+ "examples": {
+ "I_AM_AI": {
+ "value": {
+ "error": {
+ "message": "You sent a request to Ai-chan, Misskey's showgirl, instead of the server.",
+ "code": "I_AM_AI",
+ "id": "60c46cd1-f23a-46b1-bebe-5d2b73951a84"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "429": {
+ "description": "To many requests",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ },
+ "examples": {
+ "RATE_LIMIT_EXCEEDED": {
+ "value": {
+ "error": {
+ "message": "Rate limit exceeded. Please try again later.",
+ "code": "RATE_LIMIT_EXCEEDED",
+ "id": "d5826d14-3982-4d2e-8011-b9e9f02499ef"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal server error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ },
+ "examples": {
+ "INTERNAL_ERROR": {
+ "value": {
+ "error": {
+ "message": "Internal error occurred. Please contact us if the error persists.",
+ "code": "INTERNAL_ERROR",
+ "id": "5d37dbcb-891e-41ca-a3d6-e690c97775ac"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
"/announcements": {
"post": {
"operationId": "announcements",
@@ -51784,6 +51982,209 @@
}
}
}
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal server error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ },
+ "examples": {
+ "INTERNAL_ERROR": {
+ "value": {
+ "error": {
+ "message": "Internal error occurred. Please contact us if the error persists.",
+ "code": "INTERNAL_ERROR",
+ "id": "5d37dbcb-891e-41ca-a3d6-e690c97775ac"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/i/webhooks/test": {
+ "post": {
+ "operationId": "i___webhooks___test",
+ "summary": "i/webhooks/test",
+ "description": "No description provided.\n\n**Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.\n**Credential required**: *Yes* / **Permission**: *read:account*",
+ "externalDocs": {
+ "description": "Source code",
+ "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/i/webhooks/test.ts"
+ },
+ "tags": [
+ "webhooks"
+ ],
+ "security": [
+ {
+ "bearerAuth": []
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "webhookId": {
+ "type": "string",
+ "format": "misskey:id"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "mention",
+ "unfollow",
+ "follow",
+ "followed",
+ "note",
+ "reply",
+ "renote",
+ "reaction"
+ ]
+ },
+ "override": {
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string"
+ },
+ "secret": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "required": [
+ "webhookId",
+ "type"
+ ]
+ }
+ }
+ }
+ },
+ "responses": {
+ "204": {
+ "description": "OK (without any results)"
+ },
+ "400": {
+ "description": "Client error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ },
+ "examples": {
+ "NO_SUCH_WEBHOOK": {
+ "value": {
+ "error": {
+ "message": "No such webhook.",
+ "code": "NO_SUCH_WEBHOOK",
+ "id": "0c52149c-e913-18f8-5dc7-74870bfe0cf9"
+ }
+ }
+ },
+ "INVALID_PARAM": {
+ "value": {
+ "error": {
+ "message": "Invalid param.",
+ "code": "INVALID_PARAM",
+ "id": "3d81ceae-475f-4600-b2a8-2bc116157532"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Authentication error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ },
+ "examples": {
+ "CREDENTIAL_REQUIRED": {
+ "value": {
+ "error": {
+ "message": "Credential required.",
+ "code": "CREDENTIAL_REQUIRED",
+ "id": "1384574d-a912-4b81-8601-c7b1c4085df1"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ },
+ "examples": {
+ "AUTHENTICATION_FAILED": {
+ "value": {
+ "error": {
+ "message": "Authentication failed. Please ensure your token is correct.",
+ "code": "AUTHENTICATION_FAILED",
+ "id": "b0a7f5f8-dc2f-4171-b91f-de88ad238e14"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "418": {
+ "description": "I'm Ai",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ },
+ "examples": {
+ "I_AM_AI": {
+ "value": {
+ "error": {
+ "message": "You sent a request to Ai-chan, Misskey's showgirl, instead of the server.",
+ "code": "I_AM_AI",
+ "id": "60c46cd1-f23a-46b1-bebe-5d2b73951a84"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "429": {
+ "description": "To many requests",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ },
+ "examples": {
+ "RATE_LIMIT_EXCEEDED": {
+ "value": {
+ "error": {
+ "message": "Rate limit exceeded. Please try again later.",
+ "code": "RATE_LIMIT_EXCEEDED",
+ "id": "d5826d14-3982-4d2e-8011-b9e9f02499ef"
+ }
+ }
+ }
}
}
} |
samunohito
commented
Sep 2, 2024
Comment on lines
+21
to
+24
| limit: { | ||
| duration: ms('15min'), | ||
| max: 60, | ||
| }, |
There was a problem hiding this comment.
UIがボタンであるゆえに連打できてしまうので15分/60回までとしています。
| @@ -13,6 +13,7 @@ import { DI } from '@/di-symbols.js'; | |||
| import { RoleService } from '@/core/RoleService.js'; | |||
| import { ApiError } from '@/server/api/error.js'; | |||
|
|
|||
| // TODO: UserWebhook schemaの適用 | |||
There was a problem hiding this comment.
リファクタの余地があります。…が、このprではスコープ外なのでTODOコメントに留めています。
ここを含めて複数個所でmeta.res配下に直接UserWebhookのスキーマが記述されていますが、いずれも内容に差はないので単独のスキーマとした方がよいと考えます。
There was a problem hiding this comment.
UserWebhookServiceとSystemWebhookServiceはテストWebhookである旨を知らなくてもいいと思ったので、テスト系の処理をこのServiceに分離しています。
This comment was marked as resolved.
This comment was marked as resolved.
|
テスト送信時は設定をリクエストパラメータから上書き出来るようにする…？ |
|
Revertできる形にしつつ↑を試します（のでdraftに） |
これにしました。 |
|
/preview |
syuilo
reviewed
Sep 3, 2024
| * UserWebhook の一覧を取得する. | ||
| */ | ||
| @bindThis | ||
| public async fetchWebhooks(params?: { |
|
/preview |
1 similar comment
|
/preview |
|
misskey-jsのautogen生成するのどうするんだっけ |
|
autogenがない状態で pnpm build-misskey-js-with-types や pnpm build してもエラーになる |
|
TASUKETE |
これやればできるはずですが…いったいなにが |
|
ゔわー |
# Conflicts: # packages/misskey-js/src/autogen/endpoint.ts
|
@syuilo たぶんなおったはず |
|
今後同様のことが起こったらどう治せばいいかしら |
|
pnpm clean -> pnpm build-misskey-js-with-types -> pnpm build |
|
👍🏿 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What
UserWebhookとSystemWebhookにテスト送信機能が追加されます。
Why
fix #14445
Additional info (optional)
ローカルにWebサーバを立てて実際に送信確認
Checklist