feat: Use StarSearchPayload from API #3424

jpmcb · 2024-05-18T23:03:17Z

Description

This is a followup to https://github.com/open-sauced/api/pull/818 which introduces a well defined, strongly typed object for sending in the StarSearch data: stream. This should make parsing the incoming content much, much easier. This method is heavily inspired by ChatGPT and the data object they send back in their stream.

This also introduces the remark github style markdown plugin. I'm not sure if it's making a difference, but maybe worth playing around with.

Related Tickets & Documents

Followup to: https://github.com/open-sauced/api/pull/818

⚠️ The deploy preview will not work until the API changes ^go in.

Mobile & Desktop Screenshots/Recordings

Overall, this seems to fix alot of the messy line breaking that was going on:

Steps to QA

Run the API locally (or wait for API changes to go in).
Run app locally, check the /star-search route

Tier (staff will fill in)

Tier 1
Tier 2
Tier 3
Tier 4

netlify · 2024-05-18T23:03:36Z

✅ Deploy Preview for design-insights ready!

Name	Link
🔨 Latest commit	`0c76073`
🔍 Latest deploy log	https://app.netlify.com/sites/design-insights/deploys/664cb809b7f9fd0008c70f20
😎 Deploy Preview	https://deploy-preview-3424--design-insights.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

netlify · 2024-05-18T23:03:37Z

✅ Deploy Preview for oss-insights ready!

Name	Link
🔨 Latest commit	`0c76073`
🔍 Latest deploy log	https://app.netlify.com/sites/oss-insights/deploys/664cb8096ea5bd00074b28d8
😎 Deploy Preview	https://deploy-preview-3424--oss-insights.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

zeucapua

Looks good! Just needs a fix on the text break.

pages/star-search/index.tsx

zeucapua · 2024-05-20T19:41:45Z

The list markdown isn't rendering correctly:

API response

Rendered Response

jpmcb · 2024-05-20T19:46:05Z

Force pushed to set the markdown class as break-word which should now wrap only on long words instead of break-all which was wrapping all words: #3420

jpmcb · 2024-05-20T19:46:52Z

The list markdown isn't rendering correctly:

Yeah, I was hoping the github flavored markdown plugin would fix this :( but it's till messed up. Any ideas?

pages/star-search/index.tsx

jpmcb · 2024-05-20T20:54:14Z

prose seemed to be the silver bullet we needed to get these to render nicely - huge shoutout to @zeucapua for discovering that!!! 👏🏼

Also added some additional comments and a check that result.content.parts has some actual stuff.

jpmcb · 2024-05-20T21:01:12Z

pages/star-search/index.tsx

           */

-          const matched = v.match(/data:\s?(?<result>.*)/);
+          const matched = v.match(/data:\s(?<result>.*)/);


I made the regex just abit more strict: now, there has to be a space between data: and the json object flowing in. We can always expect the same result now from the API: the data key, a :, a space , and then the json object. So, for example, data: { id: "abc123" } will get captured. But data: or data:{ ... } will be rejected.

always one space or can it be \s+? I'd assume just \s since the API is handling the formatting?

Yes, correct, the payload from the API should always be data: { ... } with one space and we should reject anything that is malformed. It's probably a moot point to make the regex more strict, but it at least makes the client have to do alot less heavy lifting since the API is doing it now

pages/star-search/index.tsx

brandonroberts

Nice work! 🤝

jpmcb · 2024-05-21T14:30:12Z

Looking good with the chat bubbles!! cc @nickytonline

would love to get this in a release today so we can play around with everything before thursday!

nickytonline

Nothing blocking, just some comments. Great work @jpmcb!

🚢

pages/star-search/index.tsx

next-types.d.ts

nickytonline · 2024-05-21T14:55:54Z

pages/star-search/index.tsx

           */

-          const matched = v.match(/data:\s?(?<result>.*)/);
+          const matched = v.match(/data:\s(?<result>.*)/);


always one space or can it be \s+? I'd assume just \s since the API is handling the formatting?

Makes the Markdown class use "break-word" and "prose" classes for styling Co-authored-by: John McBride <john@opensauced.pizza> Co-authored-by: Zeu Capua <zeu@opensauced.pizza> Signed-off-by: John McBride <john@opensauced.pizza>

jpmcb · 2024-05-21T15:05:19Z

pages/star-search/index.tsx

+            if (!payload || !payload.content || payload.content.parts.length === 0) {
+              Sentry.captureException(
+                new Error(`Parsed and rejected malformed JSON for StarSearch. JSON payload: ${v}`)
+              );


Sends Sentry an error if we get some weird malformed JSON for some reason.

nickytonline · 2024-05-21T15:41:33Z

Looking good with the chat bubbles!! cc @nickytonline

would love to get this in a release today so we can play around with everything before thursday!

Not sure why you're loader is blue. 🤔 Here it is on beta.

nickytonline · 2024-05-21T15:43:07Z

deploy-preview-3424--oss-insights.netlify.app

Not sure what's going on your local, but on your deploy preview the loader animation is orange. 🙃

## [2.30.0-beta.2](v2.30.0-beta.1...v2.30.0-beta.2) (2024-05-21) ### 🍕 Features * Use StarSearchPayload from API ([#3424](#3424)) ([a8b01f7](a8b01f7))

## [2.30.0](v2.29.0...v2.30.0) (2024-05-21) ### 🍕 Features * add workspaces intro video to welcome modal ([#3432](#3432)) ([d4bce9a](d4bce9a)) * added a loader for StarSearch responses ([#3422](#3422)) ([8972760](8972760)) * open up access to StarSearch and show modal/drawer for login ([#3442](#3442)) ([d228949](d228949)) * Small update to copy for suggested starsearch queries ([#3438](#3438)) ([012db59](012db59)) * update to lunch week card ([#3439](#3439)) ([d41f8fa](d41f8fa)) * Use StarSearchPayload from API ([#3424](#3424)) ([a8b01f7](a8b01f7)) ### 🐛 Bug Fixes * add mobile drawer for `InsightUpgradeModal` ([#3429](#3429)) ([d081980](d081980)) * add support for clipboard copy in Safari and use utility function ([#3433](#3433)) ([2d1b74f](2d1b74f)) * disable search for workspace dropdown if not logged in ([#3414](#3414)) ([b242e92](b242e92)) * fix to avoid StarSearch UI breaking when long words are outputted ([#3420](#3420)) ([4d6bb23](4d6bb23)) * fixed rendering of lottery chart when less than 4 contributors ([#3415](#3415)) ([3888ecb](3888ecb)) * fixed scrolling issues with StarSearch ([#3444](#3444)) ([2c46494](2c46494)) * history chart using correct data for `StarsChart` ([#3443](#3443)) ([f85f1fd](f85f1fd)) * now sauced-orange colour defaults to 1 for opacity ([#3437](#3437)) ([aa9f67f](aa9f67f)) * remove reactions from issues table ([#3435](#3435)) ([e15c6b6](e15c6b6)) * swap out css module prompt with lottery factor ([#3413](#3413)) ([2c9def0](2c9def0)) * updated StarSearch copy ([#3440](#3440)) ([abe33f1](abe33f1))

jpmcb requested a review from a team May 18, 2024 23:03

zeucapua requested changes May 20, 2024

View reviewed changes

pages/star-search/index.tsx Outdated Show resolved Hide resolved

jpmcb force-pushed the use-starsearch-payload branch from 9f6a5d7 to 87a1062 Compare May 20, 2024 19:44

zeucapua requested changes May 20, 2024

View reviewed changes

pages/star-search/index.tsx Outdated Show resolved Hide resolved

brandonroberts reviewed May 20, 2024

View reviewed changes

pages/star-search/index.tsx Show resolved Hide resolved

jpmcb force-pushed the use-starsearch-payload branch 2 times, most recently from f66ba64 to 672c4a5 Compare May 20, 2024 20:52

jpmcb requested review from a team, brandonroberts and zeucapua May 20, 2024 20:52

jpmcb commented May 20, 2024

View reviewed changes

pages/star-search/index.tsx Outdated Show resolved Hide resolved

jpmcb force-pushed the use-starsearch-payload branch 3 times, most recently from 91d545e to e055e39 Compare May 20, 2024 21:19

brandonroberts approved these changes May 20, 2024

View reviewed changes

nickytonline mentioned this pull request May 21, 2024

feat: added a loader for StarSearch responses #3422

Merged

4 tasks

jpmcb force-pushed the use-starsearch-payload branch from e055e39 to 2a5f6ee Compare May 21, 2024 14:28

nickytonline approved these changes May 21, 2024

View reviewed changes

feat: Use StarSearchPayload from API

0c76073

Makes the Markdown class use "break-word" and "prose" classes for styling Co-authored-by: John McBride <john@opensauced.pizza> Co-authored-by: Zeu Capua <zeu@opensauced.pizza> Signed-off-by: John McBride <john@opensauced.pizza>

jpmcb force-pushed the use-starsearch-payload branch from 2a5f6ee to 0c76073 Compare May 21, 2024 15:04

jpmcb commented May 21, 2024

View reviewed changes

jpmcb merged commit a8b01f7 into beta May 21, 2024
13 checks passed

jpmcb deleted the use-starsearch-payload branch May 21, 2024 15:52

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Use StarSearchPayload from API #3424

feat: Use StarSearchPayload from API #3424

jpmcb commented May 18, 2024

netlify bot commented May 18, 2024 •

edited

netlify bot commented May 18, 2024 •

edited

zeucapua left a comment

zeucapua commented May 20, 2024

jpmcb commented May 20, 2024

jpmcb commented May 20, 2024

jpmcb commented May 20, 2024

jpmcb May 20, 2024

nickytonline May 21, 2024

jpmcb May 21, 2024

brandonroberts left a comment

jpmcb commented May 21, 2024

nickytonline left a comment

nickytonline May 21, 2024

jpmcb May 21, 2024

nickytonline commented May 21, 2024

nickytonline commented May 21, 2024

feat: Use StarSearchPayload from API #3424

feat: Use StarSearchPayload from API #3424

Conversation

jpmcb commented May 18, 2024

Description

Related Tickets & Documents

Mobile & Desktop Screenshots/Recordings

Steps to QA

Tier (staff will fill in)

netlify bot commented May 18, 2024 • edited

✅ Deploy Preview for design-insights ready!

netlify bot commented May 18, 2024 • edited

✅ Deploy Preview for oss-insights ready!

zeucapua left a comment

Choose a reason for hiding this comment

zeucapua commented May 20, 2024

jpmcb commented May 20, 2024

jpmcb commented May 20, 2024

jpmcb commented May 20, 2024

jpmcb May 20, 2024

Choose a reason for hiding this comment

nickytonline May 21, 2024

Choose a reason for hiding this comment

jpmcb May 21, 2024

Choose a reason for hiding this comment

brandonroberts left a comment

Choose a reason for hiding this comment

jpmcb commented May 21, 2024

nickytonline left a comment

Choose a reason for hiding this comment

nickytonline May 21, 2024

Choose a reason for hiding this comment

jpmcb May 21, 2024

Choose a reason for hiding this comment

nickytonline commented May 21, 2024

nickytonline commented May 21, 2024

netlify bot commented May 18, 2024 •

edited

netlify bot commented May 18, 2024 •

edited