Add new Help Scout integration and Beacon functionality #304

evan10s · 2020-08-12T04:45:33Z

Adds support for Help Scout dynamic custom apps as well as Beacons on the frontend

⚠️ I upgraded us to TypeScript 3.9.7. You'll need to upgrade your local version of the package if running registration locally

Dynamic app example:

Once we review this and get it merged, I will cherry-pick it into a new PR for master so this is a mainline registration feature.

Hackgt7 dev

…alidation

…hive yaml

Stephanie-A

Excited!!!

ehsanmasdar

Nice work, Helpscout seems cool! Was scrolling through the code and then figured I'd leave a few comments.

ehsanmasdar · 2020-08-12T15:03:37Z

server/routes/api/helpscout.ts

+}
+
+function createListBlock(title: string, content: string | string[] | Express.Multer.File | null) {
+	return `<li class="c-sb-list-item">


Just happened to be scrolling through - I think this could lead to a XSS if you're not careful about the fields that are being included. You probably want to use some sort of templating library to construct this in a safe way.

Hmmm I will look into this. Help Scout asks you to send them basically the string HTML to display but I'm 99% certain they automatically filter what's displayed. But never hurts to be careful on our end too

This should be fixed now that this uses Handlebars

server/routes/api/helpscout.ts

server/middleware.ts

server/routes/api/helpscout.ts

ehsanmasdar · 2020-08-12T15:12:53Z

server/routes/api/helpscout.ts

+	return `<span class="badge ${type}">${text}</span>`;
+}
+
+async function helpScoutUserInfoHandler(request: express.Request, response: express.Response) {


This is a scary function because if the auth checks pass it can query information about any user. For purposes of monitoring it (and also improving general data privacy posture) I'd consider logging accesses somewhere and having it notify y'all when it is used.

That's a good point. Would it be worthwhile to directly validate the signature in the function vs. middleware to prevent it from accidentally being open to the world? I wonder if we could also restrict it to be called by Help Scout IP addresses 🤔

petschekr

Just some minor things and questions

server/common.ts

server/middleware.ts

server/routes/api/helpscout.ts

server/routes/templates.ts

server/routes/api/helpscout.ts

server/schema.ts

server/routes/api/helpscout.ts

* Added very basic initial functionality * Implemented hmac hash checking (maybe?) * Basic hello world to test signature validation in test deploy * Add Help Scout secret * Add more debugging * Updated to latest version of typescript, fixed Help Scout signature validation * Pushing some more changes to see how they look * Make time zone questions required * Testing some more * Make timezone questions required * Fix punctuation in dates * Lots of Help Scout integration UI element improvements * Finishing touches for Help Scout integration * Help Scout Beacon support improvements * Add info about Help Scout integration/Beacon to README * Apparently you can't define secrets in both deployment.yaml and a Beehive yaml * Remove package script that doesn't work * Upgraded packages, including Handlebars * Re-implemented Help Scout templates using Handlebars * Show selected application/confirmation questions in Help Scout * Cleanup Help Scout API security * Remove extra lines * A few final fixes and tweaks * Make time zone questions required * test file questions help scout view * Fix file helpscout download URL * actually fix help scout file links * Remove some console.logs * minor fixes Co-authored-by: Evan Strat <evan10s@users.noreply.github.com> Co-authored-by: Stephanie A <almeidasmail@gmail.com> Co-authored-by: Evan Strat <evan10s@users.noreply.github.com> Co-authored-by: Stephanie A <almeidasmail@gmail.com>

* Added very basic initial functionality * Implemented hmac hash checking (maybe?) * Basic hello world to test signature validation in test deploy * Add Help Scout secret * Add more debugging * Updated to latest version of typescript, fixed Help Scout signature validation * Pushing some more changes to see how they look * Make time zone questions required * Testing some more * Make timezone questions required * Fix punctuation in dates * Lots of Help Scout integration UI element improvements * Finishing touches for Help Scout integration * Help Scout Beacon support improvements * Add info about Help Scout integration/Beacon to README * Apparently you can't define secrets in both deployment.yaml and a Beehive yaml * Remove package script that doesn't work * Upgraded packages, including Handlebars * Re-implemented Help Scout templates using Handlebars * Show selected application/confirmation questions in Help Scout * Cleanup Help Scout API security * Remove extra lines * A few final fixes and tweaks * Make time zone questions required * test file questions help scout view * Fix file helpscout download URL * actually fix help scout file links * Remove some console.logs * minor fixes Co-authored-by: Evan Strat <evan10s@users.noreply.github.com> Co-authored-by: Stephanie A <almeidasmail@gmail.com> Co-authored-by: Evan Strat <evan10s@users.noreply.github.com> Co-authored-by: Stephanie A <almeidasmail@gmail.com> # Conflicts: # package-lock.json # server/config/questions.json

* Add new Help Scout integration and Beacon functionality (#304) * Added very basic initial functionality * Implemented hmac hash checking (maybe?) * Basic hello world to test signature validation in test deploy * Add Help Scout secret * Add more debugging * Updated to latest version of typescript, fixed Help Scout signature validation * Pushing some more changes to see how they look * Make time zone questions required * Testing some more * Make timezone questions required * Fix punctuation in dates * Lots of Help Scout integration UI element improvements * Finishing touches for Help Scout integration * Help Scout Beacon support improvements * Add info about Help Scout integration/Beacon to README * Apparently you can't define secrets in both deployment.yaml and a Beehive yaml * Remove package script that doesn't work * Upgraded packages, including Handlebars * Re-implemented Help Scout templates using Handlebars * Show selected application/confirmation questions in Help Scout * Cleanup Help Scout API security * Remove extra lines * A few final fixes and tweaks * Make time zone questions required * test file questions help scout view * Fix file helpscout download URL * actually fix help scout file links * Remove some console.logs * minor fixes Co-authored-by: Evan Strat <evan10s@users.noreply.github.com> Co-authored-by: Stephanie A <almeidasmail@gmail.com> * Add staff, partner, and confirmation branches * Fix questions * Add HackGT 7 sponsor acceptance functionality (#311) * Add sponsor branch auto-accept/reject capabilities * Add console.log to verify sponsor email domain/email email allowlist * Add HackGT 7 sponsor allowlist secrets Co-authored-by: Evan Strat <evan10s@users.noreply.github.com> * Fix duplicate branch * Add staff/partner confirmation branches * Add additional branch descriptions for the branch selection page * Fix typo * Fix partner branch name * Clean up some more stuff * Use list of choices for address state question * Clean up sponsor data sharing agreement text * Remove t-shirt question from mentor confirmation * more fixes * Add GM to sponsor list * Fix typo * Allow other on sponsor list Co-authored-by: Evan Strat <evan10s@users.noreply.github.com> Co-authored-by: Stephanie A <almeidasmail@gmail.com>

* Add new Help Scout integration and Beacon functionality (#304) (#308) * Added very basic initial functionality * Implemented hmac hash checking (maybe?) * Basic hello world to test signature validation in test deploy * Add Help Scout secret * Add more debugging * Updated to latest version of typescript, fixed Help Scout signature validation * Pushing some more changes to see how they look * Make time zone questions required * Testing some more * Make timezone questions required * Fix punctuation in dates * Lots of Help Scout integration UI element improvements * Finishing touches for Help Scout integration * Help Scout Beacon support improvements * Add info about Help Scout integration/Beacon to README * Apparently you can't define secrets in both deployment.yaml and a Beehive yaml * Remove package script that doesn't work * Upgraded packages, including Handlebars * Re-implemented Help Scout templates using Handlebars * Show selected application/confirmation questions in Help Scout * Cleanup Help Scout API security * Remove extra lines * A few final fixes and tweaks * Make time zone questions required * test file questions help scout view * Fix file helpscout download URL * actually fix help scout file links * Remove some console.logs * minor fixes Co-authored-by: Evan Strat <evan10s@users.noreply.github.com> Co-authored-by: Stephanie A <almeidasmail@gmail.com> Co-authored-by: Evan Strat <evan10s@users.noreply.github.com> Co-authored-by: Stephanie A <almeidasmail@gmail.com> # Conflicts: # package-lock.json # server/config/questions.json * Fix compile errors * Finishing touches * clarify Co-authored-by: Evan Strat <evan10s@users.noreply.github.com>

* Added very basic initial functionality * Implemented hmac hash checking (maybe?) * Basic hello world to test signature validation in test deploy * Add Help Scout secret * Add more debugging * Updated to latest version of typescript, fixed Help Scout signature validation * Pushing some more changes to see how they look * Make time zone questions required * Testing some more * Make timezone questions required * Fix punctuation in dates * Lots of Help Scout integration UI element improvements * Finishing touches for Help Scout integration * Help Scout Beacon support improvements * Add info about Help Scout integration/Beacon to README * Apparently you can't define secrets in both deployment.yaml and a Beehive yaml * Remove package script that doesn't work * Upgraded packages, including Handlebars * Re-implemented Help Scout templates using Handlebars * Show selected application/confirmation questions in Help Scout * Cleanup Help Scout API security * Remove extra lines * A few final fixes and tweaks * Make time zone questions required * test file questions help scout view * Fix file helpscout download URL * actually fix help scout file links * Remove some console.logs * minor fixes Co-authored-by: Evan Strat <evan10s@users.noreply.github.com> Co-authored-by: Stephanie A <almeidasmail@gmail.com>

* Added very basic initial functionality * Implemented hmac hash checking (maybe?) * Basic hello world to test signature validation in test deploy * Add Help Scout secret * Add more debugging * Updated to latest version of typescript, fixed Help Scout signature validation * Pushing some more changes to see how they look * Make time zone questions required * Testing some more * Make timezone questions required * Fix punctuation in dates * Lots of Help Scout integration UI element improvements * Finishing touches for Help Scout integration * Help Scout Beacon support improvements * Add info about Help Scout integration/Beacon to README * Apparently you can't define secrets in both deployment.yaml and a Beehive yaml * Remove package script that doesn't work * Upgraded packages, including Handlebars * Re-implemented Help Scout templates using Handlebars * Show selected application/confirmation questions in Help Scout * Cleanup Help Scout API security * Remove extra lines * A few final fixes and tweaks * Make time zone questions required * test file questions help scout view * Fix file helpscout download URL * actually fix help scout file links * Remove some console.logs * minor fixes Co-authored-by: Evan Strat <evan10s@users.noreply.github.com> Co-authored-by: Stephanie A <almeidasmail@gmail.com> Co-authored-by: Evan Strat <evan10s@users.noreply.github.com> Co-authored-by: Stephanie A <almeidasmail@gmail.com>

* Add new Help Scout integration and Beacon functionality (#304) * Added very basic initial functionality * Implemented hmac hash checking (maybe?) * Basic hello world to test signature validation in test deploy * Add Help Scout secret * Add more debugging * Updated to latest version of typescript, fixed Help Scout signature validation * Pushing some more changes to see how they look * Make time zone questions required * Testing some more * Make timezone questions required * Fix punctuation in dates * Lots of Help Scout integration UI element improvements * Finishing touches for Help Scout integration * Help Scout Beacon support improvements * Add info about Help Scout integration/Beacon to README * Apparently you can't define secrets in both deployment.yaml and a Beehive yaml * Remove package script that doesn't work * Upgraded packages, including Handlebars * Re-implemented Help Scout templates using Handlebars * Show selected application/confirmation questions in Help Scout * Cleanup Help Scout API security * Remove extra lines * A few final fixes and tweaks * Make time zone questions required * test file questions help scout view * Fix file helpscout download URL * actually fix help scout file links * Remove some console.logs * minor fixes Co-authored-by: Evan Strat <evan10s@users.noreply.github.com> Co-authored-by: Stephanie A <almeidasmail@gmail.com> * Add staff, partner, and confirmation branches * Fix questions * Add HackGT 7 sponsor acceptance functionality (#311) * Add sponsor branch auto-accept/reject capabilities * Add console.log to verify sponsor email domain/email email allowlist * Add HackGT 7 sponsor allowlist secrets Co-authored-by: Evan Strat <evan10s@users.noreply.github.com> * Fix duplicate branch * Add staff/partner confirmation branches * Add additional branch descriptions for the branch selection page * Fix typo * Fix partner branch name * Clean up some more stuff * Use list of choices for address state question * Clean up sponsor data sharing agreement text * Remove t-shirt question from mentor confirmation * more fixes * Add GM to sponsor list * Fix typo * Allow other on sponsor list Co-authored-by: Evan Strat <evan10s@users.noreply.github.com> Co-authored-by: Stephanie A <almeidasmail@gmail.com>

* Add new Help Scout integration and Beacon functionality (#304) (#308) * Added very basic initial functionality * Implemented hmac hash checking (maybe?) * Basic hello world to test signature validation in test deploy * Add Help Scout secret * Add more debugging * Updated to latest version of typescript, fixed Help Scout signature validation * Pushing some more changes to see how they look * Make time zone questions required * Testing some more * Make timezone questions required * Fix punctuation in dates * Lots of Help Scout integration UI element improvements * Finishing touches for Help Scout integration * Help Scout Beacon support improvements * Add info about Help Scout integration/Beacon to README * Apparently you can't define secrets in both deployment.yaml and a Beehive yaml * Remove package script that doesn't work * Upgraded packages, including Handlebars * Re-implemented Help Scout templates using Handlebars * Show selected application/confirmation questions in Help Scout * Cleanup Help Scout API security * Remove extra lines * A few final fixes and tweaks * Make time zone questions required * test file questions help scout view * Fix file helpscout download URL * actually fix help scout file links * Remove some console.logs * minor fixes Co-authored-by: Evan Strat <evan10s@users.noreply.github.com> Co-authored-by: Stephanie A <almeidasmail@gmail.com> Co-authored-by: Evan Strat <evan10s@users.noreply.github.com> Co-authored-by: Stephanie A <almeidasmail@gmail.com> # Conflicts: # package-lock.json # server/config/questions.json * Fix compile errors * Finishing touches * clarify Co-authored-by: Evan Strat <evan10s@users.noreply.github.com>

evan10s and others added 18 commits July 31, 2020 22:22

Added very basic initial functionality

5ae242b

Implemented hmac hash checking (maybe?)

9a62ac7

Basic hello world to test signature validation in test deploy

3fbb772

Add Help Scout secret

88feaa6

Add more debugging

e01dc23

Merge pull request #302 from HackGT/hackgt7-dev

dfe451c

Hackgt7 dev

Updated to latest version of typescript, fixed Help Scout signature v…

d3754f0

…alidation

Pushing some more changes to see how they look

5b9522a

Make time zone questions required

7c10d5f

Testing some more

e03bcfd

Make timezone questions required

c9acd94

Fix punctuation in dates

bca16d8

Lots of Help Scout integration UI element improvements

2aa3828

Finishing touches for Help Scout integration

6b1d5c2

Help Scout Beacon support improvements

1efaa0f

Add info about Help Scout integration/Beacon to README

994fcb6

Apparently you can't define secrets in both deployment.yaml and a Bee…

8b18ecd

…hive yaml

Merge branch 'hackgt7-dev' into evan/hackgt7-hs-app

44597ce

evan10s requested review from Stephanie-A and petschekr August 12, 2020 04:47

hackgt-beekeeper bot temporarily deployed to reg-hs-dev August 12, 2020 04:50 Inactive

Remove package script that doesn't work

06cce98

hackgt-beekeeper bot temporarily deployed to reg-hs-dev August 12, 2020 04:55 Inactive

Stephanie-A approved these changes Aug 12, 2020

View reviewed changes

ehsanmasdar reviewed Aug 12, 2020

View reviewed changes

petschekr reviewed Aug 12, 2020

View reviewed changes

server/common.ts Show resolved Hide resolved

server/middleware.ts Outdated Show resolved Hide resolved

server/routes/api/helpscout.ts Show resolved Hide resolved

server/routes/templates.ts Outdated Show resolved Hide resolved

evan10s added 2 commits September 15, 2020 01:56

Upgraded packages, including Handlebars

2d2b14a

Re-implemented Help Scout templates using Handlebars

76aaa3f

hackgt-beekeeper bot temporarily deployed to reg-hs-dev September 15, 2020 06:01 Inactive

Show selected application/confirmation questions in Help Scout

2bc4596

hackgt-beekeeper bot temporarily deployed to reg-hs-dev September 16, 2020 01:36 Inactive

petschekr reviewed Sep 16, 2020

View reviewed changes

server/routes/templates.ts Show resolved Hide resolved

petschekr reviewed Sep 16, 2020

View reviewed changes

server/routes/api/helpscout.ts Outdated Show resolved Hide resolved

petschekr reviewed Sep 16, 2020

View reviewed changes

server/schema.ts Outdated Show resolved Hide resolved

petschekr reviewed Sep 16, 2020

View reviewed changes

server/routes/api/helpscout.ts Outdated Show resolved Hide resolved

A few final fixes and tweaks

c032251

hackgt-beekeeper bot temporarily deployed to reg-hs-dev September 16, 2020 05:00 Inactive

hackgt-beekeeper bot temporarily deployed to reg-hs-dev September 19, 2020 20:46 Inactive

evan10s and others added 3 commits September 19, 2020 16:59

Make time zone questions required

9b541ff

Merge branch 'hackgt7' into evan/hackgt7-hs-app

7fe0549

test file questions help scout view

ce486e5

hackgt-beekeeper bot temporarily deployed to reg-hs-dev September 19, 2020 21:33 Inactive

Fix file helpscout download URL

b80f635

hackgt-beekeeper bot temporarily deployed to reg-hs-dev September 19, 2020 22:36 Inactive

actually fix help scout file links

567e288

hackgt-beekeeper bot temporarily deployed to reg-hs-dev September 19, 2020 23:35 Inactive

evan10s added 2 commits September 19, 2020 23:15

Remove some console.logs

b395ae0

minor fixes

bdd164b

hackgt-beekeeper bot deployed to reg-hs-dev September 20, 2020 03:18 View deployment

evan10s merged commit 2d06c1b into hackgt7-dev Sep 20, 2020

evan10s deleted the evan/hackgt7-hs-app branch September 20, 2020 03:21

evan10s mentioned this pull request Sep 23, 2020

Mainline Help Scout features #310

Merged

Add new Help Scout integration and Beacon functionality #304

Add new Help Scout integration and Beacon functionality #304

Uh oh!

Conversation

evan10s commented Aug 12, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Stephanie-A left a comment

Choose a reason for hiding this comment

Uh oh!

ehsanmasdar left a comment

Choose a reason for hiding this comment

Uh oh!

ehsanmasdar Aug 12, 2020

Choose a reason for hiding this comment

Uh oh!

evan10s Aug 12, 2020

Choose a reason for hiding this comment

Uh oh!

evan10s Sep 16, 2020

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ehsanmasdar Aug 12, 2020

Choose a reason for hiding this comment

Uh oh!

evan10s Aug 12, 2020

Choose a reason for hiding this comment

Uh oh!

petschekr left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

evan10s commented Aug 12, 2020 •

edited

Loading