-
Notifications
You must be signed in to change notification settings - Fork 5.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
importinto: convert encode and sort part into operator (#46532)
- Loading branch information
Showing
8 changed files
with
304 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,134 @@ | ||
| // Copyright 2023 PingCAP, Inc. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package importinto | ||
|
|
||
| import ( | ||
| "context" | ||
|
|
||
| "github.com/pingcap/errors" | ||
| "github.com/pingcap/tidb/disttask/operator" | ||
| "github.com/pingcap/tidb/resourcemanager/pool/workerpool" | ||
| "github.com/pingcap/tidb/resourcemanager/util" | ||
| tidbutil "github.com/pingcap/tidb/util" | ||
| "go.uber.org/atomic" | ||
| "go.uber.org/zap" | ||
| ) | ||
|
|
||
| // encodeAndSortOperator is an operator that encodes and sorts data. | ||
| // this operator process data of a subtask, i.e. one engine, it contains a lot | ||
| // of data chunks, each chunk is a data file or part of it. | ||
| // we don't split into encode and sort operators of chunk level, we parallel | ||
| // them inside. | ||
| type encodeAndSortOperator struct { | ||
| *operator.AsyncOperator[*importStepMinimalTask, workerpool.None] | ||
| wg tidbutil.WaitGroupWrapper | ||
| firstErr atomic.Error | ||
|
|
||
| ctx context.Context | ||
| cancel context.CancelFunc | ||
|
|
||
| logger *zap.Logger | ||
| errCh chan error | ||
| } | ||
|
|
||
| var _ operator.Operator = (*encodeAndSortOperator)(nil) | ||
| var _ operator.WithSource[*importStepMinimalTask] = (*encodeAndSortOperator)(nil) | ||
| var _ operator.WithSink[workerpool.None] = (*encodeAndSortOperator)(nil) | ||
|
|
||
| func newEncodeAndSortOperator(ctx context.Context, concurrency int, logger *zap.Logger) *encodeAndSortOperator { | ||
| subCtx, cancel := context.WithCancel(ctx) | ||
| op := &encodeAndSortOperator{ | ||
| ctx: subCtx, | ||
| cancel: cancel, | ||
| logger: logger, | ||
| errCh: make(chan error), | ||
| } | ||
| pool := workerpool.NewWorkerPool( | ||
| "encodeAndSortOperator", | ||
| util.ImportInto, | ||
| concurrency, | ||
| func() workerpool.Worker[*importStepMinimalTask, workerpool.None] { | ||
| return &chunkWorker{ | ||
| ctx: subCtx, | ||
| op: op, | ||
| } | ||
| }, | ||
| ) | ||
| op.AsyncOperator = operator.NewAsyncOperator(subCtx, pool) | ||
| return op | ||
| } | ||
|
|
||
| func (op *encodeAndSortOperator) Open() error { | ||
| op.wg.Run(func() { | ||
| for err := range op.errCh { | ||
| if op.firstErr.CompareAndSwap(nil, err) { | ||
| op.cancel() | ||
| } else { | ||
| if errors.Cause(err) != context.Canceled { | ||
| op.logger.Error("error on encode and sort", zap.Error(err)) | ||
| } | ||
| } | ||
| } | ||
| }) | ||
| return op.AsyncOperator.Open() | ||
| } | ||
|
|
||
| func (op *encodeAndSortOperator) Close() error { | ||
| // TODO: handle close err after we separate wait part from close part. | ||
| // right now AsyncOperator.Close always returns nil, ok to ignore it. | ||
| // nolint:errcheck | ||
| op.AsyncOperator.Close() | ||
| op.cancel() | ||
| close(op.errCh) | ||
| op.wg.Wait() | ||
| // see comments on interface definition, this Close is actually WaitAndClose. | ||
| return op.firstErr.Load() | ||
| } | ||
|
|
||
| func (*encodeAndSortOperator) String() string { | ||
| return "encodeAndSortOperator" | ||
| } | ||
|
|
||
| func (op *encodeAndSortOperator) hasError() bool { | ||
| return op.firstErr.Load() != nil | ||
| } | ||
|
|
||
| func (op *encodeAndSortOperator) onError(err error) { | ||
| op.errCh <- err | ||
| } | ||
|
|
||
| func (op *encodeAndSortOperator) Done() <-chan struct{} { | ||
| return op.ctx.Done() | ||
| } | ||
|
|
||
| type chunkWorker struct { | ||
| ctx context.Context | ||
| op *encodeAndSortOperator | ||
| } | ||
|
|
||
| func (w *chunkWorker) HandleTask(task *importStepMinimalTask, _ func(workerpool.None)) { | ||
| if w.op.hasError() { | ||
| return | ||
| } | ||
| // we don't use the input send function, it makes workflow more complex | ||
| // we send result to errCh and handle it here. | ||
| executor := newImportMinimalTaskExecutor(task) | ||
| if err := executor.Run(w.ctx); err != nil { | ||
| w.op.onError(err) | ||
| } | ||
| } | ||
|
|
||
| func (*chunkWorker) Close() { | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,118 @@ | ||
| // Copyright 2023 PingCAP, Inc. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package importinto | ||
|
|
||
| import ( | ||
| "context" | ||
| "os" | ||
| "path" | ||
| "sync" | ||
| "sync/atomic" | ||
| "testing" | ||
| "time" | ||
|
|
||
| "github.com/pingcap/errors" | ||
| mockexecute "github.com/pingcap/tidb/disttask/framework/mock/execute" | ||
| "github.com/pingcap/tidb/disttask/framework/scheduler/execute" | ||
| "github.com/pingcap/tidb/disttask/operator" | ||
| "github.com/stretchr/testify/require" | ||
| "go.uber.org/mock/gomock" | ||
| "go.uber.org/zap" | ||
| ) | ||
|
|
||
| func TestEncodeAndSortOperator(t *testing.T) { | ||
| bak := os.Stdout | ||
| logFileName := path.Join(t.TempDir(), "test.log") | ||
| file, err := os.OpenFile(logFileName, os.O_CREATE|os.O_WRONLY|os.O_TRUNC, 0644) | ||
| require.NoError(t, err) | ||
| os.Stdout = file | ||
| t.Cleanup(func() { | ||
| require.NoError(t, os.Stdout.Close()) | ||
| os.Stdout = bak | ||
| }) | ||
| logger := zap.NewExample() | ||
|
|
||
| ctrl := gomock.NewController(t) | ||
| defer ctrl.Finish() | ||
| executor := mockexecute.NewMockMiniTaskExecutor(ctrl) | ||
| backup := newImportMinimalTaskExecutor | ||
| t.Cleanup(func() { | ||
| newImportMinimalTaskExecutor = backup | ||
| }) | ||
| newImportMinimalTaskExecutor = func(t *importStepMinimalTask) execute.MiniTaskExecutor { | ||
| return executor | ||
| } | ||
|
|
||
| source := operator.NewSimpleDataChannel(make(chan *importStepMinimalTask)) | ||
| op := newEncodeAndSortOperator(context.Background(), 3, logger) | ||
| op.SetSource(source) | ||
| require.NoError(t, op.Open()) | ||
| require.Greater(t, len(op.String()), 0) | ||
|
|
||
| // cancel on error | ||
| mockErr := errors.New("mock err") | ||
| executor.EXPECT().Run(gomock.Any()).Return(mockErr) | ||
| source.Channel() <- &importStepMinimalTask{} | ||
| require.Eventually(t, func() bool { | ||
| return op.hasError() | ||
| }, 3*time.Second, 300*time.Millisecond) | ||
| require.Equal(t, mockErr, op.firstErr.Load()) | ||
| // should not block | ||
| <-op.ctx.Done() | ||
| require.ErrorIs(t, op.Close(), mockErr) | ||
|
|
||
| // cancel on error and log other errors | ||
| mockErr2 := errors.New("mock err 2") | ||
| source = operator.NewSimpleDataChannel(make(chan *importStepMinimalTask)) | ||
| op = newEncodeAndSortOperator(context.Background(), 2, logger) | ||
| op.SetSource(source) | ||
| executor1 := mockexecute.NewMockMiniTaskExecutor(ctrl) | ||
| executor2 := mockexecute.NewMockMiniTaskExecutor(ctrl) | ||
| var id atomic.Int32 | ||
| newImportMinimalTaskExecutor = func(t *importStepMinimalTask) execute.MiniTaskExecutor { | ||
| if id.Add(1) == 1 { | ||
| return executor1 | ||
| } | ||
| return executor2 | ||
| } | ||
| var wg sync.WaitGroup | ||
| wg.Add(2) | ||
| // wait until 2 executor start running, else workerpool will be cancelled. | ||
| executor1.EXPECT().Run(gomock.Any()).DoAndReturn(func(context.Context) error { | ||
| wg.Done() | ||
| wg.Wait() | ||
| return mockErr2 | ||
| }) | ||
| executor2.EXPECT().Run(gomock.Any()).DoAndReturn(func(context.Context) error { | ||
| wg.Done() | ||
| wg.Wait() | ||
| // wait error in executor1 has been processed | ||
| require.Eventually(t, func() bool { | ||
| return op.hasError() | ||
| }, 3*time.Second, 300*time.Millisecond) | ||
| return errors.New("mock error should be logged") | ||
| }) | ||
| require.NoError(t, op.Open()) | ||
| // send 2 tasks | ||
| source.Channel() <- &importStepMinimalTask{} | ||
| source.Channel() <- &importStepMinimalTask{} | ||
| // should not block | ||
| <-op.ctx.Done() | ||
| require.ErrorIs(t, op.Close(), mockErr2) | ||
| require.NoError(t, os.Stdout.Sync()) | ||
| content, err := os.ReadFile(logFileName) | ||
| require.NoError(t, err) | ||
| require.Contains(t, string(content), "mock error should be logged") | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.