refactor import dry run to handle custom function and body

Author: RIT3shSapata

base/error.go

@@ -83,6 +83,8 @@ var (
 
 	// ErrInvalidJSON is returned when the JSON being unmarshalled cannot be parsed.
 	ErrInvalidJSON = HTTPErrorf(http.StatusBadRequest, "Invalid JSON")
+
+	ErrImportDryRun = &sgError{"Error occured during import dry run: "}
 )
 
 func (e *sgError) Error() string {

db/import.go

@@ -545,20 +545,44 @@ func (i *ImportFilterFunction) EvaluateFunction(ctx context.Context, doc Body, d
 		return false, errors.New("Import filter function returned non-boolean value.")
 	}
 }
-func (db *DatabaseCollectionWithUser) ImportFilterDryRun(ctx context.Context, doc Body, docid string) (bool, error) {
-
-	importFilter := db.importFilter()
-	if docid != "" {
-		docInBucket, err := db.GetDocument(ctx, docid, DocUnmarshalAll)
-		if err == nil {
-			if doc == nil {
-				doc = docInBucket.Body(ctx)
+
+// ImportFilterDryRun Runs a document through the import filter and returns a boolean and error
+func (db *DatabaseCollectionWithUser) ImportFilterDryRun(ctx context.Context, doc Body, importFn string) (bool, error) {
+
+	var shouldImport bool
+	if importFn == "" {
+		importFilter := db.importFilter()
+		ouput, err := importFilter.EvaluateFunction(ctx, doc, true)
+		if err != nil {
+			if errors.Is(errors.New("Import filter function returned non-boolean value."), err) {
+				err = fmt.Errorf("%s: %s ", base.ErrImportDryRun, err)
 			}
-		} else {
+			return false, err
+		}
+		shouldImport = ouput
+	} else {
+		jsTimeout := time.Duration(base.DefaultJavascriptTimeoutSecs) * time.Second
+		importRunner, err := newImportFilterRunner(ctx, importFn, jsTimeout)
+		if err != nil {
+			return false, errors.New("Import filter function error: " + err.Error())
+		}
+		importOuput, err := importRunner.Call(ctx, doc)
+		switch result := importOuput.(type) {
+		case bool:
+			shouldImport = result
+			break
+		case string:
+			boolResult, err := strconv.ParseBool(result)
+			if err != nil {
+				return false, err
+			}
+			shouldImport = boolResult
+			break
+		default:
+			err = fmt.Errorf("%s Import filter function returned non-boolean result %v Type: %T", base.ErrImportDryRun, result, result)
 			return false, err
 		}
 	}
-	shouldImport, err := importFilter.EvaluateFunction(ctx, doc, true)
 
-	return shouldImport, err
+	return shouldImport, nil
 }

rest/diagnostic_doc_api.go

@@ -11,7 +11,6 @@ licenses/APL2.txt.
 package rest
 
 import (
-	"fmt"
 	"mime"
 	"net/http"
 
@@ -39,6 +38,11 @@ type SyncFnDryRunPayload struct {
 	Doc      db.Body `json:"doc,omitempty"`
 }
 
+type ImportFilterDryRunPayload struct {
+	Function string  `json:"sync_function"`
+	Doc      db.Body `json:"doc,omitempty"`
+}
+
 func populateDocChannelInfo(doc db.Document) map[string][]auth.GrantHistorySequencePair {
 	resp := make(map[string][]auth.GrantHistorySequencePair, len(doc.Channels))
 
@@ -119,18 +123,33 @@ func (h *handler) handleSyncFnDryRun() error {
 // HTTP handler for running a document through the import filter and returning the results
 func (h *handler) handleImportFilterDryRun() error {
 	docid := h.getQuery("doc_id")
+	contentType, _, _ := mime.ParseMediaType(h.rq.Header.Get("Content-Type"))
 
-	body, err := h.readDocument()
-	if err != nil {
-		if docid == "" {
-			return fmt.Errorf("Error reading body: %s, no doc id provided for dry run", err)
-		}
+	if contentType != "application/json" && contentType != "" {
+		return base.HTTPErrorf(http.StatusUnsupportedMediaType, "Invalid Content-Type header: %s. Needs to be empty or application/json", contentType)
 	}
 
-	if docid != "" && body != nil {
-		return base.HTTPErrorf(http.StatusBadRequest, "doc body and doc id provided. Please provide either the body or a doc id for the import filter dry run")
+	var importFilterPayload ImportFilterDryRunPayload
+	err := h.readJSONInto(&importFilterPayload)
+	// Only require a valid JSON payload if docid is not provided.
+	// If docid is provided, the sync function will use the document from the bucket, and the payload is optional.
+	if err != nil && docid == "" {
+		return base.HTTPErrorf(http.StatusUnprocessableEntity, "Error reading sync function payload: %v", err)
+	}
+
+	//if docid != "" && body != nil {
+	//	return base.HTTPErrorf(http.StatusBadRequest, "doc body and doc id provided. Please provide either the body or a doc id for the import filter dry run")
+	//}
+
+	var doc db.Body
+	if docid != "" {
+		docInBucket, err := h.collection.GetDocument(h.ctx(), docid, db.DocUnmarshalSync)
+		if err != nil {
+			return err
+		}
+		doc = docInBucket.Body(h.ctx())
 	}
-	shouldImport, err := h.collection.ImportFilterDryRun(h.ctx(), body, docid)
+	shouldImport, err := h.collection.ImportFilterDryRun(h.ctx(), doc, importFilterPayload.Function)
 	errorMsg := ""
 	if err != nil {
 		errorMsg = err.Error()