Sequelize查询结果嵌套数据结构扁平化问题求助

问题背景 #

基于Node.js开发的应用使用Sequelize作为ORM，查询用户详情时关联了角色与权限数据，当前返回结构中permissions数组嵌套在role对象内，而role又位于user_details层级下。需求如下：

1. 将permissions数组扁平化，直接挂载到user_details下
2. 把关联的module.name字段作为module_name合并到每个permission对象中
3. 曾尝试将role层级的attributes设为空数组，触发错误：Cannot read properties of undefined (reading 'permissions')

当前查询代码：

// Create a findOptions object for findByEmail
const findOptions = {
    attributes: {
        include: [[Sequelize.col('role.name'), 'role_name']]
    },
    include: [
        {
            as: 'role',
            model: Role,
            required: true,
            attributes: ['id'],
            include: [
                {
                    required: true,
                    as: 'permissions',
                    model: Permission,
                    attributes: ['id', 'read', 'create', 'update', 'delete', 'module_id'],
                    include: [
                        {
                            as: 'module',
                            model: Module,
                            required: true,
                            attributes: ['name']
                        }
                    ]
                }
            ]
        }
    ]
};

// Check if the email is already associated with another account
const user = await this.userRepository.findByEmail(payload.email, findOptions);

解决方案 #

一、错误原因解析 #

当将role层级的attributes设为空数组时，Sequelize不会在返回的user对象中生成role属性，后续访问user.role.permissions自然会触发undefined读取错误。必须保留至少一个属性让Sequelize返回完整的role对象，或通过查询后处理规避该问题。

二、查询后数据重组（推荐方案） #

先通过查询获取完整的关联数据，再手动调整结构，灵活性更高：

1. 调整查询配置（确保role正常返回）

const findOptions = {
    attributes: {
        include: [[Sequelize.col('role.name'), 'role_name']]
    },
    include: [
        {
            as: 'role',
            model: Role,
            required: true,
            attributes: ['id', 'name'], // 保留必要属性，避免role为undefined
            include: [
                {
                    required: true,
                    as: 'permissions',
                    model: Permission,
                    attributes: ['id', 'read', 'create', 'update', 'delete', 'module_id'],
                    include: [
                        {
                            as: 'module',
                            model: Module,
                            required: true,
                            attributes: ['name']
                        }
                    ]
                }
            ]
        }
    ]
};

2. 查询后处理数据结构

const user = await this.userRepository.findByEmail(payload.email, findOptions);

if (user) {
    // 转换Sequelize实例为普通对象（如果需要）
    const userObj = user.toJSON ? user.toJSON() : user;
    
    // 处理权限数组：添加module_name并移除原module对象
    const processedPermissions = userObj.role.permissions.map(perm => ({
        ...perm,
        module_name: perm.module.name,
        module: undefined
    }));
    
    // 将权限挂载到user_details下
    userObj.user_details.permissions = processedPermissions;
    
    // 可选：移除原role对象（若业务无需保留）
    delete userObj.role;
    
    // 使用处理后的userObj进行后续操作
    return userObj;
}

三、查询阶段直接映射字段（简化后续处理） #

通过Sequelize的字段映射，直接在查询时将module.name转为module_name，减少后续处理步骤：

const findOptions = {
    attributes: {
        include: [[Sequelize.col('role.name'), 'role_name']]
    },
    include: [
        {
            as: 'role',
            model: Role,
            required: true,
            attributes: ['id', 'name'],
            include: [
                {
                    required: true,
                    as: 'permissions',
                    model: Permission,
                    attributes: [
                        'id', 'read', 'create', 'update', 'delete', 'module_id',
                        [Sequelize.col('module.name'), 'module_name'] // 直接映射module.name为module_name
                    ],
                    include: [
                        {
                            as: 'module',
                            model: Module,
                            required: true,
                            attributes: [] // 无需返回原module对象
                        }
                    ]
                }
            ]
        }
    ]
};

查询后只需将user.role.permissions数组移到user.user_details下即可，无需再处理module_name字段。

内容的提问来源于stack exchange，提问作者RAHUL KUNDU