frontend/lib/src/components/elements/ExceptionElement/ExceptionElement.test.tsx - develop - vshmidt/streamlit

frontend/lib/src/components/elements/ExceptionElement/ExceptionElement.test.tsx
132 строки5 KB
Burak
Add "client.showErrorLinks` config option (#11238)" (#13472)
28 янв 2026, 21:24
28 янв 2026, 21:24da62861
/**
 * Copyright (c) Streamlit Inc. (2018-2022) Snowflake Inc. (2022-2026)
 *
 * Licensed 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 { screen } from "@testing-library/react"
import { MockInstance } from "vitest"

import { Config, Exception as ExceptionProto } from "@streamlit/protobuf"

import { render, renderWithContexts } from "~lib/test_util"

import ExceptionElement, { ExceptionElementProps } from "./ExceptionElement"

const getProps = (
  elementProps: Partial<ExceptionProto> = {}
): ExceptionElementProps => ({
  element: ExceptionProto.create({
    stackTrace: ["step 1", "step 2", "step 3"],
    type: "RuntimeError",
    message: "This is an exception of type RuntimeError",
    messageIsMarkdown: false,
    ...elementProps,
  }),
})

describe("ExceptionElement Element", () => {
  it("renders without crashing", () => {
    render(<ExceptionElement {...getProps()} />)

    const exceptionContainer = screen.getByTestId("stException")
    expect(exceptionContainer).toBeInTheDocument()
    expect(exceptionContainer).toHaveClass("stException")
  })

  it("should render the complete stack", () => {
    render(<ExceptionElement {...getProps()} />)

    expect(screen.getByText("Traceback:")).toBeInTheDocument()

    const traceRows = screen.getAllByTestId("stExceptionTraceRow")
    traceRows.forEach((row, index) => {
      expect(row).toHaveTextContent(`step ${index + 1}`)
    })
  })

  it("should render only the message when type and stack are empty", () => {
    render(<ExceptionElement {...getProps({ type: "", stackTrace: [] })} />)

    expect(screen.queryByText("RuntimeError")).not.toBeInTheDocument()
    expect(screen.queryByText("Traceback:")).not.toBeInTheDocument()

    expect(
      screen.getByText("This is an exception of type RuntimeError")
    ).toBeInTheDocument()
  })

  it("should render markdown when it has messageIsMarkdown", () => {
    render(<ExceptionElement {...getProps({ messageIsMarkdown: true })} />)

    expect(screen.getByTestId("stMarkdownContainer")).toBeInTheDocument()
  })

  it("should render if there's no message", () => {
    render(<ExceptionElement {...getProps({ message: "" })} />)

    expect(screen.getByText("RuntimeError")).toBeInTheDocument()
  })

  describe("Exception links visibility", () => {
    let originalLocation: Location
    let windowSpy: MockInstance

    beforeEach(() => {
      originalLocation = window.location
      windowSpy = vi.spyOn(window, "location", "get")
    })

    afterEach(() => {
      windowSpy.mockRestore()
    })

    it.each([
      ["localhost", undefined],
      ["localhost", Config.ShowErrorLinks.SHOW_ERROR_LINKS_AUTO],
      ["localhost", Config.ShowErrorLinks.SHOW_ERROR_LINKS_TRUE],
      ["foo.com", Config.ShowErrorLinks.SHOW_ERROR_LINKS_TRUE],
    ])("shows links: hostname=%s, config=%s", (hostname, showErrorLinks) => {
      windowSpy.mockReturnValue({ ...originalLocation, hostname })
      if (showErrorLinks === undefined) {
        render(<ExceptionElement {...getProps()} />)
      } else {
        renderWithContexts(<ExceptionElement {...getProps()} />, {
          libConfigContext: { showErrorLinks },
        })
      }
      expect(screen.getByText("Copy")).toBeInTheDocument()
      expect(screen.getByText("Ask Google")).toBeInTheDocument()
      expect(screen.getByText("Ask ChatGPT")).toBeInTheDocument()
    })

    it.each([
      ["foo.com", undefined],
      ["foo.com", Config.ShowErrorLinks.SHOW_ERROR_LINKS_AUTO],
      ["localhost", Config.ShowErrorLinks.SHOW_ERROR_LINKS_FALSE],
      ["foo.com", Config.ShowErrorLinks.SHOW_ERROR_LINKS_FALSE],
    ])("hides links: hostname=%s, config=%s", (hostname, showErrorLinks) => {
      windowSpy.mockReturnValue({ ...originalLocation, hostname })
      if (showErrorLinks === undefined) {
        render(<ExceptionElement {...getProps()} />)
      } else {
        renderWithContexts(<ExceptionElement {...getProps()} />, {
          libConfigContext: { showErrorLinks },
        })
      }
      expect(screen.queryByText("Copy")).not.toBeInTheDocument()
      expect(screen.queryByText("Ask Google")).not.toBeInTheDocument()
      expect(screen.queryByText("Ask ChatGPT")).not.toBeInTheDocument()
    })
  })
})