|
| 1 | +package common |
| 2 | + |
| 3 | +import ( |
| 4 | + "errors" |
| 5 | + "fmt" |
| 6 | + "testing" |
| 7 | + |
| 8 | + "github.com/go-sql-driver/mysql" |
| 9 | + "github.com/stretchr/testify/require" |
| 10 | + |
| 11 | + dscommon "github.com/authzed/spicedb/internal/datastore/common" |
| 12 | +) |
| 13 | + |
| 14 | +func TestIsMissingTableError(t *testing.T) { |
| 15 | + t.Run("returns true for missing table error", func(t *testing.T) { |
| 16 | + mysqlErr := &mysql.MySQLError{ |
| 17 | + Number: mysqlMissingTableErrorNumber, |
| 18 | + Message: "Table 'spicedb.caveat' doesn't exist", |
| 19 | + } |
| 20 | + require.True(t, IsMissingTableError(mysqlErr)) |
| 21 | + }) |
| 22 | + |
| 23 | + t.Run("returns false for other mysql errors", func(t *testing.T) { |
| 24 | + mysqlErr := &mysql.MySQLError{ |
| 25 | + Number: 1062, // Duplicate entry error |
| 26 | + Message: "Duplicate entry '1' for key 'PRIMARY'", |
| 27 | + } |
| 28 | + require.False(t, IsMissingTableError(mysqlErr)) |
| 29 | + }) |
| 30 | + |
| 31 | + t.Run("returns false for non-mysql errors", func(t *testing.T) { |
| 32 | + err := fmt.Errorf("some other error") |
| 33 | + require.False(t, IsMissingTableError(err)) |
| 34 | + }) |
| 35 | + |
| 36 | + t.Run("returns false for nil error", func(t *testing.T) { |
| 37 | + require.False(t, IsMissingTableError(nil)) |
| 38 | + }) |
| 39 | + |
| 40 | + t.Run("returns true for wrapped missing table error", func(t *testing.T) { |
| 41 | + mysqlErr := &mysql.MySQLError{ |
| 42 | + Number: mysqlMissingTableErrorNumber, |
| 43 | + Message: "Table 'spicedb.caveat' doesn't exist", |
| 44 | + } |
| 45 | + wrappedErr := fmt.Errorf("query failed: %w", mysqlErr) |
| 46 | + require.True(t, IsMissingTableError(wrappedErr)) |
| 47 | + }) |
| 48 | +} |
| 49 | + |
| 50 | +func TestWrapMissingTableError(t *testing.T) { |
| 51 | + t.Run("wraps missing table error", func(t *testing.T) { |
| 52 | + mysqlErr := &mysql.MySQLError{ |
| 53 | + Number: mysqlMissingTableErrorNumber, |
| 54 | + Message: "Table 'spicedb.caveat' doesn't exist", |
| 55 | + } |
| 56 | + wrapped := WrapMissingTableError(mysqlErr) |
| 57 | + require.NotNil(t, wrapped) |
| 58 | + |
| 59 | + var schemaErr dscommon.SchemaNotInitializedError |
| 60 | + require.True(t, errors.As(wrapped, &schemaErr)) |
| 61 | + require.Contains(t, wrapped.Error(), "spicedb datastore migrate") |
| 62 | + }) |
| 63 | + |
| 64 | + t.Run("returns nil for non-missing-table errors", func(t *testing.T) { |
| 65 | + mysqlErr := &mysql.MySQLError{ |
| 66 | + Number: 1062, // Duplicate entry error |
| 67 | + Message: "Duplicate entry '1' for key 'PRIMARY'", |
| 68 | + } |
| 69 | + require.Nil(t, WrapMissingTableError(mysqlErr)) |
| 70 | + }) |
| 71 | + |
| 72 | + t.Run("returns nil for non-mysql errors", func(t *testing.T) { |
| 73 | + err := fmt.Errorf("some other error") |
| 74 | + require.Nil(t, WrapMissingTableError(err)) |
| 75 | + }) |
| 76 | + |
| 77 | + t.Run("returns nil for nil error", func(t *testing.T) { |
| 78 | + require.Nil(t, WrapMissingTableError(nil)) |
| 79 | + }) |
| 80 | + |
| 81 | + t.Run("preserves original error in chain", func(t *testing.T) { |
| 82 | + mysqlErr := &mysql.MySQLError{ |
| 83 | + Number: mysqlMissingTableErrorNumber, |
| 84 | + Message: "Table 'spicedb.caveat' doesn't exist", |
| 85 | + } |
| 86 | + wrapped := WrapMissingTableError(mysqlErr) |
| 87 | + require.NotNil(t, wrapped) |
| 88 | + |
| 89 | + // The original mysql error should be accessible via unwrapping |
| 90 | + var foundMySQLErr *mysql.MySQLError |
| 91 | + require.True(t, errors.As(wrapped, &foundMySQLErr)) |
| 92 | + require.Equal(t, uint16(mysqlMissingTableErrorNumber), foundMySQLErr.Number) |
| 93 | + }) |
| 94 | + |
| 95 | + t.Run("does not double-wrap already wrapped errors", func(t *testing.T) { |
| 96 | + mysqlErr := &mysql.MySQLError{ |
| 97 | + Number: mysqlMissingTableErrorNumber, |
| 98 | + Message: "Table 'spicedb.caveat' doesn't exist", |
| 99 | + } |
| 100 | + // First wrap |
| 101 | + wrapped := WrapMissingTableError(mysqlErr) |
| 102 | + require.NotNil(t, wrapped) |
| 103 | + |
| 104 | + // Second wrap should return the already-wrapped error (preserving it through call chain) |
| 105 | + doubleWrapped := WrapMissingTableError(wrapped) |
| 106 | + require.NotNil(t, doubleWrapped) |
| 107 | + require.Equal(t, wrapped, doubleWrapped) |
| 108 | + |
| 109 | + // Should still be detectable as SchemaNotInitializedError |
| 110 | + var schemaErr dscommon.SchemaNotInitializedError |
| 111 | + require.True(t, errors.As(doubleWrapped, &schemaErr)) |
| 112 | + }) |
| 113 | +} |
0 commit comments