Merge pull request #9526 from hicommonwealth/rotorsoft/9507-get-user-…

…feed Refactor user activity queries
hicommonwealth · Oct 15, 2024 · 8aef5b5 · 8aef5b5
2 parents c0fe2c8 + 5e9eb3a
commit 8aef5b5
Show file tree

Hide file tree

Showing 1,927 changed files with 6,110 additions and 3,365 deletions.
diff --git a/common_knowledge/Caching.md b/common_knowledge/Caching.md
@@ -40,8 +40,8 @@ _"There are only two hard things in Computer Science: cache invalidation and nam
 - Choosing a right TTL could be very important, as app data is highly transactional
 
 - **Caching Namespace:**
-  - Global - eg. /api/viewGlobalActivity
-  - User Specific - eg. /api/viewUserActivity or /api/status
+  - Global - eg. /api/internal/trpc/feed.GetGlobalActivity
+  - User Specific - eg. /api/internal/trpc/feed.GetUserActivity or /api/status
 
 - **Hybrid Request Handler** -> Fetch followed by tracking of user activity
   eg. get chain data & record current chain selected by user  - these kind of request handler can only utilize sequelize result caching

diff --git a/common_knowledge/Performance-Benchmarks.md b/common_knowledge/Performance-Benchmarks.md
@@ -39,7 +39,7 @@ _See also full [Datadog](./Datadog.md) entry._
 
 We've implemented two new performance dashboards to monitor and track improvements in latency and call volume over time.
 
-These dashboards serve a key role in prioritizing improvements by highlighting high call volume and slow endpoints. They are instrumental in monitoring the effect of improvements over time, as shown by specific examples corresponding to PRs like `getAddressProfile` larger batches and performance enhancements in backend API calls such as `/viewUserActivity` and `/status`. Additionally, they can effectively detect abnormal spikes in latency and call volume through real-time metrics reported to Datadog.
+These dashboards serve a key role in prioritizing improvements by highlighting high call volume and slow endpoints. They are instrumental in monitoring the effect of improvements over time, as shown by specific examples corresponding to PRs like `getAddressProfile` larger batches and performance enhancements in backend API calls such as `/feed.GetUserActivity` and `/status`. Additionally, they can effectively detect abnormal spikes in latency and call volume through real-time metrics reported to Datadog.
 
 ## Change Log
 

diff --git a/libs/api-client/README.md b/libs/api-client/README.md
@@ -1,3 +1,23 @@
 # Common API
 
-## TODO: write readme file
+## Documentation
+
+[Fern API Reference](https://common.docs.buildwithfern.com)
+
+## CI/CD Instructions (Developers)
+
+- TODO
+
+## Manual Setup (Developers)
+
+### Generate a new API client
+
+- Start app with `pnpm start` so fern can refresh the lastest `openapi.spec` from `http://localhost:8080/api/v1/openapi.json`
+- Run `pnpm generate-client` to generate:
+  - A new `fern/openapi/openapi.yml` file
+  - A client API in `/src`, formatted with our root `.prettierrc.json` config
+
+### Deploy a new API client
+
+- Update the version in `package.json`
+- Run `pnpm publish` to publish the client
diff --git a/libs/api-client/fern/docs.yml b/libs/api-client/fern/docs.yml
@@ -1,5 +1,5 @@
 instances:
-  - url: https://Common.docs.buildwithfern.com
+  - url: https://common.docs.buildwithfern.com
 title: Common | Documentation
 navigation:
   - api: API Reference

diff --git a/libs/api-client/fern/fern.config.json b/libs/api-client/fern/fern.config.json
@@ -1,4 +1,4 @@
 {
   "organization": "Common",
-  "version": "0.43.5"
+  "version": "0.44.11"
 }