@shortlink-org/portolan 0.1.0 → 0.2.1

package/plugins/extract-sql/lineage.go

@@ -1,107 +0,0 @@
-package main
-
-// Where a column's value came from, when it came from somewhere else.
-//
-// A view says this in its own select and needs no help. A table cannot: a
-// column copied from another service's row - the address the warehouse keeps
-// beside the order it belongs to - is a copy made by code, and the migration
-// that creates the column is the only place the fact can be written down where
-// it will be read.
-//
-// So it is declared, in the one form a migration already has for saying
-// something to a person:
-//
-//	-- from: shop.oms.pg.orders.ship_to
-//	ship_to text NOT NULL,
-//
-// The grammar drops comments, so this is read off the text. A line naming a
-// column of this store may leave the store out - `orders.ship_to` - and the
-// store's own id is put back on; anything else is taken as written, which is
-// how a copy from another service's schema is spelled.
-
-import (
-	"regexp"
-	"strings"
-)
-
-var (
-	createTable = regexp.MustCompile(`(?i)^\s*create\s+table\s+(?:if\s+not\s+exists\s+)?"?([\w.]+)"?`)
-	fromComment = regexp.MustCompile(`(?i)^\s*--\s*from:\s*(.+?)\s*$`)
-	columnLine  = regexp.MustCompile(`^\s*"?(\w+)"?\s+\S`)
-)
-
-// readCopies reads the `-- from:` lines of one migration, as table -> column ->
-// the ids the value was copied from.
-func readCopies(sql, storeID string) map[string]map[string][]string {
-	out := map[string]map[string][]string{}
-
-	table := ""
-	var pending []string
-
-	for _, line := range strings.Split(sql, "\n") {
-		if found := createTable.FindStringSubmatch(line); found != nil {
-			table = unqualified(found[1])
-			pending = nil
-
-			continue
-		}
-		if strings.HasPrefix(strings.TrimSpace(line), ")") {
-			table = ""
-			pending = nil
-
-			continue
-		}
-		if found := fromComment.FindStringSubmatch(line); found != nil {
-			for _, id := range strings.Split(found[1], ",") {
-				id = strings.TrimSpace(id)
-				if id == "" {
-					continue
-				}
-				// A column of this store may be named without it.
-				if strings.Count(id, ".") == 1 {
-					id = storeID + "." + id
-				}
-				pending = append(pending, id)
-			}
-
-			continue
-		}
-		if table == "" || len(pending) == 0 {
-			continue
-		}
-		if found := columnLine.FindStringSubmatch(line); found != nil {
-			column := strings.ToLower(found[1])
-			if isConstraintWord(column) {
-				pending = nil
-
-				continue
-			}
-			if out[table] == nil {
-				out[table] = map[string][]string{}
-			}
-			out[table][column] = pending
-			pending = nil
-		}
-	}
-
-	return out
-}
-
-// isConstraintWord tells a column definition from the table-level clauses that
-// look like one.
-func isConstraintWord(word string) bool {
-	switch word {
-	case "primary", "unique", "foreign", "constraint", "check", "exclude", "like":
-		return true
-	}
-
-	return false
-}
-
-func unqualified(name string) string {
-	if at := strings.LastIndex(name, "."); at >= 0 {
-		return name[at+1:]
-	}
-
-	return name
-}

package/plugins/extract-sql/main.go

@@ -1,141 +0,0 @@
-// Package main is portolan-extract-sql: the migrations of a service in, a
-// catalog fragment describing where its state lives out.
-//
-// It reads the DDL with PostgreSQL's own grammar ported to Go, so it needs no
-// database, no Docker and no external binary - the same property every other
-// extractor here has, and the reason this does not shell out to a migration
-// tool to be told what the files build.
-package main
-
-import (
-	"encoding/json"
-	"fmt"
-	"io"
-	"os"
-	"path/filepath"
-
-	"github.com/shortlink-org/portolan/catalog"
-	"github.com/shortlink-org/portolan/plugin"
-)
-
-// Options are what the manifest tells the extractor: the things the migrations
-// themselves do not say about the estate they belong to.
-type Options struct {
-	Context string `json:"context"`
-	Service string `json:"service"`
-
-	// Store names the database these migrations build. One service can keep
-	// state in more than one, and a slug is how the two are told apart.
-	Store string `json:"store,omitempty"`
-	Name  string `json:"name,omitempty"`
-	Kind  string `json:"kind,omitempty"`
-
-	// Repositories optionally pins where adapters live, relative to the input
-	// root. Empty discovers horizontal and feature-sliced layouts.
-	Repositories string `json:"repositories,omitempty"`
-	// Projectors does the same for projection adapters.
-	Projectors string `json:"projectors,omitempty"`
-
-	Out string `json:"out,omitempty"`
-}
-
-func main() {
-	if err := run(os.Stdin, os.Stdout); err != nil {
-		fmt.Fprintln(os.Stderr, "portolan-extract-sql:", err)
-		os.Exit(1)
-	}
-}
-
-func run(stdin io.Reader, stdout io.Writer) error {
-	return plugin.Serve(stdin, stdout, descriptor(), func(req plugin.Request, opts Options) (plugin.Response, error) {
-		if req.Input.Root == "" {
-			return plugin.Response{}, fmt.Errorf("no input root: an extractor has nothing to read")
-		}
-
-		return extract(req.Input, opts), nil
-	})
-}
-
-func extract(in plugin.Input, opts Options) plugin.Response {
-	b := &plugin.Builder{}
-	root := in.Root
-
-	if opts.Context == "" {
-		opts.Context = filepath.Base(root)
-	}
-	if opts.Service == "" {
-		opts.Service = filepath.Base(root)
-	}
-	if opts.Store == "" {
-		opts.Store = "pg"
-	}
-	if opts.Kind == "" {
-		opts.Kind = string(catalog.StoreKindPostgres)
-	}
-	owner := opts.Context + "." + opts.Service
-	storeID := owner + "." + opts.Store
-	layout := discoverStorageLayout(root, opts.Repositories, opts.Projectors)
-
-	tables, views := readStore(root, layout, storeID, owner, b)
-	resolveForeignKeys(storeID, tables, b)
-	foreignSchemas(root, modulePath(root), b, storeID)
-
-	fragment := catalog.Catalog{
-		GeneratedAt: in.GeneratedAt,
-		Commit:      in.Commit,
-		Contexts: []catalog.BoundedContext{{
-			ID:   opts.Context,
-			Slug: opts.Context,
-			// Only the link from the service to its store. What the service is
-			// called, and what it holds, belong to the extractors that read
-			// those things.
-			Services: []catalog.Service{{
-				ID:         owner,
-				Slug:       opts.Service,
-				Provides:   []catalog.RpcService{},
-				Consumes:   []catalog.RpcCall{},
-				Aggregates: []catalog.Aggregate{},
-				Stores:     []string{storeID},
-			}},
-		}},
-		Defs:  map[string]catalog.TypeDef{},
-		Flows: []catalog.Flow{},
-		Adrs:  []catalog.Adr{},
-	}
-
-	if len(tables) == 0 {
-		b.Warn(storeID, "no repository or projector migrations found; the service is described as keeping no state")
-	} else {
-		fragment.Stores = []catalog.Store{{
-			ID:     storeID,
-			Slug:   opts.Store,
-			Name:   firstNonEmpty(opts.Name, opts.Service+" database"),
-			Kind:   catalog.StoreKind(opts.Kind),
-			Owner:  owner,
-			Source: layout.source,
-			Tables: tables,
-			Views:  views,
-		}}
-	}
-
-	encoded, err := json.MarshalIndent(fragment, "", "  ")
-	if err != nil {
-		b.Warn(storeID, "the fragment could not be encoded: "+err.Error())
-
-		return b.Response()
-	}
-
-	b.File(firstNonEmpty(opts.Out, "stores.json"), string(encoded)+"\n")
-
-	return b.Response()
-}
-
-func firstNonEmpty(values ...string) string {
-	for _, value := range values {
-		if value != "" {
-			return value
-		}
-	}
-
-	return ""
-}