-
Notifications
You must be signed in to change notification settings - Fork 13.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Embedded dashboard configuration (#19364)
* embedded dashboard model * embedded dashboard endpoints * DRY up using the with_dashboard decorator elsewhere * wip * check feature flags and permissions * wip * sdk * urls * dao option for id column * got it working * Update superset/embedded/view.py * use the curator check * put back old endpoint, for now * allow access by either embedded.uuid or dashboard.id * keep the old endpoint around, for the time being * openapi * lint * lint * lint * test stuff * lint, test * typo * Update superset-frontend/src/embedded/index.tsx * Update superset-frontend/src/embedded/index.tsx * fix tests * bump sdk (cherry picked from commit 8e29ec5)
- Loading branch information
Showing
33 changed files
with
1,015 additions
and
120 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
228 changes: 228 additions & 0 deletions
228
superset-frontend/src/dashboard/components/DashboardEmbedControls.tsx
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,228 @@ | ||
| /** | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
| import React, { useCallback, useEffect, useState } from 'react'; | ||
| import { makeApi, styled, SupersetApiError, t } from '@superset-ui/core'; | ||
| import { InfoTooltipWithTrigger } from '@superset-ui/chart-controls'; | ||
| import Modal from 'src/components/Modal'; | ||
| import Loading from 'src/components/Loading'; | ||
| import Button from 'src/components/Button'; | ||
| import { Input } from 'src/components/Input'; | ||
| import { useToasts } from 'src/components/MessageToasts/withToasts'; | ||
| import { FormItem } from 'src/components/Form'; | ||
| import { EmbeddedDashboard } from '../types'; | ||
|
|
||
| type Props = { | ||
| dashboardId: string; | ||
| show: boolean; | ||
| onHide: () => void; | ||
| }; | ||
|
|
||
| type EmbeddedApiPayload = { allowed_domains: string[] }; | ||
|
|
||
| const stringToList = (stringyList: string): string[] => | ||
| stringyList.split(/(?:\s|,)+/).filter(x => x); | ||
|
|
||
| const ButtonRow = styled.div` | ||
| display: flex; | ||
| flex-direction: row; | ||
| justify-content: flex-end; | ||
| `; | ||
|
|
||
| export const DashboardEmbedControls = ({ dashboardId, onHide }: Props) => { | ||
| const { addInfoToast, addDangerToast } = useToasts(); | ||
| const [ready, setReady] = useState(true); // whether we have initialized yet | ||
| const [loading, setLoading] = useState(false); // whether we are currently doing an async thing | ||
| const [embedded, setEmbedded] = useState<EmbeddedDashboard | null>(null); // the embedded dashboard config | ||
| const [allowedDomains, setAllowedDomains] = useState<string>(''); | ||
|
|
||
| const endpoint = `/api/v1/dashboard/${dashboardId}/embedded`; | ||
| // whether saveable changes have been made to the config | ||
| const isDirty = | ||
| !embedded || | ||
| stringToList(allowedDomains).join() !== embedded.allowed_domains.join(); | ||
|
|
||
| const enableEmbedded = useCallback(() => { | ||
| setLoading(true); | ||
| makeApi<EmbeddedApiPayload, { result: EmbeddedDashboard }>({ | ||
| method: 'POST', | ||
| endpoint, | ||
| })({ | ||
| allowed_domains: stringToList(allowedDomains), | ||
| }) | ||
| .then( | ||
| ({ result }) => { | ||
| setEmbedded(result); | ||
| setAllowedDomains(result.allowed_domains.join(', ')); | ||
| addInfoToast(t('Changes saved.')); | ||
| }, | ||
| err => { | ||
| console.error(err); | ||
| addDangerToast( | ||
| t( | ||
| t('Sorry, something went wrong. The changes could not be saved.'), | ||
| ), | ||
| ); | ||
| }, | ||
| ) | ||
| .finally(() => { | ||
| setLoading(false); | ||
| }); | ||
| }, [endpoint, allowedDomains]); | ||
|
|
||
| const disableEmbedded = useCallback(() => { | ||
| Modal.confirm({ | ||
| title: t('Disable embedding?'), | ||
| content: t('This will remove your current embed configuration.'), | ||
| okType: 'danger', | ||
| onOk: () => { | ||
| setLoading(true); | ||
| makeApi<{}>({ method: 'DELETE', endpoint })({}) | ||
| .then( | ||
| () => { | ||
| setEmbedded(null); | ||
| setAllowedDomains(''); | ||
| addInfoToast(t('Embedding deactivated.')); | ||
| onHide(); | ||
| }, | ||
| err => { | ||
| console.error(err); | ||
| addDangerToast( | ||
| t( | ||
| 'Sorry, something went wrong. Embedding could not be deactivated.', | ||
| ), | ||
| ); | ||
| }, | ||
| ) | ||
| .finally(() => { | ||
| setLoading(false); | ||
| }); | ||
| }, | ||
| }); | ||
| }, [endpoint]); | ||
|
|
||
| useEffect(() => { | ||
| setReady(false); | ||
| makeApi<{}, { result: EmbeddedDashboard }>({ | ||
| method: 'GET', | ||
| endpoint, | ||
| })({}) | ||
| .catch(err => { | ||
| if ((err as SupersetApiError).status === 404) { | ||
| // 404 just means the dashboard isn't currently embedded | ||
| return { result: null }; | ||
| } | ||
| throw err; | ||
| }) | ||
| .then(({ result }) => { | ||
| setReady(true); | ||
| setEmbedded(result); | ||
| setAllowedDomains(result ? result.allowed_domains.join(', ') : ''); | ||
| }); | ||
| }, [dashboardId]); | ||
|
|
||
| if (!ready) { | ||
| return <Loading />; | ||
| } | ||
|
|
||
| return ( | ||
| <> | ||
| <p> | ||
| {embedded ? ( | ||
| <> | ||
| {t( | ||
| 'This dashboard is ready to embed. In your application, pass the following id to the SDK:', | ||
| )} | ||
| <br /> | ||
| <code>{embedded.uuid}</code> | ||
| </> | ||
| ) : ( | ||
| t( | ||
| 'Configure this dashboard to embed it into an external web application.', | ||
| ) | ||
| )} | ||
| </p> | ||
| <p> | ||
| {t('For further instructions, consult the')}{' '} | ||
| <a | ||
| href="https://www.npmjs.com/package/@superset-ui/embedded-sdk" | ||
| target="_blank" | ||
| rel="noreferrer" | ||
| > | ||
| {t('Superset Embedded SDK documentation.')} | ||
| </a> | ||
| </p> | ||
| <h3>Settings</h3> | ||
| <FormItem> | ||
| <label htmlFor="allowed-domains"> | ||
| {t('Allowed Domains (comma separated)')}{' '} | ||
| <InfoTooltipWithTrigger | ||
| tooltip={t( | ||
| 'A list of domain names that can embed this dashboard. Leaving this field empty will allow embedding from any domain.', | ||
| )} | ||
| /> | ||
| </label> | ||
| <Input | ||
| name="allowed-domains" | ||
| value={allowedDomains} | ||
| placeholder="superset.example.com" | ||
| onChange={event => setAllowedDomains(event.target.value)} | ||
| /> | ||
| </FormItem> | ||
| <ButtonRow> | ||
| {embedded ? ( | ||
| <> | ||
| <Button | ||
| onClick={disableEmbedded} | ||
| buttonStyle="secondary" | ||
| loading={loading} | ||
| > | ||
| {t('Deactivate')} | ||
| </Button> | ||
| <Button | ||
| onClick={enableEmbedded} | ||
| buttonStyle="primary" | ||
| disabled={!isDirty} | ||
| loading={loading} | ||
| > | ||
| {t('Save changes')} | ||
| </Button> | ||
| </> | ||
| ) : ( | ||
| <Button | ||
| onClick={enableEmbedded} | ||
| buttonStyle="primary" | ||
| loading={loading} | ||
| > | ||
| {t('Enable embedding')} | ||
| </Button> | ||
| )} | ||
| </ButtonRow> | ||
| </> | ||
| ); | ||
| }; | ||
|
|
||
| export const DashboardEmbedModal = (props: Props) => { | ||
| const { show, onHide } = props; | ||
|
|
||
| return ( | ||
| <Modal show={show} onHide={onHide} title={t('Embed')} hideFooter> | ||
| <DashboardEmbedControls {...props} /> | ||
| </Modal> | ||
| ); | ||
| }; |
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
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
Oops, something went wrong.