docs(gatsby-plugin-guess-js): Document JWT #15969

omonk · 2019-07-22T06:56:35Z

Description

gatsby-plugin-guess-js is able to accept a JWT for authenticating the plugin on deployment services.

The documentation previously didn't have any mention about how to use this on deployment services as locally it requires human interaction to grant permissions.

Related Issues

guess-js/gatsby-guess#19 (comment)
#15582

wardpeet

Thanks, this is valuable! Just added a question & a small change.

wardpeet · 2019-07-22T07:39:35Z

packages/gatsby-plugin-guess-js/README.md

@@ -36,6 +36,8 @@ module.exports = {
      options: {
        // Find the view id in the GA admin in a section labeled "views"
        GAViewID: `VIEW_ID`,
+        // Add JWT token to perform authentication on deployment builds
+        jwt: GA_JWT


Could you explain what GA_JWT holds?

For gatsbyjs.org we're doing the following to make it work:

jwt: { client_email: process.env.ANALYTICS_SERVICE_ACCOUNT, private_key: process.env.ANALYTICS_SERVICE_ACCOUNT_KEY, },

ENV vars look like:

ANALYTICS_SERVICE_ACCOUNT="<name>@<project>.iam.gserviceaccount.com"

ANALYTICS_SERVICE_ACCOUNT_KEY="-----BEGIN PRIVATE KEY-----\nPRIVATE KEY STRING\n-----END PRIVATE KEY-----"

very good point, tried to follow the rabbit hole into Guess webpack and ga packages but haven't been able to work out where this goes yet. I can see that client_email, private_key combo in www/ but it appears to be commented out currently?

We have a bug with guess so that's why :)

wardpeet · 2019-07-22T07:47:51Z

packages/gatsby-plugin-guess-js/README.md

+
+## How to get a JWT token?
+
+[Here](https://2ality.com/2015/10/google-analytics-api.html)


I feel like we should just copy and modify https://2ality.com/2015/10/google-analytics-api.html#unlocking-the-google-analytics-api in the readme and give credits to 2ality url.

Another good point, I would probably be welcome to more suggestions as to how to do this in a simpler way (if possible?).

Maybe attaching something to a gatsby preBuild api to get a fresh JWT. My knowledge on JWT is a little limited but I would assume that this wouldn't be the best way as each JWT is valid until you make it non valid correct?

wardpeet

It seems like there is already a PR open to create some changes to the documentation which opened a week before you #15774. I'll be closing this one.

We absolutely want to have you as a contributor, so please take a look at our open issues for ideas, and please reach out to us on Twitter at @gatsbyjs with questions.

We offer pair programming sessions if you’d like to work with one of our maintainers to make another contribution.

Thanks again, and we look forward to seeing more PRs from you in the future! 💪💜

wardpeet · 2019-07-23T07:59:54Z

packages/gatsby-plugin-guess-js/README.md

@@ -36,6 +36,8 @@ module.exports = {
      options: {
        // Find the view id in the GA admin in a section labeled "views"
        GAViewID: `VIEW_ID`,
+        // Add JWT token to perform authentication on deployment builds
+        jwt: GA_JWT


We have a bug with guess so that's why :)

wardpeet · 2019-07-23T08:05:49Z

My mood changes fast 😂. Let's re-open this one and wait for #15774 to get merged and get some of your updates in as well. So you can get credit for your work! 💪

omonk · 2019-07-23T08:10:27Z

🙈 totally missed that! Very similar to my changes yep. I think it would be really beneficially to add a solution to get the JWT from google in there as well!

wardpeet · 2019-07-23T10:45:31Z

I would copy the first step of https://2ality.com/2015/10/google-analytics-api.html. Add a small paragraph that the token will expire in x time. If you need to update your token automatically please read https://2ality.com/2015/10/google-analytics-api.html

That's how I would suggest it 🤷‍♂

sidharthachatterjee · 2019-08-13T19:15:04Z

@omonk I've made the changes @wardpeet requested but don't have access to push to your fork. Can you please allow me write access to your fork? I'll push the changes and get this merged in ASAP

sidharthachatterjee

Can't push further changes (that @wardpeet recommended) to this branch but I don't want to take away credit for this contribution so I'm merging this in and pushing the changes as a follow up to this!

Thank you so much @omonk 🙌

gatsbot · 2019-08-15T21:47:31Z

Holy buckets, @omonk — we just merged your PR to Gatsby! 💪💜

Gatsby is built by awesome people like you. Let us say “thanks” in two ways:

We’d like to send you some Gatsby swag. As a token of our appreciation, you can go to the Gatsby Swag Store and log in with your GitHub account to get a coupon code good for one free piece of swag. We’ve got Gatsby t-shirts, stickers, hats, scrunchies, and much more. (You can also unlock even more free swag with 5 contributions — wink wink nudge nudge.) See gatsby.dev/swag for details.
We just invited you to join the Gatsby organization on GitHub. This will add you to our team of maintainers. Accept the invite by visiting https://github.com/orgs/gatsbyjs/invitation. By joining the team, you’ll be able to label issues, review pull requests, and merge approved pull requests.

If there’s anything we can do to help, please don’t hesitate to reach out to us: tweet at @gatsbyjs and we’ll come a-runnin’.

Thanks again!

omonk · 2019-08-16T09:28:08Z

@sidharthachatterjee Sorry for my delayed response, have been on holiday!

Thanks very much for merging that!

wardpeet · 2019-08-20T08:51:08Z

I hope you had an awesome vacation! 🌴 Thanks for your work!

update documentation for guess-js plugn

86c34d1

omonk requested a review from a team as a code owner July 22, 2019 06:56

omonk mentioned this pull request Jul 22, 2019

Auth Issue During Build guess-js/gatsby-guess#19

Open

wardpeet reviewed Jul 22, 2019

View reviewed changes

lannonbr changed the title ~~Update documentation for guess-js plugin~~ docs(gatsby-plugin-guess-js): Update documentation for guess-js plugin Jul 22, 2019

lannonbr added the type: documentation An issue or pull request for improving or updating Gatsby's documentation label Jul 22, 2019

wardpeet reviewed Jul 23, 2019

View reviewed changes

wardpeet closed this Jul 23, 2019

wardpeet reopened this Jul 23, 2019

wardpeet added the status: blocked This issue/PR can't be solved at the moment and shouldn't be closed/merged label Jul 23, 2019

wardpeet self-assigned this Jul 23, 2019

wardpeet removed the status: blocked This issue/PR can't be solved at the moment and shouldn't be closed/merged label Jul 23, 2019

Merge branch 'master' into master

0ed23fa

Dahmon mentioned this pull request Jul 24, 2019

Using gatsby-plugin-guess-js with Google Tag Manager #15582

Closed

sidharthachatterjee assigned sidharthachatterjee and unassigned wardpeet Aug 11, 2019

sidharthachatterjee approved these changes Aug 15, 2019

View reviewed changes

sidharthachatterjee changed the title ~~docs(gatsby-plugin-guess-js): Update documentation for guess-js plugin~~ docs(gatsby-plugin-guess-js): Document JWT Aug 15, 2019

sidharthachatterjee merged commit 5dc0b5a into gatsbyjs:master Aug 15, 2019

sidharthachatterjee mentioned this pull request Aug 15, 2019

docs(gatsby-plugin-guess-js): Add note about how to get a JWT #16667

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs(gatsby-plugin-guess-js): Document JWT #15969

docs(gatsby-plugin-guess-js): Document JWT #15969

omonk commented Jul 22, 2019

wardpeet left a comment

wardpeet Jul 22, 2019

omonk Jul 22, 2019

wardpeet Jul 23, 2019

wardpeet Jul 22, 2019

omonk Jul 22, 2019

wardpeet left a comment

wardpeet Jul 23, 2019

wardpeet commented Jul 23, 2019

omonk commented Jul 23, 2019

wardpeet commented Jul 23, 2019

sidharthachatterjee commented Aug 13, 2019

sidharthachatterjee left a comment

gatsbot bot commented Aug 15, 2019

omonk commented Aug 16, 2019

wardpeet commented Aug 20, 2019


		## How to get a JWT token?

		[Here](https://2ality.com/2015/10/google-analytics-api.html)

docs(gatsby-plugin-guess-js): Document JWT #15969

docs(gatsby-plugin-guess-js): Document JWT #15969

Conversation

omonk commented Jul 22, 2019

Description

Related Issues

wardpeet left a comment

Choose a reason for hiding this comment

wardpeet Jul 22, 2019

Choose a reason for hiding this comment

omonk Jul 22, 2019

Choose a reason for hiding this comment

wardpeet Jul 23, 2019

Choose a reason for hiding this comment

wardpeet Jul 22, 2019

Choose a reason for hiding this comment

omonk Jul 22, 2019

Choose a reason for hiding this comment

wardpeet left a comment

Choose a reason for hiding this comment

wardpeet Jul 23, 2019

Choose a reason for hiding this comment

wardpeet commented Jul 23, 2019

omonk commented Jul 23, 2019

wardpeet commented Jul 23, 2019

sidharthachatterjee commented Aug 13, 2019

sidharthachatterjee left a comment

Choose a reason for hiding this comment

gatsbot bot commented Aug 15, 2019

omonk commented Aug 16, 2019

wardpeet commented Aug 20, 2019