Activity flow api changes. #2476

aditya-07 · 2024-03-14T14:42:00Z

IMPORTANT: All PRs must be linked to an issue (except for extremely trivial and straightforward changes).

Description
Api for creating a flow to move a request through various phases of an ActivityFlow.

The class ActivityFlow has two main functionalities:

Allow users to get access to the current Phase.
Allow users to move to next phase of the activity flow.
To move to the next phase, user may first call the api to create a draft Resource for the new phase and then start that phase. These correspond with the begin and end api of the ActivityFlow.
e.g. ActivityFlow.draftPlan corresponds to beginPlan and ActivityFlow.startPlan corresponds to endPlan .

The Phase class has two distinct hierarchies RequestPhase and EventPhase each with unique apis to allow valid state transitions for Request based phases (Proposal, Plan and Order) and Event based phases (Perform) respectively.

ActivityFlow provides various ActivityFlow.of static api to help user create ActivityFlow for particular activities with particular request or event types.

Alternative(s) considered
Have you considered any alternatives? And if so, why have you chosen the approach in this PR?

Screenshots (if applicable)

Checklist

I have read and acknowledged the Code of conduct.
I have read the Contributing page.
I have signed the Google Individual CLA, or I am covered by my company's Corporate CLA.
I have discussed my proposed solution with code owners in the linked issue(s) and we have agreed upon the general approach.
I have run ./gradlew spotlessApply and ./gradlew spotlessCheck to check my code follows the style guide of this project.
I have run ./gradlew check and ./gradlew connectedCheck to test my changes locally.
I have built and run the demo app(s) to verify my change fixes the issue and/or does not break the demo app(s).

… perform is called

MJ1998

This looks great!
Requesting few small changes .

workflow/src/main/java/com/google/android/fhir/workflow/activity/ActivityFlow.kt

workflow/src/main/java/com/google/android/fhir/workflow/activity/request/CPGRequestResource.kt

workflow/src/main/java/com/google/android/fhir/workflow/activity/event/CPGEventResource.kt

...n/java/com/google/android/fhir/workflow/activity/event/CPGEventResourceForOrderMedication.kt

workflow/src/main/java/com/google/android/fhir/workflow/activity/event/CPGCaseEvent.kt

MJ1998 · 2024-08-05T08:40:27Z

...w/src/main/java/com/google/android/fhir/workflow/activity/request/CPGProposeDiagnosisTask.kt

+
+import org.hl7.fhir.r4.model.Task
+
+class CPGProposeDiagnosisTask(override val resource: Task) : CPGTaskRequest(resource) {


Similarly for other TaskRequest resources

Suggested change

class CPGProposeDiagnosisTask(override val resource: Task) : CPGTaskRequest(resource) {

class CPGProposeDiagnosisTaskRequest(override val resource: Task) : CPGTaskRequest(resource) {

workflow/src/main/java/com/google/android/fhir/workflow/activity/ActivityFlow.kt

workflow/src/main/java/com/google/android/fhir/workflow/activity/ActivityFlowPhases.kt

FikriMilano · 2024-08-25T11:57:59Z

workflow/src/main/java/com/google/android/fhir/workflow/activity/event/CPGEventResource.kt

+enum class EventStatus(val code: String) {
+  PREPARATION("preparation"),
+  INPROGRESS("in-progress"),
+  CANCELLED("not-done"),


Suggested change

CANCELLED("not-done"),

CANCELLED("cancelled"),

FikriMilano · 2024-08-25T11:59:28Z

workflow/src/main/java/com/google/android/fhir/workflow/activity/event/CPGEventResource.kt

+  COMPLETED("completed"),
+  ENTEREDINERROR("entered-in-error"),
+  STOPPED("stopped"),
+  DECLINED("decline"),


Suggested change

DECLINED("decline"),

DECLINED("declined"),

FikriMilano · 2024-08-25T12:00:05Z

workflow/src/main/java/com/google/android/fhir/workflow/activity/event/CPGEventResource.kt

+      when (code) {
+        "preparation" -> PREPARATION
+        "in-progress" -> INPROGRESS
+        "not-done" -> CANCELLED


Suggested change

"not-done" -> CANCELLED

"cancelled" -> CANCELLED

FikriMilano · 2024-08-25T12:00:25Z

workflow/src/main/java/com/google/android/fhir/workflow/activity/event/CPGEventResource.kt

+        "completed" -> COMPLETED
+        "entered-in-error" -> ENTEREDINERROR
+        "stopped" -> STOPPED
+        "decline" -> DECLINED


Suggested change

"decline" -> DECLINED

"declined" -> DECLINED

FikriMilano · 2024-08-25T12:01:51Z

workflow/src/main/java/com/google/android/fhir/workflow/activity/event/CPGEventResource.kt

+
+  companion object {
+
+    fun of(code: String) =


This case is missing

Suggested change

fun of(code: String) =

"not-done" -> NOTDONE

…e classes

jingtang10

can you add a page in the doc folder?

workflow/src/test/java/com/google/android/fhir/workflow/activity/ActivityFlowTest.kt

...c/main/java/com/google/android/fhir/workflow/activity/resource/request/CPGRequestResource.kt

workflow/build.gradle.kts

workflow/src/main/java/com/google/android/fhir/workflow/activity/ActivityFlow.kt

workflow/src/main/java/com/google/android/fhir/workflow/activity/phase/request/PlanPhase.kt

workflow/src/main/java/com/google/android/fhir/workflow/activity/resource/event/CPGCaseEvent.kt

workflow/src/main/java/com/google/android/fhir/workflow/activity/ActivityFlow.kt

jingtang10

just noting comments from bryn:

Can we change "draft" to "prepare"
Can we change "start" to "submit"
Can we change "resume" in the test cases to "continue"?

MJ1998

Thanks Aditya for the changes.
2 main concerns:-

Should we consider making the operations asynchronous ? Since we are dealing with Repository it only makes sense to do the operations in a IO coroutine. Suggesting to make the initiate and update methods suspend functions.
Do you think we should add a rollback api ? If there are errors in later phases one might want to rollback. To do this we could maintain a stack pf phases instead of only the currentPhase.

MJ1998 · 2024-09-17T16:16:01Z

workflow/src/main/java/com/google/android/fhir/workflow/activity/ActivityFlow.kt

+  /**
+   * Creates a draft plan resource based on the state of the [currentPhase].
+   *
+   * @return [R] if the action is successful, error otherwise.


Correct the return kdoc.

Suggested change

* @return [R] if the action is successful, error otherwise.

* @return [Result]<R> containing the draft plan resource if the action is successful, [Result.failure] otherwise.

MJ1998 · 2024-09-17T16:17:56Z

workflow/src/main/java/com/google/android/fhir/workflow/activity/ActivityFlow.kt

+  /**
+   * Creates a draft order resource based on the state of the [currentPhase].
+   *
+   * @return [R] if the action is successful, error otherwise.


Correct the return kdoc like above and other places.

MJ1998 · 2024-09-17T16:19:36Z

workflow/src/main/java/com/google/android/fhir/workflow/activity/ActivityFlow.kt

+@Suppress(
+  "UnstableApiUsage", /* Repository is marked @Beta */
+)
+class ActivityFlow<R : CPGRequestResource<*>, E : CPGEventResource<*>>


Can you comment on thread-safety of this class ?

MJ1998 · 2024-09-17T16:26:53Z

workflow/src/test/java/com/google/android/fhir/workflow/activity/ActivityFlowTest.kt

+  }
+
+  @Test
+  fun `order medication flow for medication dispense no test `(): Unit = runBlockingOnWorkerThread {


Is this the same as order medication flow for medication dispense ?
I see a lot of duplicate codes. Can we reuse them ?

MJ1998 · 2024-09-17T16:27:52Z

workflow/src/test/java/com/google/android/fhir/workflow/activity/ActivityFlowTest.kt

+  }
+
+  @Test
+  fun `draftPlan is success when flow is in proposal phase`(): Unit = runBlockingOnWorkerThread {


Maybe this is better ?

Suggested change

fun `draftPlan is success when flow is in proposal phase`(): Unit = runBlockingOnWorkerThread {

fun `preparePlan should succeed when in proposal phase`(): Unit = runBlockingOnWorkerThread {

MJ1998 · 2024-09-17T16:28:25Z

workflow/src/test/java/com/google/android/fhir/workflow/activity/ActivityFlowTest.kt

+  }
+
+  @Test
+  fun `draftPlan is failure when flow is in plan phase`(): Unit = runBlockingOnWorkerThread {


Similarly others ?

Suggested change

fun `draftPlan is failure when flow is in plan phase`(): Unit = runBlockingOnWorkerThread {

fun `preparePlan should fail when in plan phase`(): Unit = runBlockingOnWorkerThread {

…supported activities

aditya-07 added 23 commits March 14, 2024 20:10

Base classes for the activity flow api

bf1e783

Merge branch 'master' into ak/activityflow

63c2af7

Updated the api

38991cb

Merge branch 'master' into ak/activityflow

ed5c823

spotless

6d9194f

Added fluent api

de9bbdc

Cleanded test

a0c1117

Merge branch 'master' into ak/activityflow

a12834e

Merge branch 'master' into ak/activityflow

43eba78

Added more activities

e12a324

Merge branch 'master' into ak/activityflow

d322972

Merge branch 'master' into ak/activityflow

7d0d467

Updated to a new flow style

7e09af2

Merge branch 'master' into ak/activityflow

e1eaafc

Updated the flow and added CPG structures

e32aaf3

Merge branch 'master' into ak/activityflow

7dd6101

Added request and event classes. Updated the flow for event type when…

74c7e1c

… perform is called

Merge branch 'master' into ak/activityflow

9bdf062

Merge branch 'master' into ak/activityflow

9f056d7

Cleanup of activity flow files

23f4fd0

Merge branch 'master' into ak/activityflow

af3c1d6

Merge branch 'master' into ak/activityflow

0d20d3e

Added docs, updated tests

6a62a6b

aditya-07 marked this pull request as ready for review July 25, 2024 09:09

aditya-07 requested review from jingtang10, MJ1998 and santosh-pingle as code owners July 25, 2024 09:09

aditya-07 added 3 commits July 25, 2024 14:39

Merge branch 'master' into ak/activityflow

8567f18

Merge branch 'master' into ak/activityflow

85c797c

Updated docs

9e2ad9c

MJ1998 requested changes Aug 5, 2024

View reviewed changes

FikriMilano suggested changes Aug 25, 2024

View reviewed changes

Refactored code , defined new api and separated the phase and resourc…

f3733de

…e classes

aditya-07 requested a review from a team as a code owner September 12, 2024 07:16

aditya-07 added 4 commits September 12, 2024 13:06

Merge branch 'master' into ak/activityflow

9e0626f

spotless

e8013ce

Updated kdocs, checks and error messages

e5b7341

Review comments + kdoc

6c9c735

aditya-07 added the kokoro:force-run label Sep 12, 2024

android-fhir-bot removed the kokoro:force-run label Sep 12, 2024

aditya-07 added 3 commits September 12, 2024 18:05

Added tests

031525f

Updated some code logic and kdocs

905bc37

Refactored code

e582b1b

jingtang10 requested changes Sep 16, 2024

View reviewed changes

jingtang10 reviewed Sep 16, 2024

View reviewed changes

workflow/src/main/java/com/google/android/fhir/workflow/activity/ActivityFlow.kt Outdated Show resolved Hide resolved

jingtang10 reviewed Sep 16, 2024

View reviewed changes

MJ1998 requested changes Sep 17, 2024

View reviewed changes

aditya-07 force-pushed the ak/activityflow branch from 64d62ed to ec9fbcd Compare September 18, 2024 11:27

Review comments: Renamed api, removed classes not related to current …

0e8bcc7

…supported activities

aditya-07 force-pushed the ak/activityflow branch from ec9fbcd to 0e8bcc7 Compare September 18, 2024 11:38

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Activity flow api changes. #2476

Activity flow api changes. #2476

aditya-07 commented Mar 14, 2024 •

edited

Loading

MJ1998 left a comment

MJ1998 Aug 5, 2024

FikriMilano Aug 25, 2024

FikriMilano Aug 25, 2024

FikriMilano Aug 25, 2024

FikriMilano Aug 25, 2024

FikriMilano Aug 25, 2024

jingtang10 left a comment

jingtang10 left a comment

MJ1998 left a comment

MJ1998 Sep 17, 2024

MJ1998 Sep 17, 2024

MJ1998 Sep 17, 2024

MJ1998 Sep 17, 2024

MJ1998 Sep 17, 2024

MJ1998 Sep 17, 2024


		import org.hl7.fhir.r4.model.Task

		class CPGProposeDiagnosisTask(override val resource: Task) : CPGTaskRequest(resource) {

	class CPGProposeDiagnosisTask(override val resource: Task) : CPGTaskRequest(resource) {
	class CPGProposeDiagnosisTaskRequest(override val resource: Task) : CPGTaskRequest(resource) {

	* @return [R] if the action is successful, error otherwise.
	* @return [Result]<R> containing the draft plan resource if the action is successful, [Result.failure] otherwise.

	fun `draftPlan is success when flow is in proposal phase`(): Unit = runBlockingOnWorkerThread {
	fun `preparePlan should succeed when in proposal phase`(): Unit = runBlockingOnWorkerThread {

	fun `draftPlan is failure when flow is in plan phase`(): Unit = runBlockingOnWorkerThread {
	fun `preparePlan should fail when in plan phase`(): Unit = runBlockingOnWorkerThread {

Activity flow api changes. #2476

Are you sure you want to change the base?

Activity flow api changes. #2476

Conversation

aditya-07 commented Mar 14, 2024 • edited Loading

MJ1998 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jingtang10 left a comment

Choose a reason for hiding this comment

jingtang10 left a comment

Choose a reason for hiding this comment

MJ1998 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aditya-07 commented Mar 14, 2024 •

edited

Loading