index.js 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509
  1. const { MongoClient, ObjectID } = require("mongodb");
  2. const {asynchronize, openPromise } = require('./asynchronize')
  3. const mm = db => {
  4. class Savable {
  5. constructor(obj, ref, empty=false){
  6. this._id = null
  7. this._ref = ref
  8. this._class = this.__proto__.constructor.name
  9. this._empty = true
  10. Savable.addClass(this.__proto__.constructor)
  11. if (obj){
  12. this.populate(obj)
  13. this._empty = empty
  14. }
  15. }
  16. saveRelations(){
  17. this._loadRelations = {};
  18. for (const relation in this.__proto__.constructor.relations){
  19. this._loadRelations[relation] = this[relation] instanceof Array ? [...this[relation]] : this[relation]
  20. }
  21. }
  22. populate(obj){
  23. const convertSavables = (obj) => {
  24. for (const key in obj){
  25. if (Savable.isSavable(obj[key])){
  26. obj[key] = (this._ref &&
  27. obj[key]._id.toString() == this._ref._id.toString()) ?
  28. this._ref :
  29. Savable.newSavable(obj[key], this)
  30. }
  31. else if (typeof obj[key] === 'object'){
  32. convertSavables(obj[key])
  33. }
  34. }
  35. }
  36. Object.assign(this, obj)
  37. convertSavables(this)
  38. this.saveRelations()
  39. //this._id = obj._id
  40. }
  41. get _empty(){
  42. return !!this.then
  43. }
  44. set _empty(value){
  45. if (value){
  46. //TODO: list of callbacks, because then can be called many times, and
  47. //it's not reason to repeat query to db
  48. this.then = (cb, err) => {
  49. if (!this._id) err(new ReferenceError('Id is empty'))
  50. if (!this._class) err(new ReferenceError('Class is empty'))
  51. const promise = openPromise()
  52. this.collection.findOne(this._id).then( data => {
  53. if (!data){
  54. err(new ReferenceError('Document Not Found'))
  55. }
  56. else {
  57. delete this.then
  58. this.populate(data)
  59. if (typeof cb === 'function')
  60. promise.resolve(cb(this))
  61. else {
  62. promise.resolve(this)
  63. }
  64. }
  65. })
  66. return promise
  67. }
  68. }
  69. else {
  70. delete this.then
  71. }
  72. }
  73. get createdAt(){
  74. return this._id ? new Date(this._id.getTimestamp()) : null
  75. }
  76. get collection(){
  77. return db.collection(this._class)
  78. }
  79. async save(noRefs=false, noSync=false){
  80. if (this.empty) return this;
  81. const syncRelations = async () => {
  82. if (noSync) return
  83. if (!(this && this.__proto__ && this.__proto__.constructor && this.__proto__.constructor.relations)) return
  84. async function getValueByField(field, savable) {
  85. let path = field.split('.');
  86. await savable//.catch(e => console.log('GET VALUE BY FIELD ERROR'));
  87. let result = savable;
  88. let prev;
  89. let lastKey = path.pop()
  90. while (prev = result, result = result[path.shift()] && path.length);
  91. return {value: prev[lastKey], obj: prev, lastKey};
  92. }
  93. let setBackRef = async (backRef, foreignSavable) => {
  94. const {value: backRefValue,
  95. obj: backRefObj,
  96. lastKey: backRefKey} = await getValueByField(backRef, foreignSavable)
  97. if (backRefValue instanceof Array){
  98. if (!Savable.existsInArray(backRefValue, this)){
  99. backRefValue.push(this)
  100. }
  101. }
  102. else {
  103. backRefObj[backRefKey] = this
  104. }
  105. noRefs || await foreignSavable.save(true)
  106. }
  107. for (const relation in this.__proto__.constructor.relations){
  108. const backRef = this.__proto__.constructor.relations[relation]
  109. const loadRelation = this._loadRelations[relation]
  110. const loadRelationAsArray = loadRelation instanceof Savable ? [loadRelation] : loadRelation
  111. let {value, obj, lastKey: key} = await getValueByField(relation, this)
  112. const valueAsArray = value instanceof Savable ? [value] : value
  113. if (loadRelationAsArray){
  114. const removedRefs = valueAsArray ?
  115. loadRelationAsArray.filter(ref => !Savable.existsInArray(valueAsArray, ref)) :
  116. loadRelationAsArray
  117. for (const ref of removedRefs){
  118. try {
  119. await ref
  120. }
  121. catch (e) {console.log('SYNC RELATIONS ERROR') }
  122. if (ref[backRef] instanceof Array){
  123. ref[backRef] = ref[backRef].filter(br => br._id !== this._id)
  124. }
  125. else {
  126. ref[backRef] = null
  127. }
  128. noRefs || await ref.save(true)
  129. }
  130. }
  131. if (valueAsArray){
  132. for (const foreignSavable of valueAsArray){
  133. await setBackRef(backRef, foreignSavable)
  134. }
  135. }
  136. }
  137. }
  138. async function recursiveSlicer(obj){
  139. let result = obj instanceof Array ? [] : {}
  140. for (const key in obj){
  141. if (obj[key] && typeof obj[key] === 'object'){
  142. if (obj[key] instanceof Savable){
  143. if (!(obj[key]._id)){
  144. await obj[key].save().catch(err => console.log('ERR', err))
  145. }
  146. result[key] = {_id: obj[key]._id, _class: obj[key]._class}
  147. }
  148. else {
  149. result[key] = await recursiveSlicer(obj[key])
  150. }
  151. }
  152. else {
  153. result[key] = obj[key]
  154. }
  155. }
  156. return result;
  157. }
  158. const {_id, _empty, _ref, _loadRelations, then, ...toSave} = await recursiveSlicer(this)
  159. //TODO: UPSERT
  160. if (!this._id){ //first time
  161. const { insertedId } = await this.collection.insertOne(toSave)
  162. this._id = insertedId
  163. }
  164. else { //update
  165. await this.collection.updateOne({_id: this._id}, {$set: toSave}).catch(err => console.log('UPDATE ERR', err))
  166. }
  167. await syncRelations()
  168. this.saveRelations()
  169. return this
  170. }
  171. async delete(noRefs=false){
  172. if (!noRefs) for (const relation in this.__proto__.constructor.relations){
  173. const backRef = this.__proto__.constructor.relations[relation]
  174. const loadRelation = this._loadRelations && this._loadRelations[relation]
  175. const loadRelationAsArray = loadRelation instanceof Savable ? [loadRelation] : loadRelation
  176. if (loadRelationAsArray){
  177. for (const ref of loadRelationAsArray){
  178. try {
  179. await ref
  180. }
  181. catch (e) {console.log('DELETE SYNC RELATIONS ERROR') }
  182. if (ref[backRef] instanceof Array){
  183. ref[backRef] = ref[backRef].filter(br => br._id !== this._id)
  184. }
  185. else {
  186. ref[backRef] = null
  187. }
  188. await ref.save(true, true)
  189. }
  190. }
  191. }
  192. const id = this._id
  193. const col = this._class && this.collection
  194. for (let key in this)
  195. delete this[key]
  196. delete this.__proto__
  197. if (col)
  198. return await col.deleteOne({_id: id})
  199. }
  200. static equals(obj1, obj2){
  201. if(!obj1._id) return obj1 === obj2
  202. if(!obj2._id) return obj1 === obj2
  203. return obj1._id.toString() === obj2._id.toString()
  204. }
  205. equals(obj){
  206. return Savable.equals(this, obj)
  207. }
  208. static existsInArray(arr, obj){
  209. let filtered = arr.filter(item => Savable.equals(item, obj))
  210. return filtered.length
  211. }
  212. static isSavable(obj){
  213. return obj && obj._id && obj._class
  214. }
  215. static newSavable(obj, ref, empty=true){
  216. let className = obj._class || "Savable"
  217. className = Savable.classes[className] ? className : "Savable"
  218. if (obj.__proto__.constructor === Savable.classes[className]){
  219. return obj
  220. }
  221. return new Savable.classes[className](obj, ref, empty)
  222. }
  223. static addClass(_class){ //explicit method to add class to Savable registry for instantiate right class later
  224. (typeof _class == 'function') && (Savable.classes[_class.name] = _class)
  225. }
  226. static get m(){
  227. return new Proxy({}, {
  228. get(obj, _class){
  229. if (_class in obj){
  230. return obj[_class]
  231. }
  232. const applyCursorCalls = (cursor, calls) =>{
  233. for (let [method, params] of Object.entries(calls)){
  234. if (typeof cursor[method] !== "function"){
  235. throw new SyntaxError(`Wrong cursor method ${method}`)
  236. }
  237. cursor = cursor[method](...params)
  238. }
  239. return cursor;
  240. }
  241. return obj[_class] = {
  242. * find(query, projection, cursorCalls={}){
  243. let cursor = applyCursorCalls(db.collection(_class).find(query, projection), cursorCalls)
  244. let cursorGen = asynchronize({s: cursor.stream(),
  245. chunkEventName: 'data',
  246. endEventName: 'close',
  247. errEventName: 'error',
  248. countMethodName: 'count'})
  249. for (const pObj of cursorGen()){
  250. yield new Promise((ok, fail) =>
  251. pObj.then(obj => (/*console.log(obj),*/ok(Savable.newSavable(obj, null, false))),
  252. err => fail(err)))
  253. }
  254. },
  255. async count(query, cursorCalls={}){
  256. let cursor = applyCursorCalls(db.collection(_class).find(query, projection), cursorCalls)
  257. return await cursor.count(true)
  258. },
  259. async findOne(query, projection){
  260. let result = await db.collection(_class).findOne(query, projection)
  261. if (result)
  262. return Savable.newSavable(result, null, false)
  263. return result
  264. }
  265. }
  266. },
  267. set(obj, propName, value){
  268. }
  269. })
  270. }
  271. static get relations(){
  272. //empty default relations, acceptable: {field: foreignField}, where:
  273. //field and foreign field can be Savable, Array or Set
  274. //both fields can be specified as "field", "field.subfield"
  275. //or field: {subfield: foreignField} //TODO later if needed
  276. //TODO: move it into object instead of class to give more flexibility, for example
  277. //if person has children, it can have backRef father or mother depending on sex:
  278. //return {
  279. // children: this.sex === 'male' ? 'father': 'mother'
  280. //}
  281. return {}
  282. }
  283. }
  284. Savable.classes = {Savable}
  285. /**
  286. * sliceSavable - slice (limit) Savables for some permission
  287. * Array userACL - array of objectIDs, words or savable refs - current user, group objectid, or `tags` or `role` (ACL)
  288. */
  289. function sliceSavable(userACL){
  290. userACL = userACL.map(tag => tag.toString())
  291. //console.log(userACL)
  292. class SlicedSavable extends Savable {
  293. constructor(...params){
  294. super (...params)
  295. if (!this._empty){
  296. this.___permissionsPrepare()
  297. }
  298. }
  299. ___permissionsPrepare(){
  300. if (this._empty) return
  301. if (!this.___permissions) this.___permissions = {}
  302. for (let [perm, acl] of Object.entries(this.__proto__.constructor.defaultPermissions)){
  303. if (!this.___permissions[perm]){
  304. this.___permissions[perm] = [...acl]
  305. }
  306. }
  307. }
  308. ___permissionCan(permission, permissions=this.___permissions, obj=this){
  309. const acl = (permissions &&
  310. permissions[permission] ||
  311. this.__proto__.constructor.defaultPermissions[permission]).map(tag => tag.toString())
  312. if (acl.includes('owner') && obj.___owner && userACL.includes(obj.___owner.toString())){
  313. return true
  314. }
  315. for (let uTag of userACL){
  316. if (acl.includes(uTag)){
  317. return true
  318. }
  319. }
  320. return false
  321. }
  322. populate(obj){ //place to check read permission
  323. //console.log(obj)
  324. if (!this.___permissionCan('read', obj.___permissions, obj)){
  325. throw new ReferenceError(`No Access To Entity ${this._id} of class ${this._class}`)
  326. }
  327. super.populate(obj)
  328. }
  329. async save(noRefs=false, noSync=false){
  330. if (!this._id && !this.___permissionCan('create'))
  331. throw new ReferenceError(`Permissison denied Create Entity of class ${this._class}`)
  332. if (this._id && !this.___permissionCan('write') && !noRefs) //give ability to change backrefs for not permitted records
  333. throw new ReferenceError(`Permissison denied Save Entity ${this._id} of class ${this._class}`)
  334. if (!this._id){
  335. this.___owner = userACL[0] //TODO fix objectid troubles
  336. //console.log(typeof this.___owner, this.___owner)
  337. }
  338. return await super.save(noRefs, noSync)
  339. }
  340. async delete(noRefs=false){
  341. if (!this.___permissionCan('delete'))
  342. throw new ReferenceError(`Permissison denied Delete Entity ${this._id} of class ${this._class}`)
  343. return await super.delete(noRefs)
  344. }
  345. static ___permissionQuery(permission){
  346. //const withObjectIDs = userACL.map((a,id) => (id = new ObjectID(a)) && id.toString() === a ? id : a)
  347. const withObjectIDs = userACL
  348. return {
  349. $or: [
  350. {[`___permissions.${permission}`]: {$in: withObjectIDs}},
  351. {$and: [{[`___permissions.${permission}`]: "owner"},
  352. {___owner: userACL[0]}]}]
  353. }
  354. }
  355. static get m() {
  356. return new Proxy({}, {
  357. get(obj, _class){
  358. if (_class in obj){
  359. return obj[_class]
  360. }
  361. return obj[_class] = {
  362. * find(query, projection, cursorCalls={}){
  363. const originalClass = Savable.classes[_class]
  364. Savable.addClass(SlicedSavable.classes[_class])
  365. let permittedQuery = {$and: [SlicedSavable.___permissionQuery('read') ,query]}
  366. //console.log(JSON.stringify(permittedQuery, null, 4))
  367. let iter = Savable.m[_class].find(permittedQuery, projection, cursorCalls)
  368. Savable.addClass(originalClass)
  369. yield* iter;
  370. },
  371. async count(query, cursorCalls={}){
  372. let permittedQuery = {$and: [SlicedSavable.___permissionQuery('read') ,query]}
  373. return await Savable.m[_class].count(permittedQuery, cursorCalls)
  374. },
  375. async findOne(query, projection){
  376. const originalClass = Savable.classes[_class]
  377. Savable.addClass(SlicedSavable.classes[_class])
  378. const permittedQuery = {$and: [SlicedSavable.___permissionQuery('read') ,query]}
  379. const p = Savable.m[_class].findOne(permittedQuery, projection)
  380. Savable.addClass(originalClass)
  381. return await p;
  382. }
  383. }
  384. },
  385. set(obj, propName, value){
  386. }
  387. })
  388. }
  389. static get defaultPermissions(){
  390. return {
  391. //savable refs, objectid's, words like 'tags' or 'roles'
  392. read: ['owner', 'user'],
  393. write: ['owner', 'admin'],
  394. create: ['user'],
  395. delete: ['admin'],
  396. /*permission
  397. * TODO: permissions for read and write permissions
  398. *
  399. */
  400. }
  401. }
  402. }
  403. return SlicedSavable
  404. }
  405. return {Savable, sliceSavable}
  406. }
  407. async function connect(dbName, dsn="mongodb://localhost:27017/"){
  408. if (!dbName)
  409. throw new ReferenceError(`db name does not provided`)
  410. const mongoClient = new MongoClient(dsn, { useNewUrlParser: true });
  411. const client = await mongoClient.connect()
  412. const db = client.db(dbName)
  413. const Savable = mm(db).Savable
  414. const slice = mm(db).sliceSavable
  415. return {
  416. Savable,
  417. slice,
  418. }
  419. }
  420. module.exports = {
  421. mm,
  422. connect
  423. }