Inherit belongsTo() relations form parent Model

[ad-on-is]

Many of my models share the same properties/relations. I'd want to extract these in a separate parent class

While columns such as createdAt work just fine, the relations throw an error, in this case the belongsTo()

export default class BaseAppModel extends compose(BaseModel, SoftDeletes) {
  @column.dateTime({ autoCreate: true })
  public createdAt: DateTime

  @column.dateTime({ autoCreate: true, autoUpdate: true })
  public updatedAt: DateTime

  @column()
  public creatorId: string

  @belongsTo(() => User, {
    foreignKey: 'creatorId',
  })
  public creator: BelongsTo<typeof User>


}

export default class User extends BaseAppModel {}

When I do something like return User.query() in my Controller, I get the following error.

{
	"message": "Cannot read properties of undefined (reading 'primaryKey')",
	"stack": "TypeError: Cannot read properties of undefined (reading 'primaryKey')\n    at SnakeCaseNamingStrategy.relationLocalKey (/home/adonis/Development/Node/my_cool_project/node_modules/.pnpm/@adonisjs+lucid@16.3.2_@adonisjs+core@5.4.2+pg@8.7.1/node_modules/@adonisjs/lucid/build/src/Orm/NamingStrategies/SnakeCase.js:40:33)\n    at BelongsTo.boot (/home/adonis/Development/Node/my_cool_project/node_modules/.pnpm/@adonisjs+lucid@16.3.2_@adonisjs+core@5.4.2+pg@8.7.1/node_modules/@adonisjs/lucid/build/src/Orm/Relations/BelongsTo/index.js:144:47)\n    at /home/adonis/Development/Node/my_cool_project/node_modules/.pnpm/@adonisjs+lucid@16.3.2_@adonisjs+core@5.4.2+pg@8.7.1/node_modules/@adonisjs/lucid/build/src/Orm/BaseModel/index.js:504:31\n    at Map.forEach (<anonymous>)\n    at /home/adonis/Development/Node/my_cool_project/node_modules/.pnpm/@adonisjs+lucid@16.3.2_@adonisjs+core@5.4.2+pg@8.7.1/node_modules/@adonisjs/lucid/build/src/Orm/BaseModel/index.js:502:19\n    at defineStaticProperty (/home/adonis/Development/Node/my_cool_project/node_modules/.pnpm/@poppinss+utils@3.3.1/node_modules/@poppinss/utils/build/src/defineStaticProperty.js:50:53)\n    at Function.$defineProperty (/home/adonis/Development/Node/my_cool_project/node_modules/.pnpm/@adonisjs+lucid@16.3.2_@adonisjs+core@5.4.2+pg@8.7.1/node_modules/@adonisjs/lucid/build/src/Orm/BaseModel/index.js:433:42)\n    at Function.boot (/home/adonis/Development/Node/my_cool_project/node_modules/.pnpm/@adonisjs+lucid@16.3.2_@adonisjs+core@5.4.2+pg@8.7.1/node_modules/@adonisjs/lucid/build/src/Orm/BaseModel/index.js:500:14)\n    at decorateAsColumn (/home/adonis/Development/Node/my_cool_project/node_modules/.pnpm/@adonisjs+lucid@16.3.2_@adonisjs+core@5.4.2+pg@8.7.1/node_modules/@adonisjs/lucid/build/src/Orm/Decorators/index.js:23:15)\n    at DecorateProperty (/home/adonis/Development/Node/my_cool_project/node_modules/.pnpm/reflect-metadata@0.1.13/node_modules/reflect-metadata/Reflect.js:553:33)"
}

Am I doing something wrong, or is this not possible?

[amraei]

I'm also facing the same problem.

[thetutlage]

What happens when you call User.boot() inside the User model?

export default class User extends BaseAppModel {}

User.boot()

[amraei]

@thetutlage Nothing for me. The same error occurs even If I extend any other model (rather than User) from BaseAppModel.

function ShareableModel<T extends NormalizeConstructor<LucidModel>>(superclass: T) {
  class AShareableModel extends superclass {
    @column({ isPrimary: true })
    public id: number;

    @column()
    public ownerId: number;

    @belongsTo(() => User, {
      foreignKey: 'ownerId'
    })
    public owner: BelongsTo<typeof User>;

  }

  return AShareableModel;
}

class Project extends compose(BaseModel, ShareableModel) {}

Then calling User.find(1) throws the same error:

It worth to mention this error occurs only if the mixin or parent class has a belongsTo relation. For other type of relations, it works.

[thetutlage]

Can you please create a fresh project, reproduce this error and share it with me? Because I am not able to do so

[amraei]

@thetutlage Here I attached a fresh project which reproduce the error.
reproduction.zip

There is a mixin:

• Shareable (implements a belongsTo relation to User using ownerId)

There are 3 models:

• User (which has many Projects)
• Project (which has many Items)
• Item (which extends Shareable)

Just by running npm run dev, the error occurs.

[amraei]

@thetutlage No chance?

[Melchyore]

I am also facing the same problem. I have tried many approaches but unfortunately without success.

[Melchyore]

After some investigation, it seems like the decorator isn't registering the relationship correctly. The first argument of the decorator which should return the related model, returns undefined actually.

Maybe it should be converted into an issue in the @adonisjs/lucid repository? I can provide a repo to demonstrate the issue, if needed.

[isimisi]

Anyone found a fix? - it seems like the child models' boot method never gets called?

[IgorArnaut]

NOPE!