index.js 22 KB

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