2023-01-18 19:12:53 +00:00
|
|
|
package coderd_test
|
|
|
|
|
|
|
|
|
|
import (
|
|
|
|
|
"context"
|
2026-09-29 14:23:00 +02:00
|
|
|
"fmt"
|
|
|
|
|
"net/http"
|
2023-01-18 19:12:53 +00:00
|
|
|
"testing"
|
|
|
|
|
|
2026-11-11 23:54:05 +01:00
|
|
|
"github.com/google/uuid"
|
2023-01-18 19:12:53 +00:00
|
|
|
"github.com/stretchr/testify/require"
|
|
|
|
|
|
2023-08-18 13:55:43 -05:00
|
|
|
"github.com/coder/coder/v2/coderd/coderdtest"
|
2026-09-29 14:23:00 +02:00
|
|
|
"github.com/coder/coder/v2/coderd/database/dbauthz"
|
|
|
|
|
experimentrules "github.com/coder/coder/v2/coderd/experiments"
|
2023-08-18 13:55:43 -05:00
|
|
|
"github.com/coder/coder/v2/coderd/httpmw"
|
|
|
|
|
"github.com/coder/coder/v2/codersdk"
|
|
|
|
|
"github.com/coder/coder/v2/testutil"
|
2023-01-18 19:12:53 +00:00
|
|
|
)
|
|
|
|
|
|
|
|
|
|
func Test_Experiments(t *testing.T) {
|
|
|
|
|
t.Parallel()
|
|
|
|
|
t.Run("empty", func(t *testing.T) {
|
|
|
|
|
t.Parallel()
|
2023-03-07 15:10:01 -06:00
|
|
|
cfg := coderdtest.DeploymentValues(t)
|
2023-01-18 19:12:53 +00:00
|
|
|
client := coderdtest.New(t, &coderdtest.Options{
|
2023-03-07 15:10:01 -06:00
|
|
|
DeploymentValues: cfg,
|
2023-01-18 19:12:53 +00:00
|
|
|
})
|
|
|
|
|
_ = coderdtest.CreateFirstUser(t, client)
|
|
|
|
|
|
|
|
|
|
ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
|
|
|
|
|
defer cancel()
|
|
|
|
|
|
|
|
|
|
experiments, err := client.Experiments(ctx)
|
|
|
|
|
require.NoError(t, err)
|
|
|
|
|
require.NotNil(t, experiments)
|
|
|
|
|
require.Empty(t, experiments)
|
|
|
|
|
require.False(t, experiments.Enabled("foo"))
|
|
|
|
|
})
|
|
|
|
|
|
|
|
|
|
t.Run("multiple features", func(t *testing.T) {
|
|
|
|
|
t.Parallel()
|
2023-03-07 15:10:01 -06:00
|
|
|
cfg := coderdtest.DeploymentValues(t)
|
|
|
|
|
cfg.Experiments = []string{"foo", "BAR"}
|
2023-01-18 19:12:53 +00:00
|
|
|
client := coderdtest.New(t, &coderdtest.Options{
|
2023-03-07 15:10:01 -06:00
|
|
|
DeploymentValues: cfg,
|
2023-01-18 19:12:53 +00:00
|
|
|
})
|
|
|
|
|
_ = coderdtest.CreateFirstUser(t, client)
|
|
|
|
|
|
|
|
|
|
ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
|
|
|
|
|
defer cancel()
|
|
|
|
|
|
|
|
|
|
experiments, err := client.Experiments(ctx)
|
|
|
|
|
require.NoError(t, err)
|
|
|
|
|
require.NotNil(t, experiments)
|
|
|
|
|
// Should be lower-cased.
|
|
|
|
|
require.ElementsMatch(t, []codersdk.Experiment{"foo", "bar"}, experiments)
|
|
|
|
|
require.True(t, experiments.Enabled("foo"))
|
|
|
|
|
require.True(t, experiments.Enabled("bar"))
|
|
|
|
|
require.False(t, experiments.Enabled("baz"))
|
|
|
|
|
})
|
|
|
|
|
|
|
|
|
|
t.Run("wildcard", func(t *testing.T) {
|
|
|
|
|
t.Parallel()
|
2023-03-07 15:10:01 -06:00
|
|
|
cfg := coderdtest.DeploymentValues(t)
|
|
|
|
|
cfg.Experiments = []string{"*"}
|
2023-01-18 19:12:53 +00:00
|
|
|
client := coderdtest.New(t, &coderdtest.Options{
|
2023-03-07 15:10:01 -06:00
|
|
|
DeploymentValues: cfg,
|
2023-01-18 19:12:53 +00:00
|
|
|
})
|
|
|
|
|
_ = coderdtest.CreateFirstUser(t, client)
|
|
|
|
|
|
|
|
|
|
ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
|
|
|
|
|
defer cancel()
|
|
|
|
|
|
|
|
|
|
experiments, err := client.Experiments(ctx)
|
|
|
|
|
require.NoError(t, err)
|
|
|
|
|
require.NotNil(t, experiments)
|
2025-04-22 11:21:15 -05:00
|
|
|
require.ElementsMatch(t, codersdk.ExperimentsSafe, experiments)
|
|
|
|
|
for _, ex := range codersdk.ExperimentsSafe {
|
2023-01-18 19:12:53 +00:00
|
|
|
require.True(t, experiments.Enabled(ex))
|
|
|
|
|
}
|
|
|
|
|
require.False(t, experiments.Enabled("danger"))
|
|
|
|
|
})
|
|
|
|
|
|
|
|
|
|
t.Run("alternate wildcard with manual opt-in", func(t *testing.T) {
|
|
|
|
|
t.Parallel()
|
2023-03-07 15:10:01 -06:00
|
|
|
cfg := coderdtest.DeploymentValues(t)
|
|
|
|
|
cfg.Experiments = []string{"*", "dAnGeR"}
|
2023-01-18 19:12:53 +00:00
|
|
|
client := coderdtest.New(t, &coderdtest.Options{
|
2023-03-07 15:10:01 -06:00
|
|
|
DeploymentValues: cfg,
|
2023-01-18 19:12:53 +00:00
|
|
|
})
|
|
|
|
|
_ = coderdtest.CreateFirstUser(t, client)
|
|
|
|
|
|
|
|
|
|
ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
|
|
|
|
|
defer cancel()
|
|
|
|
|
|
|
|
|
|
experiments, err := client.Experiments(ctx)
|
|
|
|
|
require.NoError(t, err)
|
|
|
|
|
require.NotNil(t, experiments)
|
2025-04-22 11:21:15 -05:00
|
|
|
require.ElementsMatch(t, append(codersdk.ExperimentsSafe, "danger"), experiments)
|
|
|
|
|
for _, ex := range codersdk.ExperimentsSafe {
|
2023-01-18 19:12:53 +00:00
|
|
|
require.True(t, experiments.Enabled(ex))
|
|
|
|
|
}
|
|
|
|
|
require.True(t, experiments.Enabled("danger"))
|
|
|
|
|
require.False(t, experiments.Enabled("herebedragons"))
|
|
|
|
|
})
|
|
|
|
|
|
|
|
|
|
t.Run("Unauthorized", func(t *testing.T) {
|
|
|
|
|
t.Parallel()
|
2023-03-07 15:10:01 -06:00
|
|
|
cfg := coderdtest.DeploymentValues(t)
|
|
|
|
|
cfg.Experiments = []string{"*"}
|
2023-01-18 19:12:53 +00:00
|
|
|
client := coderdtest.New(t, &coderdtest.Options{
|
2023-03-07 15:10:01 -06:00
|
|
|
DeploymentValues: cfg,
|
2023-01-18 19:12:53 +00:00
|
|
|
})
|
|
|
|
|
// Explicitly omit creating a user so we're unauthorized.
|
|
|
|
|
// _ = coderdtest.CreateFirstUser(t, client)
|
|
|
|
|
|
|
|
|
|
ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
|
|
|
|
|
defer cancel()
|
|
|
|
|
|
|
|
|
|
_, err := client.Experiments(ctx)
|
|
|
|
|
require.Error(t, err)
|
|
|
|
|
require.ErrorContains(t, err, httpmw.SignedOutErrorMessage)
|
|
|
|
|
})
|
2023-10-17 14:49:19 -04:00
|
|
|
|
2026-09-29 14:23:00 +02:00
|
|
|
t.Run("rules per user", func(t *testing.T) {
|
|
|
|
|
t.Parallel()
|
|
|
|
|
cfg := coderdtest.DeploymentValues(t)
|
2026-10-29 20:32:56 +01:00
|
|
|
cfg.Experiments = []string{"foo", string(codersdk.ExperimentExample)}
|
2026-09-29 14:23:00 +02:00
|
|
|
ownerClient, db := coderdtest.NewWithDatabase(t, &coderdtest.Options{
|
|
|
|
|
DeploymentValues: cfg,
|
|
|
|
|
})
|
|
|
|
|
owner := coderdtest.CreateFirstUser(t, ownerClient)
|
|
|
|
|
memberClient, member := coderdtest.CreateAnotherUser(t, ownerClient, owner.OrganizationID)
|
|
|
|
|
|
|
|
|
|
ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
|
|
|
|
|
defer cancel()
|
|
|
|
|
|
|
|
|
|
revisions := map[codersdk.Experiment]int64{}
|
|
|
|
|
writeRule := func(ex codersdk.Experiment, rule experimentrules.Rule) {
|
|
|
|
|
t.Helper()
|
|
|
|
|
_, stored, _, err := experimentrules.WriteRule(dbauthz.AsSystemRestricted(ctx), db, owner.UserID, ex, rule, revisions[ex])
|
|
|
|
|
require.NoError(t, err)
|
|
|
|
|
revisions[ex] = stored.Revision
|
|
|
|
|
}
|
|
|
|
|
requireExperiments := func(client *codersdk.Client, want ...codersdk.Experiment) {
|
|
|
|
|
t.Helper()
|
|
|
|
|
got, err := client.Experiments(ctx)
|
|
|
|
|
require.NoError(t, err)
|
|
|
|
|
require.ElementsMatch(t, want, got)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// A condition enables a user-scoped experiment only for matching
|
|
|
|
|
// users; a kill switch disables a statically enabled one.
|
|
|
|
|
writeRule(codersdk.ExperimentExample, experimentrules.Rule{
|
|
|
|
|
Mode: experimentrules.ModeCondition,
|
|
|
|
|
Condition: fmt.Sprintf("user.username == %q", member.Username),
|
|
|
|
|
})
|
|
|
|
|
requireExperiments(memberClient, "foo", codersdk.ExperimentExample)
|
|
|
|
|
requireExperiments(ownerClient, "foo")
|
2026-10-29 20:32:56 +01:00
|
|
|
writeRule(codersdk.ExperimentExample, experimentrules.Rule{Mode: experimentrules.ModeOff})
|
|
|
|
|
requireExperiments(memberClient, "foo")
|
2026-09-29 14:23:00 +02:00
|
|
|
|
|
|
|
|
// Inherit restores the startup default.
|
2026-10-29 20:32:56 +01:00
|
|
|
writeRule(codersdk.ExperimentExample, experimentrules.Rule{Mode: experimentrules.ModeInherit})
|
|
|
|
|
requireExperiments(memberClient, "foo", codersdk.ExperimentExample)
|
|
|
|
|
requireExperiments(ownerClient, "foo", codersdk.ExperimentExample)
|
2026-09-29 14:23:00 +02:00
|
|
|
|
|
|
|
|
// The personalized result must not be cached.
|
|
|
|
|
res, err := memberClient.Request(ctx, http.MethodGet, "/api/v2/experiments", nil)
|
|
|
|
|
require.NoError(t, err)
|
|
|
|
|
defer res.Body.Close()
|
|
|
|
|
require.Equal(t, http.StatusOK, res.StatusCode)
|
|
|
|
|
require.Equal(t, "no-store", res.Header.Get("Cache-Control"))
|
|
|
|
|
})
|
|
|
|
|
|
2026-11-11 23:54:05 +01:00
|
|
|
// Later automation code asks api.ExperimentEvaluator about one user ID at
|
|
|
|
|
// a time: the caller, a chat's owner, or an automation's owner.
|
|
|
|
|
t.Run("chat automations per user", func(t *testing.T) {
|
|
|
|
|
t.Parallel()
|
|
|
|
|
cfg := coderdtest.DeploymentValues(t)
|
|
|
|
|
cfg.Experiments = []string{string(codersdk.ExperimentChatAutomations)}
|
|
|
|
|
ownerClient, _, api := coderdtest.NewWithAPI(t, &coderdtest.Options{
|
|
|
|
|
DeploymentValues: cfg,
|
|
|
|
|
})
|
|
|
|
|
owner := coderdtest.CreateFirstUser(t, ownerClient)
|
|
|
|
|
memberClient, member := coderdtest.CreateAnotherUser(t, ownerClient, owner.OrganizationID)
|
|
|
|
|
|
|
|
|
|
ctx := testutil.Context(t, testutil.WaitLong)
|
|
|
|
|
|
|
|
|
|
var revision int64
|
|
|
|
|
writeRule := func(rule experimentrules.Rule) {
|
|
|
|
|
t.Helper()
|
|
|
|
|
_, stored, _, err := experimentrules.WriteRule(dbauthz.AsSystemRestricted(ctx), api.Database, owner.UserID, codersdk.ExperimentChatAutomations, rule, revision)
|
|
|
|
|
require.NoError(t, err)
|
|
|
|
|
revision = stored.Revision
|
|
|
|
|
}
|
|
|
|
|
requireEnabled := func(wantOwner, wantMember bool) {
|
|
|
|
|
t.Helper()
|
|
|
|
|
for _, tc := range []struct {
|
|
|
|
|
name string
|
|
|
|
|
client *codersdk.Client
|
|
|
|
|
userID uuid.UUID
|
|
|
|
|
want bool
|
|
|
|
|
}{
|
|
|
|
|
{"owner", ownerClient, owner.UserID, wantOwner},
|
|
|
|
|
{"member", memberClient, member.ID, wantMember},
|
|
|
|
|
} {
|
|
|
|
|
require.Equal(t, tc.want, api.ExperimentEvaluator.Enabled(ctx, tc.userID, codersdk.ExperimentChatAutomations), tc.name)
|
|
|
|
|
listed, err := tc.client.Experiments(ctx)
|
|
|
|
|
require.NoError(t, err)
|
|
|
|
|
require.Equal(t, tc.want, listed.Enabled(codersdk.ExperimentChatAutomations), tc.name)
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
requireEnabled(true, true)
|
|
|
|
|
require.False(t, api.ExperimentEvaluator.Enabled(ctx, uuid.Nil, codersdk.ExperimentChatAutomations), "nil subject")
|
|
|
|
|
|
|
|
|
|
writeRule(experimentrules.Rule{
|
|
|
|
|
Mode: experimentrules.ModeCondition,
|
|
|
|
|
Condition: fmt.Sprintf("user.username == %q", member.Username),
|
|
|
|
|
})
|
|
|
|
|
requireEnabled(false, true)
|
|
|
|
|
|
|
|
|
|
writeRule(experimentrules.Rule{Mode: experimentrules.ModeOff})
|
|
|
|
|
requireEnabled(false, false)
|
|
|
|
|
|
|
|
|
|
writeRule(experimentrules.Rule{Mode: experimentrules.ModeInherit})
|
|
|
|
|
requireEnabled(true, true)
|
|
|
|
|
})
|
|
|
|
|
|
2023-10-17 14:49:19 -04:00
|
|
|
t.Run("available experiments", func(t *testing.T) {
|
|
|
|
|
t.Parallel()
|
|
|
|
|
cfg := coderdtest.DeploymentValues(t)
|
|
|
|
|
client := coderdtest.New(t, &coderdtest.Options{
|
|
|
|
|
DeploymentValues: cfg,
|
|
|
|
|
})
|
|
|
|
|
_ = coderdtest.CreateFirstUser(t, client)
|
|
|
|
|
|
|
|
|
|
ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
|
|
|
|
|
defer cancel()
|
|
|
|
|
|
|
|
|
|
experiments, err := client.SafeExperiments(ctx)
|
|
|
|
|
require.NoError(t, err)
|
|
|
|
|
require.NotNil(t, experiments)
|
2025-04-22 11:21:15 -05:00
|
|
|
require.ElementsMatch(t, codersdk.ExperimentsSafe, experiments.Safe)
|
2023-10-17 14:49:19 -04:00
|
|
|
})
|
2023-01-18 19:12:53 +00:00
|
|
|
}
|