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

Refactor browserContext.grantPermissions #1075

Merged
merged 9 commits into from
Oct 23, 2023
Merged

Refactor browserContext.grantPermissions #1075

merged 9 commits into from
Oct 23, 2023

Conversation

ankur22
Copy link
Collaborator

@ankur22 ankur22 commented Oct 18, 2023 •
edited
Loading

What?

This refactors the browserContext.grantPermissions implementation.

Why?

This helps bring it inline with current ways of implementing the APIs:

  1. Parsing the options in a new parsed type.
  2. Returning an error instead of panicking.
  3. Explicit errors when a permission is invalid/unrecognised.
  4. Working with goja in the mapping layer and not in the business logic.

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)

Prerequisite to working on grafana/k6#4435

@ankur22 ankur22 force-pushed the refactor/grantPermissions branch 3 times, most recently from b8e6390 to 08e7912 Compare October 18, 2023 16:50
ka3de
ka3de previously approved these changes Oct 19, 2023
View reviewed changes
Copy link
Collaborator

@ka3de ka3de left a comment

Choose a reason for hiding this comment

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

LGTM 👏

@ankur22 ankur22 requested a review from inancgumus October 19, 2023 08:39
inancgumus
inancgumus previously approved these changes Oct 19, 2023
View reviewed changes
Copy link
Member

@inancgumus inancgumus left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Nice work 👍 It's a good step towards #271 and #1064. Thanks! Some minor suggestions. Feel free to skip.

browser/mapping.go Outdated Show resolved Hide resolved
common/browser_context.go Outdated Show resolved Hide resolved
common/browser_context.go Outdated Show resolved Hide resolved
common/browser_context_options.go Outdated Show resolved Hide resolved
common/browser_context_options.go Outdated Show resolved Hide resolved
common/browser_context_options.go Outdated Show resolved Hide resolved
tests/browser_context_test.go Show resolved Hide resolved
@ankur22 ankur22 force-pushed the refactor/grantPermissions branch from 08e7912 to d5c55a6 Compare October 19, 2023 09:10
@ankur22 ankur22 dismissed stale reviews from ka3de and inancgumus via 74822b1 October 19, 2023 09:14
@ankur22 ankur22 force-pushed the refactor/grantPermissions branch from 9d81296 to 3f1f503 Compare October 19, 2023 14:50
@ankur22 ankur22 requested review from inancgumus and ka3de October 19, 2023 14:50
ka3de
ka3de previously approved these changes Oct 20, 2023
View reviewed changes
Copy link
Collaborator

@ka3de ka3de left a comment

Choose a reason for hiding this comment

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

LGTM.

@ankur22 ankur22 force-pushed the refactor/grantPermissions branch from 3f1f503 to f7f3714 Compare October 23, 2023 08:35
ankur22 and others added 9 commits October 23, 2023 11:05
@ankur22
Use the helper gojaValueExists
7c616a5
@ankur22
Move grantPermissions options parsing
ce6c238 
This change aligns the options parsing with the other APIs.
@ankur22
Refactor to return an error
d5eb5da 
Instead of panicking in grantPermissions we should return an error to
prevent unnecessary panics.
@ankur22
Move goja parsing to mapping layer
58bf484 
This moves the goja value parsing into the mapping layer so that we're
removing goja from the browserContext business logic, which makes the
code a bit more maintainable.
@ankur22
Add a failure case when perms are invalid
51ed336 
This change makes it explicit when a permission is used that the module
doesn't recognise, allowing the user to fix the mistake quickly instead
of having to debug the issue if the module just hid the invalid
permissions.
@ankur22
Add test for browserContext.grantPermission
16929d8
@ankur22
Rename short lived/scoped variable
c4427ff
@ankur22 @inancgumus
Apply suggestions from code review
51d9268 
Co-authored-by: İnanç Gümüş <[email protected]>
@ankur22
Refactor comment to align to go naming convention
50992a9
@ankur22 ankur22 force-pushed the refactor/grantPermissions branch from f7f3714 to 50992a9 Compare October 23, 2023 10:09
ka3de
ka3de approved these changes Oct 23, 2023
View reviewed changes
Copy link
Collaborator

@ka3de ka3de left a comment

Choose a reason for hiding this comment

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

LGTM.

@ankur22 ankur22 merged commit ca8adca into main Oct 23, 2023
@ankur22 ankur22 deleted the refactor/grantPermissions branch October 23, 2023 14:07
@ankur22 ankur22 mentioned this pull request Jan 30, 2025
Open
@Porkepix Porkepix mentioned this pull request Dec 6, 2023
Merged
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@inancgumus inancgumus inancgumus approved these changes

@ka3de ka3de ka3de approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

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