Refactor API for albums feature (#155)

* Rename "shared" to "album"

Prepare moving "SharedAlbums" to "Albums"

* Update server album API endpoints

* Update mobile app album endpoints

Also add `putRequest` to mobile network.service

* Add GET album collection filter

- allow to filter by owner = 'mine' | 'their'
- make sharedWithUserIds no longer required when creating an album

* Rename remaining variables to "album"

* Add ParseMeUUIDPipe to validate uuid or `me`

* Add album params validation

* Update todo in mobile album service.

* Setup e2e testing

* Add user e2e tests

* Rename database host env variable to DB_HOST

* Add some `Album` e2e tests

Also fix issues found with the tests

* Force push (try to recover DB_HOST env)

* Rename db host env variable to `DB_HOSTNAME`

* Remove unnecessary `initDb` from test-utils

The current database.config is running the migrations:
`migrationsRun: true`

* Remove `initDb` usage from album e2e test

* Update GET albums filter to `shared`

- add filter by all / shared / not shared
- add response DTOs
- add GET albums e2e tests

* Update album e2e tests for user.service changes

* Update mobile app to use album response DTOs

* Refactor album-service DB into album-registry

- DB logic refactored into album-repository making it easier to test
- add some album-service unit tests
- add `clearMocks` to jest configuration

* Finish implementing album.service unit tests

* Rename response DTO

Make them consistent with rest of the project naming

* Update debug log messages in mobile network service

* Rename table `shared_albums` to `albums`

* Rename table `asset_shared_album`

* Rename Albums `sharedAssets` to `assets`

* Update tests to match updated "delete" response

* Fixed asset cannot be compared in Set by adding Equatable package

* Remove hero effect to fixed janky animation

Co-authored-by: Alex <alex.tran1502@gmail.com>

server/libs/database/src/entities/album.entity.ts

@@ -0,0 +1,27 @@
+import { Column, CreateDateColumn, Entity, OneToMany, PrimaryGeneratedColumn } from 'typeorm';
+import { AssetAlbumEntity } from './asset-album.entity';
+import { UserAlbumEntity } from './user-album.entity';
+
+@Entity('albums')
+export class AlbumEntity {
+  @PrimaryGeneratedColumn('uuid')
+  id: string;
+
+  @Column()
+  ownerId: string;
+
+  @Column({ default: 'Untitled Album' })
+  albumName: string;
+
+  @CreateDateColumn({ type: 'timestamptz' })
+  createdAt: string;
+
+  @Column({ comment: 'Asset ID to be used as thumbnail', nullable: true })
+  albumThumbnailAssetId: string;
+
+  @OneToMany(() => UserAlbumEntity, (userAlbums) => userAlbums.albumInfo)
+  sharedUsers: UserAlbumEntity[];
+
+  @OneToMany(() => AssetAlbumEntity, (assetAlbumEntity) => assetAlbumEntity.albumInfo)
+  assets: AssetAlbumEntity[];
+}

server/libs/database/src/entities/asset-album.entity.ts

@@ -1,10 +1,10 @@
-import { Column, Entity, JoinColumn, ManyToOne, OneToOne, PrimaryGeneratedColumn, Unique } from 'typeorm';
+import { Column, Entity, JoinColumn, ManyToOne, PrimaryGeneratedColumn, Unique } from 'typeorm';
+import { AlbumEntity } from './album.entity';
 import { AssetEntity } from './asset.entity';
-import { SharedAlbumEntity } from './shared-album.entity';
 
-@Entity('asset_shared_album')
+@Entity('asset_album')
 @Unique('PK_unique_asset_in_album', ['albumId', 'assetId'])
-export class AssetSharedAlbumEntity {
+export class AssetAlbumEntity {
   @PrimaryGeneratedColumn()
   id: string;
 
@@ -14,12 +14,12 @@ export class AssetSharedAlbumEntity {
   @Column()
   assetId: string;
 
-  @ManyToOne(() => SharedAlbumEntity, (sharedAlbum) => sharedAlbum.sharedAssets, {
+  @ManyToOne(() => AlbumEntity, (album) => album.assets, {
     onDelete: 'CASCADE',
     nullable: true,
   })
   @JoinColumn({ name: 'albumId' })
-  albumInfo: SharedAlbumEntity;
+  albumInfo: AlbumEntity;
 
   @ManyToOne(() => AssetEntity, {
     onDelete: 'CASCADE',

server/libs/database/src/entities/shared-album.entity.ts

@@ -1,27 +0,0 @@
-import { Column, CreateDateColumn, Entity, OneToMany, PrimaryGeneratedColumn } from 'typeorm';
-import { AssetSharedAlbumEntity } from './asset-shared-album.entity';
-import { UserSharedAlbumEntity } from './user-shared-album.entity';
-
-@Entity('shared_albums')
-export class SharedAlbumEntity {
-  @PrimaryGeneratedColumn('uuid')
-  id: string;
-
-  @Column()
-  ownerId: string;
-
-  @Column({ default: 'Untitled Album' })
-  albumName: string;
-
-  @CreateDateColumn({ type: 'timestamptz' })
-  createdAt: string;
-
-  @Column({ comment: 'Asset ID to be used as thumbnail', nullable: true })
-  albumThumbnailAssetId: string;
-
-  @OneToMany(() => UserSharedAlbumEntity, (userSharedAlbums) => userSharedAlbums.albumInfo)
-  sharedUsers: UserSharedAlbumEntity[];
-
-  @OneToMany(() => AssetSharedAlbumEntity, (assetSharedAlbumEntity) => assetSharedAlbumEntity.albumInfo)
-  sharedAssets: AssetSharedAlbumEntity[];
-}

server/libs/database/src/entities/user-album.entity.ts

@@ -1,10 +1,10 @@
-import { Column, Entity, JoinColumn, ManyToOne, OneToOne, PrimaryGeneratedColumn, Unique } from 'typeorm';
+import { Column, Entity, JoinColumn, ManyToOne, PrimaryGeneratedColumn, Unique } from 'typeorm';
 import { UserEntity } from './user.entity';
-import { SharedAlbumEntity } from './shared-album.entity';
+import { AlbumEntity } from './album.entity';
 
 @Entity('user_shared_album')
 @Unique('PK_unique_user_in_album', ['albumId', 'sharedUserId'])
-export class UserSharedAlbumEntity {
+export class UserAlbumEntity {
   @PrimaryGeneratedColumn()
   id: string;
 
@@ -14,12 +14,12 @@ export class UserSharedAlbumEntity {
   @Column()
   sharedUserId: string;
 
-  @ManyToOne(() => SharedAlbumEntity, (sharedAlbum) => sharedAlbum.sharedUsers, {
+  @ManyToOne(() => AlbumEntity, (album) => album.sharedUsers, {
     onDelete: 'CASCADE',
     nullable: true,
   })
   @JoinColumn({ name: 'albumId' })
-  albumInfo: SharedAlbumEntity;
+  albumInfo: AlbumEntity;
 
   @ManyToOne(() => UserEntity)
   @JoinColumn({ name: 'sharedUserId' })

server/libs/database/src/migrations/1655401127251-RenameSharedAlbums.ts

@@ -0,0 +1,19 @@
+import { MigrationInterface, QueryRunner } from 'typeorm';
+
+export class RenameSharedAlbums1655401127251 implements MigrationInterface {
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(`
+      ALTER TABLE shared_albums RENAME TO albums;
+
+      ALTER TABLE asset_shared_album RENAME TO asset_album;
+    `);
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(`
+      ALTER TABLE asset_album RENAME TO asset_shared_album;
+
+      ALTER TABLE albums RENAME TO shared_albums;
+    `);
+  }
+}