Change log server URL locally #2852
Conversation
avazirna
changed the title
There was a problem hiding this comment.
Few points/questions -
- Can we add a link to the ticket or github issue which is prompting the change
- Are we clear and ok with set of steps one need to take to see this setting in dev options ? (Dev options visibility defer in debug and release builds)
- Have we confirmed with the client that this solution works with them ?
- Is it urgent enough for the client to include in a hotfix ?
| @@ -173,4 +173,9 @@ | |||
| android:entryValues="@array/pref_enabled_vals" | |||
| android:key="cc-enable-certificate-transparency" | |||
| android:title="Certificate Transparency"/> | |||
| <EditTextPreference | |||
| android:defaultValue="@string/logs_server_url_protocol" | |||
There was a problem hiding this comment.
Wondering if user ever sees this defaultValue as an app should always have the log_receiver_url populated ?
There was a problem hiding this comment.
they see it when log_receiver_url is not set, by default the logs URL is the Form Submission log
| || newValue.equals(getString(R.string.logs_server_url_protocol))) { | ||
| SharedPreferences appPreferences = CommCareApplication.instance().getCurrentApp() | ||
| .getAppPreferences(); | ||
| appPreferences.edit().remove(PREFS_LOG_POST_URL_KEY).apply(); |
There was a problem hiding this comment.
think we should be defaulting to the url from app profile xml instead of completely removing it.
There was a problem hiding this comment.
I think this is related to the notion of what is the default URL for the logs submission, right now it seems to be the form submission URL
There was a problem hiding this comment.
yeah we should be defaulting it to form submission url instead of removing it completely.
There was a problem hiding this comment.
@shubham1g5 that would be changing the way this preference is currently used and create redundancy. Right now, it seems that we only set the preference when the logs URL is different from the form submissions URL. Defaulting to the submissions URL and to keep consistency, would require setting it during app installation as well, right?
There was a problem hiding this comment.
@shubham1g5 that was my first impulse as well, but I think it's actually too dangerous to set this redundantly for two reasons.
1 - It introduces a new parity requirement. If we changed the submission URL for form submissions on HQ's end, we'd now need to also change the log URL, but we can't really do that with HQ settings because it'll blow away the config for anyone who's added the custom setting.
2 - From a usability perspective, it's dangerous because the users don't have a super meaningful way currently to know what was in the box for this current UI before. If the Log URL is Empty when you load it, it's clear that setting it back to blank should be the "inverse" that sets things back to neutral. If you load up the field then and its got the HQ default form URL already in it, I think you'd naturally then assume that you need to keep track of that URL so you can set it back if you want to undo the action.
There was a problem hiding this comment.
Defaulting to the submissions URL and to keep consistency, would require setting it during app installation as well, right?
Makes sense, I didn't realise we don't do it already.
we can't really do that with HQ settings because it'll blow away the config for anyone who's added the custom setting.
I am not sure I understand it. My thought was to do this as a one time action at app install time -
-
While Installing app, we populate the
logs_receiver_urlin app preferences by copying it from form submission url. -
When user opens the logs url preference to edit, they would see what this url is pointing to (which would be same as form submission url)
-
User edits the url to some other valid url. We preserve it and show it to user in this preference
-
User edits the url and change is to a non-valid url (empty or something else) -> We show user an error that the change they made is invalid and preserve whatever the old value of the url was.
No strong thoughts here though overall, though with the current change behaviour it's probably better to rename the field from Log Submission Server to Custom Log Submission Server to make it more clear that existing log server is not empty when they see it empty.
Done
Good point, I may have to whitelist this option, let me check.
I got sign-off from this comment about this option. And I think we are still waiting for the client's response about it here.
Given the context around this client, I believe this is the bare minimum to satisfy their request and considering that they are in the middle of investigating the issues, it does seem relevant enough to take this opportunity to roll it out now. |
|
@avazirna I think it's worth confirming briefly that this option can cleanly be set to a different URL, used, then have the custom text deleted, and make sure that the submission reverts to the original receiver. With settings like this where the option is a String value or an empty value, there's always a risk that a blank string setting is treated differently than a null or empty value. |
Yes @ctsims, I tested that scenario a couple of times and also added a listener to remove the preference when |
|
@damagatchi retest this please |
avazirna
force-pushed
the
change-log-submission-url
branch
from
c1a49e8
to
dd17c2c
Compare
|
@damagatchi retest this please |
Summary
This PR adds a new option to the
Developer Optionsmenu that allows users the set a new URL for where CommCare logs should be submitted.Ticket: https://dimagi.atlassian.net/browse/SAAS-15980
Product Description
Users are able to set the URL by typing it in the text box and remove it by leaving the text box blank or with just the default value, which is the protocol
https://.Safety Assurance
Safety story
Local tests were successful but this should also be tested by QA.