Rating the driver of a trip (Node.js)

In this use case, the user rates the driver of a trip. The rating is usually between 1 to 5. The mobility service sometimes asks for a reason why the user has provided a particular rating.

Code snippets

Client calls the BAP server to trigger rating:

    router.post("/mobility/rate_order", rateOrder);

    async function rateOrder({ body }, res) {
        try {
            // ..  Validate the client request here
            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": "nic2004:60221",
        "country": "IND",
        "city": "std:080",
        "action": "rating",
        "core_version": "0.9.1",
        "bap_id": "https://mock_bap.com/",
        "bap_uri": "https://mock_bap.com/beckn/",
        "bpp_id": "https://mock_bpp.com/",
        "bpp_uri": "https://mock_bpp.com/beckn/",
        "transaction_id": "1209849124",
        "message_id": "12341242345",
        "timestamp": "2021-03-23T10:00:40.065Z"
    },
    "message": {
        "id": "trip_1",
        "value": "4"
    }
}
*/
        //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}/mobility/rating`, method: "POST", headers, data: ratingRequestBody });
    }

BAP receives protocol on_rating

/*
Example Response JSON:
{
    "context": {
        "domain": "nic2004:60221",
        "country": "IND",
        "city": "std:080",
        "action": "on_rating",
        "bap_id": "https://mock_bap.com/",
        "bap_uri": "https://mock_bap.com/beckn/",
        "bpp_id": "https://mock_bpp.com/",
        "bpp_uri": "https://mock_bpp.com/beckn/",
        "transaction_id": "1209849124",
        "message_id": "12341242343",
        "timestamp": "2021-03-23T10:00:40.065Z"
    },
    "message": {
        "feedback": {
            "id": "trip_1",
            "descriptor": "https://feedback.mock_bpp.com/pooja-stores?id=trip_1",
            "parent_id": "yellow-cabs"
        }
    }
}
*/
    // Auth middleware authenticates the digital signature of the incoming request
    router.post("/mobility/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));
        }
    };