diff --git a/docs/debugging/how-to-resolve-the-dbdriver-configuration-error-when-running.md b/docs/debugging/how-to-resolve-the-dbdriver-configuration-error-when-running.md new file mode 100644 index 0000000..a85dbfe --- /dev/null +++ b/docs/debugging/how-to-resolve-the-dbdriver-configuration-error-when-running.md @@ -0,0 +1,136 @@ +# How to Resolve the `dB.driver` Configuration Error When Running the New E2E Local Evaluation Script + +## Overview + +This guide explains how to locate and resolve a configuration error related to `dB.driver` that occurs when running the new end-to-end (E2E) local evaluation script. It consolidates the information shared in Slack into a clear, repeatable process. + +## Prerequisites + +- Access to the project repository containing: + - The new E2E local evaluation script + - Project documentation (including one or more `README` files) +- A code editor or integrated development environment (IDE) capable of searching across all files (for example, Cursor, Visual Studio Code, JetBrains IDEs) +- Basic familiarity with: + - Configuration files (for example, `.env`, `config.yml`, `config.json`) + - Running local scripts from the command line + +> Note: The original Slack discussion did not specify the exact repository name, directory structure, or the specific configuration file where `dB.driver` is defined. You may need to adapt the steps below to your project’s layout. + +## Steps to Locate and Fix the `dB.driver` Error + +1. **Identify the exact error message** + + - Run the new E2E local evaluation script as you normally would. + - Copy the full error message that references `dB.driver` (or similar). + - This will help you confirm you are addressing the correct configuration issue. + +2. **Search documentation for `dB.driver`** + + - Open your project in your editor/IDE. + - Use the “search in all files” feature to search for: + - `dB.driver` + - `db.driver` + - `driver` in combination with `db` or `database` + - Focus on: + - `README.md` files in the repository root and subdirectories + - Any `docs/` or `documentation/` directories + + The Slack answer indicates that this error is documented in a README file, so you should find a section that: + - Mentions `dB.driver` (or a similar key) + - Describes how to configure it for local E2E evaluations + +3. **Locate the relevant configuration instructions** + + - Once you find the README entry, read the surrounding section carefully. + - Look for: + - The name and path of the configuration file (for example, `config/local.yml`, `.env.local`, `e2e.config.json`) + - Required values for the `dB.driver` (or equivalent) setting + - Any environment variables that must be set + +4. **Update your configuration** + + - Open the configuration file referenced in the README. + - Add or update the `dB.driver` (or equivalent) entry according to the documentation. For example (illustrative only): + ```yaml + dB: + driver: postgres + host: localhost + port: 5432 + ``` + or in an environment file: + ```bash + DB_DRIVER=postgres + ``` + - Save the file. + + > Important: The exact key name, structure, and valid values depend on your project. Use the README instructions as the source of truth. + +5. **Re-run the E2E local evaluation script** + + - After updating the configuration, run the script again. + - Confirm that the `dB.driver` error no longer appears. + - If a new error appears, capture the full message for further troubleshooting. + +## Important Notes and Caveats + +- **Documentation location is not fixed** + The Slack responses indicate that the relevant instructions are “in the readme” but do not specify which one. You may need to: + - Check multiple `README.md` files (for example, in `./`, `./e2e/`, `./scripts/`, `./docs/`) + - Search for related terms such as “local evals,” “E2E,” or “database configuration” + +- **Configuration may differ by environment** + Some projects use different configuration files for local, staging, and production environments. Ensure you are editing the configuration file used by the “new E2E local evals” script (often named with `local`, `dev`, or `e2e`). + +- **Tooling limitations** + The original question mentioned that Cursor was “not helpful in debugging.” Rely on full-text search across the repository and the project’s documentation rather than only on AI-assisted suggestions. + +## Troubleshooting Tips + +If the error persists after following the steps above: + +1. **Verify you edited the correct file** + - Confirm that the file you changed is actually loaded by the E2E local evaluation script. + - Check any startup or configuration-loading code for references to configuration paths or environment variables. + +2. **Check for typos and case sensitivity** + - Ensure the key name matches exactly what the application expects (`dB.driver` vs `db.driver` vs `DB_DRIVER`). + - Some configuration systems are case-sensitive. + +3. **Confirm environment variable loading** + - If the configuration uses environment variables: + - Ensure they are exported in your shell or defined in the correct `.env` file. + - Restart your terminal or development environment if necessary. + +4. **Search for related configuration keys** + - If `dB.driver` does not appear anywhere, search for: + - `database` + - `dbConfig` + - `connectionString` + - The error may be a derived message from a higher-level configuration wrapper. + +5. **Gather additional information if asking for help** + - When escalating to your team or support channel, provide: + - The full error message and stack trace + - The exact command you ran to start the E2E local evaluation script + - The relevant snippet from your configuration file (with secrets removed) + - The path and content of the README section you followed + +## Information That May Still Be Needed + +The Slack exchange does not specify: + +- The exact repository or directory structure +- The precise configuration file name and path +- The valid values for `dB.driver` in this project +- The exact error text emitted by the script + +To create a fully precise guide, you would need: + +- The full error message as printed by the E2E local evaluation script +- The specific README section that documents `dB.driver` +- The configuration file path and an example of a working configuration block + +Once those details are known, they should be added to this document (for example, under “Steps to Locate and Fix the `dB.driver` Error”) to make it fully actionable for all users. + +--- +*Source: [Original Slack thread](https://distylai.slack.com/archives/impl-tower-infobot/p1736435334008259)*