|
| 1 | +const _ = require('lodash'); |
| 2 | +const { klona } = require('klona'); |
| 3 | + |
| 4 | +module.exports = (self) => { |
| 5 | + return { |
| 6 | + async addMissingSchemaFields() { |
| 7 | + let scans = 0; let updates = 0; |
| 8 | + const lastPropLists = await self.getLastPropLists(); |
| 9 | + const propLists = self.getPropLists(); |
| 10 | + let changesToPropLists = false; |
| 11 | + for (const name of Object.keys(propLists)) { |
| 12 | + if (!_.isEqual(lastPropLists?.[name], propLists[name])) { |
| 13 | + changesToPropLists = true; |
| 14 | + scans++; |
| 15 | + updates += await self.addMissingSchemaFieldsForDocType(name); |
| 16 | + } |
| 17 | + } |
| 18 | + if (changesToPropLists) { |
| 19 | + await self.updateLastPropLists(propLists); |
| 20 | + } |
| 21 | + // Returned for tests |
| 22 | + return { |
| 23 | + scans, |
| 24 | + updates |
| 25 | + }; |
| 26 | + }, |
| 27 | + async addMissingSchemaFieldsForDocType(name) { |
| 28 | + let updates = 0; |
| 29 | + const schema = (self.apos.doc.managers[name] || {}).schema; |
| 30 | + if (!schema) { |
| 31 | + return; |
| 32 | + } |
| 33 | + await self.eachDoc({ |
| 34 | + type: name |
| 35 | + }, async doc => { |
| 36 | + const changes = {}; |
| 37 | + await self.addMissingSchemaFieldsFor(doc, schema, '', changes); |
| 38 | + if (Object.keys(changes).length > 0) { |
| 39 | + updates++; |
| 40 | + return self.apos.doc.db.updateOne({ |
| 41 | + _id: doc._id |
| 42 | + }, { |
| 43 | + $set: changes |
| 44 | + }); |
| 45 | + } |
| 46 | + }); |
| 47 | + return updates; |
| 48 | + }, |
| 49 | + // Adds changes to the object "changes" so that a single |
| 50 | + // $set call can be made at the end. Use of a single |
| 51 | + // object passed by reference also avoids creating many |
| 52 | + // unnecessary objects in memory during a time-sensitive |
| 53 | + // operation |
| 54 | + addMissingSchemaFieldsFor(doc, schema, dotPath, changes) { |
| 55 | + for (const field of schema) { |
| 56 | + const newDotPath = dotPath ? `${dotPath}.${field.name}` : field.name; |
| 57 | + // Supply the default |
| 58 | + if (doc[field.name] === undefined) { |
| 59 | + // Only undefined should fall back here |
| 60 | + const def = klona((field.def === undefined) ? self.apos.schema.fieldTypes[field.type]?.def : field.def); |
| 61 | + if (def !== undefined) { |
| 62 | + if (!Object.hasOwn(changes, dotPath)) { |
| 63 | + changes[newDotPath] = def; |
| 64 | + } |
| 65 | + // Also change it in memory so that if this is a subproperty of a |
| 66 | + // new object, the change for that new object will have this |
| 67 | + // subproperty too, plus we don't get crashes above when testing the |
| 68 | + // subproperties' current values |
| 69 | + doc[field.name] = def; |
| 70 | + } |
| 71 | + } |
| 72 | + // Address defaults of subproperties |
| 73 | + if (field.type === 'area') { |
| 74 | + const basePath = `${newDotPath}.items`; |
| 75 | + for (let i = 0; (i < (doc[field.name]?.items || []).length); i++) { |
| 76 | + const widgetPath = `${basePath}.${i}`; |
| 77 | + const widget = doc[field.name].items[i]; |
| 78 | + const widgetSchema = self.apos.area.getWidgetManager(widget.type)?.schema; |
| 79 | + if (!widgetSchema) { |
| 80 | + continue; |
| 81 | + } |
| 82 | + self.addMissingSchemaFieldsFor(widget, widgetSchema, widgetPath, changes); |
| 83 | + } |
| 84 | + } else if (field.type === 'object') { |
| 85 | + self.addMissingSchemaFieldsFor(doc[field.name], field.schema, newDotPath, changes); |
| 86 | + } else if (field.type === 'array') { |
| 87 | + for (let i = 0; (i < (doc[field.name] || []).length); i++) { |
| 88 | + const itemPath = `${newDotPath}.${i}`; |
| 89 | + const item = doc[field.name][i]; |
| 90 | + self.addMissingSchemaFieldsFor(item, field.schema, itemPath, changes); |
| 91 | + } |
| 92 | + } else if (field.type === 'relationship') { |
| 93 | + for (const [ key, item ] of Object.entries(doc[field.fieldsStorage] || {})) { |
| 94 | + const itemPath = `${newDotPath}.${field.fieldsStorage}.${key}`; |
| 95 | + self.addMissingSchemaFieldsFor(item, field.schema, itemPath, changes); |
| 96 | + } |
| 97 | + } |
| 98 | + } |
| 99 | + return changes; |
| 100 | + }, |
| 101 | + getPropLists() { |
| 102 | + const schema = {}; |
| 103 | + for (const [ name, module ] of Object.entries(self.apos.doc.managers)) { |
| 104 | + if (!module.__meta.name) { |
| 105 | + // Just a placeholder for a type present in the |
| 106 | + // database but not found in the project code |
| 107 | + continue; |
| 108 | + } |
| 109 | + schema[name] = []; |
| 110 | + self.expandPropList(module.schema, schema[name], ''); |
| 111 | + } |
| 112 | + return schema; |
| 113 | + }, |
| 114 | + expandPropList(schema, propList, dotPath) { |
| 115 | + for (const field of schema) { |
| 116 | + const newDotPath = dotPath ? `${dotPath}.${field.name}` : field.name; |
| 117 | + propList.push(newDotPath); |
| 118 | + if (field.schema) { |
| 119 | + self.expandPropList(field.schema, propList, newDotPath); |
| 120 | + } |
| 121 | + } |
| 122 | + }, |
| 123 | + async getLastPropLists() { |
| 124 | + const result = await self.db.findOne({ |
| 125 | + _id: '*lastPropLists' |
| 126 | + }); |
| 127 | + return result?.propLists; |
| 128 | + }, |
| 129 | + async updateLastPropLists(propLists) { |
| 130 | + return self.db.updateOne({ |
| 131 | + _id: '*lastPropLists' |
| 132 | + }, { |
| 133 | + $set: { |
| 134 | + propLists |
| 135 | + } |
| 136 | + }, { |
| 137 | + upsert: true |
| 138 | + }); |
| 139 | + } |
| 140 | + }; |
| 141 | +}; |
0 commit comments