Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Restrict editing of QuestionnaireResopnse to when saving draft is enabled #3723

Merged
merged 3 commits into from
Mar 5, 2025
Merged

Restrict editing of QuestionnaireResopnse to when saving draft is enabled #3723

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
29f8eb8
Restrict editing of QuestionnaireResopnse to when saving draft is ena…
Rkareko Mar 4, 2025
9118f8e
Add tests
Rkareko Mar 4, 2025
e79f3d5
Run spotless Apply
Rkareko Mar 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion ...src/main/java/org/smartregister/fhircore/quest/ui/questionnaire/QuestionnaireViewModel.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1208,7 +1208,13 @@ constructor(
)
?.let {
QuestionnaireResponse().apply {
id = it.id
/**
* Only set the ID value when [saveDraft] is set to true] this ensues that a new
* [QuestionnaireResponse] is generated when the questionnaire is submitted
*/
if (questionnaireConfig.saveDraft) {
id = it.id
}
status = it.status
item = it.item.removeUnAnsweredItems()
// Clearing the text prompts the SDK to re-process the content, which includes HTML
Expand Down
235 changes: 163 additions & 72 deletions ...test/java/org/smartregister/fhircore/quest/ui/questionnaire/QuestionnaireViewModelTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2171,85 +2171,176 @@ class QuestionnaireViewModelTest : RobolectricTest() {
}

@Test
fun testThatPopulateQuestionnaireReturnsQuestionnaireResponseWithIdValue() = runTest {
val questionnaireViewModelInstance =
QuestionnaireViewModel(
defaultRepository = defaultRepository,
dispatcherProvider = dispatcherProvider,
fhirCarePlanGenerator = fhirCarePlanGenerator,
rulesExecutor = rulesExecutor,
transformSupportServices = mockk(),
sharedPreferencesHelper = sharedPreferencesHelper,
fhirOperator = fhirOperator,
fhirValidatorRequestHandlerProvider = fhirValidatorRequestHandlerProvider,
fhirPathDataExtractor = fhirPathDataExtractor,
configurationRegistry = configurationRegistry,
)
val questionnaireConfig1 =
questionnaireConfig.copy(
resourceType = ResourceType.Patient,
resourceIdentifier = patient.logicalId,
type = QuestionnaireType.EDIT.name,
)
fun testThatPopulateQuestionnaireReturnsQuestionnaireResponseWithIdValueWhenSaveDraftIsTrue() =
runTest {
val questionnaireViewModelInstance =
QuestionnaireViewModel(
defaultRepository = defaultRepository,
dispatcherProvider = dispatcherProvider,
fhirCarePlanGenerator = fhirCarePlanGenerator,
rulesExecutor = rulesExecutor,
transformSupportServices = mockk(),
sharedPreferencesHelper = sharedPreferencesHelper,
fhirOperator = fhirOperator,
fhirValidatorRequestHandlerProvider = fhirValidatorRequestHandlerProvider,
fhirPathDataExtractor = fhirPathDataExtractor,
configurationRegistry = configurationRegistry,
)
val questionnaireConfig1 =
questionnaireConfig.copy(
resourceType = ResourceType.Patient,
resourceIdentifier = patient.logicalId,
type = QuestionnaireType.EDIT.name,
saveDraft = true,
)

val questionnaireWithInitialValue =
Questionnaire().apply {
id = questionnaireConfig1.id
addItem(
QuestionnaireItemComponent().apply {
linkId = "group-1"
type = Questionnaire.QuestionnaireItemType.GROUP
addItem(
QuestionnaireItemComponent().apply {
linkId = "linkid-1"
type = Questionnaire.QuestionnaireItemType.STRING
addInitial(Questionnaire.QuestionnaireItemInitialComponent(StringType("---")))
},
)
},
val questionnaireWithInitialValue =
Questionnaire().apply {
id = questionnaireConfig1.id
addItem(
QuestionnaireItemComponent().apply {
linkId = "group-1"
type = Questionnaire.QuestionnaireItemType.GROUP
addItem(
QuestionnaireItemComponent().apply {
linkId = "linkid-1"
type = Questionnaire.QuestionnaireItemType.STRING
addInitial(Questionnaire.QuestionnaireItemInitialComponent(StringType("---")))
},
)
},
)

addItem(
QuestionnaireItemComponent().apply {
linkId = "linkid-2"
type = Questionnaire.QuestionnaireItemType.STRING
},
)
}
val qrId = "qr-id-1"
val questionnaireResponse =
QuestionnaireResponse().apply {
id = qrId
addItem(
QuestionnaireResponse.QuestionnaireResponseItemComponent().apply {
linkId = "group-1"
addItem(
QuestionnaireResponse.QuestionnaireResponseItemComponent().apply {
linkId = "linkid-1"
},
)
},
)
}
coEvery {
fhirEngine.get(
questionnaireConfig1.resourceType!!,
questionnaireConfig1.resourceIdentifier!!,
)
} returns patient

addItem(
QuestionnaireItemComponent().apply {
linkId = "linkid-2"
type = Questionnaire.QuestionnaireItemType.STRING
},
coEvery { fhirEngine.search<QuestionnaireResponse>(any<Search>()) } returns
listOf(
SearchResult(questionnaireResponse, included = null, revIncluded = null),
)
}
val qrId = "qr-id-1"
val questionnaireResponse =
QuestionnaireResponse().apply {
id = qrId
addItem(
QuestionnaireResponse.QuestionnaireResponseItemComponent().apply {
linkId = "group-1"
addItem(
QuestionnaireResponse.QuestionnaireResponseItemComponent().apply {
linkId = "linkid-1"
},
)
},

Assert.assertNotNull(questionnaireResponse.find("linkid-1"))
val result =
questionnaireViewModelInstance.populateQuestionnaire(
questionnaireWithInitialValue,
questionnaireConfig1,
emptyList(),
)
}
coEvery {
fhirEngine.get(questionnaireConfig1.resourceType!!, questionnaireConfig1.resourceIdentifier!!)
} returns patient
Assert.assertNotNull(result.first)
Assert.assertEquals(qrId, result.first!!.id)
}

coEvery { fhirEngine.search<QuestionnaireResponse>(any<Search>()) } returns
listOf(
SearchResult(questionnaireResponse, included = null, revIncluded = null),
)
@Test
fun testThatPopulateQuestionnaireReturnsQuestionnaireResponseWithoutIdValueWhenSaveDraftIsFalse() =
runTest {
val questionnaireViewModelInstance =
QuestionnaireViewModel(
defaultRepository = defaultRepository,
dispatcherProvider = dispatcherProvider,
fhirCarePlanGenerator = fhirCarePlanGenerator,
rulesExecutor = rulesExecutor,
transformSupportServices = mockk(),
sharedPreferencesHelper = sharedPreferencesHelper,
fhirOperator = fhirOperator,
fhirValidatorRequestHandlerProvider = fhirValidatorRequestHandlerProvider,
fhirPathDataExtractor = fhirPathDataExtractor,
configurationRegistry = configurationRegistry,
)
val questionnaireConfig1 =
questionnaireConfig.copy(
resourceType = ResourceType.Patient,
resourceIdentifier = patient.logicalId,
type = QuestionnaireType.EDIT.name,
saveDraft = false,
)

Assert.assertNotNull(questionnaireResponse.find("linkid-1"))
val result =
questionnaireViewModelInstance.populateQuestionnaire(
questionnaireWithInitialValue,
questionnaireConfig1,
emptyList(),
)
Assert.assertNotNull(result.first)
Assert.assertEquals(qrId, result.first!!.id)
}
val questionnaireWithInitialValue =
Questionnaire().apply {
id = questionnaireConfig1.id
addItem(
QuestionnaireItemComponent().apply {
linkId = "group-1"
type = Questionnaire.QuestionnaireItemType.GROUP
addItem(
QuestionnaireItemComponent().apply {
linkId = "linkid-1"
type = Questionnaire.QuestionnaireItemType.STRING
addInitial(Questionnaire.QuestionnaireItemInitialComponent(StringType("---")))
},
)
},
)

addItem(
QuestionnaireItemComponent().apply {
linkId = "linkid-2"
type = Questionnaire.QuestionnaireItemType.STRING
},
)
}
val qrId = "qr-id-1"
val questionnaireResponse =
QuestionnaireResponse().apply {
id = qrId
addItem(
QuestionnaireResponse.QuestionnaireResponseItemComponent().apply {
linkId = "group-1"
addItem(
QuestionnaireResponse.QuestionnaireResponseItemComponent().apply {
linkId = "linkid-1"
},
)
},
)
}
coEvery {
fhirEngine.get(
questionnaireConfig1.resourceType!!,
questionnaireConfig1.resourceIdentifier!!,
)
} returns patient

coEvery { fhirEngine.search<QuestionnaireResponse>(any<Search>()) } returns
listOf(
SearchResult(questionnaireResponse, included = null, revIncluded = null),
)

Assert.assertNotNull(questionnaireResponse.find("linkid-1"))
val result =
questionnaireViewModelInstance.populateQuestionnaire(
questionnaireWithInitialValue,
questionnaireConfig1,
emptyList(),
)
Assert.assertNotNull(result.first)
Assert.assertNull(result.first?.id)
}

@Test
fun testProcessRepeatGroupItems() {
Expand Down
Loading