Proactively alert user of likely issues in automated SaaS config template updates
adamsachs opened this issue · 0 comments
Is your feature request related to a specific problem?
As discussed in #1098 (comment), if an update is made to a saas connector template that adds a value to its connector_params
, we need to better alert the user that there is a new connector_param
that must be parameterized for their connector instance, by updating the instance's connection config secrets - not doing so will mean they hit unexpected errors when trying to execute a privacy request with the updated connector instance (or it will use the param's default_value
if configured, which the user should still be alerted about).
Similarly, if an automated template update to a DatasetConfig
instance fails for whatever reason, but the instance's SaaSConfig
update succeeded, then the overall connector will be left in a half-upgraded state, likely non-functional. While there would be an error message buried in the logs about this failure, it will be difficult for a user to understand the state they're in.
Describe the solution you'd like
Some more proactive (i.e., better than a log message that gets buried) way of alerting the user to these potential (likely) problems that need remediating.
Perhaps some field on the ConnectionConfig
record that keeps track of problems
that need remediation? That would need to be hooked in to some validation logic that could update the problems
field if/when the issues have been resolved. Haven't thought through this much, just an idea.
(For what it's worth, there's not even currently a log message to indicate the automated addition of a new connector_params
value to a config).
Additional context
We specifically punted on this in #1307 / #1098 to reduce scope and get the initial version of the update logic in place