Foorm: Add published state to all forms and add to seed step #37655
Conversation
| @@ -18,6 +18,7 @@ const styles = { | |||
| class FoormEditorManager extends React.Component { | |||
| static propTypes = { | |||
| updateFormQuestions: PropTypes.func, | |||
There was a problem hiding this comment.
Should the updateFormQuestions prop be removed? Or is it used elsewhere?
There was a problem hiding this comment.
Oh it looks like it's still being passed as a prop in apps/src/sites/studio/pages/foorm/editor/index.js -- maybe just help me understand why it's sticking around and most other places language like FormQuestions is being swapped out for FormData?
There was a problem hiding this comment.
good question. The form data is an object in the form {published: true/false, questions: {entire json blob of survey}}, while form questions is the json blob of the survey. We get the form data once when loading a survey, then send around the form questions as the survey author edits them. I can add a comment somewhere to make this clearer.
| @@ -43,12 +43,15 @@ def self.setup | |||
|
|
|||
| # Let's load the JSON text. | |||
| questions = File.read(path) | |||
| # if published is not provided, default to true | |||
| published = questions['published'].nil? ? true : questions['published'] | |||
There was a problem hiding this comment.
Is this necessary? Shouldn't the default you set on the published column coerce it to true?
There was a problem hiding this comment.
Yep, it's necessary. If we leave the value as nil it will treat the value as nil, not change it to the default. The default is only used if no value is provided, so we need to check that the value is provided somewhere.
We added a published column for foorm forms and library questions in this PR. This PR adds a published state for every form and library question, and seeds that data in as part of the seed step. This state will be used to help provide better information to our survey editors. I also updated the API that our editor uses to get the published state, but am not using it in the editor yet. That will be done in a follow-up PR.
Future work
As a follow-up I will add this published state to the editor UI in a more friendly way (currently it is visible in the editor as part of the json). When we add the ability to save forms from the editor we will also want to add the ability to change a survey from draft->published mode without the survey author knowing the json syntax (i.e., a button that says "publish" that will inject the correct json field to the survey configuration). There is also a P1 item to make this published state more than just an FYI for survey authors--we will block viewing of draft surveys on prod, and only allow certain updates to already-published surveys.
Links
Testing story
Tested locally that the forms and library questions seed correctly, and the new published state does not mess up any surveys. Surveyjs ignores all fields it does not know about so there are no issues there.
Reviewer Checklist: