freestyle-sandboxes 0.1.40 → 0.1.42

package/index.cjs

@@ -5648,6 +5648,7 @@ function composeCreateVmOptions(arr) {
       result.activityThresholdBytes = options.activityThresholdBytes;
     if (options.discriminator !== void 0)
       result.discriminator = options.discriminator;
+    if (options.skipCache !== void 0) result.skipCache = options.skipCache;
     if (options.persistence !== void 0)
       result.persistence = options.persistence;
     if (options.ports !== void 0) {
@@ -5795,6 +5796,7 @@ function composeCreateVmOptions(arr) {
           aptDeps: newTemplate.aptDeps ?? baseTemplate.aptDeps,
           vcpuCount: newTemplate.vcpuCount !== void 0 ? newTemplate.vcpuCount : baseTemplate.vcpuCount,
           discriminator: newTemplate.discriminator ?? baseTemplate.discriminator,
+          skipCache: newTemplate.skipCache ?? baseTemplate.skipCache,
           workdir: newTemplate.workdir !== void 0 ? newTemplate.workdir : baseTemplate.workdir,
           idleTimeoutSeconds: newTemplate.idleTimeoutSeconds !== void 0 ? newTemplate.idleTimeoutSeconds : baseTemplate.idleTimeoutSeconds,
           waitForReadySignal: newTemplate.waitForReadySignal !== void 0 ? newTemplate.waitForReadySignal : baseTemplate.waitForReadySignal,
@@ -6545,7 +6547,10 @@ class VmSpec {
   }
   ensureSnapshot() {
     if (!isVmSpecLike$1(this.raw.snapshot)) {
-      this.raw.snapshot = this.raw.discriminator !== void 0 ? new VmSpec({ discriminator: this.raw.discriminator }) : new VmSpec();
+      this.raw.snapshot = new VmSpec({
+        discriminator: this.raw.discriminator,
+        skipCache: this.raw.skipCache
+      });
     }
     return this.raw.snapshot;
   }
@@ -6574,6 +6579,9 @@ class VmSpec {
   discriminator(value) {
     return this.mergeRaw({ discriminator: value });
   }
+  skipCache() {
+    return this.mergeRaw({ skipCache: true });
+  }
   workdir(path) {
     return this.mergeRaw({ workdir: path });
   }
@@ -6695,6 +6703,73 @@ function isVmSpecLike$1(value) {
 function isVmTemplateLike$1(value) {
   return !!value && typeof value === "object" && "raw" in value && "with" in value;
 }
+function cloneVmSpecTree(spec) {
+  const clonedRaw = cloneVmSpecRaw$1(spec.raw);
+  return new VmSpec({
+    ...clonedRaw,
+    with: { ...spec.builders },
+    __withDiscriminators: spec.getBuilderDiscriminators()
+  });
+}
+function isVmSpecInstance(value) {
+  return value instanceof VmSpec;
+}
+function isVmTemplateInstance(value) {
+  return value instanceof VmTemplate;
+}
+function cloneVmTemplateTree(template) {
+  const clonedRaw = cloneVmTemplateRaw$1(template.raw);
+  return new VmTemplate({
+    ...clonedRaw,
+    with: { ...template.with }
+  });
+}
+function cloneVmSpecRaw$1(raw) {
+  const cloned = cloneVmTemplateRaw$1(raw);
+  if (isVmSpecInstance(raw.snapshot)) {
+    cloned.snapshot = cloneVmSpecTree(raw.snapshot);
+  } else if (raw.snapshot !== void 0) {
+    cloned.snapshot = cloneVmValue(raw.snapshot);
+  }
+  return cloned;
+}
+function cloneVmTemplateRaw$1(raw) {
+  const cloned = cloneVmPlainObject(raw);
+  if (isVmTemplateInstance(raw.template)) {
+    cloned.template = cloneVmTemplateTree(raw.template);
+  } else if (raw.template !== void 0) {
+    cloned.template = cloneVmValue(raw.template);
+  }
+  return cloned;
+}
+function cloneVmPlainObject(value) {
+  if (!value || typeof value !== "object") {
+    return value;
+  }
+  const cloned = {};
+  for (const [key, entry] of Object.entries(value)) {
+    cloned[key] = cloneVmValue(entry);
+  }
+  return cloned;
+}
+function cloneVmValue(value) {
+  if (value instanceof VmBaseImage) {
+    return new VmBaseImage(value.toRaw());
+  }
+  if (isVmSpecInstance(value)) {
+    return cloneVmSpecTree(value);
+  }
+  if (isVmTemplateInstance(value)) {
+    return cloneVmTemplateTree(value);
+  }
+  if (Array.isArray(value)) {
+    return value.map((entry) => cloneVmValue(entry));
+  }
+  if (value && typeof value === "object") {
+    return cloneVmPlainObject(value);
+  }
+  return value;
+}
 async function convertSpecSnapshotsToTemplates(spec, processBuilders = true) {
   if (!isVmSpecLike$1(spec.raw.snapshot)) {
     return void 0;
@@ -6733,7 +6808,10 @@ async function processOuterSpecBuilders(spec) {
           snapshotSpec = spec.raw.snapshot;
         } else {
           const inheritedDiscriminator = spec.getBuilderDiscriminator(key) ?? spec.raw.discriminator;
-          snapshotSpec = inheritedDiscriminator !== void 0 ? new VmSpec({ discriminator: inheritedDiscriminator }) : new VmSpec({});
+          snapshotSpec = new VmSpec({
+            discriminator: inheritedDiscriminator,
+            skipCache: spec.raw.skipCache
+          });
           spec.raw.snapshot = snapshotSpec;
         }
         spec.raw.snapshot = await builder.configureSnapshotSpec(snapshotSpec);
@@ -6760,7 +6838,10 @@ async function processSpecTree(spec) {
           snapshotSpec = spec.raw.snapshot;
         } else {
           const inheritedDiscriminator = spec.getBuilderDiscriminator(key) ?? spec.raw.discriminator;
-          snapshotSpec = inheritedDiscriminator !== void 0 ? new VmSpec({ discriminator: inheritedDiscriminator }) : new VmSpec({});
+          snapshotSpec = new VmSpec({
+            discriminator: inheritedDiscriminator,
+            skipCache: spec.raw.skipCache
+          });
           spec.raw.snapshot = snapshotSpec;
         }
         spec.raw.snapshot = await builder.configureSnapshotSpec(snapshotSpec);
@@ -6806,7 +6887,17 @@ class VmsNamespace {
   snapshots;
   async create(options = {}) {
     if (isVmSpecLike$1(options)) {
-      options = { spec: options };
+      options = { spec: cloneVmSpecTree(options) };
+    } else {
+      if (isVmSpecLike$1(options.spec)) {
+        options.spec = cloneVmSpecTree(options.spec);
+      }
+      if (isVmSpecLike$1(options.snapshot)) {
+        options.snapshot = cloneVmSpecTree(options.snapshot);
+      }
+      if (isVmTemplateLike$1(options.template)) {
+        options.template = cloneVmTemplateTree(options.template);
+      }
     }
     if (isVmSpecLike$1(options.snapshot)) {
       if (isVmSpecLike$1(options.spec)) {
@@ -6918,6 +7009,12 @@ class VmsNamespace {
       template: _template,
       ...requestConfig
     } = config;
+    let slowPathTimeout;
+    slowPathTimeout = setTimeout(() => {
+      console.log(
+        "VM creation is taking longer than expected. This usually happens when there's a cache miss on your vm's base snapshot. Subsequent vm creations with this configuration will likely be much faster."
+      );
+    }, 5e3);
     const response = await this.freestyle._apiClient.post("/v1/vms", {
       body: {
         ...requestConfig,
@@ -6928,9 +7025,11 @@ class VmsNamespace {
         git: normalizeGitOptions(config.git)
       }
     }).catch((e) => {
+      if (slowPathTimeout) clearTimeout(slowPathTimeout);
       enhanceError(e);
       throw e;
     });
+    if (slowPathTimeout) clearTimeout(slowPathTimeout);
     const vmId = response.id;
     const vm = new Vm({ vmId, freestyle: this.freestyle });
     for (const key in builders) {
@@ -7083,7 +7182,12 @@ class VmSnapshotsNamespace {
     this.apiClient = apiClient;
   }
   async ensure(options) {
-    let requestOptions = options;
+    let requestOptions = {
+      ...options,
+      spec: isVmSpecLike$1(options.spec) ? cloneVmSpecTree(options.spec) : void 0,
+      snapshot: isVmSpecLike$1(options.snapshot) ? cloneVmSpecTree(options.snapshot) : void 0,
+      template: isVmTemplateLike$1(options.template) ? cloneVmTemplateTree(options.template) : options.template
+    };
     if (isVmSpecLike$1(requestOptions.snapshot)) {
       if (isVmSpecLike$1(requestOptions.spec)) {
         if (!requestOptions.spec.raw.snapshot) {
@@ -7129,6 +7233,7 @@ class VmSnapshotsNamespace {
         "snapshots.ensure requires a template or spec to build a snapshot"
       );
     }
+    const startTime = Date.now();
     return this.apiClient.post("/v1/vms/snapshots", {
       body: {
         ...requestOptions,
@@ -7136,6 +7241,14 @@ class VmSnapshotsNamespace {
           isVmTemplateLike$1(requestOptions.template) ? requestOptions.template.raw : requestOptions.template
         )
       }
+    }).then((response) => {
+      const elapsedTime = Date.now() - startTime;
+      if (elapsedTime > 5e3) {
+        console.log(
+          "Snapshot creation took longer than expected (> 5 seconds). This is slower because caches weren't available, but subsequent operations will be much faster."
+        );
+      }
+      return response;
     }).catch((e) => {
       enhanceError(e);
       throw e;

package/index.d.cts

@@ -4467,6 +4467,12 @@ interface PostV1VmsRequestBody {
          * These packages will be installed using `apt-get install` on VM startup.
          */
         aptDeps?: string[] | null;
+        /**
+         * When true, bypasses the snapshot cache and always creates a new snapshot.
+         * The new snapshot still stores the template hash, so it becomes the updated
+         * cache entry for future requests that do not set skipCache.
+         */
+        skipCache?: boolean | null;
     };
     /**
      * @deprecated
@@ -4883,6 +4889,12 @@ interface PostV1VmsSnapshotsRequestBody {
          * These packages will be installed using `apt-get install` on VM startup.
          */
         aptDeps?: string[] | null;
+        /**
+         * When true, bypasses the snapshot cache and always creates a new snapshot.
+         * The new snapshot still stores the template hash, so it becomes the updated
+         * cache entry for future requests that do not set skipCache.
+         */
+        skipCache?: boolean | null;
     };
     persistence?: null | ({
         priority?: number | null;
@@ -11909,6 +11921,12 @@ interface CreateSnapshotRequest {
          * These packages will be installed using `apt-get install` on VM startup.
          */
         aptDeps?: string[] | null;
+        /**
+         * When true, bypasses the snapshot cache and always creates a new snapshot.
+         * The new snapshot still stores the template hash, so it becomes the updated
+         * cache entry for future requests that do not set skipCache.
+         */
+        skipCache?: boolean | null;
     };
     persistence?: null | ({
         priority?: number | null;
@@ -12496,6 +12514,7 @@ declare class VmSpec<T extends Record<string, VmWithLike> = {}> {
     readySignalTimeoutSeconds(value: number): this;
     waitForReadySignal(value: boolean): this;
     discriminator(value: string): this;
+    skipCache(): this;
     workdir(path: string): this;
     aptDeps(...deps: string[]): this;
     users(users: NonNullable<CreateVmOptions["users"]>): this;
@@ -12595,6 +12614,7 @@ type CreateVmOptions = Omit<PostV1VmsRequestBody, "template" | "systemd" | "git"
     };
     git?: null | GitOptions;
     discriminator?: CreateSnapshotRequest["template"]["discriminator"];
+    skipCache?: CreateSnapshotRequest["template"]["skipCache"];
 };
 
 type CronSchedule = {

package/index.d.mts

@@ -4467,6 +4467,12 @@ interface PostV1VmsRequestBody {
          * These packages will be installed using `apt-get install` on VM startup.
          */
         aptDeps?: string[] | null;
+        /**
+         * When true, bypasses the snapshot cache and always creates a new snapshot.
+         * The new snapshot still stores the template hash, so it becomes the updated
+         * cache entry for future requests that do not set skipCache.
+         */
+        skipCache?: boolean | null;
     };
     /**
      * @deprecated
@@ -4883,6 +4889,12 @@ interface PostV1VmsSnapshotsRequestBody {
          * These packages will be installed using `apt-get install` on VM startup.
          */
         aptDeps?: string[] | null;
+        /**
+         * When true, bypasses the snapshot cache and always creates a new snapshot.
+         * The new snapshot still stores the template hash, so it becomes the updated
+         * cache entry for future requests that do not set skipCache.
+         */
+        skipCache?: boolean | null;
     };
     persistence?: null | ({
         priority?: number | null;
@@ -11909,6 +11921,12 @@ interface CreateSnapshotRequest {
          * These packages will be installed using `apt-get install` on VM startup.
          */
         aptDeps?: string[] | null;
+        /**
+         * When true, bypasses the snapshot cache and always creates a new snapshot.
+         * The new snapshot still stores the template hash, so it becomes the updated
+         * cache entry for future requests that do not set skipCache.
+         */
+        skipCache?: boolean | null;
     };
     persistence?: null | ({
         priority?: number | null;
@@ -12496,6 +12514,7 @@ declare class VmSpec<T extends Record<string, VmWithLike> = {}> {
     readySignalTimeoutSeconds(value: number): this;
     waitForReadySignal(value: boolean): this;
     discriminator(value: string): this;
+    skipCache(): this;
     workdir(path: string): this;
     aptDeps(...deps: string[]): this;
     users(users: NonNullable<CreateVmOptions["users"]>): this;
@@ -12595,6 +12614,7 @@ type CreateVmOptions = Omit<PostV1VmsRequestBody, "template" | "systemd" | "git"
     };
     git?: null | GitOptions;
     discriminator?: CreateSnapshotRequest["template"]["discriminator"];
+    skipCache?: CreateSnapshotRequest["template"]["skipCache"];
 };
 
 type CronSchedule = {

package/index.mjs

@@ -5646,6 +5646,7 @@ function composeCreateVmOptions(arr) {
       result.activityThresholdBytes = options.activityThresholdBytes;
     if (options.discriminator !== void 0)
       result.discriminator = options.discriminator;
+    if (options.skipCache !== void 0) result.skipCache = options.skipCache;
     if (options.persistence !== void 0)
       result.persistence = options.persistence;
     if (options.ports !== void 0) {
@@ -5793,6 +5794,7 @@ function composeCreateVmOptions(arr) {
           aptDeps: newTemplate.aptDeps ?? baseTemplate.aptDeps,
           vcpuCount: newTemplate.vcpuCount !== void 0 ? newTemplate.vcpuCount : baseTemplate.vcpuCount,
           discriminator: newTemplate.discriminator ?? baseTemplate.discriminator,
+          skipCache: newTemplate.skipCache ?? baseTemplate.skipCache,
           workdir: newTemplate.workdir !== void 0 ? newTemplate.workdir : baseTemplate.workdir,
           idleTimeoutSeconds: newTemplate.idleTimeoutSeconds !== void 0 ? newTemplate.idleTimeoutSeconds : baseTemplate.idleTimeoutSeconds,
           waitForReadySignal: newTemplate.waitForReadySignal !== void 0 ? newTemplate.waitForReadySignal : baseTemplate.waitForReadySignal,
@@ -6543,7 +6545,10 @@ class VmSpec {
   }
   ensureSnapshot() {
     if (!isVmSpecLike$1(this.raw.snapshot)) {
-      this.raw.snapshot = this.raw.discriminator !== void 0 ? new VmSpec({ discriminator: this.raw.discriminator }) : new VmSpec();
+      this.raw.snapshot = new VmSpec({
+        discriminator: this.raw.discriminator,
+        skipCache: this.raw.skipCache
+      });
     }
     return this.raw.snapshot;
   }
@@ -6572,6 +6577,9 @@ class VmSpec {
   discriminator(value) {
     return this.mergeRaw({ discriminator: value });
   }
+  skipCache() {
+    return this.mergeRaw({ skipCache: true });
+  }
   workdir(path) {
     return this.mergeRaw({ workdir: path });
   }
@@ -6693,6 +6701,73 @@ function isVmSpecLike$1(value) {
 function isVmTemplateLike$1(value) {
   return !!value && typeof value === "object" && "raw" in value && "with" in value;
 }
+function cloneVmSpecTree(spec) {
+  const clonedRaw = cloneVmSpecRaw$1(spec.raw);
+  return new VmSpec({
+    ...clonedRaw,
+    with: { ...spec.builders },
+    __withDiscriminators: spec.getBuilderDiscriminators()
+  });
+}
+function isVmSpecInstance(value) {
+  return value instanceof VmSpec;
+}
+function isVmTemplateInstance(value) {
+  return value instanceof VmTemplate;
+}
+function cloneVmTemplateTree(template) {
+  const clonedRaw = cloneVmTemplateRaw$1(template.raw);
+  return new VmTemplate({
+    ...clonedRaw,
+    with: { ...template.with }
+  });
+}
+function cloneVmSpecRaw$1(raw) {
+  const cloned = cloneVmTemplateRaw$1(raw);
+  if (isVmSpecInstance(raw.snapshot)) {
+    cloned.snapshot = cloneVmSpecTree(raw.snapshot);
+  } else if (raw.snapshot !== void 0) {
+    cloned.snapshot = cloneVmValue(raw.snapshot);
+  }
+  return cloned;
+}
+function cloneVmTemplateRaw$1(raw) {
+  const cloned = cloneVmPlainObject(raw);
+  if (isVmTemplateInstance(raw.template)) {
+    cloned.template = cloneVmTemplateTree(raw.template);
+  } else if (raw.template !== void 0) {
+    cloned.template = cloneVmValue(raw.template);
+  }
+  return cloned;
+}
+function cloneVmPlainObject(value) {
+  if (!value || typeof value !== "object") {
+    return value;
+  }
+  const cloned = {};
+  for (const [key, entry] of Object.entries(value)) {
+    cloned[key] = cloneVmValue(entry);
+  }
+  return cloned;
+}
+function cloneVmValue(value) {
+  if (value instanceof VmBaseImage) {
+    return new VmBaseImage(value.toRaw());
+  }
+  if (isVmSpecInstance(value)) {
+    return cloneVmSpecTree(value);
+  }
+  if (isVmTemplateInstance(value)) {
+    return cloneVmTemplateTree(value);
+  }
+  if (Array.isArray(value)) {
+    return value.map((entry) => cloneVmValue(entry));
+  }
+  if (value && typeof value === "object") {
+    return cloneVmPlainObject(value);
+  }
+  return value;
+}
 async function convertSpecSnapshotsToTemplates(spec, processBuilders = true) {
   if (!isVmSpecLike$1(spec.raw.snapshot)) {
     return void 0;
@@ -6731,7 +6806,10 @@ async function processOuterSpecBuilders(spec) {
           snapshotSpec = spec.raw.snapshot;
         } else {
           const inheritedDiscriminator = spec.getBuilderDiscriminator(key) ?? spec.raw.discriminator;
-          snapshotSpec = inheritedDiscriminator !== void 0 ? new VmSpec({ discriminator: inheritedDiscriminator }) : new VmSpec({});
+          snapshotSpec = new VmSpec({
+            discriminator: inheritedDiscriminator,
+            skipCache: spec.raw.skipCache
+          });
           spec.raw.snapshot = snapshotSpec;
         }
         spec.raw.snapshot = await builder.configureSnapshotSpec(snapshotSpec);
@@ -6758,7 +6836,10 @@ async function processSpecTree(spec) {
           snapshotSpec = spec.raw.snapshot;
         } else {
           const inheritedDiscriminator = spec.getBuilderDiscriminator(key) ?? spec.raw.discriminator;
-          snapshotSpec = inheritedDiscriminator !== void 0 ? new VmSpec({ discriminator: inheritedDiscriminator }) : new VmSpec({});
+          snapshotSpec = new VmSpec({
+            discriminator: inheritedDiscriminator,
+            skipCache: spec.raw.skipCache
+          });
           spec.raw.snapshot = snapshotSpec;
         }
         spec.raw.snapshot = await builder.configureSnapshotSpec(snapshotSpec);
@@ -6804,7 +6885,17 @@ class VmsNamespace {
   snapshots;
   async create(options = {}) {
     if (isVmSpecLike$1(options)) {
-      options = { spec: options };
+      options = { spec: cloneVmSpecTree(options) };
+    } else {
+      if (isVmSpecLike$1(options.spec)) {
+        options.spec = cloneVmSpecTree(options.spec);
+      }
+      if (isVmSpecLike$1(options.snapshot)) {
+        options.snapshot = cloneVmSpecTree(options.snapshot);
+      }
+      if (isVmTemplateLike$1(options.template)) {
+        options.template = cloneVmTemplateTree(options.template);
+      }
     }
     if (isVmSpecLike$1(options.snapshot)) {
       if (isVmSpecLike$1(options.spec)) {
@@ -6916,6 +7007,12 @@ class VmsNamespace {
       template: _template,
       ...requestConfig
     } = config;
+    let slowPathTimeout;
+    slowPathTimeout = setTimeout(() => {
+      console.log(
+        "VM creation is taking longer than expected. This usually happens when there's a cache miss on your vm's base snapshot. Subsequent vm creations with this configuration will likely be much faster."
+      );
+    }, 5e3);
     const response = await this.freestyle._apiClient.post("/v1/vms", {
       body: {
         ...requestConfig,
@@ -6926,9 +7023,11 @@ class VmsNamespace {
         git: normalizeGitOptions(config.git)
       }
     }).catch((e) => {
+      if (slowPathTimeout) clearTimeout(slowPathTimeout);
       enhanceError(e);
       throw e;
     });
+    if (slowPathTimeout) clearTimeout(slowPathTimeout);
     const vmId = response.id;
     const vm = new Vm({ vmId, freestyle: this.freestyle });
     for (const key in builders) {
@@ -7081,7 +7180,12 @@ class VmSnapshotsNamespace {
     this.apiClient = apiClient;
   }
   async ensure(options) {
-    let requestOptions = options;
+    let requestOptions = {
+      ...options,
+      spec: isVmSpecLike$1(options.spec) ? cloneVmSpecTree(options.spec) : void 0,
+      snapshot: isVmSpecLike$1(options.snapshot) ? cloneVmSpecTree(options.snapshot) : void 0,
+      template: isVmTemplateLike$1(options.template) ? cloneVmTemplateTree(options.template) : options.template
+    };
     if (isVmSpecLike$1(requestOptions.snapshot)) {
       if (isVmSpecLike$1(requestOptions.spec)) {
         if (!requestOptions.spec.raw.snapshot) {
@@ -7127,6 +7231,7 @@ class VmSnapshotsNamespace {
         "snapshots.ensure requires a template or spec to build a snapshot"
       );
     }
+    const startTime = Date.now();
     return this.apiClient.post("/v1/vms/snapshots", {
       body: {
         ...requestOptions,
@@ -7134,6 +7239,14 @@ class VmSnapshotsNamespace {
           isVmTemplateLike$1(requestOptions.template) ? requestOptions.template.raw : requestOptions.template
         )
       }
+    }).then((response) => {
+      const elapsedTime = Date.now() - startTime;
+      if (elapsedTime > 5e3) {
+        console.log(
+          "Snapshot creation took longer than expected (> 5 seconds). This is slower because caches weren't available, but subsequent operations will be much faster."
+        );
+      }
+      return response;
     }).catch((e) => {
       enhanceError(e);
       throw e;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "freestyle-sandboxes",
-  "version": "0.1.40",
+  "version": "0.1.42",
   "type": "module",
   "exports": {
     "require": {