index.js 24 KB

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