importer

type Detection struct {
	Kind    string   `json:"kind"`
	Version string   `json:"version"`
	Notes   []string `json:"notes"`
	Schemas []string `json:"schemas"`
	// SourceUsers counts the source auth users seen at detection; --plan uses it to run the
	// same auth.users preflight as the real run.
	SourceUsers int `json:"source_users,omitempty"`
	// Objects lists the bucket/key pairs a bundle source will load, for the --plan object-store check.
	// It never reaches the report: keys can be user file names.
	Objects []portable.Object `json:"-"`
}

type Extracted struct {
	Stage                string
	UntranslatedPolicies []Policy
}

type FlagSpec struct {
	Name, Usage string
	EnvVarName  bool
}

type HasuraReport struct {
	Equal bool              `json:"equal"`
	Diffs []verify.Mismatch `json:"diffs"`
}

type Input struct {
	Values map[string]string
	Env    func(string) string
	Target *config.Config
}

type Policy struct {
	Table  string `json:"table"`
	Policy string `json:"policy"`
	Reason string `json:"reason"`
}

type Report struct {
	Source               string        `json:"source"`
	RunID                string        `json:"run_id"`
	Result               string        `json:"result"`
	Tables               []TableReport `json:"tables"`
	Users                UsersReport   `json:"users"`
	Storage              StorageReport `json:"storage"`
	Hasura               HasuraReport  `json:"hasura"`
	UntranslatedPolicies []Policy      `json:"untranslated_policies"`
	// CompatShims names the source objects the bundle's db/compat.sql re-creates in the target.
	CompatShims []string             `json:"compat_shims"`
	Exemptions  []portable.Exemption `json:"exemptions"`
	Mismatches  []verify.Mismatch    `json:"mismatches"`
	Steps       []string             `json:"steps,omitempty"`
	// Wrote is true once the target may have changed; LastStep is the last finished load step.
	Wrote     bool       `json:"wrote"`
	LastStep  string     `json:"last_step,omitempty"`
	Detection *Detection `json:"detection,omitempty"`
}

type ResetUser struct {
	ID    string `json:"id"`
	Email string `json:"email"`
}

type RunOptions struct {
	ProjectDir                   string
	Plan, KeepStage, SkipStorage bool
}

type Source interface {
	Name() string
	Flags() []FlagSpec
	Detect(context.Context, Input) (Detection, error)
	Extract(context.Context, Input, string) (Extracted, error)
}

type StorageReport struct {
	SourceObjects int  `json:"source_objects"`
	TargetObjects int  `json:"target_objects"`
	Equal         bool `json:"equal"`
}

type TableReport struct {
	Schema     string `json:"schema"`
	Name       string `json:"name"`
	SourceRows int64  `json:"source_rows"`
	TargetRows int64  `json:"target_rows"`
	Equal      bool   `json:"equal"`
}

type UsersReport struct {
	Source        int         `json:"source"`
	Target        int         `json:"target"`
	Equal         bool        `json:"equal"`
	ResetRequired []ResetUser `json:"reset_required"`
}