-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Refactor webhook overview layout to master details page
Co-authored-by: Konstantin Schaper <konstantin.schaper@cloudogu.com>
- Loading branch information
Showing
21 changed files
with
1,116 additions
and
188 deletions.
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| - type: changed | ||
| description: BREAKING - Change webhooks layout to master details multi-page design |
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| /* | ||
| * MIT License | ||
| * | ||
| * Copyright (c) 2020-present Cloudogu GmbH and Contributors | ||
| * | ||
| * Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| * of this software and associated documentation files (the "Software"), to deal | ||
| * in the Software without restriction, including without limitation the rights | ||
| * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| * copies of the Software, and to permit persons to whom the Software is | ||
| * furnished to do so, subject to the following conditions: | ||
| * | ||
| * The above copyright notice and this permission notice shall be included in all | ||
| * copies or substantial portions of the Software. | ||
| * | ||
| * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| * SOFTWARE. | ||
| */ | ||
|
|
||
| import { Form } from "@scm-manager/ui-forms"; | ||
| import React, { FC, useMemo, useState } from "react"; | ||
| import { WebhookConfiguration } from "./extensionPoints"; | ||
| import { SelectField } from "@scm-manager/ui-forms"; | ||
| import { useHistory } from "react-router-dom"; | ||
| import { Subtitle } from "@scm-manager/ui-components"; | ||
| import { useTranslation } from "react-i18next"; | ||
|
|
||
| type Props = { | ||
| webhookMap: Record<string, WebhookConfiguration["type"]>; | ||
| typeOptions: any; | ||
| onCreate: (name: string, configuration: unknown) => Promise<unknown>; | ||
| baseRoute: string; | ||
| }; | ||
|
|
||
| const CreatePage: FC<Props> = ({ webhookMap, onCreate, typeOptions, baseRoute }) => { | ||
| const [t] = useTranslation("plugins"); | ||
| const [type, setType] = useState(""); | ||
| const extension = useMemo(() => webhookMap[type], [type, webhookMap]); | ||
| const history = useHistory(); | ||
|
|
||
| const options = useMemo(() => [{ label: "", value: "" }, ...typeOptions], [typeOptions]); | ||
|
|
||
| return ( | ||
| <> | ||
| <Subtitle>{t("scm-webhook-plugin.config.createSubtitle")}</Subtitle> | ||
| <SelectField label={t("scm-webhook-plugin.config.type.label")} value={type} onChange={event => setType(event.target.value)} options={options} /> | ||
| {type ? ( | ||
| <> | ||
| <hr /> | ||
| <Form | ||
| onSubmit={formValue => onCreate(type, formValue).then(() => history.push(baseRoute))} | ||
| defaultValues={extension.defaultConfiguration} | ||
| translationPath={["plugins", "scm-webhook-plugin.config.form.webhooks.configuration"]} | ||
| > | ||
| {({ watch }) => React.createElement(extension.FormComponent, { webhook: watch() })} | ||
| </Form> | ||
| </> | ||
| ) : null} | ||
| </> | ||
| ); | ||
| }; | ||
|
|
||
| export default CreatePage; |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| /* | ||
| * MIT License | ||
| * | ||
| * Copyright (c) 2020-present Cloudogu GmbH and Contributors | ||
| * | ||
| * Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| * of this software and associated documentation files (the "Software"), to deal | ||
| * in the Software without restriction, including without limitation the rights | ||
| * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| * copies of the Software, and to permit persons to whom the Software is | ||
| * furnished to do so, subject to the following conditions: | ||
| * | ||
| * The above copyright notice and this permission notice shall be included in all | ||
| * copies or substantial portions of the Software. | ||
| * | ||
| * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| * SOFTWARE. | ||
| */ | ||
|
|
||
| import { Form } from "@scm-manager/ui-forms"; | ||
| import React, { FC, useMemo } from "react"; | ||
| import { WebhookConfiguration } from "./extensionPoints"; | ||
| import { WebHookConfiguration } from "./types"; | ||
| import { useHistory, useParams } from "react-router-dom"; | ||
| import { Subtitle } from "@scm-manager/ui-components"; | ||
| import { useTranslation } from "react-i18next"; | ||
| import { Button } from "@scm-manager/ui-buttons"; | ||
|
|
||
| type Props = { | ||
| webhookMap: Record<string, WebhookConfiguration["type"]>; | ||
| webhooks: WebHookConfiguration[]; | ||
| onUpdate: (webhook: WebHookConfiguration) => Promise<unknown>; | ||
| onDelete: (webhook: WebHookConfiguration) => Promise<unknown>; | ||
| baseRoute: string; | ||
| }; | ||
|
|
||
| const EditPage: FC<Props> = ({ webhookMap, webhooks, onUpdate, onDelete, baseRoute }) => { | ||
| const [t] = useTranslation("plugins"); | ||
| const { id } = useParams<{ id: string }>(); | ||
| const webhook = useMemo(() => webhooks.find(wh => wh.id === id), [id, webhooks]); | ||
| const extension = useMemo(() => webhookMap[webhook.name], [webhook.name, webhookMap]); | ||
| const history = useHistory(); | ||
|
|
||
| return ( | ||
| <> | ||
| <Subtitle>{t("scm-webhook-plugin.config.editSubtitle", { name: webhook.name})}</Subtitle> | ||
| <Form | ||
| onSubmit={formValue => onUpdate({ ...webhook, configuration: formValue }).then(() => history.push(baseRoute))} | ||
| defaultValues={webhook.configuration} | ||
| translationPath={["plugins", "scm-webhook-plugin.config.form.webhooks.configuration"]} | ||
| > | ||
| {({ watch }) => React.createElement(extension.FormComponent, { webhook: watch() })} | ||
| </Form> | ||
| <hr/> | ||
| <div className="level-right"> | ||
| <Button variant="signal" onClick={() => onDelete(webhook).then(() => history.push(baseRoute))}> | ||
| {t("Delete webhook")} | ||
| </Button> | ||
| </div> | ||
| </> | ||
| ); | ||
| }; | ||
|
|
||
| export default EditPage; |
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,136 @@ | ||
| /* | ||
| * MIT License | ||
| * | ||
| * Copyright (c) 2020-present Cloudogu GmbH and Contributors | ||
| * | ||
| * Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| * of this software and associated documentation files (the "Software"), to deal | ||
| * in the Software without restriction, including without limitation the rights | ||
| * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| * copies of the Software, and to permit persons to whom the Software is | ||
| * furnished to do so, subject to the following conditions: | ||
| * | ||
| * The above copyright notice and this permission notice shall be included in all | ||
| * copies or substantial portions of the Software. | ||
| * | ||
| * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| * SOFTWARE. | ||
| */ | ||
|
|
||
| import React, { FC, useCallback, useMemo } from "react"; | ||
| import { Route, Switch } from "react-router-dom"; | ||
| import Overview from "./Overview"; | ||
| import CreatePage from "./CreatePage"; | ||
| import { useBinder } from "@scm-manager/ui-extensions"; | ||
| import { WebhookConfiguration } from "./extensionPoints"; | ||
| import { Repository } from "@scm-manager/ui-types"; | ||
| import { useTranslation } from "react-i18next"; | ||
| import { useConfigLink } from "@scm-manager/ui-api"; | ||
| import { WebHookConfiguration, WebHookConfigurations } from "./types"; | ||
| import { Loading, Subtitle, Title } from "@scm-manager/ui-components"; | ||
| import EditPage from "./EditPage"; | ||
|
|
||
| type Props = { | ||
| baseRoute: string; | ||
| link: string; | ||
| title?: string; | ||
| repository?: Repository; | ||
| }; | ||
|
|
||
| const MasterDetailsView: FC<Props> = ({ repository, link, title, baseRoute }) => { | ||
| const [t] = useTranslation("plugins"); | ||
| const binder = useBinder(); | ||
| const { initialConfiguration, isReadOnly, update, isLoading, isUpdating } = useConfigLink<WebHookConfigurations>( | ||
| link | ||
| ); | ||
| const allWebHooks = binder.getExtensions<WebhookConfiguration>("webhook.configuration"); | ||
| const create = useCallback( | ||
| (name: string, configuration: unknown) => { | ||
| const newWebhook = { | ||
| name, | ||
| configuration | ||
| } as WebHookConfiguration; | ||
| initialConfiguration.webhooks.push(newWebhook); | ||
| return update(initialConfiguration); | ||
| }, | ||
| [initialConfiguration, update] | ||
| ); | ||
|
|
||
| const updateWebhook = useCallback( | ||
| (webhook: WebHookConfiguration) => { | ||
| initialConfiguration.webhooks[initialConfiguration.webhooks.findIndex(wh => wh.id === webhook.id)] = webhook; | ||
| return update(initialConfiguration); | ||
| }, | ||
| [initialConfiguration, update] | ||
| ); | ||
|
|
||
| const deleteWebhook = useCallback( | ||
| (webhook: WebHookConfiguration) => { | ||
| initialConfiguration.webhooks.splice( | ||
| initialConfiguration.webhooks.findIndex(wh => wh.id === webhook.id), | ||
| 1 | ||
| ); | ||
| return update(initialConfiguration); | ||
| }, | ||
| [initialConfiguration, update] | ||
| ); | ||
|
|
||
| const webhookMap = useMemo<Record<string, WebhookConfiguration["type"]>>( | ||
| () => | ||
| allWebHooks.reduce((prev, cur) => { | ||
| prev[cur.name] = cur; | ||
| return prev; | ||
| }, {}), | ||
| [allWebHooks] | ||
| ); | ||
|
|
||
| const typeOptions = useMemo( | ||
| () => | ||
| (repository?._embedded?.supportedWebHookTypes.types ?? allWebHooks.map(({ name }) => name)).map(name => ({ | ||
| value: name, | ||
| label: t(`webhooks.${name}.name`) | ||
| })), | ||
| [allWebHooks, repository, t] | ||
| ); | ||
|
|
||
| if (isLoading || isUpdating) { | ||
| return <Loading />; | ||
| } | ||
|
|
||
| return ( | ||
| <> | ||
| {title ? <Title>{title}</Title> : null} | ||
| <Switch> | ||
| <Route path={`${baseRoute}/add`}> | ||
| <CreatePage webhookMap={webhookMap} typeOptions={typeOptions} onCreate={create} baseRoute={baseRoute} /> | ||
| </Route> | ||
| <Route path={`${baseRoute}/:id`}> | ||
| <EditPage | ||
| webhooks={initialConfiguration.webhooks} | ||
| webhookMap={webhookMap} | ||
| onUpdate={updateWebhook} | ||
| baseRoute={baseRoute} | ||
| onDelete={deleteWebhook} | ||
| /> | ||
| </Route> | ||
| <Route path={baseRoute} exact> | ||
| <Overview | ||
| repository={repository} | ||
| webhooks={initialConfiguration.webhooks} | ||
| webhookMap={webhookMap} | ||
| typeOptions={typeOptions} | ||
| isReadOnly={isReadOnly} | ||
| onDelete={deleteWebhook} | ||
| /> | ||
| </Route> | ||
| </Switch> | ||
| </> | ||
| ); | ||
| }; | ||
|
|
||
| export default MasterDetailsView; |
Oops, something went wrong.