Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
@platformatic/config
Advanced tools
@platformatic/config - npm Package Compare versions
Comparing version 0.35.5 to 0.36.0
300
index.js
| 'use strict' | ||
| const { basename, join, resolve, dirname } = require('path') | ||
| const { readFile, access } = require('fs/promises') | ||
| const EventEmitter = require('events') | ||
| const Ajv = require('ajv') | ||
| const fastifyPlugin = require('./lib/plugin') | ||
| const dotenv = require('dotenv') | ||
| const { request } = require('undici') | ||
| const { FileWatcher } = require('@platformatic/utils') | ||
| const { getParser, analyze, upgrade } = require('@platformatic/metaconfig') | ||
| const { ConfigManager } = require('./lib/manager') | ||
| const { Store } = require('./lib/store') | ||
| const { loadConfig, printConfigValidationErrors, printAndExitLoadConfigError } = require('./lib/load-config') | ||
| class ConfigManager extends EventEmitter { | ||
| constructor (opts) { | ||
| super() | ||
| this.pupa = null | ||
| this.envWhitelist = opts.envWhitelist || [] | ||
| if (!opts.source) { | ||
| throw new Error('Source missing.') | ||
| } | ||
| this.validationErrors = [] | ||
| if (typeof opts.source === 'string') { | ||
| this.fullPath = resolve(opts.source) | ||
| const allowToWatch = opts.allowToWatch || [] | ||
| allowToWatch.push(basename(this.fullPath)) | ||
| this._parser = getParser(this.fullPath) | ||
| this.fileWatcher = new FileWatcher({ | ||
| path: dirname(this.fullPath), | ||
| allowToWatch | ||
| }) | ||
| /* c8 ignore next 3 */ | ||
| if (opts.watch) { | ||
| this.startWatching() | ||
| } | ||
| this.dirname = dirname(this.fullPath) | ||
| } else { | ||
| this.current = opts.source | ||
| this.dirname = opts.dirname || process.cwd() | ||
| } | ||
| this.schema = opts.schema || {} | ||
| this.schemaOptions = opts.schemaOptions || {} | ||
| this._providedSchema = !!opts.schema | ||
| this._originalEnv = opts.env || {} | ||
| this.env = this.purgeEnv(this._originalEnv) | ||
| this._onMissingEnv = opts.onMissingEnv | ||
| if (typeof opts.transformConfig === 'function') { | ||
| this._transformConfig = opts.transformConfig | ||
| } | ||
| } | ||
| toFastifyPlugin () { | ||
| return async (app, opts) => { | ||
| return fastifyPlugin(app, { | ||
| ...opts, | ||
| configManager: this | ||
| }) | ||
| } | ||
| } | ||
| async stopWatching () { | ||
| await this.fileWatcher.stopWatching() | ||
| } | ||
| startWatching () { | ||
| if (this.fileWatcher.isWatching) return | ||
| this.fileWatcher.on('update', async () => { | ||
| try { | ||
| await this.parseAndValidate() | ||
| this.emit('update', this.current) | ||
| } catch (err) { | ||
| this.emit('error', err) | ||
| } | ||
| }) | ||
| this.fileWatcher.startWatching() | ||
| } | ||
| purgeEnv (providedEnvironment) { | ||
| const env = { | ||
| ...process.env, | ||
| ...providedEnvironment | ||
| } | ||
| const purged = {} | ||
| for (const key in env) { | ||
| if (key.match(/^PLT_/) || this.envWhitelist.includes(key)) { | ||
| purged[key] = env[key] | ||
| } | ||
| } | ||
| return purged | ||
| } | ||
| async replaceEnv (configString) { | ||
| if (this.pupa === null) { | ||
| this.pupa = (await import('pupa')).default | ||
| } | ||
| const paths = [ | ||
| join(dirname(this.fullPath), '.env'), | ||
| join(process.cwd(), '.env') | ||
| ] | ||
| let dotEnvPath | ||
| for (const p of paths) { | ||
| try { | ||
| await access(p) | ||
| dotEnvPath = p | ||
| break | ||
| } catch { | ||
| // Nothing to do | ||
| } | ||
| } | ||
| let env = { ...this._originalEnv } | ||
| if (dotEnvPath) { | ||
| const data = await readFile(dotEnvPath, 'utf-8') | ||
| const parsed = dotenv.parse(data) | ||
| env = { ...env, ...parsed } | ||
| } | ||
| this.env = this.purgeEnv(env) | ||
| const escapeJSONstring = ({ key, value }) => { | ||
| if (!value && this._onMissingEnv) { | ||
| value = this._onMissingEnv(key) | ||
| } | ||
| if (!value) { | ||
| return value | ||
| } | ||
| // TODO this shoudl handle all the escapes chars | ||
| // defined in https://www.json.org/json-en.html | ||
| // but it's good enough for now. | ||
| return value.replace(/\\/g, '\\\\').replace(/\n/g, '\\n') | ||
| } | ||
| return this.pupa(configString, this.env, { transform: escapeJSONstring }) | ||
| } | ||
| _transformConfig () {} | ||
| async parse () { | ||
| try { | ||
| if (this.fullPath) { | ||
| const configString = await this.load() | ||
| this.current = this._parser(await this.replaceEnv(configString)) | ||
| // try updating the config format to latest | ||
| try { | ||
| let meta = await analyze({ config: this.current }) | ||
| meta = upgrade(meta) | ||
| this.current = meta.config | ||
| } catch { | ||
| // nothing to do | ||
| } | ||
| } | ||
| if (!this._providedSchema && this.current.$schema) { | ||
| // The user did not provide a schema, but we have a link to the schema | ||
| // in $schema. Try to fetch the schema and ignore anything that goes | ||
| // wrong. | ||
| try { | ||
| const { body, statusCode } = await request(this.current.$schema) | ||
| if (statusCode === 200) { | ||
| this.schema = await body.json() | ||
| } | ||
| } catch { | ||
| // Ignore error. | ||
| } | ||
| } | ||
| const validationResult = this.validate() | ||
| if (!validationResult) { | ||
| return false | ||
| } | ||
| await this._transformConfig() | ||
| return true | ||
| } catch (err) { | ||
| if (err.name === 'MissingValueError') { | ||
| if (!err.key.match(/^PLT_/) && !this.envWhitelist.includes(err.key)) { | ||
| throw new Error(`${err.key} is an invalid placeholder. All placeholders must be prefixed with PLT_.\nDid you mean PLT_${err.key}?`) | ||
| } else { | ||
| throw new Error(`${err.key} env variable is missing.`) | ||
| } | ||
| } | ||
| const newerr = new Error(`Cannot parse config file. ${err.message}`) | ||
| newerr.cause = err | ||
| throw newerr | ||
| } | ||
| } | ||
| validate () { | ||
| if (!this.current) { | ||
| return false | ||
| } | ||
| const ajv = new Ajv(this.schemaOptions) | ||
| ajv.addKeyword({ | ||
| keyword: 'resolvePath', | ||
| type: 'string', | ||
| schemaType: 'boolean', | ||
| // TODO: figure out how to implement this via the new `code` | ||
| // option in Ajv | ||
| validate: (schema, path, parentSchema, data) => { | ||
| if (typeof path !== 'string' || path.trim() === '') { | ||
| return false | ||
| } | ||
| const resolved = resolve(this.dirname, path) | ||
| data.parentData[data.parentDataProperty] = resolved | ||
| return true | ||
| } | ||
| }) | ||
| const ajvValidate = ajv.compile(this.schema) | ||
| const res = ajvValidate(this.current) | ||
| /* c8 ignore next 12 */ | ||
| if (!res) { | ||
| this.validationErrors = ajvValidate.errors.map((err) => { | ||
| return { | ||
| path: err.instancePath === '' ? '/' : err.instancePath, | ||
| message: err.message + ' ' + JSON.stringify(err.params) | ||
| } | ||
| }) | ||
| return false | ||
| } | ||
| return true | ||
| } | ||
| async parseAndValidate () { | ||
| const validationResult = await this.parse() | ||
| if (!validationResult) { | ||
| throw new Error(this.validationErrors.map((err) => { | ||
| return err.message | ||
| }).join('\n')) | ||
| } | ||
| } | ||
| async update (newConfig) { | ||
| const _old = { ...this.current } | ||
| this.current = newConfig | ||
| if (!this.validate()) { | ||
| this.current = _old | ||
| return false | ||
| } | ||
| await this._transformConfig() | ||
| this.emit('update', this.current) | ||
| return true | ||
| } | ||
| async load () { | ||
| const configString = await readFile(this.fullPath, 'utf-8') | ||
| return configString | ||
| } | ||
| static listConfigFiles (type) { | ||
| if (type) { | ||
| // A config type (service, db, etc.) was explicitly provided. | ||
| return [ | ||
| `platformatic.${type}.json`, | ||
| `platformatic.${type}.json5`, | ||
| `platformatic.${type}.yaml`, | ||
| `platformatic.${type}.yml`, | ||
| `platformatic.${type}.toml`, | ||
| `platformatic.${type}.tml` | ||
| ] | ||
| } else { | ||
| // A config type was not provided. Search for all known types and | ||
| // formats. Unfortunately, this means the ConfigManager needs to be | ||
| // aware of the different application types (but that should be small). | ||
| return [ | ||
| ...this.listConfigFiles('service'), | ||
| ...this.listConfigFiles('db'), | ||
| ...this.listConfigFiles('composer'), | ||
| ...this.listConfigFiles('runtime') | ||
| ] | ||
| } | ||
| } | ||
| static async findConfigFile (directory, type) { | ||
| directory ??= process.cwd() | ||
| const configFileNames = this.listConfigFiles(type) | ||
| const configFilesAccessibility = await Promise.all(configFileNames.map((fileName) => isFileAccessible(fileName, directory))) | ||
| const accessibleConfigFilename = configFileNames.find((value, index) => configFilesAccessibility[index]) | ||
| return accessibleConfigFilename | ||
| } | ||
| } | ||
| async function isFileAccessible (filename, directory) { | ||
| try { | ||
| const filePath = resolve(directory, filename) | ||
| await access(filePath) | ||
| return true | ||
| } catch (err) { | ||
| return false | ||
| } | ||
| } | ||
| module.exports = ConfigManager | ||
| module.exports.ConfigManager = ConfigManager | ||
| module.exports.Store = Store | ||
| module.exports.loadConfig = loadConfig | ||
| module.exports.printConfigValidationErrors = printConfigValidationErrors | ||
| module.exports.printAndExitLoadConfigError = printAndExitLoadConfigError |
| { | ||
| "name": "@platformatic/config", | ||
| "version": "0.35.5", | ||
| "version": "0.36.0", | ||
| "description": "Platformatic DB Config Manager", | ||
@@ -26,9 +26,11 @@ "main": "index.js", | ||
| "dependencies": { | ||
| "@fastify/deepmerge": "^1.3.0", | ||
| "ajv": "^8.12.0", | ||
| "dotenv": "^16.1.4", | ||
| "minimist": "^1.2.8", | ||
| "pupa": "^3.1.0", | ||
| "semver": "^7.5.1", | ||
| "undici": "^5.22.1", | ||
| "@platformatic/metaconfig": "0.35.5", | ||
| "@platformatic/utils": "0.35.5" | ||
| "@platformatic/metaconfig": "0.36.0", | ||
| "@platformatic/utils": "0.36.0" | ||
| }, | ||
@@ -35,0 +37,0 @@ "scripts": { |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Debug access
Supply chain riskUses debug, reflection and dynamic code execution features.
Found 1 instance in 1 package
Dynamic require
Supply chain riskDynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.
Found 1 instance in 1 package
Environment variable access
Supply chain riskPackage accesses environment variables, which may be a sign of credential stuffing or data theft.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by40.24%
78193
- Number of package files
- increased by64%
41
- Lines of code
- increased by55.05%
2349
Worsened metrics
- Dependency count
- increased by28.57%
9
- Number of low supply chain risk alerts
- increased by46.67%
22
Dependency changes
+ Added@fastify/deepmerge@^1.3.0
+ Addedminimist@^1.2.8
+ Added@platformatic/metaconfig@0.36.0(transitive)
+ Added@platformatic/utils@0.36.0(transitive)
+ Addedminimist@1.2.8(transitive)
- Removed@platformatic/metaconfig@0.35.5(transitive)
- Removed@platformatic/utils@0.35.5(transitive)
Updated@platformatic/utils@0.36.0