[Task]: Add mongoDB unique index for slug field in Tenant collection

[NilanshBansal]

SubTasks

The Tenant domain slug field has an @Unique annotation but there is no unique index for slug field in the mongo database. We should add an index in the database to maintain consistentency.

[akshayvijayjain]

@NilanshBansal , we plan to work on this, can we take it up?

[NilanshBansal]

@akshayvijayjain yes definitely.

[Naveen-Goud]

@NilanshBansal can we use@Indexed annotation instead of @Unique, to gererate unique slug id in db. The difference between two annotations is:

The @Unique annotation might be mistakenly thought to enforce uniqueness in the database, but this is not the case. There is no standard @Unique annotation in Spring Data or Java for enforcing database-level constraints. The @Unique annotation you mentioned could be from a custom or non-standard library, but it is not required and not commonly used for this purpose.

@Indexed(unique = true): This annotation tells Spring Data MongoDB to create a unique index on the slug field. This ensures that each document in the Tenant collection will have a unique slug value. MongoDB will enforce this constraint at the database level.

below is the screenshot with the updated change

can you review and give feedback whether to use this annotation or not?

[nidhi-nair]

@Naveen-Goud , agreed with your analysis. However, as a practice, we rely on migrations to create indices in the database and not annotations. The ask from this issue is that we create such a migration for this field as well. The reason we opt for migrations and not annotations is that the annotation is a part of compiled code. Spring auto-magically creates the index if it finds such a reference in code. However, if the annotation were to be slipped as part of any refactor, future "fresh DBs" would not have this index at all. This is much harder to do with migrations.

[Naveen-Goud]

hello @nidhi-nair , thanks for the response , I couldn't understand last statement regarding "fresh db's". but I have worked on task , and replaced with @Indexed , and also made a migration file which generate a unigue index for the slug field.

this migration wil make the slug field unique id and will not accept any id which are similar , if the data s similar then it returns error

and also because of the migration step , the slud id are arranged in ascending order.

I also have a question , if we insert data with one field , the slug is considering null as id for first time and not allowing to create another object with inserting one field.

does the task also says that id's should be created in db when we try insert data without slug field?

[NilanshBansal]

This seems like a premature optimization as currently we have not moved to multi-tenancy. Right now, there is only 1 document in the Tenant collection always as there is only a single Tenant. Adding index to that does not make much sense right now. When we implement multi-tenancy we might figure out that ensuring uniqueness only on this field might not suffice. We might need to add other fields along with it to make a composite unique index. Closing this task right now, can reopen when we move to multi-tenancy.