Rating the delivery service with feedback (Node.js)

In this use case, the user rates the delivery service. This rating is usually between 1 to 5. Sometimes, the user is also expected to provide feedback against a rating.

Code snippets

Client calls the BAP server to trigger rating:

    router.post("/delivery/rate_delivery", rateDelivery);

    async function rateDelivery({ body }, res) {
        try {

            //  .. Validate the client request before below function
            await generateRateOrderRequest(body)
        } catch (error) {
            res.status(500).send(httpResponse("NACK", error));
        }
    };

BAP server generates the protocol request body

    // Code to generate the protocol request body i.e. function generateRateOrderRequest() specified above

    async function generateRateOrderRequest(clientRequestBody) {
/*
Example Request JSON :
{
    "context": {
        "domain": "delivery",
        "country": "IND",
        "city": "std:080",
        "action": "rating",
        "core_version": "0.9.2",
        "bap_id": "https://mock_bap.com/",
        "bap_uri": "https://mock_bap.com/beckn/",
        "transaction_id": "1239890342",
        "message_id": "123793824",
        "timestamp": "2021-06-23T08:18:49.303Z"
    },
    "message": {
        "id": "order_1",
        "value": 5
    }
}
*/
        //The below code generates the above example JSON.
        const transactionId = _.get(body, "transactionId");
        // Returns the Context including MessageId
        const context = createContext(transactionId);
        const ratingRequestBody = {
            context,
            message: {
                // Construct from the request
            }
        }
        //call protocol rating order
        const response = await callRating(ratingRequestBody);
        res
        .status(200)
        .send({ ...response.data, messageId: context["message_id"] });
    }

BAP server calls protocol rating to the network

    async function callRating(ratingRequestBody) {
        // It lookups the registry for BG OR BPP
        let uri = lookup();
        // Construct Header
        const headers = constructAuthHeader(); // Auth Header with digital Signature
        return axios({ url: `${uri}/delivery/rating`, method: "POST", headers, data: ratingRequestBody });
    }

BAP receives protocol on_rating

/*
Example Response JSON:
{
    "context": {
        "domain": "delivery",
        "country": "IND",
        "city": "std:080",
        "action": "on_rating",
        "core_version": "0.9.2",
        "bap_id": "https://mock_bap.com/",
        "bap_uri": "https://mock_bap.com/beckn/",
        "transaction_id": "1239890342",
        "message_id": "123793824",
        "timestamp": "2021-06-29T10:52:01.620Z"
    },
    "message": {
        "feedback": {
            "id": "c9f4c283-6e53-4d86-aa2e-98d18d30144d",
            "descriptor": "https://feedback.bpp.com/provider/fast-logistics/1532",
            "parent_id": "order_1"
        }
    }
}
*/
    // Auth middleware authenticates the digital signature of the incoming request
    router.post("/delivery/on_rating", auth, onRating);
    async function onRating({ body }, res) {
        // Save the response to Database
        await saveToDb(body);
    };

Client polls BAP to get the on_rating results

    // Endpoint for the client to poll the search data based on the message id
    async function getMessageById(req) {
        try {
            const messageId = _.get(req, "messageId");
            // Get the data using message Id
            const response = await getData(messageId);
            res.status(200).send(httpResponse('ACK', "", response));
        } catch(error) {
            res.status(500).send(httpResponse("NACK", error));
        }
    };