Merge pull request #243 from BridgeDigitalHealth/archiving

Don't serialize AssessmentResults that implement JsonFileArchivableResult
Sage-Bionetworks · Dec 1, 2023 · d05bafa · d05bafa
2 parents b3d70c9 + 51a0746
commit d05bafa
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 10 deletions.
diff --git a/...sdk/src/main/java/org/sagebionetworks/bridge/assessmentmodel/upload/AssessmentArchiver.kt b/...sdk/src/main/java/org/sagebionetworks/bridge/assessmentmodel/upload/AssessmentArchiver.kt
@@ -34,8 +34,6 @@ class AssessmentArchiver(
     private val assessmentResult: Result,
     private val jsonCoder: Json,
     private val bridgeConfig: BridgeConfig,
-    // To serialize assessmentResult as part of archive, include a filename for the result.
-    private val assessmentResultFilename: String? = null // Used when result is of type AssessmentResult
 ) {
 
     private val manifest: MutableSet<ArchiveFileInfo> = mutableSetOf()
@@ -44,6 +42,9 @@ class AssessmentArchiver(
     private var answersSchema: SimpleJsonSchema
 
     init {
+        if (assessmentResult !is AssessmentResult && assessmentResult !is JsonFileArchivableResult) {
+            throw IllegalArgumentException("Result must implement either AssessmentResult or JsonFileArchivableResult")
+        }
         val appVersion = "version ${bridgeConfig.appVersionName}, build ${bridgeConfig.appVersion}"
         val item = assessmentResult.identifier
         archiveBuilder = Archive.Builder.forActivity(item)
@@ -55,9 +56,9 @@ class AssessmentArchiver(
     fun buildArchive() : Archive {
         // Iterate through all the results within this collection and add if they are `JsonFileArchivableResult`.
         recursiveAdd(assessmentResult)
-
         // Add assessment result file to archive
-        if (assessmentResult is AssessmentResult && assessmentResultFilename != null) {
+        if (assessmentResult is AssessmentResult) {
+            val assessmentResultFilename = "assessmentResult.json"
             Logger.d("Writing result for assessment ${assessmentResult.identifier}")
             archiveBuilder.addDataFile(
                 JsonArchiveFile(

diff --git a/...java/org/sagebionetworks/bridge/assessmentmodel/upload/AssessmentResultArchiveUploader.kt b/...java/org/sagebionetworks/bridge/assessmentmodel/upload/AssessmentResultArchiveUploader.kt
@@ -43,14 +43,12 @@ class AssessmentResultArchiveUploader(
      */
     fun archiveResultAndQueueUpload(assessmentResult: Result,
                                     jsonCoder: Json,
-                                    adherenceRecord: AdherenceRecord?,
-                                    assessmentResultFilename: String? = "assessmentResult.json") {
+                                    adherenceRecord: AdherenceRecord?) {
 
         val archiver = AssessmentArchiver(
             assessmentResult = assessmentResult,
             jsonCoder = jsonCoder,
-            bridgeConfig = bridgeConfig,
-            assessmentResultFilename = assessmentResultFilename
+            bridgeConfig = bridgeConfig
         )
 
         val assessmentRunUUID =  if (assessmentResult is AssessmentResult && assessmentResult.runUUIDString.isNotEmpty()) {

diff --git a/...src/test/java/org/sagebionetworks/bridge/assessmentmodel/upload/AssessmentArchiverTest.kt b/...src/test/java/org/sagebionetworks/bridge/assessmentmodel/upload/AssessmentArchiverTest.kt
@@ -161,8 +161,7 @@ class AssessmentArchiverTest {
         val archiver = AssessmentArchiver(
             assessmentResult = assessmentResult,
             jsonCoder = jsonCoder,
-            bridgeConfig = TestBridgeConfig(),
-            assessmentResultFilename = resultFileName
+            bridgeConfig = TestBridgeConfig()
         )
 
         val archive = archiver.buildArchive()