You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
247 lines
7.9 KiB
247 lines
7.9 KiB
import { BaseRecord, BaseResource, flat } from 'adminjs'
|
|
import mongoose from 'mongoose'
|
|
import { get } from 'lodash'
|
|
import { FindOptions } from './utils/filter.types'
|
|
import Property from './property'
|
|
import { convertFilter } from './utils/convert-filter'
|
|
import { createValidationError } from './utils/create-validation-error'
|
|
import { createDuplicateError } from './utils/create-duplicate-error'
|
|
import { createCastError } from './utils/create-cast-error'
|
|
|
|
import errors from './utils/errors'
|
|
|
|
const { MONGOOSE_CAST_ERROR, MONGOOSE_DUPLICATE_ERROR_CODE, MONGOOSE_VALIDATION_ERROR } = errors
|
|
|
|
/**
|
|
* Adapter for mongoose resource
|
|
* @private
|
|
*/
|
|
class Resource extends BaseResource {
|
|
private readonly dbType: string = 'mongodb';
|
|
|
|
/**
|
|
* @typedef {Object} MongooseModel
|
|
* @private
|
|
* @see https://mongoosejs.com/docs/models.html
|
|
*/
|
|
public readonly MongooseModel: mongoose.Model<any>;
|
|
|
|
/**
|
|
* Initialize the class with the Resource name
|
|
* @param {MongooseModel} MongooseModel Class which subclass mongoose.Model
|
|
* @memberof Resource
|
|
*/
|
|
constructor(MongooseModel) {
|
|
super(MongooseModel)
|
|
this.MongooseModel = MongooseModel
|
|
}
|
|
|
|
static isAdapterFor(MoongooseModel) {
|
|
return get(MoongooseModel, 'base.constructor.name') === 'Mongoose'
|
|
}
|
|
|
|
databaseName() {
|
|
return this.MongooseModel.db.name
|
|
}
|
|
|
|
databaseType() {
|
|
return this.dbType
|
|
}
|
|
|
|
name() {
|
|
return this.MongooseModel.modelName
|
|
}
|
|
|
|
id() {
|
|
return this.MongooseModel.modelName
|
|
}
|
|
|
|
properties() {
|
|
return Object.entries(this.MongooseModel.schema.paths).map(([, path], position) => (
|
|
new Property(path, position)
|
|
))
|
|
}
|
|
|
|
property(name:string) {
|
|
return this.properties().find(property => property.path() === name) ?? null
|
|
}
|
|
|
|
async count(filters = null) {
|
|
if (Object.keys(convertFilter(filters)).length > 0) {
|
|
return this.MongooseModel.count(convertFilter(filters))
|
|
}
|
|
return this.MongooseModel.estimatedDocumentCount()
|
|
}
|
|
|
|
async find(filters = {}, { limit = 20, offset = 0, sort = {} }: FindOptions) {
|
|
const { direction, sortBy } = sort
|
|
const sortingParam = {
|
|
[sortBy]: direction,
|
|
}
|
|
const mongooseObjects = await this.MongooseModel
|
|
.find(convertFilter(filters), {}, {
|
|
skip: offset, limit, sort: sortingParam,
|
|
})
|
|
return mongooseObjects.map(mongooseObject => new BaseRecord(
|
|
Resource.stringifyId(mongooseObject), this,
|
|
))
|
|
}
|
|
|
|
async findOne(id:string) {
|
|
const mongooseObject = await this.MongooseModel.findById(id)
|
|
return new BaseRecord(Resource.stringifyId(mongooseObject), this)
|
|
}
|
|
|
|
async findMany(ids: string[]) {
|
|
const mongooseObjects = await this.MongooseModel.find(
|
|
{ _id: ids },
|
|
{},
|
|
)
|
|
return mongooseObjects.map(mongooseObject => (
|
|
new BaseRecord(Resource.stringifyId(mongooseObject), this)
|
|
))
|
|
}
|
|
|
|
build(params) {
|
|
return new BaseRecord(Resource.stringifyId(params), this)
|
|
}
|
|
|
|
async create(params) {
|
|
const parsedParams = this.parseParams(params)
|
|
let mongooseDocument = new this.MongooseModel(parsedParams)
|
|
try {
|
|
mongooseDocument = await mongooseDocument.save()
|
|
} catch (error) {
|
|
if (error.name === MONGOOSE_VALIDATION_ERROR) {
|
|
throw createValidationError(error)
|
|
}
|
|
if (error.code === MONGOOSE_DUPLICATE_ERROR_CODE) {
|
|
throw createDuplicateError(error, mongooseDocument.toJSON())
|
|
}
|
|
throw error
|
|
}
|
|
return Resource.stringifyId(mongooseDocument.toObject())
|
|
}
|
|
|
|
async update(id, params) {
|
|
const parsedParams = this.parseParams(params)
|
|
const unflattedParams = flat.unflatten(parsedParams)
|
|
try {
|
|
const mongooseObject = await this.MongooseModel.findOneAndUpdate({
|
|
_id: id,
|
|
}, {
|
|
$set: unflattedParams,
|
|
}, {
|
|
new: true,
|
|
runValidators: true,
|
|
context: 'query',
|
|
})
|
|
return Resource.stringifyId(mongooseObject.toObject())
|
|
} catch (error) {
|
|
if (error.name === MONGOOSE_VALIDATION_ERROR) {
|
|
throw createValidationError(error)
|
|
}
|
|
if (error.code === MONGOOSE_DUPLICATE_ERROR_CODE) {
|
|
throw createDuplicateError(error, unflattedParams)
|
|
}
|
|
// In update cast errors are not wrapped into a validation errors (as it happens in create).
|
|
// that is why we have to have a different way of handling them - check out tests to see
|
|
// example error
|
|
if (error.name === MONGOOSE_CAST_ERROR) {
|
|
throw createCastError(error)
|
|
}
|
|
throw error
|
|
}
|
|
}
|
|
|
|
async delete(id) {
|
|
return this.MongooseModel.findOneAndRemove({ _id: id })
|
|
}
|
|
|
|
static stringifyId(mongooseObj) {
|
|
// By default Id field is an ObjectID and when we change entire mongoose model to
|
|
// raw object it changes _id field not to a string but to an object.
|
|
// stringify/parse is a path found here: https://github.com/Automattic/mongoose/issues/2790
|
|
// @todo We can somehow speed this up
|
|
const strinigified = JSON.stringify(mongooseObj)
|
|
return JSON.parse(strinigified)
|
|
}
|
|
|
|
/**
|
|
* Check all params against values they hold. In case of wrong value it corrects it.
|
|
*
|
|
* What it does exactly:
|
|
* - changes all empty strings to `null`s for the ObjectID properties.
|
|
* - changes all empty strings to [] for array fields
|
|
*
|
|
* @param {Object} params received from AdminJS form
|
|
*
|
|
* @return {Object} converted params
|
|
*/
|
|
parseParams(params) {
|
|
const parsedParams = { ...params }
|
|
|
|
// this function handles ObjectIDs and Arrays recursively
|
|
const handleProperty = (prefix = '') => (property) => {
|
|
const {
|
|
path,
|
|
schema,
|
|
instance,
|
|
} = property
|
|
// mongoose doesn't supply us with the same path as we're using in our data
|
|
// so we need to improvise
|
|
const fullPath = [prefix, path].filter(Boolean).join('.')
|
|
const value = parsedParams[fullPath]
|
|
|
|
// this handles missing ObjectIDs
|
|
if (instance === 'ObjectID') {
|
|
if (value === '') {
|
|
parsedParams[fullPath] = null
|
|
} else if (value) {
|
|
// this works similar as this.stringifyId
|
|
parsedParams[fullPath] = value.toString()
|
|
}
|
|
}
|
|
|
|
// this handles empty Arrays or recurse into all properties of a filled Array
|
|
if (instance === 'Array') {
|
|
if (value === '') {
|
|
parsedParams[fullPath] = []
|
|
} else if (schema && schema.paths) { // we only want arrays of objects (with sub-paths)
|
|
const subProperties = Object.values(schema.paths)
|
|
// eslint-disable-next-line no-plusplus, no-constant-condition
|
|
for (let i = 0; true; i++) { // loop over every item
|
|
const newPrefix = `${fullPath}.${i}`
|
|
if (parsedParams[newPrefix] === '') {
|
|
// this means we have an empty object here
|
|
parsedParams[newPrefix] = {}
|
|
} else if (!Object.keys(parsedParams).some(key => key.startsWith(newPrefix))) {
|
|
// we're past the last index of this array
|
|
break
|
|
} else {
|
|
// recurse into the object
|
|
subProperties.forEach(handleProperty(newPrefix))
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
// this handles all properties of an object
|
|
if (instance === 'Embedded') {
|
|
if (parsedParams[fullPath] === '') {
|
|
parsedParams[fullPath] = {}
|
|
} else {
|
|
const subProperties = Object.values(schema.paths)
|
|
subProperties.forEach(handleProperty(fullPath))
|
|
}
|
|
}
|
|
}
|
|
|
|
this.properties().forEach(({ mongoosePath }) => handleProperty()(mongoosePath))
|
|
|
|
return parsedParams
|
|
}
|
|
}
|
|
|
|
export default Resource
|