Method handleGetRawDoc

rest/admin_api.go:1431–1499

handleGetRawDoc returns the raw version of the stored document for diagnostic purposes. It can optionally redact UserData in the sync metadata and allows a custom salt for correlating with collected logs.

()

// handleGetRawDoc returns the raw version of the stored document for diagnostic purposes.
// It can optionally redact UserData in the sync metadata and allows a custom salt for correlating with collected logs.
func (h *handler) handleGetRawDoc() error {
	h.assertAdminOnly()

	var (
		docID                     = h.PathVar("docid")
		includeDoc, includeDocSet = h.getOptBoolQuery("include_doc", true)
		redact                    = h.getBoolQuery("redact")
		redactSalt                = h.getQuery("salt")
	)

	if redact {
		// cannot explicitly include doc and redact - it doesn't make sense since the doc body itself is considered UserData and eligible for redaction.
		if includeDocSet && includeDoc {
			return base.HTTPErrorf(http.StatusBadRequest, "redact and include_doc cannot be true at the same time. "+
				"If you want to redact you must specify include_doc=false")
		}
		// if include_doc was not explicitly set, and we want to redact, then automatically set include_doc to false
		includeDoc = false
	} else if redactSalt != "" {
		return base.HTTPErrorf(http.StatusBadRequest, "redactSalt can only be used when redact=true")
	}

	opts := db.GetRawDocOpts{
		IncludeDoc: includeDoc,
		Redact:     redact,
		RedactSalt: redactSalt,
	}
	docBody, xattrValues, err := h.collection.GetRawDoc(h.ctx(), docID, &opts)
	if err != nil {
		return err
	}

	responseBody := []byte(base.EmptyDocument)
	if docBody != nil {
		responseBody = docBody
	}

	responseBody, err = base.InjectJSONProperties(responseBody, base.KVPair{Key: "_xattrs", Val: xattrValues})
	if err != nil {
		return base.HTTPErrorf(http.StatusInternalServerError, "couldn't inject xattrs into response: %s", err)
	}

	base.Audit(h.ctx(), base.AuditIDDocumentMetadataRead, base.AuditFields{
		base.AuditFieldDocID: docID,
	})
	if includeDoc && base.AuditEventIsEnabled(h.ctx(), base.AuditIDDocumentRead) {
		// best-effort attempt to extract a revision from the raw sync data
		docCurrentRev := "unknown"
		if syncData, ok := xattrValues[base.SyncXattrName]; ok {
			var sdRev struct {
				Rev channels.RevAndVersion `json:"rev"`
			}
			if err := json.Unmarshal(syncData, &sdRev); err != nil {
				// syncData is not normally generally redacted, but in this case we know it's malformed in some way and want the raw data in the log message.
				// This data may contain channel names, etc. which _are_ classed as UserData, so tag the whole thing.
				base.WarnfCtx(h.ctx(), "couldn't unmarshal doc %q SyncData xattr value %q: %s", base.UD(docID), base.UD(syncData), err)
			} else {
				docCurrentRev = sdRev.Rev.RevTreeID