Release Notes #
See the updates and improvements in the latest releases of Nakama and supported client libraries.
Nakama #
This section covers new releases and their features for the nakama and nakama-common packages jointly.
Compatibility matrix #
Developers using the Go Server Runtime must ensure the correct nakama-common version is used for their Nakama version. For those using Hiro, here you can see the required Nakama versions based on your version of Hiro:
| Nakama Version | Nakama Common Version |
|---|---|
| 3.25.0 | 1.35.0 |
| 3.24.2 | 1.34.0 |
| 3.24.1 | 1.34.0 |
| 3.24.0 | 1.34.0 |
| 3.23.0 | 1.33.0 |
| 3.22.0 | 1.32.0 |
| 3.21.1 | 1.31.0 |
| 3.21.0 | 1.31.0 |
| 3.20.1 | 1.30.1 |
| 3.20.0 | 1.30.1 |
| 3.19.0 | 1.30.0 |
| 3.18.0 | 1.29.0 |
| 3.17.1 | 1.28.1 |
| 3.17.0 | 1.28.0 |
| 3.16.0 | 1.27.0 |
| 3.15.0 | 1.26.0 |
| 3.14.0 | 1.25.0 |
| 3.13.1 | 1.24.0 |
| 3.12.0 | 1.23.0 |
| 3.11.0 | 1.22.0 |
| 3.10.0 | 1.21.0 |
| 3.9.0 | 1.20.0 |
| 3.8.0 | 1.19.0 |
| 3.7.0 | 1.18.0 |
| 3.6.0 | 1.17.0 |
| 3.5.0 | 1.16.0 |
| 3.4.0 | 1.15.0 |
| 3.3.0 | 1.14.0 |
| 3.2.1 | 1.13.1 |
| 3.2.0 | 1.13.0 |
| 3.1.2 | 1.12.1 |
| 3.1.1 | 1.12.1 |
| 3.1.0 | 1.12.0 |
| 3.0.0 | 1.11.0 |
Release Notes #
See the updates and improvements in the latest releases of Nakama.
v3.25.0 #
Released: November 25, 2024
Added #
- New devconsole UI for in-app notification listings, browsing, and deletion.
- Add Console API endpoints for in-app notifications listings.
- Add Console API endpoints for in-app notifications deletions.
- Add new runtime function to get a list of user’s friend status.
- Add new Follow/Unfollow runtime APIs.
- Add new NotificationsUpdate runtime API.
- Add new initializers function to get config values.
Changed #
- Increase limit of runtime friend listing operations to 1,000.
- Leaving a group is now treated as a deletion when done by the last member.
- Build with Go 1.23.3.
Fixed #
- Add missing JavaScript runtime SessionRefresh before/after hook functions.
- Correct text in tournament creation error messages.
- Improve copying of internal configuration before display to devconsole.
- Close group channel sooner when group is deleted.
NOTE: For developers who use the Go server runtime support. The nakama-common package at v1.35.0 must be used with this release.
| |
v3.24.2 #
Released: October 22, 2024
Fixed #
- Correctly display MFA-related configuration in devconsole UI.
- Correctly extract RPC function identifiers.
NOTE: For developers who use the Go server runtime support. The nakama-common package at v1.34.0 must be used with this release.
| |
v3.24.1 #
Released: October 21, 2024
Changed #
- Build with correct version of Protobuf dependency.
NOTE: For developers who use the Go server runtime support. The nakama-common package at v1.34.0 must be used with this release.
| |
v3.24.0 #
Released: October 21, 2024
Added #
- New runtime function to list user notifications.
- Support for runtime registration of custom HTTP handlers.
Changed #
- Increased limit on runtimes group users list functions.
- Added pagination support to storage index listing.
- Update runtime Satori client for latest API changes.
- Build with Go 1.23.2.
Fixed #
- Ensure matchmaker stats behave correctly if matchmaker becomes fully empty and idle.
- Correctly clear rank cache entries on account deletion.
- Only display owned purchases in the console account tab.
- Correctly infer X-Forwarded-For headers on Satori Authenticate calls in JS/Lua runtimes.
NOTE: For developers who use the Go server runtime support. The nakama-common package at v1.34.0 must be used with this release.
| |
v3.23.0 #
Released: July 27, 2024
Added #
- Add devconsole view to list and search purchases across users.
- Add devconsole view to list and search subscriptions across users.
- Add function to get notifications by identifier to Go runtime.
- Add function to get notifications by identifier to Lua runtime.
- Add function to get notifications by identifier to TypeScript/JavaScript runtime.
- Add function to delete notifications by identifier to Go runtime.
- Add function to delete notifications by identifier to Lua runtime.
- Add function to delete notifications by identifier to TypeScript/JavaScript runtime.
- Add runtime function to disable ranks for an active leaderboard.
- Add new matchmaker stats API.
- Add support for specifying session vars in devconsole API explorer calls.
Changed #
- Add leaderboard create function parameter to enable or disable ranks.
- Add tournament create function parameter to enable or disable ranks.
- Obfuscate further fields when viewing server configuration in the devconsole.
- Build with Go 1.22.5.
Fixed #
- Correctly wire Go runtime shutdown function context.
- Fix friends of friends API error when user has no friends.
- Fix group listing pagination if name filter is used.
- Correctly register friends of friends API before/after hooks.
NOTE: For developers who use the Go server runtime support. The nakama-common package at v1.33.0 must be used with this release.
| |
v3.22.0 #
Released: June 9, 2024
Added #
- Add runtime support for registering a shutdown hook function.
- Add support to custom sorting in storage index search.
- New config option to enforce a single party per user socket.
- New config option to enforce a single valid session token per user.
- New friends of friends listing API and runtime functions.
Changed #
- When a user is blocked, any DM streams between the blocker and blocked user are torn down.
- Add confirm dialog to devconsole delete operations.
- Reduce Console Storage View memory usage.
- Upgraded pgx to v5.
- Attempt to import Facebook friends on Limited Login authentication.
- Build with Go 1.22.4.
- Improve devconsole login page experience.
- Return Lua VM instance to the pool only after any error processing is complete.
- Better cancellation of long running queries in devconsole operations.
Fixed #
- Ensure Apple receipts with duplicate transaction identifiers are processed cleanly.
- Fix leaderboard rank cache initialization upon startup.
- Fix log message incorrectly referencing “userID” instead of “senderID”.
- Fix Lua runtime calls to string metatable functions.
- Correctly handle Steam API rejections on friend listing operations.
- Ensure Google auth token errors are handled gracefully.
NOTE: For developers who use the Go server runtime support. The nakama-common package at v1.32.0 must be used with this release.
| |
v3.21.1 #
Released: March 22, 2024
Added #
- Add ability to easily run unit and integration tests in an isolated docker-compose environment.
Changed #
- More efficient initial loading of storage index contents.
Fixed #
- Fix issue with Fleet Manager access causing an unexpected error.
NOTE: For developers who use the Go server runtime support. The nakama-common package at v1.31.0 must be used with this release.
| |
v3.21.0 #
Released: March 17, 2024
Added #
- Add Fleet Manager API to power session-based multiplayer adapters. See the documentation for more details.
- Add CRON next and previous functions to Go runtime.
- Add CRON previous function to Lua runtime.
- Add CRON previous function to TypeScript/JavaScript runtime.
- Add support for storage deletes in runtime multi-update functions.
Changed #
- Reduce number of memory allocations in leaderboard cache.
- Fix leaderboard rank cache inconsistencies/race that could arise under heavy load.
- List leaderboard records can now return up to 1,000 records per request.
- Simplify query planning for storage object read operations.
- Improve comparison operation for leaderboard rank cache ordering.
- Extend extraction of purchase data from Apple IAP receipts.
Fixed #
- Prevent players from requesting duplicate joins to the same party.
- Prevent players from requesting joins to parties they are already members of.
- Ensure runtime user deletion function rejects the system user.
NOTE: For developers who use the Go server runtime support. The nakama-common package at v1.31.0 must be used with this release.
| |
v3.20.1 #
Released: February 3, 2024
Changed #
- Improve handling of messages being sent while session is closing.
- Build with Go 1.21.6.
Fixed #
- Skip Google refund handling for deleted users.
- Fix storage engine version check regression.
- Fix JavaScript runtime tournament records list owner identifier parameter handling.
- Fix regression in tournament end active time calculation when it coincides with reset schedule.
- Better handling of concurrent wallet update operations for the same user.
NOTE: For developers who use the Go server runtime support. The nakama-common package at v1.30.1 must be used with this release.
| |
v3.20.0 #
Released: December 15, 2023
Changed #
- JavaScript runtime
localcachePutnow only accepts primitive types, other values will throw an error. - Storage search index list max limit increased from 100 to 10,000 results.
- Upgrade GRPC-Gateway, Tally, Zap, crypto, oauth2, GRPC, and related dependencies.
- Build with Go 1.21.5.
Fixed #
- Fix pointer slices assertions in JavaScript runtime Nakama module function arguments.
- Fix caller ID parameter index in Lua runtime
storage_listfunction. - Fix incorrect GOARCH flag in Dockerfiles for arm64.
NOTE: For developers who use the Go server runtime support. The nakama-common package at v1.30.1 must be used with this release.
| |
v3.19.0 #
Released: November 11, 2023
Added #
- Add IAP purchase validation support for Facebook Instant Games.
- Add Lua runtime function to clear all localcache data.
- Add JavaScript runtime function to clear all localcache data.
- Add support for per-key TTL in Lua runtime localcache.
- Add support for per-key TTL in JavaScript runtime localcache.
- Add support for optional client IP address passthrough to runtime Satori client.
Changed #
- Remove unused config ‘matchmaker.batch_pool_size’.
- RPC now allows omitting the
unwrapparameter for requests with empty payloads. - Upgrade GRPC dependency.
- Writing tournament scores now updates number of scores even if submitted score is not an improvement.
- Move internal queries with variable number of args to a fixed number of args syntax.
- Better handling of
num_scoreandmax_num_scorein tournament score updates. - Remove unnecessary
curl,git,unzip,rsync, andschroottools from Docker images. - Build with Go 1.21.4 and use Debian bookworm-slim for base docker images.
Fixed #
- Correctly handle empty email field when authenticating via Apple Sign In.
- Fix issue where rank cache may store duplicate ranks for some score inputs.
- Fix issue related to accepting party members.
- Fix HTTP request timeout usage in JavaScript runtime.
NOTE: For developers who use the Go server runtime support. The nakama-common package at v1.30.0 must be used with this release.
| |
v3.18.0 #
Released: October 24, 2023
Added #
- Allow HTTP key to be read from an HTTP request’s Basic auth header if present.
- Add prefix search for storage keys in console (
key%). - Runtime functions to build a leaderboardList cursor to start listing from a given rank.
- Improved support for TypeScript/JavaScript runtime profiling.
Changed #
- Session cache model switched from whitelist to blacklist for improved usability.
- Use Steam partner API instead of public API for Steam profiles and friends requests.
- Add create_time and update_time to returned storage engine writes acks.
- Add storage index create flag to read only from the index.
- Add caller ID param to storage listing and storage index listing runtime APIs.
- Update Facebook Graph API usage from v11 to v18.
- Add support for refresh token rotation.
- Allow JS runtime storage write operation version inputs to be undefined.
- Build with Go 1.21.3.
Fixed #
- Fixed multiple issues found by linter.
- Fix storage index listing results sometimes being returned with incorrect order.
- Fixes calculation of leaderboard and tournament times for rare types of CRON expressions that don’t execute at a fixed interval.
- Improved how start and end times are calculated for tournaments occurring in the future.
- Fix users receiving friend request notifications when added by users who have blocked them.
- Fix Go runtime registration of matchmaker custom override hook function.
- Fully remove corresponding matchmaker tickets after custom matchmaker process completes.
- Fix incorrectly documented default value for matchmaker flag.
NOTE: For developers who use the Go server runtime support. The nakama-common package at v1.29.0 must be used with this release.
| |
v3.17.1 #
Released: August 23, 2023
Added #
- Add Satori
recomputeoptional input parameter to relevant operations.
Changed #
- Prefix storage index values with
value.for query input namespacing purposes.
Fixed #
- Ensure graceful log handling during Lua runtime check operation.
- Fix Satori client response body resource handling.
NOTE: For developers who use the Go server runtime support. The nakama-common package at v1.28.1 must be used with this release.
| |
v3.17.0 #
Released: July 19, 2023
Added #
- Introduce pagination for console API leaderboard and tournament listing endpoint.
- Introduce pagination for devconsole leaderboard view.
- Add storage object indexing support and related runtime functions.
- Return rank count from leaderboard score listings, if available for the given leaderboard.
- Return rank count from tournament score listings, if available for the given tournament.
Changed #
- Better formatting for graphed values in devconsole status view.
- Better handling of large numbers of configured leaderboards and tournaments.
- Improved delivery of non-persistent SendAll notifications to large numbers of users.
- Truncate stats reported to devconsole status view to 2 decimal digits for improved readability.
- Memory usage and population time improvements in leaderboard rank cache.
- Better handling of internal transaction retries.
- Better handling of party membership when interacting with matchmaking.
- Improve leaderboard cache reporting of idempotent operations.
- Build with Go 1.20.6.
Fixed #
- Correct cursor usage in group listings using only open/closed group state filter.
- Fix issue delivering persistent SendAll notifications to large numbers of users.
- Remove incorrect category start and category end parameters from runtime leaderboard list functions.
- Graceful handling of idempotent tournament creation operations.
- Correct sorting of batched storage write and delete operations.
- Fix indexing of channel message list responses in Lua runtime.
- Better handling of parameters submitted from the devconsole UI.
- Remap original Google IDs to “next generation player IDs”
- Return ordered owner records in leaderboard/tournament records listings.
NOTE: For developers who use the Go server runtime support. The nakama-common package at v1.28.0 must be used with this release.
| |
v3.16.0 #
Released: April 18, 2023
Added #
- Add “tournamentRecordDelete” function to server frameworks.
- Add “insecure” flag to runtime http functions to optionally skip TLS checks.
- Satori API available to Nakama server in all server frameworks.
- New “MatchmakerOverride” hook to provide custom matching behaviour.
Changed #
- Improve graceful shutdown of Google IAP receipt processor.
- If In-App Purchase validation contain mismatching user IDs, do not return an error.
- Better handling of matchmaker operations while the interval process is in execution.
- Add user ID param to Go runtime GroupUpdate function.
- Build with Go 1.20.3 and use Debian bullseye-slim for base docker images.
Fixed #
- Consistent validation of override operator in runtime leaderboard record writes.
- Correctly filter open/closed groups in the listing API.
- Ensure direct message channel message list is correctly scoped to participants only.
- Make next and previous cursor of leaderboard and tournament records around owner operations consistent with record listings.
- Make next and previous cursor of leaderboard and tournament records haystack operations consistent with record listings.
NOTE: For developers who use the Go server runtime support. The nakama-common package at v1.27.0 must be used with this release.
| |
v3.15.0 #
Released: January 5, 2023
Happy New Year to everyone! 🎉
For the full release notes have a look at our release notes documentation.
Added #
- Allow the socket acceptor to read session tokens from request headers.
- Add support for custom response headers set in server configuration.
- Add missing fields to tournament end and reset JavaScript server framework hooks.
- Add support for removing channel messages to all server runtimes.
- Allow Console group UI view to add new members.
- Allow “DELETE” and “HEAD” methods in server framework HTTP request functions.
- Add In-App Purchase notification callback functions to all server runtimes.
- Add “DeleteAccount” client API function.
- Add “DeleteAccount” before and after hook functions to all server runtimes.
Changed #
- Use stricter validation of limit param in server framework storage list operations.
- Allow newer subdomain variant in Facebook Limited Login token issuer field.
- Rename “groupsGetRandom” to “groups_get_random” in the Lua server framework for consistency.
- Accept Google IAP receipts with or without Unity wrapper structures.
- Update Nakama logos.
- Use stricter validation of method param in Lua server framework HTTP request function.
- Disable SQL statement cache mode describe by default. This reverts to the same behaviour as before 3.14.0 release.
- Build with Go 1.19.4 release.
Fixed #
- Fix response structure in purchase lookups by identifier.
- Ensure corresponding leaderboard rank cache entries are removed when a user is deleted.
- Update scheduler when leaderboards and tournaments are deleted from the Console.
- Fix matchmaker tracking of eligible matches when downsizing for count multiples.
- Handle context cancellation in “httpRequest” calls in the JavaScript server framework.
- Handle context cancellation in “httpRequest” calls in the Lua server framework.
- Fix logic on users who attempt to leave groups they’re banned from.
- Fix logic in optional params in JavaScript server framework token generate function.
- Validate group member count so it does not update when failing to add a member.
- Handle Google IAP validation token caching when using credential overrides.
- More graceful handling of no-op authoritative storage delete operations.
- Ensure rank cache is correctly updated when joining tournaments.
- Ensure default parameters for tournament listings are consistent between API and runtimes.
- Fix Console groups view incorrect visual removal of last group member.
- Fix In-App Purchase subscription notification handling.
- Fix handling of party leader transition if previous leader and other members leave concurrently.
- Fix exact enforcement of maximum party size.
NOTE: For developers who use the Go server runtime support. The nakama-common package at v1.26.0 must be used with this release.
| |
v3.14.0 #
Released: October 14, 2022
For the full release notes have a look at our release notes documentation.
Added #
- Add new GroupsGetRandom function to the runtimes.
Changed #
- More consistent signature and handling between JavaScript runtime Base64 encode functions.
- Improve group list cursor handling for messages with close timestamps.
- Improve handling of database connections going through proxies.
- Improve extraction of purchases and subscriptions from Apple receipts.
- Improve signature of JavaScript runtime Base64 decode functions.
- Improve signature of JavaScript runtime Base16 encode and decode functions.
- Token and credentials as inputs on unlink operations are now optional.
- Improve runtime IAP operation errors to include provider payload in error message.
- Build with Go 1.19.2 release.
Fixed #
- Observe the error if returned in storage list errors in JavaScript runtime.
- More exact usage of limit parameter in leaderboard record listings.
- Include subscriptions in all data deletion from the developer console.
- Fix the return format of JavaScript runtime account export function.
- Add user ID to JS runtime wallet operations returned results.
- Fix a bug which would prevent subscriptions to be stored when validating with persist set to true.
- If server shutdown is started before the rank cache is populated observe the context cancellation.
NOTE: For developers who use the Go server runtime support. The nakama-common package at v1.25.0 must be used with this release.
| |
v3.13.1 #
Released: August 18, 2022
For the full release notes have a look at our release notes documentation.
Fixed #
- Push new tag for fix to Docker image releases.
Added #
- Add subscription validation APIs and runtime functions for Google and Apple.
- New Chat Messages view in the Nakama Console.
- New Chat Messages listing and delete endpoints in the Nakama Console API.
- Add extended filtering options to Nakama Console Matches view.
- Add additional filter handling to Nakama Console Accounts view.
- Add “NotificationsDelete” function to all runtimes.
Changed #
- Improve runtime handling of non-persisted purchases and subscriptions.
- Improve validation of count multiple matchmaker parameter.
- Use stricter validation of user email inputs in the Nakama Console.
- Add next and previous cursor to results of leaderboard and tournament records around owner client operations.
- Add next and previous cursor to results of leaderboard and tournament records haystack runtime operations.
- Build with Go 1.19.0 release.
- Improve signature of JavaScript runtime HMAC SHA256 hash function.
- Improve signature of JavaScript runtime Base64 encode functions.
- Improve handling of JavaScript runtime context cancellation.
- Allow runtime group updates to increase max count beyond 100.
NOTE: For developers who use the Go server runtime support. The nakama-common package at v1.24.0 must be used with this release.
| |
v3.12.0 #
Released: May 22, 2022
For the full release notes have a look at our release notes documentation.
Added #
- Add “FriendsBlock” function to all runtimes.
- Add “ChannelMessagesList” function to all runtimes.
Changed #
- Ensure storage write ops return acks in the same order as inputs.
- Update console path for delete all data operation.
- Check HTTP key before Authorization header in RPC function invocations.
- Expose error message from Apple authentication JWT verification failures.
- Improve user online status lookups.
- Build with Go 1.18.2 release.
- Update naming of delete notifications before/after hook registration functions.
- Improve clarity of Nakama Console status view graph headers.
- Improve log messages from failed social provider requests.
- Improve concurrency with Lua runtime function registrations.
- Ensure authoritative match loggers correctly include only their own match identifier.
- Improve handling of large tournament max size values.
- Improve handling of channel removal on group leave/kick/ban.
- Small UI adjustments to the group membership view in the Nakama Console.
Fixed #
- Fix data returned by “StreamUserList” in JavaScript runtime.
- Allow passing lists of presences as match init parameters to Go runtime matches.
- Fix Nakama Console object counts when database statistics are not available.
- Must generate username field in the token generator if not specified when called by the server runtimes.
- Improve JavaScript runtime authoritative match filtered broadcasts to large sets of users.
- Align optional parameters in JavaScript runtime bindings.
- Fix JavaScript registered match handlers not being available within the “InitModule” function.
- Use unique notification ID handling for persistent notifications sent to all users.
- Ensure concurrent leaderboard creation requests are handled idempotently.
- Fix regression with matchmaker optimization used when only two opponents are matched.
NOTE: For developers who use the Go server runtime support. The nakama-common package at v1.23.0 must be used with this release.
| |
v3.11.0 #
Released: March 21, 2022
Added #
- Add “GroupUsersBan” function to all runtimes.
- Add “LeaderboardRecordsHaystack” to all runtimes.
- Add Groups page and API endpoints to the developer console.
- Add “NotificationSendAll” function to the runtimes, for sending a notification to all users.
- Log a warning when client IP address cannot be resolved.
- Add matchmaker option to enforce a multiple of resulting matched count.
- Add tagged Prometheus stats containing RPC function identifiers.
Changed #
- Improve Stackdriver log format timestamp and message field formats.
- Use crypto random to seed global random instance if possible.
- Allow migrate subcommand to use database names that contain dashes.
- Add senderID param to “channelIdBuild” function.
- Improve leaderboard rank cache population at startup.
- JavaScript global variables are made immutable by default after the “InitModule” function is invoked.
- Return system user UUID string in “StorageWrite” acks for all runtimes.
- Realtime after hooks now include both the outgoing and incoming payload.
- Realtime after hooks do not run when the operation fails.
- Build with Go 1.18.0 release.
Fixed #
- Fix the registered function name for “nk.channelIdBuild” in the JavaScript runtime.
- Better input validation for Steam link operations.
- Fix incorrect link device behaviour in JavaScript runtime.
- Fix JavaScript runtime multi-update execution consistency when part of the operation fails.
- Fix handling of wallet ledger lookups with no limit during account exports.
- Ensure maximum count is accounted for in matchmaker mutual match checks.
- Ensure the matchmaker always correctly prefers matches closer to the maximum count.
NOTE: For developers who use the Go server runtime support. The nakama-common package at v1.22.0 must be used with this release.
| |
v3.10.0 #
Released: December 17, 2021
Added #
- Add ctx field to access http request headers in the runtimes.
- New JS runtime stringToBinary and binaryToString functions.
- New configuration option for frequency of database DNS change scans.
Changed #
- Set JavaScript runtime custom error message as the returned payload message in RPC requests.
- JavaScript runtime match data changed to use Uint8Array type.
- Update Tally, and transitive dependencies to resolve dynamic linker error in xxhash package.
- Build with Go 1.17.5 release.
Fixed #
- Gracefully close Lua matches when call queue fills up.
- Better handling for Lua runtime wallet update operation errors.
- Fix handling of leaderboard record writes that do not need to update the database.
- Fix parsing edge case in TypeScript/JavaScript runtime storage delete operations.
- Better handling of leaderboard and tournament score submissions that result in no score change.
- Named match creation now returns existing presences if the name mapped to an existing match.
NOTE: For developers who use the Go server runtime support. The nakama-common package at v1.21.0 must be used with this release.
| |
v3.9.0 #
Released: October 29, 2021
Added #
- Allow creation of relayed matches with a name. Names will be mapped to match identifiers.
- Expose Nakama errors to the server runtime.
- The wallet ledger view in the Nakama Console now supports pagination.
Changed #
- Periodically check database hostname for underlying address changes more frequently.
- Upgrade GRPC, GRPC-Gateway, Protobuf, PGX, and other dependencies.
Fixed #
- Fix optimistic email imports when linking social profiles.
NOTE: For developers who use the Go server runtime support. The nakama-common package at v1.20.0 must be used with this release.
| |
v3.8.0 #
Released: October 15, 2021
Added #
- Add final notification sent to sockets closed via single socket option.
- Add match signal function to server framework.
- Add node status icons to the console dashboard.
Changed #
Build with Go 1.17.2 release.
Match handlers are now required to implement a signal handler function.
Match signals allow the match handler to be sent a reservation signal to mark a user ID or session ID into the match state ahead of their join attempt and eventual join flow. This is useful to apply reservations to a matchmaking system with Nakama’s matchmaker or match listings APIs.
Log status follow missing users at debug instead of warn level.
Fixed #
- Fix input validation edge case in group listing operations.
NOTE: For developers who use the Go server runtime support. The nakama-common package at v1.19.0 must be used with this release.
| |
v3.7.0 #
Released: September 28, 2021
Added #
- New config options to enforce a single socket per user, and a single match per socket.
Changed #
- Build with Go 1.17.1 release.
- Allow tournament creation operations to set the authoritative flag.
- Update to nakama-common 1.18.0 release.
NOTE: For developers who use the Go server runtime support. The nakama-common package at v1.18.0 must be used with this release.
| |
v3.6.0 #
Released: September 9, 2021
Added #
- More informational logging when groups are created, updated, or deleted.
- Add “ChannelMessageUpdate” function to server framework.
- New config option to toggle Lua runtime error stacktraces returned to clients.
Changed #
- Use the Facebook Graph API v11.0 version.
- Defer Facebook email import execution to after account creation.
- Improve encode/decode check in authoritative match creation parameters.
- Warn when using deprecated config parameters.
- Improve email import semantics when linking social accounts.
- Log IAP provider API response payload when non 200 status code is returned.
- Better handling of storage operations where OCC is not required.
- Default ledger updates to false in “walletsUpdate” function in the JavaScript/Lua runtimes. Same as how Go usage works.
- Build with Go 1.17.0 release.
- Purchase validation functions now return a flag indicating if valid purchases are new or resubmitted.
- Adjust Lua runtime pool allocation startup logs.
Fixed #
- Fix log level in Lua runtime log calls which use structured logger fields.
- Register purchase validation before/after hooks in JavaScript/Lua runtimes.
- Register “DemoteGroupUsers” before/after hooks in the JavaScript runtime.
- Add missing “environment” to JavaScript ValidatedPurchases type.
- Fix typos in error messages which mention empty input values.
- Fix resolution of exported time and latency metrics.
- Optimize tournament lookup operations.
- Fix “groupUpdate” function incorrect parsing of “open” argument in the Lua runtime.
- List JavaScript modules if loaded from the default entrypoint in the Console.
NOTE: For developers who use the Go server runtime support. The nakama-common package at v1.17.0 must be used with this release.
| |
v3.5.0 #
Released: August 10, 2021
Added #
- Handle thrown JS runtime custom exceptions containing a message and a grpc code to be returned in the server response.
- Add function to retrieve a random set of users to server framework.
- Add ChannelMessageSend function to server framework.
- Add BuildChannelId function to server framework.
Changed #
- Apple Sign-In is now supported across both Web and mobile tokens.
- Status messages can now be up to 2048 characters (increased from 128 characters).
- Improved SQL used in unfiltered group listings queries.
- Throw error instead of panic when attempting to create a group with the system user.
- Add userId field for permission check in JavaScript/Lua runtimes groupUpdate functions.
- Allow standard space characters in usernames for direct compatibility with Steam display names.
- Build with Go 1.16.7 release.
- Allow batch-only leaderboard and tournament score lookups from the server framework.
- Return a better error message when single input wallet updates are performed for a user which does not exist.
- Update to newer Apple guidelines on Game Center root certificate validation in authentication.
Fixed #
- Fix creator id being read from the wrong argument in JavaScript runtime groupUpdate function.
- Fix max count being incorrectly validated in groupUpdate JavaScript runtime function.
- Fix error handling when attempting to write records to a tournament that does not exist.
- Fix JavaScript runtime missing fields from leaderboards/tournaments get, list, and write functions.
- Fix JavaScript runtime ownerId field bad parsing in leaderboard/tournament records list functions.
- Fix parameter usage in leaderboard score set operator.
- Fix JavaScript runtime storageList not returning a cursor.
NOTE: For developers who use the Go server runtime support. The nakama-common package at v1.16.0 must be used with this release.
| |
v3.4.0 #
Released: July 8, 2021
Added #
- Add new groupsList runtime function.
- Add runtime leaderboardList and leaderboardsGetId functions.
- Add leaderboard/tournament prev_reset field.
- Add custom metrics runtime functions for counters, gauges, and timers.
- Add optional override for runtime Apple IAP validation function.
- Add socket lang parameter to Go runtime contexts.
Changed #
- Include ticket in party matchmaker add operation responses.
- Build with Go 1.16.5 release.
- Replace Bleve gtreap in-memory store implementation with a more compact version.
- Users kicked from parties now receive a party close event.
- Log recovered panics in HTTP handler functions at error level rather than info.
- Add new langTag, members and open filters to the group listing API.
- Upgrade pgx to v4 for improved SQL performance.
- Update RegisterLeaderboardReset runtime function signature.
- Cancel runtime context when graceful shutdown completes.
- Add button to Nakama Console UI to allow device IDs to be copied.
Fixed #
- Ensure all members are correctly listed in party info when there are multiple concurrent successful joins.
- Correctly set party ID in matchmaker matched callback input.
- Send Party close messages only where appropriate.
- Fix TypeScript/JavaScript match dispatcher presence list validation.
- Fix JavaScript/Lua friendsList incorrect returned values.
NOTE: For developers who use the Go server runtime support. The nakama-common package at v1.15.0 must be used with this release.
| |
v3.3.0 #
Released: May 17, 2021
Added #
- Tournaments and leaderboards now allow operator scoring to be passed in on updates.
- Tournaments and leaderboards now support decrement score operator.
- Add “rpc_id” and “api_id” to the structured logger output in API calls.
Changed #
- Store email, avatar URL, and display name provided by Apple, Facebook, and Google login providers if empty.
- Change runtime group add/kick/promote/demote APIs to include optional callerID parameter for permission checking. If the caller ID is an empty string it defaults to the system user.
- Default to use SSL mode “prefer” in database connections.
Fixed #
- Fix reading Lua authoritative match states that contain functions.
- Fix reading JS/TS authoritative match states that contain functions.
- Use UNIX path representation for embedded migrations and console files on Windows systems.
- Update Lua VM implementation to resolve nil reference caused after a VM registry resize.
- Pointerize slice and map types when passed into the JS VM so that they’re mutated by reference.
- Fix off by one error in leaderboard records returned by “around owner” queries.
- Return null from within JS VM GetMatch function if match does not exist.
NOTE: For developers who use the Go server runtime support. The nakama-common package at v1.14.0 must be used with this release.
| |
v3.2.1 #
Released: April 18, 2021
Changed #
- A user’s online indicator now observes the status mode rather than just socket connectivity.
- Update sql-migrate library to a32ed26.
- Rework some migrations for better compatibility with different database engines.
- Update to Protobuf v1.5.2, GRPC v1.37.0, and GRPC-Gateway v2.3.0 releases.
- Update to Bleve v2.0.3 release.
- Various other dependency updates.
Fixed #
- Fix user scoping in Nakama Console purchase listing view.
NOTE: For developers who use the Go server runtime support. The nakama-common package at v1.13.1 must be used with this release.
| |
v3.2.0 #
Released: April 14, 2021
### Added
- New API to logout and intercept logouts with session and refresh tokens.
- Add a leave reason to presence events to handle transient disconnects more easily.
- New API for IAP validation with Apple App Store, Google Play Store, and Huawei AppGallery.
Changed #
- Improve struct field alignment on types in the social package.
- Improve memory re-use within the matchmaker and match registry structures.
- Support Facebook Limited Login tokens received into the standard Facebook login/link/unlink functions.
- Update JS VM to newer version. This resolves an issue with resizing some JS arrays.
- Build with Go 1.16.3 release.
Fixed #
- Matchmaker entries which were only partially matched together could not combine with larger player counts.
- Fix bad inputs parsed in some before/after hook executions made from the API Explorer in the Console.
- Correctly return Unix timestamps in JS runtime functions returning users/accounts data.
NOTE: For developers who use the Go server runtime support. The nakama-common package at v1.13.0 must be used with this release.
| |
v3.1.2 #
Released: March 4, 2021
Changed #
- Sort match listings to show newer created matches first by default.
- Loosen status follow input validation and constraints to ignore unrecognised user IDs and usernames.
- Build with Go 1.16.0 release.
- Do not import Steam friends by default on Steam authentication.
- Do not import Facebook friends by default on Facebook authentication.
- Improve match label update batching semantics.
- Account object returned by some JS runtime functions are not flattened with user values anymore.
Fixed #
- Fix an issue in the JS runtime that would prevent the matchmaker matched callback to function correctly.
- Allow the console API to return large responses based on the configured max message size.
- Allow JS runtime initializer functions to be invoked inside a try/catch block.
- Fix Tournament Reset function hook schedules calcuated on first write if the end active time must be computed with no reset schedule.
NOTE: For developers who use the Go server runtime support. The nakama-common package at v1.12.1 must be used with this release.
| |
v3.1.1 #
Released: February 15, 2021
Changed #
- Go runtime logger now identifies the file/line in the runtime as the caller rather than the logger.
- Build with Go 1.15.8 release.
- Use a newer CA certificates package within the Docker containers.
Fixed #
- Fix an issue that prevented the JavaScript runtime hooks to be invoked correctly.
- Fix the delete button not working in the console leaderboard listing.
- GetUsers can fetch user accounts by Facebook ID the same as in the client API.
NOTE: For developers who use the Go server runtime support. The nakama-common package at v1.12.1 must be used with this release.
| |
v3.1.0 #
Released: February 4, 2021
Added #
- New APIs to import Steam friends into the social graph.
Changed #
- Improve output of “nakama migrate status” command when database contains unknown migrations.
- The socket status flag is now parsed as case-insensitive.
- Build with Go 1.15.7 release.
Fixed #
- Fix an issue with the JS runtime multiUpdate function.
- Fix an issue where the JS runtime would call the InitModule function twice.
- Fix how the JS runtime invokes matchmakerMatched and leaderboard/tournament related hooks.
- Fix JS VM not being put back into the pool after an RPC call.
NOTE: For developers who use the Go server runtime support. The nakama-common package at v1.12.0 must be used with this release.
| |
v3.0.0 #
Released: January 16, 2021
This is a major release of the server but is fully backwards compatible with the 2.x releases. Have a look at the release announcement for more details: https://heroiclabs.com/blog/announcements/nakama-3-0/
Added #
- New JavaScript runtime to write server code.
- Introduce refresh tokens that can be used to refresh sessions.
- New Realtime Parties for users to create teamplay in games. Users can form a party and communicate with party members.
- Add party matching support to the Matchmaker.
- Add options to the Matchmaker to control how long tickets wait for their preferred match.
- Add Console UI permissions API.
- New “ReadFile” runtime function to read files within the “–runtime.path” folder.
Changed #
- Rebuild Console UI with Angular framework. Manage user data, update objects, restrict access to production with permission profiles, and gain greater visibility into realtime features like active matches.
- Matchmaker improvements to the process for matching and the handling of player count ranges.
- Authoritative match handlers can now tick at 60 per second.
- Support CockroachDB 20.2 release.
- Build with Go 1.15.6 release.
Fixed #
- Return rank field in Lua API for leaderboard record writes.
- Return social fields for users in friend listings.
NOTE: For developers who use the Go server runtime support. The nakama-common package at v1.11.0 must be used with this release.
| |
v2.15.0 #
Released: November 28, 2020
Added #
- Add cacheable cursor to channel message listings.
- Add group management functions to the server runtime. Thanks @4726.
Changed #
- Make metrics prefix configurable and set a default value.
- Pin the GRPC Go plugin for the protoc compiler with a tool dependency.
- Build with Go 1.15.5 release.
- Use the Facebook Graph API v9.0 version.
- Facebook authentication no longer requires access to gender, locale, and timezone data.
- Update to Bleve v1.0.13 release.
- Update to nakama-common 1.10.0 release.
- Skip logging Lua errors raised by explicit runtime calls to the
error({ msg, code })function.
Fixed #
- Better handling of SSL negotiation in development with certs provided to the server.
- Use correct error message and response code when RPC functions receive a request payload larger than allowed.
- Expose missing ‘group_users_kick’ function to the Lua runtime.
- Fix an issue that would cause an error when trying to update a tournament record with invalid data.
- Fix some issues around listing tournaments.
- Fix an issue that would prevent the insertion of a record in a tournament with no scheduled reset and end time.
- Ensure the devconsole applies user password updates even if no other fields change.
NOTE: For developers who use the Go server runtime support. The nakama-common package at v1.10.0 must be used with this release.
| |
v2.14.1 #
Released: November 2, 2020
Added #
- Event contexts now contain user information for external events.
- Expose more metrics for socket activity.
- New Docker release of the server with debug symbols enabled.
- Add “TournamentRecordsList” and “ListFriends” functions to the Go server runtime.
- Add “friends_list” and “tournament_records_list” functions to the Lua server runtime.
Changed #
- Build with Go 1.15.3 release.
- Update to Protobuf v1.4.3, GRPC v1.33.1, and GRPC-Gateway v2.0.1 releases.
- Update protocol definitions for OpenAPIv2 code generator.
Fixed #
- Fix score comparisons on leaderboard record ranks in cache. Thanks @4726.
- Put “rank” field into results from “tournament_records_haystack” calls in Lua server runtime.
- Add missing cursor return values from “GroupUsersList” and “UsersGroupList” functions in the Go server runtime.
NOTE: For developers who use the Go server runtime support. The nakama-common package at v1.9.0 must be used with this release.
| |
v2.14.0 #
Released: October 3, 2020
Added #
- Publish new metric for presences count.
- Use a “tool dependency” to specify the protoc-gen-go, protoc-gen-grpc-gateway, and protoc-gen-openapiv2 required versions. See here.
Changed #
- Build with Go 1.15.2 release.
- Update to Protobuf 1.4.2, GRPC 1.32.0, and GRPC-Gateway 2.0.0-beta.5. This enables us to take advantage of the new Protobuf runtime. See here.
- Replace shell script with Go generate commands to run protoc toolchain.
- Update protocol definitions to remove warnings from stricter Go package import paths. See here.
- Move some Go packages to be internal.
- Improved rank caching strategy.
- Separate authentication error response code and message for banned accounts.
- Pin to an older certs store in the Docker container to work around an issue with GeoTrust certificates.
NOTE: For developers who use the Go server runtime support. The nakama-common package at v1.8.0 must be used with this release.
| |
v2.13.0 #
Released: August 31, 2020
Added #
- Add Sign in with Apple authentication, link, and unlink.
- Wallet operations now return the previous and updated state of the wallet.
- New multi-update runtime function to handle batched storage, wallet, and account updates in a single transaction.
- Groups now have a demote API for convenience.
Changed #
- Build with Go 1.15.0 release.
- Sanitize metric names and properties fields.
- Wallet updates now use int64 values to ensure precision in all numeric operations.
- Update to nakama-common 1.7.3 release.
- Optimize how session IDs are stored in presence structs.
- Friend listings now allow a page size of up to 1000 objects.
Fixed #
- Prevent bad presence list input to dispatcher message broadcasts from causing unexpected errors.
- Extra HTTP headers in RPC responses are set before the response is written to the buffer.
- Fix an issue in the Lua runtime nk module’s “jwt_generate” function that would prevent it from accepting a key in RS256 format.
- Fix an issue in the Lua runtime nk module’s “rsaSHA256Hash” function that would prevent it from parsing the input private key.
- Unmatched routes in the Nakama Console server now return a 404 rather than a 401 response.
NOTE: For developers who use the Go server runtime support. The nakama-common package at v1.7.3 must be used with this release.
| |
v2.12.0 #
Released: May 25, 2020
Added #
- Print a log message when all authoritative messages have stopped during graceful shutdown.
- New option in Lua runtime for read-only globals to reduce memory footprint. This is enabled by default.
- Separate server config flags for socket read and write buffer sizes.
- Add user session scoped fields to authoritative match join attempt contexts.
- Add group ID to content of in-app notifications sent with user changes in groups.
- New runtime function to get a single match by ID.
- New runtime functions for link and unlink operations.
- New Lua runtime function to print a log message at debug level.
- Add disable time to account get operations in the server runtime.
- Expose last user relationship update time when listing friends.
- Expose caller information in logger messages.
- Expose node name in all runtime contexts.
Changed #
- Rebuild metrics implementation.
- Validate GOB encoded authoritative match create parameters.
- Eliminate user account writes to database if fields have not changed.
- The gauges in the Developer console status view more accurately reflect current server metrics.
- Disconnect match participants when a Lua runtime authoritative match ends due to an error.
- Sort wallet ledger listings by creation time from newest to oldest.
- Do not update leaderboard and tournament record timestamps when scores have not changed.
- Build with Go 1.14.3 release.
- Update to nakama-common 1.5.1 release.
Fixed #
- Fetch account in Lua runtime function now includes Facebook Instant Game IDs.
- Don’t duplicate runtime environment values in the devconsole configuration view.
- All low-level channel presence events now populate room, group, and direct message fields.
- Developer console status graphs correctly show a fixed time window of metrics.
- Fix friend deletion in developer console user detail view.
- Fix group membership deletion in developer console user detail view.
- A user’s password is no longer expected when unlinking emails.
NOTE: For developers who use the Go server runtime support. The nakama-common package at v1.5.1 must be used with this release.
| |
v2.11.1 #
Released: March 29, 2020
Changed #
- Update protobuf (1.3.5), websocket (1.4.2), opencensus (0.22.3), atomic (1.6.0), zap (1.14.1) dependencies.
- Update devconsole minimist (1.2.2), acorn (6.4.1) dependencies.
- Build with Go 1.14.1 release.
v2.11.0 #
Released: February 27, 2020
Added #
- Return tournament end time in listing operations if one exists.
- Add Facebook Instant Game Authentication.
Changed #
- Build with Go 1.14.0 release.
- Update most server dependencies (particularly GRPC, GRPC Gateway, and Protobuf).
- Upgrade to use nakama-common 1.4.0 release.
NOTE: For developers who use the Go server runtime support. The nakama-common package at v1.4.0 must be used with this release.
v2.10.0 #
Released: February 13, 2020
Added #
- New metric for number of authoritative matches currently running.
- New metric for total number of events dropped by the events processor pool.
Changed #
- Build with Go 1.13.7 release.
- Update username on leaderboard and tournament records when processing a score update.
- Automatically stop empty authoritative matches after a configurable amount of time.
Fixed #
- Fix calculation for ‘can enter’ field for newly created tournaments.
- Ensure tournament reset callbacks carry the correct ID.
- Ensure tournament end callbacks carry the correct end and reset times.
- Expose match stopped state to the Lua runtime match dispatcher.
- Fix calculation of tournament start active time for schedules with variable active durations.
v2.9.1 #
Released: January 14, 2020
Changed #
- Build with Go 1.13.6 release.
- Upgrade devconsole handlebars (4.3.0) dependency.
Fixed #
- Ensure tournament listing correctly uses the cursor on paginated requests.
- Passthrough GRPC Gateway Console requests to GRPC internally with authentication middleware active.
v2.9.0 #
Released: December 23, 2019
Added #
- New runtime functions to retrieve tournaments by ID.
- Allow tournament duration to exceed reset window and cap the duration if it does.
- Ban group users which prevents them from rejoining or requesting to rejoin.
- New config parameter for max request message size separate from socket message size limit.
Changed #
- Do not use absolute path for
tiniexecutable in default container entry point. - Faster validation of JSON object input payloads.
- Update IAP validation example for Android Publisher v3 API.
- Relayed multiplayer matches allow echoing messages back to sender if they’re in the filter list.
- Upgrade Facebook authentication to use version 5.0 of the Facebook Graph API.
- Upgrade devconsole serialize-javascript (2.1.1) dependency.
- Ensure authoritative match dispatcher is no longer usable after match stops.
- Deferred message broadcasts now process just before match ends if match handler functions return an error.
Fixed #
- Correctly read pagination cursor in notification listings.
- Group user add no longer sends another channel message when an add operation is repeated.
- Importing Facebook friends when there are no friends and reset is true now works as expected.
NOTE For developers who use the Go server runtime support. The nakama-common package at v1.3.0 must be used with this release.
v2.8.0 #
Released: November 12, 2019
Added #
- New API for client and runtime events known as event signals.
- Allow user account password updates from the developer console.
Changed #
- Default runtime HTTP key value is no longer the same as the default server key value.
- A group create operation now returns a GRPC Code 6 (HTTP 409 Conflict) when the group name is already in use.
- Allow Console API requests to return results above default size limit.
- The presence count is no longer added together across nodes in the status view of the Developer Console.
- Create tournament operations always returns the existing tournament after repeated calls with the same ID.
- Upgrade to Go 1.13.4 and use Debian buster-slim for base docker images.
- Rate limit the maximum number of concurrent leaderboard/tournament callback executions.
- Allow Go runtime match listing operations min/max count to be optional.
Fixed #
- Handle (OCC) errors when concurrently writing new storage objects.
- Fix optimistic concurrency controls (OCC) on individual storage objects under high write contention.
- Time spent metrics are now correctly reported in milliseconds.
- Password minimum length error message now correctly reflects the constraint.
- Set specific response Content-Type header in successful HTTP RPC responses.
NOTE For developers who use the Go server runtime support. The nakama-common package at v1.2.0 must be used with this release.
v2.7.0 #
Released: September 12, 2019
## Notables changes
Added #
- Enable RPC functions to receive and return raw JSON data.
- Status follow operations now also accept usernames to follow.
- Pagination support for friends listing operations.
- Filtering by friend state in friends listing operations.
- Pagination support for group users listing operations.
- Filtering by user state in group users listing operations.
- Pagination support for user groups listing operations.
- Filtering by group state in user groups listing operations.
- Allow max count to be set when creating groups from client calls.
- Log better startup error message when database schema is not set up at all.
- New “check” command to validate runtime modules without starting the server.
- Add discrete channel identifier fields in all messages and message history listings.
- Session tokens now allow storage of arbitrary string key-value pairs.
- New runtime function for programmatic GDPR account data exports.
Changed #
- Use Go 1.13.0 on Alpine 3.10 as base Docker container image and native builds.
- Update devconsole lodash (4.17.13), lodash.template (4.5.0), eslint-utils (1.4.1), set-value (2.0.1), and mixin-deep (1.3.2) dependencies.
- Errors from runtime before hooks no longer close the session.
- Switch prometheus metrics to use labels instead of a prefix.
- Add flag on realtime socket messages that will support optional reliability.
- Friends listing pages are now limited to max 100 results each.
- Group users listing pages are now limited to max 100 results each.
- User groups listing pages are now limited to max 100 results each.
- Group users listing now includes disabled (banned) users.
- User groups listing now includes disabled groups.
- Remove hard cap on maximum number of users per group.
- Return deterministic ordering for edge relationship listings.
- Return deterministic ordering for storage listing operations.
- Return deterministic ordering for leaderboard scores where both score and subscore are identical.
- Consistent default database address between migration command and main server startup.
- Return deterministic ordering for group listings without filters.
Fixed #
- Handle updates during leaderboard schedule reset window.
- Ensure the matchmaker cannot match together tickets from the same session.
- Handle leaderboard deletes shortly before a scheduled reset.
- Listing user groups no longer returns an error when the user is a member of zero groups.
- Go runtime group creation now correctly validates max count.
- Consistent expiry calculation in leaderboard records haystack queries.
- Convert custom SQL query and exec parameters to integers when necessary in Lua runtime.
- Correctly validate users before adding them to groups.
- Add missing group chat channel message when a user joins the group.
- Add missing group chat channel message when a user leaves the group.
- Add missing group chat channel message when a user is added to the group.
- Add missing group chat channel message when a user is kicked from the group.
- Add missing group chat channel message when a user is promoted in the group.
- Handle TIMESTAMPTZ return types in Lua runtime custom SQL queries.
- Use consistent upper bound for authoritative match label size.
NOTE: The Go 1.13 release has changed how we build the the server so it can accommodate Go modules for dependency resolution with the builtin Go server runtime. We recommend Go modules be used to manage dependencies on projects which use the Go runtime moving forwards.
v2.6.0 #
Released: July 1, 2019
Added #
- Explicitly set cache control header in all API responses.
- Add support for CockroachDB 19.1.
- Add tournament start active timestamp to the API response.
- Add overridable expiry time when listing leaderboard/tournaments records.
Changed #
- Tournament start time can be set to past time.
- Update GRPC (1.21.1), GRPC-Gateway (1.9.2), Protobuf (1.3.1), Mux (1.7.2), and OpenCensus (0.22.0) dependencies.
- Use Go 1.12.6 as base Docker container image and native builds.
- Move from dep to Go modules for dependency management.
- Switch database driver from pq to pgx.
- Update devconsole handlebars (4.1.2) and js-yaml (3.13.1) dependencies.
- Update community link in console sidebar.
Fixed #
- Fix delayed first time invocation of tournament and leaderboard callbacks.
- Expired tournaments will no longer be listed nor any records will be returned.
- Unlink device identifiers on console user account details page.
- Add missing index drop on migrate down.
- Handle query and parameter resets on wallet update retries.
- Reset list of friend IDs in Facebook import when retrying the operation.
- Reset notifications in friend add when retrying the operation.
- Do not return storage list cursor unless there are further objects.
- Attempt fast user and storage count on partitioned tables in console API.
v2.5.1 #
Released: May 3, 2019
Changed #
- Storage object get operations now also return the user ID if the owner is the root user.
- Status view on console no longer refreshes if server is not reachable.
- Adjust default socket ping and pong heartbeat frequency.
Fixed #
- Display updated counters on console status page.
- Render friend names on console user details page.
- Render group names on console user details page.
- Do not attempt to navigate to groups from console user details page.
- Render changed wallet value after update on console user details page.
- Display custom ID, email, and verification time on console user details page.
- Add missing placeholder text to fields on console user details page.
- Re-render the console storage view when deleting records.
v2.5.0 #
Released: April 25, 2019
Added #
- New developer console UI available on http://127.0.0.1:7351.
- New Lua runtime functions to generate JWT tokens.
- New Lua runtime functions to hash data using RSA SHA256.
- Print max number of OS threads setting in server startup logs.
Changed #
- Log more information when authoritative match handlers receive too many data messages.
- Ensure storage writes and deletes are performed in a consistent order within each batch.
- Ensure wallet updates are performed in a consistent order within each batch.
- Increase default socket pong wait time.
- Ensure leaderboard record metadata, number of scores, and update time are only changed during leaderboard write operations if the score or subscore change.
Fixed #
- Storage write batches now correctly abort when any query in the batch fails.
- Rank cache correctly calculates record expiry times.
- Return correct response to group join operations when the user is already a member of the group.
- Fix query when selecting a page of leaderboard records around a user.
v2.4.2 #
Released: March 25, 2019
Added #
- New programmatic console API for administrative server operations.
- Initial events subsystem with session start+end handlers.
Changed #
- Update GRPC (1.19.0), GRPC-Gateway (1.8.4), and Protobuf (1.3.0) dependencies.
- Use Go 1.12.1 as base Docker container image and native builds.
v2.4.1 #
Released: March 8, 2019
Added #
- Strict validation of socket timeout configuration parameters.
- New Go runtime constants representing storage permissions.
- New runtime function to programmatically delete user accounts.
- Allow multiple config files to be read at startup and merged into a final server configuration.
- Storage listing operations can now disambiguate between listing system-owned objects and listing all objects.
Changed #
- Default maximum database connection lifetime is now 1 hour.
- Improved parsing of client IP and port for incoming requests and socket connections.
- WebSocket sessions no longer log the client IP and port number in error messages.
- Go and Lua server runtime startup log messages are now consistent.
- All schema and query statements that use the ‘1970-01-01 00:00:00’ constant now specify UTC timezone.
- Storage write error message are more descriptive for when values must be encoded JSON objects.
- Storage listing operations now treat empty owner IDs as listing across all objects rather than system-owned objects.
Fixed #
- CRON expressions for leaderboard and tournament resets now allow concurrent usage safely.
- Set console API gateway timeout to match connection idle timeout value.
v2.4.0 #
Released: February 3, 2019
Added #
- New logging format option for Stackdriver Logging.
- New runtime function to immediately disconnect active sockets.
- New runtime function to kick arbitrary presences from streams.
Fixed #
- Fix return arguments for group user list results in Lua runtime function.
- Leaderboard records returned with a previous page cursor no longer errors.
v2.3.2 #
Released: January 17, 2019
Fixed #
- Set gateway timeout to match idle timeout value.
- Reliably release database resources before moving from one query to the next.
- Unlock GPGS certs cache in social client.
v2.3.1 #
Released: January 4, 2019
Added #
- Make authoritative match join attempt marker deadline configurable.
Changed #
- Improve db transaction semantics with batch wallet updates.
Fixed #
- Initialize registration of deferred messages sent from authoritative matches.
- Early cancel Lua authoritative match context when match initialization fails.
- Update decoding of Steam authentication responses to correctly unwrap payload. Thanks @nielslanting
- Parse Steam Web API response errors when authenticating Steam tokens.
v2.3.0 #
Released: December 31, 2018
🎉
Added #
- WebSocket connections can now send Protobuf binary messages.
- Lua runtime tournament listings now return duration, end active, and end time fields.
- Lua runtime tournament end hooks now contain duration, end active, and end time fields.
- Lua runtime tournament reset hooks now contain duration, end active, and end time fields.
- New configuration flag for maximum number of concurrent join requests to authoritative matches.
- New runtime function to kick users from a group.
- Clients that send data to an invalid match ID will now receive an uncollated error.
- The logger now supports optional log file rotation.
- Go runtime authoritative matches now also print Match IDs in log lines generated within the match.
- Email authentication client requests can authenticate with username/password instead of email/password.
- Email authentication server runtime calls can authenticate with username/password instead of email/password.
- New authoritative match dispatcher function to defer message broadcasts until the end of the tick.
- New runtime function to retrieve multiple user accounts by user ID.
- Send notifications to admins of non-open groups when a user requests to join.
- Send notifications to users when their request to join a group is accepted.
- New configuration flag for presence event buffer size.
Changed #
- Replace standard logger supplied to the Go runtime with a more powerful interface.
- Rename stream ‘descriptor’ field to ‘subcontext’ to avoid protocol naming conflict.
- Rename Facebook authentication and link ‘import’ field to avoid language keyword conflict.
- Rejoining a match the user is already part of will now return the match label.
- Allow tournament joins before the start of the tournament active period.
- Authoritative matches now complete their stop phase faster to avoid unnecessary processing.
- Authoritative match join attempts now have their own bounded queue and no longer count towards the match call queue limit.
- Lua runtime group create function now sets the correct default max size if one is not specified.
- Improve socket session close semantics.
- Session logging now prints correct remote address if available when the connection is through a proxy.
- Authoritative match join attempts now wait until the handler acknowledges the join before returning to clients.
Fixed #
- Report correct execution mode in Lua runtime after hooks.
- Use correct parameter type for creator ID in group update queries.
- Use correct parameter name for lang tag in group update queries.
- Do not allow users to send friend requests to the root user.
- Tournament listings now report correct active periods if the start time is in the future.
- Leaderboard and tournament reset runtime callbacks now receive the correct reset time.
- Tournament end runtime callbacks now receive the correct end time.
- Leaderboard and tournament runtime callbacks no longer trigger twice when time delays are observed.
- Check group max allowed user when promoting a user.
- Correct Lua runtime decoding of stream identifying parameters.
- Correctly use optional parameters when they are passed to group creation operations.
- Lua runtime operations now observe context cancellation while waiting for an available Lua instance.
- Correctly list tournament records when the tournament has no end time defined.
v2.2.1 #
Released: November 20, 2018
Added #
- New duration field in the tournament API.
Fixed #
- Set friend state correctly when initially adding friends.
- Allow tournaments to be created to start in the future but with no end time.
- Join events on tournaments with an end time set but no reset now allow users to submit scores.
v2.2.0 #
Released: November 12, 2018
Added #
- New runtime function to send raw realtime envelope data through streams.
Changed #
- Improve error message on database errors raised during authentication operations.
- Set new default of 100 maximum number of open database connections.
- Friendship state is no longer offset by one when sent to clients.
- Group membership state is no longer offset by one when sent to clients.
- Set new default metrics report frequency to 60 seconds.
Fixed #
- Account update optional inputs are not updated unless set in runtime functions.
- Fix boolean logic with context cancellation in single-statement database operations.
v2.1.3 #
Released: November 2, 2018
Added #
- Add option to skip virtual wallet ledger writes if not needed.
Changed #
- Improved error handling in Lua runtime custom SQL function calls.
- Authoritative match join attempts are now cancelled faster when the client session closes.
Fixed #
- Correctly support arbitrary database schema names that may contain special characters.
v2.1.2 #
Released: October 24, 2018
Added #
- Ensure runtime environment values are exposed through the Go runtime InitModule context.
Changed #
- Log more error information when InitModule hooks from Go runtime plugins return errors.
- Preserve order expected in match listings generated with boosted query terms.
Fixed #
- Improve leaderboard rank re-calculation when removing a leaderboard record.
v2.1.1 #
Released: October 21, 2018
Added #
- More flexible query-based filter when listing realtime multiplayer matches.
- Runtime function to batch get groups by group ID.
- Allow authoritative match join attempts to carry metadata from the client.
Changed #
- Improved cancellation of ongoing work when clients disconnect.
- Improved validation of dispatcher broadcast message filters.
- Set maximum size of authoritative match labels to 2048 bytes.
Fixed #
- Use leaderboard expires rather than end active IDs with leaderboard resets.
- Better validation of tournament duration when a reset schedule is set.
- Set default matchmaker input query if none supplied with the request.
- Removed a possible race condition when session ping backoff triggers concurrently with a timed ping.
- Errors returned by InitModule hooks from Go runtime plugins will now correctly halt startup.
v2.1.0 #
Released: October 8, 2018
Added #
- New Go code runtime for custom functions and authoritative match handlers.
- New Tournaments feature.
- Runtime custom function triggers for leaderboard and tournament resets.
- Add Lua runtime AES-256 util functions.
- Lua runtime token generator function now returns a second value representing the token’s expiry.
- Add local cache for in-memory storage to the Lua runtime.
- Graceful server shutdown and match termination.
- Expose incoming request data in runtime after hooks.
Changed #
- Improved Postgres compatibility on TIMESTAMPTZ types.
Fixed #
- Correctly merge new friend records when importing from Facebook.
- Log registered hook names correctly at startup.
v2.0.3 #
Released: August 10, 2018
Added #
- New “bit32” backported module available in the code runtime.
- New code runtime function to create MD5 hashes.
- New code runtime function to create SHA256 hashes.
- Runtime stream user list function now allows filtering hidden presences.
- Allow optional request body compression on all API requests.
Changed #
- Reduce the frequency of socket checks on known active connections.
- Deleting a record from a leaderboard that does not exist now succeeds.
- Notification listings use a more accurate timestamp in cacheable cursors.
- Use “root” as the default database user if not specified.
Fixed #
- Runtime module loading now correctly handles paths on non-UNIX environments.
- Correctly handle blocked user list when importing friends from Facebook.
v2.0.2 #
Released: July 9, 2018
Added #
- New configuration option to adjust authoritative match data input queue size.
- New configuration option to adjust authoritative match call queue size.
- New configuration options to allow listening on IPv4/6 and a particular network interface.
- Authoritative match modules now support a
match_joincallback that triggers when users have completed their join process. - New stream API function to upsert a user presence.
- Extended validation of Google signin tokens to handle different token payloads.
- Authoritative match labels can now be updated using the dispatcher’s
match_label_updatefunction.
Changed #
- Presence list in match join responses no longer contains the user’s own presence.
- Presence list in channel join responses no longer contains the user’s own presence.
- Socket read/write buffer sizes are now set based on the
socket.max_message_size_bytesvalue. - Console GRPC port now set relative to
console.portconfig value.
v2.0.1 #
Released: June 15, 2018
Added #
- New timeout option to HTTP request function in the code runtime.
- Set QoS settings on client outgoing message queue.
- New runtime pool min/max size options.
- New user ban and unban functions.
- RPC functions triggered by HTTP GET requests now include any custom query parameters.
- Authoritative match messages now carry a receive timestamp field.
- Track new metrics for function calls, before/after hooks, and internal components.
Changed #
- The avatar URL fields in various domain objects now support up to 512 characters for FBIG.
- Runtime modules are now loaded in a deterministic order.
Fixed #
- Add “ON DELETE CASCADE” to foreign key user constraint on wallet ledger.
v2.0.0 #
Released: May 14, 2018
This release brings a large number of changes and new features to the server. For more news about this release see the announcement.
Added #
- Authenticate functions can now be called from the code runtime.
- Use opencensus for server metrics. Add drivers for Prometheus and Google Cloud Stackdriver.
- New API for users to subscribe to status update events from other users online.
- New API for user wallets to store and manage virtual currencies.
- Realtime multiplayer supports authoritative matches with a handler and game loop on the server.
- Matches can be listed on the server for “room-based” matchmaker logic.
- “run_once” function to execute logic at startup with the code runtime.
- Variables can be passed into the server for environment configuration.
- Low level streams API for advanced distributed use cases.
- New API for export and delete of users for GDPR compliance.
Changed #
- Split the server protocol into request/response with GRPC or HTTP1.1+JSON (REST) and WebSockets or rUDP.
- The command line flags of the server have changed to be clearer and more explicit.
- Authenticate functions can now take username as an input at account create time.
- Use TIMESTAMPTZ for datetimes in the database.
- Use JSONB for objects stored in the database.
- Before/after hooks changed to distinguish between req/resp and socket messages.
- Startup messages are more concise.
- Log messages have been updated to be more useful in development.
- Stdlib for the code runtime uses “snake_case” consistently across variables and function names.
- The base image for our Docker images now uses Alpine Linux.
Fixed #
- Build dependencies are now vendored and build system is simplified.
- Database requests for transaction retries are handled automatically.
Removed #
- The storage engine no longer needs a “bucket” field as a namespace. It was redundant.
- Leaderboard haystack queries did not perform well and need a redesign.
- IAP validation removed until it can be integrated with the virtual wallet system.
This release is not a simple upgrade from v1.0 so reach out to us for help to upgrade.
v1.4.1 #
Released: March 30, 2018
Added #
- Allow the server to handle SSL termination of client connections although NOT recommended in production.
- Add code runtime hook for IAP validation messages.
Changed #
- Update social sign-in code for changes to Google’s API.
- Migrate code is now cockroach2 compatible.
Fixed #
- Fix bitshift code in rUDP protocol parser.
- Fix incorrect In-app purchase setup availability checks.
- Cast ID in friend add queries which send notifications.
- Expiry field in notifications now stored in database write.
- Return success if user is re-added who is already a friend.
v1.4.0 #
Released: December 16, 2017
Changed #
- Nakama will now log an error and refuse to start if the schema is outdated.
- Drop unused leaderboard ’next’ and ‘previous’ fields.
- A user’s ’last online at’ field now contains a current UTC milliseconds timestamp if they are currently online.
- Fields that expect JSON content now allow up to 32kb of data.
Fixed #
- Storage remove operations now ignore records that don’t exist.
v1.3.0 #
Released: November 21, 2017
Added #
- Improve graceful shutdown behaviour by ensuring the server stops accepting connections before halting other components.
- Add User-Agent to the default list of accepted CORS request headers.
- Improve how the dashboard component is stopped when server shuts down.
- Improve dashboard CORS support by extending the list of allowed request headers.
- Server startup output now contains database version string.
- Migrate command output now contains database version string.
- Doctor command output now contains database version string.
Changed #
- Internal operations exposed to the script runtime through function bindings now silently ignore unknown parameters.
Fixed #
- Blocking users now works correctly when there was no prior friend relationship in place.
- Correctly assign cursor data in paginated leaderboard records list queries.
- Improve performance of user device login operations.
v1.2.0 #
Released: November 6, 2017
Added #
- New experimental rUDP socket protocol option for client connections.
- Accept JSON payloads over WebSocket connections.
Changed #
- Use string identifiers instead of byte arrays for compatibility across Lua, JSON, and client representations.
- Improve runtime hook lookup behaviour.
Note: You will need to update client libraries with this server release:
- For Unity use 0.10.0 or greater.
- For Java/Android use 0.4.0 or greater.
- For Swift use 0.3.0 or greater.
- For JavaScript use 0.1.0 or greater.
v1.1.0 #
Released: October 17, 2017
Added #
- Advanced Matchmaking with custom filters and user properties.
Changed #
- Script runtime RPC and HTTP hook errors now return more detail when verbose logging is enabled.
- Script runtime invocations now use separate underlying states to improve concurrency.
Fixed #
- Build system no longer passes flags to Go vet command.
- Haystack leaderboard record listings now return correct results around both sides of the pivot record.
- Haystack leaderboard record listings now return a complete page even when the pivot record is at the end of the leaderboard.
- CRON expression runtime function now correctly uses UTC as the timezone for input timestamps.
- Ensure all runtime ‘os’ module time functions default to UTC timezone.
v1.0.2 #
Released: September 29, 2017
Added #
- New code runtime function to list leaderboard records for a given set of users.
- New code runtime function to list leaderboard records around a given user.
- New code runtime function to execute raw SQL queries.
- New code runtime function to run CRON expressions.
Changed #
- Handle update now returns a bad input error code if handle is too long.
- Improved handling of accept request headers in HTTP runtime script invocations.
- Improved handling of content type request headers in HTTP runtime script invocations.
- Increase default maximum length of user handle from 20 to 128 characters.
- Increase default maximum length of device and custom IDs from 64 to 128 characters.
- Increase default maximum length of various name, location, timezone, and other free text fields to 255 characters.
- Increase default maximum length of storage bucket, collection, and record from 70 to 128 characters.
- Increase default maximum length of topic room names from 64 to 128 characters.
- Better error responses when runtime function RPC or HTTP hooks fail or return errors.
- Log a more informative error message when social providers are unreachable or return errors.
Fixed #
- Realtime notification routing now correctly resolves connected users.
- The server will now correctly log a reason when clients disconnect unexpectedly.
- Use correct wire format when sending live notifications to clients.
v1.0.1 #
Released: August 5, 2017
Added #
- New code runtime functions to convert UUIDs between byte and string representations.
Changed #
- Improve index selection in storage list operations.
- Payloads in
register_beforehooks now usePascalCasefield names and expose correctly formatted IDs. - Metadata regions in users, groups, and leaderboard records are now exposed to the code runtime as Lua tables.
Fixed #
- The code runtime batch user update operations now process correctly.
v1.0.0 #
Released: August 1, 2017
Added #
- New storage partial update feature.
- Log warn messages at startup when using insecure default parameter values.
- Add code runtime function to update groups.
- Add code runtime function to list groups a user is part of.
- Add code runtime function to list users who’re members of a group.
- Add code runtime function to submit a score to a leaderboard.
- Send in-app notification on friend request.
- Send in-app notification on friend request accept.
- Send in-app notification when a Facebook friend signs into the game for the first time.
- Send in-app notification to group admins when a user requests to join a private group.
- Send in-app notification to the user when they are added to a group or their request to join a private group is accepted.
- Send in-app notification to the user when someone wants to DM chat.
Changed #
- Use a Lua table with content field when creating new notifications.
- Use a Lua table with metadata field when creating new groups.
- Use a Lua table with metadata field when updating a user.
- Updated configuration variable names. The most important one is
DBwhich is nowdatabase.address. - Moved all
nakamaxfunctions intonakamaruntime module. - An invalid config file or invalid cmdflag now prevents the server from startup.
- A matchmake token now expires after 30 instead of 15 seconds.
- The code runtime
os.date()function now returns correct day of year. - The code runtime context passed to function hooks now use PascalCase case in fields names. For example
context.user_idis nowcontext.UserId. - Remove
adminsub-command. - A group leave operation now returns a specific error code when the last admin attempts to leave.
- A group self list operations now return the user’s membership state with each group.
v1.0.0-rc.1 #
Released: July 18, 2017
Added #
- New storage list feature.
- Ban users and create groups from within the code runtime.
- Update users from within the code runtime.
- New In-App Purchase validation feature.
- New In-App Notification feature.
Changed #
- Run Facebook friends import after registration completes.
- Adjust command line flags to be follow pattern in the config file.
- Extend the server protocol to be batch-orientated for more message types.
- Update code runtime modules to use plural function names for batch operations.
- The code runtime JSON encoder/decoder now support root level JSON array literals.
- The code runtime storage functions now expect and return Lua tables for values.
- Login attempts with an ID that does not exist will return a new dedicated error code.
- Register attempts with an ID that already exists will return a new dedicated error code.
Fixed #
- The runtime code for the after hook message was set to “before” incorrectly.
- The user ID was not passed into the function context in “after” authentication messages.
- Authentication messages required hook names which began with “.” and “_”.
- A device ID used in a link message which was already in use now returns “link in use” error code.
Note: These migration notes cover changes which need to be made in developer code. This release requires a Unity client with version greater or equal to 0.7.0 due to small changes in the server protocol.
v0.13.1 #
Released: June 8, 2017
Added #
- Runtime Base64 and Base16 conversion util functions.
Fixed #
- Update storage write permissions validation.
- Runtime module path must derive from
--data-dirflag value. - Fix parameter mapping in leaderboard haystack query.
v0.13.0 #
Released: May 29, 2017
Added #
- Lua script runtime for custom code.
- Node status now also reports a startup timestamp.
- New matchmaking feature.
- Optionally send match data to a subset of match participants.
- Fetch users by handle.
- Add friend by handle.
- Filter by IDs in leaderboard list message.
- User storage messages can now set records with public read permission.
Changed #
- The build system now suffixes Windows binaries with
exeextension.
Fixed #
- Set correct initial group member count when group is created.
- Do not update group count when join requests are rejected.
- Use cast with leaderboard BEST score submissions due to new strictness in database type conversion.
- Storage records can now correctly be marked with no owner (global).
NOTE: This release is compatible with cockroachdb 1.0 or greater. It should also be used with the Unity client at version 0.6.0 or greater.
v0.12.2 #
Released: April 22, 2017
Added #
- Add
--logtostdoutflag to redirect log output to console. - Add build rule to create Docker release images.
Changed #
- Update Zap logging library to latest stable version.
- The
--verboseflag no longer alters the logging output to print to both terminal and file. - The log output is now in JSON format.
- Update the healthcheck endpoint to be “/” (root path) of the main server port.
Fixed #
- Fix a race when the heartbeat ticker might not be stopped after a connection is closed.
NOTE: This release is compatible with cockroachdb beta-20170330 but not newer versions yet. This is due to an issue in cockroachdb with schema migrations.
v0.12.1 #
Released: March 28, 2017
Added #
- Optionally allow JSON encoding in user login/register operations and responses.
Changed #
- Improve user email storage and comparison.
- Allow group batch fetch by both ID and name.
- Increase heartbeat server time precision.
- Rework the embedded dashboard.
- Support 64 characters with
SystemInfo.deviceUniqueIdentifieron Windows with device ID link messages.
Fixed #
- Fix Facebook unlink operation.
v0.12.0 #
Released: March 19, 2017
Added #
- Dynamic leaderboards feature.
- Presence updates now report the user’s handle.
- Add error codes to the server protocol.
Changed #
- The build system now strips up to current dir in recorded source file paths at compile.
- Group names must now be unique.
Fixed #
- Fix regression loading config file.
v0.11.3 #
Released: February 25, 2017
Added #
- Add CORS headers for browser games.
Changed #
- Update response types to realtime match create/join operations.
Fixed #
- Make sure dependent build rules are run with
reluploadrule. - Fix match presence list generated when joining matches.
v0.11.2 #
Released: February 17, 2017
Added #
- Include Dockerfile and Docker instructions.
- Use a default limit in topic message listings if one is not provided.
- Improve log messages in topic presence diff checks.
- Report self presence in realtime match create and join.
Changed #
- Improve warn message when database is created in migrate subcommand.
- Print database connections to logs on server start.
- Use byte slices with most database operations.
- Standardize match presence field names across chat and realtime protocol.
- Improve concurrency for closed sockets.
Fixed #
- Enforce concurrency control on outgoing socket messages.
- Fix session lookup in realtime message router.
- Fix input validation when chat messages are sent.
- Fix how IDs are handled in various login options.
- Fix presence service shutdown sequence.
- More graceful handling of session operations while connection is closed.
- Fix batch user fetch query construction.
- Fix duplicate leaves reported in topic presence diff messages.
v0.11.1 #
Released: February 12, 2017
Changed #
- Server configuration in dashboard is now displayed as YAML.
- Update server protocol to simplify presence messages across chat and multiplayer.
###Â Fixed
- Work around a limitation in cockroachdb with type information in group sub-queries.
Note: This release requires a Unity client with version greater or equal to 0.2.0 due to small changes in the server protocol.
v0.11.0 #
Released: February 9, 2017
Added #
- Add
--verboseflag to enable debug logs in server. - Database name can now be set in migrations and at server startup. i.e.
nakama --db root@127.0.0.1:26257/mydbname. - Improve SQL compatibility.
###Â Changed
- Update db schema to support 64 characters with device IDs. This enables
SystemInfo.deviceUniqueIdentifierto be used as a source for device IDs on Windows 10. - Logout messages now close the server-side connection and won’t reply.
- Rename logout protocol message type from
TLogouttoLogout. - Update server protocol for friend messages to use IDs as bytes.
###Â Fixed
- Fix issue where random handle generator wasn’t seeded properly.
- Improve various SQL storage, friend, and group queries.
- Send close frame message in the websocket to gracefully close a client connection.
- Build system will now detect modifications to
migrations/...files and run dependent rules.
Note: This release requires a Unity client with version greater or equal to 0.2.0 due to small changes in the server protocol.
v0.10.0 #
Released: January 14, 2017
Added #
- Initial public release.
