The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:
TypeScript analyticsbibusiness-intelligencebusinessintelligenceclojuredashboarddatadata-analysisdata-visualizationdatabasemetabasemysqlpostgrespostgresqlreportingslacksql-editorvisualization
Move `metabase/auth` to the feature tier (#75375)
Romeo Van Snick84a31f735cc4
diff --git a/enterprise/frontend/src/metabase-enterprise/auth/index.ts b/enterprise/frontend/src/metabase-enterprise/auth/index.tsindex 99c92b8199c..43cc69aa4b3 100644--- a/enterprise/frontend/src/metabase-enterprise/auth/index.ts+++ b/enterprise/frontend/src/metabase-enterprise/auth/index.ts@@ -1,4 +1,3 @@-import { LOGIN, LOGIN_GOOGLE } from "metabase/auth/actions";import {PLUGIN_AUTH_PROVIDERS,PLUGIN_IS_PASSWORD_USER,@@ -6,6 +5,7 @@ import {PLUGIN_REDUX_MIDDLEWARES,} from "metabase/plugins";import type { AuthProvider } from "metabase/plugins/types";+import { LOGIN, LOGIN_GOOGLE } from "metabase/redux/auth";import MetabaseSettings from "metabase/utils/settings";import { hasPremiumFeature } from "metabase-enterprise/settings";import type { OidcAuthProvider, User } from "metabase-types/api";diff --git a/enterprise/frontend/src/metabase-enterprise/auth/middleware/session-middleware.js b/enterprise/frontend/src/metabase-enterprise/auth/middleware/session-middleware.jsindex a4221530548..6d1135c9b3a 100644--- a/enterprise/frontend/src/metabase-enterprise/auth/middleware/session-middleware.js+++ b/enterprise/frontend/src/metabase-enterprise/auth/middleware/session-middleware.js@@ -1,7 +1,7 @@import Cookies from "js-cookie";import { replace } from "react-router-redux";-import { logout, refreshSession } from "metabase/auth/actions";+import { logout, refreshSession } from "metabase/redux/auth";import { isSameOrSiteUrlOrigin } from "metabase/utils/dom";export const SESSION_KEY = "metabase.TIMEOUT";diff --git a/enterprise/frontend/src/metabase-enterprise/auth/middleware/session-middleware.unit.spec.js b/enterprise/frontend/src/metabase-enterprise/auth/middleware/session-middleware.unit.spec.jsindex d3eccb8c446..1ed49bf8c15 100644--- a/enterprise/frontend/src/metabase-enterprise/auth/middleware/session-middleware.unit.spec.js+++ b/enterprise/frontend/src/metabase-enterprise/auth/middleware/session-middleware.unit.spec.js@@ -2,7 +2,7 @@ import FakeTimers from "@sinonjs/fake-timers";import Cookie from "js-cookie";import { replace } from "react-router-redux";-import { logout, refreshSession } from "metabase/auth/actions";+import { logout, refreshSession } from "metabase/redux/auth";import {COOKIE_POOLING_TIMEOUT,@@ -11,7 +11,7 @@ import {} from "./session-middleware";jest.mock("js-cookie", () => jest.fn());-jest.mock("metabase/auth/actions", () => ({+jest.mock("metabase/redux/auth", () => ({logout: jest.fn(),refreshSession: jest.fn(() => Promise.resolve()),}));diff --git a/frontend/lint/module-boundaries.mjs b/frontend/lint/module-boundaries.mjsindex 3ee69ad6c26..8caaa945b9a 100644--- a/frontend/lint/module-boundaries.mjs+++ b/frontend/lint/module-boundaries.mjs@@ -51,7 +51,7 @@ const elements = [createElement({ type: "shared", name: "account" }),createElement({ type: "shared", name: "api" }),createElement({ type: "shared", name: "archive" }),- createElement({ type: "shared", name: "auth" }),+ createElement({ type: "feature", name: "auth" }),createElement({ type: "shared", name: "browse" }),createElement({ type: "shared", name: "collections" }),createElement({ type: "shared", name: "comments" }),diff --git a/frontend/src/metabase/auth/actions.ts b/frontend/src/metabase/auth/actions.tsdeleted file mode 100644index 55e137830cb..00000000000--- a/frontend/src/metabase/auth/actions.ts+++ /dev/null@@ -1,185 +0,0 @@-import { type UnknownAction, createAction } from "@reduxjs/toolkit";-import { push } from "react-router-redux";--import { loadLocalization } from "metabase/api/localization";-import { openNavbar } from "metabase/redux/app";-import { refreshSiteSettings } from "metabase/redux/settings";-import { clearCurrentUser, refreshCurrentUser } from "metabase/redux/user";-import { createAsyncThunk } from "metabase/redux/utils";-import { getSetting } from "metabase/selectors/settings";-import { getUser } from "metabase/selectors/user";-import { SessionApi } from "metabase/services";-import * as Urls from "metabase/urls";-import { isSmallScreen, reload } from "metabase/utils/dom";-import { isResourceNotFoundError } from "metabase/utils/errors";--import type { LoginData } from "./types";--export const REFRESH_LOCALE = "metabase/user/REFRESH_LOCALE";-export const refreshLocale = createAsyncThunk(- REFRESH_LOCALE,- async (_, { dispatch, getState }) => {- const userLocale = getUser(getState())?.locale;- const siteLocale = getSetting(getState(), "site-locale");- if (userLocale && userLocale !== siteLocale) {- // This sets a flag to keep the route guard from redirecting us while the reload is happening- await dispatch(pauseRedirect());- reload();- } else {- await loadLocalization(userLocale ?? siteLocale ?? "en");- }- },-);--export const PAUSE_REDIRECT = "metabase/user/PAUSE_REDIRECT";-export const pauseRedirect = createAction(PAUSE_REDIRECT);--export const REFRESH_SESSION = "metabase/auth/REFRESH_SESSION";-export const refreshSession = createAsyncThunk(- REFRESH_SESSION,- async (_, { dispatch }) => {- await Promise.all([- dispatch(refreshCurrentUser()),- dispatch(refreshSiteSettings()),- ]);- await dispatch(refreshLocale()).unwrap();- },-);--interface LoginPayload {- data: LoginData;- redirectUrl?: string;-}--export const LOGIN = "metabase/auth/LOGIN";-export const login = createAsyncThunk(- LOGIN,- async ({ data }: LoginPayload, { dispatch, rejectWithValue }) => {- try {- await SessionApi.create(data);- await dispatch(refreshSession()).unwrap();- if (!isSmallScreen()) {- dispatch(openNavbar());- }- } catch (error) {- return rejectWithValue(error);- }- },-);--interface LoginGooglePayload {- credential: string;- redirectUrl?: string;- remember?: boolean;-}--export const LOGIN_GOOGLE = "metabase/auth/LOGIN_GOOGLE";-export const loginGoogle = createAsyncThunk(- LOGIN_GOOGLE,- async (- { credential, remember }: LoginGooglePayload,- { dispatch, rejectWithValue },- ) => {- try {- await SessionApi.createWithGoogleAuth({- token: credential,- remember,- });- await dispatch(refreshSession()).unwrap();- if (!isSmallScreen()) {- dispatch(openNavbar());- }- } catch (error) {- return rejectWithValue(error);- }- },-);--export const LOGOUT = "metabase/auth/LOGOUT";-export const logout = createAsyncThunk(- LOGOUT,- async (- redirectUrl: string | undefined,- { dispatch, rejectWithValue, getState },- ) => {- try {- const state = getState();- const user = getUser(state);-- if (user?.sso_source === "saml") {- const { "saml-logout-url": samlLogoutUrl } = await initiateSLO();-- dispatch(clearCurrentUser());- await dispatch(refreshLocale()).unwrap();-- if (samlLogoutUrl) {- window.location.href = samlLogoutUrl;- }- } else {- await deleteSession();- dispatch(clearCurrentUser());- await dispatch(refreshLocale()).unwrap();-- // We use old react-router-redux which references old redux, which does not require- // action type to be a string - unlike RTK v2+- dispatch(push(Urls.login()) as unknown as UnknownAction);- reload(); // clears redux state and browser caches- }- } catch (error) {- return rejectWithValue(error);- }- },-);--export const FORGOT_PASSWORD = "metabase/auth/FORGOT_PASSWORD";-export const forgotPassword = createAsyncThunk(- FORGOT_PASSWORD,- async (email: string, { rejectWithValue }) => {- try {- await SessionApi.forgot_password({ email });- } catch (error) {- return rejectWithValue(error);- }- },-);--interface ResetPasswordPayload {- token: string;- password: string;-}--export const RESET_PASSWORD = "metabase/auth/RESET_PASSWORD";-export const resetPassword = createAsyncThunk(- RESET_PASSWORD,- async (- { token, password }: ResetPasswordPayload,- { dispatch, rejectWithValue },- ) => {- try {- await SessionApi.reset_password({ token, password });- await dispatch(refreshSession()).unwrap();- } catch (error) {- return rejectWithValue(error);- }- },-);--const initiateSLO = async () => {- try {- return await SessionApi.slo();- } catch (error) {- if (!isResourceNotFoundError(error)) {- console.error("Problem clearing session", error);- }- }-};--export const deleteSession = async () => {- try {- await SessionApi.delete();- } catch (error) {- if (!isResourceNotFoundError(error)) {- console.error("Problem clearing session", error);- }- }-};diff --git a/frontend/src/metabase/auth/components/ForgotPassword/ForgotPassword.tsx b/frontend/src/metabase/auth/components/ForgotPassword/ForgotPassword.tsxindex f2fad4da1c0..e1f52cbf559 100644--- a/frontend/src/metabase/auth/components/ForgotPassword/ForgotPassword.tsx+++ b/frontend/src/metabase/auth/components/ForgotPassword/ForgotPassword.tsx@@ -3,9 +3,9 @@ import { useCallback, useState } from "react";import { t } from "ttag";import { useDispatch, useSelector } from "metabase/redux";+import { forgotPassword } from "metabase/redux/auth";import { Button } from "metabase/ui";-import { forgotPassword } from "../../actions";import { getIsEmailConfigured, getIsLdapEnabled } from "../../selectors";import { AuthLayout } from "../AuthLayout";import { ForgotPasswordForm } from "../ForgotPasswordForm";diff --git a/frontend/src/metabase/auth/components/GoogleButton/GoogleButton.tsx b/frontend/src/metabase/auth/components/GoogleButton/GoogleButton.tsxindex 484575a6511..885065662e4 100644--- a/frontend/src/metabase/auth/components/GoogleButton/GoogleButton.tsx+++ b/frontend/src/metabase/auth/components/GoogleButton/GoogleButton.tsx@@ -7,11 +7,11 @@ import { t } from "ttag";import ErrorBoundary from "metabase/ErrorBoundary";import { Link } from "metabase/common/components/Link";import { useDispatch, useSelector } from "metabase/redux";+import { loginGoogle } from "metabase/redux/auth";import { Box, Checkbox, useColorScheme } from "metabase/ui";import * as Urls from "metabase/urls";import { getCspNonce } from "metabase/utils/csp";-import { loginGoogle } from "../../actions";import { getGoogleClientId, getSiteLocale } from "../../selectors";import S from "./GoogleButton.module.css";diff --git a/frontend/src/metabase/auth/components/LoginForm/LoginForm.tsx b/frontend/src/metabase/auth/components/LoginForm/LoginForm.tsxindex dbdf9ca3d55..2e827ac900f 100644--- a/frontend/src/metabase/auth/components/LoginForm/LoginForm.tsx+++ b/frontend/src/metabase/auth/components/LoginForm/LoginForm.tsx@@ -10,10 +10,9 @@ import {FormSubmitButton,FormTextInput,} from "metabase/forms";+import type { LoginData } from "metabase/redux/auth";import * as Errors from "metabase/utils/errors";-import type { LoginData } from "../../types";-const LOGIN_SCHEMA = Yup.object().shape({username: Yup.string().required(Errors.required)diff --git a/frontend/src/metabase/auth/components/Logout/Logout.tsx b/frontend/src/metabase/auth/components/Logout/Logout.tsxindex 9161d689826..80b6543bb5c 100644--- a/frontend/src/metabase/auth/components/Logout/Logout.tsx+++ b/frontend/src/metabase/auth/components/Logout/Logout.tsx@@ -1,8 +1,7 @@import { useEffect } from "react";import { useDispatch } from "metabase/redux";--import { logout } from "../../actions";+import { logout } from "metabase/redux/auth";export const Logout = (): JSX.Element | null => {const dispatch = useDispatch();diff --git a/frontend/src/metabase/auth/components/PasswordPanel/PasswordPanel.tsx b/frontend/src/metabase/auth/components/PasswordPanel/PasswordPanel.tsxindex b8a1d9e5f92..9906a4f9625 100644--- a/frontend/src/metabase/auth/components/PasswordPanel/PasswordPanel.tsx+++ b/frontend/src/metabase/auth/components/PasswordPanel/PasswordPanel.tsx@@ -2,14 +2,14 @@ import { useCallback } from "react";import { t } from "ttag";import { useDispatch, useSelector } from "metabase/redux";+import type { LoginData } from "metabase/redux/auth";+import { login } from "metabase/redux/auth";-import { login } from "../../actions";import {getExternalAuthProviders,getHasSessionCookies,getIsLdapEnabled,} from "../../selectors";-import type { LoginData } from "../../types";import { AuthButton } from "../AuthButton";import { LoginForm } from "../LoginForm";diff --git a/frontend/src/metabase/auth/components/ResetPassword/ResetPassword.tsx b/frontend/src/metabase/auth/components/ResetPassword/ResetPassword.tsxindex 0c49999d4b4..a489f356713 100644--- a/frontend/src/metabase/auth/components/ResetPassword/ResetPassword.tsx+++ b/frontend/src/metabase/auth/components/ResetPassword/ResetPassword.tsx@@ -8,9 +8,9 @@ import { Link } from "metabase/common/components/Link";import { useValidatePassword } from "metabase/common/hooks";import { useToast } from "metabase/common/hooks/use-toast";import { useDispatch } from "metabase/redux";+import { resetPassword } from "metabase/redux/auth";import { Button } from "metabase/ui";-import { resetPassword } from "../../actions";import type { ResetPasswordData } from "../../types";import { AuthLayout } from "../AuthLayout";import { ResetPasswordForm } from "../ResetPasswordForm";diff --git a/frontend/src/metabase/auth/types.ts b/frontend/src/metabase/auth/types.tsindex 1b2fdc4c98f..952daf4ea3a 100644--- a/frontend/src/metabase/auth/types.ts+++ b/frontend/src/metabase/auth/types.ts@@ -1,9 +1,3 @@-export interface LoginData {- username: string;- password: string;- remember?: boolean;-}-export interface ForgotPasswordData {email: string;}diff --git a/frontend/src/metabase/metabot/state/reducer.ts b/frontend/src/metabase/metabot/state/reducer.tsindex 11014c205bd..656befcd436 100644--- a/frontend/src/metabase/metabot/state/reducer.ts+++ b/frontend/src/metabase/metabot/state/reducer.ts@@ -2,7 +2,7 @@ import { type PayloadAction, createSlice } from "@reduxjs/toolkit";import { castDraft } from "immer";import _ from "underscore";-import { logout } from "metabase/auth/actions";+import { logout } from "metabase/redux/auth";import { uuid } from "metabase/utils/uuid";import type {MetabotCodeEdit,diff --git a/frontend/src/metabase/metabot/tests/ui.unit.spec.tsx b/frontend/src/metabase/metabot/tests/ui.unit.spec.tsxindex ea3e0cae755..9df03febee4 100644--- a/frontend/src/metabase/metabot/tests/ui.unit.spec.tsx+++ b/frontend/src/metabase/metabot/tests/ui.unit.spec.tsx@@ -3,10 +3,10 @@ import userEvent from "@testing-library/user-event";import fetchMock from "fetch-mock";import { act, screen, waitFor, within } from "__support__/ui";-import { logout } from "metabase/auth/actions";import { useMetabotAgent } from "metabase/metabot/hooks";import { metabotActions } from "metabase/metabot/state";import { getMetabotInitialState } from "metabase/metabot/state/reducer-utils";+import { logout } from "metabase/redux/auth";import * as domModule from "metabase/utils/dom";import { createMockUser } from "metabase-types/api/mocks";diff --git a/frontend/src/metabase/nav/components/AppSwitcher/AppSwitcher.tsx b/frontend/src/metabase/nav/components/AppSwitcher/AppSwitcher.tsxindex 6e0533efa76..cb1a572f38a 100644--- a/frontend/src/metabase/nav/components/AppSwitcher/AppSwitcher.tsx+++ b/frontend/src/metabase/nav/components/AppSwitcher/AppSwitcher.tsx@@ -1,7 +1,6 @@import { useMemo, useState } from "react";import { t } from "ttag";-import { logout } from "metabase/auth/actions";import { ErrorDiagnosticModalWrapper } from "metabase/common/components/ErrorPages/ErrorDiagnosticModal";import { trackErrorDiagnosticModalOpened } from "metabase/common/components/ErrorPages/analytics";import { ExternalLink } from "metabase/common/components/ExternalLink";@@ -15,6 +14,7 @@ import {} from "metabase/home/selectors";import { useDispatch, useSelector } from "metabase/redux";import { openDiagnostics } from "metabase/redux/app";+import { logout } from "metabase/redux/auth";import { setOpenModal } from "metabase/redux/ui";import { getAdminPaths } from "metabase/selectors/admin";import { getUser } from "metabase/selectors/user";diff --git a/frontend/src/metabase/nav/containers/MainNavbar/MainNavbarContainer/MainNavbarContainer.tsx b/frontend/src/metabase/nav/containers/MainNavbar/MainNavbarContainer/MainNavbarContainer.tsxindex 8bc0a62a1be..97e08b405be 100644--- a/frontend/src/metabase/nav/containers/MainNavbar/MainNavbarContainer/MainNavbarContainer.tsx+++ b/frontend/src/metabase/nav/containers/MainNavbar/MainNavbarContainer/MainNavbarContainer.tsx@@ -9,7 +9,6 @@ import {useListDatabasesQuery,useReorderBookmarksMutation,} from "metabase/api";-import { logout } from "metabase/auth/actions";import { ROOT_COLLECTION } from "metabase/collections/constants";import CreateCollectionModal from "metabase/collections/containers/CreateCollectionModal";import type { CollectionTreeItem } from "metabase/collections/utils";@@ -22,6 +21,7 @@ import {import { Modal } from "metabase/common/components/Modal";import { PLUGIN_TENANTS } from "metabase/plugins";import { connect, useDispatch, useSelector } from "metabase/redux";+import { logout } from "metabase/redux/auth";import type { State } from "metabase/redux/store";import { addUndo } from "metabase/redux/undo";import {diff --git a/frontend/src/metabase/redux/auth.ts b/frontend/src/metabase/redux/auth.tsindex f50c657538c..232895055f8 100644--- a/frontend/src/metabase/redux/auth.ts+++ b/frontend/src/metabase/redux/auth.ts@@ -1,6 +1,196 @@-import { createReducer } from "@reduxjs/toolkit";+import {+ type UnknownAction,+ createAction,+ createReducer,+} from "@reduxjs/toolkit";+import { push } from "react-router-redux";-import { login, loginGoogle, pauseRedirect } from "metabase/auth/actions";+import { loadLocalization } from "metabase/api/localization";+import { openNavbar } from "metabase/redux/app";+import { refreshSiteSettings } from "metabase/redux/settings";+import { clearCurrentUser, refreshCurrentUser } from "metabase/redux/user";+import { createAsyncThunk } from "metabase/redux/utils";+import { getSetting } from "metabase/selectors/settings";+import { getUser } from "metabase/selectors/user";+import { SessionApi } from "metabase/services";+import * as Urls from "metabase/urls";+import { isSmallScreen, reload } from "metabase/utils/dom";+import { isResourceNotFoundError } from "metabase/utils/errors";++export interface LoginData {+ username: string;+ password: string;+ remember?: boolean;+}++export const REFRESH_LOCALE = "metabase/user/REFRESH_LOCALE";+export const refreshLocale = createAsyncThunk(+ REFRESH_LOCALE,+ async (_, { dispatch, getState }) => {+ const userLocale = getUser(getState())?.locale;+ const siteLocale = getSetting(getState(), "site-locale");+ if (userLocale && userLocale !== siteLocale) {+ // This sets a flag to keep the route guard from redirecting us while the reload is happening+ await dispatch(pauseRedirect());+ reload();+ } else {+ await loadLocalization(userLocale ?? siteLocale ?? "en");+ }+ },+);++export const PAUSE_REDIRECT = "metabase/user/PAUSE_REDIRECT";+export const pauseRedirect = createAction(PAUSE_REDIRECT);++export const REFRESH_SESSION = "metabase/auth/REFRESH_SESSION";+export const refreshSession = createAsyncThunk(+ REFRESH_SESSION,+ async (_, { dispatch }) => {+ await Promise.all([+ dispatch(refreshCurrentUser()),+ dispatch(refreshSiteSettings()),+ ]);+ await dispatch(refreshLocale()).unwrap();+ },+);++interface LoginPayload {+ data: LoginData;+ redirectUrl?: string;+}++export const LOGIN = "metabase/auth/LOGIN";+export const login = createAsyncThunk(+ LOGIN,+ async ({ data }: LoginPayload, { dispatch, rejectWithValue }) => {+ try {+ await SessionApi.create(data);+ await dispatch(refreshSession()).unwrap();+ if (!isSmallScreen()) {+ dispatch(openNavbar());+ }+ } catch (error) {+ return rejectWithValue(error);+ }+ },+);++interface LoginGooglePayload {+ credential: string;+ redirectUrl?: string;+ remember?: boolean;+}++export const LOGIN_GOOGLE = "metabase/auth/LOGIN_GOOGLE";+export const loginGoogle = createAsyncThunk(+ LOGIN_GOOGLE,+ async (+ { credential, remember }: LoginGooglePayload,+ { dispatch, rejectWithValue },+ ) => {+ try {+ await SessionApi.createWithGoogleAuth({+ token: credential,+ remember,+ });+ await dispatch(refreshSession()).unwrap();+ if (!isSmallScreen()) {+ dispatch(openNavbar());+ }+ } catch (error) {+ return rejectWithValue(error);+ }+ },+);++export const LOGOUT = "metabase/auth/LOGOUT";+export const logout = createAsyncThunk(+ LOGOUT,+ async (+ redirectUrl: string | undefined,+ { dispatch, rejectWithValue, getState },+ ) => {+ try {+ const state = getState();+ const user = getUser(state);++ if (user?.sso_source === "saml") {+ const { "saml-logout-url": samlLogoutUrl } = await initiateSLO();++ dispatch(clearCurrentUser());+ await dispatch(refreshLocale()).unwrap();++ if (samlLogoutUrl) {+ window.location.href = samlLogoutUrl;+ }+ } else {+ await deleteSession();+ dispatch(clearCurrentUser());+ await dispatch(refreshLocale()).unwrap();++ // We use old react-router-redux which references old redux, which does not require+ // action type to be a string - unlike RTK v2++ dispatch(push(Urls.login()) as unknown as UnknownAction);+ reload(); // clears redux state and browser caches+ }+ } catch (error) {+ return rejectWithValue(error);+ }+ },+);++export const FORGOT_PASSWORD = "metabase/auth/FORGOT_PASSWORD";+export const forgotPassword = createAsyncThunk(+ FORGOT_PASSWORD,+ async (email: string, { rejectWithValue }) => {+ try {+ await SessionApi.forgot_password({ email });+ } catch (error) {+ return rejectWithValue(error);+ }+ },+);++interface ResetPasswordPayload {+ token: string;+ password: string;+}++export const RESET_PASSWORD = "metabase/auth/RESET_PASSWORD";+export const resetPassword = createAsyncThunk(+ RESET_PASSWORD,+ async (+ { token, password }: ResetPasswordPayload,+ { dispatch, rejectWithValue },+ ) => {+ try {+ await SessionApi.reset_password({ token, password });+ await dispatch(refreshSession()).unwrap();+ } catch (error) {+ return rejectWithValue(error);+ }+ },+);++const initiateSLO = async () => {+ try {+ return await SessionApi.slo();+ } catch (error) {+ if (!isResourceNotFoundError(error)) {+ console.error("Problem clearing session", error);+ }+ }+};++export const deleteSession = async () => {+ try {+ await SessionApi.delete();+ } catch (error) {+ if (!isResourceNotFoundError(error)) {+ console.error("Problem clearing session", error);+ }+ }+};const initialState = {loginPending: false,