add dashboard frontend

solidtime-io · Mar 11, 2024 · b1d4a47 · b1d4a47
1 parent ace113a
commit b1d4a47
Show file tree

Hide file tree

Showing 86 changed files with 5,123 additions and 848 deletions.
diff --git a/.eslintrc.cjs b/.eslintrc.cjs
@@ -2,11 +2,7 @@
 require("@rushstack/eslint-patch/modern-module-resolution")
 
 module.exports = {
-    extends: [
-        'plugin:vue/vue3-essential',
-        '@vue/eslint-config-typescript/recommended',
-        '@vue/eslint-config-prettier'
-    ],
+    extends: ['plugin:vue/vue3-essential', '@vue/eslint-config-typescript/recommended', '@vue/eslint-config-prettier'],
     rules: {
         'vue/multi-word-component-names': 'off',
     }

diff --git a/README.md b/README.md
@@ -18,6 +18,8 @@ cp .env.example .env
 
 ./vendor/bin/sail artisan migrate:fresh --seed
 
+./vendor/bin/sail php artisan passport:install
+
 ./vendor/bin/sail npm install
 
 ./vendor/bin/sail npm run build
@@ -52,6 +54,19 @@ npx playwright install
 npx playwright codegen solidtime.test
 ``` 
 
+## E2E Troubleshooting
+
+If the E2E tests are not working consistently and fail with a timeout during the authentication, you might want to delete the `test-results/.auth` directory to force new test accounts to be created.
+
+## Generate ZOD Client
+
+The Zodius HTTP client is generated using the following command:
+
+```bash
+
+npm run generate:zod
+```
+
 ## Contributing
 
 This project is in a very early stage. The structure and APIs are still subject to change and not stable. 

diff --git a/app/Http/Controllers/Api/V1/ProjectController.php b/app/Http/Controllers/Api/V1/ProjectController.php
@@ -28,6 +28,8 @@ protected function checkPermission(Organization $organization, string $permissio
      * Get projects
      *
      * @throws AuthorizationException
+     *
+     * @operationId getProjects
      */
     public function index(Organization $organization): JsonResource
     {
@@ -43,6 +45,8 @@ public function index(Organization $organization): JsonResource
      * Get project
      *
      * @throws AuthorizationException
+     *
+     * @operationId getProject
      */
     public function show(Organization $organization, Project $project): JsonResource
     {
@@ -57,6 +61,8 @@ public function show(Organization $organization, Project $project): JsonResource
      * Create project
      *
      * @throws AuthorizationException
+     *
+     * @operationId createProject
      */
     public function store(Organization $organization, ProjectStoreRequest $request): JsonResource
     {
@@ -75,6 +81,8 @@ public function store(Organization $organization, ProjectStoreRequest $request):
      * Update project
      *
      * @throws AuthorizationException
+     *
+     * @operationId updateProject
      */
     public function update(Organization $organization, Project $project, ProjectUpdateRequest $request): JsonResource
     {
@@ -90,6 +98,8 @@ public function update(Organization $organization, Project $project, ProjectUpda
      * Delete project
      *
      * @throws AuthorizationException
+     *
+     * @operationId deleteProject
      */
     public function destroy(Organization $organization, Project $project): JsonResponse
     {

diff --git a/app/Http/Controllers/Api/V1/TagController.php b/app/Http/Controllers/Api/V1/TagController.php
@@ -27,6 +27,8 @@ protected function checkPermission(Organization $organization, string $permissio
      * Get tags
      *
      * @throws AuthorizationException
+     *
+     * @operationId getTags
      */
     public function index(Organization $organization): TagCollection
     {
@@ -44,6 +46,8 @@ public function index(Organization $organization): TagCollection
      * Create tag
      *
      * @throws AuthorizationException
+     *
+     * @operationId createTag
      */
     public function store(Organization $organization, TagStoreRequest $request): TagResource
     {
@@ -61,6 +65,8 @@ public function store(Organization $organization, TagStoreRequest $request): Tag
      * Update tag
      *
      * @throws AuthorizationException
+     *
+     * @operationId updateTag
      */
     public function update(Organization $organization, Tag $tag, TagUpdateRequest $request): TagResource
     {
@@ -76,6 +82,8 @@ public function update(Organization $organization, Tag $tag, TagUpdateRequest $r
      * Delete tag
      *
      * @throws AuthorizationException
+     *
+     * @operationId deleteTag
      */
     public function destroy(Organization $organization, Tag $tag): JsonResponse
     {

diff --git a/app/Http/Controllers/Api/V1/TimeEntryController.php b/app/Http/Controllers/Api/V1/TimeEntryController.php
@@ -32,6 +32,8 @@ protected function checkPermission(Organization $organization, string $permissio
      * Get time entries
      *
      * @throws AuthorizationException
+     *
+     * @operationId getTimeEntries
      */
     public function index(Organization $organization, TimeEntryIndexRequest $request): JsonResource
     {
@@ -103,6 +105,8 @@ public function index(Organization $organization, TimeEntryIndexRequest $request
      * Create time entry
      *
      * @throws AuthorizationException|TimeEntryStillRunning
+     *
+     * @operationId createTimeEntry
      */
     public function store(Organization $organization, TimeEntryStoreRequest $request): JsonResource
     {
@@ -120,7 +124,7 @@ public function store(Organization $organization, TimeEntryStoreRequest $request
 
         $timeEntry = new TimeEntry();
         $timeEntry->fill($request->validated());
-        $timeEntry->description = $request->get('description', '');
+        $timeEntry->description = $request->get('description') ?? '';
         $timeEntry->organization()->associate($organization);
         $timeEntry->save();
 
@@ -131,6 +135,8 @@ public function store(Organization $organization, TimeEntryStoreRequest $request
      * Update time entry
      *
      * @throws AuthorizationException
+     *
+     * @operationId updateTimeEntry
      */
     public function update(Organization $organization, TimeEntry $timeEntry, TimeEntryUpdateRequest $request): JsonResource
     {
@@ -141,6 +147,7 @@ public function update(Organization $organization, TimeEntry $timeEntry, TimeEnt
         }
 
         $timeEntry->fill($request->validated());
+        $timeEntry->description = $request->get('description', $timeEntry->description) ?? '';
         $timeEntry->save();
 
         return new TimeEntryResource($timeEntry);
@@ -150,6 +157,8 @@ public function update(Organization $organization, TimeEntry $timeEntry, TimeEnt
      * Delete time entry
      *
      * @throws AuthorizationException
+     *
+     * @operationId deleteTimeEntry
      */
     public function destroy(Organization $organization, TimeEntry $timeEntry): JsonResponse
     {

diff --git a/app/Http/Requests/V1/TimeEntry/TimeEntryUpdateRequest.php b/app/Http/Requests/V1/TimeEntry/TimeEntryUpdateRequest.php
@@ -42,7 +42,7 @@ public function rules(): array
             ],
             // End of time entry (ISO 8601 format, UTC timezone)
             'end' => [
-                'required',
+                'present',
                 'nullable',
                 'date', // TODO
                 'after:start',

diff --git a/app/Http/Resources/V1/TimeEntry/TimeEntryResource.php b/app/Http/Resources/V1/TimeEntry/TimeEntryResource.php
@@ -30,8 +30,8 @@ public function toArray(Request $request): array
             /**
              * @var string|null $end End of time entry (ISO 8601 format, UTC timezone, example: 2024-02-26T17:17:17Z)
              */
-            'end' => $this->formatDateTime($this->resource->start),
-            /** @var int $duration Duration of time entry in seconds */
+            'end' => $this->formatDateTime($this->resource->end),
+            /** @var int|null $duration Duration of time entry in seconds */
             'duration' => $this->resource->getDuration()?->seconds,
             /** @var string|null $description Description of time entry */
             'description' => $this->resource->description,
@@ -42,7 +42,7 @@ public function toArray(Request $request): array
             /** @var string $user_id ID of user */
             'user_id' => $this->resource->user_id,
             /** @var array<string> $tags List of tag IDs */
-            'tags' => $this->resource->tags,
+            'tags' => $this->resource->tags ?? [],
         ];
     }
 }
diff --git a/app/Providers/JetstreamServiceProvider.php b/app/Providers/JetstreamServiceProvider.php
@@ -94,7 +94,7 @@ protected function configurePermissions(): void
             'tags:update',
             'tags:delete',
             'organizations:view',
-        ])->description('Editor users have the ability to read, create, and update.');
+        ])->description('Managers have the ability to read, create, and update their own time entries as well as those of their team.');
 
         Jetstream::role('employee', 'Employee', [
             'projects:view',
@@ -104,6 +104,6 @@ protected function configurePermissions(): void
             'time-entries:update:own',
             'time-entries:delete:own',
             'organizations:view',
-        ])->description('Editor users have the ability to read, create, and update.');
+        ])->description('Employees have the ability to read, create, and update their own time entries.');
     }
 }
diff --git a/config/scramble.php b/config/scramble.php
@@ -64,9 +64,9 @@
      * ```
      */
     'servers' => [
-        'Production' => 'https://app.solidtime.io',
-        'Staging' => 'https://app.staging.solidtime.io',
-        'Local' => 'https://soldtime.test',
+        'Production' => 'https://app.solidtime.io/api',
+        'Staging' => 'https://app.staging.solidtime.io/api',
+        'Local' => 'https://soldtime.test/api',
     ],
 
     'middleware' => [

diff --git a/docker-compose.yml b/docker-compose.yml
@@ -65,6 +65,8 @@ services:
         image: mcr.microsoft.com/playwright:v1.41.1-jammy
         command: ['npx', 'playwright', 'test', '--ui-port=8080', '--ui-host=0.0.0.0']
         working_dir: /src
+        extra_hosts:
+            - "solidtime.test:${REVERSE_PROXY_IP:-10.100.100.10}"
         labels:
             - "traefik.enable=true"
             - "traefik.docker.network=${NETWORK_NAME}"

diff --git a/e2e/auth.spec.ts b/e2e/auth.spec.ts
@@ -8,30 +8,23 @@ async function registerNewUser(page, email, password) {
     await page.getByLabel('Password', { exact: true }).fill(password);
     await page.getByLabel('Confirm Password').fill(password);
     await page.getByRole('button', { name: 'Register' }).click();
-    await expect(
-        page.getByRole('heading', { name: 'Dashboard' })
-    ).toBeVisible();
+    await expect(page.getByTestId('dashboard_view')).toBeVisible();
 }
 
 test('can register, logout and log back in', async ({ page }) => {
     await page.goto(PLAYWRIGHT_BASE_URL);
     const email = `john+${Math.round(Math.random() * 10000)}@doe.com`;
     const password = 'suchagreatpassword123';
     await registerNewUser(page, email, password);
-    await expect(
-        page.getByRole('button', { name: "John's Organization" })
-    ).toBeVisible();
-    await page.locator('#currentUserButton').click();
-
-    await page.getByRole('button', { name: 'Log Out' }).click();
+    await expect(page.getByTestId('dashboard_view')).toBeVisible();
+    await page.getByTestId('current_user_button').click();
+    await page.getByText('Log Out').click();
     await page.waitForURL(PLAYWRIGHT_BASE_URL + '/');
     await page.goto(PLAYWRIGHT_BASE_URL + '/login');
     await page.getByLabel('Email').fill(email);
     await page.getByLabel('Password').fill(password);
     await page.getByRole('button', { name: 'Log in' }).click();
-    await expect(
-        page.getByRole('heading', { name: 'Dashboard' })
-    ).toBeVisible();
+    await expect(page.getByTestId('dashboard_view')).toBeVisible();
 });
 
 test('can register and delete account', async ({ page }) => {

diff --git a/e2e/organization.spec.ts b/e2e/organization.spec.ts
@@ -3,23 +3,37 @@ import { PLAYWRIGHT_BASE_URL } from '../playwright/config';
 
 async function goToOrganizationSettings(page) {
     await page.goto(PLAYWRIGHT_BASE_URL + '/dashboard');
-    await page.locator('#currentTeamButton').click();
-    await page.getByRole('link', { name: 'Team Settings' }).click();
+    await page.getByTestId('organization_switcher').click();
+    await page.getByText('Team Settings').click();
 }
 
 test('test that organization name can be updated', async ({ page }) => {
     await goToOrganizationSettings(page);
     await page.getByLabel('Team Name').fill('NEW ORG NAME');
     await page.getByLabel('Team Name').press('Enter');
     await page.getByLabel('Team Name').press('Meta+r');
-    await expect(page.getByRole('navigation')).toContainText('NEW ORG NAME');
+    await expect(page.getByTestId('organization_switcher')).toContainText(
+        'NEW ORG NAME'
+    );
+});
+
+test('test that new manager can be invited', async ({ page }) => {
+    await goToOrganizationSettings(page);
+    const editorId = Math.round(Math.random() * 10000);
+    await page.getByLabel('Email').fill(`new+${editorId}@editor.test`);
+    await page.getByRole('button', { name: 'Manager' }).click();
+    await page.getByRole('button', { name: 'Add' }).click();
+    await page.reload();
+    await expect(page.getByRole('main')).toContainText(
+        `new+${editorId}@editor.test`
+    );
 });
 
-test('test that new editor can be invited', async ({ page }) => {
+test('test that new employee can be invited', async ({ page }) => {
     await goToOrganizationSettings(page);
     const editorId = Math.round(Math.random() * 10000);
     await page.getByLabel('Email').fill(`new+${editorId}@editor.test`);
-    await page.getByRole('button', { name: 'Editor' }).click();
+    await page.getByRole('button', { name: 'Employee' }).click();
     await page.getByRole('button', { name: 'Add' }).click();
     await page.reload();
     await expect(page.getByRole('main')).toContainText(