1
0
mirror of https://github.com/MontFerret/ferret.git synced 2025-07-05 00:49:00 +02:00

Added timeout to DOCUMENT function (#186)

This commit is contained in:
Tim Voronov
2018-11-21 20:38:27 -05:00
committed by GitHub
parent 05772972d0
commit d94a2fb004
4 changed files with 74 additions and 19 deletions

View File

@ -2,20 +2,27 @@ package html
import (
"context"
"github.com/MontFerret/ferret/pkg/html"
"github.com/MontFerret/ferret/pkg/runtime/core"
"github.com/MontFerret/ferret/pkg/runtime/values"
"time"
)
// Document loads a document by a given url.
type LoadDocumentArgs struct {
Dynamic values.Boolean
Timeout values.Int
}
// Page loads a HTML document by a given url.
// By default, loads a document by http call - resulted document does not support any interactions.
// If passed "true" as a second argument, headless browser is used for loading the document which support interactions.
// @param url (String) - Target url string. If passed "about:blank" for dynamic document - it will open an empty page.
// @param dynamic (Boolean) - Optional boolean value indicating whether to use dynamic document.
// @param dynamicOrTimeout (Boolean|Int, optional) - If boolean value is passed, it indicates whether to use dynamic document.
// If integer values is passed it sets a custom timeout.
// @param timeout (Int, optional) - Sets a custom timeout.
// @returns (HTMLDocument) - Returns loaded HTML document.
func Document(ctx context.Context, args ...core.Value) (core.Value, error) {
err := core.ValidateArgs(args, 1, 2)
err := core.ValidateArgs(args, 1, 3)
if err != nil {
return values.None, err
@ -23,22 +30,24 @@ func Document(ctx context.Context, args ...core.Value) (core.Value, error) {
err = core.ValidateType(args[0], core.StringType)
if err != nil {
return values.None, err
}
url := args[0].(values.String)
dynamic := values.False
if len(args) == 2 {
err = core.ValidateType(args[1], core.BooleanType)
params, err := parseLoadDocumentArgs(args)
if err != nil {
return values.None, err
}
dynamic = args[1].(values.Boolean)
if err != nil {
return values.None, err
}
var drv html.Driver
if !dynamic {
ctx, cancel := context.WithTimeout(ctx, time.Duration(params.Timeout)*time.Millisecond)
defer cancel()
if params.Dynamic == false {
drv, err = html.FromContext(ctx, html.Static)
} else {
drv, err = html.FromContext(ctx, html.Dynamic)
@ -50,3 +59,41 @@ func Document(ctx context.Context, args ...core.Value) (core.Value, error) {
return drv.GetDocument(ctx, url)
}
func parseLoadDocumentArgs(args []core.Value) (LoadDocumentArgs, error) {
res := LoadDocumentArgs{
Timeout: values.Int(time.Second * 30),
}
if len(args) == 3 {
err := core.ValidateType(args[1], core.BooleanType)
if err != nil {
return res, err
}
res.Dynamic = args[1].(values.Boolean)
err = core.ValidateType(args[2], core.IntType)
if err != nil {
return res, err
}
res.Timeout = args[2].(values.Int)
} else if len(args) == 2 {
err := core.ValidateType(args[1], core.BooleanType, core.IntType)
if err != nil {
return res, err
}
if args[1].Type() == core.BooleanType {
res.Dynamic = args[1].(values.Boolean)
} else {
res.Timeout = args[1].(values.Int)
}
}
return res, nil
}