Expose the database client to the scripts

[mrheinen]

User description

This is to fix https://github.com/mrheinen/lophiid/issues/2

---

PR Type

Enhancement, Tests, Documentation

---

Description

• Enhanced the JavaScript runner to accept and utilize a database client.
• Exposed database functions to the JavaScript environment via DatabaseClientWrapper.
• Updated existing tests and added new tests to cover database interactions.
• Documented the new database functions available in the JavaScript environment.

---

Changes walkthrough 📝

	Relevant files
Enhancement	backend_main.go Pass database client to JavaScript runner initialization  cmd/backend/backend_main.go - Added `dbc` parameter to `NewGojaJavascriptRunner` call. +1/-1      goja.go Expose database client functions to JavaScript environment pkg/javascript/goja.go Added DatabaseClientWrapper to expose database functions to JavaScript. Modified GojaJavascriptRunner to include dbClient. Updated NewGojaJavascriptRunner to accept dbClient. +43/-6
Tests	goja_test.go Add tests for database client usage in JavaScript runner  pkg/javascript/goja_test.go Updated tests to include FakeDatabaseClient. Added TestRunScriptUsesDatabase to test database interactions. +103/-4
Documentation	SCRIPTING.md Document database client functions for JavaScript                SCRIPTING.md - Documented `util.database.getContentById` function. +9/-0

---

💡 PR-Agent usage: Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

[mrheinen]

@CodiumAI-Agent /review

[mrheinen]

/review

[github-actions[bot]]

PR Reviewer Guide 🔍

⏱️ Estimated effort to review: 3 🔵🔵🔵⚪⚪

🧪 PR contains tests

🔒 No security concerns identified

⚡ Key issues to review Error Handling The new method `GetContentById` in `DatabaseClientWrapper` does not log or handle errors except for returning `nil`. Consider adding error logging or handling to improve debugging and error tracking. Security Concern Ensure that the database access in `DatabaseClientWrapper` does not inadvertently expose sensitive data or allow for injection attacks, especially since it interfaces directly with JavaScript code.

[mrheinen]

/describe

[github-actions[bot]]

PR Description updated to latest commit (https://github.com/mrheinen/lophiid/commit/9c15ca67e87505b3ad181688a546e688583bed2e)

[mrheinen]

/improve

[github-actions[bot]]

PR Code Suggestions ✨

Category	Suggestion	Score
Best practice	Improve error handling by logging errors when database queries fail ___ **Consider handling the error returned by d.dbClient.GetContentByID(id) explicitly by logging it or returning it to the caller instead of just returning nil. This will help in debugging and understanding the flow of data and errors.** [pkg/javascript/goja.go [197-200]](https://github.com/mrheinen/lophiid/pull/6/files#diff-93ebbcb2bc5cc6ca7ef6d25c1ce739d50fc1194101ed2b4469c1941da4111828R197-R200) ```diff cn, err := d.dbClient.GetContentByID(id) if err != nil { + log.Errorf("Failed to get content by ID: %v", err) return nil } ``` Suggestion importance[1-10]: 9 Why: This suggestion improves error handling by logging the error, which aids in debugging and understanding the flow of data and errors. It is a best practice to log errors for better traceability.	9
Robustness	Add input validation to the constructor of GojaJavascriptRunner ___ **To make the GojaJavascriptRunner struct initialization more robust, consider checking for nil inputs in the constructor and return an error if any essential parameter is nil.** [pkg/javascript/goja.go [116-126]](https://github.com/mrheinen/lophiid/pull/6/files#diff-93ebbcb2bc5cc6ca7ef6d25c1ce739d50fc1194101ed2b4469c1941da4111828R116-R126) ```diff -func NewGojaJavascriptRunner(dbClient database.DatabaseClient, metrics *GojaMetrics) *GojaJavascriptRunner { +func NewGojaJavascriptRunner(dbClient database.DatabaseClient, metrics *GojaMetrics) (*GojaJavascriptRunner, error) { + if dbClient == nil || metrics == nil { + return nil, errors.New("dbClient and metrics cannot be nil") + } return &GojaJavascriptRunner{ strCache: cache, metrics: metrics, dbClient: dbClient, - } + }, nil } ``` Suggestion importance[1-10]: 8 Why: Adding input validation makes the constructor more robust by ensuring that essential parameters are not nil, which can prevent potential runtime errors.	8
Encapsulation	Encapsulate the dbClient field and provide a constructor for DatabaseClientWrapper ___ **For better encapsulation and to prevent direct modifications, consider making the dbClient field in DatabaseClientWrapper private and provide a constructor for initializing it.** [pkg/javascript/goja.go [192-194]](https://github.com/mrheinen/lophiid/pull/6/files#diff-93ebbcb2bc5cc6ca7ef6d25c1ce739d50fc1194101ed2b4469c1941da4111828R192-R194) ```diff type DatabaseClientWrapper struct { dbClient database.DatabaseClient } +func NewDatabaseClientWrapper(client database.DatabaseClient) *DatabaseClientWrapper { + return &DatabaseClientWrapper{dbClient: client} +} + ``` Suggestion importance[1-10]: 7 Why: Encapsulation is a good practice for maintaining control over how fields are accessed and modified. Providing a constructor improves code readability and maintainability.	7
Concurrency	Add thread safety to the ContentWrapper struct ___ **To ensure that the ContentWrapper struct is safely usable in concurrent environments, consider adding mutex locks around accesses to its fields if they can be accessed concurrently.** [pkg/javascript/goja.go [174-176]](https://github.com/mrheinen/lophiid/pull/6/files#diff-93ebbcb2bc5cc6ca7ef6d25c1ce739d50fc1194101ed2b4469c1941da4111828R174-R176) ```diff type ContentWrapper struct { + sync.Mutex Content database.Content } ``` Suggestion importance[1-10]: 3 Why: While adding mutex locks can ensure thread safety, there is no indication in the provided code that `ContentWrapper` will be accessed concurrently. This suggestion might be unnecessary unless concurrent access is expected.	3