feat: modpacks

.gitattributes

@@ -0,0 +1,9 @@
+# Auto detect text files and perform LF normalization
+#	This keeps unix/windows machines from wanting to change every file
+#	from the other because of the line ending (\r vs \r\n)
+* text=auto
+*.sh text eol=lf
+*.env* text eol=lf
+
+# Atlas migration hashes are different if file get windows line endings
+*.sql text eol=lf

.github/workflows/generated.yml

@@ -43,3 +43,4 @@ jobs:
 
       - name: Ensure no changes
         run: git diff --exit-code
+

.mise/tasks/import_staging_dump.sh

@@ -0,0 +1,25 @@
+#!/bin/bash
+
+CONTAINER="smr-api-postgres-1"
+URL="https://storage.ficsit.app/file/smr-db-dumps/staging-dump.sql"
+
+echo -e "WARNING: This will wipe your local database and import a fresh staging dump."
+read -p "Are you sure you want to proceed? (y/N): " confirm
+
+if [[ $confirm != [yY] && $confirm != [yY][eE][sS] ]]; then
+    echo "Import cancelled."
+    exit 0
+fi
+
+echo "---"
+echo "Wiping existing data for a clean slate..."
+docker exec -i $CONTAINER psql -U postgres -c "DROP SCHEMA public CASCADE; CREATE SCHEMA public;"
+
+echo "Downloading and importing staging dump from Ficsit Storage..."
+# Using curl to stream the SQL directly into psql
+curl -sSL "$URL" | docker exec -i $CONTAINER psql -U postgres
+
+echo -e "Import complete! Run 'mise run api'."
+
+echo "Press any key to exit..."
+read -n 1 -s

README.md

@@ -61,6 +61,8 @@ mise run api
 # Testing
 mise run localtest
 mise run coverage
+mise run populate  # Runs test to create mods and modpacks
+mise run load_staging_dump
 
 # Linting
 mise run lint
@@ -151,12 +153,23 @@ See `config/config.go` for full configuration structure.
    mise run test   # Run tests
    ```
 
+### Using Staging Dumps
+
+   `mise run load_staging_dump`
+   This command runs before adding the most
+   recently saved dump of the staging database on the network. Once the file runs, local migrations will run
+   when executing `mise run api`. This is useful to check if your changes will break the
+   data currently in the database.
+
+Windows users, if you get annoyed by the constant firewall block prompts Go creates,
+you can silence them by [temporarily adjusting your notification settings](https://serverfault.com/a/1198657/982905).
+
 ## Contributing
 
 **Before submitting:**
 
 ```bash
-mise run lint     # Check code quality
+mise run format   # Automatically fix code quality problems and report those that need manual correction
 mise run test     # Run test suite
 mise run generate # Regenerate if needed
 ```
@@ -167,4 +180,4 @@ mise run generate # Regenerate if needed
 - Implement GraphQL resolvers for complex queries
 - Use Temporal workflows for background processing
 - Follow structured logging with `slog`
-- Use context for request tracing
+- Use context for request tracing

api/api.go

@@ -156,6 +156,8 @@ func Setup(ctx context.Context) *echo.Echo {
 	nodes.RegisterModRoutes(v1.Group("/mod"))
 	nodes.RegisterModsRoutes(v1.Group("/mods"))
 	nodes.RegisterVersionRoutes(v1.Group("/version"))
+	nodes.RegisterModpackRoutes(v1.Group("/modpack"))
+	nodes.RegisterModpacksRoutes(v1.Group("/modpacks"))
 
 	v2 := e.Group("/v2")
 

codecov.yml

@@ -6,3 +6,4 @@ coverage:
 
 ignore:
   - "generated"
+  - "db/schema"

conversion/ent_to_graphql.go

@@ -47,7 +47,7 @@ type SatisfactoryVersion interface {
 // goverter:output:package conv
 // goverter:extend TimeToString
 type User interface {
-	// goverter:ignore Roles Groups Mods Guides
+	// goverter:ignore Roles Groups Mods Guides Modpacks
 	Convert(source *ent.User) *generated.User
 	ConvertSlice(source []*ent.User) []*generated.User
 }
@@ -82,6 +82,16 @@ type UserMod interface {
 	ConvertSlice(source []*ent.UserMod) []*generated.UserMod
 }
 
+// goverter:converter
+// goverter:output:file ../generated/conv/user_modpack.go
+// goverter:output:package conv
+// goverter:extend TimeToString
+type UserModpack interface {
+	// goverter:ignore User Modpack
+	Convert(source *ent.UserModpack) *generated.UserModpack
+	ConvertSlice(source []*ent.UserModpack) []*generated.UserModpack
+}
+
 // goverter:converter
 // goverter:output:file ../generated/conv/mod.go
 // goverter:output:package conv
@@ -127,6 +137,64 @@ type VirustotalResult interface {
 	ConvertSlice(source []*ent.VirustotalResult) []*generated.VirustotalResult
 }
 
+// goverter:converter
+// goverter:output:file ../generated/conv/modpack.go
+// goverter:output:package conv
+// goverter:extend TimeToString UIntToInt Int64ToInt EntModpackReleaseToGenerated
+type Modpack interface {
+	// goverter:map Edges.Tags Tags
+	// goverter:map Edges.ModpackMods Mods
+	// goverter:map Edges.Parent Parent
+	// goverter:map Edges.Releases Releases
+	// goverter:map Edges.Children Children
+	// goverter:ignore Creator Authors
+	Convert(source *ent.Modpack) *generated.Modpack
+	ConvertSlice(source []*ent.Modpack) []*generated.Modpack
+}
+
+func EntModpackReleaseToGenerated(source *ent.ModpackRelease) *generated.ModpackRelease {
+	if source == nil {
+		return nil
+	}
+	targets := make([]*generated.ModpackTarget, len(source.Edges.Targets))
+	for i, t := range source.Edges.Targets {
+		targets[i] = &generated.ModpackTarget{
+			ID:         t.ID,
+			ReleaseID:  source.ID,
+			TargetName: t.TargetName,
+		}
+	}
+	return &generated.ModpackRelease{
+		ID:        source.ID,
+		Version:   source.Version,
+		CreatedAt: source.CreatedAt.Format(time.RFC3339),
+		Lockfile:  source.Lockfile,
+		Changelog: source.Changelog,
+		Targets:   targets,
+	}
+}
+
+// goverter:converter
+// goverter:output:file ../generated/conv/modpack_release.go
+// goverter:output:package conv
+// goverter:extend TimeToString EntModpackTargetToGenerated
+type ModpackRelease interface {
+	// goverter:map Edges.Targets Targets
+	Convert(source *ent.ModpackRelease) *generated.ModpackRelease
+	ConvertSlice(source []*ent.ModpackRelease) []*generated.ModpackRelease
+}
+
+func EntModpackTargetToGenerated(source *ent.ModpackTarget) *generated.ModpackTarget {
+	if source == nil {
+		return nil
+	}
+	return &generated.ModpackTarget{
+		ID:         source.ID,
+		ReleaseID:  source.VersionID,
+		TargetName: source.TargetName,
+	}
+}
+
 func TimeToString(i time.Time) string {
 	return i.Format(time.RFC3339)
 }

dataloader/loaders.go

@@ -12,6 +12,7 @@ import (
 	"github.com/satisfactorymodding/smr-api/generated/ent"
 	"github.com/satisfactorymodding/smr-api/generated/ent/user"
 	"github.com/satisfactorymodding/smr-api/generated/ent/usermod"
+	"github.com/satisfactorymodding/smr-api/generated/ent/usermodpack"
 	"github.com/satisfactorymodding/smr-api/generated/ent/version"
 	"github.com/satisfactorymodding/smr-api/generated/ent/versiondependency"
 )
@@ -22,6 +23,7 @@ type Loaders struct {
 	UserByID                       *dataloader.Loader[string, *ent.User]
 	VersionDependenciesByVersionID *dataloader.Loader[string, []*ent.VersionDependency]
 	UserModsByModID                *dataloader.Loader[string, []*ent.UserMod]
+	UserModpacksByModpackID        *dataloader.Loader[string, []*ent.UserModpack]
 	VersionsByModID                *dataloader.Loader[string, []*ent.Version]
 	VersionsByModIDNoMeta          *dataloader.Loader[string, []*ent.Version]
 }
@@ -76,6 +78,29 @@ func Middleware() func(handlerFunc echo.HandlerFunc) echo.HandlerFunc {
 
 					return results
 				}, dataloader.WithCache[string, []*ent.UserMod](&dataloader.NoCache[string, []*ent.UserMod]{})),
+				UserModpacksByModpackID: dataloader.NewBatchedLoader(func(ctx context.Context, ids []string) []*dataloader.Result[[]*ent.UserModpack] {
+					// TODO Query only selected fields from context
+					entities, err := db.From(ctx).UserModpack.Query().Where(usermodpack.ModpackIDIn(ids...)).All(ctx)
+					if err != nil {
+						return nil
+					}
+
+					byID := map[string][]*ent.UserModpack{}
+					for _, entity := range entities {
+						byID[entity.ModpackID] = append(byID[entity.ModpackID], entity)
+					}
+
+					results := make([]*dataloader.Result[[]*ent.UserModpack], len(ids))
+					for i, id := range ids {
+						if u, ok := byID[id]; ok {
+							results[i] = &dataloader.Result[[]*ent.UserModpack]{Data: u}
+						} else {
+							results[i] = &dataloader.Result[[]*ent.UserModpack]{Error: errors.New("modpack not found")}
+						}
+					}
+
+					return results
+				}, dataloader.WithCache[string, []*ent.UserModpack](&dataloader.NoCache[string, []*ent.UserModpack]{})),
 				VersionsByModID: dataloader.NewBatchedLoader(func(ctx context.Context, ids []string) []*dataloader.Result[[]*ent.Version] {
 					// TODO Query only selected fields from context
 					entities, err := db.From(ctx).Version.Query().WithTargets().Where(

db/modpack.go

@@ -0,0 +1,71 @@
+package db
+
+import (
+	"strings"
+
+	"entgo.io/ent/dialect/sql"
+
+	"github.com/satisfactorymodding/smr-api/generated"
+	"github.com/satisfactorymodding/smr-api/generated/ent"
+	"github.com/satisfactorymodding/smr-api/generated/ent/modpack"
+	"github.com/satisfactorymodding/smr-api/generated/ent/tag"
+	"github.com/satisfactorymodding/smr-api/models"
+)
+
+func ConvertModpackFilter(query *ent.ModpackQuery, filter *models.ModpackFilter, count bool) *ent.ModpackQuery {
+	if len(filter.IDs) > 0 {
+		query = query.Where(modpack.IDIn(filter.IDs...))
+	} else if filter != nil {
+		if !count {
+			query = query.
+				Limit(*filter.Limit).
+				Offset(*filter.Offset)
+		}
+
+		if filter.OrderBy != nil && *filter.OrderBy != generated.ModpackFieldsSearch {
+			query = query.Order(sql.OrderByField(
+				filter.OrderBy.String(),
+				OrderToOrder(filter.Order.String()),
+			).ToFunc())
+		}
+
+		if filter.Search != nil && *filter.Search != "" {
+			cleanSearch := strings.ReplaceAll(strings.TrimSpace(*filter.Search), " ", " & ")
+
+			query = query.Where(func(s *sql.Selector) {
+				join := sql.Select("id")
+				join = join.AppendSelectExprAs(
+					sql.P(func(builder *sql.Builder) {
+						builder.WriteString("similarity(name, ").Arg(cleanSearch).WriteString(") * 2").
+							WriteString(" + ").
+							WriteString("similarity(short_description, ").Arg(cleanSearch).WriteString(")").
+							WriteString(" + ").
+							WriteString("similarity(full_description, ").Arg(cleanSearch).WriteString(") * 0.5")
+					}),
+					"s",
+				)
+				join.From(sql.Table(modpack.Table)).As("t1")
+				s.Join(join).On(s.C(modpack.FieldID), join.C("id"))
+			})
+
+			query = query.Where(func(s *sql.Selector) {
+				s.Where(sql.ExprP(`"t1"."s" > 0.2`))
+			})
+
+			if !count && *filter.OrderBy == generated.ModpackFieldsSearch {
+				query = query.Order(func(s *sql.Selector) {
+					s.OrderExpr(sql.ExprP(`"t1"."s" DESC`))
+				})
+			}
+		}
+
+		if filter.Hidden == nil || !(*filter.Hidden) {
+			query = query.Where(modpack.Hidden(false))
+		}
+
+		if len(filter.TagIDs) > 0 {
+			query = query.Where(modpack.HasTagsWith(tag.IDIn(filter.TagIDs...)))
+		}
+	}
+	return query
+}

db/schema/mod.go

@@ -63,5 +63,8 @@ func (Mod) Edges() []ent.Edge {
 		edge.From("dependents", Version.Type).
 			Ref("dependencies").
 			Through("version_dependencies", VersionDependency.Type),
+		edge.From("modpacks", Modpack.Type).
+			Ref("mods").
+			Through("modpack_mods", ModpackMod.Type),
 	}
 }

db/schema/modpack.go

@@ -0,0 +1,64 @@
+package schema
+
+import (
+	"entgo.io/ent"
+	"entgo.io/ent/dialect/entsql"
+	"entgo.io/ent/schema/edge"
+	"entgo.io/ent/schema/field"
+
+	"github.com/satisfactorymodding/smr-api/util"
+)
+
+type Modpack struct {
+	ent.Schema
+}
+
+func (Modpack) Mixin() []ent.Mixin {
+	return []ent.Mixin{
+		IDMixin{},
+		TimeMixin{},
+		SoftDeleteMixin{},
+	}
+}
+
+func (Modpack) Fields() []ent.Field {
+	return []ent.Field{
+		field.String("name"),
+		field.String("short_description").MaxLen(128),
+		field.String("full_description"),
+		field.String("logo").Optional(),
+		field.String("logo_thumbhash").Optional(),
+		field.String("creator_id"),
+		field.Uint("views").Default(0),
+		field.Uint("hotness").Default(0),
+		field.Uint("installs").Default(0),
+		field.Uint("popularity").Default(0),
+		field.Bool("hidden").Default(false),
+		field.JSON("compatibility", &util.CompatibilityInfo{}).Optional(),
+		field.String("parent_id").Optional().Immutable(),
+	}
+}
+
+func (Modpack) Edges() []ent.Edge {
+	return []ent.Edge{
+		edge.To("children", Modpack.Type).
+			Annotations(entsql.OnDelete(entsql.Restrict)),
+		edge.From("parent", Modpack.Type).
+			Ref("children").
+			Field("parent_id").
+			Unique().
+			Immutable().
+			Annotations(entsql.OnDelete(entsql.Restrict)),
+		edge.To("releases", ModpackRelease.Type).
+			Annotations(entsql.OnDelete(entsql.Cascade)),
+		edge.To("mods", Mod.Type).
+			Through("modpack_mods", ModpackMod.Type).
+			Annotations(entsql.OnDelete(entsql.Cascade)),
+		edge.From("authors", User.Type).
+			Ref("modpacks").
+			Through("user_modpacks", UserModpack.Type),
+		edge.To("tags", Tag.Type).
+			Through("modpack_tags", ModpackTag.Type).
+			Annotations(entsql.OnDelete(entsql.Cascade)),
+	}
+}