GoToSocial/internal/processing/fromclientapi_test.go

// 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 processing_test

import (
	"context"
	"encoding/json"
	"testing"

	"github.com/stretchr/testify/suite"
	"github.com/superseriousbusiness/gotosocial/internal/ap"
	apimodel "github.com/superseriousbusiness/gotosocial/internal/api/model"
	"github.com/superseriousbusiness/gotosocial/internal/db"
	"github.com/superseriousbusiness/gotosocial/internal/gtsmodel"
	"github.com/superseriousbusiness/gotosocial/internal/messages"
	"github.com/superseriousbusiness/gotosocial/internal/stream"
	"github.com/superseriousbusiness/gotosocial/testrig"
)

type FromClientAPITestSuite struct {
	ProcessingStandardTestSuite
}

func (suite *FromClientAPITestSuite) TestProcessStreamNewStatus() {
	ctx := context.Background()

	// let's say that the admin account posts a new status: it should end up in the
	// timeline of any account that follows it and has a stream open
	postingAccount := suite.testAccounts["admin_account"]
	receivingAccount := suite.testAccounts["local_account_1"]

	// open a home timeline stream for zork
	wssStream, errWithCode := suite.processor.Stream().Open(ctx, receivingAccount, stream.TimelineHome)
	suite.NoError(errWithCode)

	// open another stream for zork, but for a different timeline;
	// this shouldn't get stuff streamed into it, since it's for the public timeline
	irrelevantStream, errWithCode := suite.processor.Stream().Open(ctx, receivingAccount, stream.TimelinePublic)
	suite.NoError(errWithCode)

	// make a new status from admin account
	newStatus := &gtsmodel.Status{
		ID:                       "01FN4B2F88TF9676DYNXWE1WSS",
		URI:                      "http://localhost:8080/users/admin/statuses/01FN4B2F88TF9676DYNXWE1WSS",
		URL:                      "http://localhost:8080/@admin/statuses/01FN4B2F88TF9676DYNXWE1WSS",
		Content:                  "this status should stream :)",
		AttachmentIDs:            []string{},
		TagIDs:                   []string{},
		MentionIDs:               []string{},
		EmojiIDs:                 []string{},
		CreatedAt:                testrig.TimeMustParse("2021-10-20T11:36:45Z"),
		UpdatedAt:                testrig.TimeMustParse("2021-10-20T11:36:45Z"),
		Local:                    testrig.TrueBool(),
		AccountURI:               "http://localhost:8080/users/admin",
		AccountID:                "01F8MH17FWEB39HZJ76B6VXSKF",
		InReplyToID:              "",
		BoostOfID:                "",
		ContentWarning:           "",
		Visibility:               gtsmodel.VisibilityFollowersOnly,
		Sensitive:                testrig.FalseBool(),
		Language:                 "en",
		CreatedWithApplicationID: "01F8MGXQRHYF5QPMTMXP78QC2F",
		Federated:                testrig.FalseBool(),
		Boostable:                testrig.TrueBool(),
		Replyable:                testrig.TrueBool(),
		Likeable:                 testrig.TrueBool(),
		ActivityStreamsType:      ap.ObjectNote,
	}

	// put the status in the db first, to mimic what would have already happened earlier up the flow
	err := suite.db.PutStatus(ctx, newStatus)
	suite.NoError(err)

	// process the new status
	err = suite.processor.ProcessFromClientAPI(ctx, messages.FromClientAPI{
		APObjectType:   ap.ObjectNote,
		APActivityType: ap.ActivityCreate,
		GTSModel:       newStatus,
		OriginAccount:  postingAccount,
	})
	suite.NoError(err)

	// zork's stream should have the newly created status in it now
	msg := <-wssStream.Messages
	suite.Equal(stream.EventTypeUpdate, msg.Event)
	suite.NotEmpty(msg.Payload)
	suite.EqualValues([]string{stream.TimelineHome}, msg.Stream)
	statusStreamed := &apimodel.Status{}
	err = json.Unmarshal([]byte(msg.Payload), statusStreamed)
	suite.NoError(err)
	suite.Equal("01FN4B2F88TF9676DYNXWE1WSS", statusStreamed.ID)
	suite.Equal("this status should stream :)", statusStreamed.Content)

	// and stream should now be empty
	suite.Empty(wssStream.Messages)

	// the irrelevant messages stream should also be empty
	suite.Empty(irrelevantStream.Messages)
}

func (suite *FromClientAPITestSuite) TestProcessStatusDelete() {
	ctx := context.Background()

	deletingAccount := suite.testAccounts["local_account_1"]
	receivingAccount := suite.testAccounts["local_account_2"]

	deletedStatus := suite.testStatuses["local_account_1_status_1"]
	boostOfDeletedStatus := suite.testStatuses["admin_account_status_4"]

	// open a home timeline stream for turtle, who follows zork
	wssStream, errWithCode := suite.processor.Stream().Open(ctx, receivingAccount, stream.TimelineHome)
	suite.NoError(errWithCode)

	// delete the status from the db first, to mimic what would have already happened earlier up the flow
	err := suite.db.DeleteStatusByID(ctx, deletedStatus.ID)
	suite.NoError(err)

	// process the status delete
	err = suite.processor.ProcessFromClientAPI(ctx, messages.FromClientAPI{
		APObjectType:   ap.ObjectNote,
		APActivityType: ap.ActivityDelete,
		GTSModel:       deletedStatus,
		OriginAccount:  deletingAccount,
	})
	suite.NoError(err)

	// turtle's stream should have the delete of admin's boost in it now
	msg := <-wssStream.Messages
	suite.Equal(stream.EventTypeDelete, msg.Event)
	suite.Equal(boostOfDeletedStatus.ID, msg.Payload)
	suite.EqualValues([]string{stream.TimelineHome}, msg.Stream)

	// turtle's stream should also have the delete of the message itself in it
	msg = <-wssStream.Messages
	suite.Equal(stream.EventTypeDelete, msg.Event)
	suite.Equal(deletedStatus.ID, msg.Payload)
	suite.EqualValues([]string{stream.TimelineHome}, msg.Stream)

	// stream should now be empty
	suite.Empty(wssStream.Messages)

	// the boost should no longer be in the database
	_, err = suite.db.GetStatusByID(ctx, boostOfDeletedStatus.ID)
	suite.ErrorIs(err, db.ErrNoEntries)
}

func (suite *FromClientAPITestSuite) TestProcessNewStatusWithNotification() {
	ctx := context.Background()
	postingAccount := suite.testAccounts["admin_account"]
	receivingAccount := suite.testAccounts["local_account_1"]

	// Update the follow from receiving account -> posting account so
	// that receiving account wants notifs when posting account posts.
	follow := &gtsmodel.Follow{}
	*follow = *suite.testFollows["local_account_1_admin_account"]
	follow.Notify = testrig.TrueBool()
	if err := suite.db.UpdateFollow(ctx, follow); err != nil {
		suite.FailNow(err.Error())
	}

	// Make a new status from admin account.
	newStatus := &gtsmodel.Status{
		ID:                       "01FN4B2F88TF9676DYNXWE1WSS",
		URI:                      "http://localhost:8080/users/admin/statuses/01FN4B2F88TF9676DYNXWE1WSS",
		URL:                      "http://localhost:8080/@admin/statuses/01FN4B2F88TF9676DYNXWE1WSS",
		Content:                  "this status should create a notification",
		AttachmentIDs:            []string{},
		TagIDs:                   []string{},
		MentionIDs:               []string{},
		EmojiIDs:                 []string{},
		CreatedAt:                testrig.TimeMustParse("2021-10-20T11:36:45Z"),
		UpdatedAt:                testrig.TimeMustParse("2021-10-20T11:36:45Z"),
		Local:                    testrig.TrueBool(),
		AccountURI:               "http://localhost:8080/users/admin",
		AccountID:                "01F8MH17FWEB39HZJ76B6VXSKF",
		InReplyToID:              "",
		BoostOfID:                "",
		ContentWarning:           "",
		Visibility:               gtsmodel.VisibilityFollowersOnly,
		Sensitive:                testrig.FalseBool(),
		Language:                 "en",
		CreatedWithApplicationID: "01F8MGXQRHYF5QPMTMXP78QC2F",
		Federated:                testrig.FalseBool(),
		Boostable:                testrig.TrueBool(),
		Replyable:                testrig.TrueBool(),
		Likeable:                 testrig.TrueBool(),
		ActivityStreamsType:      ap.ObjectNote,
	}

	// Put the status in the db first, to mimic what
	// would have already happened earlier up the flow.
	err := suite.db.PutStatus(ctx, newStatus)
	suite.NoError(err)

	// Process the new status.
	if err := suite.processor.ProcessFromClientAPI(ctx, messages.FromClientAPI{
		APObjectType:   ap.ObjectNote,
		APActivityType: ap.ActivityCreate,
		GTSModel:       newStatus,
		OriginAccount:  postingAccount,
	}); err != nil {
		suite.FailNow(err.Error())
	}

	// Wait for a notification to appear for the status.
	if !testrig.WaitFor(func() bool {
		_, err := suite.db.GetNotification(
			ctx,
			gtsmodel.NotificationStatus,
			receivingAccount.ID,
			postingAccount.ID,
			newStatus.ID,
		)
		return err == nil
	}) {
		suite.FailNow("timed out waiting for new status notification")
	}
}

func TestFromClientAPITestSuite(t *testing.T) {
	suite.Run(t, &FromClientAPITestSuite{})
}