@pbvision/firestore-orm 0.0.26 → 0.0.27

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pbvision/firestore-orm",
-  "version": "0.0.26",
+  "version": "0.0.27",
   "description": "Firestore ORM Library",
   "license": "Apache-2.0",
   "type": "module",

package/src/context.js

@@ -405,10 +405,23 @@ export class Context {
     await model.__write(this)
   }
 
-  __throwIfWritesNotAllowed (data) {
-    if (this.options.readOnly) {
-      throw new WriteAttemptedInReadOnlyTxError(data)
+  __throwIfWritesNotAllowed (modelOrKey) {
+    if (!this.options.readOnly) {
+      return
+    }
+    let key = modelOrKey
+    let fieldNames = []
+    if (modelOrKey instanceof Model) {
+      key = modelOrKey.__key
+      fieldNames = Object.values(modelOrKey.__cached_attrs)
+        .filter(field => field.hasChangesToCommit(false))
+        .map(field => field.name)
     }
+    // delete() checks for read-only before it checks its args
+    const doc = key instanceof Key
+      ? `${key.Cls.collectionName} _id=${key.encodedKey}`
+      : 'an unknown doc'
+    throw new WriteAttemptedInReadOnlyTxError(doc, fieldNames)
   }
 
   /**

package/src/errors.js

@@ -135,12 +135,20 @@ export class DeletedTwiceError extends GenericModelError {
 
 /**
  * Thrown when a tx tries to write when it was marked read-only.
+ *
+ * Names the doc and the fields it would have changed, never their values: a
+ * model can hold secrets, and this message ends up in logs and error reports
+ * (and, through an error handler that returns crash messages, in API
+ * responses).
  * @memberof Errors
  */
 export class WriteAttemptedInReadOnlyTxError extends Error {
-  constructor (dataToWrite) {
-    super(`Tried to write model in a read-only transaction with the following
-      changes ${JSON.stringify(dataToWrite)}`)
+  constructor (doc, fieldNames) {
+    const fields = fieldNames.length
+      ? ` (changed fields: ${fieldNames.join(', ')})`
+      : ''
+    super(`Tried to write ${doc} in a read-only transaction${fields}`)
+    this.name = this.constructor.name
   }
 }