Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

wip: new merging logic, updated tests #56

Draft
wants to merge 8 commits into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,10 @@
"name": "fas fa-code-branch fa-flip-vertical",
"backgroundColor": "#e74c3c",
"color": "#fff"
}
},
"optional-dependencies": [
"flarum/lock"
]
},
"flagrow": {
"discuss": "https://discuss.flarum.org/d/19460"
Expand All @@ -60,7 +63,8 @@
},
"require-dev": {
"flarum/phpstan": "*",
"flarum/testing": "^1.0.0"
"flarum/testing": "^1.0.0",
"flarum/lock": "*"
},
"scripts": {
"analyse:phpstan": "phpstan analyse",
Expand Down
25 changes: 18 additions & 7 deletions src/Api/Controllers/MergeController.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,12 @@

use Flarum\Api\Controller\AbstractShowController;
use Flarum\Api\Serializer\DiscussionSerializer;
use Flarum\Discussion\Discussion;
use Flarum\Http\RequestUtil;
use FoF\MergeDiscussions\Commands\MergeDiscussion;
use FoF\MergeDiscussions\Jobs\MergeDiscussionsJob;
use FoF\MergeDiscussions\Validators\MergeDiscussionValidator;
use Illuminate\Contracts\Bus\Dispatcher;
use Illuminate\Contracts\Queue\Queue;
use Illuminate\Support\Arr;
use Psr\Http\Message\ServerRequestInterface;
use Tobscure\JsonApi\Document;
Expand All @@ -40,10 +42,16 @@ class MergeController extends AbstractShowController
*/
protected $validator;

public function __construct(Dispatcher $bus, MergeDiscussionValidator $validator)
/**
* @var Queue
*/
protected $queue;

public function __construct(Dispatcher $bus, MergeDiscussionValidator $validator, Queue $queue)
{
$this->bus = $bus;
$this->validator = $validator;
$this->queue = $queue;
}

/**
Expand All @@ -57,17 +65,20 @@ public function __construct(Dispatcher $bus, MergeDiscussionValidator $validator
protected function data(ServerRequestInterface $request, Document $document)
{
$actor = RequestUtil::getActor($request);
$discussion = Arr::get($request->getQueryParams(), 'id');
$discussion = Discussion::findOrFail(Arr::get($request->getQueryParams(), 'id'));

$actor->assertCan('merge', $discussion);

$ids = Arr::get($request->getParsedBody(), 'ids');
$ordering = Arr::get($request->getParsedBody(), 'ordering');

$this->validator->assertValid([
'discussion_id' => $discussion,
'discussion_id' => $discussion->id,
'merging_discussions' => $ids,
]);

return $this->bus->dispatch(
new MergeDiscussion($actor, $discussion, $ids, $ordering)
);
$this->queue->push(new MergeDiscussionsJob($actor, $discussion->id, $ids, $ordering));

return $discussion;
}
}
4 changes: 2 additions & 2 deletions src/Api/Controllers/MergePreviewController.php
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
use Flarum\Api\Serializer\DiscussionSerializer;
use Flarum\Discussion\Discussion;
use Flarum\Http\RequestUtil;
use FoF\MergeDiscussions\Commands\MergeDiscussion;
use FoF\MergeDiscussions\Commands\MergeDiscussions;
use FoF\MergeDiscussions\Validators\MergeDiscussionValidator;
use Illuminate\Contracts\Bus\Dispatcher;
use Illuminate\Support\Arr;
Expand Down Expand Up @@ -84,7 +84,7 @@ protected function data(ServerRequestInterface $request, Document $document)
* @var Discussion
*/
$discussion = $this->bus->dispatch(
new MergeDiscussion($actor, $discussion, $ids, $ordering, false)
new MergeDiscussions($actor, $discussion, $ids, $ordering, false)
);

$discussion->setRelation('posts', $discussion->posts);
Expand Down
6 changes: 6 additions & 0 deletions src/Commands/MergeDiscussion.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,12 @@
use Flarum\User\User;
use Illuminate\Support\Arr;

/**
* Use the `MergeDiscussions` command instead. This class is kept for backwards compatibility.
* TODO: Remove in 2.0.
*
* @deprecated
*/
class MergeDiscussion
{
/**
Expand Down
10 changes: 8 additions & 2 deletions src/Commands/MergeDiscussionHandler.php
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,12 @@
use Illuminate\Support\Collection as SupportCollection;
use Throwable;

/**
* Use the `MergeDiscussions` command instead. This class is kept for backwards compatibility.
* TODO: Remove in 2.0.
*
* @deprecated
*/
class MergeDiscussionHandler
{
/**
Expand Down Expand Up @@ -69,12 +75,12 @@ public function handle(MergeDiscussion $command)
$this->fixPostsNumber($discussion);
}

/** @var Collection $discussions */
/** @var Collection<Discussion> $discussions */
$discussions = Discussion::query()
->with('posts')
->findMany($command->ids);

/** @var Collection $posts */
/** @var Collection<Post> $posts */
$posts = $discussions->pluck('posts')->flatten(1)
->reject(function (Post $post) {
return $post->type === 'discussionTagged';
Expand Down
69 changes: 69 additions & 0 deletions src/Commands/MergeDiscussions.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
<?php

/*
* This file is part of fof/merge-discussions.
*
* Copyright (c) FriendsOfFlarum.
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

namespace FoF\MergeDiscussions\Commands;

use Flarum\User\User;
use Illuminate\Support\Arr;

class MergeDiscussions
{
/**
* The user performing the action.
*
* @var User
*/
public $actor;

/**
* Discussion id to merge other discussions into.
*
* @var int
*/
public $discussionId;

/**
* The discussion ids to merge.
*
* @var int[]
*/
public $ids;

/**
* The merge ordering.
*
* @var string
*/
public $ordering;

/**
* @var bool Save merged discussion to database
*/
public $merge;

/**
* MergeDiscussion constructor.
*
* @param User $actor
* @param $discussionId
* @param int[] $ids
* @param $ordering
* @param bool $merge
*/
public function __construct(User $actor, $discussionId, $ids, $ordering, $merge = true)
{
$this->actor = $actor;
$this->discussionId = (int) $discussionId;
$this->ids = Arr::wrap($ids);
$this->ordering = $ordering;
$this->merge = $merge;
}
}
Loading