Uploaded image for project: 'Documentation'
  1. Documentation
  2. DOCS-14028

Investigate changes in SERVER-51839: Add error context when document validator with $expr fails by throwing an exception

      Description

      Downstream Change Summary

      Document validators which use $expr will now generate detailed errors
      when $expr throws (for example, the validator {$expr: {$divide: [10,0]}} will always result in a division by zero exception). When the validationAction is set to error, the write will fail with a DocumentValidationError instead of the exception's error code. When the validationAction is set to warn, the write will be accepted and a detailed error will be logged (previously, these writes were rejected).

      Description of Linked Ticket

      The evaluation of an $expr can throw query-fatal exceptions in a variety of conditions, with one classic example being division by zero. When this happens during the evaluation of a collection validator, the insert or update operation will be rejected by the validator. For example, let's suppose that we create a collection validator that always divides by zero:

       > db.createCollection("c", {validator: {$expr: {$divide: [10, 0]}}})
      { "ok" : 1 }
       > db.c.insert({})
      WriteResult({
      	"nInserted" : 0,
      	"writeError" : {
      		"code" : 16608,
      		"errmsg" : "can't $divide by zero"
      	}
      })
      

      The insert is rejected when the system runs the validator to ensure that the write is valid, and the validator itself fails.

      Note, however, that the error message doesn't indicate that the problem occurred when checking the document validator. We should add context to the error message so that it says something like "Document validation failed :: caused by :: can't $divide by zero".

      As an implementation note, we have a convenient method for adding context to an exception before rethrowing it.

      Scope of changes

      This might just be a release notes update (heading like Improved $expr Error Handling). But we should review the $expr docs to see if there's anything we need to tweak.

      Impact to Other Docs

      MVP (Work and Date)

      Resources (Scope or Design Docs, Invision, etc.)

            Assignee:
            naomi.pentrel@mongodb.com Naomi Pentrel (Inactive)
            Reporter:
            backlog-server-pm Backlog - Core Eng Program Management Team
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved:
              3 years, 4 weeks, 6 days ago