Wrap Nakama Leaderboard Functions for Personalization by andresfelipemendez · Pull Request #143 · heroiclabs/hiro

andresfelipemendez · 2026-01-19T13:59:57Z

No description provided.

Copilot

Pull request overview

This PR wraps Nakama's leaderboard functions to enable personalization hooks, adding new RPC endpoints for writing, deleting, and listing leaderboard records. These operations allow the system to intercept and customize leaderboard interactions before delegating to Nakama's native implementation.

Changes:

Extended the LeaderboardsSystem interface with six new methods for CRUD operations on leaderboards and records
Added four new RPC endpoints (IDs 126-129) for leaderboard record operations in the protobuf definitions
Updated the OpenAPI specification with corresponding REST endpoints and schema definitions

Reviewed changes

Copilot reviewed 3 out of 4 changed files in this pull request and generated 3 comments.

File	Description
leaderboards.go	Extended interface with Create, Delete, WriteRecord, DeleteRecord, ListRecords, and ListRecordsAroundOwner methods
hiro.proto	Added RPC IDs 126-129, Operator enum, and message types for leaderboard record operations
hiro-openapi.yml	Added REST endpoints for write, delete, and list operations with corresponding request/response schemas

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Calm0 · 2026-01-20T14:53:50Z

+	Delete(ctx context.Context, logger runtime.Logger, nk runtime.NakamaModule, userID, id string) error
+
+	// WriteScore writes a leaderboard score.
+	WriteScore(ctx context.Context, logger runtime.Logger, db *sql.DB, nk runtime.NakamaModule, userID, leaderboardID, ownerID, username string, score, subscore int64, metadata map[string]any, operator Operator, conditionalMetadataUpdate bool) (*Leaderboard, error)


Why do we need both ownerID and userID?

Calm0 · 2026-01-20T14:58:08Z

+	WriteScore(ctx context.Context, logger runtime.Logger, db *sql.DB, nk runtime.NakamaModule, userID, leaderboardID, ownerID, username string, score, subscore int64, metadata map[string]any, operator Operator, conditionalMetadataUpdate bool) (*Leaderboard, error)
+
+	// DeleteScore deletes a leaderboard score.
+	DeleteScore(ctx context.Context, logger runtime.Logger, db *sql.DB, nk runtime.NakamaModule, userID, leaderboardID, ownerID string) error


Same here, userID and ownerID?

Calm0 · 2026-01-20T15:01:42Z

 	Get(ctx context.Context, logger runtime.Logger, nk runtime.NakamaModule, userID string) (*LeaderboardConfigList, error)
+
+	// GetScores returns a specified leaderboard with scores.
+	GetScores(ctx context.Context, logger runtime.Logger, nk runtime.NakamaModule, userID, leaderboardID, ownerID string, limit int, cursor string) (*Leaderboard, error)


This should take ownerIDs []string instead of a singular?
And maybe include the expiry as well so it covers the base Nakama functionality?

Calm0 · 2026-01-20T15:18:13Z

+message Leaderboard {
+  // Leaderboard ID.
+  string id = 1;
+  // Score ordering. If true, lower scores are better.
+  bool ascending = 2;
+  // Score submission operator.
+  string operator = 3;
+  // The leaderboard reset schedule.
+  string reset_schedule = 4;
+  // Whether the leaderboard is authoritative or not.
+  bool authoritative = 5;
+  // Additional metadata properties.
+  map<string, string> additional_properties = 6;
+  // Participants and their scores.
+  repeated LeaderboardScore scores = 7;
+  // Owner scores.
+  repeated LeaderboardScore owner_scores = 8;
+  // Next page cursor.
+  string next_cursor = 9;
+  // Previous page cursor.
+  string prev_cursor = 10;
+  // Total rank count.
+  int64 rank_count = 11;
+  // The UNIX timestamp for the current server time.
+  int64 current_time_sec = 12;
+}


Shouldn't this include a region as well? or do we wanna only rely on the leaderboard id?

Copilot

Pull request overview

Copilot reviewed 4 out of 5 changed files in this pull request and generated 4 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

# Conflicts: # hiro.pb.go

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

…to sort_order

also added "Ascending" config entry to be more inline with the event leaderboards

andresfelipemendez requested review from Copilot, novabyte and zyro January 19, 2026 13:59

Copilot AI reviewed Jan 19, 2026

View reviewed changes

Comment thread hiro-openapi.yml Outdated

Comment thread hiro-openapi.yml Outdated

Comment thread hiro-openapi.yml

Calm0 reviewed Jan 20, 2026

View reviewed changes

andresfelipemendez force-pushed the leaderboard-management-ops branch 4 times, most recently from 5b7eeef to bb41755 Compare January 22, 2026 18:12

VBorisof reviewed Jan 28, 2026

View reviewed changes

Comment thread leaderboards.go Outdated

Calm0 force-pushed the leaderboard-management-ops branch from bcc896b to e904b2d Compare February 25, 2026 11:45

Calm0 marked this pull request as draft February 25, 2026 11:45

andresfelipemendez requested a review from a team February 25, 2026 12:29

Calm0 marked this pull request as ready for review March 3, 2026 16:53

Calm0 requested a review from Copilot March 3, 2026 16:53

Copilot started reviewing on behalf of Calm0 March 3, 2026 16:54 View session

Copilot AI reviewed Mar 3, 2026

View reviewed changes

Comment thread hiro-openapi.yml

Comment thread hiro-openapi.yml

Comment thread hiro-openapi.yml Outdated

Comment thread leaderboards.go

Calm0 force-pushed the leaderboard-management-ops branch from a205512 to 14e3aec Compare March 18, 2026 13:57

andresfelipemendez and others added 12 commits April 2, 2026 17:14

add rpcs

b18c23a

# Conflicts: # hiro.pb.go

add list records

369df95

re order

86415ec

Update hiro-openapi.yml

486fb07

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update hiro-openapi.yml

ef3ac5a

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update hiro-openapi.yml

2bb1863

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

refactor rename closer to eventleaderboards

edfb3a6

update interface naming

b2a77cb

revert limit to int32, delegating errcheck to nakama

4343cd7

rename to follow event leaderboard convention

4ed966d

renaming refactor

f3330b8

remove delete score since event leaderboard doesn't have it

a5a3557

andresfelipemendez and others added 11 commits April 2, 2026 17:14

add custom error, roderder parameters, update openapi from ascending …

e58fd74

…to sort_order

update

fae52f7

Enrich hiro leaderboard type and RPCs

af9cd58

Remove score delete hook

4d4eead

Update score write function params

b8a6620

Allow caller to pass overrideOperator on update

3dfdde2

update leaderboard schema

273b864

also added "Ascending" config entry to be more inline with the event leaderboards

Add new error (update outside duration)

74121d4

Pass the leaderboard region separately when listing scores

3c727d2

regnerate buf

438f0b2

remove unnecessary ConditionalMetadataUpdate param

0bee033

Calm0 force-pushed the leaderboard-management-ops branch from 846a2b3 to 0bee033 Compare April 2, 2026 15:17

Calm0 added 2 commits April 2, 2026 17:17

regen buf

4f35a23

re order proto message for cpp clients

04ad1fe

Calm0 approved these changes Apr 2, 2026

View reviewed changes

Calm0 merged commit 77d4366 into main Apr 2, 2026
2 checks passed

Calm0 deleted the leaderboard-management-ops branch April 2, 2026 16:45

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Wrap Nakama Leaderboard Functions for Personalization#143

Wrap Nakama Leaderboard Functions for Personalization#143
Calm0 merged 25 commits into
mainfrom
leaderboard-management-ops

andresfelipemendez commented Jan 19, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Calm0 Jan 20, 2026 •

edited

Loading

Uh oh!

Calm0 Jan 20, 2026

Uh oh!

Calm0 Jan 20, 2026

Uh oh!

Calm0 Jan 20, 2026 •

edited

Loading

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

andresfelipemendez commented Jan 19, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Calm0 Jan 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Calm0 Jan 20, 2026

Choose a reason for hiding this comment

Uh oh!

Calm0 Jan 20, 2026

Choose a reason for hiding this comment

Uh oh!

Calm0 Jan 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Calm0 Jan 20, 2026 •

edited

Loading

Calm0 Jan 20, 2026 •

edited

Loading