Change name for interne deployment #10302

Uriel-Sautron · 2025-01-09T12:58:40Z

close #10281
For internal deployment we need to display the LMR and Horizon logos.

For test:

create a folder overrides at the front root
add in this folder the images you find here and overrides.json

// overrides.json
{
   "name": {
     "stdcm": "Last Minute Request",
     "digital_twin": "Horizon"
   },
 "icons": {
    "stdcm": {
      "light": "Logotype_LastMinuteRequest_light",
      "dark": "Logotype_LastMinuteRequest_dark"
    },
    "digital_twin": {
      "light": "Logotype_Horizon_light",
      "dark": "Logotype_Horizon_dark"
    }
  }
}

- change logo stdcm when using application internally Signed-off-by: Uriel-Sautron <[email protected]>

…cation internally

codecov-commenter · 2025-01-09T13:00:59Z

⚠️ Please install the to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 67.43%. Comparing base (ef6e28e) to head (9e3dc3d).
Report is 62 commits behind head on dev.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

❗ There is a different number of reports uploaded between BASE (ef6e28e) and HEAD (9e3dc3d). Click for more details.

HEAD has 6 uploads less than BASE

Flag BASE (ef6e28e) HEAD (9e3dc3d)

osrdyne 2 1

gateway 2 1

tests 2 1

front 2 0

editoast 2 1

Additional details and impacted files

@@             Coverage Diff             @@
##              dev   #10302       +/-   ##
===========================================
- Coverage   81.45%   67.43%   -14.03%     
===========================================
  Files        1058      366      -692     
  Lines      104235    37193    -67042     
  Branches      722        0      -722     
===========================================
- Hits        84907    25080    -59827     
+ Misses      19287    12113     -7174     
+ Partials       41        0       -41

Flag	Coverage Δ
editoast	`73.62% <ø> (+<0.01%)`	⬆️
front	`?`
gateway	`2.18% <ø> (ø)`
osrdyne	`3.28% <ø> (ø)`
railjson_generator	`87.50% <ø> (ø)`
tests	`87.05% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

ElysaSrc

Thanks for the PR !

In my understanding of the front (which might get a bit rusty over time) I think we should reference directly only the files that are present in the code base (the default logo) and switch if the override file exists on the server and defines the fields on the json.

ElysaSrc · 2025-01-09T13:04:43Z

front/src/utils/hooks/useLogo.ts

+    stdcmLogo: undefined,
+    stdcmPngLogo: defaultLogo,
+  });
+  const [isIntenalProd, setIsIntenalProd] = useState(false);


Maybe we should not name this internalProd, but "customizedDeployment", it seems more accurate.

ElysaSrc · 2025-01-09T13:08:02Z

front/src/applications/stdcm/components/StdcmResults/SimulationReportSheet.tsx

@@ -15,6 +16,7 @@ import type { SimulationReportSheetProps } from '../../types';
 import { getStopDurationTime } from '../../utils/formatSimulationReportSheet';

 const getSecondaryCode = ({ location }: StdcmPathStep) => location!.secondary_code;
+const lmrLogoPath = '../../overrides/[email protected]';


We should not reference any override directly in terms of path, they are dynamically defined by the JSON.

front/src/applications/stdcm/components/StdcmHeader.tsx

ElysaSrc

Overall LGTM, thanks !

ElysaSrc · 2025-01-09T15:47:47Z

front/src/utils/hooks/useLogo.ts

+
+          const lmrLogoPath = `../../overrides/${icons.stdcm.light}.svg`;
+          const lmrPngLogoPath = `../../overrides/${icons.stdcm.light}@2x.png`;
+          const horizonFullLogoPath = `../../overrides/${icons.digital_twin.dark}.svg`;


Any reasons to use ../../overrides vs /overrides ?

Uriel-Sautron added 5 commits January 7, 2025 17:39

front: change name in interne deployment

6a51a54

- change logo stdcm when using application internally Signed-off-by: Uriel-Sautron <[email protected]>

- add lmr logo in stdcm simulation report sheet when using the appli…

87487c4

…cation internally

- create hook useLogo

daacdfb

- use useLogo in app

a3d6605

- remove logo.ts

ef600c1

Uriel-Sautron requested review from Yohh, clarani and ElysaSrc January 9, 2025 12:58

Uriel-Sautron requested a review from a team as a code owner January 9, 2025 12:58

github-actions bot added the area:front Work on Standard OSRD Interface modules label Jan 9, 2025

ElysaSrc requested changes Jan 9, 2025

View reviewed changes

Yohh reviewed Jan 9, 2025

View reviewed changes

front/src/applications/stdcm/components/StdcmHeader.tsx Show resolved Hide resolved

fixup: fix Elyse's comments

9e3dc3d

Uriel-Sautron requested review from Yohh and ElysaSrc January 9, 2025 14:43

ElysaSrc approved these changes Jan 9, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Change name for interne deployment #10302

Change name for interne deployment #10302

Uriel-Sautron commented Jan 9, 2025 •

edited

Loading

codecov-commenter commented Jan 9, 2025 •

edited

Loading

ElysaSrc left a comment

ElysaSrc Jan 9, 2025

Uriel-Sautron Jan 9, 2025

ElysaSrc Jan 9, 2025

Uriel-Sautron Jan 9, 2025

ElysaSrc left a comment

ElysaSrc Jan 9, 2025

Change name for interne deployment #10302

Are you sure you want to change the base?

Change name for interne deployment #10302

Conversation

Uriel-Sautron commented Jan 9, 2025 • edited Loading

codecov-commenter commented Jan 9, 2025 • edited Loading

Codecov Report

ElysaSrc left a comment

Choose a reason for hiding this comment

ElysaSrc Jan 9, 2025

Choose a reason for hiding this comment

Uriel-Sautron Jan 9, 2025

Choose a reason for hiding this comment

ElysaSrc Jan 9, 2025

Choose a reason for hiding this comment

Uriel-Sautron Jan 9, 2025

Choose a reason for hiding this comment

ElysaSrc left a comment

Choose a reason for hiding this comment

ElysaSrc Jan 9, 2025

Choose a reason for hiding this comment

Uriel-Sautron commented Jan 9, 2025 •

edited

Loading

codecov-commenter commented Jan 9, 2025 •

edited

Loading