Feature/hero 6 #2354

jackhellyercw · 2025-07-17T10:45:57Z

created generic validate purchase func, created new flow for apple platform to use the new register purchase provider and refund funcs. Xbox platform also setup up to use this new flow

…und looping through platforms enum and generic validatePurchase functioniality added

…atepurchase is in

sesposito

Intermediate review feedback, there's some more changes that we'll need here.

sesposito · 2025-07-18T19:55:53Z

apigrpc/apigrpc.proto

+  // Validate Purchase
+  rpc ValidatePurchase (api.ValidatePurchaseRequest) returns (api.ValidatePurchaseResponse) {
+    option (google.api.http) = {
+      put: "/v2/iap/purchase",


I think this should be a post to be consistent with other APIs

changed to post

sesposito · 2025-07-18T19:56:23Z

build/Dockerfile

We likely want to revert these changes

sesposito · 2025-07-18T19:57:25Z

main.go

@@ -187,6 +187,7 @@ func main() {
 	leaderboardRankCache := server.NewLocalLeaderboardRankCache(ctx, startupLogger, db, config.GetLeaderboard(), leaderboardCache)
 	leaderboardScheduler := server.NewLocalLeaderboardScheduler(logger, db, config, leaderboardCache, leaderboardRankCache)
 	googleRefundScheduler := server.NewGoogleRefundScheduler(logger, db, config)
+	xboxRefundPoller := server.NewXboxRefundPoller(logger, db, config)


This should be up to the xbox specific plugin that implements the adapter interface.

moved to the xbox adapter

sesposito · 2025-07-18T20:01:14Z

server/api_purchase.go

+
+func validatePurchaseRequest(ctx context.Context, in *api.ValidatePurchaseRequest, platform iap.Platform, config *IAPConfig) error {
+	switch platform {
+	case iap.Apple:


I think it's ok that we provide well-known defaults for the most common platforms in nakama-common, but we want the implementation (and Nakama) to be agnostic to a specific provider.
Perhaps the adapter interface could expose a GetProviderString and GetProvider functions, or similar.

created a ValidateRequest func on the purchaseprovider interface, this will be used to check for the relevant string for each platform, example

func (a *ApplePurchaseProvider) ValidateRequest(in *api.ValidatePurchaseRequest) error { if a.config.GetApple().GetSharedPassword() == "" { return status.Error(codes.FailedPrecondition, "Apple IAP is not configured.") } return nil }

sesposito · 2025-07-18T20:03:10Z

server/config.go

+	Xbox            *IAPXboxConfig            `yaml:"xbox" json:"xbox" usage:"Xbox Configuration."`
+	Playstation     *IAPPlaystationConfig     `yaml:"playstation" json:"playstation" usage:"Playstation Configuration."`


The configuration should live in the plugin implementation, Nakama should not be aware of specific provider configurations for the generic IAP adapter API.

moved into the adapter, have added a func to the config interface in nakama common which gets the configfilepath which is then used to read in the config in the adapter

sesposito · 2025-07-21T14:05:21Z

main.go

@@ -215,6 +216,7 @@ func main() {

 	leaderboardScheduler.Start(runtime)
 	googleRefundScheduler.Start(runtime)
+	xboxRefundPoller.Start(runtime)


moved into adapter

sesposito · 2025-07-21T14:16:42Z

server/api_purchase.go

+		persist = in.Persist.GetValue()
+	}
+
+	validation, err := purchaseProvider.PurchaseValidate(ctx, s.logger, s.db, in.Receipt, userID, persist, s.config.GetIAP())


This should likely be wrapped into a core function that calls the provider's PurchaseValidate as done here, but also then proceeds to call upsertPurchase to actually store it, and populate the response including the seenBefore field.

We may also want to return the persist flag as part of PurchaseValidate return values so that we skip storing it and just return the validated output.

the upsertPurchase is currently called in the purchaseProvider.PurchaseValidate func, can we have a chat about this tomorrow?

sesposito · 2025-07-21T14:21:43Z

server/xbox_refund_poller.go

Not sure if this is just being used for testing, but if not, it should live in the separate implementation of the adapter interface.

moved into adapter

sesposito · 2025-07-21T14:22:48Z

server/runtime.go

@@ -305,6 +308,8 @@ func (e RuntimeExecutionMode) String() string {
 		return "purchase_notification_google"
 	case RuntimeExecutionModeSubscriptionNotificationGoogle:
 		return "subscription_notification_google"
+	case RuntimeExecutionModePurchaseNotification:
+		return "purchase_notification_"


Suggested change

return "purchase_notification_"

return "purchase_notification"

idea here was that i have prepended the platform inside the registerRefundHandler func:

`func (ri *RuntimeGoInitializer) RegisterRefundHandler(platform string, purchaseRefundFn runtime.PurchaseRefundFn, subscriptionRefundFn runtime.SubscriptionRefundFn) error {
if nk, ok := ri.nk.(*RuntimeGoNakamaModule); ok {
if ri.refundFns == nil {
ri.refundFns = make(map[string]runtime.RefundFns)
}

if nk.refundFns == nil { nk.refundFns = make(map[string]runtime.RefundFns) } purchasefuncWrapper := func(ctx context.Context, logger runtime.Logger, db *sql.DB, nk runtime.NakamaModule, purchase *api.ValidatedPurchase, providerPayload string) error { ctx = NewRuntimeGoContext(ctx, ri.node, ri.version, ri.env, RuntimeExecutionModePurchaseNotification, nil, nil, 0, "", "", nil, "", "", "", "") return purchaseRefundFn(ctx, ri.logger.WithField("mode", RuntimeExecutionModePurchaseNotification.String()+platform), ri.db, ri.nk, purchase, providerPayload) } SubscriptionfuncWrapper := func(ctx context.Context, logger runtime.Logger, db *sql.DB, nk runtime.NakamaModule, subscription *api.ValidatedSubscription, providerPayload string) error { ctx = NewRuntimeGoContext(ctx, ri.node, ri.version, ri.env, RuntimeExecutionModePurchaseNotification, nil, nil, 0, "", "", nil, "", "", "", "") return subscriptionRefundFn(ctx, ri.logger.WithField("mode", RuntimeExecutionModePurchaseNotification.String()+platform), ri.db, ri.nk, subscription, providerPayload) } refundFns := runtime.RefundFns{ Purchase: purchasefuncWrapper, Subscription: SubscriptionfuncWrapper, } ri.refundFns[platform] = refundFns nk.refundFns[platform] = refundFns } return nil

}`

can still remove if you want though

…eric validate purchase func

…purchase provider validate request func

sesposito

Left some more comments @jackhellyercw

sesposito · 2025-08-13T17:22:22Z

server/runtime_config.go

@@ -33,6 +34,10 @@ func (c *RuntimeConfigClone) GetName() string {
 	return c.Name
 }

+func (c *RuntimeConfigClone) GetConfigFilePath() []string {


I think this shouldn't be needed

sesposito · 2025-08-13T17:22:30Z

server/runtime_config.go

@@ -18,6 +18,7 @@ import "github.com/heroiclabs/nakama-common/runtime"

 type RuntimeConfigClone struct {
 	Name          string
+	FilePaths     []string


Shouldn't be needed.

sesposito · 2025-08-13T17:24:21Z

server/runtime_go.go

@@ -2795,6 +2861,82 @@ func (ri *RuntimeGoInitializer) RegisterFleetManager(fleetManager runtime.FleetM
 	return nil
 }

+func (ri *RuntimeGoInitializer) RegisterPurchaseProvider(platform string, purchaseProvider runtime.PurchaseProvider) error {


@novabyte I think we want the platform to be an int, or would we rather use string to identify them?

sesposito · 2025-08-18T16:53:33Z

server/runtime_go.go

+	}
+
+	if nk, ok := ri.nk.(*RuntimeGoNakamaModule); ok {
+		if ri.purchaseProviders == nil {


Can we do these initializations when the structs are initialized instead?

moved initializations

sesposito · 2025-08-18T16:58:36Z

iap/facebook.go

+	return nil, runtime.ErrPurchaseProviderFunctionalityNotSupported
+}
+
+func (f *FacebookPurchaseProvider) HandleRefund(ctx context.Context) (http.HandlerFunc, error) {


This shouldn't return http.HandlerFunc, instead, it should just return error. The actual implementation of the endpoints should be up to the adapter via custom RPC, and for the adapters that we want to auto-register, we should just wrap this function so that we register it as an http.HandlerFunc, to keep it backwards compatible.

so should the custom RPC in the adapter not just be the handleRefund function? and for the auto registered adapters how do you want to wrap this? do you want to move the code that registers the handleFunc inside of the handleRefund func?

created a wrapper func around handleRefund

sesposito · 2025-08-18T16:59:32Z

server/config.go

@@ -550,6 +552,10 @@ func (c *config) GetName() string {
 	return c.Name
 }

+func (c *config) GetConfigFilePath() []string {


Shouldn't be needed

sesposito · 2025-08-18T16:59:39Z

server/config.go

@@ -643,6 +649,7 @@ func (c *config) GetRuntimeConfig() (runtime.Config, error) {

 	cn := &RuntimeConfigClone{
 		Name:          clone.GetName(),
+		FilePaths:     clone.GetConfigFilePath(),


Shouldn't be needed

… generic string passed into validatePurchase func, unused comments removed, platform enum moved to nakama common, google handleRefund flow comment out and revert config file path func changes

…he purchase providers and refund funcs maps where the struct is initialized

sesposito · 2025-08-25T14:20:24Z

server/runtime_go.go

+func RegisterBuiltInIAPPurchaseProviders(nk runtime.NakamaModule, logger runtime.Logger, initializer runtime.Initializer, db *sql.DB, config runtime.IAPConfig, zapLogger *zap.Logger) {
+	// Apple
+	provider := iap.NewApplePurchaseProvider(nk, logger, db, config, zapLogger)
+	if provider != nil {


Shouldn't this check inspect whether a "Apple" provider is registered, and only if not, register the default on?

Same applies for the other providers with default implementations.

This is checked by the RegisterPurchaseProvider func:

_, exists := ri.purchaseProviders[platform] if exists { return errors.New("platform already registered") }

sesposito · 2025-08-25T14:24:10Z

server/runtime_go.go

+	_, exists := ri.refundFns[platform]
+
+	if exists {
+		return errors.New("platform already registered")


Suggested change

return errors.New("platform already registered")

return fmt.Errorf("refund handler for platform %q already registered", platform)

change made

sesposito · 2025-08-25T15:23:22Z

server/api_purchase.go

+	validationPurchases, err := purchaseProvider.PurchaseValidate(ctx, in, userID.String())
+	if err != nil {
+		return nil, err
+	}
+
+	validatedPurchasesResponse, err := handleValidatedPurchases(ctx, s.db, validationPurchases, persist)
+	if err != nil {
+		return nil, err
+	}


We may want to expose this logic under a single function, defined in core_purchase.go, simply because we'll also have to call this for the Lua and JS runtime functions to be exposed.

change made and also have done the same for the subs validate funcs

sesposito · 2025-08-25T17:42:08Z

server/api_purchase.go

+			CreateTime:       timestamppb.New(p.CreateTime),
+			UpdateTime:       timestamppb.New(p.UpdateTime),
+			ProviderResponse: p.RawResponse,
+			Environment:      p.Environment,


We're missing the RefundTime here (I think it was missing in the original code too)

should this be included here? this is called as part of the validate purchase flow not the refund flow

sesposito · 2025-08-25T17:43:50Z

@jackhellyercw maybe it's best if you rebase against the current master as there's been a few changes thus far.

…/hero-6 # Conflicts: # apigrpc/apigrpc.pb.go # apigrpc/apigrpc.pb.gw.go # apigrpc/apigrpc.swagger.json # apigrpc/apigrpc_grpc.pb.go # console/console.pb.go # console/console.pb.gw.go # console/console_grpc.pb.go # console/ui/src/app/console.service.ts # go.mod # go.sum # server/console.go # server/core_subscription.go # server/google_refund_scheduler.go # server/runtime.go # server/runtime_go.go # vendor/github.com/heroiclabs/nakama-common/api/api.pb.go # vendor/github.com/heroiclabs/nakama-common/rtapi/realtime.pb.go # vendor/golang.org/x/net/http2/frame.go # vendor/modules.txt

… certain platform, moved handling of validated purchase and subs funcs into core_purchase and core_subs

sesposito · 2025-08-29T17:18:41Z

@jackhellyercw I think the only thing left is to expose the adapters via the Go/Lua/JS runtimes as well.

jackhellyercw · 2025-09-03T14:33:26Z

@jackhellyercw I think the only thing left is to expose the adapters via the Go/Lua/JS runtimes as well.

@sesposito so is this just for the built in platforms (apple, google, facebook, huawei)? just asking as i've had a quick look at adding a registerPurchaseProvider func for the js runtime and not entirely sure how i would do this. Also not entirely sure how/if i can even add the nakama-console-auth go package to a js runtime server so that i would be able to even use the console platforms

sesposito · 2025-09-03T14:44:19Z

@jackhellyercw we don't want to allow registration via JS/Lua, we'll provide that via the Go modules, however we do want to expose any registered adapters validation via the runtimes, you should only need to wire the adapters to the several providers and add wrappers for Lua/JS to call them

…mented

jackhellyercw added 9 commits June 24, 2025 16:13

xbox adapter validate changes

32bc037

xbox poller setup and now handling generic iap interface

a096c66

removed comments and test logs

7eda417

go mod tidy, go mod vendor

88fb850

playstation validate and before and after hooks added

0d44600

work in progress

47f18de

struct pointer issue for apple interal adapter fixed, fixed issue aro…

5d72b90

…und looping through platforms enum and generic validatePurchase functioniality added

removed unused rpc, before and after funcs now that the generic valid…

4f24c60

…atepurchase is in

remove test logs

1daa434

sesposito requested changes Jul 21, 2025

View reviewed changes

jackhellyercw added 11 commits July 22, 2025 16:05

revert dockerfile changes

f5604af

white space added back in dockerfile

a2d1df0

dockerfile revert

7206953

started address PR comments

c632479

validate request func implemented for apple adapter and called in gen…

0aa3412

…eric validate purchase func

move the console iap config out into console adapter repo

7dcf4bf

added the rest of the built ins and now handling error returned from …

21062a8

…purchase provider validate request func

huawei validate purchase request func implemented

337daaf

handle refund implemeted in the relevant built ins

51f135f

PR requested changes and generic validate subscription implemented

d3b7f1a

google sub validate implemented

a5d79b0

sesposito requested changes Aug 18, 2025

View reviewed changes

jackhellyercw added 5 commits August 19, 2025 11:38

GetProviderString now called platform.String() func in nakama common,…

621f233

… generic string passed into validatePurchase func, unused comments removed, platform enum moved to nakama common, google handleRefund flow comment out and revert config file path func changes

revert config file path changes

f5a3c99

PR comments address: reverted unused config changes and initialized t…

c93c5eb

…he purchase providers and refund funcs maps where the struct is initialized

removed persisit from client purchase and subscription validate response

e057c6e

handle refund wrapper implemented

98b8003

heroiclabs deleted a comment from 22TOXIC-WASTE22 Aug 22, 2025

sesposito requested changes Aug 25, 2025

View reviewed changes

jackhellyercw added 2 commits August 26, 2025 14:55

PR comments: changed error returned if refund fn already register for…

40d4774

… certain platform, moved handling of validated purchase and subs funcs into core_purchase and core_subs

jackhellyercw added 2 commits September 6, 2025 21:28

purchase validate functions, before and after hooks added for js and lua

c759fad

js and lua validate subscription api endpoint and runtime funcs imple…

6ee0155

…mented

		Xbox *IAPXboxConfig `yaml:"xbox" json:"xbox" usage:"Xbox Configuration."`
		Playstation *IAPPlaystationConfig `yaml:"playstation" json:"playstation" usage:"Playstation Configuration."`

	return "purchase_notification_"
	return "purchase_notification"

	return errors.New("platform already registered")
	return fmt.Errorf("refund handler for platform %q already registered", platform)

Feature/hero 6 #2354

Are you sure you want to change the base?

Feature/hero 6 #2354

Uh oh!

Conversation

jackhellyercw commented Jul 17, 2025

Uh oh!

sesposito left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jackhellyercw Jul 23, 2025 • 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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jackhellyercw Jul 23, 2025 • 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!

sesposito left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

jackhellyercw Jul 23, 2025 •

edited

Loading

jackhellyercw Jul 23, 2025 •

edited

Loading