Handlers and Endpoints for Mojaloop/App/Firebase - Linking/Unlinking Flow

ambient.d.ts

@@ -21,6 +21,7 @@
  * Google
  - Abhimanyu Kapur <[email protected]>
  - Steven Wijaya <[email protected]>
+ - Abhimanyu Kapur <[email protected]>
  --------------
  ******/
 

package.json

@@ -105,7 +105,8 @@
     "@hapi/inert": "^6.0.1",
     "@hapi/vision": "^6.0.0",
     "@mojaloop/central-services-logger": "^10.6.0",
-    "@mojaloop/sdk-standard-components": "^11.3.1",
+    "@mojaloop/central-services-shared": "^11.3.2",
+    "@mojaloop/sdk-standard-components": "^11.6.0",
     "@types/uuid": "^8.0.0",
     "convict": "^6.0.0",
     "dotenv": "^8.2.0",

src/interface/mojaloop.yaml

@@ -270,12 +270,17 @@ paths:
           $ref: '../../node_modules/@mojaloop/api-snippets/v1.0/openapi3/responses/index.yaml#/501'
         503:
           $ref: '../../node_modules/@mojaloop/api-snippets/v1.0/openapi3/responses/index.yaml#/503'
-    delete:
+    patch:
       tags:
         - consents
-      summary: '[Mojaloop Callback] Result of deleting the specified consent'
-      description: Result of deleting the specified consent
-      operationId: deleteConsentsById
+      summary: '[Mojaloop Callback] Result of patching the specified consent (used in unlinking)'
+      description: Result of patching the specified consent (used in unlinking)
+      operationId: patchConsentsById
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: 'shared.yaml#/components/schemas/PatchConsentsByIdRequest'
       responses:
         200:
           $ref: '../../node_modules/@mojaloop/api-snippets/v1.0/openapi3/responses/index.yaml#/200'

src/interface/shared.yaml

@@ -98,6 +98,15 @@ components:
         name: 
           type: string
       description: Data model for the complex type Participant.
+    PatchConsentsByIdRequest:
+      title: PutConsentsByIdRequest
+      type: object
+      properties:
+        status:
+          type: string
+        revokedAt:
+          type: string
+      description: Data model for the complex type PatchConsentsByIdRequest.
     PostAuthorizationsRequest:
       title: PostAuthorizationsRequest
       type: object

src/lib/config.ts

@@ -108,6 +108,13 @@ const config = convict({
       default: 'pisp',
       env: 'MOJALOOP_PARTICIPANT_ID',
     },
+    // TODO: Replace placeholder
+    pispCallbackUri: {
+      doc: 'The callback URI sent by PISP deeplinked with the app',
+      format: String,
+      default: 'PLACEHOLDER',
+      env: 'MOJALOOP_CALLBACK_URI',
+    },
     endpoints: {
       default: {
         doc: 'Default endpoint to communicate with Mojaloop',

src/models/consent.ts

@@ -20,6 +20,7 @@
 
  * Google
  - Steven Wijaya <[email protected]>
+ - Abhimanyu Kapur <[email protected]>
  --------------
  ******/
 
@@ -40,22 +41,37 @@ export enum ConsentStatus {
    * Waiting for the user to confirm payee information and provide more
    * details about the transaction.
    */
-  PENDING_PAYEE_CONFIRMATION = 'PENDING_PAYEE_CONFIRMATION',
+  PENDING_PARTY_CONFIRMATION = 'PENDING_PARTY_CONFIRMATION',
 
   /**
    * Waiting for the user to authorize the consent.
    */
-  AUTHORIZATION_REQUIRED = 'AUTHORIZATION_REQUIRED',
+  AUTHENTICATION_REQUIRED = 'AUTHENTICATION_REQUIRED',
 
   /**
-   * The consent is authorized and active.
+   * The consent is granted and active.
+   */
+  CONSENT_GRANTED = 'CONSENT_GRANTED',
+
+  /**
+   * The consent is ACTIVE and challenge has been generated
+   */
+  CHALLENGE_GENERATED = 'CHALLENGE_GENERATED',
+
+  /**
+   * The consent is ACTIVE and challenge has been verified
    */
   ACTIVE = 'ACTIVE',
 
   /**
    * The consent is revoked and no longer valid.
    */
   REVOKED = 'REVOKED',
+
+  /**
+   * The consent is requested to be revoked for unlinking.
+   */
+  REVOKE_REQUESTED = 'REVOKE_REQUESTED',
 }
 
 export interface Consent {

src/models/errors.ts

@@ -37,3 +37,8 @@ export class MissingConsentFieldsError extends Error {
     this.consent = consent
   }
 }
+export class InvalidConsentStatusError extends Error {
+  public constructor(consentStatus: string) {
+    super(`Invalid Consent Status Provided! Status: ${consentStatus}`)
+  }
+}

src/repositories/consent.ts

@@ -19,27 +19,47 @@
  - Name Surname <[email protected]>
 
  * Google
- - Steven Wijaya <stevenwjy@google.com>
+ - Abhimanyu Kapur <abhi.kapur09@gmail.com>
  --------------
  ******/
 
-/* eslint-disable @typescript-eslint/no-explicit-any */
+/* istanbul ignore file */
+// TODO: BDD Testing will covered in separate ticket #1702
 
 import firebase from '~/lib/firebase'
 import { Consent } from '~/models/consent'
 import { logger } from '~/shared/logger'
 
 export interface IConsentRepository {
+  /**
+   * Updates a consent document based on a unique identifier.
+   *
+   * @param id    Id for the consent document that needs to be updated.
+   * @param data  Document fields that are about to be updated.
+   */
+  updateConsentById(id: string, data: Record<string, unknown>): Promise<void>
+
   /**
    * Retrieves a consent document based on its consent ID.
    *
    * @param id    Consent ID of the document that needs to be retrieved.
    */
-  getByConsentId(id: string): Promise<Consent>
+  getConsentById(id: string): Promise<Consent>
+
+  /**
+   * Updates one or more consent documents based on the given conditions.
+   *
+   * @param conditions  Conditions for the documents that need to be updated.
+   * @param data        Document fields that are about to be updated.
+   */
+  updateConsent(
+    conditions: Record<string, unknown>,
+    data: Record<string, unknown>
+  ): Promise<void>
 }
 
 export class FirebaseConsentRepository implements IConsentRepository {
-  async getByConsentId(id: string): Promise<Consent> {
+  async getConsentById(id: string): Promise<Consent> {
     return new Promise((resolve, reject) => {
       firebase
         .firestore()
@@ -58,6 +78,53 @@ export class FirebaseConsentRepository implements IConsentRepository {
         })
     })
   }
+
+  async updateConsentById(
+    id: string,
+    data: Record<string, unknown>
+  ): Promise<void> {
+    await firebase.firestore().collection('consents').doc(id).update(data)
+  }
+
+  async updateConsent(
+    conditions: Record<string, unknown>,
+    data: Record<string, unknown>
+  ): Promise<void> {
+    let firestoreQuery: FirebaseFirestore.Query = firebase
+      .firestore()
+      .collection('consents')
+
+    // Chain all of the given conditions to the query
+    for (const key in conditions) {
+      firestoreQuery = firestoreQuery.where(key, '==', conditions[key])
+    }
+
+    // Find and update all matching documents in Firebase that match the given conditions.
+    firestoreQuery
+      .get()
+      .then((response) => {
+        // Create a batch to perform all of the updates using a single request.
+        // Firebase will also execute the updates atomically according to the
+        // API specification.
+        const batch = firebase.firestore().batch()
+
+        // Iterate through all matching documents add them to the processing batch.
+        response.docs.forEach((doc) => {
+          batch.update(
+            // Put a reference to the document.
+            firebase.firestore().collection('consents').doc(doc.id),
+            // Specify the updated fields and their new values.
+            data
+          )
+        })
+
+        // Commit the updates.
+        return batch.commit()
+      })
+      .catch((err) => {
+        logger.error(err)
+      })
+  }
 }
 
 export const consentRepository: IConsentRepository = new FirebaseConsentRepository()

src/repositories/participants.ts

@@ -0,0 +1,81 @@
+/*****
+ License
+ --------------
+ Copyright © 2020 Mojaloop Foundation
+ The Mojaloop files are made available by the Mojaloop Foundation under the Apache License, Version 2.0 (the 'License') and you may not use these files except in compliance with the License. You may obtain a copy of the License at
+ http://www.apache.org/licenses/LICENSE-2.0
+ Unless required by applicable law or agreed to in writing, the Mojaloop files are distributed on an 'AS IS' BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+ Contributors
+ --------------
+ This is the official list of the Mojaloop project contributors for this file.
+ Names of the original copyright holders (individuals or organizations)
+ should be listed with a '*' in the first column. People who have
+ contributed from an organization can be listed under the organization
+ that actually holds the copyright for their contributions (see the
+ Mojaloop Foundation organization for an example). Those individuals should have
+ their names indented and be marked with a '-'. Email address can be added
+ optionally within square brackets <email>.
+ * Mojaloop Foundation
+ - Name Surname <[email protected]>
+
+ * Google
+ - Steven Wijaya <[email protected]>
+ - Abhimanyu Kapur <[email protected]>
+ --------------
+ ******/
+
+/* istanbul ignore file */
+// TODO: BDD Testing will covered in separate ticket #1702
+
+import firebase from '~/lib/firebase'
+import { logger } from '~/shared/logger'
+import { Participant } from '~/shared/ml-thirdparty-client/models/core'
+
+export interface IParticipantRepository {
+  /**
+   * Replace existing participants list with new list.
+   *
+   * @param data   Documents that are about to be added.
+   */
+  replace(data: Participant[]): Promise<void>
+}
+
+export class FirebaseParticipantRepository implements IParticipantRepository {
+  async replace(data: Participant[]): Promise<void> {
+    const collectionRef: FirebaseFirestore.CollectionReference<FirebaseFirestore.DocumentData> = firebase
+      .firestore()
+      .collection('participants')
+
+    // Find and update all matching documents in Firebase that match the given conditions.
+    collectionRef
+      .get()
+      .then(async (response) => {
+        // Create a batch to perform all of the updates using a single request.
+        // Firebase will also execute the updates atomically according to the
+        // API specification.
+        const batch = firebase.firestore().batch()
+
+        const batchSize = response.size
+        if (batchSize > 0) {
+          // If previous participants list exists, delete it
+
+          // Iterate through all matching documents add them to the processing batch.
+          response.docs.forEach((doc) => {
+            batch.delete(doc.ref)
+          })
+        }
+        // Iterate through received participants list and add them to the processing batch.
+        data.forEach((participant: Participant) => {
+          batch.set(collectionRef.doc(), participant)
+        })
+
+        // Commit the updates.
+        return batch.commit()
+      })
+      .catch((err) => {
+        logger.error(err)
+      })
+  }
+}
+
+export const participantRepository: IParticipantRepository = new FirebaseParticipantRepository()

src/repositories/transaction.ts

@@ -23,7 +23,8 @@
  --------------
  ******/
 
-/* eslint-disable @typescript-eslint/no-explicit-any */
+/* istanbul ignore file */
+// TODO: BDD Testing will covered in separate ticket #1702
 
 import firebase from '~/lib/firebase'
 import { logger } from '~/shared/logger'
@@ -35,7 +36,7 @@ export interface ITransactionRepository {
    * @param id    Id for the transaction document that needs to be updated.
    * @param data  Document fields that are about to be updated.
    */
-  updateById(id: string, data: Record<string, any>): Promise<void>
+  updateById(id: string, data: Record<string, unknown>): Promise<void>
 
   /**
    * Updates one or more transaction documents based on the given conditions.
@@ -44,19 +45,19 @@ export interface ITransactionRepository {
    * @param data        Document fields that are about to be updated.
    */
   update(
-    conditions: Record<string, any>,
-    data: Record<string, any>
+    conditions: Record<string, unknown>,
+    data: Record<string, unknown>
   ): Promise<void>
 }
 
 export class FirebaseTransactionRepository implements ITransactionRepository {
-  async updateById(id: string, data: Record<string, any>): Promise<void> {
+  async updateById(id: string, data: Record<string, unknown>): Promise<void> {
     await firebase.firestore().collection('transactions').doc(id).update(data)
   }
 
   async update(
-    conditions: Record<string, any>,
-    data: Record<string, any>
+    conditions: Record<string, unknown>,
+    data: Record<string, unknown>
   ): Promise<void> {
     let firestoreQuery: FirebaseFirestore.Query = firebase
       .firestore()
@@ -68,7 +69,7 @@ export class FirebaseTransactionRepository implements ITransactionRepository {
     }
 
     // Find and update all matching documents in Firebase that match the given conditions.
-    await firestoreQuery
+    firestoreQuery
       .get()
       .then((response) => {
         // Create a batch to perform all of the updates using a single request.