adalal/solidtime
1
0
Fork 0
mirror of https://github.com/solidtime-io/solidtime.git synced 2026-08-08 00:02:15 +01:00
Code Issues Packages Projects Releases Wiki Activity

Added time estimates for projects and tasks, fixes ST-283

Browse Source
This commit is contained in:
Constantin Graf
2024-07-02 16:36:15 +02:00
committed by Gregor Vostrak
parent 78ea8a673b
commit a820d8540f
18 changed files with 402 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
app/Http/Controllers/Api/V1/Controller.php
View File

@@ -5,6 +5,7 @@ declare(strict_types=1);
namespace App\Http\Controllers\Api\V1;
use App\Models\Organization;
use App\Service\BillingContract;
use App\Service\PermissionStore;
use Illuminate\Auth\Access\AuthorizationException;
@@ -43,4 +44,9 @@ class Controller extends \App\Http\Controllers\Controller
{
return $this->permissionStore->has($organization, $permission);
}
protected function canAccessPremiumFeatures(Organization $organization): bool
{
return app(BillingContract::class)->hasSubscription($organization) || app(BillingContract::class)->hasTrial($organization);
}
}

10
app/Http/Controllers/Api/V1/ProjectController.php
View File

@@ -95,6 +95,9 @@ class ProjectController extends Controller
$project->is_billable = (bool) $request->input('is_billable');
$project->billable_rate = $request->getBillableRate();
$project->client_id = $request->input('client_id');
if ($this->canAccessPremiumFeatures($organization) && $request->has('estimated_time')) {
$project->estimated_time = $request->getEstimatedTime();
}
$project->organization()->associate($organization);
$project->save();
@@ -117,6 +120,9 @@ class ProjectController extends Controller
if ($request->has('is_archived')) {
$project->archived_at = $request->getIsArchived() ? Carbon::now() : null;
}
if ($this->canAccessPremiumFeatures($organization) && $request->has('estimated_time')) {
$project->estimated_time = $request->getEstimatedTime();
}
$oldBillableRate = $project->billable_rate;
$project->billable_rate = $request->getBillableRate();
$project->client_id = $request->input('client_id');
@@ -147,8 +153,8 @@ class ProjectController extends Controller
throw new EntityStillInUseApiException('project', 'time_entry');
}
DB::transaction(function () use (&$project) {
$project->members->each(function (ProjectMember $member) {
DB::transaction(function () use (&$project): void {
$project->members->each(function (ProjectMember $member): void {
$member->delete();
});

6
app/Http/Controllers/Api/V1/TaskController.php
View File

@@ -79,6 +79,9 @@ class TaskController extends Controller
$task = new Task;
$task->name = $request->input('name');
$task->project_id = $request->input('project_id');
if ($this->canAccessPremiumFeatures($organization) && $request->has('estimated_time')) {
$task->estimated_time = $request->getEstimatedTime();
}
$task->organization()->associate($organization);
$task->save();
@@ -96,6 +99,9 @@ class TaskController extends Controller
{
$this->checkPermission($organization, 'tasks:update', $task);
$task->name = $request->input('name');
if ($this->canAccessPremiumFeatures($organization) && $request->has('estimated_time')) {
$task->estimated_time = $request->getEstimatedTime();
}
if ($request->has('is_done')) {
$task->done_at = $request->getIsDone() ? Carbon::now() : null;
}

14
app/Http/Requests/V1/Project/ProjectStoreRequest.php
View File

@@ -52,6 +52,7 @@ class ProjectStoreRequest extends FormRequest
'integer',
'min:0',
],
// ID of the client
'client_id' => [
'nullable',
new ExistsEloquent(Client::class, null, function (Builder $builder): Builder {
@@ -59,6 +60,12 @@ class ProjectStoreRequest extends FormRequest
return $builder->whereBelongsTo($this->organization, 'organization');
}),
],
// Estimated time in seconds
'estimated_time' => [
'nullable',
'integer',
'min:0',
],
];
}
@@ -68,4 +75,11 @@ class ProjectStoreRequest extends FormRequest
return $input !== null && $input !== 0 ? (int) $this->input('billable_rate') : null;
}
public function getEstimatedTime(): ?int
{
$input = $this->input('estimated_time');
return $input !== null && $input !== 0 ? (int) $this->input('estimated_time') : null;
}
}

13
app/Http/Requests/V1/Project/ProjectUpdateRequest.php
View File

@@ -62,6 +62,12 @@ class ProjectUpdateRequest extends FormRequest
'integer',
'min:0',
],
// Estimated time in seconds
'estimated_time' => [
'nullable',
'integer',
'min:0',
],
];
}
@@ -78,4 +84,11 @@ class ProjectUpdateRequest extends FormRequest
return $input !== null && $input !== 0 ? (int) $this->input('billable_rate') : null;
}
public function getEstimatedTime(): ?int
{
$input = $this->input('estimated_time');
return $input !== null && $input !== 0 ? (int) $this->input('estimated_time') : null;
}
}

13
app/Http/Requests/V1/Task/TaskStoreRequest.php
View File

@@ -43,6 +43,19 @@ class TaskStoreRequest extends FormRequest
return $builder->whereBelongsTo($this->organization, 'organization');
}),
],
// Estimated time in seconds
'estimated_time' => [
'nullable',
'integer',
'min:0',
],
];
}
public function getEstimatedTime(): ?int
{
$input = $this->input('estimated_time');
return $input !== null && $input !== 0 ? (int) $this->input('estimated_time') : null;
}
}

13
app/Http/Requests/V1/Task/TaskUpdateRequest.php
View File

@@ -38,6 +38,12 @@ class TaskUpdateRequest extends FormRequest
'is_done' => [
'boolean',
],
// Estimated time in seconds
'estimated_time' => [
'nullable',
'integer',
'min:0',
],
];
}
@@ -47,4 +53,11 @@ class TaskUpdateRequest extends FormRequest
return $this->boolean('is_done');
}
public function getEstimatedTime(): ?int
{
$input = $this->input('estimated_time');
return $input !== null && $input !== 0 ? (int) $this->input('estimated_time') : null;
}
}

2
app/Http/Resources/V1/Project/ProjectResource.php
View File

@@ -35,6 +35,8 @@ class ProjectResource extends BaseResource
'billable_rate' => $this->resource->billable_rate,
/** @var bool $is_billable Project time entries billable default */
'is_billable' => $this->resource->is_billable,
/** @var int|null $estimated_time Estimated time in seconds */
'estimated_time' => $this->resource->estimated_time,
];
}
}

2
app/Http/Resources/V1/Task/TaskResource.php
View File

@@ -30,6 +30,8 @@ class TaskResource extends BaseResource
'is_done' => $this->resource->is_done,
/** @var string $project_id ID of the project */
'project_id' => $this->resource->project_id,
/** @var int|null $estimated_time Estimated time in seconds */
'estimated_time' => $this->resource->estimated_time,
/** @var string $created_at When the tag was created */
'created_at' => $this->formatDateTime($this->resource->created_at),
/** @var string $updated_at When the tag was last updated */

2
app/Models/Project.php
View File

@@ -27,6 +27,7 @@ use OwenIt\Auditing\Contracts\Auditable as AuditableContract;
* @property bool $is_public
* @property bool $is_billable
* @property-read bool $is_archived
* @property int|null $estimated_time
* @property Carbon|null $archived_at
* @property Carbon|null $created_at
* @property Carbon|null $updated_at
@@ -56,6 +57,7 @@ class Project extends Model implements AuditableContract
'name' => 'string',
'color' => 'string',
'archived_at' => 'datetime',
'estimated_time' => 'integer',
];
/**

2
app/Models/Task.php
View File

@@ -23,6 +23,7 @@ use OwenIt\Auditing\Contracts\Auditable as AuditableContract;
* @property string $project_id
* @property string $organization_id
* @property Carbon|null $done_at
* @property int|null $estimated_time
* @property Carbon|null $created_at
* @property Carbon|null $updated_at
* @property-read Project $project
@@ -48,6 +49,7 @@ class Task extends Model implements AuditableContract
*/
protected $casts = [
'name' => 'string',
'estimated_time' => 'integer',
'done_at' => 'datetime',
];

10
database/factories/ProjectFactory.php
View File

@@ -33,9 +33,19 @@ class ProjectFactory extends Factory
'archived_at' => null,
'client_id' => null,
'organization_id' => Organization::factory(),
'estimated_time' => null,
];
}
public function withEstimatedTime(): self
{
return $this->state(function (array $attributes): array {
return [
'estimated_time' => $this->faker->randomNumber(3),
];
});
}
public function billable(): self
{
return $this->state(function (array $attributes): array {

1
database/factories/TaskFactory.php
View File

@@ -26,6 +26,7 @@ class TaskFactory extends Factory
'project_id' => Project::factory(),
'organization_id' => Organization::factory(),
'done_at' => null,
'estimated_time' => null,
];
}

36
database/migrations/2024_07_02_134307_add_estimated_time_to_projects_and_tasks_table.php Normal file
View File

@@ -0,0 +1,36 @@
<?php
declare(strict_types=1);
use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;
return new class extends Migration
{
/**
* Run the migrations.
*/
public function up(): void
{
Schema::table('projects', function (Blueprint $table): void {
$table->integer('estimated_time')->unsigned()->nullable();
});
Schema::table('tasks', function (Blueprint $table): void {
$table->integer('estimated_time')->unsigned()->nullable();
});
}
/**
* Reverse the migrations.
*/
public function down(): void
{
Schema::table('projects', function (Blueprint $table): void {
$table->dropColumn('estimated_time');
});
Schema::table('tasks', function (Blueprint $table): void {
$table->dropColumn('estimated_time');
});
}
};

12
tests/TestCase.php
View File

@@ -72,11 +72,21 @@ abstract class TestCase extends BaseTestCase
protected function assertBillableRateServiceIsUnused(): void
{
$this->mock(BillableRateService::class, function (MockInterface $mock) {
$this->mock(BillableRateService::class, function (MockInterface $mock): void {
$mock->shouldNotReceive('updateTimeEntriesBillableRateForProjectMember');
$mock->shouldNotReceive('updateTimeEntriesBillableRateForProject');
$mock->shouldNotReceive('updateTimeEntriesBillableRateForMember');
$mock->shouldNotReceive('updateTimeEntriesBillableRateForOrganization');
});
}
protected function actAsOrganizationWithSubscription(): void
{
$this->mock(BillingContract::class, function (MockInterface $mock): void {
$mock->shouldReceive('hasSubscription')->andReturn(true);
$mock->shouldReceive('hasTrial')->andReturn(false);
$mock->shouldReceive('getTrialUntil')->andReturn(null);
$mock->shouldReceive('isBlocked')->andReturn(false);
});
}
}

134
tests/Unit/Endpoint/Api/V1/ProjectEndpointTest.php
View File

@@ -251,6 +251,75 @@ class ProjectEndpointTest extends ApiEndpointTestAbstract
]);
}
public function test_store_endpoint_ignores_estimated_time_if_pro_features_are_disabled(): void
{
// Arrange
$data = $this->createUserWithPermission([
'projects:create',
]);
$projectFake = Project::factory()->forOrganization($data->organization)->make();
Passport::actingAs($data->user);
// Act
$response = $this->postJson(route('api.v1.projects.store', [$data->organization->getKey()]), [
'name' => $projectFake->name,
'color' => $projectFake->color,
'is_billable' => $projectFake->is_billable,
'estimated_time' => 10000,
]);
// Assert
$response->assertStatus(201);
$response->assertJson(fn (AssertableJson $json) => $json
->has('data')
->where('data.name', $projectFake->name)
->where('data.color', $projectFake->color)
->where('data.estimated_time', null)
);
$this->assertDatabaseHas(Project::class, [
'name' => $projectFake->name,
'color' => $projectFake->color,
'organization_id' => $projectFake->organization_id,
'is_billable' => $projectFake->is_billable,
'estimated_time' => null,
]);
}
public function test_store_endpoint_can_store_project_with_estimated_time_with_pro_features_enabled(): void
{
// Arrange
$data = $this->createUserWithPermission([
'projects:create',
]);
$projectFake = Project::factory()->forOrganization($data->organization)->make();
Passport::actingAs($data->user);
$this->actAsOrganizationWithSubscription();
// Act
$response = $this->postJson(route('api.v1.projects.store', [$data->organization->getKey()]), [
'name' => $projectFake->name,
'color' => $projectFake->color,
'is_billable' => $projectFake->is_billable,
'estimated_time' => 10000,
]);
// Assert
$response->assertStatus(201);
$response->assertJson(fn (AssertableJson $json) => $json
->has('data')
->where('data.name', $projectFake->name)
->where('data.color', $projectFake->color)
->where('data.estimated_time', 10000)
);
$this->assertDatabaseHas(Project::class, [
'name' => $projectFake->name,
'color' => $projectFake->color,
'organization_id' => $projectFake->organization_id,
'is_billable' => $projectFake->is_billable,
'estimated_time' => 10000,
]);
}
public function test_store_endpoint_fails_if_name_is_already_used_in_organization(): void
{
// Arrange
@@ -507,6 +576,71 @@ class ProjectEndpointTest extends ApiEndpointTestAbstract
$this->assertFalse($project->is_archived);
}
public function test_update_endpoint_ignores_estimated_time_if_pro_features_are_disabled(): void
{
// Arrange
$data = $this->createUserWithPermission([
'projects:update',
]);
$project = Project::factory()->forOrganization($data->organization)->create();
$projectFake = Project::factory()->make();
Passport::actingAs($data->user);
// Act
$response = $this->putJson(route('api.v1.projects.update', [$data->organization->getKey(), $project->getKey()]), [
'name' => $projectFake->name,
'color' => $projectFake->color,
'is_billable' => $projectFake->is_billable,
'estimated_time' => 10000,
]);
// Assert
$response->assertStatus(200);
$project->refresh();
$response->assertJson(fn (AssertableJson $json) => $json
->has('data')
->where('data.name', $projectFake->name)
->where('data.color', $projectFake->color)
->where('data.estimated_time', null)
);
$this->assertSame($projectFake->name, $project->name);
$this->assertSame($projectFake->color, $project->color);
$this->assertNull($project->estimated_time);
}
public function test_update_endpoint_can_store_project_with_estimated_time_with_pro_features_enabled(): void
{
// Arrange
$data = $this->createUserWithPermission([
'projects:update',
]);
$project = Project::factory()->forOrganization($data->organization)->create();
$projectFake = Project::factory()->make();
Passport::actingAs($data->user);
$this->actAsOrganizationWithSubscription();
// Act
$response = $this->putJson(route('api.v1.projects.update', [$data->organization->getKey(), $project->getKey()]), [
'name' => $projectFake->name,
'color' => $projectFake->color,
'is_billable' => $projectFake->is_billable,
'estimated_time' => 10000,
]);
// Assert
$response->assertStatus(200);
$project->refresh();
$response->assertJson(fn (AssertableJson $json) => $json
->has('data')
->where('data.name', $projectFake->name)
->where('data.color', $projectFake->color)
->where('data.estimated_time', 10000)
);
$this->assertSame($projectFake->name, $project->name);
$this->assertSame($projectFake->color, $project->color);
$this->assertSame(10000, $project->estimated_time);
}
public function test_update_endpoint_does_not_update_billable_rates_of_time_entries_if_billable_rate_is_unchanged(): void
{
// Arrange

127
tests/Unit/Endpoint/Api/V1/TaskEndpointTest.php
View File

@@ -10,6 +10,7 @@ use App\Models\ProjectMember;
use App\Models\Task;
use App\Models\TimeEntry;
use Illuminate\Support\Carbon;
use Illuminate\Testing\Fluent\AssertableJson;
use Laravel\Passport\Passport;
use PHPUnit\Framework\Attributes\UsesClass;
@@ -274,7 +275,7 @@ class TaskEndpointTest extends ApiEndpointTestAbstract
$response->assertJsonCount(2, 'data');
}
public function test_store_endpoint_fails_if_user_has_no_permission_to_create_tasks()
public function test_store_endpoint_fails_if_user_has_no_permission_to_create_tasks(): void
{
// Arrange
$data = $this->createUserWithPermission();
@@ -347,7 +348,7 @@ class TaskEndpointTest extends ApiEndpointTestAbstract
]);
}
public function test_store_endpoint_creates_new_task_if_user_has_permission_to_create_tasks()
public function test_store_endpoint_creates_new_task_if_user_has_permission_to_create_tasks(): void
{
// Arrange
$data = $this->createUserWithPermission([
@@ -371,6 +372,71 @@ class TaskEndpointTest extends ApiEndpointTestAbstract
]);
}
public function test_store_endpoint_ignores_estimated_time_if_pro_features_are_disabled(): void
{
// Arrange
$data = $this->createUserWithPermission([
'tasks:create',
]);
$project = Project::factory()->forOrganization($data->organization)->create();
Passport::actingAs($data->user);
// Act
$response = $this->postJson(route('api.v1.tasks.store', [$data->organization->getKey()]), [
'name' => 'Task 1',
'project_id' => $project->getKey(),
'estimated_time' => 3600,
]);
// Assert
$response->assertStatus(201);
$response->assertJson(fn (AssertableJson $json) => $json
->has('data')
->where('data.name', 'Task 1')
->where('data.project_id', $project->getKey())
->where('data.estimated_time', null)
);
$this->assertDatabaseHas(Task::class, [
'name' => 'Task 1',
'project_id' => $project->getKey(),
'organization_id' => $data->organization->getKey(),
'estimated_time' => null,
]);
}
public function test_store_endpoint_can_store_with_estimated_time_with_pro_features_enabled(): void
{
// Arrange
$data = $this->createUserWithPermission([
'tasks:create',
]);
$project = Project::factory()->forOrganization($data->organization)->create();
Passport::actingAs($data->user);
$this->actAsOrganizationWithSubscription();
// Act
$response = $this->postJson(route('api.v1.tasks.store', [$data->organization->getKey()]), [
'name' => 'Task 1',
'project_id' => $project->getKey(),
'estimated_time' => 3600,
]);
// Assert
$response->assertStatus(201);
$response->assertJson(fn (AssertableJson $json) => $json
->has('data')
->where('data.name', 'Task 1')
->where('data.project_id', $project->getKey())
->where('data.estimated_time', 3600)
);
$this->assertDatabaseHas(Task::class, [
'name' => 'Task 1',
'project_id' => $project->getKey(),
'organization_id' => $data->organization->getKey(),
'estimated_time' => 3600,
]);
}
public function test_update_endpoint_fails_if_user_has_no_permission(): void
{
// Arrange
@@ -523,6 +589,63 @@ class TaskEndpointTest extends ApiEndpointTestAbstract
]);
}
public function test_update_endpoint_ignores_estimated_time_if_pro_features_are_disabled(): void
{
// Arrange
$data = $this->createUserWithPermission([
'tasks:update',
]);
$task = Task::factory()->forOrganization($data->organization)->create();
Passport::actingAs($data->user);
// Act
$response = $this->putJson(route('api.v1.tasks.update', [$data->organization->getKey(), $task->getKey()]), [
'name' => $task->name,
'estimated_time' => 3600,
]);
// Assert
$response->assertStatus(200);
$response->assertJson(fn (AssertableJson $json) => $json
->has('data')
->where('data.name', $task->name)
->where('data.estimated_time', null)
);
$this->assertDatabaseHas(Task::class, [
'id' => $task->getKey(),
'estimated_time' => null,
]);
}
public function test_update_endpoint_can_update_estimated_time_with_pro_features_enabled(): void
{
// Arrange
$data = $this->createUserWithPermission([
'tasks:update',
]);
$task = Task::factory()->forOrganization($data->organization)->create();
Passport::actingAs($data->user);
$this->actAsOrganizationWithSubscription();
// Act
$response = $this->putJson(route('api.v1.tasks.update', [$data->organization->getKey(), $task->getKey()]), [
'name' => $task->name,
'estimated_time' => 3600,
]);
// Assert
$response->assertStatus(200);
$response->assertJson(fn (AssertableJson $json) => $json
->has('data')
->where('data.name', $task->name)
->where('data.estimated_time', 3600)
);
$this->assertDatabaseHas(Task::class, [
'id' => $task->getKey(),
'estimated_time' => 3600,
]);
}
public function test_delete_endpoint_deletes_tasks_if_user_has_permission(): void
{
// Arrange

5
tests/Unit/Model/UserModelTest.php
View File

@@ -92,7 +92,10 @@ class UserModelTest extends ModelTestAbstract
// Assert
$this->assertNotNull($timeEntriesRel);
$this->assertCount(3, $timeEntriesRel);
$this->assertTrue($timeEntriesRel->first()->is($timeEntries->first()));
$this->assertEqualsCanonicalizing(
$timeEntries->pluck('id')->toArray(),
$timeEntriesRel->pluck('id')->toArray()
);
}
public function test_it_has_many_project_members(): void