refactor(config): rename snowflake_username to snowflake_user

[asithade]

Summary

Rename the environment variable SNOWFLAKE_USERNAME to SNOWFLAKE_USER across all configuration files, code, and documentation for consistency with Snowflake SDK conventions.

Changes

Files Modified (5 files):

1. apps/lfx-one/src/server/services/snowflake.service.ts

   • Updated ConnectionOptions to use process.env['SNOWFLAKE_USER']
   • Line 256: Changed from SNOWFLAKE_USERNAME to SNOWFLAKE_USER

2. apps/lfx-one/.env.example

   • Updated environment variable name in configuration example
   • Line 39: SNOWFLAKE_USER=your-username

3. charts/lfx-v2-ui/values.yaml

   • Updated Helm chart environment variable definition
   • Line 215: SNOWFLAKE_USER

4. charts/lfx-v2-ui/README.md

   • Updated Helm chart documentation (2 occurrences)
   • Lines 52, 184: References to SNOWFLAKE_USER

5. docs/architecture/backend/snowflake-integration.md

   • Updated technical documentation (3 occurrences)
   • Lines 88, 504, 816: Updated all examples and references

Verification

✅ No remaining instances of SNOWFLAKE_USERNAME in codebase
✅ All files formatted with yarn format
✅ Build passed successfully
✅ Linting passed
✅ Type checking passed

Rationale

The SNOWFLAKE_USER naming convention is more consistent with Snowflake SDK standards and common practice in Snowflake integrations.

JIRA

LFXV2-692

Generated with Claude Code

[coderabbitai]

Walkthrough

The pull request renames the Snowflake service environment variable from SNOWFLAKE_USERNAME to SNOWFLAKE_USER across application configuration, service implementation, Helm chart values, and documentation files.

Changes

Cohort / File(s)	Summary
Environment and Configuration apps/lfx-one/.env.example, charts/lfx-v2-ui/values.yaml	Environment variable SNOWFLAKE_USERNAME renamed to SNOWFLAKE_USER in configuration files
Service Implementation apps/lfx-one/src/server/services/snowflake.service.ts	Updated Snowflake connection options to read from SNOWFLAKE_USER instead of SNOWFLAKE_USERNAME when creating the connection pool
Documentation charts/lfx-v2-ui/README.md, docs/architecture/backend/snowflake-integration.md	Updated references from SNOWFLAKE_USERNAME to SNOWFLAKE_USER in deployment examples and documentation

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

• Homogeneous change repeated across files (consistent find-and-replace pattern)
• No logic modifications or control flow changes
• No behavioral impact—only environment variable naming updated

Possibly related PRs

• feat(helm): add missing environment variables to chart #137 — Modifies the same Snowflake environment variable name in chart/docs configuration (potential conflict or complementary change depending on PR order)

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run @coderabbitai generate docstrings to improve docstring coverage.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Title Check	✅ Passed	The pull request title "refactor(config): rename snowflake_username to snowflake_user" clearly and concisely summarizes the main objective of the changeset. The title directly corresponds to the primary change—renaming the environment variable SNOWFLAKE_USERNAME to SNOWFLAKE_USER across configuration files, code, and documentation. It uses a conventional commit format (type: description) and provides sufficient clarity for a developer scanning the repository history to understand the purpose of the change at a glance.
Linked Issues Check	✅ Passed	The changeset fully satisfies the requirements outlined in linked issue LFXV2-692. All specified objectives have been met: the environment variable SNOWFLAKE_USERNAME has been renamed to SNOWFLAKE_USER across service code [snowflake.service.ts], configuration examples [.env.example], Helm chart values [values.yaml], and documentation [README.md, snowflake-integration.md]. The PR description confirms that no remaining instances of SNOWFLAKE_USERNAME exist in the codebase and verifies that formatting (yarn format), build, linting, and type checking all passed as required.
Out of Scope Changes Check	✅ Passed	All code changes in this pull request are directly in scope and aligned with the stated objective of renaming the SNOWFLAKE_USERNAME environment variable to SNOWFLAKE_USER. The modifications span service code, configuration examples, Helm chart definitions, and documentation—all of which are necessary to complete the rename consistently across the repository. No unrelated changes, refactorings, bug fixes, or feature additions have been introduced outside the scope of this variable naming update.
Description Check	✅ Passed	The pull request description is well-structured and directly related to the changeset. It includes a clear summary of the rename operation, lists all five modified files with specific line numbers and changes, explains the rationale for the change (consistency with Snowflake SDK conventions), and documents verification steps showing that formatting, build, linting, and type checking all passed. The description provides meaningful information about what was changed and why, meeting the requirements for a passing description check.

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch refactor/LFXV2-692

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[Copilot]

Pull Request Overview

This PR standardizes the Snowflake username environment variable name from SNOWFLAKE_USERNAME to SNOWFLAKE_USER across the codebase and removes sensitive credential values from documentation examples.

• Renamed environment variable from SNOWFLAKE_USERNAME to SNOWFLAKE_USER for consistency
• Updated all references in code, configuration files, and documentation
• Sanitized example values in documentation by removing actual account credentials

Reviewed Changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
apps/lfx-one/src/server/services/snowflake.service.ts	Updated environment variable reference in connection options
apps/lfx-one/.env.example	Updated environment variable name in example configuration
charts/lfx-v2-ui/values.yaml	Updated Helm chart environment variable configuration
charts/lfx-v2-ui/README.md	Updated documentation and parameter table with new variable name
docs/architecture/backend/snowflake-integration.md	Updated technical documentation with new variable name and removed sensitive example values

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

apps/lfx-one/src/server/services/snowflake.service.ts (1)

256-256: Code change is correct and aligns with SDK conventions.

The environment variable has been successfully updated from SNOWFLAKE_USERNAME to SNOWFLAKE_USER in the connection options. This aligns with Snowflake SDK naming conventions and is consistent with all configuration and documentation updates across the PR.

For a smoother migration path, consider adding temporary fallback logic to support both variable names during the transition period:

 const connectionOptions: ConnectionOptions = {
   account: process.env['SNOWFLAKE_ACCOUNT'] as string,
-  username: process.env['SNOWFLAKE_USER'] as string,
+  username: (process.env['SNOWFLAKE_USER'] || process.env['SNOWFLAKE_USERNAME']) as string,
   role: process.env['SNOWFLAKE_ROLE'] as string,

This would allow existing deployments to continue working while they update their configuration. The fallback can be removed in a future release after confirming all environments have migrated.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

• Jira integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between d5209ea and c023404.

📒 Files selected for processing (5)

• apps/lfx-one/.env.example (1 hunks)
• apps/lfx-one/src/server/services/snowflake.service.ts (1 hunks)
• charts/lfx-v2-ui/README.md (2 hunks)
• charts/lfx-v2-ui/values.yaml (1 hunks)
• docs/architecture/backend/snowflake-integration.md (3 hunks)

🧰 Additional context used

📓 Path-based instructions (3)

**/*.{ts,tsx}

📄 CodeRabbit inference engine (CLAUDE.md)

**/*.{ts,tsx}: Use TypeScript interfaces instead of union types for better maintainability
When defining PrimeNG-related types, reference the official PrimeNG component interfaces

Files:

• apps/lfx-one/src/server/services/snowflake.service.ts

**/*.{ts,tsx,js,jsx,mjs,cjs,html,css,scss}

📄 CodeRabbit inference engine (CLAUDE.md)

Include required license headers on all source files

Files:

• apps/lfx-one/src/server/services/snowflake.service.ts

**/*.{ts,tsx,js,jsx}

📄 CodeRabbit inference engine (CLAUDE.md)

Do not nest ternary expressions

Files:

• apps/lfx-one/src/server/services/snowflake.service.ts

🔇 Additional comments (4)

charts/lfx-v2-ui/values.yaml (1)

215-215: LGTM! Environment variable rename is consistent.

The rename from SNOWFLAKE_USERNAME to SNOWFLAKE_USER aligns with Snowflake SDK conventions. Note that this is a breaking change for existing Helm deployments—ensure all environment-specific values files and deployment configurations are updated accordingly.

Verify that deployment teams have been notified of this breaking change and that all environment-specific values files (dev, staging, production) have been updated to use SNOWFLAKE_USER.

charts/lfx-v2-ui/README.md (1)

52-52: Documentation updates look good.

Both occurrences of the environment variable have been correctly updated from SNOWFLAKE_USERNAME to SNOWFLAKE_USER in the deployment example and the analytics parameters table, maintaining consistency with the code changes.

Also applies to: 184-184

docs/architecture/backend/snowflake-integration.md (1)

88-88: Technical documentation updated consistently.

All references to the Snowflake username environment variable have been correctly updated to SNOWFLAKE_USER across code examples (line 88) and configuration sections (lines 504, 816), ensuring the documentation remains accurate and aligned with the implementation.

Also applies to: 504-504, 816-816

apps/lfx-one/.env.example (1)

39-39: Example environment file updated correctly.

The .env.example file now reflects the new SNOWFLAKE_USER environment variable, ensuring developers setting up local environments will use the correct variable name from the start.