ABDM API for related mobile app #32332

akashkj · 2022-11-11T06:42:52Z

Product Description

Reopened PR of #32194

Changes include:

Expose API to be consumed by ABDM android application. These API endpoints internally communicate with the ABDM server to return the processed response to the caller ABDM android app.
Authenticate new APIs with a custom token, which are having validity for ABDM API only.
Provide ABDM auth token to the CommCare mobile app user on every sync. There is the future scope of adding validity to the token.

Technical Summary

https://docs.google.com/document/d/1gbQcAC3H4kj22iMCMMKSYMVO5_7kt56qiS8OWkd6e34/edit

Feature Flag

RESTORE_ADD_ABDM_TOKEN

Safety Assurance

Safety story

Manual testing in the local environment and dev instance of CommCare HQ deployed on Mumbai region.

Automated test coverage

[TODO]Automated unit tests

QA Plan

https://dimagi-dev.atlassian.net/browse/QA-4549

Migrations

The migrations in this code can be safely applied first independently of the code

Rollback instructions

This PR can be reverted after deploy with no further considerations

Labels & Review

Risk label is set correctly
The set of people pinged as reviewers is appropriate for the level of risk of the change

…bile-app

mkangia

Took a first pass. Need to understand it better to review properly. Will offline.

mkangia · 2022-11-21T20:47:59Z

custom/abdm/milestone_one/utils/abha_creation_util.py

@@ -0,0 +1,44 @@
+import logging


what is the motivation behind having a module called "milestone_one"? I understand this is the first for 3 stages in terms of implementations but does it need to reflect in code?

All milestones have different usecases and if there is need to add or remove certain usecases, based on certifications received, it will be easier to locate the code milestone wise.

Can we add a README for milestone one? To explain things like

what is ABHA?

what is the ABDM mobile app?

what interaction happen between CommCare App and HQ?

A quick summary of how ABDM mobile app works with the CommCare App or a link if its written elsewhere.

Can we take that as supplementary change for another PR as I believe that should be more formal and researched. We will require to pick content from mobile app's doc.

mkangia · 2022-11-21T20:50:10Z

custom/abdm/milestone_one/utils/abha_creation_util.py

+
+
+def generate_aadhar_otp(aadhaar_number):
+    generate_aadhar_otp_url = "v1/registration/aadhaar/generateOtp"


Can these URLs be constants?

custom/abdm/milestone_one/utils/abha_creation_util.py

mkangia · 2022-11-21T20:53:24Z

custom/abdm/milestone_one/utils/decorators.py

+
+def required_request_params(params: List[str]):
+    """
+    A version of the requires_privilege decorator which raises an Http404


I don't understand the reference to requires_privilege function here. Is that needed?
The name of the function seems good enough to me to signify what it does, so does not look like it needs any documentation at all too.

Yes, it is copy paste residue, was removed.

mkangia · 2022-11-21T20:56:19Z

custom/abdm/milestone_one/utils/decorators.py

+        def wrapped(request, *args, **kwargs):
+            if not (params and isinstance(params, List)):
+                error_msg = f"Request {request} could not be validated as validation input not provided."
+                logger.warning(error_msg)


Is this still needed? Guessing this was added during development?

Kept to audit invalid requests. Any harm in retaining?

this would be in the logs where it would get removed from time to time. You would need something permanent if its for audit later.

mkangia · 2022-11-21T21:06:05Z

settings.py

@@ -2015,6 +2020,9 @@ def _pkce_required(client_id):

 REST_FRAMEWORK = {
    'DATETIME_FORMAT': '%Y-%m-%dT%H:%M:%S.%fZ',
+    'DEFAULT_AUTHENTICATION_CLASSES': (
+       'rest_framework.authentication.TokenAuthentication',
+   ),


what all does this impact outside of the abdm app?

This is removed.

mkangia · 2022-11-21T21:08:40Z

corehq/apps/domain/tests/test_deletion_models.py

@@ -65,6 +66,7 @@
    'util.TransientBounceEmail',
    'registration.AsyncSignupRequest',
    'users.UserHistory',
+    'custom.abdm.models.ABDMUser',


why should this be ignored?

Seems strange that this is included in dump but ignored during deletion.

corrected, it should be included in deletion flow.

mkangia · 2022-11-21T21:09:40Z

custom/abdm/milestone_one/utils/decorators.py

    """
-    A version of the requires_privilege decorator which raises an Http404
-    if PermissionDenied is raised.
+    Checks if the parameters provided in the decorator(a list of strings) are present in the DRF request.


Are these sensitive enough that they should be present in the request header and not in the params?

These are in the POST body of request. Do you mean something else, which I misinterpreted?

Okay.
I think its the term parameters that is being used. I would always think of these as params that are a part of the URL.
A better name could be required_request_data or required_request_post_data. Not sure what a better name could be for params.

custom/abdm/milestone_one/utils/request_util.py

mkangia · 2022-11-21T21:13:35Z

CONTRIBUTING.rst

-Contributing to CommCareHQ
-==========================
+===========================
+Contributing to CommCare HQ


Oh, I think we need CommCareHQ only.

This commit looks like things went wrong here?

…bile-app

…ficiary Existing abha check in verification flow

…ficiary Moved existing abha check to API used by mobile app

…o abdm-audit

…ficiary ABHA Validation on HQ for Creation flow

…to abdm-audit

ajeety4 · 2023-07-10T15:54:16Z

Updated this m1 branch with abdm-audit to account of m1 changes that were addressed recently.

snopoke · 2023-07-12T08:39:27Z

I'm not sure what's up with the PR diff but I'm seeing changes from other branches. Perhaps try merge master?

ajeety4 · 2023-07-12T09:06:00Z

I'm not sure what's up with the PR diff but I'm seeing changes from other branches. Perhaps try merge master?

Yes we did integrated some changes from other branches.
Also, as we plan to separate out this work on a independent repostory (later to be integrated as an HQ extension probably) I am going to close this PR.

mkangia · 2023-07-12T10:07:43Z

Hey @snopoke

we don't intend to merge this into master. This PR is just to see the changes we have made for an long on-going integration effort.
We would extract this piece out entirely of HQ through extensions.

akashkj added 13 commits September 22, 2022 11:04

ABDM api for mobile app consumption

ba82c67

Add abdm api token to response of mobile restore

23d321b

Add auth settings + register in primary urls.py

424af6d

abdm migrations

f7e8afd

add abdm exclusion to domain migration tests

09c8c5a

Merge remote-tracking branch 'origin/master' into akj/abdm-api-for-mo…

496bd0b

…bile-app

Refactor based on review comments

d8e49bf

Merge remote-tracking branch 'origin/master' into akj/abdm-api-for-mo…

60d5df1

…bile-app

Merge remote-tracking branch 'origin/master' into akj/abdm-api-for-mo…

492daad

…bile-app

Feature flag for restore content

7235e7f

Use extensions for fetching abdm token in restore

6587471

revert commit to abdm FF

a864ce8

Merge remote-tracking branch 'origin/master' into akj/abdm-api-for-mo…

150678e

…bile-app

dimagimon added the reindex/migration Reindex or migration will be required during or before deploy label Nov 11, 2022

akashkj marked this pull request as draft November 11, 2022 06:43

Remove drf default auth from settings.py

39521a8

akashkj mentioned this pull request Nov 11, 2022

ABDM changes for consuming APIs in the mobile app. #32194

Closed

4 tasks

akashkj added awaiting QA QA in progress. Do not merge product/custom Change will only impact users on a single project labels Nov 11, 2022

akashkj marked this pull request as ready for review November 11, 2022 06:51

akashkj added QA Passed and removed awaiting QA QA in progress. Do not merge labels Nov 11, 2022

akashkj requested a review from mkangia November 11, 2022 07:20

akashkj changed the title ~~Akj/abdm api for mobile app~~ ABDM API for related mobile app Nov 11, 2022

Akash Jain added 2 commits November 19, 2022 21:50

Merge remote-tracking branch 'origin/master' into akj/abdm-api-for-mo…

d174814

…bile-app

tests fix

4a45c47

mkangia reviewed Nov 21, 2022

View reviewed changes

Akash Jain added 3 commits November 24, 2022 10:44

Review comments

3778b12

Merge remote-tracking branch 'origin/master' into akj/abdm-api-for-mo…

f56917a

…bile-app

Add domain to ABDMUser model

8d99291

mkangia and others added 9 commits May 26, 2023 17:22

Merge branch 'master' into abdm-audit

f6ede98

error code update, nit: redundant variable

3f28b94

Merge pull request #33006 from dimagi/ay/abdm-validation-abha-no-bene…

9e0f6f4

…ficiary Existing abha check in verification flow

Merge branch 'akj/abdm-api-for-mobile-app' into abdm-audit

1d5d069

validates attachments by extension or mimetype

15f8756

renames var to by either audio/image/video

70775e9

extract constant for FP to use

202f162

updates FP to use HQ constant

13d979e

resolve conflict; merge mk/validate-attachments

096cb36

akashkj removed the QA Passed label May 31, 2023

mkangia and others added 11 commits June 7, 2023 14:26

escapes question labels

02806a9

Merge branch 'mk/escape-question-labels' into abdm-audit

7b1f15a

moved existing abha check to API used by mobile app

778cc3b

Merge pull request #33082 from dimagi/ay/abdm-validation-abha-no-bene…

dc88c67

…ficiary Moved existing abha check to API used by mobile app

Merge remote-tracking branch 'origin/akj/abdm-api-for-mobile-app' int…

269388e

…o abdm-audit

Add profile data in case of successful ABHA verification

fed6ade

abha id check on HQ for exists by health id API

f92c7db

add whether exists on HQ after health id creation

8b6569c

Merge pull request #33163 from dimagi/ay/abdm-validation-abha-no-bene…

e9871e6

…ficiary ABHA Validation on HQ for Creation flow

Merge branch 'akj/abdm-api-for-mobile-app' into abdm-audit

4296fbb

Merge branch 'abdm-audit' of https://github.com/dimagi/commcare-hq in…

f7f682a

…to abdm-audit

ajeety4 requested review from snopoke and orangejenny as code owners July 10, 2023 15:46

dimagimon added the Risk: Medium Change affects files that have been flagged as medium risk. label Jul 10, 2023

ajeety4 closed this Jul 12, 2023

ajeety4 mentioned this pull request Sep 12, 2023

ABDM ABHA implementation (Milestone 1) dimagi/abdm-python-integrator#1

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ABDM API for related mobile app #32332

ABDM API for related mobile app #32332

akashkj commented Nov 11, 2022 •

edited

Loading

mkangia left a comment

mkangia Nov 21, 2022

akashkj Nov 24, 2022

mkangia Dec 16, 2022

akashkj Dec 19, 2022

mkangia Jan 17, 2023

mkangia Nov 21, 2022

akashkj Nov 24, 2022

mkangia Nov 21, 2022

akashkj Nov 24, 2022 •

edited

Loading

mkangia Nov 21, 2022

akashkj Nov 24, 2022

mkangia Dec 2, 2022

mkangia Nov 21, 2022

akashkj Dec 2, 2022

mkangia Nov 21, 2022

mkangia Nov 21, 2022

akashkj Nov 24, 2022

mkangia Nov 21, 2022

mkangia Dec 16, 2022

akashkj Dec 20, 2022

mkangia Jan 17, 2023

akashkj Feb 27, 2023

mkangia Nov 21, 2022

mkangia Nov 21, 2022

ajeety4 commented Jul 10, 2023

snopoke commented Jul 12, 2023

ajeety4 commented Jul 12, 2023 •

edited

Loading

mkangia commented Jul 12, 2023



		def generate_aadhar_otp(aadhaar_number):
		generate_aadhar_otp_url = "v1/registration/aadhaar/generateOtp"

ABDM API for related mobile app #32332

ABDM API for related mobile app #32332

Conversation

akashkj commented Nov 11, 2022 • edited Loading

Product Description

Technical Summary

Feature Flag

Safety Assurance

Safety story

Automated test coverage

QA Plan

Migrations

Rollback instructions

Labels & Review

mkangia 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

akashkj Nov 24, 2022 • edited Loading

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

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ajeety4 commented Jul 10, 2023

snopoke commented Jul 12, 2023

ajeety4 commented Jul 12, 2023 • edited Loading

mkangia commented Jul 12, 2023

akashkj commented Nov 11, 2022 •

edited

Loading

akashkj Nov 24, 2022 •

edited

Loading

ajeety4 commented Jul 12, 2023 •

edited

Loading