sadpandajoe commented on code in PR #45090: URL: https://github.com/apache/superset/pull/45090#discussion_r4270186744
########## superset-frontend/src/features/canvas/DraftBanner.test.tsx: ########## @@ -0,0 +1,154 @@ +/** + * 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 fetchMock from 'fetch-mock'; +import { + fireEvent, + render, + screen, + waitFor, +} from 'spec/helpers/testing-library'; +import DraftBanner from './DraftBanner'; + +const commitEndpoint = 'glob:*/api/v1/canvas/draft/commit'; + +beforeEach(() => { + fetchMock.removeRoutes(); + fetchMock.clearHistory(); +}); + +const renderBanner = (saving = false, onClose = jest.fn()) => { + render( + <DraftBanner + token="tok-123" + revision={4} + onClose={onClose} + saving={saving} + />, + { useRedux: true }, + ); + return onClose; +}; + +const publishButton = () => screen.getByRole('button', { name: /Publish/ }); + +test('publishing commits the draft at the revision it was given', async () => { + fetchMock.post(commitEndpoint, { result: { revision: 5 } }); + const onClose = renderBanner(); + + fireEvent.click(publishButton()); + + await waitFor(() => expect(fetchMock.callHistory.calls()).toHaveLength(1)); + const [call] = fetchMock.callHistory.calls(); + expect(JSON.parse(call.options.body as string)).toEqual({ revision: 4 }); + expect( + (call.options.headers as Record<string, string>)['x-canvas-draft'], + ).toBe('tok-123'); + await waitFor(() => expect(onClose).toHaveBeenCalled()); +}); + +test('publishing is held while a layout change is still saving', () => { + fetchMock.post(commitEndpoint, { result: { revision: 5 } }); + renderBanner(true); + + expect(publishButton()).toBeDisabled(); + + fireEvent.click(publishButton()); + + // Committing now would publish the revision before that change landed and + // then delete the draft, losing it. + expect(fetchMock.callHistory.calls()).toHaveLength(0); +}); + +test('discarding deletes the draft', async () => { Review Comment: This test still passes if the DELETE is never sent. `run` calls `onClose` after any resolved action, so replacing the `SupersetClient.delete` call with `Promise.resolve()` leaves `onClose` firing and the only assertion green. Could it also assert that `fetchMock` saw exactly one DELETE to `/api/v1/canvas/draft` carrying the `tok-123` draft header? ########## superset-frontend/src/features/canvas/CanvasGridSurface.tsx: ########## @@ -0,0 +1,492 @@ +/** + * 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. + */ + +/** + * @fileoverview One grid of a canvas, with drag and resize built in. + * + * There is no edit mode: a user who may edit gets a drag grip and a resize + * corner on each widget, on the canvas as they view it. A user who may not + * gets the same grid with no handles. Dragging never covers the widget's own + * surface, so a filter or chart underneath stays clickable. + * + * While a gesture is live the widget follows the pointer and a dashed outline + * marks the cells it would take; releasing persists exactly those cells. + */ + +import { + PointerEvent as ReactPointerEvent, + KeyboardEvent as ReactKeyboardEvent, + ReactNode, + useCallback, + useEffect, + useRef, + useState, +} from 'react'; +import { css, styled } from '@apache-superset/core/theme'; +import { t } from '@apache-superset/core/translation'; +import { Icons } from '@superset-ui/core/components'; +import { + GridMetrics, + gridDelta, + movedPlacement, + NO_DELTA, + overlappedSiblings, + resizedPlacement, + samePlacement, +} from './gridGeometry'; +import type { GridPlacement, SpanConstraints } from './types'; + +type GestureKind = 'move' | 'resize'; + +interface Gesture { + nodeId: string; + kind: GestureKind; + pointerId: number; + startX: number; + startY: number; + dx: number; + dy: number; + /** + * Where the widget sat when it was grabbed. The gesture resolves against + * this, not against the current placement: a write landing mid-gesture (a + * sibling's drop pushing this one down, or a draft poll) would otherwise + * move the ground under the pointer and persist the drop relative to a row + * the user never aimed at. + */ + origin: GridPlacement; +} + +const Grid = styled.div<GridMetrics>` + display: grid; + grid-template-columns: repeat(${({ columns }) => columns}, minmax(0, 1fr)); + grid-auto-rows: ${({ rowUnit }) => rowUnit}px; + gap: ${({ gap }) => gap}px; +`; + +const GridItem = styled.div<{ + placement?: GridPlacement; + dragging?: boolean; + offset?: { x: number; y: number }; +}>` + ${({ placement, dragging, offset }) => css` + min-width: 0; + min-height: 0; + position: relative; + ${ + placement && + css` + grid-column: ${placement.col} / span ${placement.colSpan}; + grid-row: ${placement.row} / span ${placement.rowSpan}; + ` + } + ${ + dragging && + offset && + css` + /* Follow the pointer without reflowing the grid under it. */ + transform: translate(${offset.x}px, ${offset.y}px); + z-index: 2; + opacity: 0.85; + ` + } + `} +`; + +/** + * Where the widget being dragged would land. Turns red once it covers a + * sibling, so the user sees an overlap before releasing rather than being + * surprised when the server pushes a widget down to resolve it. + */ +const DropPreview = styled.div<{ + placement: GridPlacement; + colliding?: boolean; +}>` + ${({ theme, placement, colliding }) => css` + grid-column: ${placement.col} / span ${placement.colSpan}; + grid-row: ${placement.row} / span ${placement.rowSpan}; + border: 2px dashed ${colliding ? theme.colorError : theme.colorPrimary}; + border-radius: ${theme.borderRadius}px; + background: ${colliding ? theme.colorErrorBg : theme.colorPrimaryBg}; + pointer-events: none; + z-index: 1; + `} +`; + +/** + * Wraps a widget so its handles can sit on top of it. The handles stay hidden + * until the pointer is over the widget or a handle has focus, so a canvas at + * rest looks the same whether or not the user may edit it. + */ +const Interactive = styled.div` + ${({ theme }) => css` + height: 100%; + position: relative; + + /* Direct children only: hovering a container must not reveal the + handles of every widget nested inside it. */ + & > .canvas-handle { + opacity: 0; + transition: opacity ${theme.motionDurationMid}; + } + + &:hover > .canvas-handle, + & > .canvas-handle:focus-visible { + opacity: 1; + } + `} +`; + +const Grip = styled.button` + ${({ theme }) => css` + position: absolute; + top: ${theme.sizeUnit}px; + /* + * Clear of a widget's own controls, which sit at the top right corner and + * are 8 units wide (see WithQuery's .canvas-widget-controls): the grip is + * above them in the stack, so overlapping would swallow clicks meant for + * the menu. + */ + right: ${theme.sizeUnit * 9}px; + z-index: 3; + display: flex; + align-items: center; + justify-content: center; + padding: ${theme.sizeUnit / 2}px; + border: 1px solid ${theme.colorBorder}; + border-radius: ${theme.borderRadiusSM}px; + background: ${theme.colorBgElevated}; + color: ${theme.colorTextSecondary}; + cursor: grab; + touch-action: none; + + &:active { + cursor: grabbing; + } + `} +`; + +const ResizeCorner = styled.button` + ${({ theme }) => css` + position: absolute; + right: 0; + bottom: 0; + z-index: 3; + width: ${theme.sizeUnit * 4}px; + height: ${theme.sizeUnit * 4}px; + padding: 0; + border: none; + background: transparent; + cursor: nwse-resize; + touch-action: none; + + /* A two-line corner, the conventional resize affordance. */ + &::after { + content: ''; + position: absolute; + right: ${theme.sizeUnit / 2}px; + bottom: ${theme.sizeUnit / 2}px; + width: ${theme.sizeUnit * 2}px; + height: ${theme.sizeUnit * 2}px; + border-right: 2px solid ${theme.colorTextTertiary}; + border-bottom: 2px solid ${theme.colorTextTertiary}; + } + `} +`; + +/** The grid's content width, kept current as the viewport changes. */ +function useElementWidth(): [(element: HTMLDivElement | null) => void, number] { + const [element, setElement] = useState<HTMLDivElement | null>(null); + const [width, setWidth] = useState(0); + + useEffect(() => { + if (!element) return undefined; + const measure = () => setWidth(element.clientWidth); + measure(); + if (typeof ResizeObserver === 'undefined') return undefined; + const observer = new ResizeObserver(measure); + observer.observe(element); + return () => observer.disconnect(); + }, [element]); + + return [setElement, width]; +} + +export interface CanvasGridSurfaceProps { + childIds: string[]; + columns: number; + gap: number; + rowUnit: number; + placements: Record<string, GridPlacement>; + constraints: Record<string, SpanConstraints>; + /** Whether the user may drag and resize these widgets. */ + editable: boolean; + onPlace: (nodeId: string, placement: GridPlacement) => void; + renderNode: (nodeId: string) => ReactNode; +} + +export default function CanvasGridSurface({ + childIds, + columns, + gap, + rowUnit, + placements, + constraints, + editable, + onPlace, + renderNode, +}: CanvasGridSurfaceProps) { + const [gridRef, width] = useElementWidth(); + const [gesture, setGesture] = useState<Gesture>(); + // The handlers read the gesture directly, so committing never runs as a + // side effect inside a state updater. + const live = useRef<Gesture>(); + + const update = useCallback((next: Gesture | undefined) => { + live.current = next; + setGesture(next); + }, []); + + /** Where `from` would land given a pointer delta, in whole grid units. */ + const targetOf = useCallback( + ( + nodeId: string, + kind: GestureKind, + from: GridPlacement, + dx: number, + dy: number, + ) => { + const metrics: GridMetrics = { columns, gap, rowUnit }; + const delta = width > 0 ? gridDelta(dx, dy, width, metrics) : NO_DELTA; + return kind === 'move' + ? movedPlacement(from, delta, columns) + : resizedPlacement(from, delta, columns, constraints[nodeId]); + }, + [width, columns, gap, rowUnit, constraints], + ); + + const commit = useCallback( + (nodeId: string, next: GridPlacement | undefined) => { + const placement = placements[nodeId]; + if (next && placement && !samePlacement(next, placement)) { Review Comment: A plain click on a handle can silently revert someone else's edit. `commit` compares the gesture's result with the *current* placement, but with no pointer movement the result is just `origin` (the placement captured at pointer-down). If a draft poll or an agent's resize lands for that widget while the button is held, `origin` no longer equals `placements[nodeId]`, so release calls `onPlace(nodeId, origin)` at the latest revision and writes the old geometry back over the newer one. Should the no-op check also compare `next` against the gesture's `origin`, so a release that moved nothing never sends a place op? ########## superset-frontend/src/features/canvas/CanvasGrid.test.tsx: ########## @@ -190,3 +208,27 @@ test('setting a cross-filter does nothing while cross-filters are off', () => { expect(onValueChange).not.toHaveBeenCalled(); }); + +test('a canvas that is not editable gets no drag or resize handles', () => { + renderGrid(); + + expect( + screen.queryByRole('button', { name: 'Move widget' }), + ).not.toBeInTheDocument(); + expect( + screen.queryByRole('button', { name: 'Resize widget' }), + ).not.toBeInTheDocument(); +}); + +test('an editable canvas gets a handle per placed widget', () => { Review Comment: This only counts handles, so nested-grid wiring is untested: `renderGrid` could pass the root `columns` instead of `gridColumnCount` to the nested surface and every assertion here (and in `CanvasGridSurface.test.tsx`, which only uses 24 columns) would stay green. Could a test at the `CanvasGrid` boundary resize the child of a 12-column group past the group's width and assert `place` receives a span clamped to 12, not 24? -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
