(feat): 7 Day Feedback survey (gatsbyjs#27505)

* seven day feedback

* update feedback survey, account for seven day in heuristic, trackCli

* use seven instead of 7

* always save folks

* update survey URL

* update message

* ignore feedback for CI in all cases

* Update packages/gatsby/src/utils/feedback.ts

* ignore CI check for tests

* mock CI check

* missed some mocking

* add typing

* add typing

* add telemetry for current feedback survey

Author: LB

integration-tests/gatsby-cli/__tests__/feedback.js

@@ -3,6 +3,8 @@ import { GatsbyCLI } from "../test-helpers"
 const MAX_TIMEOUT = 2147483647
 jest.setTimeout(MAX_TIMEOUT)
 
+jest.mock('gatsby-core-utils', () => ({ isCI: () => false }))
+
 describe(`gatsby feedback`, () => {
   it(`Prints a note to give feedback`, () => {
     const [status, logs] = GatsbyCLI.from(`gatsby-sites/gatsby-build`).invoke(

packages/gatsby/src/commands/build.ts

@@ -18,8 +18,10 @@ import { flush as flushPendingPageDataWrites } from "../utils/page-data"
 import * as WorkerPool from "../utils/worker/pool"
 import { structureWebpackErrors } from "../utils/webpack-error-utils"
 import {
+  userGetsSevenDayFeedback,
   userPassesFeedbackRequestHeuristic,
   showFeedbackRequest,
+  showSevenDayFeedbackRequest,
 } from "../utils/feedback"
 import * as buildUtils from "./build-utils"
 import { boundActionCreators } from "../redux/actions"
@@ -352,7 +354,9 @@ module.exports = async function build(program: IBuildArgs): Promise<void> {
     report.info(`.cache/deletedPages.txt created`)
   }
 
-  if (await userPassesFeedbackRequestHeuristic()) {
+  if (await userGetsSevenDayFeedback()) {
+    showSevenDayFeedbackRequest()
+  } else if (await userPassesFeedbackRequestHeuristic()) {
     showFeedbackRequest()
   }
 }

packages/gatsby/src/commands/clean.ts

@@ -3,8 +3,10 @@ import path from "path"
 import findCacheDir from "find-cache-dir"
 
 import {
+  userGetsSevenDayFeedback,
   userPassesFeedbackRequestHeuristic,
   showFeedbackRequest,
+  showSevenDayFeedbackRequest,
 } from "../utils/feedback"
 import { IProgram } from "./types"
 
@@ -31,7 +33,9 @@ module.exports = async function clean(program: IProgram): Promise<void> {
 
   report.info(`Successfully deleted directories`)
 
-  if (await userPassesFeedbackRequestHeuristic()) {
+  if (await userGetsSevenDayFeedback()) {
+    showSevenDayFeedbackRequest()
+  } else if (await userPassesFeedbackRequestHeuristic()) {
     showFeedbackRequest()
   }
 }

packages/gatsby/src/commands/develop-process.ts

@@ -8,8 +8,10 @@ import { initTracer } from "../utils/tracer"
 import { detectPortInUseAndPrompt } from "../utils/detect-port-in-use-and-prompt"
 import onExit from "signal-exit"
 import {
+  userGetsSevenDayFeedback,
   userPassesFeedbackRequestHeuristic,
   showFeedbackRequest,
+  showSevenDayFeedbackRequest,
 } from "../utils/feedback"
 import { markWebpackStatusAsPending } from "../utils/webpack-status"
 import { store } from "../redux"
@@ -86,7 +88,9 @@ module.exports = async (program: IDevelopArgs): Promise<void> => {
   process.on(
     `SIGINT`,
     async (): Promise<void> => {
-      if (await userPassesFeedbackRequestHeuristic()) {
+      if (await userGetsSevenDayFeedback()) {
+        showSevenDayFeedbackRequest()
+      } else if (await userPassesFeedbackRequestHeuristic()) {
         showFeedbackRequest()
       }
       process.exit(0)

packages/gatsby/src/utils/__tests__/feedback.ts

@@ -13,6 +13,7 @@ jest.mock(`gatsby-core-utils`, () => {
   return {
     ...jest.requireActual(`gatsby-core-utils`),
     getGatsbyVersion: jest.fn(() => `2.1.1`),
+    isCI: (): boolean => false,
   }
 })
 

packages/gatsby/src/utils/feedback.ts

@@ -1,10 +1,13 @@
 import report from "gatsby-cli/lib/reporter"
-import { getConfigStore, getGatsbyVersion } from "gatsby-core-utils"
+import { getConfigStore, getGatsbyVersion, isCI } from "gatsby-core-utils"
+import { trackCli } from "gatsby-telemetry"
 import latestVersion from "latest-version"
 import getDayOfYear from "date-fns/getDayOfYear"
 
 const feedbackKey = `feedback.disabled`
 const lastDateKey = `feedback.lastRequestDate`
+const firstDateKey = `feedback.firstCheckDate`
+const sevenDayKey = `feedback.sevenDayFeedbackDate`
 
 // This function is designed to be used by `gatsby feedback --disable`
 // and `gatsby feedback --enable`. This key is used to determine
@@ -16,12 +19,28 @@ export function setFeedbackDisabledValue(enabled: boolean): void {
 // Print the feedback request to the user
 export function showFeedbackRequest(): void {
   getConfigStore().set(lastDateKey, Date.now())
+  trackCli(`SHOW_FEEDBACK_LINK`, {
+    name: `https://gatsby.dev/feedback`,
+  })
   report.log(
     `\n\nHello! Will you help Gatsby improve by taking a four question survey?\nIt takes less than five minutes and your ideas and feedback will be very helpful.`
   )
   report.log(`\nGive us your feedback here: https://gatsby.dev/feedback\n\n`)
 }
 
+export function showSevenDayFeedbackRequest(): void {
+  getConfigStore().set(sevenDayKey, Date.now())
+  trackCli(`SHOW_SEVEN_DAY_FEEDBACK_LINK`, {
+    name: `https://gatsby.dev/feedback-survey`,
+  })
+  report.log(
+    `\n\nHi there! Will you tell us about how you're learning Gatsby? \nIt takes less than 5 minutes and your feedback will help us make installing and using Gatsby so much better.`
+  )
+  report.log(
+    `\nGive us your feedback here: https://gatsby.dev/feedback-survey\n\n`
+  )
+}
+
 const randomChanceToBeTrue = (): boolean => {
   // This is spreading the request volume over the quarter.
   // We are grabbing a randomNumber within the spread of a first day
@@ -59,13 +78,7 @@ export async function userPassesFeedbackRequestHeuristic(): Promise<boolean> {
     return false
   }
 
-  // Heuristic 2
-  if (getConfigStore().get(feedbackKey) === true) {
-    return false
-  }
-
-  // Heuristic 3
-  if (process.env.GATSBY_FEEDBACK_DISABLED === `1`) {
+  if (isFeedbackDisabled()) {
     return false
   }
 
@@ -84,6 +97,18 @@ export async function userPassesFeedbackRequestHeuristic(): Promise<boolean> {
     }
   }
 
+  // we don't want to give them this survey right after the seven day feedback survey
+  const sevenDayFeedback = getConfigStore().get(sevenDayKey)
+  if (sevenDayFeedback) {
+    const sevenDayDate = new Date(sevenDayFeedback)
+    const threeMonthsAgo = new Date()
+    threeMonthsAgo.setMonth(threeMonthsAgo.getMonth() - 3)
+
+    if (sevenDayDate > threeMonthsAgo) {
+      return false
+    }
+  }
+
   // Heuristic 5
   const versionPoints = getGatsbyVersion().split(`.`)
   let latestVersionPoints: Array<string> = []
@@ -111,3 +136,43 @@ export async function userPassesFeedbackRequestHeuristic(): Promise<boolean> {
   // for feedback
   return true
 }
+
+function isFeedbackDisabled(): boolean {
+  // Heuristic 2
+  if (getConfigStore().get(feedbackKey) === true) {
+    return true
+  }
+
+  // Heuristic 3
+  if (process.env.GATSBY_FEEDBACK_DISABLED === `1`) {
+    return true
+  }
+
+  if (isCI()) {
+    return true
+  }
+
+  return false
+}
+
+export async function userGetsSevenDayFeedback(): Promise<boolean> {
+  if (isFeedbackDisabled()) return false
+
+  if (getConfigStore().get(sevenDayKey)) return false
+
+  const firstDateValue = getConfigStore().get(firstDateKey)
+
+  if (!firstDateValue) {
+    getConfigStore().set(firstDateKey, Date.now()) // set this for the first time
+    return false
+  } else {
+    const lastDate = new Date(firstDateValue)
+    const sevenDaysAgo = new Date()
+    sevenDaysAgo.setDate(sevenDaysAgo.getDate() - 7)
+
+    if (lastDate > sevenDaysAgo) {
+      return false
+    }
+  }
+  return true
+}