chore: Propose additional debug logging (#2243)

Author: sfc-gh-asawicki

README.md

@@ -132,6 +132,12 @@ Some links that might help you:
 - **If you are an enterprise customer**, reach out to your account team. This helps us prioritize issues.
 - The [issues section](https://github.com/Snowflake-Labs/terraform-provider-snowflake/issues) might already have an issue addressing your question.
 
+## Additional debug logs for `snowflake_grant_privileges_to_role` resource
+Set environment variable `SF_TF_ADDITIONAL_DEBUG_LOGGING` to a non-empty value. Additional logs will be visible with `sf-tf-additional-debug` prefix, e.g.:
+```text
+2023/12/08 12:58:22.497078 sf-tf-additional-debug [DEBUG] Creating new client from db
+```
+
 ## Contributing
 
 Cf. [Contributing](./CONTRIBUTING.md).

pkg/internal/logging/debug_helpers.go

@@ -0,0 +1,20 @@
+package logging
+
+import (
+	"io"
+	"log"
+	"os"
+)
+
+func init() {
+	additionalDebugLoggingEnabled = os.Getenv("SF_TF_ADDITIONAL_DEBUG_LOGGING") != ""
+	DebugLogger = log.New(os.Stderr, "sf-tf-additional-debug ", log.LstdFlags|log.Lmsgprefix|log.LUTC|log.Lmicroseconds)
+	if !additionalDebugLoggingEnabled {
+		DebugLogger.SetOutput(io.Discard)
+	}
+}
+
+var (
+	additionalDebugLoggingEnabled bool
+	DebugLogger                   *log.Logger
+)

pkg/resources/grant_privileges_to_role.go

@@ -7,13 +7,12 @@ import (
 	"strings"
 	"testing"
 
-	"github.com/Snowflake-Labs/terraform-provider-snowflake/pkg/sdk"
-	"github.com/hashicorp/terraform-plugin-testing/helper/acctest"
-	"github.com/hashicorp/terraform-plugin-testing/terraform"
-
 	acc "github.com/Snowflake-Labs/terraform-provider-snowflake/pkg/acceptance"
+	"github.com/Snowflake-Labs/terraform-provider-snowflake/pkg/sdk"
 	"github.com/hashicorp/terraform-plugin-testing/config"
+	"github.com/hashicorp/terraform-plugin-testing/helper/acctest"
 	"github.com/hashicorp/terraform-plugin-testing/helper/resource"
+	"github.com/hashicorp/terraform-plugin-testing/terraform"
 	"github.com/hashicorp/terraform-plugin-testing/tfversion"
 )
 

pkg/resources/schema_acceptance_test.go

@@ -1,6 +1,10 @@
 package sdk
 
-import "context"
+import (
+	"context"
+
+	"github.com/Snowflake-Labs/terraform-provider-snowflake/pkg/internal/logging"
+)
 
 var _ Grants = (*grants)(nil)
 
@@ -9,22 +13,26 @@ type grants struct {
 }
 
 func (v *grants) GrantPrivilegesToAccountRole(ctx context.Context, privileges *AccountRoleGrantPrivileges, on *AccountRoleGrantOn, role AccountObjectIdentifier, opts *GrantPrivilegesToAccountRoleOptions) error {
+	logging.DebugLogger.Printf("[DEBUG] Grant privileges to account role")
 	if opts == nil {
 		opts = &GrantPrivilegesToAccountRoleOptions{}
 	}
 	opts.privileges = privileges
 	opts.on = on
 	opts.accountRole = role
+	logging.DebugLogger.Printf("[DEBUG] Grant privileges to account role: opts %+v", opts)
 	return validateAndExec(v.client, ctx, opts)
 }
 
 func (v *grants) RevokePrivilegesFromAccountRole(ctx context.Context, privileges *AccountRoleGrantPrivileges, on *AccountRoleGrantOn, role AccountObjectIdentifier, opts *RevokePrivilegesFromAccountRoleOptions) error {
+	logging.DebugLogger.Printf("[DEBUG] Revoke privileges from account role")
 	if opts == nil {
 		opts = &RevokePrivilegesFromAccountRoleOptions{}
 	}
 	opts.privileges = privileges
 	opts.on = on
 	opts.accountRole = role
+	logging.DebugLogger.Printf("[DEBUG] Revoke privileges from account role: opts %+v", opts)
 	return validateAndExec(v.client, ctx, opts)
 }
 
@@ -76,14 +84,19 @@ func (v *grants) GrantOwnership(ctx context.Context, on OwnershipGrantOn, to Own
 }
 
 func (v *grants) Show(ctx context.Context, opts *ShowGrantOptions) ([]Grant, error) {
+	logging.DebugLogger.Printf("[DEBUG] Show grants")
 	if opts == nil {
 		opts = &ShowGrantOptions{}
 	}
 
+	logging.DebugLogger.Printf("[DEBUG] Show grants: opts %+v", opts)
 	dbRows, err := validateAndQuery[grantRow](v.client, ctx, opts)
+	logging.DebugLogger.Printf("[DEBUG] Show grants: query finished err = %v", err)
 	if err != nil {
 		return nil, err
 	}
+	logging.DebugLogger.Printf("[DEBUG] Show grants: converting rows")
 	resultList := convertRows[grantRow, Grant](dbRows)
+	logging.DebugLogger.Printf("[DEBUG] Show grants: rows converted")
 	return resultList, nil
 }

pkg/sdk/grants_impl.go

@@ -508,7 +508,7 @@ type TableExternalTableColumnRenameActionRequest struct {
 }
 
 type TableExternalTableColumnDropActionRequest struct {
-	Columns  []string //required
+	Columns  []string // required
 	IfExists *bool
 }
 

pkg/sdk/tables_dto.go

@@ -673,20 +673,20 @@ func (s *DropTableRequest) WithRestrict(restrict *bool) *DropTableRequest {
 }
 
 func NewTableAddRowAccessPolicyRequest(
-	RowAccessPolicy SchemaObjectIdentifier,
-	On []string,
+	rowAccessPolicy SchemaObjectIdentifier,
+	on []string,
 ) *TableAddRowAccessPolicyRequest {
 	s := TableAddRowAccessPolicyRequest{}
-	s.RowAccessPolicy = RowAccessPolicy
-	s.On = On
+	s.RowAccessPolicy = rowAccessPolicy
+	s.On = on
 	return &s
 }
 
 func NewTableDropRowAccessPolicyRequest(
-	RowAccessPolicy SchemaObjectIdentifier,
+	rowAccessPolicy SchemaObjectIdentifier,
 ) *TableDropRowAccessPolicyRequest {
 	s := TableDropRowAccessPolicyRequest{}
-	s.RowAccessPolicy = RowAccessPolicy
+	s.RowAccessPolicy = rowAccessPolicy
 	return &s
 }