#Overview
fh-mbaas-api provides FeedHenry MBaaS APIs to Node.js cloud apps.
#Usage
fh-mbaas-api is included as standard with your cloud app code.
For custom apps, add the module via npm by running the following for the root of your app
npm install --save fh-mbaas-api
This will install the latest version of fh-mbaas-api and save the installed version in your package.json
#Documentation
Documentation for the $fh cloud API is maintained at the FeedHenry API Docs.
#Deprecated
Legacy Rhino functions have been deprecated. These are listed below - with their replacements in bold. All replacements listed but '$fh.web' have drop-in replacements available.
- $fh.web -> request
- $fh.log -> console.log
- $fh.parse -> JSON.parse
- $fh.stringify JSON.stringify
#Tests
Before running tests do:
npm install
npm install -g grunt-cli
Then to run the tests use npm test
On Windows, use npm run testwindows
If tests return session errors in relation to redis, like the following:
1) test session no timeout:
Uncaught AssertionError: Error: Error: Ready check failed: ERR operation not permitted
+ expected - actual
Ensure that the correct redis password is set - export FH_REDIS_PASSWORD=RedisPassword
Caveats
Two sync loops per sync frequency
Two sync loops may be invoked per sync frequency if the server-side sync frequency
differs from the client-side frequency.
This is because the client and server sync frequencies are set independently.
Setting a long frequency on a client does not change the sync frequency on the
server.
The syncFrequency
value of the dataset on the server should be set to the
sync_frequency
value of the corresponding dataset on the client to avoid this.
For example:
sync_frequency
on the client-side dataset is also set to 120 seconds.syncFrequency
on the server-side dataset is set to 120 seconds.
[6.1.8] - Wed Mar 15 11:49:24 2017 +0000
Changed
- updates dependencies to mitigate qs and moment vulnerabilities
- "fh-mbaas-client": "0.15.0",
- "fh-mbaas-express": "5.6.9",
+ "fh-mbaas-client": "0.16.5",
+ "fh-mbaas-express": "5.6.10",
- "moment": "2.14.1",
+ "moment": "2.15.2",
- "request": "2.74.0",
+ "request": "2.81.0",
- "unifiedpush-node-sender": "0.12.0",
+ "unifiedpush-node-sender": "0.12.1",