Merge pull request #3937 from kobotoolbox/formbuilder-handle-deprecat…

…ed-metadata Allow form builder to open forms using deprecated metadata, but then force those metadata to be disabled
kobotoolbox · Jul 14, 2022 · 8760848 · 8760848
2 parents b94aace + 5350fc6
commit 8760848
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 2 deletions.
diff --git a/jsapp/js/components/metadataEditor.es6 b/jsapp/js/components/metadataEditor.es6
@@ -187,12 +187,12 @@ export default class MetadataEditor extends React.Component {
       META_QUESTION_TYPES.start,
       META_QUESTION_TYPES.end,
       META_QUESTION_TYPES.today,
-      META_QUESTION_TYPES.deviceid,
       META_QUESTION_TYPES.audit,
     ];
     const rightColumn = [
       META_QUESTION_TYPES.username,
       META_QUESTION_TYPES.phonenumber,
+      META_QUESTION_TYPES.deviceid,
     ];
 
     let backgroundAudioProp = this.getMetaProperty(

diff --git a/jsapp/xlform/src/model.aliases.coffee b/jsapp/xlform/src/model.aliases.coffee
@@ -78,6 +78,8 @@ module.exports = do ->
       ['start'],
       ['end'],
       ['today'],
+      ['simserial'],
+      ['subscriberid'],
       ['phonenumber', 'phone_number'],
       ['audit'],
     ]

diff --git a/jsapp/xlform/src/model.configs.coffee b/jsapp/xlform/src/model.configs.coffee
@@ -35,6 +35,18 @@ module.exports = do ->
       label: "username"
       description: "includes interviewer's username"
       default: false
+    simserial:
+      name: "simserial"
+      label: "sim serial"
+      description: "records the serial number of the network sim card"
+      default: false
+      deprecated: true
+    subscriberid:
+      name: "subscriberid"
+      label: "subscriber id"
+      description: "records the subscriber id of the sim card"
+      default: false
+      deprecated: true
     deviceid:
       name: "deviceid"
       label: "device id"
@@ -63,6 +75,8 @@ module.exports = do ->
         name: @get("name")
         label: @get("label")
         description: @get("description")
+        default: @get("default")
+        deprecated: @get("deprecated")
 
     class configs.SurveyDetailSchema extends Backbone.Collection
       model: SurveyDetailSchemaItem

diff --git a/jsapp/xlform/src/model.surveyDetail.coffee b/jsapp/xlform/src/model.surveyDetail.coffee
@@ -47,7 +47,12 @@ module.exports = do ->
       if (dtobj = @get(detail.type))
         if detail.parameters
           dtobj.set("parameters", detail.parameters)
-        dtobj.set("value", true)
+        if dtobj.get("deprecated")
+          # …unless the detail (aka metadata) is deprecated, in which case its
+          # value is forced to the default
+          dtobj.set("value", dtobj.get("default"))
+        else
+          dtobj.set("value", true)
       else
         throw new Error("SurveyDetail `#{key}` not loaded from schema. [Aliases have not been implemented]")
       return