@slicemachine/init 2.6.4-dev-upgrade-legacy.2 → 2.7.0

package/src/SliceMachineInitProcess.ts

@@ -41,6 +41,9 @@ import {
 	START_SCRIPT_VALUE,
 } from "./constants";
 import { detectStarterId } from "./lib/starters";
+import { setupSentry } from "./lib/setupSentry";
+import { trackSentryError } from "./lib/sentryErrorHandlers";
+import { updateSentryContext } from "./lib/updateSentryContext";
 
 export type SliceMachineInitProcessOptions = {
 	repository?: string;
@@ -132,6 +135,7 @@ export class SliceMachineInitProcess {
 				appName: pkg.name,
 				appVersion: pkg.version,
 			});
+			await setupSentry();
 			await this.manager.telemetry.track({
 				event: "command:init:start",
 				repository: this.options.repository,
@@ -172,7 +176,7 @@ export class SliceMachineInitProcess {
 				await this.createNewRepository();
 			}
 
-			await this.syncDataWithPrismic();
+			await this.pushDataToPrismic();
 			await this.initializeProject();
 			await this.initializePlugins();
 		} catch (error) {
@@ -299,8 +303,9 @@ export class SliceMachineInitProcess {
 					}
 				}
 			}
-		} catch {
-			// Noop, it's only the final convenience messsage
+		} catch (error) {
+			// Only track this error with Sentry, it's only the final convenience message
+			await this.trackSentryError(error);
 		}
 	}
 
@@ -315,8 +320,6 @@ export class SliceMachineInitProcess {
 				this.manager.customTypes.readCustomTypeLibrary(),
 				this.readDocuments(),
 			]);
-
-			// If repository exists, and there's anything to push
 			if (
 				slices.length > 0 ||
 				ctLibrary.ids.length > 0 ||
@@ -324,11 +327,6 @@ export class SliceMachineInitProcess {
 			) {
 				return true;
 			}
-
-			// If repository exists, and there might be things to pull
-			if (ctLibrary.ids.length === 0) {
-				return true;
-			}
 		} catch (e) {
 			return true;
 		}
@@ -336,13 +334,17 @@ export class SliceMachineInitProcess {
 		return false;
 	}
 
-	protected trackError = (error: unknown): Promise<void> => {
+	protected trackError = async (error: unknown): Promise<void> => {
+		await this.trackSentryError(error);
+		await this.trackTelemetryError(error);
+	};
+
+	protected trackTelemetryError = async (error: unknown): Promise<void> => {
 		// Transform error to string and prevent hitting Segment 500kb API limit or sending ridiculously long trace
 		const safeError = (
 			error instanceof Error ? error.message : `${error}`
 		).slice(0, 512);
-
-		return this.manager.telemetry.track({
+		await this.manager.telemetry.track({
 			event: "command:init:end",
 			framework: this.context.framework?.sliceMachineTelemetryID ?? "unknown",
 			repository: this.context.repository?.domain || "",
@@ -351,6 +353,15 @@ export class SliceMachineInitProcess {
 		});
 	};
 
+	protected trackSentryError = async (error: unknown): Promise<void> => {
+		await updateSentryContext({
+			manager: this.manager,
+			repositoryName: this.context.repository?.domain || "",
+			framework: this.context.framework?.sliceMachineTelemetryID ?? "unknown",
+		});
+		trackSentryError(error);
+	};
+
 	protected async copyStarter(): Promise<void> {
 		const dir = await this.getStarterDirectoryName();
 
@@ -1099,10 +1110,10 @@ ${chalk.cyan("?")} Your Prismic repository name`.replace("\n", ""),
 		return { signature, documents, directoryPath: documentsDirectoryPath };
 	}
 
-	protected syncDataWithPrismic(): Promise<void> {
+	protected pushDataToPrismic(): Promise<void> {
 		return listrRun([
 			{
-				title: "Syncing data with Prismic...",
+				title: "Pushing data to Prismic...",
 				task: (_, parentTask) =>
 					listr([
 						{
@@ -1198,7 +1209,7 @@ ${chalk.cyan("?")} Your Prismic repository name`.replace("\n", ""),
 							task: async (_, task) => {
 								assertExists(
 									this.context.repository,
-									"Repository selection must be available through context to run `syncDataWithPrismic`",
+									"Repository selection must be available through context to run `pushDataToPrismic`",
 								);
 
 								try {
@@ -1208,6 +1219,7 @@ ${chalk.cyan("?")} Your Prismic repository name`.replace("\n", ""),
 										documentsRead === undefined ||
 										documentsRead.documents.length === 0
 									) {
+										parentTask.title = "Pushed data to Prismic";
 										task.skip("No document to push");
 
 										return;
@@ -1249,7 +1261,9 @@ ${chalk.cyan("?")} Your Prismic repository name`.replace("\n", ""),
 									});
 
 									task.title = "Pushed all documents";
+									parentTask.title = "Pushed data to Prismic";
 								} catch {
+									parentTask.title = "Pushed data to Prismic";
 									task.skip("No document to push");
 
 									return;
@@ -1271,41 +1285,7 @@ ${chalk.cyan("?")} Your Prismic repository name`.replace("\n", ""),
 								}
 
 								task.title = "Cleaned up data push artifacts";
-							},
-						},
-						{
-							title: "Pulling existing types...",
-							task: async (_, task) => {
-								const { ids, errors } =
-									await this.manager.customTypes.readCustomTypeLibrary();
-
-								if (errors.length > 0) {
-									// TODO: Provide better error message.
-									throw new Error(
-										`Failed to read custom type libraries: ${errors.join(
-											", ",
-										)}`,
-									);
-								}
-
-								if (ids && ids.length > 0) {
-									task.skip("Types already exists");
-									parentTask.title = "Synced data with Prismic";
-
-									return;
-								}
-
-								const remoteTypes =
-									await this.manager.customTypes.fetchRemoteCustomTypes();
-
-								await Promise.all(
-									remoteTypes.map(async (model) => {
-										await this.manager.customTypes.createCustomType({ model });
-									}),
-								);
-
-								task.title = "Pulled existing types";
-								parentTask.title = "Synced data with Prismic";
+								parentTask.title = "Pushed data to Prismic";
 							},
 						},
 					]),

package/src/constants.ts

@@ -4,3 +4,6 @@ export const START_SCRIPT_VALUE = "start-slicemachine";
 export const GIGET_PROVIDER = "github";
 export const GIGET_ORGANIZATION = "prismicio-community";
 export const SLICE_MACHINE_INIT_USER_AGENT = "slice-machine-init";
+export const SENTRY_EXPRESS_DSN =
+	import.meta.env.VITE_SENTRY_EXPRESS_DSN ||
+	"https://d3e69d5189266d8d7f60f71ccc9353fc@o146123.ingest.sentry.io/4505917981982720";

package/src/lib/checkIsSentryEnabled.ts

@@ -0,0 +1,12 @@
+/**
+ * Checks whether or not Sentry is enabled.
+ *
+ * Sentry is enabled automatically in production but can be disabled by setting
+ * `VITE_ENABLE_SENTRY` to `false`.
+ *
+ * @returns Whether or not Sentry is enabled.
+ */
+export const checkIsSentryEnabled = (): boolean =>
+	import.meta.env.VITE_ENABLE_SENTRY === undefined
+		? import.meta.env.PROD
+		: import.meta.env.VITE_ENABLE_SENTRY === "true";

package/src/lib/sentryErrorHandlers.ts

@@ -0,0 +1,13 @@
+import * as Sentry from "@sentry/node";
+
+import { checkIsSentryEnabled } from "./checkIsSentryEnabled";
+
+export function trackSentryError(error: unknown): void {
+	if (!checkIsSentryEnabled()) {
+		return;
+	}
+
+	Sentry.captureException(error, {
+		...(error instanceof Error ? { extra: { cause: error.cause } } : {}),
+	});
+}

package/src/lib/setupSentry.ts

@@ -0,0 +1,23 @@
+import * as Sentry from "@sentry/node";
+import semver from "semver";
+
+import { SENTRY_EXPRESS_DSN } from "../constants";
+import { checkIsSentryEnabled } from "./checkIsSentryEnabled";
+import { version } from "../../package.json";
+
+export function setupSentry(): void {
+	if (!checkIsSentryEnabled()) {
+		return;
+	}
+
+	const isStableVersion =
+		semver.prerelease(version) === null && semver.lte("0.1.0", version);
+
+	Sentry.init({
+		dsn: SENTRY_EXPRESS_DSN,
+		release: version,
+		environment: isStableVersion
+			? import.meta.env.MODE || "production"
+			: "alpha",
+	});
+}

package/src/lib/updateSentryContext.ts

@@ -0,0 +1,42 @@
+import * as Sentry from "@sentry/node";
+
+import { PrismicUserProfile, SliceMachineManager } from "@slicemachine/manager";
+import { checkIsSentryEnabled } from "./checkIsSentryEnabled";
+
+type UpdateSentryContextArgs = {
+	manager: SliceMachineManager;
+	repositoryName: string;
+	framework: string;
+};
+
+export async function updateSentryContext({
+	manager,
+	repositoryName,
+	framework,
+}: UpdateSentryContextArgs): Promise<void> {
+	if (!checkIsSentryEnabled()) {
+		return;
+	}
+
+	let userProfile: PrismicUserProfile | undefined;
+	try {
+		userProfile = await manager.user.getProfile();
+	} catch {
+		// User is not logged in, it doesn't matter
+	}
+
+	if (userProfile) {
+		Sentry.setUser({ id: userProfile.shortId });
+	}
+
+	if (repositoryName) {
+		Sentry.setTag("repository", repositoryName);
+		Sentry.setContext("Repository Data", {
+			name: repositoryName,
+		});
+	}
+
+	if (framework) {
+		Sentry.setTag("framework", framework);
+	}
+}