Add missing config flow abort strings (#86180)

* Add missing `already_configured` and `already_in_progress` abort strings * Note required strings.json entries in config_entries aborting functions
2025-04-24 17:27:52 +00:00 · 2023-01-24 08:59:32 +02:00 · 2023-01-24 08:59:32 +02:00 · 5f0adfe6e4
commit 5f0adfe6e4
parent 3ec7f0280e
47 changed files with 112 additions and 2 deletions
--- a/homeassistant/components/aurora/strings.json
+++ b/homeassistant/components/aurora/strings.json
@ -10,6 +10,9 @@
        }
      }
    },
+    "abort": {
+      "already_configured": "[%key:common::config_flow::abort::already_configured_service%]"
+    },
    "error": {
      "cannot_connect": "[%key:common::config_flow::error::cannot_connect%]"
    }
--- a/homeassistant/components/aurora/translations/en.json
+++ b/homeassistant/components/aurora/translations/en.json
@ -1,5 +1,8 @@
 {
    "config": {
+        "abort": {
+            "already_configured": "Service is already configured"
+        },
        "error": {
            "cannot_connect": "Failed to connect"
        },
--- a/homeassistant/components/dnsip/strings.json
+++ b/homeassistant/components/dnsip/strings.json
@ -22,6 +22,9 @@
        }
      }
    },
+    "abort": {
+      "already_configured": "[%key:common::config_flow::abort::already_configured_service%]"
+    },
    "error": {
      "invalid_resolver": "Invalid IP address for resolver"
    }
--- a/homeassistant/components/dnsip/translations/en.json
+++ b/homeassistant/components/dnsip/translations/en.json
@ -14,6 +14,9 @@
        }
    },
    "options": {
+        "abort": {
+            "already_configured": "Service is already configured"
+        },
        "error": {
            "invalid_resolver": "Invalid IP address for resolver"
        },
--- a/homeassistant/components/environment_canada/strings.json
+++ b/homeassistant/components/environment_canada/strings.json
@ -12,6 +12,9 @@
        }
      }
    },
+    "abort": {
+      "already_configured": "[%key:common::config_flow::abort::already_configured_service%]"
+    },
    "error": {
      "bad_station_id": "Station ID is invalid, missing, or not found in the station ID database",
      "cannot_connect": "[%key:common::config_flow::error::cannot_connect%]",
--- a/homeassistant/components/environment_canada/translations/en.json
+++ b/homeassistant/components/environment_canada/translations/en.json
@ -1,5 +1,8 @@
 {
    "config": {
+        "abort": {
+            "already_configured": "Service is already configured"
+        },
        "error": {
            "bad_station_id": "Station ID is invalid, missing, or not found in the station ID database",
            "cannot_connect": "Failed to connect",
--- a/homeassistant/components/epson/strings.json
+++ b/homeassistant/components/epson/strings.json
@ -8,6 +8,9 @@
        }
      }
    },
+    "abort": {
+      "already_configured": "[%key:common::config_flow::abort::already_configured_device%]"
+    },
    "error": {
      "cannot_connect": "[%key:common::config_flow::error::cannot_connect%]",
      "powered_off": "Is projector turned on? You need to turn on projector for initial configuration."
--- a/homeassistant/components/epson/translations/en.json
+++ b/homeassistant/components/epson/translations/en.json
@ -1,5 +1,8 @@
 {
    "config": {
+        "abort": {
+            "already_configured": "Device is already configured"
+        },
        "error": {
            "cannot_connect": "Failed to connect",
            "powered_off": "Is projector turned on? You need to turn on projector for initial configuration."
--- a/homeassistant/components/growatt_server/strings.json
+++ b/homeassistant/components/growatt_server/strings.json
@ -1,6 +1,7 @@
 {
  "config": {
    "abort": {
+      "already_configured": "[%key:common::config_flow::abort::already_configured_device%]",
      "no_plants": "No plants have been found on this account"
    },
    "error": {
--- a/homeassistant/components/growatt_server/translations/en.json
+++ b/homeassistant/components/growatt_server/translations/en.json
@ -1,6 +1,7 @@
 {
    "config": {
        "abort": {
+            "already_configured": "Device is already configured",
            "no_plants": "No plants have been found on this account"
        },
        "error": {
--- a/homeassistant/components/habitica/strings.json
+++ b/homeassistant/components/habitica/strings.json
@ -1,5 +1,8 @@
 {
  "config": {
+    "abort": {
+      "already_configured": "[%key:common::config_flow::abort::already_configured_account%]"
+    },
    "error": {
      "invalid_credentials": "[%key:common::config_flow::error::invalid_auth%]",
      "unknown": "[%key:common::config_flow::error::unknown%]"
--- a/homeassistant/components/habitica/translations/en.json
+++ b/homeassistant/components/habitica/translations/en.json
@ -1,5 +1,8 @@
 {
    "config": {
+        "abort": {
+            "already_configured": "Account is already configured"
+        },
        "error": {
            "invalid_credentials": "Invalid authentication",
            "unknown": "Unexpected error"
--- a/homeassistant/components/huawei_lte/strings.json
+++ b/homeassistant/components/huawei_lte/strings.json
@ -1,6 +1,8 @@
 {
  "config": {
    "abort": {
+      "already_configured": "[%key:common::config_flow::abort::already_configured_device%]",
+      "already_in_progress": "[%key:common::config_flow::abort::already_in_progress%]",
      "reauth_successful": "[%key:common::config_flow::abort::reauth_successful%]",
      "unsupported_device": "Unsupported device"
    },
--- a/homeassistant/components/huawei_lte/translations/en.json
+++ b/homeassistant/components/huawei_lte/translations/en.json
@ -1,6 +1,8 @@
 {
    "config": {
        "abort": {
+            "already_configured": "Device is already configured",
+            "already_in_progress": "Configuration flow is already in progress",
            "reauth_successful": "Re-authentication was successful",
            "unsupported_device": "Unsupported device"
        },
--- a/homeassistant/components/jellyfin/strings.json
+++ b/homeassistant/components/jellyfin/strings.json
@ -15,6 +15,7 @@
      "unknown": "[%key:common::config_flow::error::unknown%]"
    },
    "abort": {
+      "already_configured": "[%key:common::config_flow::abort::already_configured_account%]",
      "single_instance_allowed": "[%key:common::config_flow::abort::single_instance_allowed%]"
    }
  }
--- a/homeassistant/components/jellyfin/translations/en.json
+++ b/homeassistant/components/jellyfin/translations/en.json
@ -1,6 +1,7 @@
 {
    "config": {
        "abort": {
+            "already_configured": "Account is already configured",
            "single_instance_allowed": "Already configured. Only a single configuration possible."
        },
        "error": {
--- a/homeassistant/components/laundrify/strings.json
+++ b/homeassistant/components/laundrify/strings.json
@ -19,6 +19,7 @@
      "unknown": "[%key:common::config_flow::error::unknown%]"
    },
    "abort": {
+      "already_configured": "[%key:common::config_flow::abort::already_configured_account%]",
      "single_instance_allowed": "[%key:common::config_flow::abort::single_instance_allowed%]"
    }
  }
--- a/homeassistant/components/laundrify/translations/en.json
+++ b/homeassistant/components/laundrify/translations/en.json
@ -1,6 +1,7 @@
 {
    "config": {
        "abort": {
+            "already_configured": "Account is already configured",
            "single_instance_allowed": "Already configured. Only a single configuration possible."
        },
        "error": {
--- a/homeassistant/components/meater/strings.json
+++ b/homeassistant/components/meater/strings.json
@ -18,6 +18,9 @@
        }
      }
    },
+    "abort": {
+      "already_configured": "[%key:common::config_flow::abort::already_configured_account%]"
+    },
    "error": {
      "invalid_auth": "[%key:common::config_flow::error::invalid_auth%]",
      "unknown_auth_error": "[%key:common::config_flow::error::unknown%]",
--- a/homeassistant/components/meater/translations/en.json
+++ b/homeassistant/components/meater/translations/en.json
@ -1,5 +1,8 @@
 {
    "config": {
+        "abort": {
+            "already_configured": "Account is already configured"
+        },
        "error": {
            "invalid_auth": "Invalid authentication",
            "service_unavailable_error": "The API is currently unavailable, please try again later.",
--- a/homeassistant/components/melnor/strings.json
+++ b/homeassistant/components/melnor/strings.json
@ -1,6 +1,7 @@
 {
  "config": {
    "abort": {
+      "already_configured": "[%key:common::config_flow::abort::already_configured_device%]",
      "no_devices_found": "There aren't any Melnor Bluetooth devices nearby."
    },
    "step": {
--- a/homeassistant/components/melnor/translations/en.json
+++ b/homeassistant/components/melnor/translations/en.json
@ -1,6 +1,7 @@
 {
    "config": {
        "abort": {
+            "already_configured": "Device is already configured",
            "no_devices_found": "There aren't any Melnor Bluetooth devices nearby."
        },
        "step": {
--- a/homeassistant/components/nuki/strings.json
+++ b/homeassistant/components/nuki/strings.json
@ -22,6 +22,7 @@
      "unknown": "[%key:common::config_flow::error::unknown%]"
    },
    "abort": {
+      "already_configured": "[%key:common::config_flow::abort::already_configured_device%]",
      "reauth_successful": "[%key:common::config_flow::abort::reauth_successful%]"
    }
  }
--- a/homeassistant/components/nuki/translations/en.json
+++ b/homeassistant/components/nuki/translations/en.json
@ -1,6 +1,7 @@
 {
    "config": {
        "abort": {
+            "already_configured": "Device is already configured",
            "reauth_successful": "Re-authentication was successful"
        },
        "error": {
--- a/homeassistant/components/omnilogic/strings.json
+++ b/homeassistant/components/omnilogic/strings.json
@ -14,6 +14,7 @@
      "unknown": "[%key:common::config_flow::error::unknown%]"
    },
    "abort": {
+      "already_configured": "[%key:common::config_flow::abort::already_configured_account%]",
      "single_instance_allowed": "[%key:common::config_flow::abort::single_instance_allowed%]"
    }
  },
--- a/homeassistant/components/omnilogic/translations/en.json
+++ b/homeassistant/components/omnilogic/translations/en.json
@ -1,6 +1,7 @@
 {
    "config": {
        "abort": {
+            "already_configured": "Account is already configured",
            "single_instance_allowed": "Already configured. Only a single configuration possible."
        },
        "error": {
--- a/homeassistant/components/open_meteo/strings.json
+++ b/homeassistant/components/open_meteo/strings.json
@ -7,6 +7,9 @@
          "zone": "Zone"
        }
      }
+    },
+    "abort": {
+      "already_configured": "[%key:common::config_flow::abort::already_configured_service%]"
    }
  }
 }
--- a/homeassistant/components/open_meteo/translations/en.json
+++ b/homeassistant/components/open_meteo/translations/en.json
@ -1,5 +1,8 @@
 {
    "config": {
+        "abort": {
+            "already_configured": "Service is already configured"
+        },
        "step": {
            "user": {
                "data": {
--- a/homeassistant/components/pvoutput/strings.json
+++ b/homeassistant/components/pvoutput/strings.json
@ -20,6 +20,7 @@
      "invalid_auth": "[%key:common::config_flow::error::invalid_auth%]"
    },
    "abort": {
+      "already_configured": "[%key:common::config_flow::abort::already_configured_device%]",
      "reauth_successful": "[%key:common::config_flow::abort::reauth_successful%]"
    }
  }
--- a/homeassistant/components/pvoutput/translations/en.json
+++ b/homeassistant/components/pvoutput/translations/en.json
@ -1,6 +1,7 @@
 {
    "config": {
        "abort": {
+            "already_configured": "Device is already configured",
            "reauth_successful": "Re-authentication was successful"
        },
        "error": {
--- a/homeassistant/components/rainbird/strings.json
+++ b/homeassistant/components/rainbird/strings.json
@ -10,6 +10,9 @@
        }
      }
    },
+    "abort": {
+      "already_configured": "[%key:common::config_flow::abort::already_configured_device%]"
+    },
    "error": {
      "cannot_connect": "[%key:common::config_flow::error::cannot_connect%]",
      "timeout_connect": "[%key:common::config_flow::error::timeout_connect%]"
--- a/homeassistant/components/rainbird/translations/en.json
+++ b/homeassistant/components/rainbird/translations/en.json
@ -1,5 +1,8 @@
 {
    "config": {
+        "abort": {
+            "already_configured": "Device is already configured"
+        },
        "error": {
            "cannot_connect": "Failed to connect",
            "timeout_connect": "Timeout establishing connection"
--- a/homeassistant/components/rdw/strings.json
+++ b/homeassistant/components/rdw/strings.json
@ -7,6 +7,9 @@
        }
      }
    },
+    "abort": {
+      "already_configured": "[%key:common::config_flow::abort::already_configured_service%]"
+    },
    "error": {
      "cannot_connect": "[%key:common::config_flow::error::cannot_connect%]",
      "unknown_license_plate": "Unknown license plate"
--- a/homeassistant/components/rdw/translations/en.json
+++ b/homeassistant/components/rdw/translations/en.json
@ -1,5 +1,8 @@
 {
    "config": {
+        "abort": {
+            "already_configured": "Service is already configured"
+        },
        "error": {
            "cannot_connect": "Failed to connect",
            "unknown_license_plate": "Unknown license plate"
--- a/homeassistant/components/sia/strings.json
+++ b/homeassistant/components/sia/strings.json
@ -24,6 +24,9 @@
        "title": "Add another account to the current port."
      }
    },
+    "abort": {
+      "already_configured": "[%key:common::config_flow::abort::already_configured_device%]"
+    },
    "error": {
      "invalid_key_format": "The key is not a hex value, please use only 0-9 and A-F.",
      "invalid_key_length": "The key is not the right length, it has to be 16, 24 or 32 hex characters.",
--- a/homeassistant/components/sia/translations/en.json
+++ b/homeassistant/components/sia/translations/en.json
@ -1,5 +1,8 @@
 {
    "config": {
+        "abort": {
+            "already_configured": "Device is already configured"
+        },
        "error": {
            "invalid_account_format": "The account is not a hex value, please use only 0-9 and A-F.",
            "invalid_account_length": "The account is not the right length, it has to be between 3 and 16 characters.",
--- a/homeassistant/components/solax/strings.json
+++ b/homeassistant/components/solax/strings.json
@ -9,6 +9,9 @@
        }
      }
    },
+    "abort": {
+      "already_configured": "[%key:common::config_flow::abort::already_configured_device%]"
+    },
    "error": {
      "cannot_connect": "[%key:common::config_flow::error::cannot_connect%]",
      "unknown": "[%key:common::config_flow::error::unknown%]"
--- a/homeassistant/components/solax/translations/en.json
+++ b/homeassistant/components/solax/translations/en.json
@ -1,5 +1,8 @@
 {
    "config": {
+        "abort": {
+            "already_configured": "Device is already configured"
+        },
        "error": {
            "cannot_connect": "Failed to connect",
            "unknown": "Unexpected error"
--- a/homeassistant/components/tailscale/strings.json
+++ b/homeassistant/components/tailscale/strings.json
@ -20,6 +20,7 @@
      "invalid_auth": "[%key:common::config_flow::error::invalid_auth%]"
    },
    "abort": {
+      "already_configured": "[%key:common::config_flow::abort::already_configured_service%]",
      "reauth_successful": "[%key:common::config_flow::abort::reauth_successful%]"
    }
  }
--- a/homeassistant/components/tailscale/translations/en.json
+++ b/homeassistant/components/tailscale/translations/en.json
@ -1,6 +1,7 @@
 {
    "config": {
        "abort": {
+            "already_configured": "Service is already configured",
            "reauth_successful": "Re-authentication was successful"
        },
        "error": {
--- a/homeassistant/components/tomorrowio/strings.json
+++ b/homeassistant/components/tomorrowio/strings.json
@ -10,6 +10,9 @@
        }
      }
    },
+    "abort": {
+      "already_configured": "[%key:common::config_flow::abort::already_configured_service%]"
+    },
    "error": {
      "cannot_connect": "[%key:common::config_flow::error::cannot_connect%]",
      "invalid_api_key": "[%key:common::config_flow::error::invalid_api_key%]",
--- a/homeassistant/components/tomorrowio/translations/en.json
+++ b/homeassistant/components/tomorrowio/translations/en.json
@ -1,5 +1,8 @@
 {
    "config": {
+        "abort": {
+            "already_configured": "Service is already configured"
+        },
        "error": {
            "cannot_connect": "Failed to connect",
            "invalid_api_key": "Invalid API key",
--- a/homeassistant/components/vera/strings.json
+++ b/homeassistant/components/vera/strings.json
@ -1,6 +1,7 @@
 {
  "config": {
    "abort": {
+      "already_configured": "[%key:common::config_flow::abort::already_configured_device%]",
      "cannot_connect": "Could not connect to controller with URL {base_url}"
    },
    "step": {
--- a/homeassistant/components/vera/translations/en.json
+++ b/homeassistant/components/vera/translations/en.json
@ -1,6 +1,7 @@
 {
    "config": {
        "abort": {
+            "already_configured": "Device is already configured",
            "cannot_connect": "Could not connect to controller with URL {base_url}"
        },
        "step": {
--- a/homeassistant/components/whirlpool/strings.json
+++ b/homeassistant/components/whirlpool/strings.json
@ -8,6 +8,9 @@
        }
      }
    },
+    "abort": {
+      "already_configured": "[%key:common::config_flow::abort::already_configured_account%]"
+    },
    "error": {
      "cannot_connect": "[%key:common::config_flow::error::cannot_connect%]",
      "invalid_auth": "[%key:common::config_flow::error::invalid_auth%]",
--- a/homeassistant/components/whirlpool/translations/en.json
+++ b/homeassistant/components/whirlpool/translations/en.json
@ -1,5 +1,8 @@
 {
    "config": {
+        "abort": {
+            "already_configured": "Account is already configured"
+        },
        "error": {
            "cannot_connect": "Failed to connect",
            "invalid_auth": "Invalid authentication",
--- a/homeassistant/config_entries.py
+++ b/homeassistant/config_entries.py
@ -1455,7 +1455,10 @@ class ConfigFlow(data_entry_flow.FlowHandler):
    def _async_abort_entries_match(
        self, match_dict: dict[str, Any] | None = None
    ) -> None:
-        """Abort if current entries match all data."""
+        """Abort if current entries match all data.
+
+        Requires `already_configured` in strings.json in user visible flows.
+        """
        if match_dict is None:
            match_dict = {}  # Match any entry
        for entry in self._async_current_entries(include_ignore=False):
@ -1477,7 +1480,11 @@ class ConfigFlow(data_entry_flow.FlowHandler):
        *,
        error: str = "already_configured",
    ) -> None:
-        """Abort if the unique ID is already configured."""
+        """Abort if the unique ID is already configured.
+
+        Requires strings.json entry corresponding to the `error` parameter
+        in user visible flows.
+        """
        if self.unique_id is None:
            return

@ -1619,6 +1626,9 @@ class ConfigFlow(data_entry_flow.FlowHandler):
        when the handler has no existing config entries.

        It ensures that the discovery can be ignored by the user.
+
+        Requires `already_configured` and `already_in_progress` in strings.json
+        in user visible flows.
        """
        if self.unique_id is not None:
            return