api/utils/requestProcessor

Module for processing data passed to Countly

Description:

  • Module for processing data passed to Countly

Source:

Methods

(static) processRequest(params) → {void}

Description:

  • Default request processing handler, which requires request context to operate. Check tcp_example.js

Source:
Example
//creating request context
var params = {
    //providing data in request object
    'req':{"url":"/i", "body":{"device_id":"test","app_key":"APP_KEY","begin_session":1,"metrics":{}}},
    //adding custom processing for API responses
    'APICallback': function(err, data, headers, returnCode, params){
         //handling api response, like sending to client or verifying
         if(err){
             //there was problem processing request
             console.log(data, returnCode);
         }
         else{
             //request was processed, let's handle response data
             handle(data);
         }
    }
};

//processing request
processRequest(params);
Parameters:
Name Type Description
params Params

for request context. Minimum needed properties listed

Properties
Name Type Description
req object

Request object, should not be empty and should contain listed params

Properties
Name Type Description
url string

Endpoint URL that you are calling. May contain query string.
body object

Parsed JSON object with data (same name params will overwrite query string if anything provided there)
APICallback APICallback

API output handler. Which should handle API response
Returns:

void

Type
void

(inner) checksumSaltVerification(params, type, done) → {function}

Source:
Parameters:
Name Type Description
params object

params object
type String

source type
done function

done callback
Returns:
  • done or boolean value
Type
function

(inner) fetchAppUser(params) → {Promise}

Description:

  • Function to fetch app user from db

Source:
Parameters:
Name Type Description
params object

params object
Returns:
  • user
Type
Promise

(inner) ignorePossibleDevices(params, done) → {function}

Description:

  • Add devices to ignore them

Source:
Parameters:
Name Type Description
params Params

params object
done function

callback when processing done
Returns:

done

Type
function

(inner) loadDbVersionMarks(callback) → {void}

Description:

  • Fetches version mark history (database)

Source:
Parameters:
Name Type Description
callback function

callback when response is ready
Returns:

void

Type
void

(inner) loadFsVersionMarks(callback) → {void}

Description:

  • Fetches version mark history (filesystem)

Source:
Parameters:
Name Type Description
callback function

callback when response is ready
Returns:

void

Type
void

(inner) processBulkRequest(i, requests, params) → {void}

Description:

  • Process Bulk Request

Source:
Parameters:
Name Type Description
i number

request number in bulk
requests Array.<object>

array of requests to process
params Params

params object
Returns:

void

Type
void

(inner) processFetchRequest(params, app, done)

Description:

  • Process fetch request from sdk

Source:
Parameters:
Name Type Description
params object

params object
app object

app document
done function

callback when processing done

(inner) processRequestData(params, app, done)

Description:

  • Process Request Data

Source:
Parameters:
Name Type Description
params Params

params object
app object

app document
done function

callbck when processing done

(inner) processUser(params, initiator, done, try_times) → {Promise}

Source:
Parameters:
Name Type Description
params object

params object
initiator function

function which initiated request
done function

callback when processing done
try_times number

how many times request was retried
Returns:
  • resolved
Type
Promise

(inner) restartRequest(params, initiator, done, try_times, fail) → {void}

Description:

  • Restart Request

Source:
Parameters:
Name Type Description
params Params

params object
initiator function

function which initiated request
done function

callback when processing done
try_times number

how many times request was retried
fail function

callback when restart limit reached
Returns:

void

Type
void

(inner) validateAppForFetchAPI(params, done, try_times) → {function}

Description:

  • Validate app for fetch API from sdk

Source:
Parameters:
Name Type Description
params object

params object
done function

callback when processing done
try_times number

how many times request was retried
Returns:

done - done callback

Type
function

(inner) validateAppForWriteAPI(params, done, try_times) → {void}

Description:

  • Validate App for Write API Checks app_key from the http request against "apps" collection. This is the first step of every write request to API.

Source:
Parameters:
Name Type Description
params Params

params object
done function

callback when processing done
try_times number

how many times request was retried
Returns:

void

Type
void

(inner) validateRedirect(ob) → {Boolean}

Source:
Parameters:
Name Type Description
ob object

params object
Returns:
  • false if redirected
Type
Boolean

Type Definitions

Promise

Source: