Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add report an issue #480

Merged
merged 3 commits into from
Jul 22, 2024
Merged

Add report an issue #480

merged 3 commits into from
Jul 22, 2024

Conversation

Jyyjy
Copy link
Contributor

@Jyyjy Jyyjy commented Jul 18, 2024

This resolves #478 with the following changes

  1. Allows users to access user ale options via browser action with an icon.
  2. Adds a simple issue form to the options page.
  3. Routes the issue information to the top level frame of the currently active tab.
  4. Adds an e2e test case that verifies the points 2 and 3 above.

Example issue log:

{
"pageUrl": "https://www.openstreetmap.org/#map=19/40.46362/-79.93668&layers=D",
"pageTitle": "OpenStreetMap",
"pageReferrer": "",
"browser": {
"browser": "chrome",
"version": "126.0.0"
},
"clientTime": 1721321016597,
"scrnRes": {
"width": 487,
"height": 857
},
"logType": "custom",
"userAction": true,
"details": {},
"userId": "pluginUser",
"toolVersion": "2.4.0",
"toolName": "useralePlugin",
"useraleVersion": "2.4.0",
"sessionId": "session_1721103156601",
"httpSessionId": "e9ef871810b812bbafdfc232b5fd13a9",
"browserSessionId": "9047683c125414150c97c20753fe97a5",
"issueType": "Bug",
"issueDescription": "A detailed description of the issue.",
"type": "issue"

}

@Jyyjy Jyyjy requested a review from EandrewJones July 18, 2024 16:49
@Jyyjy
Copy link
Contributor Author

Jyyjy commented Jul 19, 2024

Waiting for issue actions/setup-node#1112 to rerun the CI rather than pinning the npm version lower.

Comment on lines +19 to 20
"pretest:e2e": "rm -rf ./test/e2e/chromeData/*",
"posttest:e2e": "rm -rf ./test/e2e/chromeData/*",
Copy link
Contributor

Choose a reason for hiding this comment

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

Why do we need to clean before and after?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added because when a test fails playwright starts a server for the results that needs an interrupt signal to stop. That interrupt signal prevents the post command from cleaning up.

But on second thought, I'll just create an explicit script to cleanup that runs regardless of the main scripts completion.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Turns out, you can't run a script after a SIGINT because of how npm handles SIGINT. So I'm leaving in the pre script.

src/UserALEWebExtension/icons/UserALE Logo.png Outdated Show resolved Hide resolved
src/UserALEWebExtension/messageTypes.ts Outdated Show resolved Hide resolved
src/UserALEWebExtension/options.ts Outdated Show resolved Hide resolved
Comment on lines +73 to +74
><br />
<br />
Copy link
Contributor

Choose a reason for hiding this comment

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

The ol' <br/> to serve as padding instead of proper styles ;). Will let it slide for now.

@EandrewJones
Copy link
Contributor

@Jyyjy Tests now pass. Once you address issues, feel free to merge.

@Jyyjy Jyyjy merged commit ee2389f into master Jul 22, 2024
4 checks passed
@Jyyjy Jyyjy deleted the 478-report-issue branch July 22, 2024 18:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

feat(plugin): allow users to report issues
2 participants