[feature] add support for receiving federated status edits (#3597)

* add support for extracting Updated field from Statusable implementers

* add support for status edits in the database, and update status dereferencer to handle them

* remove unused AdditionalInfo{}.CreatedAt

* remove unused AdditionalEmojiInfo{}.CreatedAt

* update new mention creation to use status.UpdatedAt

* remove mention.UpdatedAt, fixes related to NewULIDFromTime() change

* add migration to remove Mention{}.UpdatedAt field

* add migration to add the StatusEdit{} table

* start adding tests, add delete function for status edits

* add more of status edit migrations, fill in more of the necessary edit delete functionality

* remove unused function

* allow generating gotosocial compatible ulid via CLI with `go run ./cmd/gen-ulid`

* add StatusEdit{} test models

* fix new statusedits sql

* use model instead of table name

* actually remove the Mention.UpdatedAt field...

* fix tests now new models are added, add more status edit DB tests

* fix panic wording

* add test for deleting status edits

* don't automatically set `updated_at` field on updated statuses

* flesh out more of the dereferencer status edit tests, ensure updated at field set on outgoing AS statuses

* remove media_attachments.updated_at column

* fix up more tests, further complete the dereferencer status edit tests

* update more status serialization tests not expecting 'updated' AS property

* gah!! json serialization tests!!

* undo some gtscontext wrapping changes

* more serialization test fixing :smiling_face_with_tear:

* more test fixing, ensure the edit.status_id field is actually set :facepalm:

* fix status edit test

* grrr linter

* add edited_at field to apimodel status

* remove the choice of paging on the timeline public filtered test (otherwise it needs updating every time you add statuses ...)

* ensure that status.updated_at always fits chronologically

* fix more serialization tests ...

* add more code comments

* fix envparsing

* update swagger file

* properly handle media description changes during status edits

* slight formatting tweak

* code comment

1 files changed, 168 insertions, 0 deletions

diff --git a/internal/db/bundb/statusedit_test.go b/internal/db/bundb/statusedit_test.go
new file mode 100644
index 000000000..b6a15e825
--- /dev/null
+++ b/internal/db/bundb/statusedit_test.go
@@ -0,0 +1,168 @@
+// GoToSocial
+// Copyright (C) GoToSocial Authors admin@gotosocial.org
+// SPDX-License-Identifier: AGPL-3.0-or-later
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU Affero General Public License for more details.
+//
+// You should have received a copy of the GNU Affero General Public License
+// along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+package bundb_test
+
+import (
+	"context"
+	"errors"
+	"reflect"
+	"slices"
+	"testing"
+	"time"
+
+	"github.com/stretchr/testify/suite"
+	"github.com/superseriousbusiness/gotosocial/internal/gtsmodel"
+)
+
+type StatusEditTestSuite struct {
+	BunDBStandardTestSuite
+}
+
+func (suite *StatusEditTestSuite) TestGetStatusEditBy() {
+	t := suite.T()
+
+	// Create a new context for this test.
+	ctx, cncl := context.WithCancel(context.Background())
+	defer cncl()
+
+	// Sentinel error to mark avoiding a test case.
+	sentinelErr := errors.New("sentinel")
+
+	for _, edit := range suite.testStatusEdits {
+		for lookup, dbfunc := range map[string]func() (*gtsmodel.StatusEdit, error){
+			"id": func() (*gtsmodel.StatusEdit, error) {
+				return suite.db.GetStatusEditByID(ctx, edit.ID)
+			},
+		} {
+			// Clear database caches.
+			suite.state.Caches.Init()
+
+			t.Logf("checking database lookup %q", lookup)
+
+			// Perform database function.
+			checkEdit, err := dbfunc()
+			if err != nil {
+				if err == sentinelErr {
+					continue
+				}
+
+				t.Errorf("error encountered for database lookup %q: %v", lookup, err)
+				continue
+			}
+
+			// Check received account data.
+			if !areEditsEqual(edit, checkEdit) {
+				t.Errorf("edit does not contain expected data: %+v", checkEdit)
+				continue
+			}
+		}
+	}
+}
+
+func (suite *StatusEditTestSuite) TestGetStatusEditsByIDs() {
+	t := suite.T()
+
+	// Create a new context for this test.
+	ctx, cncl := context.WithCancel(context.Background())
+	defer cncl()
+
+	// editsByStatus returns all test edits by the given status with ID.
+	editsByStatus := func(status *gtsmodel.Status) []*gtsmodel.StatusEdit {
+		var edits []*gtsmodel.StatusEdit
+		for _, edit := range suite.testStatusEdits {
+			if edit.StatusID == status.ID {
+				edits = append(edits, edit)
+			}
+		}
+		return edits
+	}
+
+	for _, status := range suite.testStatuses {
+		// Get test status edit models
+		// that should be found for status.
+		check := editsByStatus(status)
+
+		// Fetch edits for the slice of IDs attached to status from database.
+		edits, err := suite.state.DB.GetStatusEditsByIDs(ctx, status.EditIDs)
+		suite.NoError(err)
+
+		// Ensure both slices
+		// sorted the same.
+		sortEdits(check)
+		sortEdits(edits)
+
+		// Check whether slices of status edits match.
+		if !slices.EqualFunc(check, edits, areEditsEqual) {
+			t.Error("status edit slices do not match")
+		}
+	}
+}
+
+func (suite *StatusEditTestSuite) TestDeleteStatusEdits() {
+	// Create a new context for this test.
+	ctx, cncl := context.WithCancel(context.Background())
+	defer cncl()
+
+	for _, status := range suite.testStatuses {
+		// Delete all edits for status with given IDs from database.
+		err := suite.state.DB.DeleteStatusEdits(ctx, status.EditIDs)
+		suite.NoError(err)
+
+		// Now attempt to fetch these edits from database, should be empty.
+		edits, err := suite.state.DB.GetStatusEditsByIDs(ctx, status.EditIDs)
+		suite.NoError(err)
+		suite.Empty(edits)
+	}
+}
+
+func TestStatusEditTestSuite(t *testing.T) {
+	suite.Run(t, new(StatusEditTestSuite))
+}
+
+func areEditsEqual(e1, e2 *gtsmodel.StatusEdit) bool {
+	// Clone the 1st status edit.
+	e1Copy := new(gtsmodel.StatusEdit)
+	*e1Copy = *e1
+	e1 = e1Copy
+
+	// Clone the 2nd status edit.
+	e2Copy := new(gtsmodel.StatusEdit)
+	*e2Copy = *e2
+	e2 = e2Copy
+
+	// Clear populated sub-models.
+	e1.Attachments = nil
+	e2.Attachments = nil
+
+	// Clear database-set fields.
+	e1.CreatedAt = time.Time{}
+	e2.CreatedAt = time.Time{}
+
+	return reflect.DeepEqual(*e1, *e2)
+}
+
+func sortEdits(edits []*gtsmodel.StatusEdit) {
+	slices.SortFunc(edits, func(a, b *gtsmodel.StatusEdit) int {
+		if a.CreatedAt.Before(b.CreatedAt) {
+			return +1
+		} else if b.CreatedAt.Before(a.CreatedAt) {
+			return -1
+		}
+		return 0
+	})
+}