Skip to content

Fix context loss in polling and connection close operations #295

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dgiagio wants to merge 1 commit into
base: main
Choose a base branch
from
+136 −57
Open

Fix context loss in polling and connection close operations #295

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 5 additions & 7 deletions connection.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ import (
dbsqlerr "github.com/databricks/databricks-sql-go/errors"
"github.com/databricks/databricks-sql-go/internal/cli_service"
"github.com/databricks/databricks-sql-go/internal/client"
context2 "github.com/databricks/databricks-sql-go/internal/compat/context"
"github.com/databricks/databricks-sql-go/internal/config"
dbsqlerrint "github.com/databricks/databricks-sql-go/internal/errors"
"github.com/databricks/databricks-sql-go/internal/rows"
Expand Down Expand Up @@ -55,7 +56,7 @@ func (c *conn) Close() error {

if err != nil {
log.Err(err).Msg("databricks: failed to close connection")
return dbsqlerrint.NewRequestError(ctx, dbsqlerr.ErrCloseConnection, err)
return dbsqlerrint.NewBadConnectionError(err)
}
return nil
}
Expand Down Expand Up @@ -168,9 +169,7 @@ func (c *conn) QueryContext(ctx context.Context, query string, args []driver.Nam
return nil, dbsqlerrint.NewExecutionError(ctx, dbsqlerr.ErrQueryExecution, err, opStatusResp)
}

corrId := driverctx.CorrelationIdFromContext(ctx)
rows, err := rows.NewRows(c.id, corrId, exStmtResp.OperationHandle, c.client, c.cfg, exStmtResp.DirectResults)

rows, err := rows.NewRows(ctx, exStmtResp.OperationHandle, c.client, c.cfg, exStmtResp.DirectResults)
return rows, err

}
Expand Down Expand Up @@ -367,7 +366,7 @@ func (c *conn) pollOperation(ctx context.Context, opHandle *cli_service.TOperati
log := logger.WithContext(c.id, corrId, client.SprintGuid(opHandle.OperationId.GUID))
var statusResp *cli_service.TGetOperationStatusResp
ctx = driverctx.NewContextWithConnId(ctx, c.id)
newCtx := driverctx.NewContextWithCorrelationId(driverctx.NewContextWithConnId(context.Background(), c.id), corrId)
newCtx := context2.WithoutCancel(ctx)
pollSentinel := sentinel.Sentinel{
OnDoneFn: func(statusResp any) (any, error) {
return statusResp, nil
Expand Down Expand Up @@ -566,7 +565,6 @@ func (c *conn) execStagingOperation(
return nil
}

corrId := driverctx.CorrelationIdFromContext(ctx)
var row driver.Rows
var err error

Expand All @@ -589,7 +587,7 @@ func (c *conn) execStagingOperation(
}

if len(driverctx.StagingPathsFromContext(ctx)) != 0 {
row, err = rows.NewRows(c.id, corrId, exStmtResp.OperationHandle, c.client, c.cfg, exStmtResp.DirectResults)
row, err = rows.NewRows(ctx, exStmtResp.OperationHandle, c.client, c.cfg, exStmtResp.DirectResults)
if err != nil {
return dbsqlerrint.NewDriverError(ctx, "error reading row.", err)
}
Expand Down
39 changes: 39 additions & 0 deletions internal/compat/context/context.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
package context

import (
"context"
"time"
)

// This implementation has been copied from https://github.com/golang/go/blob/master/src/context/context.go#L581
// and adapted to work with this package.

// WithoutCancel returns a derived context that points to the parent context
// and is not canceled when parent is canceled.
// The returned context returns no Deadline or Err, and its Done channel is nil.
Copy link
Collaborator

@gopalldb gopalldb Jan 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: We can also add usage examples from Go driver perspective, when to use this.

// WithoutCancel is used in polling operations where we need to preserve
// context values (like authentication tokens) but don't want the operation
// to be cancelled when the parent context is cancelled.

func WithoutCancel(parent context.Context) context.Context {
if parent == nil {
panic("cannot create context from nil parent")
}
return withoutCancelCtx{parent}
}

type withoutCancelCtx struct {
c context.Context
}

func (withoutCancelCtx) Deadline() (deadline time.Time, ok bool) {
return
}

func (withoutCancelCtx) Done() <-chan struct{} {
return nil
}

func (withoutCancelCtx) Err() error {
return nil
}

func (c withoutCancelCtx) Value(key any) any {
return c.c.Value(key)
}
31 changes: 21 additions & 10 deletions internal/rows/arrowbased/arrowRecordIterator_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import (
"os"
"testing"

"github.com/databricks/databricks-sql-go/driverctx"
"github.com/databricks/databricks-sql-go/internal/cli_service"
"github.com/databricks/databricks-sql-go/internal/client"
"github.com/databricks/databricks-sql-go/internal/config"
Expand All @@ -32,15 +33,17 @@ func TestArrowRecordIterator(t *testing.T) {

var fetchesInfo []fetchResultsInfo

ctx := driverctx.NewContextWithConnId(context.Background(), "connectionId")
ctx = driverctx.NewContextWithCorrelationId(ctx, "correlationId")

simpleClient := getSimpleClient(&fetchesInfo, []cli_service.TFetchResultsResp{fetchResp1, fetchResp2})
rpi := rowscanner.NewResultPageIterator(
ctx,
rowscanner.NewDelimiter(0, 7311),
5000,
nil,
false,
simpleClient,
"connectionId",
"correlationId",
logger,
)

Expand Down Expand Up @@ -126,17 +129,19 @@ func TestArrowRecordIterator(t *testing.T) {
fetchResp3 := cli_service.TFetchResultsResp{}
loadTestData2(t, "multipleFetch/FetchResults3.json", &fetchResp3)

ctx := driverctx.NewContextWithConnId(context.Background(), "connectionId")
ctx = driverctx.NewContextWithCorrelationId(ctx, "correlationId")

var fetchesInfo []fetchResultsInfo

simpleClient := getSimpleClient(&fetchesInfo, []cli_service.TFetchResultsResp{fetchResp1, fetchResp2, fetchResp3})
rpi := rowscanner.NewResultPageIterator(
ctx,
rowscanner.NewDelimiter(0, 0),
5000,
nil,
false,
simpleClient,
"connectionId",
"correlationId",
logger,
)

Expand Down Expand Up @@ -199,16 +204,18 @@ func TestArrowRecordIteratorSchema(t *testing.T) {
fetchResp1 := cli_service.TFetchResultsResp{}
loadTestData2(t, "directResultsMultipleFetch/FetchResults1.json", &fetchResp1)

ctx := driverctx.NewContextWithConnId(context.Background(), "connectionId")
ctx = driverctx.NewContextWithCorrelationId(ctx, "correlationId")

var fetchesInfo []fetchResultsInfo
simpleClient := getSimpleClient(&fetchesInfo, []cli_service.TFetchResultsResp{fetchResp1})
rpi := rowscanner.NewResultPageIterator(
ctx,
rowscanner.NewDelimiter(0, 0),
5000,
nil,
false,
simpleClient,
"connectionId",
"correlationId",
logger,
)

Expand Down Expand Up @@ -251,16 +258,18 @@ func TestArrowRecordIteratorSchema(t *testing.T) {
fetchResp1 := cli_service.TFetchResultsResp{}
loadTestData2(t, "multipleFetch/FetchResults1.json", &fetchResp1)

ctx := driverctx.NewContextWithConnId(context.Background(), "connectionId")
ctx = driverctx.NewContextWithCorrelationId(ctx, "correlationId")

var fetchesInfo []fetchResultsInfo
simpleClient := getSimpleClient(&fetchesInfo, []cli_service.TFetchResultsResp{fetchResp1})
rpi := rowscanner.NewResultPageIterator(
ctx,
rowscanner.NewDelimiter(0, 0),
5000,
nil,
false,
simpleClient,
"connectionId",
"correlationId",
logger,
)

Expand Down Expand Up @@ -293,14 +302,16 @@ func TestArrowRecordIteratorSchema(t *testing.T) {
},
}

ctx := driverctx.NewContextWithConnId(context.Background(), "connectionId")
ctx = driverctx.NewContextWithCorrelationId(ctx, "correlationId")

rpi := rowscanner.NewResultPageIterator(
ctx,
rowscanner.NewDelimiter(0, 0),
5000,
nil,
false,
failingClient,
"connectionId",
"correlationId",
logger,
)

Expand Down
7 changes: 5 additions & 2 deletions internal/rows/arrowbased/arrowRows_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import (

"github.com/apache/arrow/go/v12/arrow"
"github.com/apache/arrow/go/v12/arrow/array"
"github.com/databricks/databricks-sql-go/driverctx"
dbsqlerr "github.com/databricks/databricks-sql-go/errors"
"github.com/databricks/databricks-sql-go/internal/cli_service"
"github.com/databricks/databricks-sql-go/internal/config"
Expand Down Expand Up @@ -1525,18 +1526,20 @@ func TestArrowRowScanner(t *testing.T) {
fetchResp2 := cli_service.TFetchResultsResp{}
loadTestData2(t, "directResultsMultipleFetch/FetchResults2.json", &fetchResp2)

ctx := driverctx.NewContextWithConnId(context.Background(), "connectionId")
ctx = driverctx.NewContextWithCorrelationId(ctx, "correlationId")

var fetchesInfo []fetchResultsInfo
client := getSimpleClient(&fetchesInfo, []cli_service.TFetchResultsResp{fetchResp1, fetchResp2})
logger := dbsqllog.WithContext("connectionId", "correlationId", "")

rpi := rowscanner.NewResultPageIterator(
ctx,
rowscanner.NewDelimiter(0, 7311),
5000,
nil,
false,
client,
"connectionId",
"correlationId",
logger)

cfg := config.WithDefaults()
Expand Down
16 changes: 7 additions & 9 deletions internal/rows/rows.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,22 +67,22 @@ var _ driver.RowsColumnTypeLength = (*rows)(nil)
var _ dbsqlrows.Rows = (*rows)(nil)

func NewRows(
connId string,
correlationId string,
ctx context.Context,
opHandle *cli_service.TOperationHandle,
client cli_service.TCLIService,
config *config.Config,
directResults *cli_service.TSparkDirectResults,
) (driver.Rows, dbsqlerr.DBError) {

Copy link
Collaborator

@gopalldb gopalldb Nov 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we need a check for context being nil?

Copy link
Author

@dgiagio dgiagio Dec 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't believe we need a check for nil here. NewRows is receiving the context when called from two places: QueryContext and execStagingOperation. In both places the ctx is expected to be non-nil already and is used a few times before being passed to NewRows.

connId := driverctx.ConnIdFromContext(ctx)
correlationId := driverctx.CorrelationIdFromContext(ctx)

var logger *dbsqllog.DBSQLLogger
var ctx context.Context
if opHandle != nil {
logger = dbsqllog.WithContext(connId, correlationId, dbsqlclient.SprintGuid(opHandle.OperationId.GUID))
ctx = driverctx.NewContextWithQueryId(driverctx.NewContextWithCorrelationId(driverctx.NewContextWithConnId(context.Background(), connId), correlationId), dbsqlclient.SprintGuid(opHandle.OperationId.GUID))
ctx = driverctx.NewContextWithQueryId(ctx, dbsqlclient.SprintGuid(opHandle.OperationId.GUID))
} else {
logger = dbsqllog.WithContext(connId, correlationId, "")
ctx = driverctx.NewContextWithCorrelationId(driverctx.NewContextWithConnId(context.Background(), connId), correlationId)
}

if client == nil {
Expand Down Expand Up @@ -140,13 +140,12 @@ func NewRows(
// the operations.
closedOnServer := directResults != nil && directResults.CloseOperation != nil
r.ResultPageIterator = rowscanner.NewResultPageIterator(
ctx,
d,
pageSize,
opHandle,
closedOnServer,
client,
connId,
correlationId,
r.logger(),
)

Expand Down Expand Up @@ -417,9 +416,8 @@ func (r *rows) getResultSetSchema() (*cli_service.TTableSchema, dbsqlerr.DBError
req := cli_service.TGetResultSetMetadataReq{
OperationHandle: r.opHandle,
}
ctx := driverctx.NewContextWithCorrelationId(driverctx.NewContextWithConnId(context.Background(), r.connId), r.correlationId)

resp, err2 := r.client.GetResultSetMetadata(ctx, &req)
resp, err2 := r.client.GetResultSetMetadata(r.ctx, &req)
if err2 != nil {
r.logger().Err(err2).Msg(err2.Error())
return nil, dbsqlerr_int.NewRequestError(r.ctx, errRowsMetadataFetchFailed, err)
Expand Down
Loading