@slicemachine/manager 0.15.3-dev-next-release.1 → 0.15.3-dev-next-release.3

package/src/lib/fetchGitHubReleaseBodyForRelease.ts

@@ -45,7 +45,10 @@ const fetchAllGitHubReleases = async (
 
 		return value;
 	} else {
-		throw new Error(`Invalid GitHub Release response.`);
+		const text = await res.text();
+		throw new Error(`Invalid GitHub Release response.`, {
+			cause: text,
+		});
 	}
 };
 

package/src/lib/installDependencies.ts

@@ -45,6 +45,12 @@ export const installDependencies = async (
 	if (!command) {
 		throw new Error(
 			"Failed to begin dependency installation (could not parse command)",
+			{
+				cause: {
+					packageManager: args.packageManager,
+					dependencies: args.dependencies,
+				},
+			},
 		);
 	}
 

package/src/managers/createSliceMachineManagerMiddleware.ts

@@ -40,7 +40,6 @@ const omitProcedures = defineOmits<SliceMachineManager>()([
 	"sliceTemplateLibrary._sliceMachineManager",
 	"getSliceMachinePluginRunner",
 	"getPrismicAuthManager",
-	"screenshots.browserContext",
 ]);
 
 export type SliceMachineManagerMiddleware = RPCMiddleware<

package/src/managers/customTypes/CustomTypesManager.ts

@@ -252,6 +252,9 @@ export class CustomTypesManager extends BaseManager {
 				} else if (error instanceof prismicCustomTypesClient.ForbiddenError) {
 					throw new UnauthorizedError(
 						"You do not have access to push types to this Prismic repository.",
+						{
+							cause: error,
+						},
 					);
 				} else {
 					throw error;

package/src/managers/prismicRepository/PrismicRepositoryManager.ts

@@ -65,9 +65,9 @@ export class PrismicRepositoryManager extends BaseManager {
 	async readAll(): Promise<PrismicRepository[]> {
 		const url = new URL("./repositories", API_ENDPOINTS.PrismicUser);
 		const res = await this._fetch({ url });
-		const json = await res.json();
 
 		if (res.ok) {
+			const json = await res.json();
 			const { value: repositories, error } = decode(
 				t.array(PrismicRepository),
 				json,
@@ -81,7 +81,8 @@ export class PrismicRepositoryManager extends BaseManager {
 
 			return repositories;
 		} else {
-			throw new Error(`Failed to read repositories`, { cause: json });
+			const text = await res.text();
+			throw new Error(`Failed to read repositories`, { cause: text });
 		}
 	}
 
@@ -413,7 +414,9 @@ export class PrismicRepositoryManager extends BaseManager {
 					const text = await response.text();
 					throw new Error(text);
 				default:
-					throw new Error(`Unexpected status code ${response.status}`);
+					throw new Error(`Unexpected status code ${response.status}`, {
+						cause: await response.text(),
+					});
 			}
 		} catch (err) {
 			console.error("An error happened while pushing your changes");

package/src/managers/project/ProjectManager.ts

@@ -173,7 +173,9 @@ export class ProjectManager extends BaseManager {
 
 		if (error) {
 			// TODO: Write a more friendly and useful message.
-			throw new Error(`Invalid config. ${error.errors.join(", ")}`);
+			throw new Error(`Invalid config. ${error.errors.join(", ")}`, {
+				cause: { rawConfig },
+			});
 		}
 
 		// Allow cached config reading using `SliceMachineManager.prototype.getProjectConfig()`.

package/src/managers/screenshots/ScreenshotsManager.ts

@@ -3,7 +3,6 @@ import { fileTypeFromBuffer } from "file-type";
 import pLimit from "p-limit";
 import fetch, { FormData, Blob, Response } from "../../lib/fetch";
 
-import { checkIsURLAccessible } from "../../lib/checkIsURLAccessible";
 import { createContentDigest } from "../../lib/createContentDigest";
 import { decode } from "../../lib/decode";
 
@@ -13,21 +12,6 @@ import { API_ENDPOINTS } from "../../constants/API_ENDPOINTS";
 
 import { BaseManager } from "../BaseManager";
 
-const SLICE_SIMULATOR_WAIT_FOR_SELECTOR = "#__iframe-ready";
-const SLICE_SIMULATOR_WAIT_FOR_SELECTOR_TIMEOUT = 10_000; // ms
-const SLICE_SIMULATOR_SCREENSHOT_SELECTOR = "#__iframe-renderer";
-
-// TODO(DT-1534): Use Puppeteer types if we want reactive Puppeteer screenshots
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-type Viewport = any;
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-type BrowserContext = any;
-
-const DEFAULT_SCREENSHOT_VIEWPORT: Viewport = {
-	width: 1200,
-	height: 800,
-};
-
 function assertS3ACLInitialized(
 	s3ACL: S3ACL | undefined,
 ): asserts s3ACL is NonNullable<typeof s3ACL> {
@@ -38,48 +22,8 @@ function assertS3ACLInitialized(
 	}
 }
 
-function assertBrowserContextInitialized(
-	browserContext: BrowserContext | undefined,
-): asserts browserContext is NonNullable<typeof browserContext> {
-	if (browserContext == undefined) {
-		throw new Error(
-			"A browser context has not been initialized. Run `SliceMachineManager.screenshots.prototype.initBrowserContext()` before re-calling this method.",
-		);
-	}
-}
-
 const uploadScreenshotLimit = pLimit(10);
 
-/**
- * Encodes a part of a Slice Simulator URL to ensure it can be added to a URL
- * safely.
- *
- * The encoding logic must match Slice Machine UI's URL encoding practices.
- * Today, that requires the following:
- *
- * - Replace "/" with "--" (e.g. a Slice Library ID of "./slices" should turn into
- *   ".--slices")
- *
- * @param urlPart - A part of the URL.
- *
- * @returns `urlPart` encoded for use in a URL.
- */
-const encodeSliceSimulatorURLPart = (urlPart: string): string => {
-	return urlPart.replace(/\//g, "--");
-};
-
-type ScreenshotsManagerCaptureSliceSimulatorScreenshotArgs = {
-	sliceMachineUIOrigin: string;
-	libraryID: string;
-	sliceID: string;
-	variationID: string;
-	viewport?: Viewport;
-};
-
-type ScreenshotsManagerCaptureSliceSimulatorScreenshotReturnType = {
-	data: Buffer;
-};
-
 type ScreenshotsManagerUploadScreenshotArgs = {
 	data: Buffer;
 	keyPrefix?: string;
@@ -94,35 +38,8 @@ type ScreenshotsManagerDeleteScreenshotFolderArgs = {
 };
 
 export class ScreenshotsManager extends BaseManager {
-	private _browserContext: BrowserContext | undefined;
 	private _s3ACL: S3ACL | undefined;
 
-	async initBrowserContext(): Promise<void> {
-		// TODO(DT-1534): Uncomment to enable Puppeteer screenshots or delete if we decide to remove Puppeteer
-		//
-		// if (this._browserContext) {
-		// 	return;
-		// }
-		//
-		// let puppeteer: typeof import("puppeteer");
-		// try {
-		// 	// Lazy-load Puppeteer only once it is needed.
-		// 	puppeteer = await import("puppeteer");
-		// } catch {
-		// 	throw new InternalError(
-		// 		"Screenshots require Puppeteer but Puppeteer was not found. Check that the `puppeteer` package is installed before trying again.",
-		// 	);
-		// }
-		// try {
-		// 	const browser = await puppeteer.launch({ headless: "new" });
-		// 	this._browserContext = await browser.createIncognitoBrowserContext();
-		// } catch (error) {
-		// 	throw new InternalError(
-		// 		"Error launching browser. If you're using an Apple Silicon Mac, check if Rosetta is installed.",
-		// 	);
-		// }
-	}
-
 	async initS3ACL(): Promise<void> {
 		// TODO: we need to find a way to create a new AWS ACL only when necessary (e.g., when it has expired).
 		// if (this._s3ACL) {
@@ -140,6 +57,9 @@ export class ScreenshotsManager extends BaseManager {
 			// Response is not JSON
 			throw new Error(
 				`Invalid AWS ACL response from ${awsACLURL}: ${awsACLText}`,
+				{
+					cause: error,
+				},
 			);
 		}
 
@@ -162,12 +82,16 @@ export class ScreenshotsManager extends BaseManager {
 		);
 
 		if (error) {
-			throw new Error(`Invalid AWS ACL response from ${awsACLURL}`);
+			throw new Error(`Invalid AWS ACL response from ${awsACLURL}`, {
+				cause: error,
+			});
 		}
 
 		const errorMessage = awsACL.error || awsACL.message || awsACL.Message;
 		if (errorMessage) {
-			throw new Error(`Failed to create an AWS ACL: ${errorMessage}`);
+			throw new Error(`Failed to create an AWS ACL: ${errorMessage}`, {
+				cause: error,
+			});
 		}
 
 		this._s3ACL = {
@@ -177,86 +101,6 @@ export class ScreenshotsManager extends BaseManager {
 		};
 	}
 
-	// TODO: Abstract to a generic `captureScreenshot()` method that is
-	// used within a Slice-specific method in SliceManager.
-	async captureSliceSimulatorScreenshot(
-		args: ScreenshotsManagerCaptureSliceSimulatorScreenshotArgs,
-	): Promise<ScreenshotsManagerCaptureSliceSimulatorScreenshotReturnType> {
-		assertBrowserContextInitialized(this._browserContext);
-
-		const sliceMachineConfig = await this.project.getSliceMachineConfig();
-
-		if (!sliceMachineConfig.localSliceSimulatorURL) {
-			// TODO: Provide a more helpful error message.
-			throw new Error(
-				"A local Slice Simulator URL must be configured in your Slice Machine configuration file.",
-			);
-		}
-
-		const { model } = await this.slices.readSlice({
-			libraryID: args.libraryID,
-			sliceID: args.sliceID,
-		});
-		if (!model) {
-			throw new Error(
-				`Did not find a Slice in library "${args.libraryID}" with ID "${args.sliceID}".`,
-			);
-		}
-
-		const viewport = args.viewport || DEFAULT_SCREENSHOT_VIEWPORT;
-
-		// TODO: Change `model.name` to `args.sliceID`?
-		// Making that change would require changing the screenshot
-		// page path in Slice Machine UI.
-		const url = new URL(
-			`./${encodeSliceSimulatorURLPart(args.libraryID)}/${model.name}/${
-				args.variationID
-			}/screenshot`,
-			args.sliceMachineUIOrigin,
-		);
-		url.searchParams.set("screenWidth", viewport.width.toString());
-		url.searchParams.set("screenHeight", viewport.height.toString());
-
-		const isURLAccessible = await checkIsURLAccessible(url.toString());
-
-		if (!isURLAccessible) {
-			throw new Error(
-				`Slice Simulator screenshot URL is not accessible: ${url}`,
-			);
-		}
-
-		const page = await this._browserContext.newPage();
-		page.setViewport(viewport);
-
-		await page.goto(url.toString(), { waitUntil: ["load", "networkidle0"] });
-		await page.waitForSelector(SLICE_SIMULATOR_WAIT_FOR_SELECTOR, {
-			timeout: SLICE_SIMULATOR_WAIT_FOR_SELECTOR_TIMEOUT,
-		});
-
-		const element = await page.$(SLICE_SIMULATOR_SCREENSHOT_SELECTOR);
-		if (!element) {
-			const baseURL = new URL(url.pathname, url.origin);
-
-			throw new Error(
-				`Slice Simulator did not find ${SLICE_SIMULATOR_WAIT_FOR_SELECTOR} on the page. Verify the URL is correct: ${baseURL}`,
-			);
-		}
-
-		const data = (await element.screenshot({
-			encoding: "binary",
-			clip: {
-				width: viewport.width,
-				height: viewport.height,
-				x: 0,
-				y: 0,
-			},
-		})) as Buffer;
-
-		return {
-			data,
-		};
-	}
-
 	async uploadScreenshot(
 		args: ScreenshotsManagerUploadScreenshotArgs,
 	): Promise<ScreenshotsManagerUploadScreenshotReturnType> {
@@ -302,8 +146,12 @@ export class ScreenshotsManager extends BaseManager {
 				url: url.toString(),
 			};
 		} else {
+			const text = await res.text();
 			throw new Error(
 				`Unable to upload screenshot with status code: ${res.status}`,
+				{
+					cause: text,
+				},
 			);
 		}
 	}
@@ -319,8 +167,12 @@ export class ScreenshotsManager extends BaseManager {
 			url: new URL("delete-folder", API_ENDPOINTS.AwsAclProvider),
 		});
 		if (!res.ok) {
+			const text = await res.text();
 			throw new Error(
 				`Unable to delete screenshot folder with status code: ${res.status}`,
+				{
+					cause: text,
+				},
 			);
 		}
 	}

package/src/managers/telemetry/types.ts

@@ -206,8 +206,8 @@ type LegacySliceConvertedSegmentEvent = SegmentEvent<
 type ScreenshotTakenSegmentEvent = SegmentEvent<
 	typeof SegmentEventType.screenshotTaken,
 	{
-		type: "custom" | "automatic";
-		method: "fromSimulator" | "upload" | "dragAndDrop";
+		type: "custom";
+		method: "upload" | "dragAndDrop";
 	}
 >;
 

package/dist/lib/checkIsURLAccessible.cjs

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const fetch = require("./fetch.cjs");
-const checkIsURLAccessible = async (url) => {
-  const res = await fetch.default(url);
-  return res.ok;
-};
-exports.checkIsURLAccessible = checkIsURLAccessible;
-//# sourceMappingURL=checkIsURLAccessible.cjs.map

package/dist/lib/checkIsURLAccessible.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"checkIsURLAccessible.cjs","sources":["../../../src/lib/checkIsURLAccessible.ts"],"sourcesContent":["import fetch from \"./fetch\";\n\nexport const checkIsURLAccessible = async (url: string): Promise<boolean> => {\n\tconst res = await fetch(url);\n\n\treturn res.ok;\n};\n"],"names":["fetch"],"mappings":";;;AAEa,MAAA,uBAAuB,OAAO,QAAiC;AACrE,QAAA,MAAM,MAAMA,cAAM,GAAG;AAE3B,SAAO,IAAI;AACZ;;"}

package/dist/lib/checkIsURLAccessible.js

@@ -1,9 +0,0 @@
-import fetch from "./fetch.js";
-const checkIsURLAccessible = async (url) => {
-  const res = await fetch(url);
-  return res.ok;
-};
-export {
-  checkIsURLAccessible
-};
-//# sourceMappingURL=checkIsURLAccessible.js.map

package/dist/lib/checkIsURLAccessible.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"checkIsURLAccessible.js","sources":["../../../src/lib/checkIsURLAccessible.ts"],"sourcesContent":["import fetch from \"./fetch\";\n\nexport const checkIsURLAccessible = async (url: string): Promise<boolean> => {\n\tconst res = await fetch(url);\n\n\treturn res.ok;\n};\n"],"names":[],"mappings":";AAEa,MAAA,uBAAuB,OAAO,QAAiC;AACrE,QAAA,MAAM,MAAM,MAAM,GAAG;AAE3B,SAAO,IAAI;AACZ;"}