Browse Source
* [feature/frontend] Add debug sections to settings panel * max-width * swaggerpull/2955/head
tobi
2 years ago
committed by
GitHub
15 changed files with 395 additions and 22 deletions
@ -0,0 +1,59 @@
|
||||
/* |
||||
GoToSocial |
||||
Copyright (C) GoToSocial Authors admin@gotosocial.org |
||||
SPDX-License-Identifier: AGPL-3.0-or-later |
||||
|
||||
This program is free software: you can redistribute it and/or modify |
||||
it under the terms of the GNU Affero General Public License as published by |
||||
the Free Software Foundation, either version 3 of the License, or |
||||
(at your option) any later version. |
||||
|
||||
This program is distributed in the hope that it will be useful, |
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of |
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
||||
GNU Affero General Public License for more details. |
||||
|
||||
You should have received a copy of the GNU Affero General Public License |
||||
along with this program. If not, see <http://www.gnu.org/licenses/>. |
||||
*/ |
||||
|
||||
import { ApURLResponse } from "../../../types/debug"; |
||||
import { gtsApi } from "../../gts-api"; |
||||
|
||||
const extended = gtsApi.injectEndpoints({ |
||||
endpoints: (build) => ({ |
||||
ApURL: build.query<ApURLResponse, string>({ |
||||
query: (url) => { |
||||
// Get the url in a SearchParam
|
||||
// so we can escape it.
|
||||
const urlParam = new URLSearchParams(); |
||||
urlParam.set("url", url); |
||||
|
||||
return { |
||||
url: `/api/v1/admin/debug/apurl?${urlParam.toString()}`, |
||||
}; |
||||
} |
||||
}), |
||||
ClearCaches: build.mutation<{}, void>({ |
||||
query: () => ({ |
||||
method: "POST", |
||||
url: `/api/v1/admin/debug/caches/clear` |
||||
}) |
||||
}), |
||||
}), |
||||
}); |
||||
|
||||
/** |
||||
* Lazy GET to /api/v1/admin/debug/apurl. |
||||
*/ |
||||
const useLazyApURLQuery = extended.useLazyApURLQuery; |
||||
|
||||
/** |
||||
* POST to /api/v1/admin/debug/caches/clear to empty in-memory caches. |
||||
*/ |
||||
const useClearCachesMutation = extended.useClearCachesMutation; |
||||
|
||||
export { |
||||
useLazyApURLQuery, |
||||
useClearCachesMutation, |
||||
}; |
||||
@ -0,0 +1,26 @@
|
||||
/* |
||||
GoToSocial |
||||
Copyright (C) GoToSocial Authors admin@gotosocial.org |
||||
SPDX-License-Identifier: AGPL-3.0-or-later |
||||
|
||||
This program is free software: you can redistribute it and/or modify |
||||
it under the terms of the GNU Affero General Public License as published by |
||||
the Free Software Foundation, either version 3 of the License, or |
||||
(at your option) any later version. |
||||
|
||||
This program is distributed in the hope that it will be useful, |
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of |
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
||||
GNU Affero General Public License for more details. |
||||
|
||||
You should have received a copy of the GNU Affero General Public License |
||||
along with this program. If not, see <http://www.gnu.org/licenses/>. |
||||
*/ |
||||
|
||||
export interface ApURLResponse { |
||||
request_url: string; |
||||
request_headers: string; |
||||
response_headers: string; |
||||
response_code: number; |
||||
response_body: string; |
||||
} |
||||
@ -0,0 +1,124 @@
|
||||
/* |
||||
GoToSocial |
||||
Copyright (C) GoToSocial Authors admin@gotosocial.org |
||||
SPDX-License-Identifier: AGPL-3.0-or-later |
||||
|
||||
This program is free software: you can redistribute it and/or modify |
||||
it under the terms of the GNU Affero General Public License as published by |
||||
the Free Software Foundation, either version 3 of the License, or |
||||
(at your option) any later version. |
||||
|
||||
This program is distributed in the hope that it will be useful, |
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of |
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
||||
GNU Affero General Public License for more details. |
||||
|
||||
You should have received a copy of the GNU Affero General Public License |
||||
along with this program. If not, see <http://www.gnu.org/licenses/>. |
||||
*/ |
||||
|
||||
import React, { useEffect, useRef } from "react"; |
||||
import { useTextInput } from "../../../../lib/form"; |
||||
import { useLazyApURLQuery } from "../../../../lib/query/admin/debug"; |
||||
import { TextInput } from "../../../../components/form/inputs"; |
||||
import MutationButton from "../../../../components/form/mutation-button"; |
||||
import { ApURLResponse } from "../../../../lib/types/debug"; |
||||
import Loading from "../../../../components/loading"; |
||||
|
||||
// Used for syntax highlighting of json result.
|
||||
import Prism from "../../../../../frontend/prism"; |
||||
|
||||
export default function ApURL() { |
||||
const urlField = useTextInput("url"); |
||||
|
||||
const [apURL, apURLResult] = useLazyApURLQuery(); |
||||
function submit(e) { |
||||
e.preventDefault(); |
||||
apURL(urlField.value ?? ""); |
||||
} |
||||
|
||||
return ( |
||||
<div className="admin-debug-apurl"> |
||||
<form onSubmit={submit}> |
||||
<div className="form-section-docs"> |
||||
<h2>AP URL</h2> |
||||
<p> |
||||
Call the provided URL with a signed request, and return the |
||||
raw ActivityPub response in the <code>response_body</code> field. |
||||
<br/> |
||||
Useful for debugging communication between instances, and |
||||
checking the shape of remote objects and actors. |
||||
</p> |
||||
</div> |
||||
<TextInput |
||||
field={urlField} |
||||
label="URL" |
||||
/> |
||||
<MutationButton |
||||
disabled={!urlField.value} |
||||
label="Send request" |
||||
result={apURLResult} |
||||
/> |
||||
</form> |
||||
<ApURLResult {...apURLResult} /> |
||||
</div> |
||||
); |
||||
} |
||||
|
||||
interface ApURLResultProps { |
||||
isLoading: boolean; |
||||
isFetching: boolean; |
||||
isSuccess: boolean; |
||||
data?: ApURLResponse, |
||||
isError: boolean; |
||||
} |
||||
|
||||
function ApURLResult({ |
||||
isLoading, |
||||
isFetching, |
||||
isSuccess, |
||||
data, |
||||
isError, |
||||
}: ApURLResultProps) {
|
||||
if (!(isSuccess || isError)) { |
||||
// Hasn't been called yet.
|
||||
return null; |
||||
} |
||||
|
||||
if (isLoading || isFetching) { |
||||
return <Loading />; |
||||
} |
||||
|
||||
if (!data) { |
||||
return "No data"; |
||||
} |
||||
|
||||
const jsonObj = { |
||||
...data, |
||||
response_body: data.response_body.length > 0 ? JSON.parse(data.response_body) : "", |
||||
}; |
||||
|
||||
const jsonStr = JSON.stringify(jsonObj, null, 2); |
||||
return <Highlighted jsonStr={jsonStr} />; |
||||
} |
||||
|
||||
function Highlighted({ jsonStr }: { jsonStr: string }) { |
||||
const ref = useRef<HTMLElement | null>(null); |
||||
useEffect(() => { |
||||
if (ref.current) { |
||||
Prism.highlightElement(ref.current); |
||||
} |
||||
}, []); |
||||
|
||||
// Prism takes control of the `pre` so wrap
|
||||
// the whole thing in a div that we control.
|
||||
return ( |
||||
<div className="prism-highlighted"> |
||||
<pre> |
||||
<code ref={ref} className="language-json"> |
||||
{jsonStr} |
||||
</code> |
||||
</pre> |
||||
</div> |
||||
); |
||||
} |
||||
@ -0,0 +1,52 @@
|
||||
/* |
||||
GoToSocial |
||||
Copyright (C) GoToSocial Authors admin@gotosocial.org |
||||
SPDX-License-Identifier: AGPL-3.0-or-later |
||||
|
||||
This program is free software: you can redistribute it and/or modify |
||||
it under the terms of the GNU Affero General Public License as published by |
||||
the Free Software Foundation, either version 3 of the License, or |
||||
(at your option) any later version. |
||||
|
||||
This program is distributed in the hope that it will be useful, |
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of |
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
||||
GNU Affero General Public License for more details. |
||||
|
||||
You should have received a copy of the GNU Affero General Public License |
||||
along with this program. If not, see <http://www.gnu.org/licenses/>. |
||||
*/ |
||||
|
||||
import React from "react"; |
||||
|
||||
import MutationButton from "../../../../components/form/mutation-button"; |
||||
import { useClearCachesMutation } from "../../../../lib/query/admin/debug"; |
||||
|
||||
export default function Caches({}) { |
||||
const [clearCaches, clearCachesResult] = useClearCachesMutation(); |
||||
function submit(e) { |
||||
e.preventDefault(); |
||||
clearCaches(); |
||||
} |
||||
|
||||
return ( |
||||
<div className="admin-debug-caches"> |
||||
<form onSubmit={submit}> |
||||
<div className="form-section-docs"> |
||||
<h2>Clear Caches</h2> |
||||
<p> |
||||
Clear internal in-memory caches |
||||
<br/> |
||||
This is useful for checking memory usage of caches, or for |
||||
clearing database cache results after manual database updates. |
||||
</p> |
||||
</div> |
||||
<MutationButton |
||||
disabled={false} |
||||
label="Clear caches" |
||||
result={clearCachesResult} |
||||
/> |
||||
</form> |
||||
</div> |
||||
); |
||||
} |
||||
Loading…
Reference in new issue