@needle-tools/gltf-build-pipeline 2.4.0-alpha.2 → 2.4.0-alpha.4

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).
 
+## [2.4.0-beta] - 2023-08-13
+- fix: issue where a mesh lod is removed during second processing of a directory that contains existing mesh lods
+
+## [2.4.0-alpha.3] - 2023-08-11
+- fix: issue where files would not correctly be overriden in subdirectories when no output directory was specified 
+
 ## [2.4.0-alpha.2] - 2023-06-29
 - fix: prevent joining/flattening of progressive assets
 

package/dist/cli/index.js

@@ -4,8 +4,9 @@ import { calculateStats, packGLTF } from "../scripts/index.js";
 import { printStats, writeFileStatsToFile } from '../utils/stats.js';
 import { getVersion } from '../utils/version.js';
 import { UsecaseOptions, createConfig, getConfig } from '../config/index.js';
-import { make_progressive } from '../transforms/needle_progressive.js';
+import { isLOD, make_progressive } from '../transforms/needle_progressive.js';
 import { cacheSizeLimit, clearCache, limitCacheSize } from '../cache/cache.js';
+import { existsSync } from 'fs';
 import { ensureIsDirectory, foreachGLTF, isDirectory } from '../utils/fileutils.js';
 import path, { resolve } from 'path';
 import { ERROR_CODES } from '../constants.js';
@@ -91,15 +92,19 @@ Each version will be compressed and written to the output directory.
             config.usecase = options.usecase.toString();
         }
     }
-    let output = args.output?.toString() || input;
     const inputIsDirectory = isDirectory(input);
-    const outputIsDirectory = isDirectory(output);
-    if (inputIsDirectory && !outputIsDirectory) {
+    let output = args.output?.toString();
+    // If the input path is a filepath and no specific output is defined we set output to the input file
+    if (!inputIsDirectory && !output) {
+        output = input;
+    }
+    const outputIsDirectory = output && isDirectory(output);
+    if (inputIsDirectory && output && !outputIsDirectory) {
         logger.error("When <input> is a directory then <output> must also be a directory");
         process.exit(ERROR_CODES.INVALID_ARGS);
     }
     // Handle the output bath being relative to the input path
-    if (path.isAbsolute(output) === false) {
+    if (output && path.isAbsolute(output) === false) {
         const base = ensureIsDirectory(input);
         output = resolve(base, output);
     }
@@ -108,6 +113,20 @@ Each version will be compressed and written to the output directory.
     const debug = options.debug === true;
     const verbose = options.verbose === true;
     await foreachGLTF(input, async (file) => {
+        if (!existsSync(file)) {
+            // Safeguard if we run compression in a souce directory that already has progressive assets
+            // Here it can happen that a LOD file is generated with the same GUID at the moment 
+            // And then later removed because simplification is too small.
+            // See https://linear.app/needle/issue/NE-5518
+            if (isLOD(file)) {
+                logger.warn(`WARN: Ignore previously found file that does not exist anymore: \"${file}\"`);
+                return;
+            }
+            else {
+                logger.error(`ERR: Previously found file is now missing: \"${file}\"`);
+                process.exit(ERROR_CODES.LOST_FILE);
+            }
+        }
         logger.info("→ Transform " + file);
         const progressive_results = new Array();
         if (options.progressive === true) {
@@ -117,6 +136,7 @@ Each version will be compressed and written to the output directory.
                 results: progressive_results,
                 config,
                 debug,
+                verbose,
                 useCache,
             }).catch(err => {
                 logger.error(err);
@@ -124,6 +144,9 @@ Each version will be compressed and written to the output directory.
             }) === false) {
                 process.exit(ERROR_CODES.PROGRESSIVE_FAILED);
             }
+            if (verbose) {
+                console.log("Progressive results:\n", progressive_results);
+            }
         }
         if (options.compress === true) {
             const opts = {

package/dist/constants.d.ts

@@ -3,4 +3,5 @@ export declare const ERROR_CODES: {
     PACKING_FAILED: number;
     PROGRESSIVE_FAILED: number;
     INVALID_ARGS: number;
+    LOST_FILE: number;
 };

package/dist/constants.js

@@ -3,4 +3,5 @@ export const ERROR_CODES = {
     PACKING_FAILED: 2,
     PROGRESSIVE_FAILED: 3,
     INVALID_ARGS: 4,
+    LOST_FILE: 5,
 };

package/dist/scripts/pack-gltf.js

@@ -17,7 +17,7 @@ export async function packGLTF(inputFile, outputFile, options) {
     }
     const { debug, stats, packedFiles, useCache, logger } = options;
     if (!existsSync(inputFile)) {
-        logger.error("WARN: can not pack, file does not exist: " + inputFile);
+        logger.error(`WARN: can not pack, file does not exist: \"${inputFile}\"`);
         return false;
     }
     // check if it's in the cache. 

package/dist/transforms/needle_progressive.js

@@ -65,7 +65,7 @@ async function onProcess(file, opts) {
         if (document) {
             const logger = document.getLogger();
             //@ts-ignore
-            logger.verbosity = opts.debug || opts.verbose ? Verbosity.DEBUG : Verbosity.WARN;
+            logger.verbosity = (opts.debug || opts.verbose) ? Verbosity.DEBUG : Verbosity.WARN;
             let smallesTextureSize = 128;
             if (opts.config.usecase === "product") {
                 smallesTextureSize = 512;
@@ -652,6 +652,7 @@ export function make_progressive_meshes(filePath, _options, opts) {
                         }
                     }
                     if (shouldOmitLevel) {
+                        logger.debug(`[${NAME}] Omitting LOD ${level} for \"${mesh.getName()}\" at \"${lodInfo.path}\"`);
                         generatedLODInfos.splice(i, 1);
                         rmSync(fullPath);
                         i--;

package/dist/utils/fileutils.js

@@ -77,7 +77,7 @@ export async function foreachGLTF(args, callback) {
         }
     }
     if (context.files.length <= 0) {
-        console.log("WARN: No glTF files found. Make sure to invoke with a valid path to a glTF file or directory. This path may be relative to \"" + initDir + "\"");
+        console.log(`WARN: No glTF files found. Make sure to invoke with a valid path to a glTF file or directory.\nBase Directory: ${context.baseDirectory}\nPaths can be relative to \"${initDir}\"`);
     }
     else {
         for (const file of context.files) {
@@ -99,13 +99,13 @@ async function testEntry(entry, context) {
         // If no base directory is defined we cannot try to resolve the path
         if (context.baseDirectory === undefined) {
             console.log("WARN: Path does not exist: " + entry);
-            return;
+            return false;
         }
         // Try resolve potential relative path
         const newPath = context.baseDirectory + "/" + entry;
         if (existsSync(newPath) === false) {
             console.log(`INFO: Resolved path failed: \"${entry}\" -> ${newPath} (doesnt exist or is locked by another process)`);
-            return;
+            return false;
         }
         else {
             console.log(`INFO: Resolved path: ${entry} -> ${newPath}`);
@@ -122,7 +122,7 @@ async function testEntry(entry, context) {
                 console.log(`INFO: Resolved path: ${entry} -> ${newPath}`);
                 entry = newPath;
                 if (!existsSync(entry)) {
-                    return;
+                    return false;
                 }
             }
         }
@@ -135,7 +135,7 @@ async function testEntry(entry, context) {
         if (stat.isDirectory()) {
             // Don't traverse node_modules
             if (entry.endsWith("node_modules")) {
-                return;
+                return false;
             }
             const files = readdirSync(entry);
             for (const file of files) {
@@ -153,6 +153,9 @@ export function replaceExtension(filepath, newExtension) {
     return parts.join(".") + "." + newExtension;
 }
 export function isDirectory(path) {
+    if (!path) {
+        return false;
+    }
     if (existsSync(path)) {
         return statSync(path).isDirectory();
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@needle-tools/gltf-build-pipeline",
-  "version": "2.4.0-alpha.2",
+  "version": "2.4.0-alpha.4",
   "description": "Pipeline and tools for optimizing gltf files using gltf-transform and compression settings within glTF extensions",
   "main": "dist/index.js",
   "type": "module",