/** * 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 configureStore from 'redux-mock-store'; import thunk from 'redux-thunk'; import { render, screen, userEvent, waitFor, } from 'spec/helpers/testing-library'; import SaveQuery from 'src/SqlLab/components/SaveQuery'; import { initialState, databases } from 'src/SqlLab/fixtures'; const mockedProps = { queryEditorId: '123', animation: false, database: { ...databases.result[0], allows_virtual_table_explore: false }, onUpdate: () => {}, onSave: () => {}, saveQueryWarning: null, columns: [], }; const mockState = { ...initialState, sqlLab: { ...initialState.sqlLab, queryEditors: [ { id: mockedProps.queryEditorId, dbId: 1, catalog: null, schema: 'main', sql: 'SELECT * FROM t', }, ], }, }; const splitSaveBtnProps = { ...mockedProps, database: { ...mockedProps.database, allows_virtual_table_explore: true, }, }; const middlewares = [thunk]; const mockStore = configureStore(middlewares); // eslint-disable-next-line no-restricted-globals -- TODO: Migrate from describe blocks describe('SavedQuery', () => { test('doesnt render save button when allows_virtual_table_explore is undefined', async () => { const noRenderProps = { ...mockedProps, database: { ...mockedProps.database, allows_virtual_table_explore: undefined, }, }; render(, { useRedux: true, store: mockStore(mockState), }); expect(() => { screen.getByRole('button', { name: /save/i }); }).toThrow( 'Unable to find an accessible element with the role "button" and name `/save/i`', ); }); test('renders a non-split save button when allows_virtual_table_explore is not enabled', () => { render(, { useRedux: true, store: mockStore(mockState), }); const saveBtn = screen.getByRole('button', { name: /save/i }); expect(saveBtn).toBeVisible(); }); test('renders a save query modal when user clicks save button', () => { render(, { useRedux: true, store: mockStore(mockState), }); const saveBtn = screen.getByRole('button', { name: /save/i }); userEvent.click(saveBtn); const saveQueryModalHeader = screen.getByRole('heading', { name: /save query/i, }); expect(saveQueryModalHeader).toBeInTheDocument(); }); test('renders the save query modal UI', () => { render(, { useRedux: true, store: mockStore(mockState), }); const saveBtn = screen.getByRole('button', { name: /save/i }); userEvent.click(saveBtn); const closeBtn = screen.getByRole('button', { name: /close/i }); const saveQueryModalHeader = screen.getByRole('heading', { name: /save query/i, }); const nameLabel = screen.getByText(/name/i); const descriptionLabel = screen.getByText(/description/i); const textBoxes = screen.getAllByRole('textbox'); const nameTextbox = textBoxes[0]; const descriptionTextbox = textBoxes[1]; // There are now two save buttons, the initial save button and the modal save button const saveBtns = screen.getAllByRole('button', { name: /save/i }); const cancelBtn = screen.getByRole('button', { name: /cancel/i }); expect(closeBtn).toBeInTheDocument(); expect(saveQueryModalHeader).toBeInTheDocument(); expect(nameLabel).toBeInTheDocument(); expect(descriptionLabel).toBeInTheDocument(); expect(textBoxes.length).toBe(2); expect(nameTextbox).toBeInTheDocument(); expect(descriptionTextbox).toBeInTheDocument(); expect(saveBtns.length).toBe(2); expect(saveBtns[0]).toBeInTheDocument(); expect(saveBtns[1]).toBeInTheDocument(); expect(cancelBtn).toBeInTheDocument(); }); test('renders a "save as new" and "update" button if query already exists', () => { render(, { useRedux: true, store: mockStore({ ...mockState, sqlLab: { ...mockState.sqlLab, unsavedQueryEditor: { id: mockedProps.queryEditorId, remoteId: '42', }, }, }), }); const saveBtn = screen.getByRole('button', { name: /save/i }); userEvent.click(saveBtn); const saveAsNewBtn = screen.getByRole('button', { name: /save as new/i }); const updateBtn = screen.getByRole('button', { name: /update/i }); expect(saveAsNewBtn).toBeInTheDocument(); expect(updateBtn).toBeInTheDocument(); }); test('pre-fills the description from an existing saved query and updates with it unchanged', async () => { const storedDescription = 'This is the stored description'; const mockOnUpdate = jest.fn(); render(, { useRedux: true, store: mockStore({ ...mockState, sqlLab: { ...mockState.sqlLab, queryEditors: [ { id: mockedProps.queryEditorId, dbId: 1, catalog: null, schema: 'main', sql: 'SELECT * FROM t', name: 'My saved query', description: storedDescription, remoteId: 42, }, ], }, }), }); userEvent.click(screen.getByRole('button', { name: /save/i })); const descriptionTextbox = screen.getByRole('textbox', { name: 'Description', }); expect(descriptionTextbox).toHaveValue(storedDescription); userEvent.click(screen.getByRole('button', { name: /update/i })); await waitFor(() => expect(mockOnUpdate).toHaveBeenCalled()); expect(mockOnUpdate.mock.calls[0][0]).toEqual( expect.objectContaining({ description: storedDescription }), ); }); test('renders a split save button when allows_virtual_table_explore is enabled', async () => { render(, { useRedux: true, store: mockStore(mockState), }); await waitFor(() => { const saveBtn = screen.getByRole('button', { name: 'Save' }); const saveDataSetBtn = screen.getByRole('button', { name: /save dataset/i, }); expect(saveBtn).toBeVisible(); expect(saveDataSetBtn).toBeVisible(); }); }); test('renders a save dataset modal when user clicks "save dataset" menu item', async () => { render(, { useRedux: true, store: mockStore(mockState), }); const saveDatasetMenuItem = await screen.findByLabelText(/save dataset/i); userEvent.click(saveDatasetMenuItem); const saveDatasetHeader = screen.getByText(/save or overwrite dataset/i); expect(saveDatasetHeader).toBeInTheDocument(); }); test('renders the save dataset modal UI', async () => { render(, { useRedux: true, store: mockStore(mockState), }); const saveDatasetMenuItem = await screen.findByLabelText(/save dataset/i); userEvent.click(saveDatasetMenuItem); const closeBtn = screen.getByRole('button', { name: /close/i }); const saveDatasetHeader = screen.getByText(/save or overwrite dataset/i); const saveRadio = screen.getByRole('radio', { name: /save as new/i, }); const saveLabel = screen.getByText(/save as new/i); const saveTextbox = screen.getByRole('textbox'); const overwriteRadio = screen.getByRole('radio', { name: /overwrite existing/i, }); const overwriteLabel = screen.getByText(/overwrite existing/i); const overwriteCombobox = screen.getByRole('combobox'); const overwritePlaceholderText = screen.getByText( /select or type dataset name/i, ); expect(saveDatasetHeader).toBeInTheDocument(); expect(closeBtn).toBeInTheDocument(); expect(saveRadio).toBeInTheDocument(); expect(saveLabel).toBeInTheDocument(); expect(saveTextbox).toBeInTheDocument(); expect(overwriteRadio).toBeInTheDocument(); expect(overwriteLabel).toBeInTheDocument(); expect(overwriteCombobox).toBeInTheDocument(); expect(overwritePlaceholderText).toBeInTheDocument(); }); test('modal stays open while save is in progress and closes after completion', async () => { let resolveSave: () => void; const savePromise = new Promise(resolve => { resolveSave = resolve; }); const mockOnSave = jest.fn().mockImplementation(() => savePromise); render(, { useRedux: true, store: mockStore(mockState), }); // Open the modal const saveBtn = screen.getByRole('button', { name: /save/i }); userEvent.click(saveBtn); // Verify modal is open expect( screen.getByRole('heading', { name: /save query/i }), ).toBeInTheDocument(); // Click save button in the modal const modalSaveBtn = screen.getAllByRole('button', { name: /save/i })[1]; userEvent.click(modalSaveBtn); // Modal should still be open while save is in progress expect( screen.getByRole('heading', { name: /save query/i }), ).toBeInTheDocument(); // Resolve the save promise resolveSave!(); // Wait for modal to close after save completes await waitFor(() => { expect( screen.queryByRole('heading', { name: /save query/i }), ).not.toBeInTheDocument(); }); expect(mockOnSave).toHaveBeenCalledTimes(1); }); test('handles save with a new tab that has no changes', async () => { const mockOnSave = jest.fn().mockResolvedValue(undefined); // Mock state for a new tab with default SQL const newTabState = { ...mockState, sqlLab: { ...mockState.sqlLab, queryEditors: [ { id: mockedProps.queryEditorId, dbId: 1, catalog: null, schema: 'main', sql: 'SELECT ...', // Default SQL for new tabs name: undefined, description: undefined, }, ], }, }; render(, { useRedux: true, store: mockStore(newTabState), }); // Open the modal const saveBtn = screen.getByRole('button', { name: /save/i }); userEvent.click(saveBtn); // Modal should open expect( screen.getByRole('heading', { name: /save query/i }), ).toBeInTheDocument(); // The name field should have "Undefined" as default const nameInput = screen.getAllByRole('textbox')[0] as HTMLInputElement; expect(nameInput).toHaveValue('Undefined'); // Click save button const modalSaveBtn = screen.getAllByRole('button', { name: /save/i })[1]; userEvent.click(modalSaveBtn); // Wait for save to complete and modal to close await waitFor(() => { expect(mockOnSave).toHaveBeenCalled(); }); await waitFor(() => { expect( screen.queryByRole('heading', { name: /save query/i }), ).not.toBeInTheDocument(); }); }); test('disables the save button when the query name is empty or whitespace-only', async () => { render(, { useRedux: true, store: mockStore(mockState), }); userEvent.click(screen.getByRole('button', { name: /save/i })); const nameInput = screen.getAllByRole('textbox')[0] as HTMLInputElement; const modalSaveBtn = () => screen.getAllByRole('button', { name: /save/i })[1]; // Default label is present, so the save button starts enabled expect(modalSaveBtn()).toBeEnabled(); // Clearing the name disables the save button userEvent.clear(nameInput); await waitFor(() => expect(modalSaveBtn()).toBeDisabled()); // A whitespace-only name keeps the save button disabled userEvent.type(nameInput, ' '); await waitFor(() => expect(modalSaveBtn()).toBeDisabled()); // A non-empty name re-enables the save button userEvent.type(nameInput, 'My query'); await waitFor(() => expect(modalSaveBtn()).toBeEnabled()); }); });