feat/logger

eval/main.go

@@ -1,6 +1,7 @@
 package main
 
 import (
+	"context"
 	"flag"
 	"fmt"
 	"time"
@@ -79,7 +80,9 @@ func runEval(browser playwright.Browser, eval *evalConfigYaml) []evalResult {
 			continue
 		}
 
-		locatrOutput, err := playWrightLocatr.GetLocatr(step.UserRequest)
+		ctx := context.Background()
+
+		locatrOutput, err := playWrightLocatr.GetLocatr(ctx, step.UserRequest)
 		if err != nil {
 			logger.Logger.Error("Error getting locator for step", "stepName", step.Name, "error", err)
 			results = append(results, evalResult{

eval/utils.go

@@ -1,6 +1,7 @@
 package main
 
 import (
+	"context"
 	"encoding/csv"
 	"fmt"
 	"os"
@@ -31,6 +32,7 @@ func getAllYamlFiles(folder string) ([]string, error) {
 		"folder", folder, "fileCount", len(res))
 	return res, nil
 }
+
 func contains(locatrs []string, loc string) bool {
 	for _, l := range locatrs {
 		if l == loc {
@@ -48,6 +50,7 @@ func compareSlices(yamlLocatrs []string, locatrs []string) bool {
 	}
 	return false
 }
+
 func readYamlFile(filePath string) (*evalConfigYaml, error) {
 	yamlFile, err := os.ReadFile(filePath)
 	if err != nil {
@@ -81,7 +84,7 @@ func getLocatrFromYamlConfig(evalConfig *evalConfigYaml, page playwright.Page) *
 		reRankClient := reranker.NewCohereClient(os.Getenv("COHERE_API_KEY"))
 		locatrOptions.ReRankClient = reRankClient
 	}
-	return playwrightLocatr.NewPlaywrightLocatr(page, locatrOptions)
+	return playwrightLocatr.NewPlaywrightLocatr(context.Background(), page, locatrOptions)
 }
 
 func writeEvalResultToCsv(results []evalResult, fileName string) {

examples/appium/main.go

@@ -1,6 +1,8 @@
 package main
 
 import (
+	"context"
+	"errors"
 	"fmt"
 	"log/slog"
 	"os"
@@ -9,11 +11,50 @@ import (
 	appiumLocatr "github.com/vertexcover-io/locatr/golang/appium"
 	"github.com/vertexcover-io/locatr/golang/llm"
 	"github.com/vertexcover-io/locatr/golang/logger"
+	"github.com/vertexcover-io/locatr/golang/tracing"
 )
 
+type Config struct {
+	Tracing struct {
+		Endpoint    string
+		ServiceName string
+		Insecure    bool
+	}
+}
+
 func main() {
+	ctx := context.Background()
+
 	logger.Level.Set(slog.LevelDebug)
 
+	cfg := Config{}
+	cfg.Tracing.Endpoint = "localhost:4317"
+	cfg.Tracing.ServiceName = "locator"
+	cfg.Tracing.Insecure = true
+
+	shutdown, err := tracing.SetupOtelSDK(
+		context.Background(),
+		tracing.WithEndpoint(cfg.Tracing.Endpoint),
+		tracing.WithSVCName(cfg.Tracing.ServiceName),
+		tracing.WithInsecure(cfg.Tracing.Insecure),
+	)
+	if err != nil {
+		logger.Logger.Error(
+			"Failed to setup Open Telemetry SDK",
+			slog.String("error", err.Error()),
+		)
+		os.Exit(1)
+	}
+	defer func() {
+		if sErr := shutdown(context.Background()); sErr != nil {
+			err = errors.Join(err, sErr)
+			logger.Logger.Error(
+				"Error while shutting down Open Telemetry service",
+				slog.String("error", err.Error()),
+			)
+		}
+	}()
+
 	llmClient, _ := llm.NewLlmClient(
 		llm.OpenAI, // (openai | anthropic),
 		os.Getenv("OPENAI_MODEL"),
@@ -23,15 +64,16 @@ func main() {
 		LlmClient: llmClient,
 	}
 	aLocatr, err := appiumLocatr.NewAppiumLocatr(
+		ctx,
 		"http://localhost:4723",
-		"640daa1b-afdc-45a3-83fd-d0c37cffb3de", bLocatr,
+		"b97d1a76-3ad5-44a5-840d-286294d94bfc", bLocatr,
 	)
 	if err != nil {
 		fmt.Println("failed creating appium locatr locatr", err)
 		return
 	}
-	desc := "This input element is designed for password entry, indicated by its type attribute set to \"password,\" which obscures the text entered for privacy. It requires user input, as denoted by the \"required\" attribute, ensuring that users do not submit the form without filling out this field. The placeholder text prompts users to \"Enter your password,\" guiding them on the expected input. This input is commonly used within forms where sensitive data is collected, such as registration or login forms."
-	l, err := aLocatr.GetLocatrStr(desc)
+	desc := "This EditText element for 'Email' serves as the second interactive entry point for user input in a linear sequence, positioned directly below an ImageView-containing LinearLayout which implies a visual hierarchy. It follows a specific order that leads to it being the first editable text input provided in the context, indicating its primary role in user authentication workflows."
+	l, err := aLocatr.GetLocatrStr(ctx, desc)
 	if err != nil {
 		fmt.Println("error getting locatr", err)
 	}

examples/cdp/main.go

@@ -1,6 +1,7 @@
 package main
 
 import (
+	"context"
 	"fmt"
 	"log"
 	"os"
@@ -11,6 +12,8 @@ import (
 )
 
 func main() {
+	ctx := context.Background()
+
 	reRankClient := reranker.NewCohereClient(os.Getenv("COHERE_API_KEY"))
 
 	options := locatr.BaseLocatrOptions{
@@ -22,7 +25,7 @@ func main() {
 	connectionOpts := cdpLocatr.CdpConnectionOptions{
 		Port: 9222,
 	}
-	connection, err := cdpLocatr.CreateCdpConnection(connectionOpts)
+	connection, err := cdpLocatr.CreateCdpConnection(ctx, connectionOpts)
 	if err != nil {
 		fmt.Println(err)
 		return
@@ -36,7 +39,7 @@ func main() {
 		return
 	}
 
-	newsItem, err := cdpLocatr.GetLocatrStr("First news link")
+	newsItem, err := cdpLocatr.GetLocatrStr(ctx, "First news link")
 	if err != nil {
 		log.Fatalf("could not get locator: %v", err)
 		return

examples/default-llm-client/main.go

@@ -6,6 +6,7 @@ Example on how to use locatr without passing the llm client.
 */
 
 import (
+	"context"
 	"log"
 	"time"
 
@@ -15,6 +16,8 @@ import (
 )
 
 func main() {
+	ctx := context.Background()
+
 	pw, err := playwright.Run()
 	if err != nil {
 		log.Fatalf("could not start playwright: %v", err)
@@ -44,9 +47,9 @@ func main() {
 		UseCache: true,
 	} // llm client is created by default by reading the environment variables.
 
-	playWrightLocatr := playwrightLocatr.NewPlaywrightLocatr(page, options)
+	playWrightLocatr := playwrightLocatr.NewPlaywrightLocatr(ctx, page, options)
 
-	_, err = playWrightLocatr.GetLocatr("Search Docker Hub input field")
+	_, err = playWrightLocatr.GetLocatr(ctx, "Search Docker Hub input field")
 	if err != nil {
 		log.Fatalf("could not get locator: %v", err)
 	}

examples/dockerhub/docker_hub.go

@@ -6,6 +6,7 @@ Example on how to use locatr with playwright to interact with docker hub.
 */
 
 import (
+	"context"
 	"log"
 	"os"
 	"time"
@@ -17,6 +18,8 @@ import (
 )
 
 func main() {
+	ctx := context.Background()
+
 	pw, err := playwright.Run()
 	if err != nil {
 		log.Fatalf("could not start playwright: %v", err)
@@ -53,9 +56,9 @@ func main() {
 		ResultsFilePath: "docker_hub.json",
 	}
 
-	playWrightLocatr := playwrightLocatr.NewPlaywrightLocatr(page, options)
+	playWrightLocatr := playwrightLocatr.NewPlaywrightLocatr(ctx, page, options)
 
-	sBarLoc, err := playWrightLocatr.GetLocatr("Search Docker Hub input field")
+	sBarLoc, err := playWrightLocatr.GetLocatr(ctx, "Search Docker Hub input field")
 	if err != nil {
 		log.Fatalf("could not get locator: %v", err)
 	}
@@ -70,7 +73,10 @@ func main() {
 	}
 	time.Sleep(5 * time.Second)
 
-	pLink, err := playWrightLocatr.GetLocatr("Link to python repo on docker hub. It has the following description: 'Python is an interpreted, interactive, object-oriented, open-source programming language.'")
+	pLink, err := playWrightLocatr.GetLocatr(
+		ctx,
+		"Link to python repo on docker hub. It has the following description: 'Python is an interpreted, interactive, object-oriented, open-source programming language.'",
+	)
 	if err != nil {
 		log.Fatalf("could not get locator: %v", err)
 	}
@@ -81,7 +87,7 @@ func main() {
 	}
 	time.Sleep(3 * time.Second)
 
-	tagsLoc, err := playWrightLocatr.GetLocatr("Tags tab on the page. It is made up of anchor tag")
+	tagsLoc, err := playWrightLocatr.GetLocatr(ctx, "Tags tab on the page. It is made up of anchor tag")
 	playWrightLocatr.WriteResultsToFile()
 	if err != nil {
 		log.Fatalf("could not get locator: %v", err)

examples/github/github.go

@@ -5,6 +5,7 @@ package main
 Example on how to use locatr with playwright to interact with github.
 */
 import (
+	"context"
 	"fmt"
 	"log"
 	"os"
@@ -51,10 +52,11 @@ func main() {
 		log.Fatalf("could not create llm client: %v", err)
 	}
 	options := locatr.BaseLocatrOptions{UseCache: true, LlmClient: llmClient}
+	ctx := context.Background()
 
-	locatr := playwrightLocatr.NewPlaywrightLocatr(page, options)
+	locatr := playwrightLocatr.NewPlaywrightLocatr(ctx, page, options)
 
-	cDropDownLoc, err := locatr.GetLocatr("<> Code dropdown")
+	cDropDownLoc, err := locatr.GetLocatr(ctx, "<> Code dropdown")
 	if err != nil {
 		log.Fatalf("could not get locator: %v", err)
 		return
@@ -64,7 +66,7 @@ func main() {
 		return
 	}
 
-	dZipLoc, err := locatr.GetLocatr("Download ZIP button on the opened dropdown")
+	dZipLoc, err := locatr.GetLocatr(ctx, "Download ZIP button on the opened dropdown")
 	if err != nil {
 		log.Fatalf("could not get download ZIP locator: %v", err)
 		return

examples/rerank/main.go

@@ -6,6 +6,7 @@ Example on how to use locatr without passing the llm client.
 */
 
 import (
+	"context"
 	"log"
 	"os"
 	"time"
@@ -48,9 +49,10 @@ func main() {
 		ReRankClient: reRankClient,
 	} // llm client is created by default by reading the environment variables.
 
-	playWrightLocatr := playwrightLocatr.NewPlaywrightLocatr(page, options)
+	ctx := context.Background()
+	playWrightLocatr := playwrightLocatr.NewPlaywrightLocatr(ctx, page, options)
 
-	nItem, err := playWrightLocatr.GetLocatr("First news link")
+	nItem, err := playWrightLocatr.GetLocatr(ctx, "First news link")
 	if err != nil {
 		log.Fatalf("could not get locator: %v", err)
 	}

examples/selenium/main.go

@@ -1,6 +1,7 @@
 package main
 
 import (
+	"context"
 	"fmt"
 	"log"
 	"os"
@@ -22,13 +23,15 @@ func main() {
 	caps := selenium.Capabilities{}
 	caps.AddChrome(chrome.Capabilities{Args: []string{}})
 
-	defer service.Stop()
+	defer func() {
+		_ = service.Stop()
+	}()
 	driver, err := selenium.NewRemote(caps, "")
 	if err != nil {
 		log.Fatal(err)
 		return
 	}
-	driver.Get("https://news.ycombinator.com/")
+	_ = driver.Get("https://news.ycombinator.com/")
 
 	reRankClient := reranker.NewCohereClient(os.Getenv("COHERE_API_KEY"))
 
@@ -40,8 +43,13 @@ func main() {
 	// wait for page to load
 	time.Sleep(3 * time.Second)
 
+	ctx := context.Background()
 	seleniumLocatr, err := seleniumLocatr.NewRemoteConnSeleniumLocatr(
-		"http://localhost:4444/wd/hub", "ca0d56a6a3dcfc51eb0110750f0abab7", options) // the path must end with /wd/hub
+		ctx,
+		"http://localhost:4444/wd/hub",
+		"ca0d56a6a3dcfc51eb0110750f0abab7",
+		options,
+	) // the path must end with /wd/hub
 
 	/*
 		or: directly pass the driver
@@ -51,7 +59,7 @@ func main() {
 		log.Fatal(err)
 		return
 	}
-	newsLocatr, err := seleniumLocatr.GetLocatrStr("First news link in the site..")
+	newsLocatr, err := seleniumLocatr.GetLocatrStr(ctx, "First news link in the site..")
 	if err != nil {
 		log.Fatal(err)
 		return

examples/steam/steam.go

@@ -6,6 +6,7 @@ Example on how to use locatr with playwright to interact with steam.
 */
 
 import (
+	"context"
 	"fmt"
 	"log"
 	"os"
@@ -56,10 +57,11 @@ func main() {
 		log.Fatalf("could not create llm client: %v", err)
 	}
 	options := locatr.BaseLocatrOptions{UseCache: true, LlmClient: llmClient}
+	ctx := context.Background()
 
-	playWrightLocatr := playwrightLocatr.NewPlaywrightLocatr(page, options)
+	playWrightLocatr := playwrightLocatr.NewPlaywrightLocatr(ctx, page, options)
 
-	sBarLoc, err := playWrightLocatr.GetLocatr("Search input bar on the steam store.")
+	sBarLoc, err := playWrightLocatr.GetLocatr(ctx, "Search input bar on the steam store.")
 	if err != nil {
 		log.Fatalf("could not get search bar locator: %v", err)
 	}
@@ -73,7 +75,7 @@ func main() {
 	}
 	time.Sleep(5 * time.Second)
 
-	cStrikeLoc, err := playWrightLocatr.GetLocatr("Counter Strike 2 game on the list")
+	cStrikeLoc, err := playWrightLocatr.GetLocatr(ctx, "Counter Strike 2 game on the list")
 	if err != nil {
 		log.Fatalf("could not get Counter Strike 2 locator: %v", err)
 		return
@@ -84,7 +86,7 @@ func main() {
 	}
 	time.Sleep(5 * time.Second)
 
-	sysReqLoc, err := playWrightLocatr.GetLocatr("System Requirements section on the game page.")
+	sysReqLoc, err := playWrightLocatr.GetLocatr(ctx, "System Requirements section on the game page.")
 	if err != nil {
 		log.Fatalf("could not get system requirements locator: %v", err)
 		return