|
| 1 | +package integration |
| 2 | + |
| 3 | +import ( |
| 4 | + "archive/tar" |
| 5 | + "bytes" |
| 6 | + "context" |
| 7 | + "errors" |
| 8 | + "net/http" |
| 9 | + "os" |
| 10 | + "strconv" |
| 11 | + "testing" |
| 12 | + "time" |
| 13 | + |
| 14 | + "github.com/coder/coder/v2/codersdk" |
| 15 | + "github.com/stretchr/testify/require" |
| 16 | +) |
| 17 | + |
| 18 | +// createMinimalTar creates a small valid tar archive for uploading. |
| 19 | +func createMinimalTar(t *testing.T) *bytes.Buffer { |
| 20 | + t.Helper() |
| 21 | + var buf bytes.Buffer |
| 22 | + tw := tar.NewWriter(&buf) |
| 23 | + content := []byte("# test file") |
| 24 | + err := tw.WriteHeader(&tar.Header{ |
| 25 | + Name: "main.tf", |
| 26 | + Mode: 0o644, |
| 27 | + Size: int64(len(content)), |
| 28 | + }) |
| 29 | + require.NoError(t, err) |
| 30 | + _, err = tw.Write(content) |
| 31 | + require.NoError(t, err) |
| 32 | + require.NoError(t, tw.Close()) |
| 33 | + return &buf |
| 34 | +} |
| 35 | + |
| 36 | +// TestHeadersBypassRateLimit verifies that the X-Coder-Bypass-Ratelimit header |
| 37 | +// allows an Owner to exceed the files endpoint rate limit (12 req/min). |
| 38 | +// |
| 39 | +// This test starts a Coder instance with rate limits ENABLED, then: |
| 40 | +// 1. Confirms that rapid file GETs without the bypass header hit a 429. |
| 41 | +// 2. Confirms that the same burst with the bypass header succeeds. |
| 42 | +func TestHeadersBypassRateLimit(t *testing.T) { |
| 43 | + t.Parallel() |
| 44 | + if os.Getenv("TF_ACC") == "1" { |
| 45 | + t.Skip("Skipping integration tests during tf acceptance tests") |
| 46 | + } |
| 47 | + if testing.Short() { |
| 48 | + t.Skip("Skipping integration test in short mode") |
| 49 | + } |
| 50 | + |
| 51 | + timeoutStr := os.Getenv("TIMEOUT_MINS") |
| 52 | + if timeoutStr == "" { |
| 53 | + timeoutStr = "10" |
| 54 | + } |
| 55 | + timeoutMins, err := strconv.Atoi(timeoutStr) |
| 56 | + require.NoError(t, err, "invalid value specified for timeout") |
| 57 | + ctx, cancel := context.WithTimeout(t.Context(), time.Duration(timeoutMins)*time.Minute) |
| 58 | + t.Cleanup(cancel) |
| 59 | + |
| 60 | + // Start Coder WITH rate limits enabled (no CODER_DANGEROUS_DISABLE_RATE_LIMITS). |
| 61 | + client := StartCoder(ctx, t, "headers-ratelimit", EnableRateLimits) |
| 62 | + |
| 63 | + // Upload a small file so we have something to GET. |
| 64 | + uploadResp, err := client.Upload(ctx, "application/x-tar", createMinimalTar(t)) |
| 65 | + require.NoError(t, err, "upload file") |
| 66 | + fileID := uploadResp.ID |
| 67 | + |
| 68 | + // The files endpoint rate limit is 12 requests per minute. |
| 69 | + // Fire 15 rapid GETs without the bypass header -- we expect at least one 429. |
| 70 | + const burstCount = 15 |
| 71 | + |
| 72 | + t.Run("WithoutBypass", func(t *testing.T) { |
| 73 | + t.Parallel() |
| 74 | + subCtx, subCancel := context.WithTimeout(context.Background(), 2*time.Minute) |
| 75 | + defer subCancel() |
| 76 | + |
| 77 | + got429 := false |
| 78 | + for range burstCount { |
| 79 | + _, _, err := client.Download(subCtx, fileID) |
| 80 | + if err != nil { |
| 81 | + var sdkErr *codersdk.Error |
| 82 | + if errors.As(err, &sdkErr) && sdkErr.StatusCode() == http.StatusTooManyRequests { |
| 83 | + got429 = true |
| 84 | + break |
| 85 | + } |
| 86 | + } |
| 87 | + } |
| 88 | + require.True(t, got429, "expected to hit 429 rate limit within %d requests", burstCount) |
| 89 | + }) |
| 90 | + |
| 91 | + t.Run("WithBypass", func(t *testing.T) { |
| 92 | + t.Parallel() |
| 93 | + subCtx, subCancel := context.WithTimeout(context.Background(), 2*time.Minute) |
| 94 | + defer subCancel() |
| 95 | + |
| 96 | + // Create a new client with the bypass header set. |
| 97 | + bypassClient := codersdk.New(client.URL) |
| 98 | + bypassClient.SetSessionToken(client.SessionToken()) |
| 99 | + bypassClient.HTTPClient.Transport = &codersdk.HeaderTransport{ |
| 100 | + Transport: http.DefaultTransport, |
| 101 | + Header: http.Header{ |
| 102 | + "X-Coder-Bypass-Ratelimit": []string{"true"}, |
| 103 | + }, |
| 104 | + } |
| 105 | + |
| 106 | + // Same burst, but with bypass -- all should succeed. |
| 107 | + for i := range burstCount { |
| 108 | + _, _, err := bypassClient.Download(subCtx, fileID) |
| 109 | + require.NoError(t, err, "request %d should not be rate limited with bypass header", i+1) |
| 110 | + } |
| 111 | + }) |
| 112 | +} |
![blink-so[bot]](https://avatars.githubusercontent.com/in/1271127?v=4&size=40){kind=avatar}
0 commit comments