Skip to content

Commit

Permalink
test: ratelimit debug
Browse files Browse the repository at this point in the history
  • Loading branch information
chronark committed Oct 10, 2024
1 parent c948512 commit 610c670
Show file tree
Hide file tree
Showing 2 changed files with 149 additions and 9 deletions.
146 changes: 146 additions & 0 deletions apps/agent/integration/identities/ratelimits_with_cost_load_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,146 @@
package identities_test

import (
"context"
"fmt"
"math/rand"
"os"
"testing"
"time"

"github.com/google/uuid"
"github.com/stretchr/testify/require"
unkey "github.com/unkeyed/unkey-go"
"github.com/unkeyed/unkey-go/models/components"
"github.com/unkeyed/unkey-go/models/operations"
attack "github.com/unkeyed/unkey/apps/agent/pkg/testutil"
"github.com/unkeyed/unkey/apps/agent/pkg/uid"
"github.com/unkeyed/unkey/apps/agent/pkg/util"
)

func TestIdentityRatelimitsWithCost0Accuracy(t *testing.T) {
// Step 1 --------------------------------------------------------------------
// Setup the sdk, create an API
// ---------------------------------------------------------------------------

ctx := context.Background()
rootKey := os.Getenv("INTEGRATION_TEST_ROOT_KEY")
require.NotEmpty(t, rootKey, "INTEGRATION_TEST_ROOT_KEY must be set")
baseURL := os.Getenv("UNKEY_BASE_URL")
require.NotEmpty(t, baseURL, "UNKEY_BASE_URL must be set")

options := []unkey.SDKOption{
unkey.WithSecurity(rootKey),
}

if baseURL != "" {
options = append(options, unkey.WithServerURL(baseURL))
}
sdk := unkey.New(options...)

for _, tc := range []struct {
rate attack.Rate
testDuration time.Duration
}{
{
rate: attack.Rate{Freq: 100, Per: time.Second},
testDuration: 1 * time.Minute,
},
{
rate: attack.Rate{Freq: 100, Per: time.Second},
testDuration: 5 * time.Minute,
},
{
rate: attack.Rate{Freq: 100, Per: time.Second},
testDuration: 30 * time.Minute,
},
} {
t.Run(fmt.Sprintf("[%s] over %s", tc.rate.String(), tc.testDuration), func(t *testing.T) {
api, err := sdk.Apis.CreateAPI(ctx, operations.CreateAPIRequestBody{
Name: uid.New("testapi"),
})
require.NoError(t, err)

// Step 2 --------------------------------------------------------------------
// Create the identity with ratelimits
// ---------------------------------------------------------------------------

ratelimit := operations.Ratelimits{
Name: "ratelimit-a",
Limit: 600,
Duration: time.Minute.Milliseconds(),
}

externalID := uuid.NewString()
_, err = sdk.Identities.CreateIdentity(ctx, operations.CreateIdentityRequestBody{
ExternalID: externalID,
Ratelimits: []operations.Ratelimits{
ratelimit,
},
})
require.NoError(t, err)

// Step 3 --------------------------------------------------------------------
// Create key for this identity
// ---------------------------------------------------------------------------

key, err := sdk.Keys.CreateKey(ctx, operations.CreateKeyRequestBody{
APIID: api.Object.APIID,
ExternalID: util.Pointer(externalID),
})
require.NoError(t, err)

// Step 5 --------------------------------------------------------------------
// Test ratelimits
// ---------------------------------------------------------------------------

total := 0
passed := 0
withCost := 0
errors := 0

results := attack.Attack(t, tc.rate, tc.testDuration, func() bool {

cost := int64(0)
if rand.Intn(100) == 0 {
withCost++
cost = 1
}

res, err := sdk.Keys.VerifyKey(context.Background(), components.V1KeysVerifyKeyRequest{
APIID: unkey.String(api.Object.APIID),
Key: key.Object.Key,
Ratelimits: []components.Ratelimits{
{Name: ratelimit.Name,
Cost: util.Pointer(cost),
},
},
})
if err != nil {
errors++
return false
}

return res.V1KeysVerifyKeyResponse.Valid

})

for valid := range results {
total++
if valid {
passed++
}

}

// Step 6 --------------------------------------------------------------------
// Assert ratelimits worked
// ---------------------------------------------------------------------------

t.Logf("Total: %d, Passed: %d, withCost=1: %d", total, passed, withCost)

// check requests::api is not exceeded
})

}
}
12 changes: 3 additions & 9 deletions internal/db/src/schema/identity.ts
Original file line number Diff line number Diff line change
Expand Up @@ -50,22 +50,16 @@ export const ratelimits = mysqlTable(
*/
name: varchar("name", { length: 256 }).notNull(),

workspaceId: varchar("workspace_id", { length: 256 })
.notNull()
.references(() => workspaces.id, { onDelete: "cascade" }),
workspaceId: varchar("workspace_id", { length: 256 }).notNull(),
...lifecycleDates,
/**
* Either keyId or identityId may be defined, not both
*/
keyId: varchar("key_id", { length: 256 }).references(() => keys.id, {
onDelete: "cascade",
}),
keyId: varchar("key_id", { length: 256 }),
/**
* Either keyId or identityId may be defined, not both
*/
identityId: varchar("identity_id", { length: 256 }).references(() => identities.id, {
onDelete: "cascade",
}),
identityId: varchar("identity_id", { length: 256 }),
limit: int("limit").notNull(),
// milliseconds
duration: bigint("duration", { mode: "number" }).notNull(),
Expand Down

0 comments on commit 610c670

Please sign in to comment.