front, editoast: turn SearchPayload.object into enum

Signed-off-by: Quentix <quentin.hay-kergrohenn@epita.fr>

Author: QuentinHayK

editoast/openapi.yaml

@@ -230,6 +230,8 @@ use search::query_into_sql;
 use serde::Deserialize;
 use serde::Serialize;
 use serde_json::value::Value as JsonValue;
+use strum::Display;
+use strum::FromRepr;
 use utoipa::ToSchema;
 
 use crate::error::Result;
@@ -260,6 +262,20 @@ enum SearchQuery {
     Array(Vec<Option<SearchQuery>>),
 }
 
+/// Object type for query search
+#[derive(Debug, Clone, ToSchema, Serialize, Deserialize, FromRepr, Display)]
+#[serde(rename_all = "lowercase")]
+enum SearchObjectType {
+    Track,
+    Signal,
+    Project,
+    Study,
+    Scenario,
+    TrainSchedule,
+    OperationalPoint,
+    User,
+}
+
 /// The payload of a search request
 #[derive(Debug, Clone, Deserialize, ToSchema)]
 #[schema(example = json!({
@@ -268,7 +284,7 @@ enum SearchQuery {
 }))]
 pub struct SearchPayload {
     /// The object kind to query - run `editoast search list` to get all possible values
-    object: String,
+    object: SearchObjectType,
     /// The query to run
     #[schema(value_type = SearchQuery)]
     query: JsonValue,
@@ -343,17 +359,15 @@ pub(in crate::views) async fn search(
     Query(PaginationQueryParams { page, page_size }): Query<PaginationQueryParams<1000>>,
     Json(SearchPayload { object, query, dry }): Json<SearchPayload>,
 ) -> Result<Json<serde_json::Value>> {
-    let required_role = match object.as_str() {
-        "track" | "signal" | "project" | "study" | "scenario" => {
-            Some(authz::Role::OperationalStudies)
-        }
-        "trainschedule" | "operationalpoint" | "user" => None,
-        _ => {
-            return Err(SearchApiError::ObjectType {
-                object_type: object.to_owned(),
-            }
-            .into());
-        }
+    let required_role = match object {
+        SearchObjectType::Track
+        | SearchObjectType::Signal
+        | SearchObjectType::Project
+        | SearchObjectType::Study
+        | SearchObjectType::Scenario => Some(authz::Role::OperationalStudies),
+        SearchObjectType::TrainSchedule
+        | SearchObjectType::OperationalPoint
+        | SearchObjectType::User => None,
     };
 
     if let Some(required_role) = required_role
@@ -365,8 +379,10 @@ pub(in crate::views) async fn search(
     }
 
     let search_config =
-        SearchConfigFinder::find(&object).ok_or_else(|| SearchApiError::ObjectType {
-            object_type: object.to_owned(),
+        SearchConfigFinder::find(object.to_string().to_lowercase()).ok_or_else(|| {
+            SearchApiError::ObjectType {
+                object_type: object.to_string(),
+            }
         })?;
     let offset = (page - 1) * page_size;
     let (sql, bindings) = query_into_sql(

editoast/src/views/search.rs

@@ -1,3 +1,4 @@
+import type { SearchPayload } from 'common/api/osrdEditoastApi';
 import { toUpper } from 'utils/strings';
 
 export const tokenClause = (token: string) => [
@@ -17,7 +18,10 @@ export const searchQuery = (debouncedTrimmedInput: string) => [
   ['search', ['secondary_code'], debouncedTrimmedInput],
 ];
 
-export const largePayload = (infraId: number | undefined, debouncedTrimmedInput: string) => ({
+export const largePayload = (
+  infraId: number | undefined,
+  debouncedTrimmedInput: string
+): SearchPayload => ({
   object: 'operationalpoint',
   query: [
     'and',
@@ -26,7 +30,10 @@ export const largePayload = (infraId: number | undefined, debouncedTrimmedInput:
   ],
 });
 
-export const exactTrigramPayload = (infraId: number | undefined, firstTokenUpper: string) => ({
+export const exactTrigramPayload = (
+  infraId: number | undefined,
+  firstTokenUpper: string
+): SearchPayload => ({
   object: 'operationalpoint',
   query: [
     'and',
@@ -35,7 +42,10 @@ export const exactTrigramPayload = (infraId: number | undefined, firstTokenUpper
   ],
 });
 
-export const multiPayloadFromTokens = (infraId: number | undefined, tokens: string[]) => {
+export const multiPayloadFromTokens = (
+  infraId: number | undefined,
+  tokens: string[]
+): SearchPayload => {
   const multiQuery = buildMultiTokenQuery(tokens);
   return {
     object: 'operationalpoint',

front/src/applications/operationalStudies/helpers/searchPayload.ts

@@ -4,6 +4,7 @@ import { omit } from 'lodash';
 import {
   osrdEditoastApi,
   type MacroNodeResponse,
+  type SearchPayload,
   type SearchResultItemOperationalPoint,
   type SubCategory,
   type TrainCategory,
@@ -268,7 +269,7 @@ export const fetchStationSecondaryCode = async (
   infraId: number,
   dispatch: AppDispatch
 ) => {
-  const searchPayload = {
+  const searchPayload: SearchPayload = {
     object: 'operationalpoint',
     query: ['and', ['=', ['infra_id'], infraId], ['=', ['main_code'], trigram]],
   };

front/src/applications/operationalStudies/views/Scenario/components/MacroEditor/utils.ts

@@ -6,6 +6,7 @@ import { useSelector } from 'react-redux';
 
 import type {
   PathItem,
+  SearchPayload,
   SearchQuery,
   SearchResultItemOperationalPoint,
   SearchResultItemTrainSchedule,
@@ -80,7 +81,7 @@ const useLinkedTrainSearch = () => {
             ] as SearchQuery);
 
       try {
-        const payloadOP = {
+        const payloadOP: SearchPayload = {
           object: 'operationalpoint',
           query: pathItemQuery,
         };

front/src/applications/stdcm/hooks/useLinkedTrainSearch.ts

@@ -4,7 +4,7 @@ import bbox from '@turf/bbox';
 import { useTranslation } from 'react-i18next';
 
 import { osrdEditoastApi } from 'common/api/osrdEditoastApi';
-import type { BoundingBox, SearchResultItemTrack } from 'common/api/osrdEditoastApi';
+import type { BoundingBox, SearchPayload, SearchResultItemTrack } from 'common/api/osrdEditoastApi';
 import InputSNCF from 'common/BootstrapSNCF/InputSNCF';
 import { computeBBoxViewport } from 'common/Map/WarpedMap/core/helpers';
 import { useInfraID } from 'common/osrdContext';
@@ -43,7 +43,7 @@ const MapSearchLine = ({
       ['search', ['line_name'], debouncedSearchTerm],
       ['like', ['to_string', ['line_code']], `%${debouncedSearchTerm}%`],
     ];
-    const payload = {
+    const payload: SearchPayload = {
       object: 'track',
       query: ['and', searchQuery, infraID !== undefined ? ['=', ['infra_id'], infraID] : true],
     };

front/src/common/Map/Search/MapSearchLine.tsx

@@ -3,7 +3,11 @@ import { useState, useMemo, useCallback } from 'react';
 import { skipToken } from '@reduxjs/toolkit/query';
 import { useSelector } from 'react-redux';
 
-import { type SearchResultItemOperationalPoint, osrdEditoastApi } from 'common/api/osrdEditoastApi';
+import {
+  type SearchResultItemOperationalPoint,
+  osrdEditoastApi,
+  type SearchPayload,
+} from 'common/api/osrdEditoastApi';
 import { useInfraID } from 'common/osrdContext';
 import { setFailure } from 'reducers/main';
 import { getOperationalPoints } from 'reducers/osrdconf/stdcmConf/selectors';
@@ -58,7 +62,7 @@ export default function useSearchOperationalPoint({
     async (searchQuery: string) => {
       if (!infraID) return [];
 
-      const payload = {
+      const payload: SearchPayload = {
         object: 'operationalpoint',
         query: [
           'and',

front/src/common/Map/Search/useSearchOperationalPoint.tsx

@@ -4365,14 +4365,23 @@ export type SearchResultItem =
   | SearchResultItemScenario
   | SearchResultItemTrainSchedule
   | SearchResultItemUser;
+export type SearchObjectType =
+  | 'track'
+  | 'signal'
+  | 'project'
+  | 'study'
+  | 'scenario'
+  | 'trainschedule'
+  | 'operationalpoint'
+  | 'user';
 export type SearchQuery = boolean | number | number | string | object;
 export type SearchPayload = {
   /** Whether to return the SQL query instead of executing it
     
     Only available in debug builds. */
   dry?: boolean;
   /** The object kind to query - run `editoast search list` to get all possible values */
-  object: string;
+  object: SearchObjectType;
   /** The query to run */
   query: SearchQuery;
 };

front/src/common/api/generatedEditoastApi.ts

@@ -10,6 +10,7 @@ import { useManageTrainScheduleContext } from 'applications/operationalStudies/h
 import type {
   PathItem,
   PostSearchApiArg,
+  SearchPayload,
   SearchResultItemOperationalPoint,
 } from 'common/api/osrdEditoastApi';
 import { osrdEditoastApi } from 'common/api/osrdEditoastApi';
@@ -100,7 +101,7 @@ const TypeAndPath = ({ setDisplayTypeAndPath, isInNewModal = false }: TypeAndPat
   const searchOperationalPoints = async () => {
     const searchQuery = ['or', ['search', ['name'], debouncedSearchTerm]];
 
-    const payload = {
+    const payload: SearchPayload = {
       object: 'operationalpoint',
       query: ['and', searchQuery, infraId !== undefined ? ['=', ['infra_id'], infraId] : true],
     };