Resource Creation using POST http verb (SingleResourcePost) #2464

santosh-pingle · 2024-03-06T06:07:03Z

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

Description
The resource is created locally, and the HTTP POST verb is used to synchronize the resource with the FHIR server. In return, the server sends a response containing the resource with the newly assigned resource ID. Subsequently, the local database is updated with the provided resource.

Upload strategy : SingleResourcePost
Update the resource with the received resourceId in the local database
Update the resource with the received meta data in the local database
Update the resource with the received resource json string in the local database

Update the resource with the received reference id in the local database.

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).

engine/src/main/java/com/google/android/fhir/sync/upload/ResourceConsolidator.kt

engine/src/androidTest/java/com/google/android/fhir/sync/upload/ResourceConsolidatorTest.kt

engine/src/main/java/com/google/android/fhir/db/Database.kt

engine/src/main/java/com/google/android/fhir/db/impl/DatabaseImpl.kt

dubdabasoduba · 2024-04-04T09:12:49Z

@santosh-pingle How is this going to work? Are we making it the default behaviour for all CREATEs.

Right now if you POST to a HAPI server, the server assigns the resource its own id.

e.g posting the following resource

{
  "resourceType": "List",
  "id": "af17fe86-561a-44b0-84d3-5e75c753f6f8",
  "meta": {
    "versionId"  : "1"                            ,
    "lastUpdated": "2024-03-13T15:41:42.808+00:00",
    "source"     : "#fd2dc30247cf61b8"
  },
  "identifier": [
    {"use": "official", "value": "f39c5f68-ab0f-4ae5-a9e2-47b0beb73d8e"}
  ],
  "status": "current",
  "code": {
    "coding": [
      {
        "system" : "http://smartregister.org/",
        "code"   : "22138876"                 ,
        "display": "Supply Inventory List"
      }
    ],
    "text": "Supply Inventory List"
  }
}

will result in

{
  "resourceType": "List",
  "id": "1759",
  "meta": {
    "versionId"  : "1"                            ,
    "lastUpdated": "2024-04-04T09:09:05.431+00:00",
    "source"     : "#fd2dc30247cf61b8"
  },
  "identifier": [
    {"use": "official", "value": "f39c5f68-ab0f-4ae5-a9e2-47b0beb73d8e"}
  ],
  "status": "current",
  "code": {
    "coding": [
      {
        "system" : "http://smartregister.org/",
        "code"   : "22138876"                 ,
        "display": "Supply Inventory List"
      }
    ],
    "text": "Supply Inventory List"
  }
}

The above behaviour is going to distort the resource references for any resources created on the mobile application

cc: @ellykits @qiarie @ndegwamartin

engine/src/main/java/com/google/android/fhir/sync/upload/ResourceConsolidator.kt

dubdabasoduba · 2024-04-05T09:32:00Z

@santosh-pingle How is this going to work? Are we making it the default behaviour for all CREATEs.

Right now if you POST to a HAPI server, the server assigns the resource its own id.

e.g posting the following resource

{
  "resourceType": "List",
  "id": "af17fe86-561a-44b0-84d3-5e75c753f6f8",
  "meta": {
    "versionId"  : "1"                            ,
    "lastUpdated": "2024-03-13T15:41:42.808+00:00",
    "source"     : "#fd2dc30247cf61b8"
  },
  "identifier": [
    {"use": "official", "value": "f39c5f68-ab0f-4ae5-a9e2-47b0beb73d8e"}
  ],
  "status": "current",
  "code": {
    "coding": [
      {
        "system" : "http://smartregister.org/",
        "code"   : "22138876"                 ,
        "display": "Supply Inventory List"
      }
    ],
    "text": "Supply Inventory List"
  }
}

will result in

{
  "resourceType": "List",
  "id": "1759",
  "meta": {
    "versionId"  : "1"                            ,
    "lastUpdated": "2024-04-04T09:09:05.431+00:00",
    "source"     : "#fd2dc30247cf61b8"
  },
  "identifier": [
    {"use": "official", "value": "f39c5f68-ab0f-4ae5-a9e2-47b0beb73d8e"}
  ],
  "status": "current",
  "code": {
    "coding": [
      {
        "system" : "http://smartregister.org/",
        "code"   : "22138876"                 ,
        "display": "Supply Inventory List"
      }
    ],
    "text": "Supply Inventory List"
  }
}

The above behaviour is going to distort the resource references for any resources created on the mobile application

cc: @ellykits @qiarie @ndegwamartin

This was clarified on the SDK dev call. I think this is a good addition

engine/src/main/java/com/google/android/fhir/sync/upload/ResourceConsolidator.kt

engine/src/main/java/com/google/android/fhir/db/impl/DatabaseImpl.kt

engine/src/main/java/com/google/android/fhir/sync/upload/ResourceConsolidator.kt

...src/androidTest/java/com/google/android/fhir/sync/upload/HttpPostResourceConsolidatorTest.kt

santosh-pingle · 2024-04-10T12:00:35Z

@santosh-pingle How is this going to work? Are we making it the default behaviour for all CREATEs.

Right now if you POST to a HAPI server, the server assigns the resource its own id.

e.g posting the following resource

{
  "resourceType": "List",
  "id": "af17fe86-561a-44b0-84d3-5e75c753f6f8",
  "meta": {
    "versionId"  : "1"                            ,
    "lastUpdated": "2024-03-13T15:41:42.808+00:00",
    "source"     : "#fd2dc30247cf61b8"
  },
  "identifier": [
    {"use": "official", "value": "f39c5f68-ab0f-4ae5-a9e2-47b0beb73d8e"}
  ],
  "status": "current",
  "code": {
    "coding": [
      {
        "system" : "http://smartregister.org/",
        "code"   : "22138876"                 ,
        "display": "Supply Inventory List"
      }
    ],
    "text": "Supply Inventory List"
  }
}

will result in

{
  "resourceType": "List",
  "id": "1759",
  "meta": {
    "versionId"  : "1"                            ,
    "lastUpdated": "2024-04-04T09:09:05.431+00:00",
    "source"     : "#fd2dc30247cf61b8"
  },
  "identifier": [
    {"use": "official", "value": "f39c5f68-ab0f-4ae5-a9e2-47b0beb73d8e"}
  ],
  "status": "current",
  "code": {
    "coding": [
      {
        "system" : "http://smartregister.org/",
        "code"   : "22138876"                 ,
        "display": "Supply Inventory List"
      }
    ],
    "text": "Supply Inventory List"
  }
}

The above behaviour is going to distort the resource references for any resources created on the mobile application

cc: @ellykits @qiarie @ndegwamartin

We have kept existing DefaultConsolidator as it is.

engine/src/androidTest/java/com/google/android/fhir/db/impl/DatabaseImplTest.kt

MJ1998 · 2024-05-02T09:49:34Z

engine/src/main/java/com/google/android/fhir/db/Database.kt

+   * @param preSyncResourceId The [Resource.id] of the resource before synchronization.
+   * @param postSyncResource The [Resource] after synchronization.
+   */
+  suspend fun updateResourcesAndLocalChangesPostSync(


Is this API different from updateResourceAndReferences we already have in Database ?

There was something that was not updated or included in the old API. Let me check what was not included.

Essentially, the old API was not updating metadata such as version ID, last updated time, and the new resource ID in the payload of the resource, and meta data externally also.

Shouldn't we modify the existing API to update metadata instead of creating a new API ?
Or in case if this is not possible then rename the APIs to distinguish them properly ?

I am thinking of renaming api.

Also the kdoc for both

fixed version id issue in existing api.

Existing api you mean updateResourceAndReferences which is already there in DatabaseImpl ?
I don't see any changes in that.

Like we discussed in eng meeting, updating this API is better than creating a new API updateResourcesAndLocalChangesPostSync .

Can you please confirm if you have the latest code changes? For me it looks like you are referring outdated code which is no more present in the pr.
updateResourcesAndLocalChangesPostSync is no longer valid, and the Database file does not contain any changes in the PR.

Actual fix is here
engine/src/main/java/com/google/android/fhir/db/impl/dao/ResourceDao.kt

MJ1998 · 2024-05-02T09:51:04Z

Checkout this PR which added bunch of stuffs for POST upload strategy.

santosh-pingle · 2024-05-06T10:12:18Z

Checkout this PR which added bunch of stuffs for POST upload strategy.

Yes, I am using the core logic as it is. Only delta changes are added on top of it to achieve the end-to-end use case for resource consolidation.

Santosh Pingle added 9 commits March 5, 2024 20:06

draft singleresourcepost

3028c9d

Remove dead code.

dcecb04

resource consolidation after post http verb request

133cc61

Remove local changes.

ddb6387

fix unit tests.

9e194e3

Merge branch 'master' into sp/post-resource-creation

1440793

unit tests

7f22636

Update kotlin api docs.

2ad3d27

revert local changes.

7a4cc0c

santosh-pingle marked this pull request as ready for review March 19, 2024 05:03

santosh-pingle requested a review from a team as a code owner March 19, 2024 05:03

santosh-pingle requested a review from kevinmost March 19, 2024 05:03

santosh-pingle changed the title ~~In progress : Resource Creation using POST http verb~~ Resource Creation using POST http verb Mar 19, 2024

santosh-pingle changed the title ~~Resource Creation using POST http verb~~ Resource Creation using POST http verb (SingleResourcePost) Mar 19, 2024

MJ1998 reviewed Mar 19, 2024

View reviewed changes

engine/src/main/java/com/google/android/fhir/sync/upload/ResourceConsolidator.kt Outdated Show resolved Hide resolved

jingtang10 requested changes Mar 27, 2024

View reviewed changes

engine/src/main/java/com/google/android/fhir/db/impl/DatabaseImpl.kt Outdated Show resolved Hide resolved

jingtang10 requested changes Mar 28, 2024

View reviewed changes

Santosh Pingle and others added 3 commits March 29, 2024 22:47

Resource consolidation as per http verb

a88125e

address review comments.

d7694d7

Merge branch 'master' into sp/post-resource-creation

5eeb2fa

santosh-pingle requested a review from jingtang10 April 3, 2024 08:02

Santosh Pingle added 2 commits April 3, 2024 17:35

order of arguments

05c2c58

code to string conversion

ee2c41c

MJ1998 reviewed Apr 4, 2024

View reviewed changes

engine/src/main/java/com/google/android/fhir/sync/upload/ResourceConsolidator.kt Show resolved Hide resolved

aditya-07 reviewed Apr 8, 2024

View reviewed changes

Address review comments.

8cd9e08

santosh-pingle requested review from aditya-07 and MJ1998 April 11, 2024 03:12

Merge branch 'master' into sp/post-resource-creation

b293dc6

MJ1998 requested changes May 2, 2024

View reviewed changes

santosh-pingle and others added 3 commits May 6, 2024 16:11

Merge branch 'master' into sp/post-resource-creation

4c3ad36

Fix version id and use existing api.

6df3732

Merge branch 'master' into sp/post-resource-creation

e8213f5

santosh-pingle requested a review from MJ1998 May 8, 2024 10:51

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Resource Creation using POST http verb (SingleResourcePost) #2464

Resource Creation using POST http verb (SingleResourcePost) #2464

santosh-pingle commented Mar 6, 2024 •

edited

dubdabasoduba commented Apr 4, 2024 •

edited

dubdabasoduba commented Apr 5, 2024

santosh-pingle commented Apr 10, 2024

MJ1998 May 2, 2024

santosh-pingle May 6, 2024

santosh-pingle May 6, 2024 •

edited

MJ1998 May 6, 2024

santosh-pingle May 6, 2024

MJ1998 May 6, 2024

santosh-pingle May 8, 2024

MJ1998 May 21, 2024 •

edited

santosh-pingle May 21, 2024

MJ1998 commented May 2, 2024 •

edited

santosh-pingle commented May 6, 2024

Resource Creation using POST http verb (SingleResourcePost) #2464

Are you sure you want to change the base?

Resource Creation using POST http verb (SingleResourcePost) #2464

Conversation

santosh-pingle commented Mar 6, 2024 • edited

dubdabasoduba commented Apr 4, 2024 • edited

dubdabasoduba commented Apr 5, 2024

santosh-pingle commented Apr 10, 2024

MJ1998 May 2, 2024

Choose a reason for hiding this comment

santosh-pingle May 6, 2024

Choose a reason for hiding this comment

santosh-pingle May 6, 2024 • edited

Choose a reason for hiding this comment

MJ1998 May 6, 2024

Choose a reason for hiding this comment

santosh-pingle May 6, 2024

Choose a reason for hiding this comment

MJ1998 May 6, 2024

Choose a reason for hiding this comment

santosh-pingle May 8, 2024

Choose a reason for hiding this comment

MJ1998 May 21, 2024 • edited

Choose a reason for hiding this comment

santosh-pingle May 21, 2024

Choose a reason for hiding this comment

MJ1998 commented May 2, 2024 • edited

santosh-pingle commented May 6, 2024

santosh-pingle commented Mar 6, 2024 •

edited

dubdabasoduba commented Apr 4, 2024 •

edited

santosh-pingle May 6, 2024 •

edited

MJ1998 May 21, 2024 •

edited

MJ1998 commented May 2, 2024 •

edited