Send project type analytics hit

Author: fvictorio

v-next/hardhat/src/internal/cli/init/init.ts

@@ -24,6 +24,7 @@ import * as semver from "semver";
 import { findClosestHardhatConfig } from "../../config-loading.js";
 import { HARDHAT_NAME } from "../../constants.js";
 import { getHardhatVersion } from "../../utils/package.js";
+import { sendProjectTypeAnalytics } from "../telemetry/analytics/analytics.js";
 
 import {
   getDevDependenciesInstallationCommand,
@@ -96,7 +97,10 @@ export async function initHardhat(options?: InitHardhatOptions): Promise<void> {
 
     // Ask the user for the template to use for the project initialization
     // if it was not provided, and validate that it exists
-    const template = await getTemplate(hardhatVersion, options?.template);
+    const [template, projectTypeAnalyticsPromise] = await getTemplate(
+      hardhatVersion,
+      options?.template,
+    );
 
     // Create the package.json file if it does not exist
     // and validate that it is an esm package
@@ -112,7 +116,11 @@ export async function initHardhat(options?: InitHardhatOptions): Promise<void> {
 
     // Print the commands to install the project dependencies
     // Run them only if the user opts-in to it
-    await installProjectDependencies(workspace, template, options?.install);
+    // Concurrently, await the analytics hit
+    await Promise.all([
+      installProjectDependencies(workspace, template, options?.install),
+      projectTypeAnalyticsPromise,
+    ]);
 
     showStarOnGitHubMessage();
   } catch (e) {
@@ -241,26 +249,34 @@ export async function getWorkspace(workspace?: string): Promise<string> {
  * NOTE: This function is exported for testing purposes
  *
  * @param template The name of the template to use for the project initialization.
- * @returns
+ * @returns A tuple with two elements: the template and a promise with the analytics hit.
  */
 export async function getTemplate(
   hardhatVersion: "hardhat-2" | "hardhat-3",
   template?: string,
-): Promise<Template> {
+): Promise<[Template, Promise<boolean>]> {
   const templates = await getTemplates(hardhatVersion);
 
   // Ask the user for the template to use for the project initialization if it was not provided
   if (template === undefined) {
     template = await promptForTemplate(templates);
   }
 
+  const projectTypeAnalyticsPromise = sendProjectTypeAnalytics(
+    hardhatVersion,
+    template,
+  );
+
   // Validate that the template exists
   for (const t of templates) {
     if (t.name === template) {
-      return t;
+      return [t, projectTypeAnalyticsPromise];
     }
   }
 
+  // we wait for the GA hit before throwing
+  await projectTypeAnalyticsPromise;
+
   throw new HardhatError(HardhatError.ERRORS.CORE.GENERAL.TEMPLATE_NOT_FOUND, {
     template,
   });

v-next/hardhat/test/internal/cli/init/init.ts

@@ -90,7 +90,7 @@ describe("getTemplate", () => {
     );
   });
   it("should return the provided template", async () => {
-    const template = await getTemplate("hardhat-3", "mocha-ethers");
+    const [template] = await getTemplate("hardhat-3", "mocha-ethers");
     assert.equal(template.name, "mocha-ethers");
   });
 });
@@ -284,7 +284,7 @@ describe("copyProjectFiles", () => {
 
   describe("when force is true", () => {
     it("should copy the template files to the workspace and overwrite existing files", async () => {
-      const template = await getTemplate("hardhat-3", "mocha-ethers");
+      const [template] = await getTemplate("hardhat-3", "mocha-ethers");
       // Create template files with "some content" in the workspace
       const workspaceFiles = template.files.map(
         relativeTemplateToWorkspacePath,
@@ -303,7 +303,7 @@ describe("copyProjectFiles", () => {
       }
     });
     it("should copy the .gitignore file correctly", async () => {
-      const template = await getTemplate("hardhat-3", "mocha-ethers");
+      const [template] = await getTemplate("hardhat-3", "mocha-ethers");
       // Copy the template files to the workspace
       await copyProjectFiles(process.cwd(), template, true);
       // Check that the .gitignore exists but gitignore does not
@@ -319,7 +319,7 @@ describe("copyProjectFiles", () => {
   });
   describe("when force is false", () => {
     it("should copy the template files to the workspace and NOT overwrite existing files", async () => {
-      const template = await getTemplate("hardhat-3", "mocha-ethers");
+      const [template] = await getTemplate("hardhat-3", "mocha-ethers");
       // Create template files with "some content" in the workspace
       const workspaceFiles = template.files.map(
         relativeTemplateToWorkspacePath,
@@ -338,7 +338,7 @@ describe("copyProjectFiles", () => {
       }
     });
     it("should copy the .gitignore file correctly", async () => {
-      const template = await getTemplate("hardhat-3", "mocha-ethers");
+      const [template] = await getTemplate("hardhat-3", "mocha-ethers");
       // Copy the template files to the workspace
       await copyProjectFiles(process.cwd(), template, false);
       // Check that the .gitignore exists but gitignore does not
@@ -396,7 +396,7 @@ describe("installProjectDependencies", async () => {
   }
 
   it("should not install any template dependencies if the user opts-out of the installation", async () => {
-    const template = await getTemplate("hardhat-3", "mocha-ethers");
+    const [template] = await getTemplate("hardhat-3", "mocha-ethers");
     await writeUtf8File("package.json", JSON.stringify({ type: "module" }));
     await installProjectDependencies(process.cwd(), template, false, false);
     assert.ok(!(await exists("node_modules")), "node_modules should not exist");
@@ -412,7 +412,7 @@ describe("installProjectDependencies", async () => {
         process.env.GITHUB_HEAD_REF?.startsWith("changeset-release/"),
     },
     async () => {
-      const template = await getTemplate("hardhat-3", "mocha-ethers");
+      const [template] = await getTemplate("hardhat-3", "mocha-ethers");
       await writeUtf8File(
         "package.json",
         JSON.stringify({