feat(pg-usage-data): Add cache to batch tracking data #4308

gagantrivedi · 2024-07-09T03:11:36Z

Thanks for submitting a PR! Please check the boxes below:

I have run pre-commit to check linting
I have added information to docs/ if required so people know about the feature!
I have filled in the "Changes" section below?
I have filled in the "How did you test this code" section below?
I have used a Conventional Commit title for this Pull Request

Changes

Add cache to batch usage tracking
fixes: #4241

How did you test this code?

Adds unit tests

vercel · 2024-07-09T03:11:40Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

3 Skipped Deployments

Name	Status	Preview	Updated (UTC)
docs	⬜️ Ignored (Inspect)	Visit Preview	Jul 16, 2024 1:50pm
flagsmith-frontend-preview	⬜️ Ignored (Inspect)	Visit Preview	Jul 16, 2024 1:50pm
flagsmith-frontend-staging	⬜️ Ignored (Inspect)	Visit Preview	Jul 16, 2024 1:50pm

github-actions · 2024-07-09T03:12:13Z

flagsmith-private-cloud image build and security scan finished ✨

Image	Build Status	Security report
`ghcr.io/flagsmith/flagsmith-private-cloud:pr-4308`	Finished ✅	Results ✅

github-actions · 2024-07-09T03:12:13Z

flagsmith-frontend image build and security scan finished ✨

Image	Build Status	Security report
`ghcr.io/flagsmith/flagsmith-frontend:pr-4308`	Finished ✅	Results ✅

github-actions · 2024-07-09T03:12:18Z

flagsmith image build and security scan finished ✨

Image	Build Status	Security report
`ghcr.io/flagsmith/flagsmith:pr-4308`	Finished ✅	Results ✅

github-actions · 2024-07-09T03:12:18Z

flagsmith-e2e image build finished ✨

Image	Build Status	Security report
`ghcr.io/flagsmith/flagsmith-e2e:pr-4308`	Finished ✅	Skipped

github-actions · 2024-07-09T03:12:31Z

flagsmith-api image build and security scan finished ✨

Image	Build Status	Security report
`ghcr.io/flagsmith/flagsmith-api:pr-4308`	Finished ✅	Results ✅

github-actions · 2024-07-09T03:19:46Z

Uffizzi Ephemeral Environment Deploying

☁️ https://app.uffizzi.com/github.com/Flagsmith/flagsmith/pull/4308

⚙️ Updating now by workflow run 9958175504.

What is Uffizzi? Learn more!

codecov · 2024-07-09T03:20:22Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.78%. Comparing base (627370f) to head (bdb2321).
Report is 34 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #4308      +/-   ##
==========================================
+ Coverage   96.60%   96.78%   +0.17%     
==========================================
  Files        1195     1162      -33     
  Lines       39099    38154     -945     
==========================================
- Hits        37773    36927     -846     
+ Misses       1326     1227      -99

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

api/tests/unit/app_analytics/test_cache.py

github-actions · 2024-07-12T09:09:44Z

Docker builds report

Image	Build Status	Security report
`ghcr.io/flagsmith/flagsmith-e2e:pr-4308`	Finished ✅	Skipped
`ghcr.io/flagsmith/flagsmith-api-test:pr-4308`	Finished ✅	Skipped
`ghcr.io/flagsmith/flagsmith-api-test:pr-4308`	Finished ✅	Skipped
`ghcr.io/flagsmith/flagsmith-e2e:pr-4308`	Finished ✅	Skipped
`ghcr.io/flagsmith/flagsmith-frontend:pr-4308`	Finished ✅	Results ✅
`ghcr.io/flagsmith/flagsmith-frontend:pr-4308`	Finished ✅	Results ✅
`ghcr.io/flagsmith/flagsmith-api:pr-4308`	Finished ✅	Results ✅
`ghcr.io/flagsmith/flagsmith-api:pr-4308`	Finished ✅	Results ✅
`ghcr.io/flagsmith/flagsmith:pr-4308`	Finished ✅	Results ✅
`ghcr.io/flagsmith/flagsmith:pr-4308`	Finished ✅	Results ✅
`ghcr.io/flagsmith/flagsmith-private-cloud:pr-4308`	Finished ✅	Results ✅
`ghcr.io/flagsmith/flagsmith-private-cloud:pr-4308`	Finished ✅	Results ✅

matthewelwell · 2024-07-12T13:53:37Z

api/tests/unit/app_analytics/test_unit_app_analytics_cache.py

+        frozen_time.tick(CACHE_FLUSH_INTERVAL + 1)
+
+        # Next, let's call flush
+        cache.flush()


I think we have this pattern elsewhere so we're probably just following that, but it's odd to me that we're calling flush directly here since I don't think any external calls are made to it. I think we should probably mark the flush method as private, and this test should only use the track_request method.

Although It's not being used, but I feel it makes the interface a bit more clean? Does that make sense?

Hmm... maybe it does, yes, but the test feels a bit too 'internal' to me. It's not really testing the actual behaviour.

Yeah, that's a fair point! I have made it private

zachaysan

Overall looks good to me, just a bunch of typing suggestions.

zachaysan · 2024-07-15T14:53:12Z

api/tests/unit/app_analytics/test_middleware.py

+    path: str,
+    enum_resource_value: int,
+    settings: SettingsWrapper,
+):


nit: Missing typing for return value

api/tests/unit/app_analytics/test_middleware.py

zachaysan · 2024-07-15T14:53:54Z

api/tests/unit/app_analytics/test_middleware.py

+    rf: RequestFactory, mocker: MockerFixture, settings: SettingsWrapper
 ):


Nit: Missing typing for return value

zachaysan · 2024-07-15T14:54:17Z

api/tests/unit/app_analytics/test_unit_app_analytics_cache.py

+from pytest_mock import MockerFixture
+
+
+def test_api_usage_cache(mocker: MockerFixture):


Nit: Missing typing for return value

api/tests/unit/app_analytics/test_unit_app_analytics_cache.py

gagantrivedi added 2 commits July 9, 2024 08:32

feat(pg-usage-data): Add cache to batch tracking data

fb2a29b

Add typing

fe8231a

gagantrivedi requested a review from a team as a code owner July 9, 2024 03:11

gagantrivedi requested review from zachaysan and removed request for a team July 9, 2024 03:11

github-actions bot added feature New feature or request api Issue related to the REST API labels Jul 9, 2024

github-actions bot added feature New feature or request and removed feature New feature or request labels Jul 9, 2024

gagantrivedi force-pushed the fix/4241 branch from 896686c to fe8231a Compare July 9, 2024 07:37

github-actions bot added feature New feature or request and removed feature New feature or request labels Jul 9, 2024

matthewelwell reviewed Jul 12, 2024

View reviewed changes

api/tests/unit/app_analytics/test_cache.py Outdated Show resolved Hide resolved

api/tests/unit/app_analytics/test_cache.py Outdated Show resolved Hide resolved

github-actions bot added feature New feature or request and removed feature New feature or request labels Jul 12, 2024

gagantrivedi requested a review from matthewelwell July 12, 2024 09:10

gagantrivedi force-pushed the fix/4241 branch from ab49091 to e530211 Compare July 12, 2024 09:29

github-actions bot added feature New feature or request and removed feature New feature or request labels Jul 12, 2024

rename file, fix test

e530211

matthewelwell reviewed Jul 12, 2024

View reviewed changes

zachaysan approved these changes Jul 15, 2024

View reviewed changes

github-actions bot added feature New feature or request and removed feature New feature or request labels Jul 16, 2024

gagantrivedi force-pushed the fix/4241 branch from a4c52ac to bdb2321 Compare July 16, 2024 13:49

github-actions bot added feature New feature or request and removed feature New feature or request labels Jul 16, 2024

misc fixes

bdb2321

gagantrivedi requested a review from matthewelwell July 16, 2024 13:51

matthewelwell approved these changes Jul 18, 2024

View reviewed changes

gagantrivedi added this pull request to the merge queue Jul 18, 2024

Merged via the queue into main with commit 117f72a Jul 18, 2024
33 checks passed

gagantrivedi deleted the fix/4241 branch July 18, 2024 13:51

flagsmithdev mentioned this pull request Jul 18, 2024

chore(main): release 2.131.0 #4354

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(pg-usage-data): Add cache to batch tracking data #4308

feat(pg-usage-data): Add cache to batch tracking data #4308

gagantrivedi commented Jul 9, 2024 •

edited

Loading

vercel bot commented Jul 9, 2024 •

edited

Loading

github-actions bot commented Jul 9, 2024 •

edited

Loading

github-actions bot commented Jul 9, 2024 •

edited

Loading

github-actions bot commented Jul 9, 2024 •

edited

Loading

github-actions bot commented Jul 9, 2024 •

edited

Loading

github-actions bot commented Jul 9, 2024 •

edited

Loading

github-actions bot commented Jul 9, 2024 •

edited

Loading

codecov bot commented Jul 9, 2024 •

edited

Loading

github-actions bot commented Jul 12, 2024 •

edited

Loading

matthewelwell Jul 12, 2024

gagantrivedi Jul 16, 2024

matthewelwell Jul 16, 2024

gagantrivedi Jul 16, 2024

zachaysan left a comment

zachaysan Jul 15, 2024

gagantrivedi Jul 16, 2024

zachaysan Jul 15, 2024

zachaysan Jul 15, 2024

		rf: RequestFactory, mocker: MockerFixture, settings: SettingsWrapper
		):

		from pytest_mock import MockerFixture


		def test_api_usage_cache(mocker: MockerFixture):

feat(pg-usage-data): Add cache to batch tracking data #4308

feat(pg-usage-data): Add cache to batch tracking data #4308

Conversation

gagantrivedi commented Jul 9, 2024 • edited Loading

Changes

How did you test this code?

vercel bot commented Jul 9, 2024 • edited Loading

github-actions bot commented Jul 9, 2024 • edited Loading

github-actions bot commented Jul 9, 2024 • edited Loading

github-actions bot commented Jul 9, 2024 • edited Loading

github-actions bot commented Jul 9, 2024 • edited Loading

github-actions bot commented Jul 9, 2024 • edited Loading

github-actions bot commented Jul 9, 2024 • edited Loading

Uffizzi Ephemeral Environment Deploying

codecov bot commented Jul 9, 2024 • edited Loading

Codecov Report

github-actions bot commented Jul 12, 2024 • edited Loading

Docker builds report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zachaysan left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gagantrivedi commented Jul 9, 2024 •

edited

Loading

vercel bot commented Jul 9, 2024 •

edited

Loading

github-actions bot commented Jul 9, 2024 •

edited

Loading

github-actions bot commented Jul 9, 2024 •

edited

Loading

github-actions bot commented Jul 9, 2024 •

edited

Loading

github-actions bot commented Jul 9, 2024 •

edited

Loading

github-actions bot commented Jul 9, 2024 •

edited

Loading

github-actions bot commented Jul 9, 2024 •

edited

Loading

codecov bot commented Jul 9, 2024 •

edited

Loading

github-actions bot commented Jul 12, 2024 •

edited

Loading