index.js 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593
  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. backupRelations(){
  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. Savable.equals(obj[key], this._ref)) ?
  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.backupRelations()
  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. let error = new ReferenceError('Document Not Found')
  55. if (typeof err === 'function') err(error)
  56. else promise.reject(error)
  57. }
  58. else {
  59. delete this.then
  60. this.populate(data)
  61. if (typeof cb === 'function')
  62. promise.resolve(cb(this))
  63. else {
  64. promise.resolve(this)
  65. }
  66. }
  67. })
  68. return promise
  69. }
  70. }
  71. else {
  72. delete this.then
  73. }
  74. }
  75. get createdAt(){
  76. return this._id ? new Date(this._id.getTimestamp()) : null
  77. }
  78. get collection(){
  79. return db.collection(this._class)
  80. }
  81. async save(noSync=false){
  82. if (this.validate && !this.validate()){
  83. throw new SyntaxError(`validation error entity ${this._id} of class ${this.constructor.name} (${this.name || this.key})`)
  84. }
  85. if (this.empty) return this;
  86. const syncRelations = async () => {
  87. if (noSync) return
  88. if (!(this && this.__proto__ && this.__proto__.constructor && this.__proto__.constructor.relations)) return
  89. async function getValueByField(field, savable) {
  90. let path = field.split('.');
  91. await savable//.catch(e => console.log('GET VALUE BY FIELD ERROR'));
  92. let result = savable;
  93. let prev;
  94. let lastKey = path.pop()
  95. while (prev = result, result = result[path.shift()] && path.length);
  96. return {value: prev[lastKey], obj: prev, lastKey};
  97. }
  98. for (const relation in this.__proto__.constructor.relations){
  99. let backRef = this.__proto__.constructor.relations[relation]
  100. if (Array.isArray(backRef)) backRef = backRef[0]
  101. const loadRelation = this._loadRelations[relation]
  102. const loadRelationAsArray = loadRelation instanceof Savable ? [loadRelation] : loadRelation
  103. let {value, obj, lastKey: key} = await getValueByField(relation, this)
  104. const valueAsArray = value instanceof Savable ? [value] : value
  105. if (loadRelationAsArray){ //check for removed Refs
  106. const removedRefs = valueAsArray ?
  107. loadRelationAsArray.filter(ref => !Savable.existsInArray(valueAsArray, ref)) :
  108. loadRelationAsArray
  109. for (const ref of removedRefs){
  110. try { await ref } catch (e) {console.log('SYNC RELATIONS REMOVE ERROR') }
  111. await ref.removeRelation(this, relation)
  112. }
  113. }
  114. if (valueAsArray){ //check for added refs
  115. for (const foreignSavable of valueAsArray) {
  116. try { await foreignSavable } catch (e) {console.log('SYNC RELATIONS ADD ERROR') }
  117. let foreignLoadRelationsAsArray = Savable.arrize(foreignSavable._loadRelations[backRef])
  118. if (foreignSavable && !Savable.existsInArray(foreignLoadRelationsAsArray, this)){
  119. await foreignSavable.setRelation(this, relation)
  120. }
  121. }
  122. }
  123. }
  124. }
  125. async function recursiveSlicer(obj){
  126. let result = obj instanceof Array ? [] : {}
  127. for (const key in obj){
  128. if (obj[key] && typeof obj[key] === 'object'){
  129. if (obj[key] instanceof Savable){
  130. if (!(obj[key]._id)){
  131. await obj[key].save().catch(err => console.log('ERR', err))
  132. }
  133. result[key] = obj[key].shortData()
  134. }
  135. else {
  136. result[key] = await recursiveSlicer(obj[key])
  137. }
  138. }
  139. else {
  140. result[key] = obj[key]
  141. }
  142. }
  143. return result;
  144. }
  145. const {_id, _empty, _ref, _loadRelations, then, ...toSave} = await recursiveSlicer(this)
  146. //TODO: UPSERT
  147. if (!this._id){ //first time
  148. const { insertedId } = await this.collection.insertOne(toSave)
  149. this._id = insertedId
  150. }
  151. else { //update
  152. await this.collection.updateOne({_id: this._id}, {$set: toSave}).catch(err => console.log('UPDATE ERR', err))
  153. }
  154. await syncRelations()
  155. this.backupRelations()
  156. return this
  157. }
  158. // method to get ref snapshot (empty object with some data). gives optimizations in related objects
  159. // place for permission, owner, probably short relations
  160. shortData(){
  161. const {_id, _class} = this
  162. return { _id, _class }
  163. }
  164. async setRelation(ref, refRelationName){
  165. await this
  166. const ourRelation = ref.__proto__.constructor.relations[refRelationName]
  167. const ourArray = ourRelation instanceof Array
  168. const ourRelationName = ourArray ? ourRelation[0] : ourRelation
  169. let shortQuery = {[ourRelationName]: ref.shortData()}
  170. let query;
  171. if (ourArray || this[ourRelationName] instanceof Array){
  172. this[ourRelationName] = this[ourRelationName] || []
  173. this[ourRelationName] = this[ourRelationName] instanceof Array ? this[ourRelationName] : [this[ourRelationName]]
  174. if (!Savable.existsInArray(this[ourRelationName], ref)) {
  175. this[ourRelationName].push(ref)
  176. this._id && this._loadRelations[ourRelationName].push(ref)
  177. }
  178. query = {$addToSet: shortQuery}
  179. }
  180. else {
  181. this[ourRelationName] = ref
  182. this._id && (this._loadRelations[ourRelationName] = ref)
  183. query = {$set: shortQuery}
  184. }
  185. console.log('SET RELATION:', query)
  186. if (this._id){
  187. console.log('SET RELATION:', query)
  188. await this.collection.updateOne({_id: this._id}, query).catch(err => console.log('UPDATE ERR', err))
  189. }
  190. }
  191. async removeRelation(ref, refRelationName){ //i. e. this = child, ref = parent object, refRelationName = children in parent
  192. await this
  193. const ourRelation = ref.__proto__.constructor.relations[refRelationName]
  194. const ourArray = ourRelation instanceof Array
  195. const ourRelationName = ourArray ? ourRelation[0] : ourRelation
  196. if (this._id){
  197. const query = ourArray ? {$pull: {[ourRelationName]: ref.shortData()}}
  198. : {$set: {[ourRelationName]: null}}
  199. console.log('REMOVE RELATION:', query)
  200. await this.collection.updateOne({_id: this._id}, query).catch(err => console.log('UPDATE ERR', err))
  201. }
  202. (this[ourRelationName] instanceof Array) ? this._loadRelations[ourRelationName] = this[ourRelationName] = this[ourRelationName].filter(ourRef => !ourRef.equals(ref))
  203. : this[ourRelationName] = null;
  204. }
  205. async delete(noRefs=false){
  206. if (!noRefs) for (const relation in this.__proto__.constructor.relations){
  207. const backRef = this.__proto__.constructor.relations[relation]
  208. const loadRelation = this._loadRelations && this._loadRelations[relation]
  209. const loadRelationAsArray = loadRelation instanceof Savable ? [loadRelation] : loadRelation
  210. if (loadRelationAsArray){
  211. for (const ref of loadRelationAsArray){
  212. try {
  213. await ref
  214. }
  215. catch (e) {console.log('DELETE SYNC RELATIONS ERROR') }
  216. await ref.removeRelation(this, relation)
  217. }
  218. }
  219. }
  220. const id = this._id
  221. const col = this._class && this.collection
  222. for (let key in this)
  223. delete this[key]
  224. delete this.__proto__
  225. if (col)
  226. return await col.deleteOne({_id: id})
  227. }
  228. static arrize(value){
  229. if (Array.isArray(value)) return value
  230. if (value) return [value]
  231. return []
  232. }
  233. static equals(obj1, obj2){
  234. if (!obj1 || !obj2) return false
  235. if(!obj1._id) return obj1 === obj2
  236. if(!obj2._id) return obj1 === obj2
  237. return obj1._id.toString() === obj2._id.toString()
  238. }
  239. equals(obj){
  240. return Savable.equals(this, obj)
  241. }
  242. static existsInArray(arr, obj){
  243. if (!Array.isArray(arr)) return false
  244. let filtered = arr.filter(item => Savable.equals(item, obj))
  245. return filtered.length
  246. }
  247. static isSavable(obj){
  248. return obj && obj._id && obj._class
  249. }
  250. static newSavable(obj, ref, empty=true){
  251. let className = obj._class || "Savable"
  252. className = Savable.classes[className] ? className : "Savable"
  253. if (obj.__proto__.constructor === Savable.classes[className]){
  254. return obj
  255. }
  256. return new Savable.classes[className](obj, ref, empty)
  257. }
  258. static addClass(_class){ //explicit method to add class to Savable registry for instantiate right class later
  259. (typeof _class == 'function') && (Savable.classes[_class.name] = _class)
  260. }
  261. static get m(){
  262. return Savable._m = (Savable._m || (new Proxy({}, {
  263. get(obj, _class){
  264. if (_class in obj){
  265. return obj[_class]
  266. }
  267. const applyCursorCalls = (cursor, calls) =>{
  268. if (!calls) return cursor;
  269. for (let [method, params] of Object.entries(calls)){
  270. if (typeof cursor[method] !== "function"){
  271. throw new SyntaxError(`Wrong cursor method ${method}`)
  272. }
  273. cursor = cursor[method](...params)
  274. }
  275. return cursor;
  276. }
  277. return obj[_class] = {
  278. * find(query, cursorCalls={}){
  279. //console.log(query)
  280. let cursor = applyCursorCalls(db.collection(_class).find(query), cursorCalls)
  281. let cursorGen = asynchronize({s: cursor.stream(),
  282. chunkEventName: 'data',
  283. endEventName: 'close',
  284. errEventName: 'error',
  285. countMethodName: 'count'})
  286. for (const pObj of cursorGen()){
  287. yield new Promise((ok, fail) =>
  288. pObj.then(obj => (/*console.log(obj),*/ok(Savable.newSavable(obj, null, false))),
  289. err => fail(err)))
  290. }
  291. },
  292. async count(query, cursorCalls={}){
  293. let cursor = applyCursorCalls(db.collection(_class).find(query), cursorCalls)
  294. return await cursor.count(true)
  295. },
  296. async findOne(query){
  297. let result = await db.collection(_class).findOne(query)
  298. if (result)
  299. return Savable.newSavable(result, null, false)
  300. return result
  301. }
  302. }
  303. },
  304. set(obj, propName, value){
  305. }
  306. })))
  307. }
  308. static get relations(){
  309. //empty default relations, acceptable: {field: foreignField}, where:
  310. //field and foreign field can be Savable, Array or Set
  311. //both fields can be specified as "field", "field.subfield"
  312. //or field: {subfield: foreignField} //TODO later if needed
  313. //TODO: move it into object instead of class to give more flexibility, for example
  314. //if person has children, it can have backRef father or mother depending on sex:
  315. //return {
  316. // children: this.sex === 'male' ? 'father': 'mother'
  317. //}
  318. //
  319. //return {
  320. // parent: ["children"],
  321. // notebooks: "owner"
  322. //}
  323. return {}
  324. }
  325. }
  326. Savable.classes = {Savable}
  327. /**
  328. * sliceSavable - slice (limit) Savables for some permission
  329. * Array userACL - array of objectIDs, words or savable refs - current user, group objectid, or `tags` or `role` (ACL)
  330. */
  331. function sliceSavable(userACL){
  332. userACL = userACL.map(tag => tag.toString())
  333. //console.log(userACL)
  334. class SlicedSavable extends Savable {
  335. constructor(...params){
  336. super (...params)
  337. if (!this._empty){
  338. this.___permissionsPrepare()
  339. }
  340. }
  341. ___permissionsPrepare(){
  342. if (this._empty) return
  343. if (!this.___permissions) this.___permissions = {}
  344. for (let [perm, acl] of Object.entries(this.__proto__.constructor.defaultPermissions)){
  345. if (!this.___permissions[perm]){
  346. this.___permissions[perm] = [...acl]
  347. }
  348. }
  349. }
  350. ___permissionCan(permission, permissions=this.___permissions, obj=this){
  351. const acl = (permissions &&
  352. permissions[permission] ||
  353. this.__proto__.constructor.defaultPermissions[permission]).map(tag => tag.toString())
  354. if (!this._id && permission === 'read') return true; //if new entity you can anything
  355. if (acl.includes('owner') && obj.___owner && userACL.includes(obj.___owner.toString())){
  356. return true
  357. }
  358. for (let uTag of userACL){
  359. if (acl.includes(uTag)){
  360. return true
  361. }
  362. }
  363. return false
  364. }
  365. populate(obj){ //place to check read permission
  366. //console.log(obj)
  367. if (!this.___permissionCan('read', obj.___permissions, obj)){
  368. throw new ReferenceError(`No Access To Entity ${this._id} of class ${this._class}`)
  369. }
  370. super.populate(obj)
  371. }
  372. async save(noSync=false){
  373. if (!this._id && !this.___permissionCan('create'))
  374. throw new ReferenceError(`Permission denied Create Entity of class ${this._class}`)
  375. if (this._id && !this.___permissionCan('write'))
  376. throw new ReferenceError(`Permission denied Save Entity ${this._id} of class ${this._class}`)
  377. if (!this._id){
  378. this.___owner = userACL[0] //TODO fix objectid troubles
  379. //console.log(typeof this.___owner, this.___owner)
  380. }
  381. return await super.save(noSync)
  382. }
  383. async setRelation(ref, refRelationName){
  384. await this
  385. const ourRelation = ref.__proto__.constructor.relations[refRelationName]
  386. const ourArray = ourRelation instanceof Array
  387. const ourRelationName = ourArray ? ourRelation[0] : ourRelation
  388. if (!this._id || this.___permissionCan('write') ||
  389. (this.__proto__.constructor.guestRelations.includes(ourRelationName) && this.___permissionCan('read')))
  390. return await super.setRelation(ref, refRelationName)
  391. throw new ReferenceError(`Permission denied Set Relation Entity ${this._id} of class ${this._class} ref: ${ref._id} of class ${ref._class}`)
  392. }
  393. async removeRelation(ref, refRelationName){
  394. await this;
  395. const ourRelation = ref.__proto__.constructor.relations[refRelationName]
  396. const ourArray = ourRelation instanceof Array
  397. const ourRelationName = ourArray ? ourRelation[0] : ourRelation
  398. if (!this._id || this.___permissionCan('write') ||
  399. (this.__proto__.constructor.guestRelations.includes(ourRelationName) && this.___permissionCan('read')))
  400. return await super.removeRelation(ref, refRelationName)
  401. throw new ReferenceError(`Permission denied Remove Relation Entity ${this._id} of class ${this._class} ref: ${ref._id} of class ${ref._class}`)
  402. }
  403. async delete(noRefs=false){
  404. if (!this.___permissionCan('delete'))
  405. throw new ReferenceError(`Permission denied Delete Entity ${this._id} of class ${this._class}`)
  406. return await super.delete(noRefs)
  407. }
  408. static ___permissionQuery(permission){
  409. //const withObjectIDs = userACL.map((a,id) => (id = new ObjectID(a)) && id.toString() === a ? id : a)
  410. const withObjectIDs = userACL
  411. return {
  412. $or: [
  413. {[`___permissions.${permission}`]: {$in: withObjectIDs}},
  414. {$and: [{[`___permissions.${permission}`]: "owner"},
  415. {___owner: userACL[0]}]}]
  416. }
  417. }
  418. static get m() {
  419. return SlicedSavable._sm = (SlicedSavable._sm || (new Proxy({}, {
  420. get(obj, _class){
  421. if (_class in obj){
  422. return obj[_class]
  423. }
  424. return obj[_class] = {
  425. * find(query, cursorCalls={}){
  426. const originalClass = Savable.classes[_class]
  427. Savable.addClass(SlicedSavable.classes[_class])
  428. let permittedQuery = {$and: [SlicedSavable.___permissionQuery('read') ,query]}
  429. //console.log(JSON.stringify(permittedQuery, null, 4))
  430. let iter = Savable.m[_class].find(permittedQuery, cursorCalls)
  431. Savable.addClass(originalClass)
  432. yield* iter;
  433. },
  434. async count(query, cursorCalls={}){
  435. let permittedQuery = {$and: [SlicedSavable.___permissionQuery('read') ,query]}
  436. return await Savable.m[_class].count(permittedQuery, cursorCalls)
  437. },
  438. async findOne(query){
  439. const originalClass = Savable.classes[_class]
  440. Savable.addClass(SlicedSavable.classes[_class])
  441. const permittedQuery = {$and: [SlicedSavable.___permissionQuery('read') ,query]}
  442. const p = Savable.m[_class].findOne(permittedQuery)
  443. Savable.addClass(originalClass)
  444. return await p;
  445. }
  446. }
  447. },
  448. set(obj, propName, value){
  449. }
  450. })))
  451. }
  452. static get defaultPermissions(){
  453. return {
  454. //savable refs, objectid's, words like 'tags' or 'roles'
  455. read: ['owner', 'user'],
  456. write: ['owner', 'admin'],
  457. create: ['user'],
  458. delete: ['admin'],
  459. /*permission
  460. * TODO: permissions for read and write permissions
  461. *
  462. */
  463. }
  464. }
  465. static get guestRelations(){ //guest relations are accessible to write by setRelation or removeRelation even if no write permission, only with read
  466. return []
  467. }
  468. }
  469. return SlicedSavable
  470. }
  471. return {Savable, sliceSavable}
  472. }
  473. async function connect(dbName, dsn="mongodb://localhost:27017/"){
  474. if (!dbName)
  475. throw new ReferenceError(`db name does not provided`)
  476. const mongoClient = new MongoClient(dsn, { useNewUrlParser: true });
  477. const client = await mongoClient.connect()
  478. const db = client.db(dbName)
  479. const {Savable, sliceSavable: slice} = mm(db)
  480. return {
  481. Savable,
  482. slice,
  483. }
  484. }
  485. module.exports = {
  486. mm,
  487. connect
  488. }