chore: deprecate project schema version (#66)

d-bytebase · web-flow · commit ed15ccf60c09 · 2023-07-18T00:27:23.000+08:00
diff --git a/.gitignore b/.gitignore
@@ -40,3 +40,6 @@ override.tf.json
 # Ignore CLI configuration files
 .terraformrc
 terraform.rc
+
+# Ignore docs overview
+docs/assets/overview.webp
diff --git a/api/project.go b/api/project.go
@@ -30,18 +30,6 @@ const (
 	ProjectTenantModeEnabled ProjectTenantMode = "TENANT_MODE_ENABLED"
 )
 
-// ProjectSchemaVersion is the schema version type for project.
-type ProjectSchemaVersion string
-
-const (
-	// ProjectSchemaVersionTimestamp is the timestamp schema version type in the project.
-	ProjectSchemaVersionTimestamp ProjectSchemaVersion = "TIMESTAMP"
-	// ProjectSchemaVersionSemantic is the semantic schema version type in the project.
-	ProjectSchemaVersionSemantic ProjectSchemaVersion = "SEMANTIC"
-	// ProjectSchemaVersionUnspecified is the unspecified schema version type in the project.
-	ProjectSchemaVersionUnspecified ProjectSchemaVersion = "SCHEMA_VERSION_UNSPECIFIED"
-)
-
 // ProjectSchemaChange is the schema change type for project.
 type ProjectSchemaChange string
 
@@ -54,16 +42,15 @@ const (
 
 // ProjectMessage is the API message for project.
 type ProjectMessage struct {
-	Name           string               `json:"name"`
-	Title          string               `json:"title"`
-	Key            string               `json:"key"`
-	Workflow       ProjectWorkflow      `json:"workflow"`
-	Visibility     ProjectVisibility    `json:"visibility"`
-	TenantMode     ProjectTenantMode    `json:"tenantMode"`
-	DBNameTemplate string               `json:"dbNameTemplate"`
-	SchemaVersion  ProjectSchemaVersion `json:"schemaVersion"`
-	SchemaChange   ProjectSchemaChange  `json:"schemaChange"`
-	State          State                `json:"state,omitempty"`
+	Name           string              `json:"name"`
+	Title          string              `json:"title"`
+	Key            string              `json:"key"`
+	Workflow       ProjectWorkflow     `json:"workflow"`
+	Visibility     ProjectVisibility   `json:"visibility"`
+	TenantMode     ProjectTenantMode   `json:"tenantMode"`
+	DBNameTemplate string              `json:"dbNameTemplate"`
+	SchemaChange   ProjectSchemaChange `json:"schemaChange"`
+	State          State               `json:"state,omitempty"`
 }
 
 // ListProjectMessage is the API message for list project response.
diff --git a/docs/data-sources/project.md b/docs/data-sources/project.md
@@ -21,6 +21,7 @@ The project data source.
 
 ### Read-Only
 
+- `databases` (List of Object) The databases in the project. (see [below for nested schema](#nestedatt--databases))
 - `db_name_template` (String) The project db name template.
 - `id` (String) The ID of this resource.
 - `key` (String) The project key.
@@ -30,16 +31,17 @@ The project data source.
 - `title` (String) The project title.
 - `visibility` (String) The project visibility.
 - `workflow` (String) The project workflow.
-- `databases` (Block List) The databases in the project. (see [below for nested schema](#nestedblock--databases))
 
-<a id="nestedblock--databases"></a>
+<a id="nestedatt--databases"></a>
 ### Nested Schema for `databases`
 
-#### Read-Only
+Read-Only:
+
+- `instance` (String)
+- `labels` (Map of String)
+- `name` (String)
+- `schema_version` (String)
+- `successful_sync_time` (String)
+- `sync_state` (String)
+
 
-- `instance` (String) The instance resource id for the database.
-- `name` (String) The database name.
-- `labels` (Map of String) The  deployment and policy control labels.
-- `schema_version` (String) The version of database schema.
-- `successful_sync_time` (String) The latest synchronization time.
-- `sync_state` (String) The existence of a database on latest sync.
diff --git a/docs/data-sources/project_list.md b/docs/data-sources/project_list.md
@@ -29,6 +29,7 @@ The project data source list.
 
 Read-Only:
 
+- `databases` (List of Object) (see [below for nested schema](#nestedobjatt--projects--databases))
 - `db_name_template` (String)
 - `key` (String)
 - `resource_id` (String)
@@ -38,16 +39,17 @@ Read-Only:
 - `title` (String)
 - `visibility` (String)
 - `workflow` (String)
-- `databases` (Block List) The databases in the project. (see [below for nested schema](#nestedblock--databases))
 
-<a id="nestedblock--databases"></a>
-### Nested Schema for `databases`
+<a id="nestedobjatt--projects--databases"></a>
+### Nested Schema for `projects.databases`
+
+Read-Only:
+
+- `instance` (String)
+- `labels` (Map of String)
+- `name` (String)
+- `schema_version` (String)
+- `successful_sync_time` (String)
+- `sync_state` (String)
 
-#### Read-Only
 
-- `instance` (String) The instance resource id for the database.
-- `name` (String) The database name.
-- `labels` (Map of String) The  deployment and policy control labels.
-- `schema_version` (String) The version of database schema.
-- `successful_sync_time` (String) The latest synchronization time.
-- `sync_state` (String) The existence of a database on latest sync.
diff --git a/docs/resources/project.md b/docs/resources/project.md
@@ -20,36 +20,36 @@ The project resource.
 - `key` (String) The project unique key.
 - `resource_id` (String) The project unique resource id. Cannot change this after created.
 - `schema_change` (String) The project schema change type.
-- `schema_version` (String) The project schema version type. Cannot change this after created.
 - `title` (String) The project title.
 - `workflow` (String) The project workflow.
 
 ### Optional
 
+- `databases` (Block List) The databases in the project. (see [below for nested schema](#nestedblock--databases))
 - `db_name_template` (String) The project db name template.
 - `tenant_mode` (String) The project tenant mode.
 - `visibility` (String) The project visibility. Cannot change this after created
-- `databases` (Block List) The databases in the project. (see [below for nested schema](#nestedblock--databases))
 
 ### Read-Only
 
 - `id` (String) The ID of this resource.
 
-
 <a id="nestedblock--databases"></a>
 ### Nested Schema for `databases`
 
-#### Required
+Required:
 
 - `instance` (String) The instance resource id for the database.
 - `name` (String) The database name.
 
-#### Optional
+Optional:
 
 - `labels` (Map of String) The  deployment and policy control labels.
 
-#### Read-Only
+Read-Only:
 
 - `schema_version` (String) The version of database schema.
 - `successful_sync_time` (String) The latest synchronization time.
 - `sync_state` (String) The existence of a database on latest sync.
+
+
diff --git a/provider/data_source_project.go b/provider/data_source_project.go
@@ -156,9 +156,6 @@ func setProjectWithDatabases(d *schema.ResourceData, project *api.ProjectMessage
 	if err := d.Set("db_name_template", project.DBNameTemplate); err != nil {
 		return diag.Errorf("cannot set db_name_template for project: %s", err.Error())
 	}
-	if err := d.Set("schema_version", project.SchemaVersion); err != nil {
-		return diag.Errorf("cannot set schema_version for project: %s", err.Error())
-	}
 	if err := d.Set("schema_change", project.SchemaChange); err != nil {
 		return diag.Errorf("cannot set schema_change for project: %s", err.Error())
 	}
diff --git a/provider/data_source_project_list.go b/provider/data_source_project_list.go
@@ -147,7 +147,6 @@ func dataSourceProjectListRead(ctx context.Context, d *schema.ResourceData, m in
 		proj["visibility"] = project.Visibility
 		proj["tenant_mode"] = project.TenantMode
 		proj["db_name_template"] = project.DBNameTemplate
-		proj["schema_version"] = project.SchemaVersion
 		proj["schema_change"] = project.SchemaChange
 
 		filter := fmt.Sprintf(`project == "%s"`, project.Name)
diff --git a/provider/data_source_project_list_test.go b/provider/data_source_project_list_test.go
@@ -29,7 +29,7 @@ func TestAccProjectListDataSource(t *testing.T) {
 				0,
 			),
 			internal.GetTestStepForDataSourceList(
-				testAccCheckProjectResource(identifier, "dev-project", "dev project", "BYT", api.ProjectWorkflowUI, api.ProjectSchemaVersionSemantic, api.ProjectSchemaChangeDDL),
+				testAccCheckProjectResource(identifier, "dev-project", "dev project", "BYT", api.ProjectWorkflowUI, api.ProjectSchemaChangeDDL),
 				fmt.Sprintf("bytebase_project.%s", identifier),
 				"bytebase_project_list",
 				"after",
diff --git a/provider/data_source_project_test.go b/provider/data_source_project_test.go
@@ -29,7 +29,7 @@ func TestAccProjectDataSource(t *testing.T) {
 			// get single project test
 			{
 				Config: testAccCheckProjectDataSource(
-					testAccCheckProjectResource(identifier, resourceID, title, key, api.ProjectWorkflowUI, api.ProjectSchemaVersionSemantic, api.ProjectSchemaChangeDDL),
+					testAccCheckProjectResource(identifier, resourceID, title, key, api.ProjectWorkflowUI, api.ProjectSchemaChangeDDL),
 					resourceName,
 					identifier,
 					resourceID,
@@ -39,7 +39,6 @@ func TestAccProjectDataSource(t *testing.T) {
 					resource.TestCheckResourceAttr(resourceName, "title", title),
 					resource.TestCheckResourceAttr(resourceName, "key", key),
 					resource.TestCheckResourceAttr(resourceName, "workflow", string(api.ProjectWorkflowUI)),
-					resource.TestCheckResourceAttr(resourceName, "schema_version", string(api.ProjectSchemaVersionSemantic)),
 					resource.TestCheckResourceAttr(resourceName, "schema_change", string(api.ProjectSchemaChangeDDL)),
 				),
 			},
diff --git a/provider/internal/mock_client.go b/provider/internal/mock_client.go
@@ -578,7 +578,6 @@ func (c *mockClient) CreateProject(_ context.Context, projectID string, project
 		Visibility:     project.Visibility,
 		TenantMode:     project.TenantMode,
 		DBNameTemplate: project.DBNameTemplate,
-		SchemaVersion:  project.SchemaVersion,
 		SchemaChange:   project.SchemaChange,
 	}
 
diff --git a/provider/resource_project.go b/provider/resource_project.go
@@ -79,16 +79,6 @@ func resourceProjct() *schema.Resource {
 				Optional:    true,
 				Description: "The project db name template.",
 			},
-			"schema_version": {
-				Type:     schema.TypeString,
-				Optional: true,
-				ValidateFunc: validation.StringInSlice([]string{
-					string(api.ProjectSchemaVersionTimestamp),
-					string(api.ProjectSchemaVersionSemantic),
-					string(api.ProjectSchemaVersionUnspecified),
-				}, false),
-				Description: "The project schema version type. Cannot change this after created.",
-			},
 			"schema_change": {
 				Type:     schema.TypeString,
 				Required: true,
@@ -158,7 +148,6 @@ func resourceProjectCreate(ctx context.Context, d *schema.ResourceData, m interf
 	dbNameTemplate := d.Get("db_name_template").(string)
 	schemaChange := api.ProjectSchemaChange(d.Get("schema_change").(string))
 	visibility := api.ProjectVisibility(d.Get("visibility").(string))
-	schemaVersion := api.ProjectSchemaVersion(d.Get("schema_version").(string))
 
 	existedProject, err := c.GetProject(ctx, projectID, true /* showDeleted */)
 	if err != nil {
@@ -181,14 +170,6 @@ func resourceProjectCreate(ctx context.Context, d *schema.ResourceData, m interf
 			})
 			return diags
 		}
-		if existedProject.SchemaVersion != schemaVersion {
-			diags = append(diags, diag.Diagnostic{
-				Severity: diag.Error,
-				Summary:  "Invalid argument",
-				Detail:   fmt.Sprintf("cannot update project %s schema_version to %s", projectName, schemaVersion),
-			})
-			return diags
-		}
 
 		if existedProject.State == api.Deleted {
 			diags = append(diags, diag.Diagnostic{
@@ -237,7 +218,6 @@ func resourceProjectCreate(ctx context.Context, d *schema.ResourceData, m interf
 			Visibility:     visibility,
 			TenantMode:     tenantMode,
 			DBNameTemplate: dbNameTemplate,
-			SchemaVersion:  schemaVersion,
 			SchemaChange:   schemaChange,
 		})
 		if err != nil {
diff --git a/provider/resource_project_test.go b/provider/resource_project_test.go
@@ -30,25 +30,23 @@ func TestAccProject(t *testing.T) {
 		Steps: []resource.TestStep{
 			// resource create
 			{
-				Config: testAccCheckProjectResource(identifier, resourceID, title, key, api.ProjectWorkflowUI, api.ProjectSchemaVersionSemantic, api.ProjectSchemaChangeDDL),
+				Config: testAccCheckProjectResource(identifier, resourceID, title, key, api.ProjectWorkflowUI, api.ProjectSchemaChangeDDL),
 				Check: resource.ComposeTestCheckFunc(
 					internal.TestCheckResourceExists(resourceName),
 					resource.TestCheckResourceAttr(resourceName, "title", title),
 					resource.TestCheckResourceAttr(resourceName, "key", key),
 					resource.TestCheckResourceAttr(resourceName, "workflow", string(api.ProjectWorkflowUI)),
-					resource.TestCheckResourceAttr(resourceName, "schema_version", string(api.ProjectSchemaVersionSemantic)),
 					resource.TestCheckResourceAttr(resourceName, "schema_change", string(api.ProjectSchemaChangeDDL)),
 				),
 			},
 			// resource updated
 			{
-				Config: testAccCheckProjectResource(identifier, resourceID, titleUpdated, key, api.ProjectWorkflowVCS, api.ProjectSchemaVersionSemantic, api.ProjectSchemaChangeSDL),
+				Config: testAccCheckProjectResource(identifier, resourceID, titleUpdated, key, api.ProjectWorkflowVCS, api.ProjectSchemaChangeSDL),
 				Check: resource.ComposeTestCheckFunc(
 					internal.TestCheckResourceExists(resourceName),
 					resource.TestCheckResourceAttr(resourceName, "title", titleUpdated),
 					resource.TestCheckResourceAttr(resourceName, "key", key),
 					resource.TestCheckResourceAttr(resourceName, "workflow", string(api.ProjectWorkflowVCS)),
-					resource.TestCheckResourceAttr(resourceName, "schema_version", string(api.ProjectSchemaVersionSemantic)),
 					resource.TestCheckResourceAttr(resourceName, "schema_change", string(api.ProjectSchemaChangeSDL)),
 				),
 			},
@@ -77,17 +75,16 @@ func testAccCheckProjectDestroy(s *terraform.State) error {
 	return nil
 }
 
-func testAccCheckProjectResource(identifier, resourceID, title, key string, workflow api.ProjectWorkflow, schemaVersion api.ProjectSchemaVersion, schemaChange api.ProjectSchemaChange) string {
+func testAccCheckProjectResource(identifier, resourceID, title, key string, workflow api.ProjectWorkflow, schemaChange api.ProjectSchemaChange) string {
 	return fmt.Sprintf(`
 	resource "bytebase_project" "%s" {
 		resource_id    = "%s"
 		title          = "%s"
 		key            = "%s"
 		workflow       = "%s"
-		schema_version = "%s"
 		schema_change  = "%s"
 		tenant_mode    = "TENANT_MODE_DISABLED"
 		visibility     = "VISIBILITY_PUBLIC"
 	}
-	`, identifier, resourceID, title, key, workflow, schemaVersion, schemaChange)
+	`, identifier, resourceID, title, key, workflow, schemaChange)
 }

Original file line number	Diff line number	Diff line change
`@@ -156,9 +156,6 @@ func setProjectWithDatabases(d schema.ResourceData, project api.ProjectMessage`
`156`	`156`	`if err := d.Set("db_name_template", project.DBNameTemplate); err != nil {`
`157`	`157`	`return diag.Errorf("cannot set db_name_template for project: %s", err.Error())`
`158`	`158`	`}`
`159`		`- if err := d.Set("schema_version", project.SchemaVersion); err != nil {`
`160`		`- return diag.Errorf("cannot set schema_version for project: %s", err.Error())`
`161`		`- }`
`162`	`159`	`if err := d.Set("schema_change", project.SchemaChange); err != nil {`
`163`	`160`	`return diag.Errorf("cannot set schema_change for project: %s", err.Error())`
`164`	`161`	`}`
Original file line number	Diff line number	Diff line change
`@@ -578,7 +578,6 @@ func (c *mockClient) CreateProject(_ context.Context, projectID string, project`
`578`	`578`	`Visibility: project.Visibility,`
`579`	`579`	`TenantMode: project.TenantMode,`
`580`	`580`	`DBNameTemplate: project.DBNameTemplate,`
`581`		`- SchemaVersion: project.SchemaVersion,`
`582`	`581`	`SchemaChange: project.SchemaChange,`
`583`	`582`	`}`
`584`	`583`