Feature/#265 dom manipulations

e2e/tests/dynamic/doc/inner_html/set.fql

@@ -0,0 +1,13 @@
+LET url = @dynamic
+LET doc = DOCUMENT(url, true)
+
+LET expected = `<span>Hello</span>`
+
+INNER_HTML_SET(doc, "body", "<span>Hello</span>")
+
+LET actual = INNER_HTML(doc, "body")
+
+LET r1 = '(\s|\")'
+LET r2 = '(\n|\s|\")'
+
+RETURN EXPECT(REGEXP_REPLACE(expected, r1, ''), REGEXP_REPLACE(TRIM(actual), r2, ''))

e2e/tests/dynamic/element/inner_html/set.fql

@@ -0,0 +1,14 @@
+LET url = @dynamic
+LET doc = DOCUMENT(url, true)
+LET el = ELEMENT(doc, "#index")
+
+LET expected = "<span>This node was injected by Ferret</span>"
+INNER_HTML_SET(el, "<span>This node was injected by Ferret</span>")
+LET actual = INNER_HTML(el)
+
+WAIT(100)
+
+LET r1 = '(\s|\")'
+LET r2 = '(\n|\s|\")'
+
+RETURN EXPECT(REGEXP_REPLACE(expected, r1, ''), REGEXP_REPLACE(TRIM(actual), r2, ''))

pkg/drivers/cdp/document.go

@@ -22,8 +22,6 @@ import (
 	"github.com/MontFerret/ferret/pkg/runtime/values"
 )
 
-const BlankPageURL = "about:blank"
-
 type HTMLDocument struct {
 	logger   *zerolog.Logger
 	client   *cdp.Client

pkg/drivers/cdp/driver.go

@@ -3,6 +3,7 @@ package cdp
 import (
 	"context"
 	"sync"
+	"time"
 
 	"github.com/mafredri/cdp"
 	"github.com/mafredri/cdp/devtool"
@@ -16,6 +17,8 @@ import (
 )
 
 const DriverName = "cdp"
+const BlankPageURL = "about:blank"
+const DefaultTimeout = 5000 * time.Millisecond
 
 type Driver struct {
 	mu        sync.Mutex

pkg/drivers/cdp/element.go

@@ -4,9 +4,6 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
-	"github.com/MontFerret/ferret/pkg/drivers/cdp/templates"
-	"github.com/pkg/errors"
-	"golang.org/x/net/html"
 	"hash/fnv"
 	"strconv"
 	"strings"
@@ -16,6 +13,7 @@ import (
 	"github.com/MontFerret/ferret/pkg/drivers/cdp/eval"
 	"github.com/MontFerret/ferret/pkg/drivers/cdp/events"
 	"github.com/MontFerret/ferret/pkg/drivers/cdp/input"
+	"github.com/MontFerret/ferret/pkg/drivers/cdp/templates"
 	"github.com/MontFerret/ferret/pkg/drivers/common"
 	"github.com/MontFerret/ferret/pkg/runtime/core"
 	"github.com/MontFerret/ferret/pkg/runtime/values"
@@ -24,7 +22,9 @@ import (
 	"github.com/mafredri/cdp"
 	"github.com/mafredri/cdp/protocol/dom"
 	"github.com/mafredri/cdp/protocol/runtime"
+	"github.com/pkg/errors"
 	"github.com/rs/zerolog"
+	"golang.org/x/net/html"
 )
 
 var emptyNodeID = dom.NodeID(0)
@@ -46,7 +46,7 @@ type (
 		id             HTMLElementIdentity
 		nodeType       html.NodeType
 		nodeName       values.String
-		innerHTML      values.String
+		innerHTML      *common.LazyValue
 		innerText      *common.LazyValue
 		value          core.Value
 		attributes     *common.LazyValue
@@ -118,7 +118,7 @@ func LoadHTMLElementWithID(
 		return nil, core.Error(err, strconv.Itoa(int(id.nodeID)))
 	}
 
-	innerHTML, err := loadInnerHTML(ctx, client, exec, id, common.ToHTMLType(node.Node.NodeType))
+	innerHTML, err := getInnerHTML(ctx, client, exec, id, common.ToHTMLType(node.Node.NodeType))
 
 	if err != nil {
 		return nil, core.Error(err, strconv.Itoa(int(id.nodeID)))
@@ -168,7 +168,7 @@ func NewHTMLElement(
 	el.id = id
 	el.nodeType = common.ToHTMLType(nodeType)
 	el.nodeName = values.NewString(nodeName)
-	el.innerHTML = innerHTML
+	el.innerHTML = common.NewVolatileValue(innerHTML, el.loadInnerHTML)
 	el.innerText = common.NewLazyValue(el.loadInnerText)
 	el.attributes = common.NewLazyValue(el.loadAttrs)
 	el.style = common.NewLazyValue(el.parseStyle)
@@ -222,17 +222,27 @@ func (el *HTMLElement) MarshalJSON() ([]byte, error) {
 }
 
 func (el *HTMLElement) String() string {
-	return el.GetInnerHTML(context.Background()).String()
+	ctx, cancel := context.WithTimeout(context.Background(), DefaultTimeout)
+
+	defer cancel()
+
+	res, err := el.GetInnerHTML(ctx)
+
+	if err != nil {
+		el.logError(errors.Wrap(err, "HTMLElement.String"))
+
+		return ""
+	}
+
+	return res.String()
 }
 
 func (el *HTMLElement) Compare(other core.Value) int64 {
 	switch other.Type() {
 	case drivers.HTMLElementType:
 		other := other.(drivers.HTMLElement)
 
-		ctx := context.Background()
-
-		return el.GetInnerHTML(ctx).Compare(other.GetInnerHTML(ctx))
+		return int64(strings.Compare(el.String(), other.String()))
 	default:
 		return drivers.Compare(el.Type(), other.Type())
 	}
@@ -243,14 +253,11 @@ func (el *HTMLElement) Unwrap() interface{} {
 }
 
 func (el *HTMLElement) Hash() uint64 {
-	el.mu.Lock()
-	defer el.mu.Unlock()
-
 	h := fnv.New64a()
 
 	h.Write([]byte(el.Type().String()))
 	h.Write([]byte(":"))
-	h.Write([]byte(el.innerHTML))
+	h.Write([]byte(strconv.Itoa(int(el.id.nodeID))))
 
 	return h.Sum64()
 }
@@ -858,75 +865,80 @@ func (el *HTMLElement) InnerTextBySelectorAll(ctx context.Context, selector valu
 	return arr
 }
 
-func (el *HTMLElement) GetInnerHTML(_ context.Context) values.String {
-	el.mu.Lock()
-	defer el.mu.Unlock()
+func (el *HTMLElement) GetInnerHTML(ctx context.Context) (values.String, error) {
+	val, err := el.innerHTML.Read(ctx)
+
+	if err != nil {
+		return values.EmptyString, err
+	}
+
+	if val == values.None {
+		return values.EmptyString, nil
+	}
 
-	return el.innerHTML
+	return val.(values.String), nil
 }
 
-func (el *HTMLElement) InnerHTMLBySelector(ctx context.Context, selector values.String) values.String {
+func (el *HTMLElement) SetInnerHTML(ctx context.Context, innerHTML values.String) error {
 	if el.IsDetached() {
-		return values.EmptyString
+		return drivers.ErrDetached
+	}
+
+	el.innerHTML.Reset()
+
+	return setInnerHTML(ctx, el.client, el.exec, el.id, innerHTML)
+}
+
+func (el *HTMLElement) GetInnerHTMLBySelector(ctx context.Context, selector values.String) (values.String, error) {
+	if el.IsDetached() {
+		return values.EmptyString, drivers.ErrDetached
 	}
 
-	// TODO: Can we use RemoteObjectID or BackendID instead of NodeId?
 	found, err := el.client.DOM.QuerySelector(ctx, dom.NewQuerySelectorArgs(el.id.nodeID, selector.String()))
 
 	if err != nil {
-		el.logError(err).
-			Str("selector", selector.String()).
-			Msg("failed to retrieve nodes by selector")
-
-		return values.EmptyString
+		return values.EmptyString, err
 	}
 
-	text, err := loadInnerHTMLByNodeID(ctx, el.client, el.exec, found.NodeID)
+	text, err := getInnerHTMLByNodeID(ctx, el.client, el.exec, found.NodeID)
 
 	if err != nil {
-		el.logError(err).
-			Str("selector", selector.String()).
-			Int("childNodeID", int(found.NodeID)).
-			Msg("failed to load inner HTML for found child el")
+		return values.EmptyString, err
+	}
 
-		return values.EmptyString
+	return text, nil
+}
+
+func (el *HTMLElement) SetInnerHTMLBySelector(ctx context.Context, selector, innerHTML values.String) error {
+	if el.IsDetached() {
+		return drivers.ErrDetached
 	}
 
-	return text
+	return el.exec.Eval(ctx, templates.SetInnerHTMLBySelector(selector.String(), innerHTML.String()))
 }
 
-func (el *HTMLElement) InnerHTMLBySelectorAll(ctx context.Context, selector values.String) *values.Array {
-	// TODO: Can we use RemoteObjectID or BackendID instead of NodeId?
+func (el *HTMLElement) GetInnerHTMLBySelectorAll(ctx context.Context, selector values.String) (*values.Array, error) {
+	// TODO: Can we use RemoteObjectID instead of NodeId?
 	selectorArgs := dom.NewQuerySelectorAllArgs(el.id.nodeID, selector.String())
 	res, err := el.client.DOM.QuerySelectorAll(ctx, selectorArgs)
 
 	if err != nil {
-		el.logError(err).
-			Str("selector", selector.String()).
-			Msg("failed to retrieve nodes by selector")
-
-		return values.NewArray(0)
+		return values.NewArray(0), err
 	}
 
 	arr := values.NewArray(len(res.NodeIDs))
 
 	for _, id := range res.NodeIDs {
-		text, err := loadInnerHTMLByNodeID(ctx, el.client, el.exec, id)
+		text, err := getInnerHTMLByNodeID(ctx, el.client, el.exec, id)
 
 		if err != nil {
-			el.logError(err).
-				Str("selector", selector.String()).
-				Int("childNodeID", int(id)).
-				Msg("failed to load inner HTML for found child el")
-
-			// return what we have
-			return arr
+			return values.NewArray(0), err
 		}
 
 		arr.Push(text)
 	}
 
-	return arr
+	return arr, nil
 }
 
 func (el *HTMLElement) CountBySelector(ctx context.Context, selector values.String) values.Int {
@@ -1081,9 +1093,17 @@ func (el *HTMLElement) IsDetached() values.Boolean {
 	return !el.connected
 }
 
+func (el *HTMLElement) loadInnerHTML(ctx context.Context) (core.Value, error) {
+	if el.IsDetached() {
+		return values.None, drivers.ErrDetached
+	}
+
+	return getInnerHTML(ctx, el.client, el.exec, el.id, el.nodeType)
+}
+
 func (el *HTMLElement) loadInnerText(ctx context.Context) (core.Value, error) {
 	if !el.IsDetached() {
-		text, err := loadInnerText(ctx, el.client, el.exec, el.id, el.nodeType)
+		text, err := getInnerText(ctx, el.client, el.exec, el.id, el.nodeType)
 
 		if err == nil {
 			return text, nil
@@ -1094,7 +1114,13 @@ func (el *HTMLElement) loadInnerText(ctx context.Context) (core.Value, error) {
 		// and just parse cached innerHTML
 	}
 
-	h := el.GetInnerHTML(ctx)
+	h, err := el.GetInnerHTML(ctx)
+
+	if err != nil {
+		el.logError(err).Msg("failed to get inner html from remote object")
+
+		return values.None, err
+	}
 
 	if h == values.EmptyString {
 		return h, nil
@@ -1329,15 +1355,7 @@ func (el *HTMLElement) handleChildInserted(ctx context.Context, message interfac
 
 		loadedArr.Insert(values.NewInt(targetIDx), loadedEl)
 
-		newInnerHTML, err := loadInnerHTML(ctx, el.client, el.exec, el.id, el.nodeType)
-
-		if err != nil {
-			el.logError(err).Msg("failed to update element")
-
-			return
-		}
-
-		el.innerHTML = newInnerHTML
+		el.innerHTML.Reset()
 		el.innerText.Reset()
 	})
 }
@@ -1391,19 +1409,7 @@ func (el *HTMLElement) handleChildRemoved(ctx context.Context, message interface
 		loadedArr := v.(*values.Array)
 		loadedArr.RemoveAt(values.NewInt(targetIDx))
 
-		newInnerHTML, err := loadInnerHTML(ctx, el.client, el.exec, el.id, el.nodeType)
-
-		if err != nil {
-			el.logger.Error().
-				Timestamp().
-				Err(err).
-				Int("nodeID", int(el.id.nodeID)).
-				Msg("failed to update element")
-
-			return
-		}
-
-		el.innerHTML = newInnerHTML
+		el.innerHTML.Reset()
 		el.innerText.Reset()
 	})
 }