support community extensions #4922

pablochacin · 2025-07-11T14:32:46Z

What?

Allow users to opt for using community extensions (defined in the oss catalog) with the K6_ENABLE_COMMUNITY_EXTENSIONS environment variable. If not enabled, the default cloud catalog will be used.

Why?

By default, binary provisioning only supports extensions defined in the cloud catalog.

We want to offer users the possibility of opting in for the complete catalog of extensions when running tests locally.

Note: if the user enables the community extensions and sends a test to the cloud using cloud run, the test will fail at execution time, as the cloud runners do not support these extensions.

Checklist

I have performed a self-review of my code.
I have commented on my code, particularly in hard-to-understand areas.
I have added tests for my changes.
I have run linter and tests locally (make check) and all pass.

Checklist: Documentation (only for k6 maintainers and if relevant)

Please do not merge this PR until the following items are filled out.

I have added the correct milestone and labels to the PR.
I have updated the release notes: link
I have updated or added an issue to the k6-documentation: grafana/k6-docs#NUMBER if applicable
I have updated or added an issue to the TypeScript definitions: grafana/k6-DefinitelyTyped#NUMBER if applicable

Related PR(s)/Issue(s)

Closes #4884

Signed-off-by: Pablo Chacin <pablochacin@gmail.com>

codebien

@pablochacin unit tests are missing here

codebien · 2025-07-29T10:37:42Z

cmd/state/state.go

+	// DefaultBuildServiceURL defines the URL to the default (grafana hosted) build service
+	DefaultBuildServiceURL = "https://ingest.k6.io/builder/api/v1"
+	// CloudExtensionsCatalog defines the extensions catalog for cloud supported extensions
+	CloudExtensionsCatalog = "cloud"
+	// CommunityExtensionsCatalog defines the extensions catalog for community extensions
+	CommunityExtensionsCatalog = "oss"


Is it required to have them exported?

They are referenced in internal/cmd/launcher.go

But they aren't used here, no?

Do we need to define and export them here? Just out of curiosity.

pablochacin · 2025-07-29T12:39:17Z

@codebien

@pablochacin unit tests are missing here

What kind of tests are you thinking? The main impact of this changes are internal to the provision function (selecting the catalog to use), and this change is only visible to the k6provider library. I'm open to suggestions.

codebien · 2025-07-29T12:48:36Z

What kind of tests are you thinking?

We should assert the URL generated if the community extensions are enabled. So the new logic added.

codebien · 2025-07-29T12:51:24Z

internal/cmd/launcher.go

+	buildSrv := p.gs.Flags.BuildServiceURL
+	buildSrvURL, err := url.Parse(buildSrv)
+	if err != nil {
+		return nil, fmt.Errorf("invalid URL to binary provisioning build service: %w", err)
+	}
+
+	catalog := state.CloudExtensionsCatalog
+	if p.gs.Flags.EnableCommunityExtensions {
+		catalog = state.CommunityExtensionsCatalog
+	}
+	buildSrv = buildSrvURL.JoinPath(catalog).String()


We might consider moving this logic into a dedicated function that accepts as input a flagset and it returns the URL or an error.

In this way, it's easier to test.

Signed-off-by: Pablo Chacin <pablochacin@gmail.com>

codebien

LGTM, just one missing improvement

codebien · 2025-07-29T16:04:12Z

internal/cmd/launcher_test.go

+			buildSrvURL:               state.DefaultBuildServiceURL,
+			enableCommunityExtensions: false,
+			expectErr:                 false,
+			expected:                  fmt.Sprintf("%s/%s", state.DefaultBuildServiceURL, state.CloudExtensionsCatalog),


Let's use a static string here. For example, if we wrote a bad value in state.CloudExtensionsCatalog then we wouldn't be able to catch it. Because the assertion is depending on the past value.

Suggested change

expected: fmt.Sprintf("%s/%s", state.DefaultBuildServiceURL, state.CloudExtensionsCatalog),

expected: "http://my-fake-exected-url/path-of-the-community,

Yeah, I'm generally in favor of the practice @codebien is suggesting here, so if anytime we change that value, it will be more explicit, and likely easier to catch potential breaking changes, etc 👍🏻

joanlopez · 2025-07-29T16:26:36Z

internal/cmd/launcher_test.go

+			if !tc.expectErr && err != nil {
+				t.Fatalf("unexpected error %v", err)
+			}
+
+			if tc.expectErr && err == nil {
+				t.Fatalf("expected error got none")
+			}
+
+			if !tc.expectErr && buildSrvURL != tc.expected {
+				t.Fatalf("expected buildSrvURL %q got %q", tc.expected, buildSrvURL)
+			}


Nit; I think we generally use assert or require from testify 🤔

Signed-off-by: Pablo Chacin <pablochacin@gmail.com>

internal/cmd/launcher_test.go

codebien · 2025-07-30T07:47:35Z

internal/cmd/launcher_test.go

+		buildSrvURL               string
+		enableCommunityExtensions bool
+		expectErr                 bool
+		expected                  string


Suggested change

expected string

expectURL string

To be consistent with the error field

internal/cmd/launcher_test.go

Signed-off-by: Pablo Chacin <pablochacin@gmail.com>

pablochacin force-pushed the binary-provisioning/support-community-extensions branch 3 times, most recently from 5456052 to 6eb7e09 Compare July 17, 2025 19:06

pablochacin force-pushed the binary-provisioning/support-community-extensions branch from 6eb7e09 to 18cb212 Compare July 22, 2025 13:14

pablochacin marked this pull request as ready for review July 22, 2025 16:17

pablochacin requested a review from a team as a code owner July 22, 2025 16:17

pablochacin requested review from ankur22 and AgnesToulet and removed request for a team July 22, 2025 16:17

ankur22 approved these changes Jul 23, 2025

View reviewed changes

codebien self-requested a review July 25, 2025 08:34

pablochacin added this to the v1.2.0 milestone Jul 25, 2025

pablochacin force-pushed the binary-provisioning/enable-to-all-users branch from 00af9c1 to 337ddaf Compare July 25, 2025 15:33

pablochacin added 2 commits July 25, 2025 17:39

add support comunity extensions flag

aca23f1

Signed-off-by: Pablo Chacin <pablochacin@gmail.com>

use community catalog if enabled

8afaff8

Signed-off-by: Pablo Chacin <pablochacin@gmail.com>

pablochacin force-pushed the binary-provisioning/support-community-extensions branch from 5a17ece to 8afaff8 Compare July 25, 2025 15:41

codebien reviewed Jul 29, 2025

View reviewed changes

add unit tests

5fe7e1f

Signed-off-by: Pablo Chacin <pablochacin@gmail.com>

codebien reviewed Jul 29, 2025

View reviewed changes

joanlopez reviewed Jul 29, 2025

View reviewed changes

pablochacin added 2 commits July 29, 2025 20:54

attend review comments

ff7f4aa

Signed-off-by: Pablo Chacin <pablochacin@gmail.com>

fix linter issues

1ecc6d9

Signed-off-by: Pablo Chacin <pablochacin@gmail.com>

pablochacin requested review from codebien, ankur22 and joanlopez July 29, 2025 19:26

codebien requested changes Jul 30, 2025

View reviewed changes

attend review comments

c5bbc60

Signed-off-by: Pablo Chacin <pablochacin@gmail.com>

codebien approved these changes Jul 30, 2025

View reviewed changes

pablochacin merged commit 76dd822 into binary-provisioning/enable-to-all-users Jul 30, 2025
37 of 39 checks passed

pablochacin deleted the binary-provisioning/support-community-extensions branch July 30, 2025 08:24

pablochacin mentioned this pull request Aug 1, 2025

fix logic for getting the build service URL #5003

Merged

8 tasks

BrewTestBot mentioned this pull request Aug 13, 2025

k6 1.2.1 Homebrew/homebrew-core#233339

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

support community extensions #4922

support community extensions #4922

Uh oh!

pablochacin commented Jul 11, 2025 •

edited

Loading

Uh oh!

codebien left a comment

Uh oh!

codebien Jul 29, 2025

Uh oh!

pablochacin Jul 29, 2025

Uh oh!

joanlopez Jul 29, 2025

Uh oh!

pablochacin commented Jul 29, 2025

Uh oh!

codebien commented Jul 29, 2025 •

edited

Loading

Uh oh!

codebien Jul 29, 2025

Uh oh!

codebien left a comment

Uh oh!

codebien Jul 29, 2025 •

edited

Loading

Uh oh!

joanlopez Jul 29, 2025

Uh oh!

joanlopez Jul 29, 2025

Uh oh!

Uh oh!

codebien Jul 30, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

	expected: fmt.Sprintf("%s/%s", state.DefaultBuildServiceURL, state.CloudExtensionsCatalog),
	expected: "http://my-fake-exected-url/path-of-the-community,

support community extensions #4922

support community extensions #4922

Uh oh!

Conversation

pablochacin commented Jul 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What?

Why?

Checklist

Checklist: Documentation (only for k6 maintainers and if relevant)

Related PR(s)/Issue(s)

Uh oh!

codebien left a comment

Choose a reason for hiding this comment

Uh oh!

codebien Jul 29, 2025

Choose a reason for hiding this comment

Uh oh!

pablochacin Jul 29, 2025

Choose a reason for hiding this comment

Uh oh!

joanlopez Jul 29, 2025

Choose a reason for hiding this comment

Uh oh!

pablochacin commented Jul 29, 2025

Uh oh!

codebien commented Jul 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codebien Jul 29, 2025

Choose a reason for hiding this comment

Uh oh!

codebien left a comment

Choose a reason for hiding this comment

Uh oh!

codebien Jul 29, 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!

joanlopez Jul 29, 2025

Choose a reason for hiding this comment

Uh oh!

joanlopez Jul 29, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

codebien Jul 30, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

pablochacin commented Jul 11, 2025 •

edited

Loading

codebien commented Jul 29, 2025 •

edited

Loading

codebien Jul 29, 2025 •

edited

Loading