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.

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: rich error for unmet view dependencies #10940

Merged
merged 3 commits into from
Aug 15, 2022

Conversation

shlomi-noach
Copy link
Contributor

Description

This PR turns the flat ErrViewDependencyUnresolved error into a richer ViewDependencyUnresolvedError, indicating the identity of the view in question.

Existing tests adapted to new error type.

Related Issue(s)

Checklist

  • "Backport me!" label has been added if this change should be backported
  • Tests were added or are not required
  • Documentation was added or is not required

Deployment Notes

Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>
@shlomi-noach shlomi-noach added Type: Enhancement Logical improvement (somewhere between a bug and feature) Component: Query Serving labels Aug 4, 2022
@shlomi-noach shlomi-noach requested a review from dbussink August 4, 2022 13:57
@vitess-bot
Copy link
Contributor

vitess-bot bot commented Aug 4, 2022

Review Checklist

Hello reviewers! 👋 Please follow this checklist when reviewing this Pull Request.

General

  • Ensure that the Pull Request has a descriptive title.
  • If this is a change that users need to know about, please apply the release notes (needs details) label so that merging is blocked unless the summary release notes document is included.
  • If a new flag is being introduced, review whether it is really needed. The flag names should be clear and intuitive (as far as possible), and the flag's help should be descriptive.
  • If a workflow is added or modified, each items in Jobs should be named in order to mark it as required. If the workflow should be required, the GitHub Admin should be notified.

Bug fixes

  • There should be at least one unit or end-to-end test.
  • The Pull Request description should either include a link to an issue that describes the bug OR an actual description of the bug and how to reproduce, along with a description of the fix.

Non-trivial changes

  • There should be some code comments as to why things are implemented the way they are.

New/Existing features

  • Should be documented, either by modifying the existing documentation or creating new documentation.
  • New features should have a link to a feature request issue or an RFC that documents the use cases, corner cases and test cases.

Backward compatibility

  • Protobuf changes should be wire-compatible.
  • Changes to _vt tables and RPCs need to be backward compatible.
  • vtctl command output order should be stable and awk-able.

Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>
@@ -239,3 +238,11 @@ func (e *InvalidColumnInForeignKeyConstraintError) Error() string {
return fmt.Sprintf("invalid column %s referenced by foreign key constraint %s in table %s",
sqlescape.EscapeID(e.Column), sqlescape.EscapeID(e.Constraint), sqlescape.EscapeID(e.Table))
}

type ViewDependencyUnresolvedError struct {
View string
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we also here have a reference to the entity it tries to refer to? Like if a another table / view is missing, we'd also know the name here as well?

We could then further improve the error to "view %s references unknown entity %s" or something along those lines?

And maybe different from having a loop and have a separate error type for that?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

So the way we detect these dependencies is by creating a connected graph, and then looking at "what's outside the graph". We don't explicitly then check which tables/views are referenced by the left-out views. We could definitely do that.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@dbussink let's iterate on that in a followup PR though, if that's OK

Copy link
Contributor

Choose a reason for hiding this comment

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

Yeah, we can improve on a further iteration.

return ErrViewDependencyUnresolved
for _, v := range s.views {
if _, ok := dependencyLevels[v.Name()]; !ok {
// We _know_ that in this iteration, at least one view is found unassugned a dependency level.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
// We _know_ that in this iteration, at least one view is found unassugned a dependency level.
// We _know_ that in this iteration, at least one view is found unassigned a dependency level.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

fixed

Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>
@@ -239,3 +238,11 @@ func (e *InvalidColumnInForeignKeyConstraintError) Error() string {
return fmt.Sprintf("invalid column %s referenced by foreign key constraint %s in table %s",
sqlescape.EscapeID(e.Column), sqlescape.EscapeID(e.Constraint), sqlescape.EscapeID(e.Table))
}

type ViewDependencyUnresolvedError struct {
View string
Copy link
Contributor

Choose a reason for hiding this comment

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

Yeah, we can improve on a further iteration.

@shlomi-noach shlomi-noach merged commit ccec4f4 into vitessio:main Aug 15, 2022
@shlomi-noach shlomi-noach deleted the schemadiff-views-rich-errors branch August 15, 2022 06:46
systay pushed a commit to planetscale/vitess that referenced this pull request Aug 19, 2022
…itessio#959)

* schemadiff: rich error for unmet view dependencies

Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>

* grammar

Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>

* typo

Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>

Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>

Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Query Serving Type: Enhancement Logical improvement (somewhere between a bug and feature)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants