@slicemachine/manager 0.17.4-dev-next-release.1 → 0.17.4-dev-next-release.2

package/src/managers/project/ProjectManager.ts

@@ -15,6 +15,7 @@ import { DecodeError } from "../../lib/DecodeError";
 import { assertPluginsInitialized } from "../../lib/assertPluginsInitialized";
 import { decodeHookResult } from "../../lib/decodeHookResult";
 import { decodeSliceMachineConfig } from "../../lib/decodeSliceMachineConfig";
+import { findEnvironment } from "../../lib/findEnvironment";
 import { format } from "../../lib/format";
 import { installDependencies } from "../../lib/installDependencies";
 import { locateFileUpward } from "../../lib/locateFileUpward";
@@ -25,13 +26,19 @@ import {
 	OnlyHookErrors,
 } from "../../types";
 
-import { SliceMachineError, InternalError, PluginError } from "../../errors";
+import {
+	SliceMachineError,
+	InternalError,
+	PluginError,
+	UnexpectedDataError,
+} from "../../errors";
 
 import { SLICE_MACHINE_CONFIG_FILENAME } from "../../constants/SLICE_MACHINE_CONFIG_FILENAME";
 import { TS_CONFIG_FILENAME } from "../../constants/TS_CONFIG_FILENAME";
 import { SLICE_MACHINE_NPM_PACKAGE_NAME } from "../../constants/SLICE_MACHINE_NPM_PACKAGE_NAME";
 
 import { BaseManager } from "../BaseManager";
+import { Environment } from "../prismicRepository/types";
 
 type ProjectManagerGetSliceMachineConfigPathArgs = {
 	ignoreCache?: boolean;
@@ -78,10 +85,15 @@ type ProjectManagerUpdateEnvironmentArgs = {
 	environment: string | undefined;
 };
 
+type ProjectManagerFetchActiveEnvironmentReturnType = {
+	activeEnvironment: Environment;
+};
+
 export class ProjectManager extends BaseManager {
 	private _cachedRoot: string | undefined;
 	private _cachedSliceMachineConfigPath: string | undefined;
 	private _cachedSliceMachineConfig: SliceMachineConfig | undefined;
+	private _cachedEnvironments: Environment[] | undefined;
 
 	async getSliceMachineConfigPath(
 		args?: ProjectManagerGetSliceMachineConfigPathArgs,
@@ -427,6 +439,49 @@ export class ProjectManager extends BaseManager {
 		};
 	}
 
+	async fetchActiveEnvironment(): Promise<ProjectManagerFetchActiveEnvironmentReturnType> {
+		const { environment: activeEnvironmentDomain } =
+			await this.readEnvironment();
+
+		// We can assume an environment cannot change its kind. If the
+		// environment exists in the cached list, we are confident it
+		// will not change.
+		const cachedActiveEnvironment = findEnvironment(
+			activeEnvironmentDomain,
+			this._cachedEnvironments || [],
+		);
+		if (cachedActiveEnvironment) {
+			return { activeEnvironment: cachedActiveEnvironment };
+		}
+
+		// If the environment is not in the cached environments list, we
+		// must fetch a fresh list and set the cache.
+		const { environments } = await this.prismicRepository.fetchEnvironments();
+		// TODO: Remove the wrapping if statement when
+		// `this.prismicRepository.fetchEnvironments()` is able to throw
+		// normally. The method returns an object with an `error`
+		// property at the time of this writing, which means we need to
+		// check if the `environments` property exists.
+		if (environments) {
+			this._cachedEnvironments = environments;
+		}
+
+		const activeEnvironment = findEnvironment(
+			activeEnvironmentDomain,
+			this._cachedEnvironments || [],
+		);
+
+		if (!activeEnvironment) {
+			throw new UnexpectedDataError(
+				`The active environment (${
+					activeEnvironmentDomain ?? "Production"
+				}) does not match one of the repository's environments.`,
+			);
+		}
+
+		return { activeEnvironment };
+	}
+
 	private async _assertAdapterSupportsEnvironments(): Promise<void> {
 		assertPluginsInitialized(this.sliceMachinePluginRunner);
 

package/src/managers/telemetry/TelemetryManager.ts

@@ -13,13 +13,16 @@ import {
 	HumanSegmentEventTypes,
 	SegmentEvents,
 } from "./types";
+import { Environment } from "../prismicRepository/types";
 
 type TelemetryManagerInitTelemetryArgs = {
 	appName: string;
 	appVersion: string;
 };
 
-type TelemetryManagerTrackArgs = SegmentEvents;
+type TelemetryManagerTrackArgs = SegmentEvents & {
+	_includeEnvironmentKind?: boolean;
+};
 
 type TelemetryManagerIdentifyArgs = {
 	userID: string;
@@ -97,6 +100,25 @@ export class TelemetryManager extends BaseManager {
 			}
 		}
 
+		let environmentKind: Environment["kind"] | "_unknown" | undefined =
+			undefined;
+		if (args._includeEnvironmentKind) {
+			if (this.project.checkSupportsEnvironments()) {
+				try {
+					const { activeEnvironment } =
+						await this.project.fetchActiveEnvironment();
+					environmentKind = activeEnvironment.kind;
+				} catch {
+					environmentKind = "_unknown";
+				}
+			} else {
+				// Assume only the production environment can be
+				// used if the project's adapter does not
+				// support environments.
+				environmentKind = "prod";
+			}
+		}
+
 		const payload: {
 			event: HumanSegmentEventTypes;
 			userId?: string;
@@ -111,6 +133,7 @@ export class TelemetryManager extends BaseManager {
 			event: HumanSegmentEventType[event],
 			properties: {
 				nodeVersion: process.versions.node,
+				environmentKind,
 				...properties,
 			},
 			context: { ...this._context },

package/dist/_node_modules/r19/dist/lib/isPlainObject.cjs

@@ -1,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const isPlainObject = (value) => {
-  if (typeof value !== "object" || value === null) {
-    return false;
-  }
-  const prototype = Object.getPrototypeOf(value);
-  return (prototype === null || prototype === Object.prototype || Object.getPrototypeOf(prototype) === null) && !(Symbol.toStringTag in value) && !(Symbol.iterator in value);
-};
-exports.isPlainObject = isPlainObject;
-//# sourceMappingURL=isPlainObject.cjs.map

package/dist/_node_modules/r19/dist/lib/isPlainObject.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"isPlainObject.cjs","sources":["../../../../../../../node_modules/r19/dist/lib/isPlainObject.js"],"sourcesContent":["const isPlainObject = (value) => {\n  if (typeof value !== \"object\" || value === null) {\n    return false;\n  }\n  const prototype = Object.getPrototypeOf(value);\n  return (prototype === null || prototype === Object.prototype || Object.getPrototypeOf(prototype) === null) && !(Symbol.toStringTag in value) && !(Symbol.iterator in value);\n};\nexport {\n  isPlainObject\n};\n//# sourceMappingURL=isPlainObject.js.map\n"],"names":[],"mappings":";;AAAK,MAAC,gBAAgB,CAAC,UAAU;AAC/B,MAAI,OAAO,UAAU,YAAY,UAAU,MAAM;AAC/C,WAAO;AAAA,EACR;AACD,QAAM,YAAY,OAAO,eAAe,KAAK;AAC7C,UAAQ,cAAc,QAAQ,cAAc,OAAO,aAAa,OAAO,eAAe,SAAS,MAAM,SAAS,EAAE,OAAO,eAAe,UAAU,EAAE,OAAO,YAAY;AACvK;;","x_google_ignoreList":[0]}

package/dist/_node_modules/r19/dist/lib/isPlainObject.js

@@ -1,11 +0,0 @@
-const isPlainObject = (value) => {
-  if (typeof value !== "object" || value === null) {
-    return false;
-  }
-  const prototype = Object.getPrototypeOf(value);
-  return (prototype === null || prototype === Object.prototype || Object.getPrototypeOf(prototype) === null) && !(Symbol.toStringTag in value) && !(Symbol.iterator in value);
-};
-export {
-  isPlainObject
-};
-//# sourceMappingURL=isPlainObject.js.map

package/dist/_node_modules/r19/dist/lib/isPlainObject.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"isPlainObject.js","sources":["../../../../../../../node_modules/r19/dist/lib/isPlainObject.js"],"sourcesContent":["const isPlainObject = (value) => {\n  if (typeof value !== \"object\" || value === null) {\n    return false;\n  }\n  const prototype = Object.getPrototypeOf(value);\n  return (prototype === null || prototype === Object.prototype || Object.getPrototypeOf(prototype) === null) && !(Symbol.toStringTag in value) && !(Symbol.iterator in value);\n};\nexport {\n  isPlainObject\n};\n//# sourceMappingURL=isPlainObject.js.map\n"],"names":[],"mappings":"AAAK,MAAC,gBAAgB,CAAC,UAAU;AAC/B,MAAI,OAAO,UAAU,YAAY,UAAU,MAAM;AAC/C,WAAO;AAAA,EACR;AACD,QAAM,YAAY,OAAO,eAAe,KAAK;AAC7C,UAAQ,cAAc,QAAQ,cAAc,OAAO,aAAa,OAAO,eAAe,SAAS,MAAM,SAAS,EAAE,OAAO,eAAe,UAAU,EAAE,OAAO,YAAY;AACvK;","x_google_ignoreList":[0]}