Skip to content

Pause & restore subscriber #26

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.

Sign up for GitHub

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

Open
mikelina wants to merge 1 commit into
base: feature/logTimeSubscriberResponse
Choose a base branch
from
+186 −1
Open

Pause & restore subscriber #26

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
88 changes: 88 additions & 0 deletions app/Http/Controllers/SubscriberController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@
use App\Http\Requests\SubscriberRequest;
use App\Http\Resources\SubscriberResource;
use App\Http\Repositories\RepositoryInterface;
use Illuminate\Support\Facades\Cache;
use Illuminate\Support\Facades\Config;

class SubscriberController extends Controller
{
Expand Down Expand Up @@ -232,4 +234,90 @@ public function getSubscriber($id)
}
return new SubscriberResource($subscriber);
}

/**
* @OA\Get(
* path="/api/subscribers/{id}/pause",
* summary="Pauses a subscriber from receiving messages",
* tags={"subscribers"},
* security={{"passport":{}}},
* description="Use to pauses a subscriber from receiving messages for 1 hour",
* operationId="SubscriberController.pauseSubscriber",
* @OA\Parameter(
* in="path",
* required=true,
* description="Subscriber id",
* name="id",
* @OA\Schema(
* type="integer",
* minimum=1
* )
* ),
* @OA\Response(
* response=200,
* ref="#/components/responses/Success200"
* ),
* @OA\Response(
* response=404,
* ref="#/components/responses/Error404"
* )
* )
*
* Response to route /api/subscribers/{id}/pause
*
* @param int $id
*
*/
public function pauseSubscriber($id)
{
$subscriber = $this->subscriberRepository->find($id);;
if (!$subscriber) {
return response()->error404(__('messages.Subscriber') . $id);
}
Cache::put(Config::get('cache.publisher_paused_key_prefix') . $id, true, 3600);
return response()->success204();
}

/**
* @OA\Get(
* path="/api/subscribers/{id}/restore",
* summary="Restore a subscriber from receiving messages",
* tags={"subscribers"},
* security={{"passport":{}}},
* description="Use to restore a subscriber from receiving messages",
* operationId="SubscriberController.restoreSubscriber",
* @OA\Parameter(
* in="path",
* required=true,
* description="Subscriber id",
* name="id",
* @OA\Schema(
* type="integer",
* minimum=1
* )
* ),
* @OA\Response(
* response=200,
* ref="#/components/responses/Success200"
* ),
* @OA\Response(
* response=404,
* ref="#/components/responses/Error404"
* )
* )
*
* Response to route /api/subscribers/{id}/restore
*
* @param int $id
*
*/
public function restoreSubscriber($id)
{
$subscriber = $this->subscriberRepository->find($id);;
if (!$subscriber) {
return response()->error404(__('messages.Subscriber') . $id);
}
Cache::forget(Config::get('cache.publisher_paused_key_prefix') . $id);
return response()->success204();
}
}
9 changes: 9 additions & 0 deletions app/Jobs/SendMessageJob.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Foundation\Bus\Dispatchable;
use Illuminate\Support\Facades\Log;
use Illuminate\Support\Facades\Cache;
use Illuminate\Support\Facades\Config;

class SendMessageJob implements ShouldQueue
{
Expand Down Expand Up @@ -75,6 +77,13 @@ public function handle(GuzzleService $guzzleService)
"authentication" => $this->event->channelSubscribe->authentication,
]);

$pausedKey = Config::get('cache.publisher_paused_key_prefix') . $this->event->channelSubscribe->subscriber_id;
if (Cache::has($pausedKey)) {
Log::warning("Message paused");
$this->fail("Subscriber Paused");
return;
}

$this->startTime = microtime(true);
switch ($this->event->channelSubscribe->authentication) {
case Authentication::BASIC:
Expand Down
4 changes: 3 additions & 1 deletion config/cache.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,8 @@
*/

'prefix' => env('CACHE_PREFIX', Str::slug(env('APP_NAME', 'laravel'), '_') . '_cache:'),
'channel_key_prefix' => "channel."
'channel_key_prefix' => "channel.",
'publisher_paused_key_prefix' => "publisher_paused."


];
2 changes: 2 additions & 0 deletions routes/api.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@
Route::get('/', 'SubscriberController@getList');
Route::post('/', 'SubscriberController@store');
Route::get('{id}', 'SubscriberController@getSubscriber')->where('id', '[0-9]+');
Route::get('{id}/pause', 'SubscriberController@pauseSubscriber')->where('id', '[0-9]+');
Route::get('{id}/restore', 'SubscriberController@restoreSubscriber')->where('id', '[0-9]+');
Route::delete('{id}', 'SubscriberController@destroy')->where('id', '[0-9]+');

Route::get('{id}/channels', 'ChannelSubscribeController@getChannelSubscribe')->where('id', '[0-9]+');
Expand Down
67 changes: 67 additions & 0 deletions tests/Feature/SubscriberTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@
use App\Models\Subscriber;
use App\Http\Repositories\SubscriberRepository;
use Tests\TestCaseWithoutMiddleware;
use Illuminate\Http\Response;
use Illuminate\Support\Facades\Cache;
use Illuminate\Support\Facades\Config;

class SubscriberTest extends TestCaseWithoutMiddleware
{
Expand Down Expand Up @@ -169,4 +172,68 @@ public function testDestroy()
$response = $this->json('DELETE', '/api/subscribers/1');
$response->assertStatus(200);
}

public function testPause()
{
Cache::spy();
$subscriber = factory(Subscriber::class)->make();
$subscriber->id = 1;
$mock = Mockery::mock(SubscriberRepository::class)->makePartial()
->shouldReceive([
"find" => $subscriber,
])
->withAnyArgs()
->once()
->getMock();
$this->app->instance('App\Http\Repositories\SubscriberRepository', $mock);
$response = $this->json('GET', '/api/subscribers/1/pause');
$response->assertStatus(Response::HTTP_NO_CONTENT);
Cache::shouldHaveReceived('put')->with(Config::get('cache.publisher_paused_key_prefix') . 1, true, 3600);
}

public function testPauseNotFound()
{
$mock = Mockery::mock(SubscriberRepository::class)->makePartial()
->shouldReceive([
"find" => null,
])
->withAnyArgs()
->once()
->getMock();
$this->app->instance('App\Http\Repositories\SubscriberRepository', $mock);
$response = $this->json('GET', '/api/subscribers/1/pause');
$response->assertStatus(Response::HTTP_NOT_FOUND);
}

public function testRestore()
{
Cache::spy();
$subscriber = factory(Subscriber::class)->make();
$subscriber->id = 1;
$mock = Mockery::mock(SubscriberRepository::class)->makePartial()
->shouldReceive([
"find" => $subscriber,
])
->withAnyArgs()
->once()
->getMock();
$this->app->instance('App\Http\Repositories\SubscriberRepository', $mock);
$response = $this->json('GET', '/api/subscribers/1/restore');
$response->assertStatus(Response::HTTP_NO_CONTENT);
Cache::shouldHaveReceived('forget')->with(Config::get('cache.publisher_paused_key_prefix') . 1);
}

public function testRestoreNotFound()
{
$mock = Mockery::mock(SubscriberRepository::class)->makePartial()
->shouldReceive([
"find" => null,
])
->withAnyArgs()
->once()
->getMock();
$this->app->instance('App\Http\Repositories\SubscriberRepository', $mock);
$response = $this->json('GET', '/api/subscribers/1/restore');
$response->assertStatus(Response::HTTP_NOT_FOUND);
}
}
17 changes: 17 additions & 0 deletions tests/Integration/MessageTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@

namespace Tests\Integration;

use App\Events\SendMessageEvent;
use Mockery;
use App\Models\Message;
use App\Models\Channel;
use App\Models\Publisher;
use Illuminate\Support\Str;
Expand All @@ -13,6 +15,8 @@
use Illuminate\Foundation\Testing\TestCase;
use Illuminate\Support\Facades\Queue;
use Tests\CreatesApplication;
use Illuminate\Support\Facades\Cache;
use Illuminate\Support\Facades\Config;

class MessageTest extends TestCase
{
Expand Down Expand Up @@ -191,4 +195,17 @@ public function testBasicAuthFailedAuth()
$response = $this->json('POST', '/api/sendMessage/' . Str::random(10), [], $authorization);
$response->assertStatus(401);
}

public function testSendMessagePaused()
{
$channel = factory(Channel::class)->create();
$publisher = factory(Publisher::class)->create(['password' => bcrypt(self::PUBLISHER_PASSWORD)]);
factory(ChannelPublish::class)->create(['channel_id' => $channel->id, 'publisher_id' => $publisher->id]);
$channelSubscribe = factory(ChannelSubscribe::class)->create(['channel_id' => $channel->id]);
Cache::put(Config::get('cache.publisher_paused_key_prefix') . $channelSubscribe->subscriber_id, true, 3600);
$job = (new SendMessageJob(new SendMessageEvent(new Message("hello"), "http://prova.com", $channelSubscribe, "low", "test", "test")))->withFakeQueueInteractions();

$job->handle(new GuzzleService());
$job->assertFailed();
}
}
Loading