Merge branch 'main' into refactor/nonnegative-rating

e2e/src/specs/server/api/asset.e2e-spec.ts

@@ -566,20 +566,6 @@ describe('/asset', () => {
       expect(status).toEqual(200);
     });
 
-    it('should set the negative rating', async () => {
-      const { status, body } = await request(app)
-        .put(`/assets/${user1Assets[0].id}`)
-        .set('Authorization', `Bearer ${user1.accessToken}`)
-        .send({ rating: -1 });
-      expect(body).toMatchObject({
-        id: user1Assets[0].id,
-        exifInfo: expect.objectContaining({
-          rating: -1,
-        }),
-      });
-      expect(status).toEqual(200);
-    });
-
     it('should return tagged people', async () => {
       const { status, body } = await request(app)
         .put(`/assets/${user1Assets[0].id}`)

mobile/openapi/lib/model/asset_bulk_update_dto.dart

@@ -97,7 +97,7 @@ class AssetBulkUpdateDto {
 
   /// Rating in range [1-5], or null for unrated
   ///
-  /// Minimum value: -1
+  /// Minimum value: 0
   /// Maximum value: 5
   int? rating;
 

mobile/openapi/lib/model/exif_response_dto.dart

@@ -108,8 +108,8 @@ class ExifResponseDto {
 
   /// Rating
   ///
-  /// Minimum value: -9007199254740991
+  /// Minimum value: 1
-  /// Maximum value: 9007199254740991
+  /// Maximum value: 5
   int? rating;
 
   /// State/province name

mobile/openapi/lib/model/metadata_search_dto.dart

@@ -238,7 +238,7 @@ class MetadataSearchDto {
 
   /// Filter by rating [1-5], or null for unrated
   ///
-  /// Minimum value: -1
+  /// Minimum value: 0
   /// Maximum value: 5
   int? rating;
 

mobile/openapi/lib/model/random_search_dto.dart

@@ -145,7 +145,7 @@ class RandomSearchDto {
 
   /// Filter by rating [1-5], or null for unrated
   ///
-  /// Minimum value: -1
+  /// Minimum value: 0
   /// Maximum value: 5
   int? rating;
 

mobile/openapi/lib/model/smart_search_dto.dart

@@ -186,7 +186,7 @@ class SmartSearchDto {
 
   /// Filter by rating [1-5], or null for unrated
   ///
-  /// Minimum value: -1
+  /// Minimum value: 0
   /// Maximum value: 5
   int? rating;
 

mobile/openapi/lib/model/statistics_search_dto.dart

@@ -150,7 +150,7 @@ class StatisticsSearchDto {
 
   /// Filter by rating [1-5], or null for unrated
   ///
-  /// Minimum value: -1
+  /// Minimum value: 0
   /// Maximum value: 5
   int? rating;
 

mobile/openapi/lib/model/update_asset_dto.dart

@@ -79,7 +79,7 @@ class UpdateAssetDto {
 
   /// Rating in range [1-5], or null for unrated
   ///
-  /// Minimum value: -1
+  /// Minimum value: 0
   /// Maximum value: 5
   int? rating;
 

open-api/immich-openapi-specs.json

@@ -9369,12 +9369,17 @@
                 "version": "v2.6.0",
                 "state": "Updated",
                 "description": "Using -1 as a rating is deprecated and will be removed in the next major version."
+              },
+              {
+                "version": "v3",
+                "state": "Updated",
+                "description": "Using -1 as a rating is no longer valid."
               }
             ],
             "x-immich-state": "Stable",
             "schema": {
               "type": "integer",
-              "minimum": -1,
+              "minimum": 0,
               "maximum": 5,
               "nullable": true
             }
@@ -15678,7 +15683,7 @@
           "rating": {
             "description": "Rating in range [1-5], or null for unrated",
             "maximum": 5,
-            "minimum": -1,
+            "minimum": 0,
             "nullable": true,
             "type": "integer",
             "x-immich-history": [
@@ -15694,6 +15699,11 @@
                 "version": "v2.6.0",
                 "state": "Updated",
                 "description": "Using -1 as a rating is deprecated and will be removed in the next major version."
+              },
+              {
+                "version": "v3",
+                "state": "Updated",
+                "description": "Using -1 as a rating is no longer valid."
               }
             ],
             "x-immich-state": "Stable"
@@ -17738,8 +17748,8 @@
           "rating": {
             "default": null,
             "description": "Rating",
-            "maximum": 9007199254740991,
+            "maximum": 5,
-            "minimum": -9007199254740991,
+            "minimum": 1,
             "nullable": true,
             "type": "integer"
           },
@@ -18769,7 +18779,7 @@
           "rating": {
             "description": "Filter by rating [1-5], or null for unrated",
             "maximum": 5,
-            "minimum": -1,
+            "minimum": 0,
             "nullable": true,
             "type": "integer",
             "x-immich-history": [
@@ -18785,6 +18795,11 @@
                 "version": "v2.6.0",
                 "state": "Updated",
                 "description": "Using -1 as a rating is deprecated and will be removed in the next major version."
+              },
+              {
+                "version": "v3",
+                "state": "Updated",
+                "description": "Using -1 as a rating is no longer valid."
               }
             ],
             "x-immich-state": "Stable"
@@ -20622,7 +20637,7 @@
           "rating": {
             "description": "Filter by rating [1-5], or null for unrated",
             "maximum": 5,
-            "minimum": -1,
+            "minimum": 0,
             "nullable": true,
             "type": "integer",
             "x-immich-history": [
@@ -20638,6 +20653,11 @@
                 "version": "v2.6.0",
                 "state": "Updated",
                 "description": "Using -1 as a rating is deprecated and will be removed in the next major version."
+              },
+              {
+                "version": "v3",
+                "state": "Updated",
+                "description": "Using -1 as a rating is no longer valid."
               }
             ],
             "x-immich-state": "Stable"
@@ -22006,7 +22026,7 @@
           "rating": {
             "description": "Filter by rating [1-5], or null for unrated",
             "maximum": 5,
-            "minimum": -1,
+            "minimum": 0,
             "nullable": true,
             "type": "integer",
             "x-immich-history": [
@@ -22022,6 +22042,11 @@
                 "version": "v2.6.0",
                 "state": "Updated",
                 "description": "Using -1 as a rating is deprecated and will be removed in the next major version."
+              },
+              {
+                "version": "v3",
+                "state": "Updated",
+                "description": "Using -1 as a rating is no longer valid."
               }
             ],
             "x-immich-state": "Stable"
@@ -22266,7 +22291,7 @@
           "rating": {
             "description": "Filter by rating [1-5], or null for unrated",
             "maximum": 5,
-            "minimum": -1,
+            "minimum": 0,
             "nullable": true,
             "type": "integer",
             "x-immich-history": [
@@ -22282,6 +22307,11 @@
                 "version": "v2.6.0",
                 "state": "Updated",
                 "description": "Using -1 as a rating is deprecated and will be removed in the next major version."
+              },
+              {
+                "version": "v3",
+                "state": "Updated",
+                "description": "Using -1 as a rating is no longer valid."
               }
             ],
             "x-immich-state": "Stable"
@@ -25277,7 +25307,7 @@
           "rating": {
             "description": "Rating in range [1-5], or null for unrated",
             "maximum": 5,
-            "minimum": -1,
+            "minimum": 0,
             "nullable": true,
             "type": "integer",
             "x-immich-history": [
@@ -25293,6 +25323,11 @@
                 "version": "v2.6.0",
                 "state": "Updated",
                 "description": "Using -1 as a rating is deprecated and will be removed in the next major version."
+              },
+              {
+                "version": "v3",
+                "state": "Updated",
+                "description": "Using -1 as a rating is no longer valid."
               }
             ],
             "x-immich-state": "Stable"

server/src/controllers/asset.controller.spec.ts

@@ -230,7 +230,7 @@ describe(AssetController.name, () => {
 
     it('should leave correct ratings as-is', async () => {
       const assetId = factory.uuid();
-      for (const test of [{ rating: -1 }, { rating: 1 }, { rating: 5 }]) {
+      for (const test of [{ rating: 1 }, { rating: 5 }]) {
         const { status } = await request(ctx.getHttpServer()).put(`/assets/${assetId}`).send(test);
         expect(service.update).toHaveBeenCalledWith(undefined, assetId, test);
         expect(status).toBe(200);

server/src/dtos/asset.dto.ts

@@ -14,9 +14,8 @@ const UpdateAssetBaseSchema = z
     latitude: latitudeSchema.optional().describe('Latitude coordinate'),
     longitude: longitudeSchema.optional().describe('Longitude coordinate'),
     rating: z
-      .number()
       .int()
-      .min(-1)
+      .min(0)
       .max(5)
       .transform((value) => (value === 0 ? null : value))
       .nullish()
@@ -26,6 +25,7 @@ const UpdateAssetBaseSchema = z
           .added('v1')
           .stable('v2')
           .updated('v2.6.0', 'Using -1 as a rating is deprecated and will be removed in the next major version.')
+          .updated('v3', 'Using -1 as a rating is no longer valid.')
           .getExtensions(),
       }),
     description: z.string().optional().describe('Asset description'),

server/src/dtos/exif.dto.ts

@@ -29,7 +29,7 @@ export const ExifResponseSchema = z
     country: z.string().nullish().default(null).describe('Country name'),
     description: z.string().nullish().default(null).describe('Image description'),
     projectionType: z.string().nullish().default(null).describe('Projection type'),
-    rating: z.int().nullish().default(null).describe('Rating'),
+    rating: z.int().min(1).max(5).nullish().default(null).describe('Rating'),
   })
   .describe('EXIF response')
   .meta({ id: 'ExifResponseDto' });

server/src/dtos/search.dto.ts

@@ -35,8 +35,9 @@ const BaseSearchSchema = z.object({
   albumIds: z.array(z.uuidv4()).optional().describe('Filter by album IDs'),
   rating: z
     .int()
-    .min(-1)
+    .min(0)
     .max(5)
+    .transform((value) => (value === 0 ? null : value))
     .nullish()
     .describe('Filter by rating [1-5], or null for unrated')
     .meta({
@@ -44,6 +45,7 @@ const BaseSearchSchema = z.object({
         .added('v1')
         .stable('v2')
         .updated('v2.6.0', 'Using -1 as a rating is deprecated and will be removed in the next major version.')
+        .updated('v3', 'Using -1 as a rating is no longer valid.')
         .getExtensions(),
     }),
   ocr: z.string().optional().describe('Filter by OCR text content'),

server/src/schema/migrations/1776429021231-ConvertNegativeRatingToNull.ts

@@ -0,0 +1,9 @@
+import { Kysely, sql } from 'kysely';
+
+export async function up(db: Kysely<any>): Promise<void> {
+  await sql`UPDATE "asset_exif" SET "rating" = NULL WHERE "rating" = -1;`.execute(db);
+}
+
+export async function down(): Promise<void> {
+  // not supported
+}

server/src/services/metadata.service.spec.ts

@@ -1436,20 +1436,6 @@ describe(MetadataService.name, () => {
       );
     });
 
-    it('should handle valid negative rating value', async () => {
-      const asset = AssetFactory.create();
-      mocks.assetJob.getForMetadataExtraction.mockResolvedValue(getForMetadataExtraction(asset));
-      mockReadTags({ Rating: -1 });
-
-      await sut.handleMetadataExtraction({ id: asset.id });
-      expect(mocks.asset.upsertExif).toHaveBeenCalledWith(
-        expect.objectContaining({
-          rating: -1,
-        }),
-        { lockedPropertiesBehavior: 'skip' },
-      );
-    });
-
     it('should handle livePhotoCID not set', async () => {
       const asset = AssetFactory.create();
       mocks.assetJob.getForMetadataExtraction.mockResolvedValue(getForMetadataExtraction(asset));

server/src/services/metadata.service.ts

@@ -304,7 +304,7 @@ export class MetadataService extends BaseService {
       // comments
       description: String(exifTags.ImageDescription || exifTags.Description || '').trim(),
       profileDescription: exifTags.ProfileDescription || null,
-      rating: exifTags.Rating === 0 ? null : validateRange(exifTags.Rating, -1, 5),
+      rating: exifTags.Rating === 0 ? null : validateRange(exifTags.Rating, 1, 5),
 
       // grouping
       livePhotoCID: (exifTags.ContentIdentifier || exifTags.MediaGroupUUID) ?? null,

server/src/utils/duplicate.spec.ts

@@ -78,7 +78,7 @@ describe('duplicate utils', () => {
         model: null,
         latitude: undefined,
         city: '',
-        rating: 0,
+        rating: null,
       });
       // fileSizeInByte (1000) + make ('Canon') = 2 truthy values
       // model (null), latitude (undefined), city (''), rating (0) are all falsy