feat: OpenSauced AI PR description #79

Anush008 · 2023-05-15T16:20:41Z

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

Description

This PR adds the AI PR description generation feature as suggested in #18. A new page is added to the extension dropdown to configure the description parameters. The text-generation is done using OpenAI's GPT-3.5 with the input context sourced from the code diff and/or the PR commits as configured by the user.
The feature documentation will be added to https://docs.opensauced.pizza.

Related Tickets & Documents

Resolves #18

Mobile & Desktop Screenshots/Recordings

Config window(This PR):

Config window(New OpenSauced generation endpoint, #94):

Generation demo:

Added tests?

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

Added to documentation?

bdougie · 2023-05-15T17:57:34Z

The Spinaroonie is not included :( There'll be a drop-down.

I actually think we should ship with the spinner. We can make it spin when generate description is selected.

Also think we can make this available on all PRs.

I think a maintainer would find this useful for new contributors that don't leave descriptions.

We can leave a note that says:

description generated by OpenSauced

bdougie · 2023-05-15T23:53:38Z

One thing I also noticed is that the icon does not show until you are logged in, but we should show even if you are not logged in, but instead log you in when it is clicked.

Anush008 · 2023-05-16T00:45:16Z

@bdougie Alright. I'll do that.

bdougie · 2023-05-16T01:07:05Z

Sorry last thing. I think we don't need to ask for an OpenAi token and can provide to add to the build or env secrets at build time. The cost for OpenSauced will be negligible and we already spent time removing friction for login. To have OpenAi tokens as more friction, it is not ideal.

~~I will DM you a token to use.~~

Update: I invited you to the OpenSauced org on OpenAI.

Anush008 · 2023-05-16T01:16:52Z

Sorry last thing. I think we don't need to ask for an OpenAi token and can provide to add to the build or env secrets at build time. The cost for OpenSauced will be negligible and we already spent time removing friction for login. To have OpenAi tokens as more friction, it is not ideal.

The users can see the token in the extension's network tab when a completion request is made to v1/chat/completions. If the request will be done with our token, it has to be from the server-side with rate-limits on a per-account basis.

bdougie · 2023-05-16T01:39:55Z

Ok let's keep it as is but make it serverside or Serverless function separately.

I have solutions but we can focus on making the feature work for now.

diivi · 2023-05-16T06:26:36Z

Yup, for what brian said to happen, we need to implement it as an opensauced API endpoint.

bdougie · 2023-05-16T12:41:59Z

I know this is still in draft, but is this testable as of yet? It doesn't seem possible to save a token in the dropdown. Or at least I don't think I can confirm if it is saved.

Anush008 · 2023-05-16T13:17:56Z

I know this is still in draft, but is this testable as of yet? It doesn't seem possible to save a token in the dropdown. Or at least I don't think I can confirm if it is saved.

I am implementing the drop-down form right now to save the config data from the form.

Anush008 · 2023-05-16T19:05:22Z

@bdougie, you can try the generation now. Currently it is implemented on the "Create a pull request page".
Work has to be done in styling, adding the button on "Edit PR" page, adding dropdowns and some fine tunings.

bdougie · 2023-05-16T19:25:02Z

@bdougie, you can try the generation now. Currently it is implemented on the "Create a pull request page". Work has to done in styling, adding the button on "Edit PR" page, adding dropdowns and some fine tunings.

Just tried once and got this message.

bdougie

Can we rename this from "AI PR Description" to "OpenSauced AI." This future proofs other AI features and we don't need to keep the scope to only PRs.

src/pages/aiprdescription.tsx

bdougie

Approving as everything I pointed out has been addressed. @diivi brought up some valid questions and thoughts about console.error and alerts.

We should alert to assist the user journey and use the console for error messages for the developer. Let's address those, so we can merge this.

I would love to get this in @BekahHW's newsletter on Monday and @brandonroberts will assist with adding an endpoint for OpenAI so we can remove that interaction.

Anush008 · 2023-05-18T01:26:57Z

There's an issue I bumped into while adding the button to the "Edit PR" section.
Unlike the "Create new PR" page, the PR page doesn't seem to have the comment editor as a part of the initial HTML when page loads. It is rendered when we click "edit" button.
We'll have to use MutationObserver to listen for changes and then add the button.

bdougie · 2023-05-18T01:32:39Z

Seems like a reasonable solution.

Anush008 · 2023-05-18T01:33:55Z

In case of draft PRs, the
https://api.github.com/repos/owner-name/repo-name/pulls/79 endpoint returns the number of commits instead of an array of commit objects with the commit messages. So, draft PR's can't use commit messages as a source for the description.
https://github.com/open-sauced/browser-extensions/blob/22b243be07ac5e4020efc5e7ba7335a9ff36b0ab/src/utils/fetchGithubAPIData.ts#L25

bdougie · 2023-05-18T01:41:09Z

Could we disable the button with a tooltip on hover that says, "unavailable for draft prs"

I was going to ask if you were going to use the feature to generate your description. That is the real test.

Anush008 · 2023-05-18T01:42:21Z

But the diff is available. The commit messages are not.

bdougie · 2023-05-18T01:55:08Z

But the diff is available. The commit messages are not.

Of we can just go with diff. No need for an explanation. We can just handle it behind the scenes.

## [1.1.0-beta.4](v1.1.0-beta.3...v1.1.0-beta.4) (2023-05-18) ### 🍕 Features * OpenSauced AI PR description ([#79](#79)) ([0e38777](0e38777))

github-actions · 2023-05-18T16:16:06Z

🎉 This PR is included in version 1.1.0-beta.4 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

## [1.1.0](v1.0.0...v1.1.0) (2023-05-20) ### 📝 Documentation * how we create extension releases ([#81](#81)) ([10b1c48](10b1c48)) ### 🐛 Bug Fixes * add extra line and italics ([#93](#93)) ([2cbd790](2cbd790)) * update name in README ([dba4734](dba4734)) ### 🍕 Features * add/remove repos to/from insights. ([#77](#77)) ([8e4a6ed](8e4a6ed)) * OpenSauced AI PR description ([#79](#79)) ([0e38777](0e38777)) * replace open issues count with highlights count ([#76](#76)) ([0fb8149](0fb8149)) * Updated to the new AI PR description endpoint ([#94](#94)) ([cf8f64c](cf8f64c))

github-actions · 2023-05-20T04:51:46Z

🎉 This PR is included in version 1.1.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

## [1.1.0-beta.4](open-sauced/ai@v1.1.0-beta.3...v1.1.0-beta.4) (2023-05-18) ### 🍕 Features * OpenSauced AI PR description ([#79](open-sauced/ai#79)) ([0e38777](open-sauced/ai@0e38777))

## [1.1.0](open-sauced/ai@v1.0.0...v1.1.0) (2023-05-20) ### 📝 Documentation * how we create extension releases ([#81](open-sauced/ai#81)) ([10b1c48](open-sauced/ai@10b1c48)) ### 🐛 Bug Fixes * add extra line and italics ([#93](open-sauced/ai#93)) ([2cbd790](open-sauced/ai@2cbd790)) * update name in README ([dba4734](open-sauced/ai@dba4734)) ### 🍕 Features * add/remove repos to/from insights. ([#77](open-sauced/ai#77)) ([8e4a6ed](open-sauced/ai@8e4a6ed)) * OpenSauced AI PR description ([#79](open-sauced/ai#79)) ([0e38777](open-sauced/ai@0e38777)) * replace open issues count with highlights count ([#76](open-sauced/ai#76)) ([0fb8149](open-sauced/ai@0fb8149)) * Updated to the new AI PR description endpoint ([#94](open-sauced/ai#94)) ([cf8f64c](open-sauced/ai@cf8f64c))

bdougie and others added 9 commits May 9, 2023 14:16

WIP just starting

8a488fa

not sure why it is not appending new element

c883f70

feat: AI highlight button

d55c5e2

Merge branch 'beta' into ai-powered-highlights

0ea64df

feat: cursor position text insert, pr info

dc3fc0f

feat: AI description config window

cdb7139

feat: pr actions dropdown

ce45bb7

chore: Create PR description button

a22d974

feat: OpenAI Completion

2153e19

feat: type response from stream

8e9fe72

Anush008 added 2 commits May 16, 2023 18:15

feat: Config window new values, save button

e1bda0d

chore: Default description config setters

441562b

Anush008 added 4 commits May 16, 2023 23:00

chore: form config submit

6b22c7b

refactor: formatting, linting fixes

75d4827

chore: description config type update, dropdown toggle

a95e801

chore: disable state handle

8ae81ca

bdougie requested changes May 16, 2023

View reviewed changes

Anush008 changed the title ~~feat: AI powered PR description~~ feat: OpenSauced AI May 17, 2023

chore: updated title

9ddcd50

diivi reviewed May 17, 2023

View reviewed changes

src/pages/aiprdescription.tsx Outdated Show resolved Hide resolved

bdougie approved these changes May 17, 2023

View reviewed changes

Anush008 added 3 commits May 17, 2023 20:29

feat: conditional diff, commitmsg fetching

08e709c

feat: Input context length check, redirect when logged out

3de3e44

feat: highlights dropdown collapse

22b243b

Anush008 changed the title ~~feat: OpenSauced AI~~ feat: OpenSauced AI PR description May 17, 2023

bdougie marked this pull request as ready for review May 17, 2023 21:31

bdougie mentioned this pull request May 17, 2023

Feature: AI code refactoring #82

Closed

2 tasks

Anush008 added 2 commits May 18, 2023 19:15

feat: Edit PR button injection, tokenizer length check

be52e9f

feat: Private repository check

02494a5

bdougie mentioned this pull request May 18, 2023

fix: pagination medium screens open-sauced/app#1195

Merged

19 tasks

feat: "Description generated using OpenSauced" append

2e35735

bdougie merged commit 0e38777 into beta May 18, 2023

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

Anush008 deleted the ai-powered-highlights branch May 18, 2023 17:22

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

Anush008 mentioned this pull request May 25, 2023

Bug: Getting PR commit messages is unstable #131

Closed

2 tasks

Anush008 mentioned this pull request Jun 3, 2023

fix: highlight redirection, multiple AI generation, draft commit messages #163

Merged

19 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: OpenSauced AI PR description #79

feat: OpenSauced AI PR description #79

Anush008 commented May 15, 2023 •

edited

Loading

bdougie commented May 15, 2023 •

edited

Loading

bdougie commented May 15, 2023

Anush008 commented May 16, 2023

bdougie commented May 16, 2023 •

edited

Loading

Anush008 commented May 16, 2023

bdougie commented May 16, 2023

diivi commented May 16, 2023

bdougie commented May 16, 2023 •

edited

Loading

Anush008 commented May 16, 2023

Anush008 commented May 16, 2023 •

edited

Loading

bdougie commented May 16, 2023

bdougie left a comment

bdougie left a comment •

edited

Loading

Anush008 commented May 18, 2023

bdougie commented May 18, 2023

Anush008 commented May 18, 2023

bdougie commented May 18, 2023 •

edited

Loading

Anush008 commented May 18, 2023

bdougie commented May 18, 2023

github-actions bot commented May 18, 2023

github-actions bot commented May 20, 2023

feat: OpenSauced AI PR description #79

feat: OpenSauced AI PR description #79

Conversation

Anush008 commented May 15, 2023 • edited Loading

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

Description

Related Tickets & Documents

Mobile & Desktop Screenshots/Recordings

Added tests?

Added to documentation?

bdougie commented May 15, 2023 • edited Loading

bdougie commented May 15, 2023

Anush008 commented May 16, 2023

bdougie commented May 16, 2023 • edited Loading

Anush008 commented May 16, 2023

bdougie commented May 16, 2023

diivi commented May 16, 2023

bdougie commented May 16, 2023 • edited Loading

Anush008 commented May 16, 2023

Anush008 commented May 16, 2023 • edited Loading

bdougie commented May 16, 2023

bdougie left a comment

Choose a reason for hiding this comment

bdougie left a comment • edited Loading

Choose a reason for hiding this comment

Anush008 commented May 18, 2023

bdougie commented May 18, 2023

Anush008 commented May 18, 2023

bdougie commented May 18, 2023 • edited Loading

Anush008 commented May 18, 2023

bdougie commented May 18, 2023

github-actions bot commented May 18, 2023

github-actions bot commented May 20, 2023

Anush008 commented May 15, 2023 •

edited

Loading

bdougie commented May 15, 2023 •

edited

Loading

bdougie commented May 16, 2023 •

edited

Loading

bdougie commented May 16, 2023 •

edited

Loading

Anush008 commented May 16, 2023 •

edited

Loading

bdougie left a comment •

edited

Loading

bdougie commented May 18, 2023 •

edited

Loading