feature/of-504-user-metrics-in-subgraph #78
Conversation
george-openformat
force-pushed
the
feature/of-504-user-metrics-in-subgraph
branch
from
3a05333 to
74737b0
Compare
There was a problem hiding this comment.
Apologies for not looking at this for a while, wanted to make sure give it some good use before reviewing.
Proposed a couple of small changes to the shema. But I think this is basically ready to go.
The main blocker looks like the test suite not supporting aggregations. @nup9151f are there any ways around this so we can still test the rest of the subgraph?
schema.graphql
Outdated
| tokenAmount: BigInt! | ||
|
|
||
| badgeId: String | ||
| badgeCount: Int! |
There was a problem hiding this comment.
badgeCount should be badgeTokenCount
Reason being in the schema badge refers to NFT contract and badgeToken refers to the individual NFT
schema.graphql
Outdated
| transactionHash: String! | ||
|
|
||
| badgeId: String | ||
| badgeCount: Int! |
There was a problem hiding this comment.
Same here badgeCount should be badgeTokenCount
schema.graphql
Outdated
| type RewardAppTokenTypeStat @aggregation(intervals: ["hour", "day"], source: "RewardTokenData") { | ||
| id: Int8! | ||
| timestamp: Timestamp! | ||
| appId: String! | ||
| count: Int8! @aggregate(fn: "count") | ||
| totalCount: Int8! @aggregate(fn: "count", cumulative: true) | ||
| } | ||
|
|
||
| type RewardAppTokenTypeUserStat @aggregation(intervals: ["hour", "day"], source: "RewardTokenData") { | ||
| id: Int8! | ||
| timestamp: Timestamp! | ||
| appId: String! | ||
| userId: String! | ||
| count: Int8! @aggregate(fn: "count") | ||
| totalCount: Int8! @aggregate(fn: "count", cumulative: true) | ||
| } |
There was a problem hiding this comment.
After coming back to this I think we should remove stat types that contain TokenType as I am not totally convinced it's all that useful to an end user. So remove RewardAppTokenTypeStat and RewardAppTokenTypeUserStat
It shows us the amount of rewards issued that contained a token for a given app. This can be constructed from querying all the tokens used by that app, with the RewardAppTokenStat.
I would rather keep it out for now and add in later if highly requested, but more than happy to be convinced otherwise.
schema.graphql
Outdated
| type RewardAppBadgeTypeStat @aggregation(intervals: ["hour", "day"], source: "RewardBadgeData") { | ||
| id: Int8! | ||
| timestamp: Timestamp! | ||
| appId: String! | ||
| count: Int8! @aggregate(fn: "count") | ||
| totalCount: Int8! @aggregate(fn: "count", cumulative: true) | ||
| badgeAmount: BigInt! @aggregate(fn: "sum", arg: "badgeCount") | ||
| totalBadgeAmount: BigInt! @aggregate(fn: "sum", arg: "badgeCount", cumulative: true) | ||
| } | ||
|
|
||
| type RewardAppBadgeTypeUserStat @aggregation(intervals: ["hour", "day"], source: "RewardBadgeData") { | ||
| id: Int8! | ||
| timestamp: Timestamp! | ||
| appId: String! | ||
| userId: String! | ||
| count: Int8! @aggregate(fn: "count") | ||
| totalCount: Int8! @aggregate(fn: "count", cumulative: true) | ||
| badgeAmount: BigInt! @aggregate(fn: "sum", arg: "badgeCount") | ||
| totalBadgeAmount: BigInt! @aggregate(fn: "sum", arg: "badgeCount", cumulative: true) | ||
| } |
There was a problem hiding this comment.
Same here as TokenType I think we should remove RewardAppBadgeTypeStat and RewardAppBadgeTypeUserStat.
We can get this results by summing the results of RewardAppBadgeStat or RewardAppBadgeUserStat
schema.graphql
Outdated
| badgeAmount: BigInt! @aggregate(fn: "sum", arg: "badgeCount") | ||
| totalBadgeAmount: BigInt! @aggregate(fn: "sum", arg: "badgeCount", cumulative: true) |
There was a problem hiding this comment.
badgeAmount should be badgeTokenAmount
totalBadgeAmount should be totalBadgeTokenAmount
schema.graphql
Outdated
| badgeAmount: BigInt! @aggregate(fn: "sum", arg: "badgeCount") | ||
| totalBadgeAmount: BigInt! @aggregate(fn: "sum", arg: "badgeCount", cumulative: true) |
There was a problem hiding this comment.
badgeAmount should be badgeTokenAmount
totalBadgeAmount should be totalBadgeTokenAmount
Hey @george-openformat: |
|
Gotcha, thanks for explaining that. |
…f-504-user-metrics-in-subgraph-2
…n-subgraph-2 Feature/of 504 user metrics in subgraph 2
|
Hey @george-openformat: |
george-openformat
changed the title
|
Awesome |
Description
This PR adds aggregation stats to be able to create these graphs:
Changes
Entities:
UserReward- Created to solve the Unique users rewarded problem. The idea of this entity is to keep track of what users have received a reward on which app. Because we can only query an entity id from the db in our handlers, thisUserRewardsaves the relationship${user_id}-${app_id}in its ID the first time (and only the first time) a user receives a reward in the app.AppRewardId- Created to saveRewardIdfor each app. EntityRewardand timeseriesRewardDataalready have this data, we need this new entity because we can not create a Graphql resolver to add adistinctorgroup byto the queries.Timeseries:
UserRewardData- Created to count the amount of new unique users per app. When we save aUserRewardwe also save a newUserRewardData, the result is we only create a new stat when a new user is rewarded in an app.RewardData- To create aggregations over all Rewards regardless of type (token, badge).RewardTokenData- To create aggregation over only Token rewards.RewardBadgeData- To create aggregation over only Badges rewards.Note: In all timeseries entities, the relations in the form
app: Appwhere changed toappId: String. The previous form was throwing occasional errors:ERROR: functions in index expression must be marked IMMUTABLECurrent stats:
UserRewardAppStat, source:UserRewardData- New users by app.RewardAppStat- Count and total rewards per app.RewardAppRewardIdStatRewardAppRewardTypeStatRewardAppRewardIdRewardTypeStatRewardAppUserStatRewardAppUserRewardTypeStatRewardAppUserRewardIdStatRewardAppUserRewardIdRewardTypeStatRewardAppTokenTypeStat, source:RewardTokenData- Stats for all tokens (and only tokens) on each app.RewardAppTokenTypeUserStat, source:RewardTokenData- Stats for all tokens (and only tokens) on each app and user.RewardAppTokenStat, source:RewardTokenData- Stats for specific tokens and appsRewardAppTokenUserStat, source:RewardTokenDataRewardAppBadgeTypeStat, source:RewardBadgeData- Stats for all badges (and only badges) on each app.RewardAppBadgeTypeUserStat, source:RewardBadgeDataRewardAppBadgeStat, source:RewardBadgeData- Stats for specific badges and appsRewardAppBadgeUserStat, source:RewardBadgeDataTests
Tests are failing because
matchsticklibrary does not have support yet for Aggregations.