feat(api): support for dynamic dataset readme rendering

Merge pull request #1137 from qri-io/feat_render_api_input

Author: b5

api/api.go

@@ -297,6 +297,7 @@ func NewServerRoutes(s Server) *http.ServeMux {
 	m.Handle("/fsi/write/", s.middleware(fsih.WriteHandler("/fsi/write")))
 
 	renderh := NewRenderHandlers(node.Repo)
+	m.Handle("/render", s.middleware(renderh.RenderHandler))
 	m.Handle("/render/", s.middleware(renderh.RenderHandler))
 
 	lh := NewLogHandlers(node)

api/render.go

@@ -1,9 +1,11 @@
 package api
 
 import (
+	"encoding/json"
 	"net/http"
 
 	"github.com/qri-io/apiutil"
+	"github.com/qri-io/dataset"
 	"github.com/qri-io/qri/lib"
 	"github.com/qri-io/qri/repo"
 )
@@ -33,6 +35,16 @@ func (h *RenderHandlers) RenderHandler(w http.ResponseWriter, r *http.Request) {
 		OutFormat: "html",
 	}
 
+	// support rendering a passed-in JSON dataset document
+	if r.Header.Get("Content-Type") == "application/json" {
+		ds := &dataset.Dataset{}
+		if err := json.NewDecoder(r.Body).Decode(ds); err != nil {
+			apiutil.WriteErrResponse(w, http.StatusBadRequest, err)
+			return
+		}
+		p.Dataset = ds
+	}
+
 	// Old style viz component rendering
 	if r.FormValue("viz") == "true" {
 		data := []byte{}

lib/render.go

@@ -39,19 +39,42 @@ func (RenderRequests) CoreRequestsName() string { return "render" }
 
 // RenderParams defines parameters for the Render method
 type RenderParams struct {
-	Ref       string
-	Template  []byte
-	UseFSI    bool
+	// Ref is a string reference to the dataset to render
+	Ref string
+	// Optionally pass an entire dataset in for rendering, if providing a dataset,
+	// the Ref field must be empty
+	Dataset *dataset.Dataset
+	// Optional template override
+	Template []byte
+	// If true,
+	UseFSI bool
+	// Output format. defaults to "html"
 	OutFormat string
 }
 
+// Validate checks if render parameters are valid
+func (p *RenderParams) Validate() error {
+	if p.Ref != "" && p.Dataset != nil {
+		return fmt.Errorf("cannot provide both a reference and a dataset to render")
+	}
+	return nil
+}
+
 // RenderViz renders a viz component as html
 func (r *RenderRequests) RenderViz(p *RenderParams, res *[]byte) (err error) {
 	if r.cli != nil {
 		return r.cli.Call("RenderRequests.RenderViz", p, res)
 	}
 	ctx := context.TODO()
 
+	if err = p.Validate(); err != nil {
+		return err
+	}
+
+	if p.Dataset != nil {
+		return fmt.Errorf("rendering dynamic dataset viz component is not supported")
+	}
+
 	var ref reporef.DatasetRef
 	if ref, err = repo.ParseDatasetRef(p.Ref); err != nil {
 		return
@@ -74,35 +97,41 @@ func (r *RenderRequests) RenderReadme(p *RenderParams, res *string) (err error)
 	}
 	ctx := context.TODO()
 
-	ref, err := base.ToDatasetRef(p.Ref, r.repo, p.UseFSI)
-	if err != nil {
+	if err = p.Validate(); err != nil {
 		return err
 	}
 
 	var ds *dataset.Dataset
-	if p.UseFSI {
-		if ref.FSIPath == "" {
-			return fsi.ErrNoLink
-		}
-		if ds, err = fsi.ReadDir(ref.FSIPath); err != nil {
-			return fmt.Errorf("loading linked dataset: %s", err)
-		}
+	if p.Dataset != nil {
+		ds = p.Dataset
 	} else {
-		ds, err = dsfs.LoadDataset(ctx, r.repo.Store(), ref.Path)
+		ref, err := base.ToDatasetRef(p.Ref, r.repo, p.UseFSI)
 		if err != nil {
-			return fmt.Errorf("loading dataset: %s", err)
+			return err
+		}
+
+		if p.UseFSI {
+			if ref.FSIPath == "" {
+				return fsi.ErrNoLink
+			}
+			if ds, err = fsi.ReadDir(ref.FSIPath); err != nil {
+				return fmt.Errorf("loading linked dataset: %s", err)
+			}
+		} else {
+			ds, err = dsfs.LoadDataset(ctx, r.repo.Store(), ref.Path)
+			if err != nil {
+				return fmt.Errorf("loading dataset: %s", err)
+			}
 		}
 	}
 
 	if ds.Readme == nil {
 		return fmt.Errorf("no readme to render")
 	}
 
-	err = ds.Readme.OpenScriptFile(ctx, r.repo.Filesystem())
-	if err != nil {
+	if err = ds.Readme.OpenScriptFile(ctx, r.repo.Filesystem()); err != nil {
 		return err
 	}
-
 	if ds.Readme.ScriptFile() == nil {
 		return fmt.Errorf("no readme to render")
 	}

lib/render_test.go

@@ -46,7 +46,7 @@ func TestNewRenderRequests(t *testing.T) {
 		t.Errorf("invalid requests name. expected: '%s', got: '%s'", "render", reqs.CoreRequestsName())
 	}
 
-	// this should panic:
+	// this should panic, triggering the defer statement above
 	NewRenderRequests(tr, rpc.NewClient(conn))
 }
 
@@ -176,6 +176,35 @@ func (r *renderTestRunner) Save(ref string, ds *dataset.Dataset, bodyPath string
 	}
 }
 
+func TestRenderRequestsRenderViz(t *testing.T) {
+	runner := newRenderTestRunner(t, "render_viz")
+	defer runner.Delete()
+
+	params := RenderParams{
+		Ref: "foo/bar",
+		Dataset: &dataset.Dataset{
+			Readme: &dataset.Readme{
+				ScriptBytes: []byte("# hi\n\nhello"),
+			},
+		},
+	}
+	var data []byte
+	if err := runner.RenderReqs.RenderViz(&params, &data); err == nil {
+		t.Errorf("expected RenderReadme with both ref & dataset to error")
+	}
+
+	params = RenderParams{
+		Dataset: &dataset.Dataset{
+			Readme: &dataset.Readme{
+				ScriptBytes: []byte("# hi\n\nhello"),
+			},
+		},
+	}
+	if err := runner.RenderReqs.RenderViz(&params, &data); err == nil {
+		t.Errorf("expected attempt to dynamic-render viz to fail")
+	}
+}
+
 // Test that render with a readme returns an html string
 func TestRenderReadme(t *testing.T) {
 	runner := newRenderTestRunner(t, "render_readme")
@@ -204,4 +233,31 @@ func TestRenderReadme(t *testing.T) {
 	if diff := cmp.Diff(expect, text); diff != "" {
 		t.Errorf("response mismatch (-want +got):\n%s", diff)
 	}
+
+	params = RenderParams{
+		Dataset: &dataset.Dataset{
+			Readme: &dataset.Readme{
+				ScriptBytes: []byte("# hi\n\nhello"),
+			},
+		},
+	}
+	if err = runner.RenderReqs.RenderReadme(&params, &text); err != nil {
+		t.Errorf("dynamic dataset render error: %s", err)
+	}
+
+	if diff := cmp.Diff(expect, text); diff != "" {
+		t.Errorf("dynamic dataset render response mismatch (-want +got):\n%s", diff)
+	}
+
+	params = RenderParams{
+		Ref: "foo/bar",
+		Dataset: &dataset.Dataset{
+			Readme: &dataset.Readme{
+				ScriptBytes: []byte("# hi\n\nhello"),
+			},
+		},
+	}
+	if err = runner.RenderReqs.RenderReadme(&params, &text); err == nil {
+		t.Errorf("expected RenderReadme with both ref & dataset to error")
+	}
 }