fix: apikey lock issue and add option to disable tracking

[italojohnny]

Fixes a database lock issue by removing the use of asyncio.create_task when updating API key usage.
Adds the LANGFLOW_DISABLE_TRACK_APIKEY_USAGE environment variable to optionally disable usage tracking.

Default behavior is unchanged.

Summary by CodeRabbit

• New Features

  • Added support for a new environment variable to optionally disable API key usage tracking, helping reduce database contention in high-concurrency scenarios.

• Documentation

  • Updated environment variables documentation to include details about the new option for disabling API key usage tracking.

[Copilot]

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

[coderabbitai]

## Walkthrough

A new environment variable, `LANGFLOW_DISABLE_TRACK_APIKEY_USAGE`, has been introduced and documented. In the API key checking logic, the update of API key usage metrics is now gated by this variable and is performed synchronously rather than as a background task. No public APIs or signatures were changed.

## Changes

| File(s)                                                      | Change Summary                                                                                      |
|--------------------------------------------------------------|---------------------------------------------------------------------------------------------------|
| docs/docs/Configuration/environment-variables.md             | Documented the new `LANGFLOW_DISABLE_TRACK_APIKEY_USAGE` environment variable and its behavior.    |
| src/backend/base/langflow/services/settings/base.py          | Added `disable_track_apikey_usage` boolean field to `Settings` class with default `False`.         |
| src/backend/base/langflow/services/database/models/api_key/crud.py | Removed async task usage; added conditional synchronous awaited update of API key usage metrics based on setting. |

## Sequence Diagram(s)

```mermaid
sequenceDiagram
    participant Client
    participant API
    participant Database

    Client->>API: Send request with API key
    API->>API: Check LANGFLOW_DISABLE_TRACK_APIKEY_USAGE
    alt Tracking enabled
        API->>Database: Update API key usage metrics (awaited)
    else Tracking disabled
        API-->>Database: Skip usage metrics update
    end
    API-->>Client: Respond to request

<!-- walkthrough_end -->


---

<details>
<summary>📜 Recent review details</summary>

**Configuration used: CodeRabbit UI**
**Review profile: CHILL**
**Plan: Pro**


<details>
<summary>📥 Commits</summary>

Reviewing files that changed from the base of the PR and between f7cb0018bf07cf694ff4d75f9d5aebb65d82b4d9 and 58cb1b28ca1b1e16a5cd9c2e813cb60d56759b3f.

</details>

<details>
<summary>📒 Files selected for processing (2)</summary>

* `src/backend/base/langflow/services/database/models/api_key/crud.py` (2 hunks)
* `src/backend/base/langflow/services/settings/base.py` (1 hunks)

</details>

<details>
<summary>🚧 Files skipped from review as they are similar to previous changes (2)</summary>

* src/backend/base/langflow/services/settings/base.py
* src/backend/base/langflow/services/database/models/api_key/crud.py

</details>

<details>
<summary>⏰ Context from checks skipped due to timeout of 90000ms (1)</summary>

* GitHub Check: Optimize new Python code in this PR

</details>

</details>
<!-- internal state start -->


<!-- DwQgtGAEAqAWCWBnSTIEMB26CuAXA9mAOYCmGJATmriQCaQDG+Ats2bgFyQAOFk+AIwBWJBrngA3EsgEBPRvlqU0AgfFwA6NPEgQAfACgjoCEYDEZyAAUASpETZWaCrKNwSPbABsvkCiQBHbGlcSHFcLzpIACIAM3gADy40bngAaxJ5L3wGNJREBw9MejRaenxucXwsAkhaJBVIsKpc+AwiABpo+2wBZnUaejlIbERKFFw0bKF8WAwMeTRkW0gMRwFxgA4AZgA2AEYO9DL/AukwgHd8SGZtLAZYTFJEDUgAMXgKRFwj9Uh4hLnNB1agqJYebK5fKFSDDfzMfASNpEMKwDyjDz4WKQAAGS1kGAY8HwGgY/moJAA+pNEGkcZALmisNhuLRqMjIABBKwASUgGXkozQpFeAGVRNVaL9Qm1cBRFNgGEDViQLpAyEj5Rg2BhQhJnPBGiQjjiADKcgByAHE3qaAPIAdUpABEeaLOQAhU0AUUp0BsnIAwgBpSncnnB70ATUpAFV3VbvTijoz4A90D58BdkBivmFrhUqhgpl55PVEEaubz+ZkRhXSM00K12q93HUSLE0N5QhtHkj8HwsaiPIhZN8SMw/BO7jnCY92nRW2jrHYGJhYR5/EjVVFqJBYLhcNxEBwAPSnojqWC9UksU9eJ6xbIXMDae+P5+n7jeLynnYHDQjH0YxwCgMhymxLsCGIMhlEGBRWHYLheH4YRRHEKQZHkJglCoVR1C0HRgJMKA4FQVB1ygwhSHIKh4KYRDdS4Kg1QcJwXFhbDFGUfDNG0XQwEMEDTAMWgckQU8xIYCTA2qeIiGwOjiQwU8NU+aodVwMB9QoQ0BEiF5mFoDgDGiMyDAsLkeRg2iKXoNjbg4ocHieaQjE5FU1TUrVNMgHS9KaM1LRte0nVdd0vV9f0g1DcNIxjeNOUTelHhkEgyGOJR6FqXBlwcbhuAHeDvI09g/INI1kEmfSSFeHkZWQYEPXwfBInXfzKwuK90HbTtu3Krxgn4bEcU7LwxhxV4HSZewSFCWocTlYJkwmOoGhqqqWjSDkh3DGtBXrDw2DlNNkAACkW/BJi8SkMUQelilxB9vlusZaEpagcQASnzKdaEVDw2Wq8EFF1dhlJGDBcP3eAiFgUGGEU/xCVkJcKLKdQIfIjAxgoeCNlwC50pqZcSASJBxHaXFzWtW1HRdD1KUDO0LQtb1A2gHkWcpUVvWgTnrVFB6oep4K6adb0LU9H1KXtK1KRsPmbB5b0ADVOVNekOo2wCjAsyxOS8GglOqKrrlywHRAfE2ceG9UEkKvGogHTx9LTdVdUxtyDCgC1qlqmBlxchd+AwUtMuQKTHHYdlqn+F3gXILyME1UrdXK3SjQAblWa4cMxPhvzdhgqz5RBYeLXBFPOIn/BuRR4HiRdTPMn2RMQCgGFPAQmwyKHu/Bd92ifLNT1xpElQkoGwTGU8ESUcbTxSeBKQFU8yWwWgNG4WQTLM6J9asmy4KiBznHkZz52eNxl3gZhHdCIc8VHQliWF7LlyIbIe98MZQhxFkQMqQEGuq9aQ1IlhpHunWKIOUtroBfg8LU+BRhhEgcgWILtAHsipntAUdZhQeFrpuCciJFyQB5CTDwOIHiiDSKvTI9JYjYEJEWI4FseBbmJKglIvB8BNnhs5cklMUSUUQbAZBqD4j+FfFDMAmCKCkHmpA362CaDDnzNdGByAhwcLwbWC4SwpzcAfEqIYix7AEiQdUFBjVDHqCiGuHwv0AGsgpNSK6UwwH3TRnY7Q9ESz5FzmqJgUNMbVBLPIMmog8DOzDvIRuGicTliNNSLaH1UgCleoQ+kf8RH/HlJODheTkTIHHmmDwqAMBXVmvNa4OJoAUGWkuDwwcGzwjIY1cRkiqoqLJCQWOWBHq3GLKQTSRx/AmKbByP4XVco9XqP4MQ6B7EBOcUQOynEeqhPkopQZ/wHxEF1uYA2Rs4LKTNhopQDBraDJ0diMmD9naF16F4d24NxDe19nnK+5wcp5QrtQauOi+DXNuUWe59snnlBecXD24R4A10oEdUotUW4HzbmAIwHcu491yOBAes8HzD0/OUyeY85oiIkj3MY29d7osPpyayNET72UcI5C+2I2new8knWELU2r3DkrDPZRZ/iIq8PQZJ61IhpN7hk9ImRsmkHpHM+GwIlB9SNgNIaT83hTAmgyIxpQsq/Q4TicUh5Sn0huUsF4gd0b1DFagKZZj0AIipldNEfB9GLBFjQSIx0OL+AfPBEp7QZB4DqPgc41TQjz0bn6qJ5NvgcmyJeBgRx9RvKBspI4LtQlylagcrMxzGVnJtpcjhYLnB3Lto8oqzzXZvJLh8xFiAgLvAlSUModAuDSorDVOVuQFVZKFKQLgAgBWQAALzvANSQekbRGDPWQBayl1qUBYBxDige+L+40pIEPIgI8LgUooBPaQFKrURsJbVHeOIGVtyEiRD2EEcDQRZXRRxLBNLMTQKxdl58tn5zwmoPiRFBIGFfQxfouBKTwFoIgSkXCdzvW+M4UIwFoOgTqAAdjQHhgADAAFk2CoEgAhthoCI02AAnHhujsRth0bQAAVliGyWgTHNi7G2CRvYNHOMCUMK+vDmwSBEb2PsEjUmGCseYwAJhIGxzYimiMCDo3Rkj+xtibFiLsDT+xVOGdoLsYExFcOxDwwwAQRGiP7E2AIWIRGbMGe07EWIJHaB4Y43R2gbG0CUYELsNjtA1MCG83RkTOGICQFU7Z/YAhFObDXEl/YJB9jmbYwwbjDBlObF07Z0zbHdi+bo1R7E2GYO/vUAhpDKGSDbiJu9cCImgA=== -->

<!-- internal state end -->
<!-- finishing_touch_checkbox_start -->

<details open="true">
<summary>✨ Finishing Touches</summary>

- [ ] <!-- {"checkboxId": "7962f53c-55bc-4827-bfbf-6a18da830691"} --> 📝 Generate Docstrings

</details>

<!-- finishing_touch_checkbox_end -->
<!-- tips_start -->

---



<details>
<summary>🪧 Tips</summary>

### Chat

There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai?utm_source=oss&utm_medium=github&utm_campaign=langflow-ai/langflow&utm_content=8361):

- Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  - `I pushed a fix in commit <commit_id>, please review it.`
  - `Explain this complex logic.`
  - `Open a follow-up GitHub issue for this discussion.`
- Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples:
  - `@coderabbitai explain this code block.`
  -	`@coderabbitai modularize this function.`
- PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.`
  - `@coderabbitai read src/utils.ts and explain its main purpose.`
  - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.`
  - `@coderabbitai help me debug CodeRabbit configuration file.`

### Support

Need help? Create a ticket on our [support page](https://www.coderabbit.ai/contact-us/support) for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

### CodeRabbit Commands (Invoked using PR comments)

- `@coderabbitai pause` to pause the reviews on a PR.
- `@coderabbitai resume` to resume the paused reviews.
- `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
- `@coderabbitai full review` to do a full review from scratch and review all the files again.
- `@coderabbitai summary` to regenerate the summary of the PR.
- `@coderabbitai generate docstrings` to [generate docstrings](https://docs.coderabbit.ai/finishing-touches/docstrings) for this PR.
- `@coderabbitai generate sequence diagram` to generate a sequence diagram of the changes in this PR.
- `@coderabbitai resolve` resolve all the CodeRabbit review comments.
- `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository.
- `@coderabbitai help` to get help.

### Other keywords and placeholders

- Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed.
- Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description.
- Add `@coderabbitai` anywhere in the PR title to generate the title automatically.

### CodeRabbit Configuration File (`.coderabbit.yaml`)

- You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository.
- Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information.
- If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json`

### Documentation and Community

- Visit our [Documentation](https://docs.coderabbit.ai) for detailed information on how to use CodeRabbit.
- Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback.
- Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

</details>

<!-- tips_end -->

[github-actions]

Build successful! ✅
Deploying docs draft.
Deploy successful! View draft

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9aaca68 and d7a7048.

📒 Files selected for processing (2)

• docs/docs/Configuration/environment-variables.md (1 hunks)
• src/backend/base/langflow/services/database/models/api_key/crud.py (2 hunks)

🧰 Additional context used

🪛 Pylint (3.3.7)

src/backend/base/langflow/services/database/models/api_key/crud.py

[convention] 1-1: Missing module docstring

(C0114)

🪛 GitHub Check: Ruff Style Check (3.13)

src/backend/base/langflow/services/database/models/api_key/crud.py

[failure] 1-14: Ruff (I001)
src/backend/base/langflow/services/database/models/api_key/crud.py:1:1: I001 Import block is un-sorted or un-formatted

🪛 GitHub Actions: Ruff Style Check

src/backend/base/langflow/services/database/models/api_key/crud.py

[error] 1-1: Ruff: Import block is un-sorted or un-formatted (I001)

⏰ Context from checks skipped due to timeout of 90000ms (2)

• GitHub Check: Optimize new Python code in this PR
• GitHub Check: Update Starter Projects

🔇 Additional comments (2)

src/backend/base/langflow/services/database/models/api_key/crud.py (1)

59-60: LGTM! Environment variable logic and synchronous fix are correct.

The implementation correctly:

• Checks the environment variable with proper default and case-insensitive comparison
• Fixes the database lock issue by using synchronous await instead of asyncio.create_task
• Preserves backward compatibility with tracking enabled by default

Note that this change may slightly increase API response times since validation now waits for the database update to complete, but this trade-off resolves the database contention issue under high concurrency.

docs/docs/Configuration/environment-variables.md (1)

194-194: Excellent documentation for the new environment variable.

The documentation is clear, accurate, and properly formatted. It correctly describes:

• The variable type and default value
• The specific functionality it controls (total_uses and last_used_at tracking)
• The use case (avoiding database contention under high concurrency)

This aligns perfectly with the code implementation in the crud.py file.

[github-actions]

Build successful! ✅
Deploying docs draft.
Deploy successful! View draft

[mendonk]

Approving for docs, thank you @italojohnny

[github-actions]

Build successful! ✅
Deploying docs draft.
Deploy successful! View draft

[github-actions]

Build successful! ✅
Deploying docs draft.
Deploy successful! View draft

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 78e0361 and f7cb001.

📒 Files selected for processing (2)

• src/backend/base/langflow/services/database/models/api_key/crud.py (2 hunks)
• src/backend/base/langflow/services/settings/base.py (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• src/backend/base/langflow/services/settings/base.py

🧰 Additional context used

🪛 Ruff (0.11.9)

src/backend/base/langflow/services/database/models/api_key/crud.py

58-58: Avoid inequality comparisons to True; use if not ...: for false checks

Replace comparison

(E712)

🪛 Pylint (3.3.7)

src/backend/base/langflow/services/database/models/api_key/crud.py

[convention] 58-58: Comparison 'settings_service.settings.disable_track_apikey_usage != True' should be 'settings_service.settings.disable_track_apikey_usage is not True' if checking for the singleton value True, or 'not settings_service.settings.disable_track_apikey_usage' if testing for falsiness

(C0121)

🪛 GitHub Check: Ruff Style Check (3.13)

src/backend/base/langflow/services/database/models/api_key/crud.py

[failure] 58-58: Ruff (E712)
src/backend/base/langflow/services/database/models/api_key/crud.py:58:12: E712 Avoid inequality comparisons to True; use if not ...: for false checks

🪛 GitHub Actions: Ruff Style Check

src/backend/base/langflow/services/database/models/api_key/crud.py

[error] 58-58: Ruff E712: Avoid inequality comparisons to True; use if not ...: for false checks.

🔇 Additional comments (1)

src/backend/base/langflow/services/database/models/api_key/crud.py (1)

12-12: LGTM!

The import of get_settings_service is correctly added to support the new conditional tracking functionality.

[coderabbitai]

⚠️ Potential issue

Fix the boolean comparison style to resolve pipeline failure.

The logic correctly implements conditional API key usage tracking, but the boolean comparison violates Python style conventions and is causing pipeline failures.

Apply this diff to fix the style issue:

-        if settings_service.settings.disable_track_apikey_usage != True:
+        if not settings_service.settings.disable_track_apikey_usage:

Note on performance: The change from async fire-and-forget tasks to synchronous awaited calls addresses the database lock issue but may impact response times since API key validation now waits for usage tracking to complete.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

	settings_service = get_settings_service()
	if settings_service.settings.disable_track_apikey_usage != True:
	await update_total_uses(api_key_object.id)
	settings_service = get_settings_service()
	if not settings_service.settings.disable_track_apikey_usage:
	await update_total_uses(api_key_object.id)

🧰 Tools

🪛 Ruff (0.11.9)

58-58: Avoid inequality comparisons to True; use if not ...: for false checks

Replace comparison

(E712)

🪛 Pylint (3.3.7)

[convention] 58-58: Comparison 'settings_service.settings.disable_track_apikey_usage != True' should be 'settings_service.settings.disable_track_apikey_usage is not True' if checking for the singleton value True, or 'not settings_service.settings.disable_track_apikey_usage' if testing for falsiness

(C0121)

🪛 GitHub Check: Ruff Style Check (3.13)

[failure] 58-58: Ruff (E712)
src/backend/base/langflow/services/database/models/api_key/crud.py:58:12: E712 Avoid inequality comparisons to True; use if not ...: for false checks

🪛 GitHub Actions: Ruff Style Check

[error] 58-58: Ruff E712: Avoid inequality comparisons to True; use if not ...: for false checks.

🤖 Prompt for AI Agents

In src/backend/base/langflow/services/database/models/api_key/crud.py around
lines 57 to 59, the boolean comparison uses '!= True', which violates Python
style conventions and causes pipeline failures. Replace the condition
'settings_service.settings.disable_track_apikey_usage != True' with 'not
settings_service.settings.disable_track_apikey_usage' to fix the style issue.
Also, ensure that the call to update_total_uses is properly awaited to handle
the database lock issue, accepting the potential impact on response times.

[github-actions]

Build successful! ✅
Deploying docs draft.
Deploy successful! View draft