index.js 23 KB

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