Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

schemadiff: ViewDependencyUnresolvedError lists missing referenced entities #17711

Merged
merged 3 commits into from
Feb 6, 2025
+37 −7
Merged

schemadiff: ViewDependencyUnresolvedError lists missing referenced entities #17711

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3a238d1
schemadiff: ViewDependencyUnresolvedError lists missing referenced en…
shlomi-noach Feb 6, 2025
7221c51
using string builder
shlomi-noach Feb 6, 2025
11d6a38
Use fprintf directly
dbussink Feb 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions go/vt/schemadiff/errors.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -389,11 +389,20 @@ func (e *IndexNeededByForeignKeyError) Error() string {
}

type ViewDependencyUnresolvedError struct {
View string
View string
MissingReferencedEntities []string
}

func (e *ViewDependencyUnresolvedError) Error() string {
return fmt.Sprintf("view %s has unresolved/loop dependencies", sqlescape.EscapeID(e.View))
var b strings.Builder
fmt.Fprintf(&b, "view %s has unresolved/loop dependencies: ", sqlescape.EscapeID(e.View))
for i, entity := range e.MissingReferencedEntities {
if i > 0 {
b.WriteString(", ")
}
sqlescape.WriteEscapeID(&b, entity)
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we do this loop, we can already add them to a buffer here as well?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How do you mean add them to a buffer?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Something like this (not actually validated, but for the idea):

var buf strings.Builder
for i, entity := range e.MissingReferencedEntities {
    if i > 0 {
           buf.WriteString(", ")
    }
    sqlescape.WriteEscapeID(&buf, entity)
}

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

return b.String()
}

type InvalidColumnReferencedInViewError struct {
Expand Down
9 changes: 8 additions & 1 deletion go/vt/schemadiff/schema.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -341,7 +341,14 @@ func (s *Schema) normalize(hints *DiffHints) error {
if _, ok := dependencyLevels[v.Name()]; !ok {
// We _know_ that in this iteration, at least one view is found unassigned a dependency level.
// We gather all the errors.
errs = errors.Join(errs, &ViewDependencyUnresolvedError{View: v.ViewName.Name.String()})
dependentNames := getViewDependentTableNames(v.CreateView)
missingReferencedEntities := []string{}
for _, name := range dependentNames {
if _, ok := dependencyLevels[name]; !ok {
missingReferencedEntities = append(missingReferencedEntities, name)
}
}
errs = errors.Join(errs, &ViewDependencyUnresolvedError{View: v.ViewName.Name.String(), MissingReferencedEntities: missingReferencedEntities})
// We still add it so it shows up in the output if that is used for anything.
s.sorted = append(s.sorted, v)
}
Expand Down
22 changes: 18 additions & 4 deletions go/vt/schemadiff/schema_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,12 +119,26 @@ func TestNewSchemaFromQueriesUnresolved(t *testing.T) {
)
schema, err := NewSchemaFromQueries(NewTestEnv(), queries)
assert.Error(t, err)
assert.EqualError(t, err, (&ViewDependencyUnresolvedError{View: "v7"}).Error())
assert.EqualError(t, err, (&ViewDependencyUnresolvedError{View: "v7", MissingReferencedEntities: []string{"v8"}}).Error())
v := schema.sorted[len(schema.sorted)-1]
assert.IsType(t, &CreateViewEntity{}, v)
assert.Equal(t, "CREATE VIEW `v7` AS SELECT * FROM `v8`, `t2`", v.Create().CanonicalStatementString())
}

func TestNewSchemaFromQueriesUnresolvedMulti(t *testing.T) {
// v8 does not exist
queries := append(schemaTestCreateQueries,
"create view v7 as select * from v8, t2, t20, v21",
)
schema, err := NewSchemaFromQueries(NewTestEnv(), queries)
assert.Error(t, err)
assert.EqualError(t, err, (&ViewDependencyUnresolvedError{View: "v7", MissingReferencedEntities: []string{"v8", "t20", "v21"}}).Error())
assert.Equal(t, "view `v7` has unresolved/loop dependencies: `v8`, `t20`, `v21`", err.Error())
v := schema.sorted[len(schema.sorted)-1]
assert.IsType(t, &CreateViewEntity{}, v)
assert.Equal(t, "CREATE VIEW `v7` AS SELECT * FROM `v8`, `t2`, `t20`, `v21`", v.Create().CanonicalStatementString())
}

func TestNewSchemaFromQueriesWithSQLKeyword(t *testing.T) {
queries := []string{
"create table `order` (id int primary key, info int not null)",
Expand All @@ -141,7 +155,7 @@ func TestNewSchemaFromQueriesUnresolvedAlias(t *testing.T) {
)
_, err := NewSchemaFromQueries(NewTestEnv(), queries)
assert.Error(t, err)
assert.EqualError(t, err, (&ViewDependencyUnresolvedError{View: "v7"}).Error())
assert.EqualError(t, err, (&ViewDependencyUnresolvedError{View: "v7", MissingReferencedEntities: []string{"something_else"}}).Error())
}

func TestNewSchemaFromQueriesViewFromDual(t *testing.T) {
Expand Down Expand Up @@ -171,7 +185,7 @@ func TestNewSchemaFromQueriesLoop(t *testing.T) {
_, err := NewSchemaFromQueries(NewTestEnv(), queries)
require.Error(t, err)
err = vterrors.UnwrapFirst(err)
assert.EqualError(t, err, (&ViewDependencyUnresolvedError{View: "v7"}).Error())
assert.EqualError(t, err, (&ViewDependencyUnresolvedError{View: "v7", MissingReferencedEntities: []string{"v8"}}).Error())
}

func TestToSQL(t *testing.T) {
Expand Down Expand Up @@ -582,7 +596,7 @@ SELECT
) AS ranking
FROM users AS u JOIN earnings AS e ON e.user_id = u.id;
`,
expectErr: &ViewDependencyUnresolvedError{View: "user_earnings_ranking"},
expectErr: &ViewDependencyUnresolvedError{View: "user_earnings_ranking", MissingReferencedEntities: []string{"earnings"}},
},
}
for _, ts := range tt {
Expand Down
Loading