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 `SessionApi` to RTK query hooks (#76045)
Romeo Van Snick66a53ed09b7d
diff --git a/frontend/src/metabase/api/session.ts b/frontend/src/metabase/api/session.tsindex 364bf3f93d0..e9e0d711933 100644--- a/frontend/src/metabase/api/session.ts+++ b/frontend/src/metabase/api/session.ts@@ -1,3 +1,4 @@+import type { LoginData } from "metabase/redux/auth";import { loadSettings } from "metabase/redux/settings";import {isValidColorScheme,@@ -14,8 +15,62 @@ import { handleQueryFulfilled } from "./utils/lifecycle";export const sessionPropertiesPath = "/api/session/properties";+export interface SessionResponse {+ id: string;+}++export interface GoogleAuthData {+ token: string;+ remember?: boolean;+}++export interface ResetPasswordData {+ token: string;+ password: string;+}++export interface SsoLogoutResponse {+ "saml-logout-url"?: string;+}+export const sessionApi = Api.injectEndpoints({endpoints: (builder) => ({+ createSession: builder.mutation<SessionResponse, LoginData>({+ query: (body) => ({+ method: "POST",+ url: "/api/session",+ body,+ }),+ }),+ createSessionWithGoogleAuth: builder.mutation<+ SessionResponse,+ GoogleAuthData+ >({+ query: (body) => ({+ method: "POST",+ url: "/api/session/google_auth",+ body,+ }),+ }),+ deleteSession: builder.mutation<void, void>({+ query: () => ({+ method: "DELETE",+ url: "/api/session",+ }),+ }),+ logoutSso: builder.mutation<SsoLogoutResponse, void>({+ query: () => ({+ method: "POST",+ url: "/auth/sso/logout",+ }),+ }),+ resetPassword: builder.mutation<void, ResetPasswordData>({+ query: (body) => ({+ method: "POST",+ url: "/api/session/reset_password",+ body,+ }),+ }),getPasswordResetTokenStatus: builder.query<PasswordResetTokenStatus,string@@ -65,6 +120,11 @@ export const sessionApi = Api.injectEndpoints({});export const {+ useCreateSessionMutation,+ useCreateSessionWithGoogleAuthMutation,+ useDeleteSessionMutation,+ useLogoutSsoMutation,+ useResetPasswordMutation,useGetPasswordResetTokenStatusQuery,useForgotPasswordMutation,useCheckPasswordMutation,diff --git a/frontend/src/metabase/redux/auth.ts b/frontend/src/metabase/redux/auth.tsindex 232895055f8..98629294a43 100644--- a/frontend/src/metabase/redux/auth.ts+++ b/frontend/src/metabase/redux/auth.ts@@ -1,4 +1,5 @@import {+ type ThunkDispatch,type UnknownAction,createAction,createReducer,@@ -6,13 +7,13 @@ import {import { push } from "react-router-redux";import { loadLocalization } from "metabase/api/localization";+import { sessionApi } from "metabase/api/session";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";@@ -64,7 +65,9 @@ export const login = createAsyncThunk(LOGIN,async ({ data }: LoginPayload, { dispatch, rejectWithValue }) => {try {- await SessionApi.create(data);+ await dispatch(+ sessionApi.endpoints.createSession.initiate(data),+ ).unwrap();await dispatch(refreshSession()).unwrap();if (!isSmallScreen()) {dispatch(openNavbar());@@ -89,10 +92,12 @@ export const loginGoogle = createAsyncThunk({ dispatch, rejectWithValue },) => {try {- await SessionApi.createWithGoogleAuth({- token: credential,- remember,- });+ await dispatch(+ sessionApi.endpoints.createSessionWithGoogleAuth.initiate({+ token: credential,+ remember,+ }),+ ).unwrap();await dispatch(refreshSession()).unwrap();if (!isSmallScreen()) {dispatch(openNavbar());@@ -115,7 +120,8 @@ export const logout = createAsyncThunk(const user = getUser(state);if (user?.sso_source === "saml") {- const { "saml-logout-url": samlLogoutUrl } = await initiateSLO();+ const { "saml-logout-url": samlLogoutUrl } =+ (await initiateSLO(dispatch)) ?? {};dispatch(clearCurrentUser());await dispatch(refreshLocale()).unwrap();@@ -124,7 +130,7 @@ export const logout = createAsyncThunk(window.location.href = samlLogoutUrl;}} else {- await deleteSession();+ await deleteSession(dispatch);dispatch(clearCurrentUser());await dispatch(refreshLocale()).unwrap();@@ -142,9 +148,11 @@ export const logout = createAsyncThunk(export const FORGOT_PASSWORD = "metabase/auth/FORGOT_PASSWORD";export const forgotPassword = createAsyncThunk(FORGOT_PASSWORD,- async (email: string, { rejectWithValue }) => {+ async (email: string, { dispatch, rejectWithValue }) => {try {- await SessionApi.forgot_password({ email });+ await dispatch(+ sessionApi.endpoints.forgotPassword.initiate(email),+ ).unwrap();} catch (error) {return rejectWithValue(error);}@@ -164,7 +172,9 @@ export const resetPassword = createAsyncThunk({ dispatch, rejectWithValue },) => {try {- await SessionApi.reset_password({ token, password });+ await dispatch(+ sessionApi.endpoints.resetPassword.initiate({ token, password }),+ ).unwrap();await dispatch(refreshSession()).unwrap();} catch (error) {return rejectWithValue(error);@@ -172,9 +182,9 @@ export const resetPassword = createAsyncThunk(},);-const initiateSLO = async () => {+const initiateSLO = async (dispatch: ThunkDispatch<any, any, any>) => {try {- return await SessionApi.slo();+ return await dispatch(sessionApi.endpoints.logoutSso.initiate()).unwrap();} catch (error) {if (!isResourceNotFoundError(error)) {console.error("Problem clearing session", error);@@ -182,9 +192,9 @@ const initiateSLO = async () => {}};-export const deleteSession = async () => {+const deleteSession = async (dispatch: ThunkDispatch<any, any, any>) => {try {- await SessionApi.delete();+ await dispatch(sessionApi.endpoints.deleteSession.initiate()).unwrap();} catch (error) {if (!isResourceNotFoundError(error)) {console.error("Problem clearing session", error);diff --git a/frontend/src/metabase/services.js b/frontend/src/metabase/services.jsindex 9be71f27ccd..7091193c31e 100644--- a/frontend/src/metabase/services.js+++ b/frontend/src/metabase/services.js@@ -1,13 +1,4 @@-import { DELETE, GET, POST, PUT } from "metabase/api/legacy-client";--export const SessionApi = {- create: POST("/api/session"),- createWithGoogleAuth: POST("/api/session/google_auth"),- delete: DELETE("/api/session"),- slo: POST("/auth/sso/logout"),- forgot_password: POST("/api/session/forgot_password"),- reset_password: POST("/api/session/reset_password"),-};+import { GET, PUT } from "metabase/api/legacy-client";export const SettingsApi = {list: GET("/api/setting"),