Skip to content

feat: Add better changes summary helper #2240

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

Merged
kodiakhq merged 2 commits into from
Jul 28, 2025
Merged

feat: Add better changes summary helper #2240

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a0f5225
feat: Add better changes summary helper
erezrokah Jul 28, 2025
cf6a20d
fix: Improve formatting
erezrokah Jul 28, 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
96 changes: 96 additions & 0 deletions schema/table.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,11 @@ import (
"fmt"
"regexp"
"slices"
"strings"

"github.com/apache/arrow-go/v18/arrow"
"github.com/cloudquery/plugin-sdk/v4/glob"
"github.com/samber/lo"
"github.com/thoas/go-funk"
)

Expand Down Expand Up @@ -258,6 +260,100 @@ func (t TableColumnChange) String() string {
}
}

func getColumnChangeSummary(change TableColumnChange) string {
switch change.Type {
case TableColumnChangeTypeAdd:
if change.Current.PrimaryKey {
return fmt.Sprintf("Column %q added with type %q and primary key constraint", change.ColumnName, change.Current.Type)
Copy link
Copy Markdown
Member

@disq disq Jul 28, 2025

Choose a reason for hiding this comment

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

What happens if a column has more than one property at the same time? (Incremental, not null. etc.)
Maybe add constraints as strings into a string slice and return a single line combining all with strings.Join

Column %q added with type %q and primary key constraint, not null constraint, as an incremental key

Copy link
Copy Markdown
Member Author

@erezrokah erezrokah Jul 28, 2025

Choose a reason for hiding this comment

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

Yeah thought about that, but I would say it's not interesting for the sake of the summary. If you have a new PK column it's "breaking enough" that we don't need to show the other changes

Copy link
Copy Markdown
Member Author

@erezrokah erezrokah Jul 28, 2025

Choose a reason for hiding this comment

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

A new PK is always not null and unique I think

Copy link
Copy Markdown
Member

@disq disq Jul 28, 2025

Choose a reason for hiding this comment

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

So these are always sorted in order of importance.

Copy link
Copy Markdown
Member Author

@erezrokah erezrokah Jul 28, 2025

Choose a reason for hiding this comment

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

So these are always sorted in order of importance.

In order of what I thought we should show first 🙃

}
if change.Current.Unique {
return fmt.Sprintf("Column %q added with type %q and unique constraint", change.ColumnName, change.Current.Type)
}
if change.Current.NotNull {
return fmt.Sprintf("Column %q added with type %q and not null constraint", change.ColumnName, change.Current.Type)
}
if change.Current.IncrementalKey {
return fmt.Sprintf("Column %q added with type %q and as an incremental key", change.ColumnName, change.Current.Type)
}
return fmt.Sprintf("Column %q added with type %q", change.ColumnName, change.Current.Type)
case TableColumnChangeTypeUpdate:
if change.Previous.Type != change.Current.Type {
return fmt.Sprintf("Type changed from %q to %q for column %q", change.Previous.Type, change.Current.Type, change.ColumnName)
}
if !change.Previous.PrimaryKey && change.Current.PrimaryKey {
return fmt.Sprintf("Primary key constraint added to column %q", change.ColumnName)
}
if change.Previous.PrimaryKey && !change.Current.PrimaryKey {
return fmt.Sprintf("Primary key constraint removed from column %q", change.ColumnName)
}
if !change.Previous.Unique && change.Current.Unique {
return fmt.Sprintf("Unique constraint added to column %q", change.ColumnName)
}
if change.Previous.Unique && !change.Current.Unique {
return fmt.Sprintf("Unique constraint removed from column %q", change.ColumnName)
}
if !change.Previous.NotNull && change.Current.NotNull {
return fmt.Sprintf("Not null constraint added to column %q", change.ColumnName)
}
if change.Previous.NotNull && !change.Current.NotNull {
return fmt.Sprintf("Not null constraint removed from column %q", change.ColumnName)
}
if !change.Previous.IncrementalKey && change.Current.IncrementalKey {
return fmt.Sprintf("Column %q added as an incremental key", change.ColumnName)
}
if change.Previous.IncrementalKey && !change.Current.IncrementalKey {
return fmt.Sprintf("Column %q removed as an incremental key", change.ColumnName)
}
if !change.Previous.PrimaryKeyComponent && change.Current.PrimaryKeyComponent {
return fmt.Sprintf("Primary key component condition added to column %q", change.ColumnName)
}
if change.Previous.PrimaryKeyComponent && !change.Current.PrimaryKeyComponent {
return fmt.Sprintf("Primary key component condition removed from column %q", change.ColumnName)
}
return fmt.Sprintf("Column %q updated. Previous: %s, Current: %s", change.ColumnName, change.Previous, change.Current)
case TableColumnChangeTypeRemove:
if change.Previous.PrimaryKey {
return fmt.Sprintf("Primary key column %q removed", change.ColumnName)
}
if change.Previous.Unique {
return fmt.Sprintf("Unique column %q removed", change.ColumnName)
}
if change.Previous.NotNull {
return fmt.Sprintf("Not null column %q removed", change.ColumnName)
}
if change.Previous.IncrementalKey {
return fmt.Sprintf("Incremental key column %q removed", change.ColumnName)
}
return fmt.Sprintf("Column %q with type %q removed", change.ColumnName, change.Previous.Type)
case TableColumnChangeTypeRemoveUniqueConstraint:
return fmt.Sprintf("Unique constraint removed from column %q", change.ColumnName)
case TableColumnChangeTypeMoveToCQOnly:
return fmt.Sprintf("Primary key columns removed and replaced with a single column %q with type %q", change.ColumnName, change.Current.Type)
default:
return fmt.Sprintf("column: %s, type: %s, current: %s, previous: %s", change.ColumnName, change.Type, change.Current, change.Previous)
}
}

func GetChangesSummary(tablesChanges map[string][]TableColumnChange) string {
tables := lo.Keys(tablesChanges)
slices.Sort(tables)
summary := strings.Builder{}
for i, table := range tables {
summary.WriteString(fmt.Sprintf("%s:\n", table))
changes := tablesChanges[table]
changesString := lo.Map(changes, func(change TableColumnChange, _ int) string {
return fmt.Sprintf(" - %s", getColumnChangeSummary(change))
})
slices.Sort(changesString)
summary.WriteString(strings.Join(changesString, "\n"))
if i < len(tables)-1 {
summary.WriteString("\n\n")
}
}

return summary.String()
}

func (tt Tables) FilterDfsFunc(include, exclude func(*Table) bool, skipDependentTables bool) Tables {
filteredTables := make(Tables, 0, len(tt))
for _, t := range tt {
Expand Down
Loading