localbackend: fix resource leak when err on new local backend (#53664)

[ti-chi-bot]

This is an automated cherry-pick of #53664

What problem does this PR solve?

Issue Number: close #53659

Problem Summary:

What changed and how does it work?

• close them on error

Check List

Tests

• Unit test
• Integration test
• Manual test (add detailed scripts or steps below)

i think it's too much to add so many failpoints to just test resource closed on err, so i write the test here

apply this diff to the code

diff --git a/pkg/lightning/backend/local/local.go b/pkg/lightning/backend/local/local.go
index f232d71d79..1d91833fa8 100644
--- a/pkg/lightning/backend/local/local.go
+++ b/pkg/lightning/backend/local/local.go
@@ -560,12 +560,14 @@ func NewBackend(
 		// the interface `ScatterRegions` may time out.
 		pd.WithCustomTimeoutOption(60*time.Second),
 	)
+	failpoint.InjectCall("failedToCreatePDClient", &err)
 	if err != nil {
 		return nil, common.NormalizeOrWrapErr(common.ErrCreatePDClient, err)
 	}
 
 	// The following copies tikv.NewTxnClient without creating yet another pdClient.
 	spkv, err = tikvclient.NewEtcdSafePointKV(strings.Split(config.PDAddr, ","), tls.TLSConfig())
+	failpoint.InjectCall("failedToCreateSafePointKV", &err)
 	if err != nil {
 		return nil, common.ErrCreateKVClient.Wrap(err).GenWithStackByArgs()
 	}
@@ -582,6 +584,7 @@ func NewBackend(
 	tikvCodec := pdCliForTiKV.GetCodec()
 	rpcCli = tikvclient.NewRPCClient(tikvclient.WithSecurity(tls.ToTiKVSecurityConfig()), tikvclient.WithCodec(tikvCodec))
 	tikvCli, err = tikvclient.NewKVStore("lightning-local-backend", pdCliForTiKV, spkv, rpcCli)
+	failpoint.InjectCall("failedToCreateKVStore", &err)
 	if err != nil {
 		return nil, common.ErrCreateKVClient.Wrap(err).GenWithStackByArgs()
 	}
@@ -594,6 +597,7 @@ func NewBackend(
 	importClientFactory = newImportClientFactoryImpl(splitCli, tls, config.MaxConnPerStore, config.ConnCompressType)
 
 	multiIngestSupported, err = checkMultiIngestSupport(ctx, pdCli, importClientFactory)
+	failpoint.InjectCall("failedToCheckMultiIngestSupport", &err)
 	if err != nil {
 		return nil, common.ErrCheckMultiIngest.Wrap(err).GenWithStackByArgs()
 	}

then in real-tikv-test which have routine leak check, add this:

func TestLocalBackendCleanOnErr(t *testing.T) {
	for _, fp := range []string{
		"failedToCreatePDClient",
		"failedToCreateSafePointKV",
		"failedToCreateKVStore",
		"failedToCheckMultiIngestSupport",
	} {
		t.Run(fp, func(t *testing.T) {
			fpName := "github.com/pingcap/tidb/pkg/lightning/backend/local/" + fp
			testfailpoint.EnableCall(t, fpName,
				func(errP *error) {
					*errP = fmt.Errorf("mock error" + fp)
				},
			)
			t.Cleanup(func() {
				require.NoError(t, failpoint.Disable(fpName))
			})
			_, err := local.NewBackend(context.Background(), &common.TLS{}, local.BackendConfig{
				PDAddr:                 "127.0.0.1:2379",
				RegionSplitBatchSize:   10,
				RegionSplitConcurrency: 1,
				MaxConnPerStore:        1,
				ConnCompressType:       config.CompressionNone,
			}, nil)
			require.ErrorContains(t, err, "mock error"+fp)
		})
	}
}

• No need to test

  • I checked and no code files have been changed.

Side effects

• Performance regression: Consumes more CPU
• Performance regression: Consumes more Memory
• Breaking backward compatibility

Documentation

• Affects user behaviors
• Contains syntax changes
• Contains variable changes
• Contains experimental features
• Changes MySQL compatibility

Release note

Please refer to Release Notes Language Style Guide to write a quality release note.

None

[D3Hunter]

@lance6716

[codecov]

Codecov Report

Attention: Patch coverage is 16.94915% with 49 lines in your changes missing coverage. Please review.

Please upload report for BASE (release-8.1@cfd1d3a). Learn more about missing BASE report.

Additional details and impacted files

@@               Coverage Diff                @@
##             release-8.1     #55066   +/-   ##
================================================
  Coverage               ?   71.1775%           
================================================
  Files                  ?       1465           
  Lines                  ?     421973           
  Branches               ?          0           
================================================
  Hits                   ?     300350           
  Misses                 ?     101115           
  Partials               ?      20508           

Flag	Coverage Δ
unit	71.1775% <16.9491%> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

Components	Coverage Δ
dumpling	53.9957% <0.0000%> (?)
parser	∅ <0.0000%> (?)
br	41.0760% <0.0000%> (?)

[ti-chi-bot]

[LGTM Timeline notifier]

Timeline:

• 2024-07-30 10:35:23.035721916 +0000 UTC m=+265639.315769985: ☑️ agreed by D3Hunter.
• 2024-07-30 13:00:27.642297612 +0000 UTC m=+274343.922345673: ☑️ agreed by lance6716.

[ti-chi-bot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: D3Hunter, lance6716, Leavrth

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• br/OWNERS [Leavrth]
• pkg/lightning/OWNERS [D3Hunter,lance6716]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment