[Internal] Use SDKv2 Implementation for databricks_share resource as default (#4931)

## Changes
<!-- Summary of your changes that are easy to understand -->
This PR:
- reverts
#4846.
- Adds a note under breaking changes to highlight the issue.
- Move the next release to patch.

**Context**
databricks_share resource exists in 2 implementations SDKv2 and Plugin
framework. In
#4846,
plugin framework implementation (`databricks_share_pluginframework`) was
made default (`databricks_share`) but this lead to surfacing an
underlying issue in plugin framework implementation leading to panic:
#4913

```
Stack trace from the terraform-provider-databricks_v1.86.0 plugin:
panic: runtime error: index out of range [0] with length 0
goroutine 68 [running]:
github.com/databricks/terraform-provider-databricks/internal/providers/pluginfw/products/sharing.(*ShareResource).syncEffectiveFields(_, {_, _}, {{{0x2, {0xc0007f6b40, 0x22}}, {0x2, 0x196f67034f0}, {0x2, {0xc0007f6b70, ...}}, ...}}, ...)
	/home/runner/work/terraform-provider-databricks/terraform-provider-databricks/internal/providers/pluginfw/products/sharing/resource_share.go:449 +0x48e
github.com/databricks/terraform-provider-databricks/internal/providers/pluginfw/products/sharing.(*ShareResource).Read(0xc000527240, {0x1c50398?, 0xc000a31890?}, {{{{0x1c5b670, 0xc000a4c150}, {0x16fd920, 0xc000a41e30}}, {0x1c61390, 0xc0009b1ef0}}, 0x0, ...}, ...)
	/home/runner/work/terraform-provider-databricks/terraform-provider-databricks/internal/providers/pluginfw/products/sharing/resource_share.go:281 +0x765
```

This leads to the default share resource having unstable implementation.
Panic can lead to bad state in TF since apply is stopped in between.

This change would be followed up by a patch release. 
- No changes for users on version 1.85.0 and below which would upgrade
to patch release including this fix. Limit the impacted users by moving
back to SDKv2.

Impacted users with the issue of panic seems to have been able to
mitigate the issue by using older version of TF which uses SDKv2.
However, I am getting diff to create the share again. It seems like
SDKv2 is not able to use the state create by plugin framework. This
needs further investigation. To limit the impact of issue, we are
rolling back to the previous stable version.

## Tests
<!--
How is this tested? Please see the checklist below and also describe any
other relevant tests
-->
Tests same as when SDKv2 was default.

Author: tanmay-db

NEXT_CHANGELOG.md

@@ -1,8 +1,9 @@
 # NEXT CHANGELOG
 
-## Release v1.88.0
+## Release v1.87.1
 
 ### Breaking Changes
+Terraform databricks provider version 1.86.0 introduced changes to databricks_share resource leading to panic for some users while applying terraform. We are rolling back to SDKv2 implementation in this version. No change is expected for users who are upgrading to latest version from before 1.86.0. Users on 1.86.0 and not facing issues are suggested to not upgrade their version to this patch release. We are investigating the issue and will release a fix soon.
 
 ### New Features and Improvements
 
@@ -13,3 +14,4 @@
 ### Exporter
 
 ### Internal Changes
+* Use SDKv2 Implementation for databricks_share resource as default ([#4931](https://github.com/databricks/terraform-provider-databricks/pull/4931))

exporter/importables.go

@@ -1992,42 +1992,8 @@ var resourcesMap map[string]importable = map[string]importable{
 			return nil
 		},
 		Import: func(ic *importContext, r *resource) error {
-			resourceInfo := ic.Resources["databricks_share"]
-			if resourceInfo == nil {
-				// Fallback to direct data access if schema is not available
-				objectsList := r.Data.Get("object").([]any)
-				ic.emitUCGrantsWithOwner("share/"+r.ID, r)
-				for _, objRaw := range objectsList {
-					obj := objRaw.(map[string]any)
-					dataObjectType := obj["data_object_type"].(string)
-					name := obj["name"].(string)
-
-					switch dataObjectType {
-					case "TABLE":
-						ic.Emit(&resource{
-							Resource: "databricks_sql_table",
-							ID:       name,
-						})
-					case "VOLUME":
-						ic.Emit(&resource{
-							Resource: "databricks_volume",
-							ID:       name,
-						})
-					case "MODEL":
-						ic.Emit(&resource{
-							Resource: "databricks_registered_model",
-							ID:       name,
-						})
-					default:
-						log.Printf("[INFO] Object type '%s' (name: '%s') isn't supported in share '%s'",
-							dataObjectType, name, r.ID)
-					}
-				}
-				return nil
-			}
-
 			var share tf_sharing.ShareInfo
-			s := resourceInfo.Schema
+			s := ic.Resources["databricks_share"].Schema
 			common.DataToStructPointer(r.Data, s, &share)
 			// TODO: how to link recipients to share?
 			ic.emitUCGrantsWithOwner("share/"+r.ID, r)
@@ -2053,6 +2019,7 @@ var resourcesMap map[string]importable = map[string]importable{
 						obj.DataObjectType, obj.Name, r.ID)
 				}
 			}
+
 			return nil
 		},
 		ShouldOmitField: shouldOmitForUnityCatalog,

internal/providers/pluginfw/pluginfw_rollout_utils.go

@@ -33,14 +33,11 @@ import (
 var migratedResources = []func() resource.Resource{
 	library.ResourceLibrary,
 	qualitymonitor.ResourceQualityMonitor,
-	sharing.ResourceShare,
 }
 
 // List of data sources that have been migrated from SDK V2 to plugin framework
 // Keep this list sorted.
 var migratedDataSources = []func() datasource.DataSource{
-	sharing.DataSourceShare,
-	sharing.DataSourceShares,
 	volume.DataSourceVolumes,
 }
 
@@ -49,6 +46,7 @@ var migratedDataSources = []func() datasource.DataSource{
 var pluginFwOnlyResources = append(
 	[]func() resource.Resource{
 		app.ResourceApp,
+		sharing.ResourceShare,
 	},
 	autoGeneratedResources...,
 )
@@ -67,6 +65,8 @@ var pluginFwOnlyDataSources = append(
 		serving.DataSourceServingEndpoints,
 		// TODO: Add DataSourceCluster into migratedDataSources after fixing unit tests.
 		cluster.DataSourceCluster, // Using the staging name (with pluginframework suffix)
+		sharing.DataSourceShare,   // Using the staging name (with pluginframework suffix)
+		sharing.DataSourceShares,  // Using the staging name (with pluginframework suffix)
 	},
 	autoGeneratedDataSources...,
 )

internal/providers/pluginfw/products/sharing/data_share.go

@@ -28,7 +28,7 @@ type ShareDataSource struct {
 }
 
 func (d *ShareDataSource) Metadata(ctx context.Context, req datasource.MetadataRequest, resp *datasource.MetadataResponse) {
-	resp.TypeName = pluginfwcommon.GetDatabricksProductionName(dataSourceNameShare)
+	resp.TypeName = pluginfwcommon.GetDatabricksStagingName(dataSourceNameShare)
 }
 
 func (d *ShareDataSource) Schema(ctx context.Context, req datasource.SchemaRequest, resp *datasource.SchemaResponse) {

internal/providers/pluginfw/products/sharing/data_shares.go

@@ -52,7 +52,7 @@ type SharesDataSource struct {
 }
 
 func (d *SharesDataSource) Metadata(ctx context.Context, req datasource.MetadataRequest, resp *datasource.MetadataResponse) {
-	resp.TypeName = pluginfwcommon.GetDatabricksProductionName(dataSourceNameShares)
+	resp.TypeName = pluginfwcommon.GetDatabricksStagingName(dataSourceNameShares)
 }
 
 func (d *SharesDataSource) Schema(ctx context.Context, req datasource.SchemaRequest, resp *datasource.SchemaResponse) {

internal/providers/pluginfw/products/sharing/data_shares_acc_test.go

@@ -12,8 +12,8 @@ import (
 
 func checkSharesDataSourcePopulated(t *testing.T) func(s *terraform.State) error {
 	return func(s *terraform.State) error {
-		ds, ok := s.Modules[0].Resources["data.databricks_shares.this"]
-		require.True(t, ok, "data.databricks_shares.this has to be there")
+		ds, ok := s.Modules[0].Resources["data.databricks_shares_pluginframework.this"]
+		require.True(t, ok, "data.databricks_shares_pluginframework.this has to be there")
 		num_shares, _ := strconv.Atoi(ds.Primary.Attributes["shares.#"])
 		assert.GreaterOrEqual(t, num_shares, 1)
 		return nil
@@ -71,7 +71,7 @@ func TestUcAccDataSourceShares(t *testing.T) {
 			}
 		}
 
-		resource "databricks_share" "myshare" {
+		resource "databricks_share_pluginframework" "myshare" {
 			name = "{var.RANDOM}-terraform-delta-share"
 			object {
 				name = databricks_table.mytable.id
@@ -86,8 +86,8 @@ func TestUcAccDataSourceShares(t *testing.T) {
 			}
 		}
 
-		data "databricks_shares" "this" {
-			depends_on = [databricks_share.myshare]
+		data "databricks_shares_pluginframework" "this" {
+			depends_on = [databricks_share_pluginframework.myshare]
 		}
 		`,
 		Check: checkSharesDataSourcePopulated(t),

internal/providers/pluginfw/products/sharing/resource_acc_test.go

@@ -1,13 +1,10 @@
 package sharing_test
 
 import (
-	"context"
 	"fmt"
 	"testing"
 
 	"github.com/databricks/terraform-provider-databricks/internal/acceptance"
-	"github.com/databricks/terraform-provider-databricks/internal/providers"
-	"github.com/hashicorp/terraform-plugin-go/tfprotov6"
 )
 
 const preTestTemplate = `
@@ -94,7 +91,7 @@ const preTestTemplateUpdate = `
 func TestUcAccCreateShare(t *testing.T) {
 	acceptance.UnityWorkspaceLevel(t, acceptance.Step{
 		Template: preTestTemplate + `
-		resource "databricks_share" "myshare" {
+		resource "databricks_share_pluginframework" "myshare" {
 			name  = "{var.STICKY_RANDOM}-terraform-delta-share"
 			owner = "account users"
 			object {
@@ -122,7 +119,7 @@ func TestUcAccCreateShare(t *testing.T) {
 		}
 
 		resource "databricks_grants" "some" {
-			share = databricks_share.myshare.name
+			share = databricks_share_pluginframework.myshare.name
 			grant {
 				principal  = databricks_recipient.db2open.name
 				privileges = ["SELECT"]
@@ -134,7 +131,7 @@ func TestUcAccCreateShare(t *testing.T) {
 
 func shareTemplateWithOwner(comment string, owner string) string {
 	return fmt.Sprintf(`
-		resource "databricks_share" "myshare" {
+		resource "databricks_share_pluginframework" "myshare" {
 			name  = "{var.STICKY_RANDOM}-terraform-delta-share"
 			owner = "%s"
 			object {
@@ -162,7 +159,7 @@ func TestUcAccUpdateShare(t *testing.T) {
 func TestUcAccUpdateShareAddObject(t *testing.T) {
 	acceptance.UnityWorkspaceLevel(t, acceptance.Step{
 		Template: preTestTemplate + preTestTemplateUpdate +
-			`resource "databricks_share" "myshare" {
+			`resource "databricks_share_pluginframework" "myshare" {
 			name  = "{var.STICKY_RANDOM}-terraform-delta-share"
 			owner = "account users"
 			object {
@@ -181,7 +178,7 @@ func TestUcAccUpdateShareAddObject(t *testing.T) {
 		}`,
 	}, acceptance.Step{
 		Template: preTestTemplate + preTestTemplateUpdate +
-			`resource "databricks_share" "myshare" {
+			`resource "databricks_share_pluginframework" "myshare" {
 			name  = "{var.STICKY_RANDOM}-terraform-delta-share"
 			owner = "account users"
 			object {
@@ -209,7 +206,7 @@ func TestUcAccUpdateShareAddObject(t *testing.T) {
 func TestUcAccUpdateShareReorderObject(t *testing.T) {
 	acceptance.UnityWorkspaceLevel(t, acceptance.Step{
 		Template: preTestTemplate + preTestTemplateUpdate +
-			`resource "databricks_share" "myshare" {
+			`resource "databricks_share_pluginframework" "myshare" {
 			name  = "{var.STICKY_RANDOM}-terraform-delta-share"
 			owner = "account users"
 			object {
@@ -223,7 +220,7 @@ func TestUcAccUpdateShareReorderObject(t *testing.T) {
 		}`,
 	}, acceptance.Step{
 		Template: preTestTemplate + preTestTemplateUpdate +
-			`resource "databricks_share" "myshare" {
+			`resource "databricks_share_pluginframework" "myshare" {
 			name  = "{var.STICKY_RANDOM}-terraform-delta-share"
 			owner = "account users"
 			object {
@@ -237,142 +234,3 @@ func TestUcAccUpdateShareReorderObject(t *testing.T) {
 		}`,
 	})
 }
-
-// TestUcAccUpdateShareNoChanges tests that updating a share with no actual changes doesn't cause issues
-func TestUcAccUpdateShareNoChanges(t *testing.T) {
-	shareConfig := preTestTemplate + preTestTemplateUpdate +
-		`resource "databricks_share" "myshare" {
-			name  = "{var.STICKY_RANDOM}-terraform-delta-share"
-			owner = "account users"
-			object {
-				name = databricks_table.mytable.id
-				comment = "stable comment"
-				data_object_type = "TABLE"
-			}
-		}`
-
-	acceptance.UnityWorkspaceLevel(t, acceptance.Step{
-		Template: shareConfig,
-	}, acceptance.Step{
-		Template: shareConfig, // Same config - should not trigger any updates
-	})
-}
-
-// TestUcAccUpdateShareComplexObjectChanges tests complex scenarios with multiple object updates
-func TestUcAccUpdateShareComplexObjectChanges(t *testing.T) {
-	acceptance.UnityWorkspaceLevel(t, acceptance.Step{
-		Template: preTestTemplate + preTestTemplateUpdate +
-			`resource "databricks_share" "myshare" {
-			name  = "{var.STICKY_RANDOM}-terraform-delta-share"
-			owner = "account users"
-			object {
-				name = databricks_table.mytable.id
-				comment = "original comment"
-				data_object_type = "TABLE"
-			}
-			object {
-				name = databricks_table.mytable_2.id
-				comment = "second table"
-				data_object_type = "TABLE"
-			}
-		}`,
-	}, acceptance.Step{
-		// Remove one object, add another, and update comment on existing
-		Template: preTestTemplate + preTestTemplateUpdate +
-			`resource "databricks_share" "myshare" {
-			name  = "{var.STICKY_RANDOM}-terraform-delta-share"
-			owner = "account users"
-			object {
-				name = databricks_table.mytable.id
-				comment = "updated comment"
-				data_object_type = "TABLE"
-			}
-			object {
-				name = databricks_table.mytable_3.id
-				comment = "third table"
-				data_object_type = "TABLE"
-			}
-		}`,
-	})
-}
-
-// TestUcAccUpdateShareRemoveAllObjects tests removing all objects from a share
-func TestUcAccUpdateShareRemoveAllObjects(t *testing.T) {
-	acceptance.UnityWorkspaceLevel(t, acceptance.Step{
-		Template: preTestTemplate + preTestTemplateUpdate +
-			`resource "databricks_share" "myshare" {
-			name  = "{var.STICKY_RANDOM}-terraform-delta-share"
-			owner = "account users"
-			object {
-				name = databricks_table.mytable.id
-				comment = "to be removed"
-				data_object_type = "TABLE"
-			}
-			object {
-				name = databricks_table.mytable_2.id
-				comment = "also to be removed"
-				data_object_type = "TABLE"
-			}
-		}`,
-	}, acceptance.Step{
-		Template: preTestTemplate + preTestTemplateUpdate +
-			`resource "databricks_share" "myshare" {
-			name  = "{var.STICKY_RANDOM}-terraform-delta-share"
-			owner = "account users"
-		}`,
-	})
-}
-
-// TestUcAccShareMigrationFromSDKv2 tests the transition from sdkv2 to plugin framework.
-// This test verifies that existing state created by SDK v2 implementation can be
-// successfully managed by the plugin framework implementation without any changes.
-func TestUcAccShareMigrationFromSDKv2(t *testing.T) {
-	acceptance.UnityWorkspaceLevel(t,
-		// Step 1: Create share using SDK v2 implementation
-		acceptance.Step{
-			ProtoV6ProviderFactories: map[string]func() (tfprotov6.ProviderServer, error){
-				"databricks": func() (tfprotov6.ProviderServer, error) {
-					sdkv2Provider, pluginfwProvider := acceptance.ProvidersWithResourceFallbacks([]string{"databricks_share"})
-					return providers.GetProviderServer(context.Background(), providers.WithSdkV2Provider(sdkv2Provider), providers.WithPluginFrameworkProvider(pluginfwProvider))
-				},
-			},
-			Template: preTestTemplate + preTestTemplateUpdate + `
-				resource "databricks_share" "myshare" {
-					name  = "{var.STICKY_RANDOM}-terraform-migration-share"
-					owner = "account users"
-					object {
-						name = databricks_table.mytable.id
-						comment = "Shared table for migration test"
-						data_object_type = "TABLE"
-					}
-					object {
-						name = databricks_table.mytable_2.id
-						comment = "Second shared table"
-						data_object_type = "TABLE"
-						cdf_enabled = false
-					}
-				}`,
-		},
-		// Step 2: Update the share using plugin framework implementation (default)
-		// This verifies no changes are needed when switching implementations
-		acceptance.Step{
-			ExpectNonEmptyPlan: false,
-			Template: preTestTemplate + preTestTemplateUpdate + `
-				resource "databricks_share" "myshare" {
-					name  = "{var.STICKY_RANDOM}-terraform-migration-share"
-					owner = "account users"
-					object {
-						name = databricks_table.mytable.id
-						comment = "Updated comment after migration"
-						data_object_type = "TABLE"
-					}
-					object {
-						name = databricks_table.mytable_2.id
-						comment = "Second shared table"
-						data_object_type = "TABLE"
-						cdf_enabled = false
-					}
-				}`,
-		},
-	)
-}

internal/providers/pluginfw/products/sharing/resource_share.go

@@ -140,7 +140,7 @@ type ShareResource struct {
 }
 
 func (r *ShareResource) Metadata(ctx context.Context, req resource.MetadataRequest, resp *resource.MetadataResponse) {
-	resp.TypeName = pluginfwcommon.GetDatabricksProductionName(resourceName)
+	resp.TypeName = pluginfwcommon.GetDatabricksStagingName(resourceName)
 }
 
 func (r *ShareResource) Schema(ctx context.Context, req resource.SchemaRequest, resp *resource.SchemaResponse) {