fix: enable passing id for post in case id has generated set to false

Signed-off-by: Muhammad Aaqil <[email protected]>

Author: aaqilniz

examples/access-control-migration/src/models/user-credentials.model.ts

@@ -10,6 +10,7 @@ export class UserCredentials extends Entity {
   @property({
     type: 'number',
     id: true,
+    generated: true,
   })
   id: number;
 

examples/express-composition/src/models/note.model.ts

@@ -10,6 +10,7 @@ export class Note extends Entity {
   @property({
     type: 'number',
     id: true,
+    generated: true,
   })
   id?: number;
 

examples/passport-login/src/models/user-credentials.model.ts

@@ -11,6 +11,7 @@ export class UserCredentials extends Entity {
   @property({
     type: 'string',
     id: true,
+    generated: false,
   })
   id: string;
 

examples/passport-login/src/models/user-identity.model.ts

@@ -11,6 +11,7 @@ export class UserIdentity extends Entity {
   @property({
     type: 'string',
     id: true,
+    generated: false,
   })
   id: string;
 

examples/rest-crud/src/models/todo.model.ts

@@ -10,7 +10,7 @@ export class Todo extends Entity {
   @property({
     type: 'number',
     id: true,
-    generated: false,
+    generated: true,
   })
   id?: number;
 

examples/todo/src/models/todo.model.ts

@@ -10,7 +10,7 @@ export class Todo extends Entity {
   @property({
     type: 'number',
     id: true,
-    generated: false,
+    generated: true,
   })
   id?: number;
 

packages/repository/src/__tests__/unit/model/define-model-class.unit.ts

@@ -53,7 +53,11 @@ describe('defineModelClass', () => {
 
   it('creates an Entity class', () => {
     const definition = new ModelDefinition('Product')
-      .addProperty('id', {type: 'number', id: true})
+      .addProperty('id', {
+        type: 'number',
+        id: true,
+        generated: true,
+      })
       .addProperty('name', {
         type: 'string',
       });
@@ -70,6 +74,7 @@ describe('defineModelClass', () => {
 
     // Verify that typedefs allows us to access static Entity properties
     expect(Product.getIdProperties()).to.deepEqual(['id']);
+    expect(Product.getExcludeProperties()).to.deepEqual(['id']);
 
     // Verify that typedefs allows us to create new model instances
     const instance = new Product({id: 1, name: 'a name'});
@@ -83,7 +88,11 @@ describe('defineModelClass', () => {
 
   it('creates a free-form Entity', () => {
     const definition = new ModelDefinition('FreeForm')
-      .addProperty('id', {type: 'number', id: true})
+      .addProperty('id', {
+        type: 'number',
+        id: true,
+        generated: true,
+      })
       .addSetting('strict', false);
 
     const FreeForm = defineModelClass<typeof Entity, AnyObject>(
@@ -98,6 +107,7 @@ describe('defineModelClass', () => {
 
     // Verify that typedefs allows us to access static Entity properties
     expect(FreeForm.getIdProperties()).to.deepEqual(['id']);
+    expect(FreeForm.getExcludeProperties()).to.deepEqual(['id']);
 
     // Verify that typedefs allows us to create new model instances
     const instance = new FreeForm({id: 1, name: 'a name'});

packages/repository/src/model.ts

@@ -444,7 +444,15 @@ export class Entity extends Model implements Persistable {
   static getIdProperties(): string[] {
     return this.definition.idProperties();
   }
-
+  static getExcludeProperties(): string[] {
+    const {properties} = this.definition;
+    const idProps = Object.keys(properties).filter(prop => {
+      if (properties[prop].id && properties[prop].generated) {
+        return properties[prop].id;
+      }
+    });
+    return idProps;
+  }
   /**
    * Get the identity value for a given entity instance or entity data object.
    *

packages/rest-crud/src/__tests__/acceptance/default-model-crud-rest.acceptance.ts

@@ -30,7 +30,7 @@ import {defineCrudRestController} from '../..';
 describe('CrudRestController for a simple Product model', () => {
   @model()
   class Product extends Entity {
-    @property({id: true})
+    @property({id: true, generated: 1})
     id: number;
 
     @property({required: true})
@@ -44,8 +44,47 @@ describe('CrudRestController for a simple Product model', () => {
     }
   }
 
+  @model()
+  class User extends Entity {
+    @property({id: true, generated: 0, defaultFn: 'uuid'})
+    id: string;
+
+    @property({required: true})
+    username: string;
+
+    @property()
+    email?: string;
+
+    constructor(data: Partial<User>) {
+      super(data);
+    }
+  }
+
+  @model()
+  class Customer extends Entity {
+    @property({id: true, generated: 0})
+    id: number;
+
+    @property({required: true})
+    name: string;
+
+    @property()
+    email?: string;
+
+    constructor(data: Partial<Customer>) {
+      super(data);
+    }
+  }
+
   let app: RestApplication;
   let repo: EntityCrudRepository<Product, typeof Product.prototype.id>;
+  let customerRepo: EntityCrudRepository<
+    Customer,
+    typeof Customer.prototype.id
+  >;
+
+  let userRepo: EntityCrudRepository<User, typeof User.prototype.id>;
+
   let client: Client;
 
   // sample data - call `seedData` to populate these items
@@ -76,7 +115,7 @@ describe('CrudRestController for a simple Product model', () => {
       expect(toJSON(found)).to.deepEqual(created);
     });
 
-    it('rejects request with `id` value', async () => {
+    it('rejects request with `id` value when generated is set to 1', async () => {
       const {body} = await client
         .post('/products')
         .send({id: 1, name: 'a name'})
@@ -94,6 +133,29 @@ describe('CrudRestController for a simple Product model', () => {
         ],
       });
     });
+
+    it('creates records when `id` has generated set to 0 with defaultFn', async () => {
+      const user = {username: 'johndoe'};
+      const {body: userCreated} = await client
+        .post('/users')
+        .send(user)
+        .expect(200);
+      expect(userCreated).to.have.property('id').of.type('string');
+      const userFound = (await userRepo.find())[0];
+      expect(toJSON(userFound)).to.deepEqual(userCreated);
+    });
+
+    it('accepts request with `id` value when generated is set to 0', async () => {
+      const customer = {id: 1, name: 'a name'};
+      const {body: customerCreated} = await client
+        .post('/customers')
+        .send(customer)
+        .expect(200);
+      expect(customerCreated).to.containEql(customer);
+      expect(customerCreated).to.have.property('id').of.type('number');
+      const customerFound = (await customerRepo.find())[0];
+      expect(toJSON(customerFound)).to.deepEqual(customerCreated);
+    });
   });
 
   describe('find', () => {
@@ -289,23 +351,53 @@ describe('CrudRestController for a simple Product model', () => {
     const db = new juggler.DataSource({connector: 'memory'});
 
     const ProductRepository = defineCrudRepositoryClass(Product);
+    const CustomerRepository = defineCrudRepositoryClass(Customer);
+    const UserRepository = defineCrudRepositoryClass(User);
 
     repo = new ProductRepository(db);
+    customerRepo = new CustomerRepository(db);
+    userRepo = new UserRepository(db);
 
     const CrudRestController = defineCrudRestController<
       Product,
       typeof Product.prototype.id,
       'id'
     >(Product, {basePath: '/products'});
 
+    const CrudRestControllerForCustomer = defineCrudRestController<
+      Customer,
+      typeof Customer.prototype.id,
+      'id'
+    >(Customer, {basePath: '/customers'});
+
+    const CrudRestControllerForUser = defineCrudRestController<
+      User,
+      typeof User.prototype.id,
+      'id'
+    >(User, {basePath: '/users'});
+
     class ProductController extends CrudRestController {
       constructor() {
         super(repo);
       }
     }
 
+    class CustomerController extends CrudRestControllerForCustomer {
+      constructor() {
+        super(customerRepo);
+      }
+    }
+
+    class UserController extends CrudRestControllerForUser {
+      constructor() {
+        super(userRepo);
+      }
+    }
+
     app = new RestApplication({rest: givenHttpServerConfig()});
     app.controller(ProductController);
+    app.controller(CustomerController);
+    app.controller(UserController);
 
     await app.start();
     client = createRestAppClient(app);

packages/rest-crud/src/crud-rest.controller.ts

@@ -14,23 +14,23 @@ import {
   Where,
 } from '@loopback/repository';
 import {
+  JsonSchemaOptions,
+  MediaTypeObject,
+  ParameterObject,
+  ResponsesObject,
+  SchemaObject,
   api,
   del,
   get,
   getFilterSchemaFor,
   getJsonSchema,
   getModelSchemaRef,
-  JsonSchemaOptions,
   jsonToSchemaObject,
-  MediaTypeObject,
   param,
-  ParameterObject,
   patch,
   post,
   put,
   requestBody,
-  ResponsesObject,
-  SchemaObject,
 } from '@loopback/rest';
 import assert from 'assert';
 
@@ -208,7 +208,7 @@ export function defineCrudRestController<
     async create(
       @body(modelCtor, {
         title: `New${modelName}`,
-        exclude: modelCtor.getIdProperties() as (keyof T)[],
+        exclude: modelCtor.getExcludeProperties() as (keyof T)[],
       })
       data: Omit<T, IdName>,
     ): Promise<T> {