Refactors configuration management (#4271)
* Adds flow types / Configuration interfaces * Lets call it options * Use a single interface to generate the configurations * Translates options to definitions only if comments are set * improves logic * Moves objects around * Fixes issue affecting logging of circular objects * fixes undefined env * Moves all defaults to defaults * Adds back CLI defaults * Restored defaults in commander.js * Merge provided defaults and platform defaults * Addresses visual nits * Improves Config.js code * Adds ability to pass the default value in trailing comments * Load platform defaults from the definitions file * proper default values on various options * Adds ParseServer.start and server.start(options) as quick startup methods * Moves creating liveQueryServer http into ParseServer.js * removes dead code * Adds tests to guarantee we can start a LQ Server from main module * Fixes incorrect code regading liveQuery init port * Start a http server for LQ if port is specified * ensure we dont fail if config.port is not set * Specify port * ignore other path skipped in tests * Adds test for custom middleware setting * Refactors new Config into Config.get - Hides AppCache from ParseServer.js, use Config.put which validates * Extracts controller creation into Controllers/index.js - This makes the ParseServer init way simpler * Move serverURL inference into ParseServer * review nits
This commit is contained in:
Florent Vilmart
GitHub
@@ -1,284 +1,2 @@
|
||||
import {
|
||||
numberParser,
|
||||
numberOrBoolParser,
|
||||
objectParser,
|
||||
arrayParser,
|
||||
moduleOrObjectParser,
|
||||
booleanParser,
|
||||
nullParser
|
||||
} from '../utils/parsers';
|
||||
|
||||
export default {
|
||||
"appId": {
|
||||
env: "PARSE_SERVER_APPLICATION_ID",
|
||||
help: "Your Parse Application ID",
|
||||
required: true
|
||||
},
|
||||
"masterKey": {
|
||||
env: "PARSE_SERVER_MASTER_KEY",
|
||||
help: "Your Parse Master Key",
|
||||
required: true
|
||||
},
|
||||
"masterKeyIps": {
|
||||
env: "PARSE_SERVER_MASTER_KEY_IPS",
|
||||
help: "Restrict masterKey to be used by only these ips. defaults to [] (allow all ips)",
|
||||
default: []
|
||||
},
|
||||
"port": {
|
||||
env: "PORT",
|
||||
help: "The port to run the ParseServer. defaults to 1337.",
|
||||
default: 1337,
|
||||
action: numberParser("port")
|
||||
},
|
||||
"host": {
|
||||
env: "PARSE_SERVER_HOST",
|
||||
help: "The host to serve ParseServer on. defaults to 0.0.0.0",
|
||||
default: '0.0.0.0',
|
||||
},
|
||||
"databaseURI": {
|
||||
env: "PARSE_SERVER_DATABASE_URI",
|
||||
help: "The full URI to your mongodb database"
|
||||
},
|
||||
"databaseOptions": {
|
||||
env: "PARSE_SERVER_DATABASE_OPTIONS",
|
||||
help: "Options to pass to the mongodb client",
|
||||
action: objectParser
|
||||
},
|
||||
"collectionPrefix": {
|
||||
env: "PARSE_SERVER_COLLECTION_PREFIX",
|
||||
help: 'A collection prefix for the classes'
|
||||
},
|
||||
"serverURL": {
|
||||
env: "PARSE_SERVER_URL",
|
||||
help: "URL to your parse server with http:// or https://.",
|
||||
},
|
||||
"publicServerURL": {
|
||||
env: "PARSE_PUBLIC_SERVER_URL",
|
||||
help: "Public URL to your parse server with http:// or https://.",
|
||||
},
|
||||
"clientKey": {
|
||||
env: "PARSE_SERVER_CLIENT_KEY",
|
||||
help: "Key for iOS, MacOS, tvOS clients"
|
||||
},
|
||||
"javascriptKey": {
|
||||
env: "PARSE_SERVER_JAVASCRIPT_KEY",
|
||||
help: "Key for the Javascript SDK"
|
||||
},
|
||||
"restAPIKey": {
|
||||
env: "PARSE_SERVER_REST_API_KEY",
|
||||
help: "Key for REST calls"
|
||||
},
|
||||
"dotNetKey": {
|
||||
env: "PARSE_SERVER_DOT_NET_KEY",
|
||||
help: "Key for Unity and .Net SDK"
|
||||
},
|
||||
"webhookKey": {
|
||||
env: "PARSE_SERVER_WEBHOOK_KEY",
|
||||
help: "Key sent with outgoing webhook calls"
|
||||
},
|
||||
"cloud": {
|
||||
env: "PARSE_SERVER_CLOUD_CODE_MAIN",
|
||||
help: "Full path to your cloud code main.js"
|
||||
},
|
||||
"push": {
|
||||
env: "PARSE_SERVER_PUSH",
|
||||
help: "Configuration for push, as stringified JSON. See http://docs.parseplatform.org/parse-server/guide/#push-notifications",
|
||||
action: objectParser
|
||||
},
|
||||
"scheduledPush": {
|
||||
env: "PARSE_SERVER_SCHEDULED_PUSH",
|
||||
help: "Configuration for push scheduling. Defaults to false.",
|
||||
action: booleanParser
|
||||
},
|
||||
"oauth": {
|
||||
env: "PARSE_SERVER_OAUTH_PROVIDERS",
|
||||
help: "[DEPRECATED (use auth option)] Configuration for your oAuth providers, as stringified JSON. See http://docs.parseplatform.org/parse-server/guide/#oauth-and-3rd-party-authentication",
|
||||
action: objectParser
|
||||
},
|
||||
"auth": {
|
||||
env: "PARSE_SERVER_AUTH_PROVIDERS",
|
||||
help: "Configuration for your authentication providers, as stringified JSON. See http://docs.parseplatform.org/parse-server/guide/#oauth-and-3rd-party-authentication",
|
||||
action: objectParser
|
||||
},
|
||||
"fileKey": {
|
||||
env: "PARSE_SERVER_FILE_KEY",
|
||||
help: "Key for your files",
|
||||
},
|
||||
"facebookAppIds": {
|
||||
env: "PARSE_SERVER_FACEBOOK_APP_IDS",
|
||||
help: "[DEPRECATED (use auth option)]",
|
||||
action: function() {
|
||||
throw 'facebookAppIds is deprecated, please use { auth: \
|
||||
{facebook: \
|
||||
{ appIds: [] } \
|
||||
}\
|
||||
}\
|
||||
}';
|
||||
}
|
||||
},
|
||||
"enableAnonymousUsers": {
|
||||
env: "PARSE_SERVER_ENABLE_ANON_USERS",
|
||||
help: "Enable (or disable) anon users, defaults to true",
|
||||
action: booleanParser
|
||||
},
|
||||
"allowClientClassCreation": {
|
||||
env: "PARSE_SERVER_ALLOW_CLIENT_CLASS_CREATION",
|
||||
help: "Enable (or disable) client class creation, defaults to true",
|
||||
action: booleanParser
|
||||
},
|
||||
"mountPath": {
|
||||
env: "PARSE_SERVER_MOUNT_PATH",
|
||||
help: "Mount path for the server, defaults to /parse",
|
||||
default: "/parse"
|
||||
},
|
||||
"filesAdapter": {
|
||||
env: "PARSE_SERVER_FILES_ADAPTER",
|
||||
help: "Adapter module for the files sub-system",
|
||||
action: moduleOrObjectParser
|
||||
},
|
||||
"emailAdapter": {
|
||||
env: "PARSE_SERVER_EMAIL_ADAPTER",
|
||||
help: "Adapter module for the email sending",
|
||||
action: moduleOrObjectParser
|
||||
},
|
||||
"verifyUserEmails": {
|
||||
env: "PARSE_SERVER_VERIFY_USER_EMAILS",
|
||||
help: "Enable (or disable) user email validation, defaults to false",
|
||||
action: booleanParser
|
||||
},
|
||||
"preventLoginWithUnverifiedEmail": {
|
||||
env: "PARSE_SERVER_PREVENT_LOGIN_WITH_UNVERIFIED_EMAIL",
|
||||
help: "Prevent user from login if email is not verified and PARSE_SERVER_VERIFY_USER_EMAILS is true, defaults to false",
|
||||
action: booleanParser
|
||||
},
|
||||
"emailVerifyTokenValidityDuration": {
|
||||
env: "PARSE_SERVER_EMAIL_VERIFY_TOKEN_VALIDITY_DURATION",
|
||||
help: "Email verification token validity duration",
|
||||
action: numberParser("emailVerifyTokenValidityDuration")
|
||||
},
|
||||
"accountLockout": {
|
||||
env: "PARSE_SERVER_ACCOUNT_LOCKOUT",
|
||||
help: "account lockout policy for failed login attempts",
|
||||
action: objectParser
|
||||
},
|
||||
"passwordPolicy": {
|
||||
env: "PARSE_SERVER_PASSWORD_POLICY",
|
||||
help: "Password policy for enforcing password related rules",
|
||||
action: objectParser
|
||||
},
|
||||
"appName": {
|
||||
env: "PARSE_SERVER_APP_NAME",
|
||||
help: "Sets the app name"
|
||||
},
|
||||
"loggerAdapter": {
|
||||
env: "PARSE_SERVER_LOGGER_ADAPTER",
|
||||
help: "Adapter module for the logging sub-system",
|
||||
action: moduleOrObjectParser
|
||||
},
|
||||
"customPages": {
|
||||
env: "PARSE_SERVER_CUSTOM_PAGES",
|
||||
help: "custom pages for password validation and reset",
|
||||
action: objectParser
|
||||
},
|
||||
"maxUploadSize": {
|
||||
env: "PARSE_SERVER_MAX_UPLOAD_SIZE",
|
||||
help: "Max file size for uploads.",
|
||||
default: "20mb"
|
||||
},
|
||||
"userSensitiveFields": {
|
||||
help: "Personally identifiable information fields in the user table the should be removed for non-authorized users.",
|
||||
default: ["email"]
|
||||
},
|
||||
"sessionLength": {
|
||||
env: "PARSE_SERVER_SESSION_LENGTH",
|
||||
help: "Session duration, defaults to 1 year",
|
||||
action: numberParser("sessionLength")
|
||||
},
|
||||
"maxLimit": {
|
||||
env: "PARSE_SERVER_MAX_LIMIT",
|
||||
help: "Max value for limit option on queries, defaults to unlimited",
|
||||
action: numberParser("maxLimit")
|
||||
},
|
||||
"verbose": {
|
||||
env: "VERBOSE",
|
||||
help: "Set the logging to verbose"
|
||||
},
|
||||
"jsonLogs": {
|
||||
env: "JSON_LOGS",
|
||||
help: "Log as structured JSON objects"
|
||||
},
|
||||
"logLevel": {
|
||||
env: "PARSE_SERVER_LOG_LEVEL",
|
||||
help: "Sets the level for logs"
|
||||
},
|
||||
"logsFolder": {
|
||||
env: "PARSE_SERVER_LOGS_FOLDER",
|
||||
help: "Folder for the logs (defaults to './logs'); set to null to disable file based logging",
|
||||
action: nullParser
|
||||
},
|
||||
"silent": {
|
||||
help: "Disables console output",
|
||||
},
|
||||
"revokeSessionOnPasswordReset": {
|
||||
env: "PARSE_SERVER_REVOKE_SESSION_ON_PASSWORD_RESET",
|
||||
help: "When a user changes their password, either through the reset password email or while logged in, all sessions are revoked if this is true. Set to false if you don't want to revoke sessions.",
|
||||
action: booleanParser
|
||||
},
|
||||
"schemaCacheTTL": {
|
||||
env: "PARSE_SERVER_SCHEMA_CACHE_TTL",
|
||||
help: "The TTL for caching the schema for optimizing read/write operations. You should put a long TTL when your DB is in production. default to 0; disabled.",
|
||||
action: numberParser("schemaCacheTTL"),
|
||||
},
|
||||
"enableSingleSchemaCache": {
|
||||
env: "PARSE_SERVER_ENABLE_SINGLE_SCHEMA_CACHE",
|
||||
help: "Use a single schema cache shared across requests. Reduces number of queries made to _SCHEMA. Defaults to false, i.e. unique schema cache per request.",
|
||||
action: booleanParser
|
||||
},
|
||||
"cacheTTL": {
|
||||
env: "PARSE_SERVER_CACHE_TTL",
|
||||
help: "Sets the TTL for the in memory cache (in ms), defaults to 5000 (5 seconds)",
|
||||
action: numberParser("cacheTTL"),
|
||||
},
|
||||
"cacheMaxSize": {
|
||||
env: "PARSE_SERVER_CACHE_MAX_SIZE",
|
||||
help: "Sets the maximum size for the in memory cache, defaults to 10000",
|
||||
action: numberParser("cacheMaxSize")
|
||||
},
|
||||
"cluster": {
|
||||
env: "PARSE_SERVER_CLUSTER",
|
||||
help: "Run with cluster, optionally set the number of processes default to os.cpus().length",
|
||||
action: numberOrBoolParser("cluster")
|
||||
},
|
||||
"liveQuery": {
|
||||
env: "PARSE_SERVER_LIVE_QUERY_OPTIONS",
|
||||
help: "parse-server's LiveQuery configuration object",
|
||||
action: objectParser
|
||||
},
|
||||
"liveQuery.classNames": {
|
||||
help: "parse-server's LiveQuery classNames",
|
||||
action: arrayParser
|
||||
},
|
||||
"liveQuery.redisURL": {
|
||||
help: "parse-server's LiveQuery redisURL",
|
||||
},
|
||||
"startLiveQueryServer": {
|
||||
help: "Starts the liveQuery server",
|
||||
action: booleanParser
|
||||
},
|
||||
"liveQueryPort": {
|
||||
help: 'Specific port to start the live query server',
|
||||
action: numberParser("liveQueryPort")
|
||||
},
|
||||
"liveQueryServerOptions": {
|
||||
help: "Live query server configuration options (will start the liveQuery server)",
|
||||
action: objectParser
|
||||
},
|
||||
"middleware": {
|
||||
help: "middleware for express server, can be string or function"
|
||||
},
|
||||
"objectIdSize": {
|
||||
env: "PARSE_SERVER_OBJECT_ID_SIZE",
|
||||
help: "Sets the number of characters in generated object id's, default 10",
|
||||
action: numberParser("objectIdSize")
|
||||
}
|
||||
};
|
||||
const ParseServerDefinitions = require('../../Options/Definitions').ParseServerOptions;
|
||||
export default ParseServerDefinitions;
|
||||
|
||||
Reference in New Issue
Block a user