Compare commits

..

10 Commits

Author SHA1 Message Date
jkunz 521628cb72 v6.1.4
Default (tags) / security (push) Failing after 1s
Default (tags) / test (push) Failing after 1s
Default (tags) / release (push) Has been skipped
Default (tags) / metadata (push) Has been skipped
2026-05-01 15:54:40 +00:00
jkunz 5e31dc93a3 fix(qenv): replace smartfile-based config loading with native fs and yaml parsing for env files 2026-05-01 15:54:39 +00:00
jkunz c0d33340c3 6.1.3 2025-08-16 12:35:35 +00:00
jkunz 5a81caa7bb fix(qenv): Handle falsy environment values correctly, improve env source resolution, add tests and update test script 2025-08-16 12:35:35 +00:00
jkunz a7e3bf1223 6.1.2 2025-08-14 07:22:44 +00:00
jkunz aedbc25269 fix(readme): Correct DATABASE_CONFIG example formatting in README and add local settings configuration file 2025-08-14 07:22:44 +00:00
jkunz d5f56e6ef6 6.1.1 2025-08-14 07:20:05 +00:00
jkunz 88bed685bc fix(qenv): Improve documentation, update dependencies, and refine project configuration 2025-08-14 07:20:05 +00:00
philkunz 7b34ef8453 6.1.0 2024-11-22 18:47:51 +01:00
philkunz e25406662f feat(core): Added new method getEnvVarOnDemandStrict to throw error for unset env vars 2024-11-22 18:47:50 +01:00
19 changed files with 9471 additions and 4918 deletions
@@ -0,0 +1,38 @@
# Code Style and Conventions
## TypeScript Conventions
- Use TypeScript with ES modules (type: "module" in package.json)
- All files use `.js` extensions in imports (even for .ts files)
- Interfaces prefixed with `I` (e.g., `IUserData`)
- Types prefixed with `T` (e.g., `TEnvVarRef`)
- Filenames must be lowercase
- Avoid ENUMs when possible
## File Organization
- Source code in `ts/` directory
- Tests in `test/` directory
- Plugin imports in `ts/qenv.plugins.ts`
- Main exports in `ts/index.ts`
- Class files named as `qenv.classes.<classname>.ts`
## Import Style
- Import all dependencies in plugins file
- Reference as `plugins.moduleName.method()`
- Use full import paths with .js extension
- Group imports: external packages, then internal modules
## Testing
- Use @git.zone/tstest framework
- Import expect from tapbundle: `import { tap, expect } from '@git.zone/tstest/tapbundle'`
- Test files end with `export default tap.start()` (tstest pattern)
- Test file naming: `*.both.ts`, `*.node.ts`, or `*.browser.ts`
## Documentation
- Keep comments minimal unless specifically requested
- README should be lowercase: `readme.md`
- Documentation should be engaging and use emojis where appropriate
## Git Conventions
- Small, focused commits
- Use `git mv` for file operations
- Never commit without running tests and type checks
+37
View File
@@ -0,0 +1,37 @@
# Qenv Project Overview
## Purpose
@push.rocks/qenv is a TypeScript/Node.js module for managing environment variables in Node.js projects. It provides a unified interface for loading environment variables from multiple sources:
- Process environment variables
- YAML configuration files (.yml/.yaml)
- JSON configuration files (.json)
- Docker secrets
- Dynamic/async variable resolution via functions
## Key Features
- Support for required and optional environment variables
- Multi-source loading hierarchy (env vars > config files > Docker secrets)
- Base64-encoded object support for complex configurations
- Synchronous and asynchronous variable retrieval
- Strict mode with error throwing for unset variables
- TypeScript with full type definitions
- Logging via @push.rocks/smartlog
## Main Components
- `Qenv` class: Core class for environment variable management
- `CloudlyAdapter`: Configuration vault integration
- Support for `qenv.yml` (required vars definition) and `env.yml`/`env.json` (values)
## Tech Stack
- TypeScript
- Node.js
- pnpm package manager
- @push.rocks ecosystem libraries (smartfile, smartlog, smartpath)
- @git.zone tools for building and testing
## Dependencies
- @api.global/typedrequest
- @configvault.io/interfaces
- @push.rocks/smartfile
- @push.rocks/smartlog
- @push.rocks/smartpath
+30
View File
@@ -0,0 +1,30 @@
# Suggested Commands for Qenv Development
## Build & Test Commands
- `pnpm test` - Run tests with tstest
- `pnpm build` - Build the project with tsbuild (includes --web --allowimplicitany flags)
- `pnpm buildDocs` - Generate documentation with tsdoc
## Development Tools
- `tsx <file>` - Execute TypeScript files directly (globally available)
- `tstest test/test.some.ts --verbose` - Run specific test file with verbose output
## Package Management
- `pnpm install` - Install dependencies
- `pnpm install --save-dev <package>` - Add development dependency
- `pnpm install <package>` - Add production dependency
## Git Operations
- `git mv <old> <new>` - Move/rename files preserving history
- `git status` - Check current repository status
- `git diff` - View uncommitted changes
## Type Checking
- `tsbuild check test/**/* --skiplibcheck` - Type check test files
- `pnpm run build` - Type check and build module files
## System Commands (Linux)
- `ls` - List files
- `find . -name "pattern"` - Find files by pattern
- `rg "pattern"` - Search file contents (ripgrep)
- `curl` - Make HTTP requests for testing/debugging
@@ -0,0 +1,32 @@
# Task Completion Checklist
When completing any development task in the qenv project, follow these steps:
## Pre-Commit Checks
1. **Run Tests**: `pnpm test`
- Ensure all tests pass
- Add new tests for new functionality
2. **Type Checking**: `pnpm run build`
- Verify no TypeScript errors
- Check that build output is generated correctly
3. **Code Quality**:
- Verify code follows project conventions
- Ensure no console.log statements left in production code
- Check imports use proper .js extensions
## Documentation Updates
- Update README.md if API changes
- Update changelog.md for notable changes
- Ensure JSDoc comments for public APIs
## Final Verification
- Review changes with `git diff`
- Test the module can be imported correctly
- Verify no breaking changes to public API
## Important Notes
- NEVER commit without explicit user approval
- Always run tests and build before suggesting commit
- If lint/typecheck commands unknown, ask user and update CLAUDE.md
+68
View File
@@ -0,0 +1,68 @@
# language of the project (csharp, python, rust, java, typescript, go, cpp, or ruby)
# * For C, use cpp
# * For JavaScript, use typescript
# Special requirements:
# * csharp: Requires the presence of a .sln file in the project folder.
language: typescript
# whether to use the project's gitignore file to ignore files
# Added on 2025-04-07
ignore_all_files_in_gitignore: true
# list of additional paths to ignore
# same syntax as gitignore, so you can use * and **
# Was previously called `ignored_dirs`, please update your config if you are using that.
# Added (renamed)on 2025-04-07
ignored_paths: []
# whether the project is in read-only mode
# If set to true, all editing tools will be disabled and attempts to use them will result in an error
# Added on 2025-04-18
read_only: false
# list of tool names to exclude. We recommend not excluding any tools, see the readme for more details.
# Below is the complete list of tools for convenience.
# To make sure you have the latest list of tools, and to view their descriptions,
# execute `uv run scripts/print_tool_overview.py`.
#
# * `activate_project`: Activates a project by name.
# * `check_onboarding_performed`: Checks whether project onboarding was already performed.
# * `create_text_file`: Creates/overwrites a file in the project directory.
# * `delete_lines`: Deletes a range of lines within a file.
# * `delete_memory`: Deletes a memory from Serena's project-specific memory store.
# * `execute_shell_command`: Executes a shell command.
# * `find_referencing_code_snippets`: Finds code snippets in which the symbol at the given location is referenced.
# * `find_referencing_symbols`: Finds symbols that reference the symbol at the given location (optionally filtered by type).
# * `find_symbol`: Performs a global (or local) search for symbols with/containing a given name/substring (optionally filtered by type).
# * `get_current_config`: Prints the current configuration of the agent, including the active and available projects, tools, contexts, and modes.
# * `get_symbols_overview`: Gets an overview of the top-level symbols defined in a given file.
# * `initial_instructions`: Gets the initial instructions for the current project.
# Should only be used in settings where the system prompt cannot be set,
# e.g. in clients you have no control over, like Claude Desktop.
# * `insert_after_symbol`: Inserts content after the end of the definition of a given symbol.
# * `insert_at_line`: Inserts content at a given line in a file.
# * `insert_before_symbol`: Inserts content before the beginning of the definition of a given symbol.
# * `list_dir`: Lists files and directories in the given directory (optionally with recursion).
# * `list_memories`: Lists memories in Serena's project-specific memory store.
# * `onboarding`: Performs onboarding (identifying the project structure and essential tasks, e.g. for testing or building).
# * `prepare_for_new_conversation`: Provides instructions for preparing for a new conversation (in order to continue with the necessary context).
# * `read_file`: Reads a file within the project directory.
# * `read_memory`: Reads the memory with the given name from Serena's project-specific memory store.
# * `remove_project`: Removes a project from the Serena configuration.
# * `replace_lines`: Replaces a range of lines within a file with new content.
# * `replace_symbol_body`: Replaces the full definition of a symbol.
# * `restart_language_server`: Restarts the language server, may be necessary when edits not through Serena happen.
# * `search_for_pattern`: Performs a search for a pattern in the project.
# * `summarize_changes`: Provides instructions for summarizing the changes made to the codebase.
# * `switch_modes`: Activates modes by providing a list of their names
# * `think_about_collected_information`: Thinking tool for pondering the completeness of collected information.
# * `think_about_task_adherence`: Thinking tool for determining whether the agent is still on track with the current task.
# * `think_about_whether_you_are_done`: Thinking tool for determining whether the task is truly completed.
# * `write_memory`: Writes a named memory (for future reference) to Serena's project-specific memory store.
excluded_tools: []
# initial prompt for the project. It will always be given to the LLM upon activating the project
# (contrary to the memories, which are loaded on demand).
initial_prompt: ""
project_name: "qenv"
+36
View File
@@ -0,0 +1,36 @@
{
"@git.zone/cli": {
"projectType": "npm",
"module": {
"githost": "code.foss.global",
"gitscope": "push.rocks",
"gitrepo": "qenv",
"description": "A module for easily handling environment variables in Node.js projects with support for .yml and .json configuration.",
"npmPackagename": "@push.rocks/qenv",
"license": "MIT",
"keywords": [
"environment variables",
"configuration management",
"Node.js",
"TypeScript",
"Docker secrets",
"CI/CD",
"testing"
]
},
"release": {
"registries": [
"https://verdaccio.lossless.digital",
"https://registry.npmjs.org"
],
"accessLevel": "public"
}
},
"@git.zone/tsdoc": {
"legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
},
"@ship.zone/szci": {
"npmGlobalTools": [],
"npmRegistryUrl": "registry.npmjs.org"
}
}
+38
View File
@@ -1,5 +1,43 @@
# Changelog # Changelog
## 2026-05-01 - 6.1.4 - fix(qenv)
replace smartfile-based config loading with native fs and yaml parsing for env files
- switch env and qenv file parsing to native fs with explicit JSON/YAML handling
- tighten TypeScript typings and optional path handling to avoid undefined and non-Error access issues
- update ConfigVault adapter to return the env bundle shape expected by consumers
- refresh build tooling and add yaml as a runtime dependency
## 2025-08-16 - 6.1.3 - fix(qenv)
Handle falsy environment values correctly, improve env source resolution, add tests and update test script
- Treat 0, false and empty string as valid environment values by checking for !== undefined when resolving env vars
- Refactor source resolution to iterate over environment, env file, Docker secrets and secret.json, returning the first defined value
- Ensure env.json and Docker secret JSON return strings for scalar values and base64-encode object values
- Add tests covering falsy values and lookup behavior (test/test.falsy.ts)
- Update package.json test script to run tstest with --verbose --testlog --timeout flags
## 2025-08-14 - 6.1.2 - fix(readme)
Correct DATABASE_CONFIG example formatting in README and add local settings configuration file
- Fix YAML formatting in DATABASE_CONFIG example to reflect proper YAML syntax
- Introduce .claude/settings.local.json with updated permission settings
## 2025-08-14 - 6.1.1 - fix(qenv)
Improve documentation, update dependencies, and refine project configuration
- Revamp README with enhanced installation, configuration, and usage instructions
- Add new project documentation files including code style conventions, project overview, suggested commands, and task checklist
- Upgrade dependency versions in package.json (e.g. @git.zone/tsbuild, @git.zone/tstest, @push.rocks/smartfile, smartlog, and smartpath)
- Adjust test import to use '@git.zone/tstest/tapbundle' for improved compatibility
- Introduce new local configuration files (.claude/settings.local.json and .serena/project.yml) to standardize project settings
## 2024-11-22 - 6.1.0 - feat(core)
Added new method getEnvVarOnDemandStrict to throw error for unset env vars
- Introduced getEnvVarOnDemandStrict method in Qenv class for strict retrieval of environment variables.
- Upgraded various @git.zone and @push.rocks dependencies for improved functionality and security.
## 2024-11-18 - 6.0.8 - fix(Qenv) ## 2024-11-18 - 6.0.8 - fix(Qenv)
Fix environment file path initialization logic. Fix environment file path initialization logic.
+21
View File
@@ -0,0 +1,21 @@
The MIT License (MIT)
Copyright (c) 2026 Task Venture Capital GmbH
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
+13 -6
View File
@@ -1,9 +1,5 @@
{ {
"npmci": { "@git.zone/cli": {
"npmGlobalTools": [],
"npmAccessLevel": "public"
},
"gitzone": {
"projectType": "npm", "projectType": "npm",
"module": { "module": {
"githost": "code.foss.global", "githost": "code.foss.global",
@@ -21,9 +17,20 @@
"CI/CD", "CI/CD",
"testing" "testing"
] ]
},
"release": {
"registries": [
"https://verdaccio.lossless.digital",
"https://registry.npmjs.org"
],
"accessLevel": "public"
} }
}, },
"tsdoc": { "@git.zone/tsdoc": {
"legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n" "legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
},
"@ship.zone/szci": {
"npmGlobalTools": [],
"npmRegistryUrl": "registry.npmjs.org"
} }
} }
+17 -14
View File
@@ -1,14 +1,15 @@
{ {
"name": "@push.rocks/qenv", "name": "@push.rocks/qenv",
"version": "6.0.8", "version": "6.1.4",
"private": false, "private": false,
"description": "A module for easily handling environment variables in Node.js projects with support for .yml and .json configuration.", "description": "A module for easily handling environment variables in Node.js projects with support for .yml and .json configuration.",
"main": "dist_ts/index.js", "main": "dist_ts/index.js",
"typings": "dist_ts/index.d.ts", "typings": "dist_ts/index.d.ts",
"type": "module", "type": "module",
"scripts": { "scripts": {
"test": "(tstest test/)", "test": "(tstest test/ --verbose --testlog --timeout 20)",
"build": "(tsbuild --web --allowimplicitany)", "build": "tsbuild --web",
"format": "gitzone format",
"buildDocs": "tsdoc" "buildDocs": "tsdoc"
}, },
"repository": { "repository": {
@@ -24,25 +25,24 @@
"CI/CD", "CI/CD",
"testing" "testing"
], ],
"author": "Lossless GmbH", "author": "Task Venture Capital GmbH <hello@task.vc>",
"license": "MIT", "license": "MIT",
"bugs": { "bugs": {
"url": "https://gitlab.com/pushrocks/qenv/issues" "url": "https://gitlab.com/pushrocks/qenv/issues"
}, },
"homepage": "https://code.foss.global/push.rocks/qenv", "homepage": "https://code.foss.global/push.rocks/qenv",
"devDependencies": { "devDependencies": {
"@git.zone/tsbuild": "^2.1.72", "@git.zone/tsbuild": "^4.4.0",
"@git.zone/tsrun": "^1.2.44", "@git.zone/tsrun": "^2.0.3",
"@git.zone/tstest": "^1.0.86", "@git.zone/tstest": "^3.6.3",
"@push.rocks/tapbundle": "^5.0.15", "@types/node": "^25.6.0"
"@types/node": "^20.11.17"
}, },
"dependencies": { "dependencies": {
"@api.global/typedrequest": "^3.0.4", "@api.global/typedrequest": "^3.3.0",
"@configvault.io/interfaces": "^1.0.17", "@configvault.io/interfaces": "^1.0.17",
"@push.rocks/smartfile": "^11.0.4", "@push.rocks/smartlog": "^3.2.2",
"@push.rocks/smartlog": "^3.0.3", "@push.rocks/smartpath": "^6.0.0",
"@push.rocks/smartpath": "^5.0.11" "yaml": "^2.8.3"
}, },
"files": [ "files": [
"ts/**/*", "ts/**/*",
@@ -53,10 +53,13 @@
"dist_ts_web/**/*", "dist_ts_web/**/*",
"assets/**/*", "assets/**/*",
"cli.js", "cli.js",
".smartconfig.json",
"license",
"npmextra.json", "npmextra.json",
"readme.md" "readme.md"
], ],
"browserslist": [ "browserslist": [
"last 1 chrome versions" "last 1 chrome versions"
] ],
"packageManager": "pnpm@10.11.0+sha512.6540583f41cc5f628eb3d9773ecee802f4f9ef9923cc45b69890fb47991d4b092964694ec3a4f738a420c918a333062c8b925d312f42e4f0c263eb603551f977"
} }
+8600 -4782
View File
File diff suppressed because it is too large Load Diff
+302 -67
View File
@@ -1,109 +1,344 @@
# @push.rocks/qenv # @push.rocks/qenv 🔐
easy promised environments **Smart Environment Variable Management for Node.js**
## Install > Never hardcode secrets again. Load environment variables from multiple sources with ease and confidence.
To install `@push.rocks/qenv`, you need to have Node.js installed on your system. Once Node.js is installed, you can add `@push.rocks/qenv` to your project by running the following command in your project's root directory:
## 🚀 Features
**Multi-source Loading** - Automatically loads from environment variables, config files, and Docker secrets
**Type-Safe** - Full TypeScript support with comprehensive type definitions
**Flexible Formats** - Supports `.yml`, `.yaml`, and `.json` configuration files
**Docker Ready** - Built-in support for Docker secrets and secret.json files
**Async & Sync** - Both synchronous and asynchronous variable retrieval
**Strict Mode** - Optional strict mode that throws errors for missing variables
**Base64 Objects** - Handle complex configuration objects with automatic encoding/decoding
**Dynamic Resolution** - Support for async functions as environment variable sources
## 📦 Installation
```bash ```bash
# Using npm
npm install @push.rocks/qenv --save npm install @push.rocks/qenv --save
# Using pnpm (recommended)
pnpm add @push.rocks/qenv
# Using yarn
yarn add @push.rocks/qenv
``` ```
This command will add `@push.rocks/qenv` as a dependency to your project, and you will be ready to use it in your application. ## 🎯 Quick Start
## Usage
`@push.rocks/qenv` provides a convenient way to manage and access environment variables in your Node.js projects, especially when dealing with different environments like development, testing, and production. Its primary use is to load environment-specific variables in an easy and organized manner. Below is an extensive guide on how to use this module effectively in various scenarios, ensuring you can handle environment variables efficiently in your projects.
### Getting Started
First, ensure you have TypeScript configured in your project. `@push.rocks/qenv` is fully typed, providing excellent IntelliSense support when working in editors that support TypeScript, such as Visual Studio Code.
#### Importing Qenv
To get started, import the `Qenv` class from `@push.rocks/qenv`:
```typescript ```typescript
import { Qenv } from '@push.rocks/qenv'; import { Qenv } from '@push.rocks/qenv';
// Create a new Qenv instance
const qenv = new Qenv('./', './', true);
// Access environment variables
const dbHost = await qenv.getEnvVarOnDemand('DB_HOST');
const apiKey = await qenv.getEnvVarOnDemand('API_KEY');
// Use strict mode to ensure variables exist
const criticalVar = await qenv.getEnvVarOnDemandStrict('CRITICAL_CONFIG');
// Throws error if CRITICAL_CONFIG is not set!
``` ```
#### Basic Configuration ## 📖 Configuration
`@push.rocks/qenv` works with two main files: `qenv.yml` for specifying required environment variables, and `env.yml` for specifying values for these variables. These files should be placed in your project directory.
##### qenv.yml ### Setting Up Your Environment Files
This file specifies the environment variables that are required by your application. An example `qenv.yml` might look like this:
#### 1. Define Required Variables (`qenv.yml`)
Create a `qenv.yml` file to specify which environment variables your application needs:
```yaml ```yaml
required: required:
- DB_HOST - DB_HOST
- DB_USER - DB_USER
- DB_PASS - DB_PASSWORD
- API_KEY
- LOG_LEVEL
``` ```
##### env.yml #### 2. Provide Values (`env.yml` or `env.json`)
This file contains the actual values for the environment variables in a development or testing environment. An example `env.yml` could be:
For local development, create an `env.yml` or `env.json` file:
**env.yml:**
```yaml ```yaml
DB_HOST: localhost DB_HOST: localhost
DB_USER: user DB_USER: developer
DB_PASS: pass DB_PASSWORD: supersecret123
API_KEY: dev-key-12345
LOG_LEVEL: debug
``` ```
#### Instantiating Qenv **env.json:**
Create an instance of `Qenv` by providing paths to the directories containing the `qenv.yml` and `env.yml` files, respectively: ```json
{
```typescript "DB_HOST": "localhost",
const myQenv = new Qenv('./path/to/dir/with/qenv', './path/to/dir/with/env'); "DB_USER": "developer",
"DB_PASSWORD": "supersecret123",
"API_KEY": "dev-key-12345",
"LOG_LEVEL": "debug"
}
``` ```
If the `env.yml` file is in the same directory as `qenv.yml`, you can omit the second argument: > 💡 **Pro Tip:** Add `env.yml` and `env.json` to your `.gitignore` to keep secrets out of version control!
## 🔥 Advanced Usage
### Loading Priority
Qenv loads variables in this order (first found wins):
1. **Process environment variables** - Already set in `process.env`
2. **Configuration files** - From `env.yml` or `env.json`
3. **Docker secrets** - From `/run/secrets/`
4. **Docker secret JSON** - From `/run/secrets/secret.json`
### Handling Complex Objects
Store and retrieve complex configuration objects:
```typescript ```typescript
const myQenv = new Qenv('./path/to/dir/with/both'); # In env.yml
DATABASE_CONFIG:
database:
host: localhost
port: 5432
options:
ssl: true
poolSize: 10
// Qenv automatically handles base64 encoding
const dbConfig = await qenv.getEnvVarOnDemandAsObject('DATABASE_CONFIG');
console.log(dbConfig.database.options.poolSize); // 10
``` ```
#### Accessing Environment Variables ### Dynamic Environment Variables
After instantiating `Qenv`, you can access the loaded environment variables directly from `process.env` in Node.js or through the `myQenv` instance for more complex scenarios like asynchronous variable resolution:
Load variables from external sources dynamically:
```typescript ```typescript
// Accessing directly via process.env const qenv = new Qenv();
console.log(process.env.DB_HOST); // 'localhost' in development environment
// Accessing via Qenv instance for more advanced scenarios // Define an async function to fetch configuration
(async () => { const fetchFromVault = async () => {
const dbHost = await myQenv.getEnvVarOnDemand('DB_HOST'); const response = await fetch('https://vault.example.com/api/secret');
console.log(dbHost); // 'localhost' const data = await response.json();
})(); return data.secret;
```
### Advanced Usage
#### Handling Missing Variables
By default, `Qenv` will throw an error and exit if any of the required environment variables specified in `qenv.yml` are missing. You can disable this behavior by passing `false` as the third argument to the constructor, which allows your application to handle missing variables gracefully:
```typescript
const myQenv = new Qenv('./path/to/dir/with/qenv', './path/to/dir/with/env', false);
```
#### Dynamic Environment Variables
For dynamic or computed environment variables, you can define functions that resolve these variables asynchronously. This is particularly useful for variables that require fetching from an external source:
```typescript
// Define a function to fetch a variable
const fetchDbHost = async () => {
// Logic to fetch DB_HOST from an external service
return 'dynamic.host';
}; };
// Use the function with getEnvVarOnDemand // Use the function as an environment variable source
(async () => { const secret = await qenv.getEnvVarOnDemand(fetchFromVault);
const dbHost = await myQenv.getEnvVarOnDemand(fetchDbHost);
console.log(dbHost); // 'dynamic.host'
})();
``` ```
#### Reading Variables from Docker Secrets or Other Sources ### Working with Docker
Internally, `@push.rocks/qenv` supports reading from Docker secrets, providing flexibility for applications deployed in Docker environments. The module attempts to read each required variable from the process environment, a provided `env.yml` file, Docker secrets, or any custom source you integrate.
### Conclusion Qenv seamlessly integrates with Docker secrets:
`@push.rocks/qenv` simplifies handling environment variables across different environments, making your application's configuration more manageable and secure. By separating variable definitions from their values and providing support for dynamic resolution, `@push.rocks/qenv` offers a robust solution for managing configuration in Node.js projects. Whether you're working in a local development environment, CI/CD pipelines, or production, `@push.rocks/qenv` ensures that you have the correct configuration for the task at hand.
Note: Due to the complexity and depth of `@push.rocks/qenv`, this documentation aims to cover general and advanced usage comprehensively. Please refer to the module's official documentation and typed definitions for further details on specific features or configuration options. ```dockerfile
# docker-compose.yml
version: '3.7'
services:
app:
image: your-app
secrets:
- db_password
- api_key
secrets:
db_password:
external: true
api_key:
external: true
```
Your application automatically reads from `/run/secrets/`:
```typescript
const qenv = new Qenv();
// Automatically loads from /run/secrets/db_password
const dbPassword = await qenv.getEnvVarOnDemand('db_password');
```
### Handling Missing Variables
Control how your application handles missing environment variables:
```typescript
// Fail fast (default behavior)
const qenvStrict = new Qenv('./', './', true);
// Application exits if required variables are missing
// Graceful handling
const qenvRelaxed = new Qenv('./', './', false);
// Application continues, you handle missing variables
// Check what's missing
if (qenvRelaxed.missingEnvVars.length > 0) {
console.warn('Missing variables:', qenvRelaxed.missingEnvVars);
// Implement fallback logic
}
```
### Strict Mode for Critical Variables
Use the new strict getter when you absolutely need a variable:
```typescript
try {
// This will throw if TOKEN is not set
const token = await qenv.getEnvVarOnDemandStrict('TOKEN');
// You can also check multiple fallback names
const db = await qenv.getEnvVarOnDemandStrict(['DATABASE_URL', 'DB_CONNECTION']);
} catch (error) {
console.error('Critical configuration missing:', error.message);
process.exit(1);
}
```
## 🏗️ CI/CD Integration
### GitHub Actions
```yaml
name: Deploy
on: [push]
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Deploy with secrets
env:
API_KEY: ${{ secrets.API_KEY }}
DB_PASSWORD: ${{ secrets.DB_PASSWORD }}
run: |
npm install
npm run deploy
```
### GitLab CI
```yaml
deploy:
stage: deploy
script:
- npm install
- npm run deploy
variables:
API_KEY: $CI_API_KEY
DB_PASSWORD: $CI_DB_PASSWORD
```
## 🎭 Testing
For testing, create a separate `test/assets/env.yml`:
```typescript
import { Qenv } from '@push.rocks/qenv';
describe('MyApp', () => {
let qenv: Qenv;
beforeEach(() => {
qenv = new Qenv('./test/assets', './test/assets', false);
});
it('should load test configuration', async () => {
const testVar = await qenv.getEnvVarOnDemand('TEST_VAR');
expect(testVar).toBe('test-value');
});
});
```
## 🔍 Debugging
Enable detailed logging to troubleshoot environment variable loading:
```typescript
const qenv = new Qenv();
// Check what's loaded
console.log('Required vars:', qenv.requiredEnvVars);
console.log('Available vars:', qenv.availableEnvVars);
console.log('Missing vars:', qenv.missingEnvVars);
// Access the logger
qenv.logger.log('info', 'Custom log message');
```
## 📊 Real-World Example
Here's how you might use qenv in a production Node.js application:
```typescript
import { Qenv } from '@push.rocks/qenv';
import { createServer } from './server';
import { connectDatabase } from './database';
async function bootstrap() {
// Initialize environment
const qenv = new Qenv();
// Load critical configuration
const config = {
port: await qenv.getEnvVarOnDemand('PORT') || '3000',
dbUrl: await qenv.getEnvVarOnDemandStrict('DATABASE_URL'),
apiKey: await qenv.getEnvVarOnDemandStrict('API_KEY'),
logLevel: await qenv.getEnvVarOnDemand('LOG_LEVEL') || 'info',
features: await qenv.getEnvVarOnDemandAsObject('FEATURE_FLAGS')
};
// Connect to database
await connectDatabase(config.dbUrl);
// Start server
const server = createServer(config);
server.listen(config.port, () => {
console.log(`🚀 Server running on port ${config.port}`);
});
}
bootstrap().catch(error => {
console.error('Failed to start application:', error);
process.exit(1);
});
```
## 🤝 API Reference
### Class: `Qenv`
#### Constructor
```typescript
new Qenv(
qenvFileBasePathArg?: string, // Path to qenv.yml (default: process.cwd())
envFileBasePathArg?: string, // Path to env.yml/json (default: same as qenv)
failOnMissing?: boolean // Exit on missing vars (default: true)
)
```
#### Methods
| Method | Description | Returns |
|--------|-------------|---------|
| `getEnvVarOnDemand(name)` | Get environment variable value | `Promise<string \| undefined>` |
| `getEnvVarOnDemandStrict(name)` | Get variable or throw error | `Promise<string>` |
| `getEnvVarOnDemandSync(name)` | Synchronously get variable | `string \| undefined` |
| `getEnvVarOnDemandAsObject(name)` | Get variable as decoded object | `Promise<any>` |
#### Properties
| Property | Type | Description |
|----------|------|-------------|
| `requiredEnvVars` | `string[]` | List of required variable names |
| `availableEnvVars` | `string[]` | List of found variable names |
| `missingEnvVars` | `string[]` | List of missing variable names |
| `keyValueObject` | `object` | All loaded variables as key-value pairs |
## License and Legal Information ## License and Legal Information
+120
View File
@@ -0,0 +1,120 @@
import * as path from 'path';
import { tap, expect } from '@git.zone/tstest/tapbundle';
import * as qenv from '../ts/index.js';
const testDir = path.dirname(new URL(import.meta.url).pathname);
// Test falsy values handling
tap.test('should handle falsy values correctly', async () => {
// Set up environment variables with falsy values
process.env['FALSY_FALSE'] = 'false';
process.env['FALSY_ZERO'] = '0';
process.env['FALSY_EMPTY'] = '';
const testQenv = new qenv.Qenv(testDir, testDir, false);
// Test that falsy values are returned, not undefined
expect(await testQenv.getEnvVarOnDemand('FALSY_FALSE')).toEqual('false');
expect(await testQenv.getEnvVarOnDemand('FALSY_ZERO')).toEqual('0');
expect(await testQenv.getEnvVarOnDemand('FALSY_EMPTY')).toEqual('');
// Test sync versions
expect(testQenv.getEnvVarOnDemandSync('FALSY_FALSE')).toEqual('false');
expect(testQenv.getEnvVarOnDemandSync('FALSY_ZERO')).toEqual('0');
expect(testQenv.getEnvVarOnDemandSync('FALSY_EMPTY')).toEqual('');
// Test that undefined is still returned for non-existent variables
expect(await testQenv.getEnvVarOnDemand('NON_EXISTENT')).toBeUndefined();
expect(testQenv.getEnvVarOnDemandSync('NON_EXISTENT')).toBeUndefined();
// Clean up
delete process.env['FALSY_FALSE'];
delete process.env['FALSY_ZERO'];
delete process.env['FALSY_EMPTY'];
});
tap.test('should handle falsy values in env.json file', async () => {
// Create a test env.json with falsy values
const testAssetsDir = path.join(testDir, 'assets-falsy');
const fs = await import('fs');
// Create directory if it doesn't exist
if (!fs.existsSync(testAssetsDir)) {
fs.mkdirSync(testAssetsDir, { recursive: true });
}
// Create env.json with falsy values
const envJsonContent = {
JSON_FALSE: false,
JSON_ZERO: 0,
JSON_EMPTY: ''
};
fs.writeFileSync(
path.join(testAssetsDir, 'env.json'),
JSON.stringify(envJsonContent, null, 2)
);
const testQenv = new qenv.Qenv(testAssetsDir, testAssetsDir, false);
// Test that falsy values from JSON are returned correctly
expect(await testQenv.getEnvVarOnDemand('JSON_FALSE')).toEqual('false');
expect(await testQenv.getEnvVarOnDemand('JSON_ZERO')).toEqual('0');
expect(await testQenv.getEnvVarOnDemand('JSON_EMPTY')).toEqual('');
// Clean up
fs.rmSync(testAssetsDir, { recursive: true, force: true });
});
tap.test('should throw error for undefined in strict mode', async () => {
const testQenv = new qenv.Qenv(testDir, testDir, false);
// Set a falsy value
process.env['FALSY_VALUE'] = '0';
// Should NOT throw for falsy value
let result;
try {
result = await testQenv.getEnvVarOnDemandStrict('FALSY_VALUE');
} catch (error) {
// Should not reach here
expect(true).toBeFalse();
}
expect(result).toEqual('0');
// Should throw for non-existent variable
let threwError = false;
try {
await testQenv.getEnvVarOnDemandStrict('NON_EXISTENT_VAR');
} catch (error) {
threwError = true;
const errorMessage = error instanceof Error ? error.message : String(error);
expect(errorMessage).toContain('is not set');
}
expect(threwError).toBeTrue();
// Clean up
delete process.env['FALSY_VALUE'];
});
tap.test('should handle array of env vars with falsy values', async () => {
const testQenv = new qenv.Qenv(testDir, testDir, false);
// Set up test environment
process.env['FIRST_VAR'] = '0';
process.env['SECOND_VAR'] = 'false';
// Test that it returns the first defined value, even if falsy
const result = await testQenv.getEnvVarOnDemand(['NON_EXISTENT', 'FIRST_VAR', 'SECOND_VAR']);
expect(result).toEqual('0');
// Test sync version
const resultSync = testQenv.getEnvVarOnDemandSync(['NON_EXISTENT', 'FIRST_VAR', 'SECOND_VAR']);
expect(resultSync).toEqual('0');
// Clean up
delete process.env['FIRST_VAR'];
delete process.env['SECOND_VAR'];
});
export default tap.start();
+2 -2
View File
@@ -1,5 +1,5 @@
import * as path from 'path'; import * as path from 'path';
import { tap, expect } from '@push.rocks/tapbundle'; import { tap, expect } from '@git.zone/tstest/tapbundle';
import * as qenv from '../ts/index.js'; import * as qenv from '../ts/index.js';
import * as smartpath from '@push.rocks/smartpath'; import * as smartpath from '@push.rocks/smartpath';
@@ -32,4 +32,4 @@ tap.test('keyValueObjectArray should hold all retrieved values', async () => {
expect(await testQenv.keyValueObject.key2).toEqual('fromJson'); expect(await testQenv.keyValueObject.key2).toEqual('fromJson');
}); });
tap.start(); export default tap.start();
+1 -1
View File
@@ -3,6 +3,6 @@
*/ */
export const commitinfo = { export const commitinfo = {
name: '@push.rocks/qenv', name: '@push.rocks/qenv',
version: '6.0.8', version: '6.1.4',
description: 'A module for easily handling environment variables in Node.js projects with support for .yml and .json configuration.' description: 'A module for easily handling environment variables in Node.js projects with support for .yml and .json configuration.'
} }
+3 -2
View File
@@ -1,13 +1,13 @@
import * as plugins from './qenv.plugins.js'; import * as plugins from './qenv.plugins.js';
export class CloudlyAdapter { export class CloudlyAdapter {
public configVaultUrl: string; public configVaultUrl?: string;
constructor(configVaultUrl?: string) { constructor(configVaultUrl?: string) {
this.configVaultUrl = configVaultUrl; this.configVaultUrl = configVaultUrl;
} }
public async getConfigBundle(): Promise<plugins.configvaultInterfaces.data.IConfigBundle> { public async getConfigBundle(): Promise<plugins.configvaultInterfaces.data.IEnvBundle | null> {
if (this.configVaultUrl) { if (this.configVaultUrl) {
console.log(`ConfigVault specified through constructor`) console.log(`ConfigVault specified through constructor`)
} else if (process.env['CONFIGVAULT_URL']) { } else if (process.env['CONFIGVAULT_URL']) {
@@ -26,5 +26,6 @@ export class CloudlyAdapter {
const response = await tr.fire({ const response = await tr.fire({
authorization: parsedUrl.pathname.replace('/', ''), authorization: parsedUrl.pathname.replace('/', ''),
}) })
return response.envBundle;
} }
} }
+99 -35
View File
@@ -2,18 +2,19 @@ import { CloudlyAdapter } from './qenv.classes.configvaultadapter.js';
import * as plugins from './qenv.plugins.js'; import * as plugins from './qenv.plugins.js';
export type TEnvVarRef = string | (() => Promise<string>); export type TEnvVarRef = string | (() => Promise<string>);
type TKeyValueObject = Record<string, any>;
export class Qenv { export class Qenv {
public requiredEnvVars: string[] = []; public requiredEnvVars: string[] = [];
public availableEnvVars: string[] = []; public availableEnvVars: string[] = [];
public missingEnvVars: string[] = []; public missingEnvVars: string[] = [];
public keyValueObject: { [key: string]: any } = {}; public keyValueObject: TKeyValueObject = {};
public logger = new plugins.smartlog.ConsoleLog(); public logger = new plugins.smartlog.ConsoleLog();
public cloudlyAdapter: CloudlyAdapter; public cloudlyAdapter: CloudlyAdapter;
public qenvFilePathAbsolute: string; public qenvFilePathAbsolute = '';
public envFilePathAbsolute: string; public envFilePathAbsolute?: string;
constructor( constructor(
qenvFileBasePathArg: string = process.cwd(), qenvFileBasePathArg: string = process.cwd(),
@@ -27,7 +28,7 @@ export class Qenv {
this.checkForMissingEnvVars(failOnMissing); this.checkForMissingEnvVars(failOnMissing);
} }
private initializeFilePaths(qenvFileBasePathArg: string, envFileBasePathArg: string) { private initializeFilePaths(qenvFileBasePathArg: string, envFileBasePathArg?: string) {
this.qenvFilePathAbsolute = plugins.path.join( this.qenvFilePathAbsolute = plugins.path.join(
plugins.path.resolve(qenvFileBasePathArg), plugins.path.resolve(qenvFileBasePathArg),
'qenv.yml' 'qenv.yml'
@@ -40,9 +41,9 @@ export class Qenv {
const envFileYmlPath = plugins.path.join(envFileBasePath, 'env.yml'); const envFileYmlPath = plugins.path.join(envFileBasePath, 'env.yml');
const envFileYamlPath = plugins.path.join(envFileBasePath, 'env.yaml'); const envFileYamlPath = plugins.path.join(envFileBasePath, 'env.yaml');
const envFileJsonExists = plugins.smartfile.fs.fileExistsSync(envFileJsonPath); const envFileJsonExists = this.fileExists(envFileJsonPath);
const envFileYmlExists = plugins.smartfile.fs.fileExistsSync(envFileYmlPath); const envFileYmlExists = this.fileExists(envFileYmlPath);
const envFileYamlExists = plugins.smartfile.fs.fileExistsSync(envFileYamlPath); const envFileYamlExists = this.fileExists(envFileYamlPath);
if (envFileJsonExists && (envFileYmlExists || envFileYamlExists)) { if (envFileJsonExists && (envFileYmlExists || envFileYamlExists)) {
this.logger.log('warn', 'Both env.json and env.yml files exist! Using env.json'); this.logger.log('warn', 'Both env.json and env.yml files exist! Using env.json');
@@ -58,10 +59,13 @@ export class Qenv {
} }
private loadRequiredEnvVars() { private loadRequiredEnvVars() {
if (plugins.smartfile.fs.fileExistsSync(this.qenvFilePathAbsolute)) { if (this.fileExists(this.qenvFilePathAbsolute)) {
const qenvFile = plugins.smartfile.fs.toObjectSync(this.qenvFilePathAbsolute); const qenvFile = this.readObjectFromFile(this.qenvFilePathAbsolute);
if (qenvFile?.required && Array.isArray(qenvFile.required)) { const requiredEnvVars = qenvFile.required;
this.requiredEnvVars.push(...qenvFile.required); if (Array.isArray(requiredEnvVars)) {
this.requiredEnvVars.push(
...requiredEnvVars.filter((envVar): envVar is string => typeof envVar === 'string')
);
} else { } else {
this.logger.log('warn', 'qenv.yml does not contain a "required" Array!'); this.logger.log('warn', 'qenv.yml does not contain a "required" Array!');
} }
@@ -71,7 +75,7 @@ export class Qenv {
private loadAvailableEnvVars() { private loadAvailableEnvVars() {
for (const envVar of this.requiredEnvVars) { for (const envVar of this.requiredEnvVars) {
const value = this.getEnvVarOnDemand(envVar); const value = this.getEnvVarOnDemand(envVar);
if (value) { if (value !== undefined) {
this.availableEnvVars.push(envVar); this.availableEnvVars.push(envVar);
this.keyValueObject[envVar] = value; this.keyValueObject[envVar] = value;
} }
@@ -101,7 +105,7 @@ export class Qenv {
if (Array.isArray(envVarNameOrNames)) { if (Array.isArray(envVarNameOrNames)) {
for (const envVarName of envVarNameOrNames) { for (const envVarName of envVarNameOrNames) {
const value = await this.tryGetEnvVar(envVarName); const value = await this.tryGetEnvVar(envVarName);
if (value) { if (value !== undefined) {
return value; return value;
} }
} }
@@ -111,13 +115,28 @@ export class Qenv {
} }
} }
/**
* Like getEnvVarOnDemand, but throws an error if the env var is not set.
* @param envVarNameOrNames
* @returns
*/
public async getEnvVarOnDemandStrict(
envVarNameOrNames: TEnvVarRef | TEnvVarRef[]
): Promise<string> {
const value = await this.getEnvVarOnDemand(envVarNameOrNames);
if (value === undefined) {
throw new Error(`Env var ${envVarNameOrNames} is not set!`);
}
return value;
}
public getEnvVarOnDemandSync(envVarNameOrNames: string | string[]): string | undefined { public getEnvVarOnDemandSync(envVarNameOrNames: string | string[]): string | undefined {
console.warn('requesting env var sync leaves out potentially important async env sources.'); console.warn('requesting env var sync leaves out potentially important async env sources.');
if (Array.isArray(envVarNameOrNames)) { if (Array.isArray(envVarNameOrNames)) {
for (const envVarName of envVarNameOrNames) { for (const envVarName of envVarNameOrNames) {
const value = this.tryGetEnvVarSync(envVarName); const value = this.tryGetEnvVarSync(envVarName);
if (value) { if (value !== undefined) {
return value; return value;
} }
} }
@@ -141,21 +160,37 @@ export class Qenv {
return await envVarRefArg(); return await envVarRefArg();
} }
return ( const sources = [
this.getFromEnvironmentVariable(envVarRefArg) || this.getFromEnvironmentVariable(envVarRefArg),
this.getFromEnvYamlOrJsonFile(envVarRefArg) || this.getFromEnvYamlOrJsonFile(envVarRefArg),
this.getFromDockerSecret(envVarRefArg) || this.getFromDockerSecret(envVarRefArg),
this.getFromDockerSecretJson(envVarRefArg) this.getFromDockerSecretJson(envVarRefArg)
); ];
for (const value of sources) {
if (value !== undefined) {
return value;
}
}
return undefined;
} }
private tryGetEnvVarSync(envVarName: string): string | undefined { private tryGetEnvVarSync(envVarName: string): string | undefined {
return ( const sources = [
this.getFromEnvironmentVariable(envVarName) || this.getFromEnvironmentVariable(envVarName),
this.getFromEnvYamlOrJsonFile(envVarName) || this.getFromEnvYamlOrJsonFile(envVarName),
this.getFromDockerSecret(envVarName) || this.getFromDockerSecret(envVarName),
this.getFromDockerSecretJson(envVarName) this.getFromDockerSecretJson(envVarName)
); ];
for (const value of sources) {
if (value !== undefined) {
return value;
}
}
return undefined;
} }
private getFromEnvironmentVariable(envVarName: string): string | undefined { private getFromEnvironmentVariable(envVarName: string): string | undefined {
@@ -163,16 +198,19 @@ export class Qenv {
} }
private getFromEnvYamlOrJsonFile(envVarName: string): string | undefined { private getFromEnvYamlOrJsonFile(envVarName: string): string | undefined {
if (!plugins.smartfile.fs.fileExistsSync(this.envFilePathAbsolute)) { if (!this.fileExists(this.envFilePathAbsolute)) {
return undefined; return undefined;
} }
try { try {
const envJson = plugins.smartfile.fs.toObjectSync(this.envFilePathAbsolute); const envJson = this.readObjectFromFile(this.envFilePathAbsolute);
const value = envJson[envVarName]; const value = envJson[envVarName];
if (typeof value === 'object') { if (value === undefined) {
return undefined;
}
if (typeof value === 'object' && value !== null) {
return 'base64Object:' + this.encodeBase64(value); return 'base64Object:' + this.encodeBase64(value);
} }
return value; return String(value);
} catch (error) { } catch (error) {
return undefined; return undefined;
} }
@@ -180,23 +218,26 @@ export class Qenv {
private getFromDockerSecret(envVarName: string): string | undefined { private getFromDockerSecret(envVarName: string): string | undefined {
const secretPath = `/run/secrets/${envVarName}`; const secretPath = `/run/secrets/${envVarName}`;
if (plugins.smartfile.fs.fileExistsSync(secretPath)) { if (this.fileExists(secretPath)) {
return plugins.smartfile.fs.toStringSync(secretPath); return plugins.fs.readFileSync(secretPath, 'utf8');
} }
return undefined; return undefined;
} }
private getFromDockerSecretJson(envVarName: string): string | undefined { private getFromDockerSecretJson(envVarName: string): string | undefined {
if (plugins.smartfile.fs.isDirectory('/run/secrets')) { if (this.directoryExists('/run/secrets')) {
const availableSecrets = plugins.smartfile.fs.listAllItemsSync('/run/secrets'); const availableSecrets = plugins.fs.readdirSync('/run/secrets');
for (const secret of availableSecrets) { for (const secret of availableSecrets) {
if (secret.includes('secret.json')) { if (secret.includes('secret.json')) {
const secretObject = plugins.smartfile.fs.toObjectSync(`/run/secrets/${secret}`); const secretObject = this.readObjectFromFile(`/run/secrets/${secret}`);
const value = secretObject[envVarName]; const value = secretObject[envVarName];
if (typeof value === 'object') { if (value === undefined) {
continue;
}
if (typeof value === 'object' && value !== null) {
return 'base64Object:' + this.encodeBase64(value); return 'base64Object:' + this.encodeBase64(value);
} }
return value; return String(value);
} }
} }
} }
@@ -212,4 +253,27 @@ export class Qenv {
const decodedString = Buffer.from(encodedString, 'base64').toString('utf-8'); const decodedString = Buffer.from(encodedString, 'base64').toString('utf-8');
return JSON.parse(decodedString); return JSON.parse(decodedString);
} }
private fileExists(filePath: string | undefined): filePath is string {
if (!filePath) {
return false;
}
return plugins.fs.existsSync(filePath);
}
private directoryExists(directoryPath: string): boolean {
try {
return plugins.fs.statSync(directoryPath).isDirectory();
} catch {
return false;
}
}
private readObjectFromFile(filePath: string): TKeyValueObject {
const fileString = plugins.fs.readFileSync(filePath, 'utf8');
const parsedObject = filePath.endsWith('.json')
? JSON.parse(fileString)
: plugins.yaml.parse(fileString);
return typeof parsedObject === 'object' && parsedObject !== null ? parsedObject : {};
}
} }
+8 -3
View File
@@ -1,7 +1,8 @@
// native // native
import * as fs from 'node:fs';
import * as path from 'path'; import * as path from 'path';
export { path }; export { fs, path };
// @api.global scope // @api.global scope
import * as typedrequest from '@api.global/typedrequest'; import * as typedrequest from '@api.global/typedrequest';
@@ -11,12 +12,16 @@ export {
} }
// @pushrocks scope // @pushrocks scope
import * as smartfile from '@push.rocks/smartfile';
import * as smartlog from '@push.rocks/smartlog'; import * as smartlog from '@push.rocks/smartlog';
export { smartfile, smartlog }; export { smartlog };
// @configvault.io scope // @configvault.io scope
import * as configvaultInterfaces from '@configvault.io/interfaces'; import * as configvaultInterfaces from '@configvault.io/interfaces';
export { configvaultInterfaces }; export { configvaultInterfaces };
// third party scope
import * as yaml from 'yaml';
export { yaml };
+4 -4
View File
@@ -5,10 +5,10 @@
"target": "ES2022", "target": "ES2022",
"module": "NodeNext", "module": "NodeNext",
"moduleResolution": "NodeNext", "moduleResolution": "NodeNext",
"noImplicitAny": true,
"esModuleInterop": true, "esModuleInterop": true,
"verbatimModuleSyntax": true "verbatimModuleSyntax": true,
"types": ["node"]
}, },
"exclude": [ "exclude": ["dist_*/**/*.d.ts"]
"dist_*/**/*.d.ts"
]
} }