Optimize API Usage Recording Performance

[Snider]

The AuthenticateApiKey middleware was calling recordUsage() synchronously on every request, adding a database write to the critical path. Additionally, TrackApiUsage middleware was performing multiple synchronous database writes for detailed analytics.

This PR optimizes API performance by:

1. Moving database updates to background jobs (UpdateApiKeyLastUsedJob and RecordApiUsageJob).
2. Implementing cache-based debouncing for the last_used_at timestamp, ensuring it's only updated at most once every 60 seconds per key.
3. Updating ApiUsageService to dispatch a job instead of performing synchronous writes and aggregations.
4. Correcting inconsistent namespaces in ApiUsageService and ApiKeyService to follow the project's PSR-4 mapping.
5. Adding a new test suite to verify the optimization and debouncing logic.

Fixes #10

---

PR created automatically by Jules for task 9719100301173661166 started by @Snider

[google-labs-jules]

👋 Jules, reporting for duty! I'm here to lend a hand with this pull request.

When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down.

I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job!

For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with @jules. You can find this option in the Pull Request section of your global Jules UI settings. You can always switch back!

New to Jules? Learn more at jules.google/docs.

---

For security, I will only act on instructions from the user who triggered this task.

[gemini-code-assist]

Summary of Changes

Hello @Snider, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly enhances API performance by refactoring synchronous database write operations related to API usage tracking and API key 'last_used_at' updates into asynchronous background jobs. By leveraging Laravel's queue system and introducing a cache-based debouncing strategy, the critical path of API requests is freed from database I/O, leading to improved responsiveness and scalability. The changes also include namespace corrections and comprehensive new tests to ensure the reliability of these optimizations.

Highlights

• API Key Last Used Update: The 'last_used_at' timestamp for API keys is now updated asynchronously via a 'UpdateApiKeyLastUsedJob' to prevent blocking the request critical path.
• Cache Debouncing for Last Used: A cache-based debouncing mechanism has been implemented for 'last_used_at' updates, ensuring the database is written to at most once every 60 seconds per API key.
• Detailed API Usage Recording: All detailed API usage analytics, including individual usage and daily aggregations, are now processed in the background by dispatching a 'RecordApiUsageJob'.
• Namespace Consistency: Inconsistent namespaces within 'ApiUsageService' and 'ApiKeyService' have been corrected to align with the project's PSR-4 mapping.
• New Test Coverage: A dedicated test suite ('ApiUsageOptimizationTest.php') has been added to verify the correct functioning of the new background job dispatching and cache debouncing logic.

Changelog

• src/Api/Jobs/RecordApiUsageJob.php
  • Added a new job responsible for recording individual API usage and updating daily aggregations in the background.
• src/Api/Jobs/UpdateApiKeyLastUsedJob.php
  • Added a new job to asynchronously update the 'last_used_at' timestamp for an API key.
• src/Api/Models/ApiKey.php
  • Modified the 'recordUsage' method to dispatch 'UpdateApiKeyLastUsedJob' instead of performing a direct database update.
  • Implemented cache-based debouncing to limit 'last_used_at' updates to once per minute per API key.
  • Added 'Cache' and 'UpdateApiKeyLastUsedJob' imports.
• src/Api/Services/ApiUsageService.php
  • Corrected the namespace from 'Mod\Api\Services' to 'Core\Api\Services'.
  • Updated 'use' statements to reflect the 'Core\Api\Models' namespace.
  • Modified the 'record' method to dispatch 'RecordApiUsageJob' with all usage data, removing synchronous database writes.
  • Changed the return type of 'record' from 'ApiUsage' to 'void'.
  • Corrected a namespace reference for 'ApiKey' in 'getKeyComparison'.
• src/Api/Tests/Feature/ApiUsageOptimizationTest.php
  • Added a new feature test file to validate the dispatching of 'UpdateApiKeyLastUsedJob' and 'RecordApiUsageJob'.
  • Includes tests specifically for the cache debouncing logic of 'UpdateApiKeyLastUsedJob'.

Activity

• No specific activity (comments, reviews, progress updates) has been recorded for this pull request yet.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[github-actions]

QA Pipeline Results

Check	Status	Details
Tests	✗	0 tests, 0 assertions
PHPStan	✗	0 errors
Psalm	✗	0 issues
Code Style	⚠	27 files need formatting
Security	✓	0 vulnerabilities

Artifacts

• test-results.xml - JUnit test results
• phpstan.json - PHPStan analysis
• psalm.json / psalm.sarif - Psalm analysis
• pint.json - Code style report
• audit.json - Security audit

---

Generated by core php qa pipeline

[gemini-code-assist]

Code Review

This pull request effectively optimizes API usage recording by offloading database writes to background jobs, which will significantly improve API response times. The implementation of cache-based debouncing for updating the last_used_at timestamp is a clever approach to further reduce database load. The code is well-structured, and the inclusion of a new test suite to verify the debouncing and job dispatching logic is excellent. I've found one minor issue regarding a duplicated data key when dispatching a job, which should be addressed.

[gemini-code-assist]

There's a duplicated key in the data array being dispatched to the job. The key responseTimeMs is passed along with response_time_ms. The job RecordApiUsageJob only uses response_time_ms. The redundant key should be removed to avoid confusion and sending unnecessary data. The inline comment on line 46 also indicates this confusion.

            'response_time_ms' => $responseTimeMs,

[coderabbitai]

Warning

Rate limit exceeded

@Snider has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 6 minutes and 30 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch fix-api-usage-performance-9719100301173661166

---

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