@needle-tools/gltf-build-pipeline 1.0.4 → 1.0.6

package/CHANGELOG.md

@@ -4,6 +4,12 @@ All notable changes to this package will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [1.0.6] - 2023-05-06
+- fix: dont add textures to cache when toktx is not installed
+
+## [1.0.5] - 2023-05-06
+- fix: catch exception in cases where toktx is not installed (e.g. in CI environment) and log warning instead
+
 ## [1.0.4] - 2023-04-24
 - fix: error caused by missing simplifier
 

package/dist/functions/gzip.d.ts

@@ -0,0 +1 @@
+export declare function gzipFile(filepath: string): Promise<string>;

package/dist/functions/gzip.js

@@ -0,0 +1,16 @@
+import { promises as fs, existsSync } from 'fs';
+import { gzip } from 'node-gzip';
+export async function gzipFile(filepath) {
+    if (filepath.endsWith('.gz')) {
+        return filepath;
+    }
+    if (!existsSync(filepath)) {
+        console.log("File not found: " + filepath);
+        return filepath;
+    }
+    const inBuffer = await fs.readFile(filepath);
+    const outBuffer = await gzip(inBuffer);
+    const outPath = filepath;
+    await fs.writeFile(outPath, outBuffer);
+    return outPath;
+}

package/dist/functions/index.d.ts

@@ -0,0 +1 @@
+export * from "./gzip.js";

package/dist/functions/index.js

@@ -0,0 +1 @@
+export * from "./gzip.js";

package/dist/transforms/needle_common.d.ts

@@ -6,7 +6,7 @@ export interface NeedleTransformContext {
     noToktx: boolean;
 }
 export interface INeedleTextureTransformContext {
-    prepare(document: Document): Promise<void>;
+    prepare(document: Document): Promise<void | boolean>;
     process(index: number, texture: Texture, settings: NEEDLE_compression_texture_schema): Promise<boolean>;
     finalize(document: Document): Promise<void>;
 }

package/dist/transforms/needle_texture_transform.js

@@ -131,8 +131,8 @@ async function processTexture(texture, index, document, logger, context) {
         if (canRunToktx) {
             // if no specific compression settings are provided we just use the toktx default settings
             // if we ever change what is used for default compression we need to teach the cache to save the mime type
-            await context.toktxContext.process(index, texture, null);
-            successFullyProcessed = true;
+            successFullyProcessed = await context.toktxContext.process(index, texture, null);
+            // don't add textures to the cache when toktx doesnt run
         }
         else {
             console.log("toktx is disallowed. Skipping texture compression.");

package/dist/transforms/needle_toktx.d.ts

@@ -19,7 +19,7 @@ export declare class NeedleToktxContext implements INeedleTextureTransformContex
     numTextures: number;
     private _prepareFailed;
     constructor(options: NeedleToktxOptions);
-    prepare(document: Document): Promise<void>;
+    prepare(document: Document): Promise<boolean>;
     process(index: number, texture: Texture, settings: NEEDLE_compression_texture_schema | null): Promise<boolean>;
     finalize(document: Document): Promise<void>;
 }

package/dist/transforms/needle_toktx.js

@@ -65,6 +65,11 @@ export class NeedleToktxContext {
             this.document = document;
             const logger = document.getLogger();
             this.version = await checkKTXSoftware(logger, this.env);
+            if (this.version === null) {
+                console.log("Will not run toktx transform");
+                this._prepareFailed = true;
+                return false;
+            }
             this.basisuExtension = document.createExtension(KHRTextureBasisu).setRequired(true);
             const tmpDir = `${tmp.tmpdir}/gltf-transform`;
             if (!(existsSync(tmpDir)))
@@ -74,8 +79,11 @@ export class NeedleToktxContext {
         }
         catch (e) {
             console.error(e);
+            console.log("Error preparing toktx transform");
             this._prepareFailed = true;
+            return false;
         }
+        return true;
     }
     async process(index, texture, settings) {
         const task = async () => {

package/dist/transforms/toktx.d.ts

@@ -74,4 +74,4 @@ export declare const UASTC_DEFAULTS: Omit<UASTCOptions, 'mode'>;
  */
 /** Create CLI parameters from the given options. Attempts to write only non-default options. */
 export declare function createParams(slots: string[], channels: number, size: vec2, logger: ILogger, numTextures: number, options: ETC1SOptions | UASTCOptions, version: string): (string | number)[];
-export declare function checkKTXSoftware(logger: ILogger, env?: any): Promise<string>;
+export declare function checkKTXSoftware(logger: ILogger, env?: any): Promise<string | null>;

package/dist/transforms/toktx.js

@@ -169,7 +169,18 @@ export function createParams(slots, channels, size, logger, numTextures, options
 }
 let didLogToktxVersion = false;
 export async function checkKTXSoftware(logger, env) {
-    const [status, stdout, stderr] = await waitExit(spawn('toktx', ['--version'], { env: env }));
+    let failedFindingToktx = false;
+    const proc = spawn('toktx', ['--version'], { env: env });
+    proc.on('error', (err) => {
+        if (err.message.endsWith("ENOENT")) {
+            failedFindingToktx = true;
+        }
+    });
+    const [status, stdout, stderr] = await waitExit(proc);
+    if (failedFindingToktx) {
+        console.log(`WARN: Unable to find "toktx". Confirm KTX-Software is installed from: https://github.com/KhronosGroup/KTX-Software.`);
+        return null;
+    }
     const version = (stdout || stderr)
         .replace(/toktx\s+/, '')
         .replace(/~\d+/, '')

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@needle-tools/gltf-build-pipeline",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "description": "Pipeline and tools for optimizing gltf files using gltf-transform and compression settings within glTF extensions",
   "main": "index.mjs",
   "type": "module",