cleanup a bit

databricks · Jan 6, 2025 · 57a7519 · 57a7519
1 parent 4743095
commit 57a7519
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 12 deletions.
diff --git a/libs/template/resolver_test.go b/libs/template/resolver_test.go
@@ -50,7 +50,7 @@ func TestTemplateResolverForDefaultTemplates(t *testing.T) {
 		require.NoError(t, err)
 
 		assert.Equal(t, &builtinReader{name: name}, tmpl.Reader)
-		assert.IsType(t, &writerWithTelemetry{}, tmpl.Writer)
+		assert.IsType(t, &writerWithFullTelemetry{}, tmpl.Writer)
 	}
 
 	r := Resolver{
@@ -63,7 +63,7 @@ func TestTemplateResolverForDefaultTemplates(t *testing.T) {
 
 	// Assert reader and writer configuration
 	assert.Equal(t, "https://github.com/databricks/mlops-stacks", tmpl.Reader.(*gitReader).gitUrl)
-	assert.Equal(t, "/config/file", tmpl.Writer.(*writerWithTelemetry).configPath)
+	assert.Equal(t, "/config/file", tmpl.Writer.(*writerWithFullTelemetry).configPath)
 }
 
 func TestTemplateResolverForCustomUrl(t *testing.T) {

diff --git a/libs/template/template.go b/libs/template/template.go
@@ -39,33 +39,33 @@ var allTemplates = []Template{
 		name:        DefaultPython,
 		description: "The default Python template for Notebooks / Delta Live Tables / Workflows",
 		Reader:      &builtinReader{name: "default-python"},
-		Writer:      &writerWithTelemetry{},
+		Writer:      &writerWithFullTelemetry{},
 	},
 	{
 		name:        DefaultSql,
 		description: "The default SQL template for .sql files that run with Databricks SQL",
 		Reader:      &builtinReader{name: "default-sql"},
-		Writer:      &writerWithTelemetry{},
+		Writer:      &writerWithFullTelemetry{},
 	},
 	{
 		name:        DbtSql,
 		description: "The dbt SQL template (databricks.com/blog/delivering-cost-effective-data-real-time-dbt-and-databricks)",
 		Reader:      &builtinReader{name: "dbt-sql"},
-		Writer:      &writerWithTelemetry{},
+		Writer:      &writerWithFullTelemetry{},
 	},
 	{
 		name:        MlopsStacks,
 		description: "The Databricks MLOps Stacks template (github.com/databricks/mlops-stacks)",
 		aliases:     []string{"mlops-stack"},
 		Reader:      &gitReader{gitUrl: "https://github.com/databricks/mlops-stacks", cloneFunc: git.Clone},
-		Writer:      &writerWithTelemetry{},
+		Writer:      &writerWithFullTelemetry{},
 	},
 	{
 		name:        DefaultPydabs,
 		hidden:      true,
 		description: "The default PyDABs template",
 		Reader:      &gitReader{gitUrl: "https://databricks.github.io/workflows-authoring-toolkit/pydabs-template.git", cloneFunc: git.Clone},
-		Writer:      &writerWithTelemetry{},
+		Writer:      &writerWithFullTelemetry{},
 	},
 	{
 		name:        Custom,

diff --git a/libs/template/template_test.go b/libs/template/template_test.go
@@ -56,7 +56,7 @@ func TestTemplateTelemetryIsCapturedForAllDefaultTemplates(t *testing.T) {
 		} else {
 			// Assert telemetry is captured for all other templates, i.e. templates
 			// owned by databricks.
-			assert.IsType(t, &writerWithTelemetry{}, w)
+			assert.IsType(t, &writerWithFullTelemetry{}, w)
 		}
 	}
 }

diff --git a/libs/template/writer.go b/libs/template/writer.go
@@ -152,15 +152,15 @@ func (tmpl *defaultWriter) Materialize(ctx context.Context, reader Reader) error
 }
 
 func (tmpl *defaultWriter) LogTelemetry(ctx context.Context) error {
-	// no-op
+	// TODO, only log the template name and uuid.
 	return nil
 }
 
-type writerWithTelemetry struct {
+type writerWithFullTelemetry struct {
 	defaultWriter
 }
 
-func (tmpl *writerWithTelemetry) LogTelemetry(ctx context.Context) error {
-	// Log telemetry. TODO.
+func (tmpl *writerWithFullTelemetry) LogTelemetry(ctx context.Context) error {
+	// TODO, log template name, uuid and enum args as well.``
 	return nil
 }