Skip to content

Show error when enabling SAML required with empty identity provider metadata#76825

Merged
NikkiWines merged 8 commits intoExpensify:mainfrom
software-mansion-labs:feat/saml-required-empty-metadata-error
Dec 11, 2025
Merged

Show error when enabling SAML required with empty identity provider metadata#76825
NikkiWines merged 8 commits intoExpensify:mainfrom
software-mansion-labs:feat/saml-required-empty-metadata-error

Conversation

@mhawryluk
Copy link
Contributor

@mhawryluk mhawryluk commented Dec 5, 2025

Explanation of Change

Shows an error when trying to enable SAML required on a domain, when no identity provider metadata is provided.

Fixed Issues

$ #76385
PROPOSAL: N/A

Tests

  1. Open a domain page of a domain that is verified and doesn't have Identity Provider Metadata set
    // or erase it in onyx Onyx.merge('saml_metadata_<domainAccountID>', {metaIdentity: null})
  2. Go to the SAML page
  3. Try to turn the SAML required toggle on.
  4. An error should be displayed underneath, no backend call should be scheduled, the toggle should stay off.

Offline tests

  1. The action in Tests should not grey out the SAML required row.

QA Steps

Same as tests.

PR Author Checklist

  • I linked the correct issue in the ### Fixed Issues section above
  • I wrote clear testing steps that cover the changes made in this PR
    • I added steps for local testing in the Tests section
    • I added steps for the expected offline behavior in the Offline steps section
    • I added steps for Staging and/or Production testing in the QA steps section
    • I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
    • I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
  • I included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • Android: Native
    • Android: mWeb Chrome
    • iOS: Native
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
  • I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
  • I verified there are no new alerts related to the canBeMissing param for useOnyx
  • I followed proper code patterns (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I followed the guidelines as stated in the Review Guidelines
  • I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.ts or at the top of the file that uses the constant) are defined as such
  • I verified that if a function's arguments changed that all usages have also been updated correctly
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))
  • If new assets were added or existing ones were modified, I verified that:
    • The assets are optimized and compressed (for SVG files, run npm run compress-svg)
    • The assets load correctly across all supported platforms.
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user flow.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.

Screenshots/Videos

Android: Native
Nagranie.z.ekranu.2025-12-9.o.11.21.19.mov
Android: mWeb Chrome
Nagranie.z.ekranu.2025-12-9.o.11.23.13.mov
iOS: Native
Simulator.Screen.Recording.-.iPhone.16.Pro.Max.-.2025-12-09.at.11.15.40.mp4
iOS: mWeb Safari
Simulator.Screen.Recording.-.iPhone.16.Pro.Max.-.2025-12-09.at.11.20.01.mp4
MacOS: Chrome / Safari
Nagranie.z.ekranu.2025-12-5.o.15.47.57.mov

@melvin-bot
Copy link

melvin-bot bot commented Dec 5, 2025

Hey, I noticed you changed src/languages/en.ts in a PR from a fork. For security reasons, translations are not generated automatically for PRs from forks.

If you want to automatically generate translations for other locales, an Expensify employee will have to:

  1. Look at the code and make sure there are no malicious changes.
  2. Run the Generate static translations GitHub workflow. If you have write access and the K2 extension, you can simply click: [this button]

Alternatively, if you are an external contributor, you can run the translation script locally with your own OpenAI API key. To learn more, try running:

npx ts-node ./scripts/generateTranslations.ts --help

Typically, you'd want to translate only what you changed by running npx ts-node ./scripts/generateTranslations.ts --compare-ref main

@codecov
Copy link

codecov bot commented Dec 5, 2025

Codecov Report

❌ Looks like you've decreased code coverage for some files. Please write tests to increase, or at least maintain, the existing level of code coverage. See our documentation here for how to interpret this table.

Files with missing lines Coverage Δ
src/selectors/Domain.ts 0.00% <0.00%> (ø)
...in/Saml/SamlConfigurationDetailsSectionContent.tsx 0.00% <0.00%> (ø)
src/pages/domain/Saml/SamlLoginSectionContent.tsx 0.00% <0.00%> (ø)
src/libs/actions/Domain.ts 12.50% <0.00%> (-0.71%) ⬇️
... and 19 files with indirect coverage changes

@OSBotify
Copy link
Contributor

OSBotify commented Dec 9, 2025

🦜 Polyglot Parrot! 🦜

Squawk! Looks like you added some shiny new English strings. Allow me to parrot them back to you in other tongues:

View the translation diff
diff --git a/src/languages/de.ts b/src/languages/de.ts
index 1295dd1f..b76858ea 100644
--- a/src/languages/de.ts
+++ b/src/languages/de.ts
@@ -7870,6 +7870,7 @@ Hier ist ein *Testbeleg*, um dir zu zeigen, wie es funktioniert:`,
             requireError: 'SAML-Anforderungseinstellung konnte nicht aktualisiert werden',
             disableSamlRequired: 'SAML-Anforderung deaktivieren',
             oktaWarningPrompt: 'Bist du sicher? Dadurch wird auch Okta SCIM deaktiviert.',
+            requireWithEmptyMetadataError: 'Bitte fügen Sie unten die Identity-Provider-Metadaten hinzu, um zu aktivieren',
         },
         samlConfigurationDetails: {
             title: 'SAML-Konfigurationsdetails',
diff --git a/src/languages/fr.ts b/src/languages/fr.ts
index 37d4375c..420738c4 100644
--- a/src/languages/fr.ts
+++ b/src/languages/fr.ts
@@ -7878,6 +7878,7 @@ Voici un *reçu test* pour vous montrer comment cela fonctionne :`,
             requireError: 'Impossible de mettre à jour le paramètre d’exigence SAML',
             disableSamlRequired: 'Désactiver l’exigence SAML',
             oktaWarningPrompt: 'Êtes-vous sûr ? Cela désactivera également Okta SCIM.',
+            requireWithEmptyMetadataError: 'Veuillez ajouter les métadonnées du fournisseur d’identité ci-dessous pour activer',
         },
         samlConfigurationDetails: {
             title: 'Détails de configuration SAML',
diff --git a/src/languages/it.ts b/src/languages/it.ts
index db9d5092..ebf147aa 100644
--- a/src/languages/it.ts
+++ b/src/languages/it.ts
@@ -7851,6 +7851,7 @@ Ecco una *ricevuta di prova* per mostrarti come funziona:`,
             requireError: "Impossibile aggiornare l'impostazione dei requisiti SAML",
             disableSamlRequired: 'Disabilita SAML obbligatorio',
             oktaWarningPrompt: 'Sei sicuro? Questo disabiliterà anche Okta SCIM.',
+            requireWithEmptyMetadataError: 'Aggiungi di seguito i metadati del provider di identità per abilitare',
         },
         samlConfigurationDetails: {
             title: 'Dettagli di configurazione SAML',
diff --git a/src/languages/ja.ts b/src/languages/ja.ts
index 90ff5cef..e86de5ee 100644
--- a/src/languages/ja.ts
+++ b/src/languages/ja.ts
@@ -7798,6 +7798,7 @@ Expensify の使い方をお見せするための*テストレシート*がこ
             requireError: 'SAML 必須設定を更新できませんでした',
             disableSamlRequired: 'SAML 必須を無効にする',
             oktaWarningPrompt: 'よろしいですか?これにより Okta SCIM も無効になります。',
+            requireWithEmptyMetadataError: 'Id プロバイダーのメタデータを以下に追加して有効化してください',
         },
         samlConfigurationDetails: {
             title: 'SAML 設定の詳細',
diff --git a/src/languages/nl.ts b/src/languages/nl.ts
index 8c8f029d..0be97b71 100644
--- a/src/languages/nl.ts
+++ b/src/languages/nl.ts
@@ -7836,11 +7836,12 @@ Hier is een *testbon* om je te laten zien hoe het werkt:`,
             requireError: 'Kon de SAML-vereiste-instelling niet bijwerken',
             disableSamlRequired: '‘SAML vereist’ uitschakelen',
             oktaWarningPrompt: 'Weet je het zeker? Dit schakelt ook Okta SCIM uit.',
+            requireWithEmptyMetadataError: 'Voeg hieronder de Identity Provider-metadata toe om in te schakelen',
         },
         samlConfigurationDetails: {
             title: 'SAML-configuratiegegevens',
             subtitle: 'Gebruik deze gegevens om SAML in te stellen.',
-            identityProviderMetadata: 'Identity Provider-meta-gegevens',
+            identityProviderMetadata: 'Metagegevens van identiteitsprovider',
             entityID: 'Entiteit-ID',
             nameIDFormat: 'Naam-ID-indeling',
             loginUrl: 'Login-URL',
diff --git a/src/languages/pl.ts b/src/languages/pl.ts
index 3a85b1a1..a68d43f8 100644
--- a/src/languages/pl.ts
+++ b/src/languages/pl.ts
@@ -7826,6 +7826,7 @@ Oto *paragon testowy*, który pokazuje, jak to działa:`,
             requireError: 'Nie można było zaktualizować ustawienia wymogu SAML',
             disableSamlRequired: 'Wyłącz wymóg SAML',
             oktaWarningPrompt: 'Czy na pewno? Spowoduje to również wyłączenie Okta SCIM.',
+            requireWithEmptyMetadataError: 'Dodaj poniżej metadane dostawcy tożsamości, aby włączyć',
         },
         samlConfigurationDetails: {
             title: 'Szczegóły konfiguracji SAML',
diff --git a/src/languages/pt-BR.ts b/src/languages/pt-BR.ts
index c1def8a7..a24df49d 100644
--- a/src/languages/pt-BR.ts
+++ b/src/languages/pt-BR.ts
@@ -7829,6 +7829,7 @@ Aqui está um *recibo de teste* para mostrar como funciona:`,
             requireError: 'Não foi possível atualizar a configuração de requisito SAML',
             disableSamlRequired: 'Desativar SAML obrigatório',
             oktaWarningPrompt: 'Você tem certeza? Isso também desativará o Okta SCIM.',
+            requireWithEmptyMetadataError: 'Adicione os metadados do Provedor de Identidade abaixo para ativar',
         },
         samlConfigurationDetails: {
             title: 'Detalhes da configuração SAML',
diff --git a/src/languages/zh-hans.ts b/src/languages/zh-hans.ts
index c3c5eee9..dc3f2c91 100644
--- a/src/languages/zh-hans.ts
+++ b/src/languages/zh-hans.ts
@@ -7676,11 +7676,12 @@ ${reportName}
             requireError: '无法更新 SAML 要求设置',
             disableSamlRequired: '禁用 SAML 要求',
             oktaWarningPrompt: '您确定吗?这也会禁用 Okta SCIM。',
+            requireWithEmptyMetadataError: '请在下方添加身份提供商元数据以启用',
         },
         samlConfigurationDetails: {
             title: 'SAML 配置详情',
             subtitle: '使用以下详细信息来完成 SAML 设置。',
-            identityProviderMetadata: '身份提供商元数据',
+            identityProviderMetadata: '身份提供者元数据',
             entityID: '实体 ID',
             nameIDFormat: '名称 ID 格式',
             loginUrl: '登录 URL',

Note

You can apply these changes to your branch by copying the patch to your clipboard, then running pbpaste | git apply 😉

@mhawryluk mhawryluk marked this pull request as ready for review December 9, 2025 10:42
@mhawryluk mhawryluk requested review from a team as code owners December 9, 2025 10:43
@melvin-bot melvin-bot bot requested review from DylanDylann and heyjennahay and removed request for a team December 9, 2025 10:43
@melvin-bot
Copy link

melvin-bot bot commented Dec 9, 2025

@DylanDylann Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

@mhawryluk
Copy link
Contributor Author

cc: @ZhenjaHorbach

@mountiny mountiny requested review from ZhenjaHorbach and mountiny and removed request for DylanDylann December 9, 2025 16:19
@ZhenjaHorbach
Copy link
Contributor

ZhenjaHorbach commented Dec 11, 2025

Reviewer Checklist

  • I have verified the author checklist is complete (all boxes are checked off).
  • I verified the correct issue is linked in the ### Fixed Issues section above
  • I verified testing steps are clear and they cover the changes made in this PR
    • I verified the steps for local testing are in the Tests section
    • I verified the steps for Staging and/or Production testing are in the QA steps section
    • I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
  • I checked that screenshots or videos are included for tests on all platforms
  • I included screenshots or videos for tests on all platforms
  • I verified that the composer does not automatically focus or open the keyboard on mobile unless explicitly intended. This includes checking that returning the app from the background does not unexpectedly open the keyboard.
  • I verified tests pass on all platforms & I tested again on:
    • Android: HybridApp
    • Android: mWeb Chrome
    • iOS: HybridApp
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
  • If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
  • I verified there are no new alerts related to the canBeMissing param for useOnyx
  • I verified proper code patterns were followed (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I verified that this PR follows the guidelines as stated in the Review Guidelines
  • I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.ts or at the top of the file that uses the constant) are defined as such
  • If a new component is created I verified that:
    • A similar component doesn't exist in the codebase
    • All props are defined accurately and each prop has a /** comment above it */
    • The file is named correctly
    • The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
    • The only data being stored in the state is data necessary for rendering and nothing else
    • For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
    • Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
    • All JSX used for rendering exists in the render method
    • The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
  • I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: HybridApp
2025-12-11.10.59.51.mov
Android: mWeb Chrome
2025-12-11.10.59.51.mov
iOS: HybridApp
2025-12-11.10.59.51.mov
iOS: mWeb Safari
2025-12-11.10.59.51.mov
MacOS: Chrome / Safari Снимок экрана 2025-12-11 в 10 54 36

@ZhenjaHorbach
Copy link
Contributor

ZhenjaHorbach commented Dec 11, 2025

Strange
I don't remember when we broke validation for Identity Provider Metadata
And now we can't use html tags

Снимок экрана 2025-12-11 в 10 50 43

@ZhenjaHorbach
Copy link
Contributor

But I know what the problem is
We don't have changes in this branch from this PR

@ZhenjaHorbach
Copy link
Contributor

ZhenjaHorbach commented Dec 11, 2025

When we reopen the screen we still have the Please add Identity Provider metadata below to enable error
I suppose it's better to reset it

2025-12-11.10.52.21.mov

@mhawryluk
Copy link
Contributor Author

When we reopen the screen we still have the Please add Identity Provider metadata below to enable error I suppose it's better to reset it

hmm, if I reset the "samlRequiredError" field when opening the page, it would also reset the errors sent from backend. and since we're doing an optimistic update for the toggle I don't know if that's the desired behavior (like when a user turns on the toggle, then leaves the page, reopens it and sees it being off and if we reset the error, they wouldn't know why). should I separate the error property to only reset the new error from this PR, or is it okay to clear them all, or can we keep all?

@ZhenjaHorbach
Copy link
Contributor

When we reopen the screen we still have the Please add Identity Provider metadata below to enable error I suppose it's better to reset it

hmm, if I reset the "samlRequiredError" field when opening the page, it would also reset the errors sent from backend. and since we're doing an optimistic update for the toggle I don't know if that's the desired behavior (like when a user turns on the toggle, then leaves the page, reopens it and sees it being off and if we reset the error, they wouldn't know why). should I separate the error property to only reset the new error from this PR, or is it okay to clear them all, or can we keep all?

I think it's better to reset all errors

And in this case
I don't think it makes sense to still show an error if we already have a valid metadata value

2025-12-11.11.06.16.mov

@mhawryluk
Copy link
Contributor Author

I made it so the saml required error is reset after submitting an IdP metadata. and also the saml required and enabled errors are now reset when first entering the page.

@ZhenjaHorbach
Copy link
Contributor

LGTM!

@mountiny mountiny requested a review from NikkiWines December 11, 2025 16:55
Copy link
Contributor

@NikkiWines NikkiWines left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice :shipit:

@NikkiWines NikkiWines merged commit f5be6bc into Expensify:main Dec 11, 2025
33 of 34 checks passed
@OSBotify
Copy link
Contributor

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/NikkiWines in version: 9.2.78-0 🚀

platform result
🖥 desktop 🖥 success ✅
🕸 web 🕸 success ✅
🤖 android 🤖 success ✅
🍎 iOS 🍎 success ✅

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/AndrewGable in version: 9.2.78-8 🚀

platform result
🖥 desktop 🖥 success ✅
🕸 web 🕸 success ✅
🤖 android 🤖 success ✅
🍎 iOS 🍎 success ✅

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants