Skip to content

Commit 49a1468

Browse files
ThomasRooneyThomasRooney
authored
chore: prefer panic on dial error (#24)
1 parent 389805a commit 49a1468

File tree

3 files changed

+24
-32
lines changed

3 files changed

+24
-32
lines changed

‎middleware_test.go‎

Lines changed: 13 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ func TestSpeakeasy_Middleware_Capture_Success(t *testing.T) {
137137
wg := &sync.WaitGroup{}
138138
wg.Add(1)
139139

140-
sdkInstance, err := speakeasy.New(speakeasy.Config{
140+
sdkInstance := speakeasy.New(speakeasy.Config{
141141
APIKey: testAPIKey,
142142
ApiID: testApiID,
143143
VersionID: testVersionID,
@@ -156,7 +156,6 @@ func TestSpeakeasy_Middleware_Capture_Success(t *testing.T) {
156156
wg.Done()
157157
}),
158158
})
159-
assert.Nil(t, err)
160159

161160
h := sdkInstance.Middleware(http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
162161
ctrl := speakeasy.MiddlewareController(req)
@@ -241,6 +240,7 @@ func TestSpeakeasy_Middleware_Capture_Success(t *testing.T) {
241240
w := httptest.NewRecorder()
242241

243242
var req *http.Request
243+
var err error
244244
if tt.Args.Body == "" {
245245
req, err = http.NewRequest(tt.Args.Method, tt.Args.URL, nil)
246246
} else {
@@ -342,7 +342,7 @@ func TestSpeakeasy_Middleware_URL_Resolve_Success(t *testing.T) {
342342
wg := &sync.WaitGroup{}
343343
wg.Add(1)
344344

345-
sdkInstance, err := speakeasy.New(speakeasy.Config{
345+
sdkInstance := speakeasy.New(speakeasy.Config{
346346
APIKey: testAPIKey,
347347
ApiID: testApiID,
348348
VersionID: testVersionID,
@@ -357,7 +357,6 @@ func TestSpeakeasy_Middleware_URL_Resolve_Success(t *testing.T) {
357357
wg.Done()
358358
}),
359359
})
360-
assert.Nil(t, err)
361360

362361
r := mux.NewRouter()
363362
r.Use(sdkInstance.Middleware)
@@ -441,7 +440,7 @@ func TestSpeakeasy_Middleware_GorillaMux_PathHint_Success(t *testing.T) {
441440
wg := &sync.WaitGroup{}
442441
wg.Add(1)
443442

444-
sdkInstance, err := speakeasy.New(speakeasy.Config{
443+
sdkInstance := speakeasy.New(speakeasy.Config{
445444
APIKey: testAPIKey,
446445
ApiID: testApiID,
447446
VersionID: testVersionID,
@@ -451,7 +450,6 @@ func TestSpeakeasy_Middleware_GorillaMux_PathHint_Success(t *testing.T) {
451450
wg.Done()
452451
}),
453452
})
454-
assert.Nil(t, err)
455453

456454
r := mux.NewRouter()
457455
r.Use(sdkInstance.Middleware)
@@ -521,7 +519,7 @@ func TestSpeakeasy_Middleware_Chi_PathHint_Success(t *testing.T) {
521519
wg := &sync.WaitGroup{}
522520
wg.Add(1)
523521

524-
sdkInstance, err := speakeasy.New(speakeasy.Config{
522+
sdkInstance := speakeasy.New(speakeasy.Config{
525523
APIKey: testAPIKey,
526524
ApiID: testApiID,
527525
VersionID: testVersionID,
@@ -531,7 +529,6 @@ func TestSpeakeasy_Middleware_Chi_PathHint_Success(t *testing.T) {
531529
wg.Done()
532530
}),
533531
})
534-
assert.Nil(t, err)
535532

536533
r := chi.NewRouter()
537534
r.Use(sdkInstance.Middleware)
@@ -587,7 +584,7 @@ func TestSpeakeasy_Middleware_ServerMux_PathHint_Success(t *testing.T) {
587584
wg := &sync.WaitGroup{}
588585
wg.Add(1)
589586

590-
sdkInstance, err := speakeasy.New(speakeasy.Config{
587+
sdkInstance := speakeasy.New(speakeasy.Config{
591588
APIKey: testAPIKey,
592589
ApiID: testApiID,
593590
VersionID: testVersionID,
@@ -597,7 +594,6 @@ func TestSpeakeasy_Middleware_ServerMux_PathHint_Success(t *testing.T) {
597594
wg.Done()
598595
}),
599596
})
600-
assert.Nil(t, err)
601597

602598
r := http.DefaultServeMux
603599

@@ -645,7 +641,7 @@ func TestSpeakeasy_GinMiddleware_Success(t *testing.T) {
645641
wg := &sync.WaitGroup{}
646642
wg.Add(1)
647643

648-
sdkInstance, err := speakeasy.New(speakeasy.Config{
644+
sdkInstance := speakeasy.New(speakeasy.Config{
649645
APIKey: testAPIKey,
650646
ApiID: testApiID,
651647
VersionID: testVersionID,
@@ -655,7 +651,6 @@ func TestSpeakeasy_GinMiddleware_Success(t *testing.T) {
655651
wg.Done()
656652
}),
657653
})
658-
assert.Nil(t, err)
659654

660655
r := gin.Default()
661656
r.Use(sdkInstance.GinMiddleware)
@@ -743,6 +738,7 @@ func TestSpeakeasy_GinMiddleware_Success(t *testing.T) {
743738
w := httptest.NewRecorder()
744739

745740
var req *http.Request
741+
var err error
746742
if tt.Args.Body == "" {
747743
req, err = http.NewRequest(tt.Args.Method, tt.Args.URL, nil)
748744
} else {
@@ -821,7 +817,7 @@ func TestSpeakeasy_GinMiddleware_PathHint_Success(t *testing.T) {
821817
wg := &sync.WaitGroup{}
822818
wg.Add(1)
823819

824-
sdkInstance, err := speakeasy.New(speakeasy.Config{
820+
sdkInstance := speakeasy.New(speakeasy.Config{
825821
APIKey: testAPIKey,
826822
ApiID: testApiID,
827823
VersionID: testVersionID,
@@ -831,7 +827,6 @@ func TestSpeakeasy_GinMiddleware_PathHint_Success(t *testing.T) {
831827
wg.Done()
832828
}),
833829
})
834-
assert.Nil(t, err)
835830

836831
r := gin.Default()
837832
r.Use(sdkInstance.GinMiddleware)
@@ -886,7 +881,7 @@ func TestSpeakeasy_EchoMiddleware_Success(t *testing.T) {
886881
wg := &sync.WaitGroup{}
887882
wg.Add(1)
888883

889-
sdkInstance, err := speakeasy.New(speakeasy.Config{
884+
sdkInstance := speakeasy.New(speakeasy.Config{
890885
APIKey: testAPIKey,
891886
ApiID: testApiID,
892887
VersionID: testVersionID,
@@ -896,7 +891,6 @@ func TestSpeakeasy_EchoMiddleware_Success(t *testing.T) {
896891
wg.Done()
897892
}),
898893
})
899-
assert.Nil(t, err)
900894

901895
r := echo.New()
902896
r.Use(sdkInstance.EchoMiddleware)
@@ -986,6 +980,7 @@ func TestSpeakeasy_EchoMiddleware_Success(t *testing.T) {
986980
w := httptest.NewRecorder()
987981

988982
var req *http.Request
983+
var err error
989984
if tt.Args.Body == "" {
990985
req, err = http.NewRequest(tt.Args.Method, tt.Args.URL, nil)
991986
} else {
@@ -1064,7 +1059,7 @@ func TestSpeakeasy_EchoMiddleware_PathHint_Success(t *testing.T) {
10641059
wg := &sync.WaitGroup{}
10651060
wg.Add(1)
10661061

1067-
sdkInstance, err := speakeasy.New(speakeasy.Config{
1062+
sdkInstance := speakeasy.New(speakeasy.Config{
10681063
APIKey: testAPIKey,
10691064
ApiID: testApiID,
10701065
VersionID: testVersionID,
@@ -1074,7 +1069,6 @@ func TestSpeakeasy_EchoMiddleware_PathHint_Success(t *testing.T) {
10741069
wg.Done()
10751070
}),
10761071
})
1077-
assert.Nil(t, err)
10781072

10791073
r := echo.New()
10801074
r.Use(sdkInstance.EchoMiddleware)
@@ -1137,7 +1131,7 @@ func TestSpeakeasy_Middleware_Capture_CustomerID_Success(t *testing.T) {
11371131
wg := &sync.WaitGroup{}
11381132
wg.Add(1)
11391133

1140-
sdkInstance, err := speakeasy.New(speakeasy.Config{
1134+
sdkInstance := speakeasy.New(speakeasy.Config{
11411135
APIKey: testAPIKey,
11421136
ApiID: testApiID,
11431137
VersionID: testVersionID,
@@ -1147,7 +1141,6 @@ func TestSpeakeasy_Middleware_Capture_CustomerID_Success(t *testing.T) {
11471141
wg.Done()
11481142
}),
11491143
})
1150-
assert.Nil(t, err)
11511144

11521145
w := httptest.NewRecorder()
11531146

‎speakeasy.go‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -63,20 +63,18 @@ type Speakeasy struct {
6363

6464
// Configure allows you to configure the default instance of the Speakeasy SDK.
6565
// Use this if you will use the same API Key for all connected APIs.
66-
func Configure(config Config) error {
67-
globalInstance, err := New(config)
66+
func Configure(config Config) {
67+
globalInstance := New(config)
6868
defaultInstance = globalInstance
69-
return err
7069
}
7170

7271
// New creates a new instance of the Speakeasy SDK.
7372
// This allows you to create multiple instances of the SDK
7473
// for specifying different API Keys for different APIs.
75-
func New(config Config) (*Speakeasy, error) {
74+
func New(config Config) *Speakeasy {
7675
s := &Speakeasy{}
77-
err := s.configure(config)
78-
79-
return s, err
76+
s.configure(config)
77+
return s
8078
}
8179

8280
func GetEmbedAccessToken(ctx context.Context, req *embedaccesstoken.EmbedAccessTokenRequest) (string, error) {
@@ -95,7 +93,7 @@ func (s *Speakeasy) Close() error {
9593
return s.grpcClient.conn.Close()
9694
}
9795

98-
func (s *Speakeasy) configure(cfg Config) error {
96+
func (s *Speakeasy) configure(cfg Config) {
9997
mustValidateConfig(cfg)
10098

10199
// The below environment variables allow the overriding of the location of the ingest server.
@@ -119,7 +117,9 @@ func (s *Speakeasy) configure(cfg Config) error {
119117

120118
grpcClient, err := newGRPCClient(context.Background(), s.config.APIKey, configuredServerURL, secure, s.config.GRPCDialer)
121119
s.grpcClient = grpcClient
122-
return err
120+
if err != nil {
121+
panic(err)
122+
}
123123
}
124124

125125
func mustValidateConfig(cfg Config) {

‎speakeasy_test.go‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -69,8 +69,7 @@ func TestConfigure_Success(t *testing.T) {
6969
os.Setenv("SPEAKEASY_SERVER_SECURE", strconv.FormatBool(*tt.fields.envSecure))
7070
}
7171

72-
sdkInstance, err := speakeasy.New(tt.args.config)
73-
assert.Nil(t, err)
72+
sdkInstance := speakeasy.New(tt.args.config)
7473
assert.NotNil(t, sdkInstance)
7574

7675
config := sdkInstance.ExportGetSpeakeasyConfig()
@@ -164,7 +163,7 @@ func TestConfigure_Error(t *testing.T) {
164163
for _, tt := range tests {
165164
t.Run(tt.name, func(t *testing.T) {
166165
assert.PanicsWithError(t, tt.wantErr, func() {
167-
_, _ = speakeasy.New(tt.args.config)
166+
_ = speakeasy.New(tt.args.config)
168167
})
169168
})
170169
}

0 commit comments

Comments
 (0)