Skip to content
This repository has been archived by the owner on Jan 30, 2025. It is now read-only.

Provide both Sync and Async JS APIs #1373

Merged
merged 20 commits into from
Jun 6, 2024
Merged

Provide both Sync and Async JS APIs #1373

merged 20 commits into from
Jun 6, 2024

Conversation

inancgumus
Copy link
Member

@inancgumus inancgumus commented Jun 6, 2024 •
edited
Loading

What?

Provides sync and async APIs within the same module.

  • k6/x/browser -> maps to sync JS API
  • k6/x/browser/async -> maps to async JS API

Why?

  • To give headroom to users to easily switch to the new async API
  • To graduate from the non-experimental module

Plan

  • We'll remove the sync API after ~two cycles.
  • We'll also register these from the k6-core side.

I'll create issues for this.

Checklist

  • I have performed a self-review of my code
  • I have added tests for my changes
  • I have commented on my code, particularly in hard-to-understand areas

Related PR(s)/Issue(s)

#1117 #428

@inancgumus inancgumus added async supports async (promises) compatibility k6 core compatibility labels Jun 6, 2024
@inancgumus inancgumus self-assigned this Jun 6, 2024
@inancgumus inancgumus changed the title Provide both sync and async API Provide both Sync and Async JS APIs Jun 6, 2024
ankur22
ankur22 reviewed Jun 6, 2024
View reviewed changes
Copy link
Collaborator

@ankur22 ankur22 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this quick turnaround on this. Generally LGTM.

I do think it's worth keeping the sync examples too 👍 Looks like you're still working on the workflow for them so I'll rereview it once you've resolved the issue.

browser/module.go Show resolved Hide resolved
register_sync.go Outdated Show resolved Hide resolved
@inancgumus inancgumus force-pushed the sync/api branch 2 times, most recently from 1ecf50c to 48e4dee Compare June 6, 2024 14:49
@inancgumus inancgumus requested a review from ankur22 June 6, 2024 15:17
@inancgumus inancgumus force-pushed the improve/text-content-null-detection branch 2 times, most recently from b987414 to 770f2ae Compare June 6, 2024 15:23
Base automatically changed from improve/text-content-null-detection to main-async June 6, 2024 15:24
inancgumus added 6 commits June 6, 2024 18:25
@inancgumus
Add syncMapLocator
c3a5e2f
@inancgumus
Update to textContent to work with null
c54d423
@inancgumus
Update to getAttribute to work with null
e72ddb8
@inancgumus
Update JS examples to async
719d27b
@inancgumus
Add sync JS examples
6ae719b
@inancgumus
Add a sync examples github workflow
8b9d9de 
The reason behind this is that the E2E tests take huge resource on
Github and become more flaky when run together both with sync and async
examples. Since we're using a weak Github runner.
ankur22
ankur22 approved these changes Jun 6, 2024
View reviewed changes
Copy link
Collaborator

@ankur22 ankur22 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is awesome! Thanks! LGTM 🚀

@inancgumus inancgumus merged commit 7883921 into main-async Jun 6, 2024
20 checks passed
@inancgumus inancgumus deleted the sync/api branch June 6, 2024 15:41
@inancgumus inancgumus mentioned this pull request Jan 30, 2025
Open
@BrewTestBot BrewTestBot mentioned this pull request Jun 25, 2024
Merged
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@ankur22 ankur22 ankur22 approved these changes

@andrewslotin andrewslotin Awaiting requested review from andrewslotin

Assignees

@inancgumus inancgumus

Labels
async supports async (promises) compatibility k6 core compatibility
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@inancgumus @ankur22