/**
- * CogniCity Server Data API
- * @module src/api/index
- **/
-import {Router} from 'express';
-
-// Import the dependencies we need to handle the request
-import errorHandler from 'api-error-handler';
-
-// Import validation dependencies
-import validate from 'celebrate';
-
-// Get the current version
-import {version} from '../../package.json';
-
-// Import our routes
-import cards from './routes/cards';
-import cities from './routes/cities';
-import feeds from './routes/feeds';
-import floodgauges from './routes/floodgauges';
-import floods from './routes/floods';
-import infrastructure from './routes/infrastructure';
-import reports from './routes/reports';
-
-/**
-* Build CogniCity Server Data API
-* @alias module:src/api/index
-* @param {Object} config Server configuration
-* @param {Object} db PG Promise database instance
-* @param {Object} logger Configured Winston logger instance
-* @return {Object} api Express router object for API routes
-**/
-export default ({config, db, logger}) => {
- let api = Router(); // eslint-disable-line new-cap
-
- // Return the API version
- api.get('/', (req, res) => {
- res.status(200).json({version});
- });
-
- // Mount the various endpoints
- // api.use('/areas', cards({ config, db, logger }));// TODO: local_areas
- api.use('/cards', cards({config, db, logger}));
- api.use('/cities', cities({config, db, logger}));
- api.use('/feeds', feeds({config, db, logger}));
- api.use('/floodgauges', floodgauges({config, db, logger}));
- api.use('/floods', floods({config, db, logger}));
- api.use('/infrastructure', infrastructure({config, db, logger}));
- api.use('/reports', reports({config, db, logger}));
-
- // Handle validation errors (wording can be overridden using err.isJoi)
- api.use(validate.errors());
-
- // Handle not found errors
- api.use((req, res) => {
- res.status(404).json({message: 'URL not found', url: req.url});
- });
-
- // Handle errors gracefully returning nicely formatted json
- api.use(errorHandler());
-
- return api;
-};
-Home
- - - - - - - - -cognicity-server 3.0.1
- - - - - - - - - - - - - - - -cognicity-server
API Server for CogniCity
-
DOI for current stable release v3.0.0
-
Summary
This is the NodeJS server which runs the CogniCity Data API used by Urban Risk Map instances, such as PetaBencana.id site.
-Run
ES6 Support is provided by Babel.
--
-
Install requirements from the provided
-package.jsonby doingnpm install.
-Copy the
-sample.envfile to a local.envand fill-in the required parameters. This local file will be ignored by Git and so should be secret safe. Further details on configuration are described below.
-To run a local development instance of the server do
-npm run dev
-
Configuration
Server configuration parameters are stored in a configuration file which is parsed by index.js on startup. Local configuration parameters are imported from the .env into src/config.js. See config.js for full details example configuration. Any variable not defined in .env will pickup the default value below (also see config.js)—note that local environment variables will override both .env and config.js. The following environment variables are currently supported by the configurtion:
-
-
APP_NAME: Name of the application (default:cognicity-server)
-API_FEEDS_QLUE_CITIES: Names of cities used by the Qlue data feed
-API_FEEDS_QLUE_DISASTER_TYPES: Names of disaster types used by the Qlue data feed
-API_FEEDS_DETIK_DISASTER_TYPES: Names of disaster types used by the Detik data feed
-API_REPORTS_TIME_WINDOW: Time window for report data queries (default 1 hour)
-API_REPORTS_TIME_WINDOW_MAX: Maximum limit for time window (default 1 week)
-API_REPORTS_LIMIT: Total maximum number of reports to return in a single request
-API_FLOODGAUGE_REPORTS_TIME_WINDOW: Time window for flood data (normally 12 hours)
-API_FLOODGAUGE_REPORTS_TIME_WINDOW: Total maximum number of flood gauge records to return in a single request
-AUTH0_AUDIENCE: Data API to be authenticated
-AUTH0_CLIENT_ID: Auth0 client ID (NOTE: this is mandatory and no default value)
-AUTH0_ISSUER: Web address of Auth0 instance
-AWS_REGION: Region for AWS Infrastructure
-AWS_S3_ACCESS_KEY_ID: Access key ID for AWS S3 bucket
-AWS_S3_SECRET_ACCESS_KEY: Access key secret for AWS S3 bucket
-AWS_S3_SIGNATURE_VERSION: Version of AWS S3 signature to use
-AUTH0_SECRET: Auth0 secret (NOTE: this is mandatory and no default value)
-BODY_LIMIT: Maximum body size POST/PUT/PATCH (default:100kb)
-CACHE: Should caching be enabled? (default:false)
-CACHE_DURATION_CARDS: How long should cards be cached for? (default: '1 minute')
-CACHE_DURATION_FLOODS: How long should floods be cached for? (default: '1 hour')
-CACHE_DURATION_FLOODS_STATES: How long should flood states be cached for? (default: '1 hour')
-CACHE_DURATION_INFRASTRUCTURE: How long should infrastructure be cached for? (default: '1 hour')
-COMPRESS: Should the server gzip compress results? Only works if CACHE is disabled. (default:false)
-CORS: Should Cross Object Resource Sharing (CORS) be enabled (default:false)
-CORS_HEADERS: CORS headers to use (default:[Link])
-DISASTER_TYPES: Disaster type keywords for report classification (default:flood,prep)
-FORMAT_DEFAULT: Which format to return results in by default (default:json)
-FORMATS: Formats supported by the system (as comma separated list) (default:json,xml)
-GEO_FORMAT_DEFAULT: Which format to return geographic results in by default (default:topojson)
-GEO_FORMATS: Geographic formats supported by the system (as comma separated list) (default:topojson,geojson,cap)
-GEO_PRECISION: Precision to use when rounding geographic coordinates (default:10)
-IMAGES_BUCKET: AWS S3 bucket for image uploads (default:testing-riskmap-image-uploads)
-IMAGES_HOST: Endpoint for image hosting (default:images.petabencana.id),
-INFRASTRUCTURE_TYPES: Infrastructure types supported (as comma separated list) (default:floodgates,pumps,waterways)
-LANGUAGES: Supported languages
-LOG_CONSOLE: In development mode we log to the console by default, in other environments this must be enabled if required by setting this parameter totrue(default:false)
-LOG_DIR: Which directory should logs be written to. If blank, not supplied or the directory is not writable by the application this will default to the current directory
-LOG_JSON: Should json format be used for logging (default:false)
-LOG_LEVEL: What level to log at. Levels are:silly,debug,verbose,info,warn,error.debuglevel is recommended for development. (default:error)
-LOG_MAX_FILE_SIZE: Maximum size of log file in bytes before rotating (default:1024 * 1024 * 100i.e.100mb)
-LOG_MAX_FILES: Maximum number of log files before rotation (default:10)
-NODE_ENV: Which environment are we in. Environments are: development, test, staging, production (default:development)
-PGHOST: Postgres DB hostname (default:127.0.0.1)
-PGDATABASE: Postgres DB database name (default:cognicity)
-PGPASSWORD: Postgres DB password (default:p@ssw0rd)
-PGPORT: Postgres DB port (default:5432)
-PGSSL: SSL enabled on Postgres DB connection? (default:false)
-PGTIMEOUT: Max duration on DB calls before timeout (in milliseconds) (default:5000i.e. 5 seconds)
-PGUSER: Postgres DB username (default:postgres)
-PORT: Which port should the application run on (default:8001)
-REGION_CODES: Which region codes are supported (as comma separated list) (default:jbd,bdg,sby)
-REPORT_TYPES: Classifiers for report types (default:drain,desilting,canalrepair,treeclearing,flood)
-RESPONSE_TIME: Should the server return anX-Response-Timeheader detailing the time taken to process the request. This is useful for both development to identify latency impact on testing and production for performance / health monitoring (default:false)
-SECURE_AUTH0: Whether Auth0 JWT token security should be applied to secure routes (default:false)
-TABLE_FLOODGAUGE_REPORTS: Postgres table name for flood-gauge reports
-TABLE_FEEDS_QLUE: Postgres table name for Qlue feed
-TABLE_FEEDS_DETIK: Postgres table name for Detik feed
-TABLE_GRASP_CARDS: Postgres table name for Grasp Cards
-TABLE_GRASP_LOG: Postgres table name for Grasp activity
-TABLE_GRASP_REPORTS: Postgres table name for Grasp reports
-TABLE_INSTANCE_REGIONS: Postgres table for operating regions
-TABLE_LOCAL_AREAS: Postgres table for local areas data for each operating region
-TABLE_REM_STATUS: Postgres table for current flood states from REM
-TABLE_REM_STATUS_LOG: Postgres table for REM log
-TABLE_REPORTS: Postgres table for reports
-
A few points to note on config:
--
-
- AWS Beanstalk: If you're deploying to AWS Elastic Beanstalk you may need to configure environment variables for each of the above under Configuration -> Software configuration. -
Building
Run npm run -s build to build.
Testing
Testing is run by Travis. ESLint runs to check syntax. Integration tests, formed by chaining unit tests, are used to check the API. Coverage is provided by Istanbul and Coveralls. See src/test/ for scripts. Beware that integration tests may pollute tables (e.g. user tables in feeds), it is not recommended to run tests against prod databases with live data. The default database (used for testing) is cognicity. Travis-ci creates a new schema instance for testing using https://github.com/urbanriskmap/cognicity-schema, see .travis.yml for more details.
-To run tests locally a new database "cognicity_server_testing" is required on localhost.
-Code follows the Google JavaScript style.ESLint is run with tests to enfoce style.
-Issue Tracking
Issues are tracked using GitHub
-Release
The release procedure is as follows:
--
-
- Update the CHANGELOG.md file with the newly released version, date, and a high-level overview of changes. Commit the change. -
- Create a tag in git from the current head of master. The tag version should be the same as the version specified in the package.json file - this is the release version. -
- Update the version in the package.json file and commit the change. -
- Further development is now on the updated version number until the release process begins again. -
API Notes
Full API documentation at https://docs.petabencana.id. This documentation is stored in the petabencana-docs repository.
--
-
- The dbgeo library expects timestamps from database to be in UTC (i.e. not a local timezone) -
License
See LICENSE.md