feat: add to highlights button #64

Anush008 · 2023-05-04T02:21:51Z

What type of PR is this? (check all applicable)

Description

This PR adds the "Add PR to OpenSauced highlights" button as mentioned in #12.

The button is displayed on the header bar of the author's first comment on the PR as suggested in Add PR to OpenSauced Highlights button #12 (comment).
As of now, the button is only displayed on PRs authored by the signed-in user. https://github.com/open-sauced/browser-extensions/blob/d561ad87722c07135adb76ad1d7d7fdf9a2349f1/src/utils/dom-utils/addPRToHighlights.ts#L21 https://github.com/open-sauced/browser-extensions/blob/d561ad87722c07135adb76ad1d7d7fdf9a2349f1/src/utils/dom-utils/addPRToHighlights.ts#L10-L12
The PR URL is appended to the redirect link as query parameter to be used for prefilled inputs on highlight create page if required. https://github.com/open-sauced/browser-extensions/blob/d561ad87722c07135adb76ad1d7d7fdf9a2349f1/src/content-scripts/components/AddPRToHighlights/AddPRToHighlightsButton.ts#L6
Two new URL matchers have been added to src/utils/urlMatchers.ts to check for the current location of the user on github.com to avoid using multiple content scripts for the same domain. https://github.com/open-sauced/browser-extensions/blob/d561ad87722c07135adb76ad1d7d7fdf9a2349f1/src/content-scripts/github.ts#L18 https://github.com/open-sauced/browser-extensions/blob/d561ad87722c07135adb76ad1d7d7fdf9a2349f1/src/content-scripts/github.ts#L20

Additionally,

This PR adds an improved DOM update watcher utility at src/utils/dom-utils/domUpdateWatcher.ts that listens to updates in the document location and invokes a callback without the need for a background-worker and can be used in content-scripts like so: https://github.com/open-sauced/browser-extensions/blob/a6f351eee7980b9f50935e49f49d14474275586b/src/content-scripts/github.ts#L33 This effectively eliminates all previous closed-receiving-end errors experienced by the extension due to message passing between the background-worker and the content-script. 51a5a4e

Related Tickets & Documents

Resolves #12.

Mobile & Desktop Screenshots/Recordings

Added tests?

👍 yes
🙅 no, because they aren't needed
🙋 no, because I need help

Added to documentation?

bdougie · 2023-05-04T14:05:41Z

This PR adds an improved DOM update watcher utility at src/utils/dom-utils/domUpdateWatcher.ts that listens to updates in the document location and invokes a callback without the need for a background-worker and can be used in content-scripts like so

@Anush008, these types of improvements need to be added to the README and eventually https://docs.opensauced.pizza/

The improvements using caching and service workers are helpful for future contributors, but this knowledge will be los without proper documentation.

Can you do the following in this PR?

Create a link to the docs in the readme
Open a PR to add a DomUtils section that explains briefly how we are using background workers and dom manipulation in this extension.

Anush008 · 2023-05-04T14:09:39Z

Right. I'll do that.

## [1.0.0-beta.8](v1.0.0-beta.7...v1.0.0-beta.8) (2023-05-04) ### 🍕 Features * add to highlights button ([#64](#64)) ([e2120a1](e2120a1))

github-actions · 2023-05-04T14:42:57Z

🎉 This PR is included in version 1.0.0-beta.8 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

diivi · 2023-05-04T22:15:32Z

We can create a CONTRIBUTING.md or something similar to explain what goes where to new contributors; the codebase might start to get overwhelming if we keep adding features without proper docs.

Also, need to keep good-first-issues open for new contributors only.

diivi · 2023-05-07T00:19:54Z

@Anush008 let's add feature screenshots for every new feature here - https://docs.opensauced.pizza/chrome-extension/using-the-chrome-extension/

Shouldn't take much time and will help users get a brief overview of what the extension can do.

## 1.0.0 (2023-05-13) ### 📝 Documentation * README and LICENSE ([917f7b0](917f7b0)) * Updated the README.md ([#15](#15)) ([3e4dd69](3e4dd69)) ### 🔁 Continuous Integration * automated github releases ([#39](#39)) ([735fa66](735fa66)), closes [#16](#16) ### 🧑‍💻 Code Refactoring * improved-auth-strategy ([#56](#56)) ([d8b27c3](d8b27c3)) ### 🍕 Features * add home page and profile page ([#36](#36)) ([8a43288](8a43288)) * add to highlights button ([#64](#64)) ([e2120a1](e2120a1)) * Added a configuration file ([#32](#32)) ([ec6722c](ec6722c)) * Added light mode to GH profile buttons ([#40](#40)) ([a7ea43a](a7ea43a)) * Added linting to the project. ([#49](#49)) ([1f73007](1f73007)) * Auto PAT authentication ([#29](#29)) ([f4f8cf6](f4f8cf6)) * extension window navigation ([#21](#21)) ([b5ae9a6](b5ae9a6)) * GitHub page update listener ([#37](#37)) ([06b070f](06b070f)) * Invite to OpenSauced ([#20](#20)) ([0c8f222](0c8f222)) * PAT authentication ([#27](#27)) ([e726a93](e726a93)) * updated the extension logo ([#22](#22)) ([d19034d](d19034d)) * view on OpenSauced button ([#14](#14)) ([a447551](a447551)) * vote repos ([#70](#70)) ([ff2c8f4](ff2c8f4)) ### 🐛 Bug Fixes * rename the. extension ([294e499](294e499)) * Update URLs ([5828e20](5828e20)) * attach dist folder to release assets ([#47](#47)) ([4f50e72](4f50e72)) * circular-deps in vote buttons ([675496c](675496c)) * Duplicate buttons on GH profile page ([#48](#48)) ([9ee2dca](9ee2dca)) * incorrect request for voting ([#72](#72)) ([7a35014](7a35014)) * make emails less creepy ([a08fa45](a08fa45)) * re-enable tailwind base class on extension popup ([#31](#31)) ([c081217](c081217)) * remove activeTab manifest.json ([#50](#50)) ([dd71480](dd71480)) * render emojis in user bio ([#68](#68)) ([d0158a5](d0158a5)) * set-output deprecation warning ([#51](#51)) ([486f84b](486f84b)) * unrecognized-manifest-key ([#55](#55)) ([d622500](d622500)) * Wrapped the await call in an async() ([#26](#26)) ([357aab5](357aab5))

github-actions · 2023-05-13T13:16:29Z

🎉 This PR is included in version 1.0.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

## [1.0.0-beta.8](open-sauced/ai@v1.0.0-beta.7...v1.0.0-beta.8) (2023-05-04) ### 🍕 Features * add to highlights button ([#64](open-sauced/ai#64)) ([e2120a1](open-sauced/ai@e2120a1))

## 1.0.0 (2023-05-13) ### 📝 Documentation * README and LICENSE ([917f7b0](open-sauced/ai@917f7b0)) * Updated the README.md ([#15](open-sauced/ai#15)) ([3e4dd69](open-sauced/ai@3e4dd69)) ### 🔁 Continuous Integration * automated github releases ([#39](open-sauced/ai#39)) ([735fa66](open-sauced/ai@735fa66)), closes [#16](open-sauced/ai#16) ### 🧑‍💻 Code Refactoring * improved-auth-strategy ([#56](open-sauced/ai#56)) ([d8b27c3](open-sauced/ai@d8b27c3)) ### 🍕 Features * add home page and profile page ([#36](open-sauced/ai#36)) ([8a43288](open-sauced/ai@8a43288)) * add to highlights button ([#64](open-sauced/ai#64)) ([e2120a1](open-sauced/ai@e2120a1)) * Added a configuration file ([#32](open-sauced/ai#32)) ([ec6722c](open-sauced/ai@ec6722c)) * Added light mode to GH profile buttons ([#40](open-sauced/ai#40)) ([a7ea43a](open-sauced/ai@a7ea43a)) * Added linting to the project. ([#49](open-sauced/ai#49)) ([1f73007](open-sauced/ai@1f73007)) * Auto PAT authentication ([#29](open-sauced/ai#29)) ([f4f8cf6](open-sauced/ai@f4f8cf6)) * extension window navigation ([#21](open-sauced/ai#21)) ([b5ae9a6](open-sauced/ai@b5ae9a6)) * GitHub page update listener ([#37](open-sauced/ai#37)) ([06b070f](open-sauced/ai@06b070f)) * Invite to OpenSauced ([#20](open-sauced/ai#20)) ([0c8f222](open-sauced/ai@0c8f222)) * PAT authentication ([#27](open-sauced/ai#27)) ([e726a93](open-sauced/ai@e726a93)) * updated the extension logo ([#22](open-sauced/ai#22)) ([d19034d](open-sauced/ai@d19034d)) * view on OpenSauced button ([#14](open-sauced/ai#14)) ([a447551](open-sauced/ai@a447551)) * vote repos ([#70](open-sauced/ai#70)) ([ff2c8f4](open-sauced/ai@ff2c8f4)) ### 🐛 Bug Fixes * rename the. extension ([294e499](open-sauced/ai@294e499)) * Update URLs ([5828e20](open-sauced/ai@5828e20)) * attach dist folder to release assets ([#47](open-sauced/ai#47)) ([4f50e72](open-sauced/ai@4f50e72)) * circular-deps in vote buttons ([675496c](open-sauced/ai@675496c)) * Duplicate buttons on GH profile page ([#48](open-sauced/ai#48)) ([9ee2dca](open-sauced/ai@9ee2dca)) * incorrect request for voting ([#72](open-sauced/ai#72)) ([7a35014](open-sauced/ai@7a35014)) * make emails less creepy ([a08fa45](open-sauced/ai@a08fa45)) * re-enable tailwind base class on extension popup ([#31](open-sauced/ai#31)) ([c081217](open-sauced/ai@c081217)) * remove activeTab manifest.json ([#50](open-sauced/ai#50)) ([dd71480](open-sauced/ai@dd71480)) * render emojis in user bio ([#68](open-sauced/ai#68)) ([d0158a5](open-sauced/ai@d0158a5)) * set-output deprecation warning ([#51](open-sauced/ai#51)) ([486f84b](open-sauced/ai@486f84b)) * unrecognized-manifest-key ([#55](open-sauced/ai#55)) ([d622500](open-sauced/ai@d622500)) * Wrapped the await call in an async() ([#26](open-sauced/ai#26)) ([357aab5](open-sauced/ai@357aab5))

Anush008 added 4 commits May 4, 2023 07:12

feat: add-to-highlights-button

c4b6e9d

feat: improved-dom-update-watcher

51a5a4e

chore: formatting

d561ad8

refactor: replace profileScreen.ts with github.ts

f8e589c

Anush008 requested review from diivi and bdougie May 4, 2023 02:21

Anush008 added 2 commits May 4, 2023 08:52

refactor: parameterize delayInMs for reuse, implicit inference

4133919

chore: 25ms delay for github.ts domupdate

a6f351e

bdougie mentioned this pull request May 4, 2023

Feature: Ability to create highlights using query params open-sauced/app#1143

Closed

2 tasks

docs: Add documentation link README.md

44435f0

bdougie approved these changes May 4, 2023

View reviewed changes

bdougie merged commit e2120a1 into beta May 4, 2023

github-actions bot added the released on @beta label May 4, 2023

Anush008 deleted the feat-add-to-highlights-button branch May 5, 2023 03:38

Anush008 mentioned this pull request May 5, 2023

docs: Added extension-utilities-docs open-sauced/docs#83

Merged

19 tasks

diivi mentioned this pull request May 13, 2023

Feature: Add query params to the /feed endpoint open-sauced/app#1175

Closed

2 tasks

github-actions bot added the released label May 13, 2023

a0m0rajab mentioned this pull request May 21, 2023

Feature: add PR to highlights from the extension #88

Closed

2 tasks

Anush008 mentioned this pull request May 29, 2023

fix: Post a highlight #101

Merged

19 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add to highlights button #64

feat: add to highlights button #64

Anush008 commented May 4, 2023 •

edited

Loading

bdougie commented May 4, 2023

Anush008 commented May 4, 2023

github-actions bot commented May 4, 2023

diivi commented May 4, 2023 •

edited

Loading

diivi commented May 7, 2023

github-actions bot commented May 13, 2023

feat: add to highlights button #64

feat: add to highlights button #64

Conversation

Anush008 commented May 4, 2023 • edited Loading

What type of PR is this? (check all applicable)

Description

Additionally,

Related Tickets & Documents

Mobile & Desktop Screenshots/Recordings

Added tests?

Added to documentation?

bdougie commented May 4, 2023

Anush008 commented May 4, 2023

github-actions bot commented May 4, 2023

diivi commented May 4, 2023 • edited Loading

diivi commented May 7, 2023

github-actions bot commented May 13, 2023

Anush008 commented May 4, 2023 •

edited

Loading

diivi commented May 4, 2023 •

edited

Loading