feat(local): add billing platform service #1991

Atrax1 · 2025-07-22T18:24:24Z

This pull request introduces a new Docker Compose-based test component for the billing platform service, including supporting utilities and configuration. The main changes are the addition of a Go package to manage the billing platform service stack, a Docker Compose YAML file to define the service and its dependencies, and utility functions for handling Docker Compose operations and networking. These changes enable automated setup and teardown of the billing platform service in integration tests.

Billing Platform Service Component Implementation:

Added a new Go package billing_platform_service that provides functions to start, configure, and connect the billing platform service and its dependencies (Postgres, migrations) for testing, including Docker Compose orchestration, container networking, and health checks.

Docker Compose Configuration:

Added docker-compose.yml defining the billing-platform-service, postgres, and migrations services, including environment variables, ports, health checks, and dependencies needed for integration testing.

Docker Compose Utilities:

Added utility functions in utils/docker.go for downloading Compose files, retrieving container hosts and mapped ports, and robustly connecting containers to Docker networks, to support the new billing platform service component.

github-actions · 2025-07-22T18:24:35Z

👋 Atrax1, thanks for creating this pull request!

To help reviewers, please consider creating future PRs as drafts first. This allows you to self-review and make any final changes before notifying the team.

Once you're ready, you can mark it as "Ready for review" to request feedback. Thanks!

skudasov

LGTM, but why not to use testcontainers-go directly? It has PostgreSQL, and it'd be the same amount of code without docker-compose for your case @Atrax1
That's fine if you prefer docker compose, but please add a test to the "golden" pipeline and docs.

Tofel · 2025-07-23T11:32:56Z

framework/components/dockercompose/billing_platform_service/billing_platform_service.go

+	}
+
+	if in.UseCache {
+		if in.Output != nil {


you can combine that into if in.UseCache && in.Output != nil

Tofel · 2025-07-23T11:33:40Z

framework/components/dockercompose/billing_platform_service/billing_platform_service.go

+}
+
+type PostgresOutput struct {
+}


Do we you think it makes sense to expose Postgres? What are the use cases for connecting directly to the database?

for migrations

And test querying. CRE can post credit usage to the billing service so it will be useful for us to verify in tests.

CRE can post credit usage to the billing service so it will be useful for us to verify in tests.

seem better though an api than direct db access. consider change the billing service in follow up

Tofel · 2025-07-23T11:34:55Z

framework/components/dockercompose/billing_platform_service/billing_platform_service.go

+		}
+
+		framework.L.Debug().Msgf("Container %s is connected to network %s", billingContainer.ID, networkName)
+	}


this probably could be extracted, defined as a function and used here and in chip ingress

Tofel · 2025-07-23T11:35:11Z

framework/components/dockercompose/billing_platform_service/billing_platform_service.go

+		},
+	}
+
+	framework.L.Info().Msg("Chip Ingress stack start")


update the log message

Tofel · 2025-07-23T11:35:50Z

framework/components/dockercompose/billing_platform_service/billing_platform_service.go

+func composeFilePath(rawFilePath string) (string, error) {
+	// if it's not a URL, return it as is and assume it's a local file
+	if !strings.HasPrefix(rawFilePath, "http") {
+		return rawFilePath, nil


pls modify it to match what we currently do for chip ingress (I modified it last week, i.e we require that local file is prefixed with file://)

Tofel · 2025-07-23T11:36:11Z

framework/components/dockercompose/billing_platform_service/billing_platform_service.go

+	}
+
+	return tempFile.Name(), nil
+}


actually this should probably also be encapsulated in a function and reused

Tofel · 2025-07-23T11:36:34Z

framework/components/dockercompose/billing_platform_service/billing_platform_service.go

+			return nil
+		}
+	}
+}


export these functions and reuse?

Tofel · 2025-07-23T11:36:53Z

framework/components/dockercompose/billing_platform_service/docker-compose.yml

+    restart: on-failure
+    tty: true
+    container_name: billing-platform-service
+    image: ${BILLING_PLATFORM_SERVICE_IMAGE:-}


can we have a default image?

Tofel · 2025-07-23T11:37:37Z

framework/components/dockercompose/billing_platform_service/docker-compose.yml

+      WORKFLOW_OWNERSHIP_PROOF_SERVER_HOST: 0.0.0.0
+      STREAMS_API_URL: ${STREAMS_API_URL}
+      STREAMS_API_KEY: ${STREAMS_API_KEY}
+      STREAMS_API_SECRET: ${STREAMS_API_SECRET}


can these values be empty? or should we verify in code whether they are set?

Tofel · 2025-07-23T11:37:50Z

framework/components/dockercompose/billing_platform_service/docker-compose.yml

+      - "5432:5432"
+
+  migrations:
+    image: ${BILLING_PLATFORM_SERVICE_MIGRATION_IMAGE:-}


how about a default image?

Tofel · 2025-07-23T11:38:08Z

framework/components/dockercompose/billing_platform_service/docker-compose.yml

+      - dbmate
+      - up
+      - --
+      - --url=${DATABASE_URL}


can we have a default?

Tofel · 2025-08-11T11:17:38Z

LGTM, but why not to use testcontainers-go directly? It has PostgreSQL, and it'd be the same amount of code without docker-compose for your case @Atrax1 That's fine if you prefer docker compose, but please add a test to the "golden" pipeline and docs.

@skudasov as I see it the whole idea is to be able quickly replace docker-compose.yaml file, if there are minor changes/improvement and to lower the lift required for adding new services that already use that file.

krehermann · 2025-09-09T17:58:06Z

framework/components/dockercompose/billing_platform_service/billing_platform_service.go

+}
+
+const (
+	DEFAULT_STACK_NAME = "billing-platform-service"


nit/ billing or billing-platform ?

The var name or the value?

krehermann · 2025-09-09T17:58:22Z

framework/components/dockercompose/billing_platform_service/billing_platform_service.go

+	DEFAULT_BILLING_PLATFORM_SERVICE_BILLING_GRPC_PORT = "2222"
+	DEFAULT_BILLING_PLATFORM_SERVICE_CREDIT_GRPC_PORT  = "2223"
+	DEFAULT_POSTGRES_PORT                              = "5432"
+	DEFAULT_BILLING_PLATFORM_SERVICE_SERVICE_NAME      = "billing-platform-service"


why is this repeated?

Good question. No reason.

krehermann · 2025-09-09T17:59:31Z

framework/components/dockercompose/billing_platform_service/billing_platform_service.go

+	// set development defaults for necessary environment variables and allow them to be overridden by the host process
+	envVars := make(map[string]string)
+
+	envVars["MAINNET_WORKFLOW_REGISTRY_CHAIN_SELECTOR"] = strconv.FormatUint(in.ChainSelector, 10)


add a code comment to New that tells the user about all the env vars.

is there no static file-based config?

This is how the billing platform service is structured. In an effort to not make any hard references to the billing service repo, I forgo copying a standard .env file and set the relevant env vars manually.

krehermann · 2025-09-09T18:00:24Z

framework/components/dockercompose/billing_platform_service/billing_platform_service.go

+	stack.WaitForService(DEFAULT_BILLING_PLATFORM_SERVICE_SERVICE_NAME,
+		wait.ForAll(
+			wait.ForLog("GRPC server is live").WithPollInterval(200*time.Millisecond),
+			wait.ForListeningPort(DEFAULT_BILLING_PLATFORM_SERVICE_BILLING_GRPC_PORT),


should this be settable? it will fail if there is a port conflict, right?

I can do that

krehermann · 2025-09-09T18:01:33Z

framework/components/dockercompose/billing_platform_service/billing_platform_service.go

+		framework.L.Debug().Msgf("Connecting billing-platform-service to %s network", networkName)
+		connectCtx, connectCancel := context.WithTimeout(ctx, 30*time.Second)
+		defer connectCancel()
+		if connectErr := utils.ConnectNetwork(connectCtx, 30*time.Second, cli, billingContainer.ID, networkName, identifier); connectErr != nil {


this looks odd, that you set the timeout above and repeat the 30s

It does, but it wasn't my doing. The ConnectNetwork utility uses both the connectCtx timeout AND the provided additional timeout internally. I used the same values as the beholder example. ¯_(ツ)_/¯

krehermann · 2025-09-09T18:02:41Z

framework/components/dockercompose/billing_platform_service/docker-compose.yml

+    tty: true
+    command: ["grpc", "billing", "reserve"]
+    environment:
+      DISABLE_AUTH: true


oh, is this were all the env vars are set? so that, it is not the case that a test in core would be explicitly setting env vars but rather passing the a ref to the compose file?

This is where the env vars are set in the container. A test could set their own env vars that map to these and would override some of the inputs. I think it's just such a strange case due to the number of env vars in the billing project.

krehermann · 2025-09-09T18:04:54Z

framework/components/dockercompose/utils/docker.go

+
+func ComposeFilePath(rawFilePath string, serviceName string) (string, error) {
+	// if it's not a URL, return it as is and assume it's a local file
+	if !strings.HasPrefix(rawFilePath, "http") {


nit/ you can use file:// or http:// and url.Parse to get the protocol

I think this was from @Atrax1 but I don't think we need the protocol exactly. Just that it is or isn't http(s).

skudasov · 2025-09-11T13:10:28Z

framework/components/dockercompose/utils/docker.go

+	return container.Host(ctx)
+}
+
+func FindMappedPort(ctx context.Context, timeout time.Duration, container *testcontainers.DockerContainer, port nat.Port) (nat.Port, error) {


This would make chaos testing way more complex because when we reboot, we need to find the port again and expose/use this function in chaos tests, minor issue though if you do not plan chaos testing (not recommended!).

We usually just do static ports in all our services because we know only a single environment is allowed to run both locally and in CI (in CI if you need more you do it with GHA Jobs)

I am already having issues with mapped ports, but only if I start up this service in the middle of a test. I'm not attempting to run more than one billing service for all tests, but it is still failing when trying to find the port.

skudasov · 2025-09-11T13:12:10Z

framework/components/dockercompose/billing_platform_service/docker-compose.yml

@@ -0,0 +1,93 @@
+services:
+
+  billing-platform-service:


So we have a Docker Compose file here and in some other repo, which we can download using HTTP, but why not use only one way?

That is a good question. I picked this up where @Atrax1 left off. He could comment on why.

Atrax1 requested a review from a team as a code owner July 22, 2025 18:24

product-security-plaid-test bot requested a review from kalverra July 22, 2025 18:24

Atrax1 requested a review from Tofel July 22, 2025 18:42

skudasov requested changes Jul 23, 2025

View reviewed changes

Tofel reviewed Jul 23, 2025

View reviewed changes

Atrax1 added 2 commits August 29, 2025 17:26

feat(local): add billing platform service

6b896fa

refactor

14888c6

EasterTheBunny force-pushed the PRODCRE-538-add-billing-service-to-local-stack branch from e2acbfa to da7c88e Compare August 29, 2025 23:27

EasterTheBunny force-pushed the PRODCRE-538-add-billing-service-to-local-stack branch 2 times, most recently from 9429588 to c312577 Compare September 9, 2025 15:56

update billing with env vars and input configs

f795c80

EasterTheBunny force-pushed the PRODCRE-538-add-billing-service-to-local-stack branch from c312577 to f795c80 Compare September 9, 2025 16:03

krehermann requested a review from skudasov September 9, 2025 17:53

krehermann reviewed Sep 9, 2025

View reviewed changes

address comments

d467a8b

skudasov reviewed Sep 11, 2025

View reviewed changes

skudasov previously approved these changes Sep 11, 2025

View reviewed changes

fix env var name mismatch

f3fb816

EasterTheBunny dismissed skudasov’s stale review via f3fb816 September 11, 2025 16:57

EasterTheBunny added 3 commits September 11, 2025 11:45

one more env var ref fix

01df7c1

static ports

5779dda

clean up

fe68fdc

patrickhuie19 approved these changes Sep 12, 2025

View reviewed changes

patrickhuie19 enabled auto-merge (squash) September 12, 2025 13:51

skudasov self-requested a review September 12, 2025 13:54

skudasov approved these changes Sep 12, 2025

View reviewed changes

Merge branch 'main' into PRODCRE-538-add-billing-service-to-local-stack

713f331

patrickhuie19 merged commit 9077810 into main Sep 12, 2025
67 checks passed

patrickhuie19 deleted the PRODCRE-538-add-billing-service-to-local-stack branch September 12, 2025 14:15

feat(local): add billing platform service #1991

feat(local): add billing platform service #1991

Uh oh!

Conversation

Atrax1 commented Jul 22, 2025 • edited by sebawo Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Jul 22, 2025

Uh oh!

skudasov 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

Uh oh!

Tofel commented Aug 11, 2025

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!

krehermann Sep 9, 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!

krehermann Sep 9, 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!

Atrax1 commented Jul 22, 2025 •

edited by sebawo

Loading

krehermann Sep 9, 2025 •

edited

Loading

krehermann Sep 9, 2025 •

edited

Loading