Move Sobek entirely out of the business logic

[inancgumus]

What?

Move Sobek entirely out of the business logic.

Why?

• Prevent Sobek data races.
• Better type-safety using native Go constructs.
• Developer productivity increase.
• Separation of concerns.
• Moving Sobek handling to the mapping layer will make the code easy to reason about, reduce the business logic's Sobek dependency, and simplify the business logic code and tests.
• Having Sobek in the business logic requires constant encoding and decoding.

Desobekifying Sobek transformation

Besides moving the calling of Sobek option parsing in the business logic, we also plan to move the Sobek-dependent option parsing part out of the business logic. Once we finish doing the same with the rest of the option parsing, we can entirely remove the Sobek dependency from the business logic.

We currently parse Sobek values into our business logic types, but the parsing dependency is in an unrelated package (common). To enhance maintainability, we move the parsing process and keep related components together (in the mapping layer). Additionally, we could implement a Validate method for the business types (in the common package) to check their validity separately from the Sobek transformation.

Moreover, we use pointers quite liberally, which is not good in terms of reduced performance and also because of many nil-pointer panics. Also, since our module is highly current, it's dangerous to have so many pointers around. So, another goal would be to get rid of as many pointer-ed options as possible to boost stability even more.

See grafana/xk6-browser#1510 for an example.

Tasks

Tasks

Preview Give feedback

1. De-sobekify ElementHandle methods #4220
   area: browser +1
2. De-sobekify Frame methods #4221
   area: browser +1
3. De-sobekify Page methods #4222
   area: browser +1
4. De-sobekify Locator methods #4223
   area: browser +1
5. De-sobekify Mouse methods #4224
   0 of 2
   area: browser refactor +2
6. De-sobekify BrowserContext methods xk6-browser#1270
   12 of 13
   mapping stability +2
   
7. Remove NetworkManager.ExtraHTTPHeaders that returns a sobek.Value xk6-browser#1282
   2 of 2
   maintenance +1
   
8. De-sobekify Keyboard option parsing out of common xk6-browser#1522
   2 of 2
   refactor stability +2
   
9. Discuss: Should we add option parsing to the trace spans? #4225
   area: browser +1
10. De-sobekify Browser methods xk6-browser#1269
    2 of 2
    mapping stability +2
    
11. De-sobekify Request methods xk6-browser#1275
    2 of 2
    maintenance stability +2
    
12. De-sobekify Keyboard methods xk6-browser#1277
    2 of 2
    refactor stability +2
    
13. De-sobekify Connection.Close method? xk6-browser#1281
    2 of 2
    refactor stability +2
    
14. Refactor Sobek out of browserContext.addinitscript xk6-browser#1228
    refactor stability +2
    
15. Refactor Sobek out of screenshots and byte pointer changes xk6-browser#1198
    refactor stability +2
    

Related PR(s)/Issue(s)

grafana/xk6-browser#271