Returning conversion warnings in 3DMLoader #21639

karimi · 2021-04-12T21:53:02Z

Description

3DMLoader parse and load methods can partially fail to convert some entities of the original file for various reasons including missing render meshes. This PR captures returns warnings of this nature.

…Loader

mrdoob · 2021-04-12T22:58:05Z

/ping @fraguada

fraguada · 2021-04-13T07:12:33Z

@mrdoob @Rada8732 @Mugen87 @karimi I'd like a bit of time to review this. @karimi and I have discussed the use case, which is valid, but I'd like to see if there are any other options to bubble up errors from workers. I haven't done the research yet, but I'm guessing this can be done through messaging. Any suggestions are welcome.

fraguada · 2021-04-13T07:43:04Z

@karimi I believe the way we'd want to do this is to actually use the worker messaging like is done here: https://github.com/mrdoob/three.js/blob/dev/examples/jsm/loaders/3DMLoader.js#L811
There is a bunch of unused onError stuff, and even a case for handling errors from the worker that is never used 😳: https://github.com/mrdoob/three.js/blob/dev/examples/jsm/loaders/3DMLoader.js#L713
It feels like we should use that messaging mechanism then hit the onError here or here.

We could extend this to warnings and aggregate warnings through a similar mechanism.

Does this sound reasonable?

karimi · 2021-04-13T15:29:05Z

@fraguada are you suggesting we add a warning case in _getWorker ?

case 'warning':
	worker._callbacks[ message.id ].reject( message );
	break;

I'm not sure how that can work since warnings can be thrown at individual object level and tasks are per buffer. Of course that can change, but it's a bigger change.

karimi · 2021-04-13T16:42:52Z

@fraguada , see latest commit
It's catching the decodeObjects errors and posting them as a new error message to the worker where it's picked up by onError callback.
I'm still not sure if we can extend the same mechanism to warnings without substantial change since tasks are not per objects.

…to wip/3DMLoader # Conflicts: # examples/jsm/loaders/3DMLoader.js

Mugen87 · 2021-04-16T07:31:50Z

@karimi Do you mind rebasing the PR due to #21660?

karimi · 2021-04-16T16:00:58Z

@Mugen87 Just rebased and pushed.

karimi · 2021-04-26T20:54:35Z

@fraguada did you have a chance to review this?

…Loader # Conflicts: # examples/jsm/loaders/3DMLoader.js

fraguada

@karimi I've written some comments along with your proposed changes. I believe we can still take advantage of the worker self.postMessage( { type: 'warning', data } ); pattern by adding a warning case when setting up the worker (around line 706). When the worker finishes, you'd have a collection of warnings that can be checked along with the resulting objects. What do you think?

examples/jsm/loaders/3DMLoader.js

fraguada · 2021-04-30T09:43:50Z

examples/jsm/loaders/3DMLoader.js

@@ -1226,6 +1241,7 @@ function Rhino3dmWorker() {

 			default:
 				console.warn( `THREE.3DMLoader: TODO: Implement ${objectType.constructor.name}` );
+				onWarning( `THREE.3DMLoader: TODO: Implement ${objectType.constructor.name}` );


Same strategy as suggested above

examples/jsm/loaders/3DMLoader.js

karimi · 2021-05-03T18:45:58Z

examples/jsm/loaders/3DMLoader.js

@@ -714,6 +717,9 @@ class Rhino3dmLoader extends Loader {
 					const message = e.data;

 					switch ( message.type ) {
+						case 'warning':
+							worker._callbacks[ message.id ].warn( message );


@fraguada We need a id to figure out which task this warning belongs to. I'm using the taskID corresponding to the file to collate the warnings.

I am not sure we should add a .warn to this callback, since the promises api only defines resolve and reject. I think this is the place we should be collecting the warning, or printing them to the console, or doing something. The worker should need to be bothered by a warning unless I am confused.

karimi · 2021-05-03T18:47:42Z

examples/jsm/loaders/3DMLoader.js

@@ -117,7 +118,7 @@ class Rhino3dmLoader extends Loader {

 				return new Promise( ( resolve, reject ) => {

-					worker._callbacks[ taskID ] = { resolve, reject };
+					worker._callbacks[ taskID ] = { resolve, reject, warn: warning =>warnings.push(warning) };


Adding a function to collate warnings thrown by workers.

karimi · 2021-05-03T18:53:01Z

@fraguada Thanks for your suggestions, I think posting the warnings to the workers makes sense. I was able to do that but needed an id to relate the warnings that can be thrown at any level to a specific task initiated by a file. Therefore I'm passing the taskID down to functions that create the geometry. I'm open to suggestions if you think this can be done more elaborately.

fraguada · 2021-05-04T08:00:56Z

@karimi the warnings should only occur in a worker that has a decode message. Perhaps it would be better to have a worker level taskId that can then be added to any messages posted, instead of passing the taskId to the methods.

So for example:
(around line 773)

/* WEB WORKER */

function Rhino3dmWorker() {

	let libraryPending;
	let libraryConfig;
	let rhino;
        let taskId; //new

and then
(around line 807)

	case 'decode':

                taskId = message.id; // new

		const buffer = message.buffer;
		libraryPending.then( () => {

			const data = decodeObjects( rhino, buffer );

			self.postMessage( { type: 'decode', id: message.id, data } );

		} );

		break;

examples/jsm/loaders/3DMLoader.js

fraguada · 2021-05-07T09:08:38Z

examples/jsm/loaders/3DMLoader.js

@@ -615,7 +624,7 @@ class Rhino3dmLoader extends Loader {

 				} else if ( geometry.isLinearLight ) {

-					console.warn( 'THREE.3DMLoader:  No conversion exists for linear lights.' );
+					self.postMessage( { type: 'warning', id: taskID, message: 'THREE.3DMLoader:  No conversion exists for linear lights.' } );


@karimi here we are no longer in the worker. What do you want to do with these warnings? I'm don't think posting messages is the way to go here.

examples/jsm/loaders/3DMLoader.js

fraguada · 2021-05-07T09:29:46Z

@karimi I made some changes and updates. Thanks for giving me push access to your fork, it makes this PR process better IMO.

I think with these changes we cover a general way to communicate warnings from the worker. In the main code we need to decide how you want to use these warnings. For now, I created a class level this.warnings[] to collect all of these. We should ensure there is enough data in the message so that it is useful when converting the objects and for your use case.

karimi · 2021-05-07T21:23:23Z

@fraguada I turned this into a draft PR since there are still issues that need to be resolved. I pushed a commit to fix the issue with undefined this.warnings . But still need to figure out the warning with linear_lights and how we communicate these warnings using load and parse methods.

karimi · 2021-05-07T21:45:34Z

@fraguada I have a few ideas on how to return these warnings, one would be to just attach the array of warnings to the returned object. Another one would be to add a onWarning callback to parse and load methods. Let me know what your thoughts are.

load( url, onLoad, onProgress, onError, onWarning ) {
.
.
.
	this.decodeObjects( buffer, url )
		.then( result =>{onLoad(result); this.warnings.length>0 && onWarning(this.warnings)} )
		.catch( e => onError( e ) );

}, onProgress, onError );

}

karimi · 2021-05-07T21:45:43Z

Regarding the contents of the warnings I think they're already useful, but it would be definitely an improvement if we could return an object with warning type and message. As far as my workflow goes, I'd like to provide a suggestion to the user on how to fix each warning, and knowing the warning type would be useful. What I mean by warning type is for example type: "missing mesh" vs type: "missing texture"

examples/jsm/loaders/3DMLoader.js

fraguada · 2021-05-11T10:43:29Z

@karimi I've reworked the warning message style, adding a guid property when the warning is related to an object. Warning types are:

no conversion - there is no analog type between rhino and threejs
not implemented - this conversion hasn't been implemented
missing mesh - no render mesh associated with this object
missing resource - there is something not embedded in the file, in the case of things like bitmaps for textures

I think we should go with your suggestion to add warnings to the objects (when possible) and not add an onWarning callback.

I suggest objects get a warning property in the object userData with the warnings associated with the object guid. This won't be relevant for things like missing textures. If that is important, we can handle it in another PR.

karimi · 2021-05-12T21:11:34Z

Thank @fraguada , I think the warning object is more informative now.
Regarding adding the warnings to object userData, I meant the object as in javascript object, not as in geometry. That won't be possible because in most of the warning cases there won't be a three.js geometry to attach the warnings to.
So I went ahead and added the warnings to userData of the object returned by load and parse.
I think it looks good and ready to be merged in. Let me know if you have any other thoughts.

fraguada · 2021-05-17T09:17:56Z

Thanks for working on this @karimi! I think this is a nifty system :)

@Mugen87 @mrdoob I think this one is ready.

mrdoob · 2021-05-17T14:40:14Z

examples/webgl_loader_3dm.html

@@ -76,7 +76,7 @@
 					// hide spinner
 					document.getElementById( 'loader' ).style.display = 'none';

-				} );
+				}, progress =>progress, error => ( console.log( error ) ) );


What does progress =>progress do?

Cleaned that up.

mrdoob · 2021-05-18T04:37:31Z

Thanks!

fraguada added 3 commits February 11, 2021 15:30

extract name and value properties from objects

158a875

Extract object userStrings

ec3ff76

Merge branch 'dev' of https://github.com/mrdoob/three.js into wip/3DM…

89da0c7

…Loader

fraguada added 3 commits April 15, 2021 15:08

Merge branch 'wip/3DMLoader' of https://github.com/mcneel/three.js in…

78afc99

…to wip/3DMLoader # Conflicts: # examples/jsm/loaders/3DMLoader.js

3dmLoader: refactor es6

c810381

Remove unnecessary imports.

4176142

karimi added 3 commits April 16, 2021 11:44

Store conversion warnings in returned object

1d97c81

Pass worker erros to onError callback

e21f211

Pass worker erros to onError callback

da176ab

karimi force-pushed the 3dmloaderwarnings branch from 38e1a96 to da176ab Compare April 16, 2021 15:59

Merge branch 'dev' into 3dmloaderwarnings

6c02601

fraguada added 2 commits April 30, 2021 11:23

adding some error catching related to PBR mats

ea34dbf

Merge branch 'dev' of https://github.com/mrdoob/three.js into wip/3DM…

103675f

…Loader # Conflicts: # examples/jsm/loaders/3DMLoader.js

fraguada reviewed Apr 30, 2021

View reviewed changes

fraguada and others added 3 commits April 30, 2021 12:06

fix bug in texturetype checking

7731833

Post warnings to worker

0652c61

Merge https://github.com/mrdoob/three.js into 3dmloaderwarnings

b1ecb5e

karimi commented May 3, 2021

View reviewed changes

fraguada reviewed May 4, 2021

View reviewed changes

examples/jsm/loaders/3DMLoader.js Show resolved Hide resolved

cleanup taskID usage

cb633a0

fraguada reviewed May 7, 2021

View reviewed changes

examples/jsm/loaders/3DMLoader.js Outdated Show resolved Hide resolved

fraguada reviewed May 7, 2021

View reviewed changes

added class level warnings

e3a7f58

fraguada reviewed May 7, 2021

View reviewed changes

examples/jsm/loaders/3DMLoader.js Outdated Show resolved Hide resolved

printing warnings

3cdfabe

fraguada and others added 2 commits May 7, 2021 11:42

fixed bug in .catch

e9d7654

Fix undefined this.warnings

0c60f5f

karimi marked this pull request as draft May 7, 2021 21:19

karimi and others added 3 commits May 7, 2021 17:48

Add onWarning callback

5d06888

Rewriting onMessage as arrow function

3ca34c0

rework warning messages, lightstyle switch

bd86376

fraguada reviewed May 11, 2021

View reviewed changes

examples/jsm/loaders/3DMLoader.js Outdated Show resolved Hide resolved

fraguada reviewed May 11, 2021

View reviewed changes

examples/jsm/loaders/3DMLoader.js Outdated Show resolved Hide resolved

Remove onWarning callback, add warnings to userData

59dd4bd

karimi marked this pull request as ready for review May 13, 2021 01:35

Cleanup comments, etc.

7f8bcc4

fraguada approved these changes May 17, 2021

View reviewed changes

mrdoob added this to the r129 milestone May 17, 2021

mrdoob reviewed May 17, 2021

View reviewed changes

reverted change in example

a7806e6

mrdoob merged commit 8fa6227 into mrdoob:dev May 18, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Returning conversion warnings in 3DMLoader #21639

Returning conversion warnings in 3DMLoader #21639

karimi commented Apr 12, 2021 •

edited by Mugen87

mrdoob commented Apr 12, 2021

fraguada commented Apr 13, 2021 •

edited

fraguada commented Apr 13, 2021 •

edited

karimi commented Apr 13, 2021

karimi commented Apr 13, 2021

Mugen87 commented Apr 16, 2021

karimi commented Apr 16, 2021

karimi commented Apr 26, 2021

fraguada left a comment

fraguada Apr 30, 2021

karimi May 3, 2021 •

edited

fraguada May 7, 2021

karimi May 3, 2021

karimi commented May 3, 2021

fraguada commented May 4, 2021

fraguada May 7, 2021

fraguada commented May 7, 2021

karimi commented May 7, 2021

karimi commented May 7, 2021

karimi commented May 7, 2021

fraguada commented May 11, 2021

karimi commented May 12, 2021

fraguada commented May 17, 2021

mrdoob May 17, 2021

fraguada May 17, 2021

mrdoob commented May 18, 2021

Returning conversion warnings in 3DMLoader #21639

Returning conversion warnings in 3DMLoader #21639

Conversation

karimi commented Apr 12, 2021 • edited by Mugen87

mrdoob commented Apr 12, 2021

fraguada commented Apr 13, 2021 • edited

fraguada commented Apr 13, 2021 • edited

karimi commented Apr 13, 2021

karimi commented Apr 13, 2021

Mugen87 commented Apr 16, 2021

karimi commented Apr 16, 2021

karimi commented Apr 26, 2021

fraguada left a comment

Choose a reason for hiding this comment

fraguada Apr 30, 2021

Choose a reason for hiding this comment

karimi May 3, 2021 • edited

Choose a reason for hiding this comment

fraguada May 7, 2021

Choose a reason for hiding this comment

karimi May 3, 2021

Choose a reason for hiding this comment

karimi commented May 3, 2021

fraguada commented May 4, 2021

fraguada May 7, 2021

Choose a reason for hiding this comment

fraguada commented May 7, 2021

karimi commented May 7, 2021

karimi commented May 7, 2021

karimi commented May 7, 2021

fraguada commented May 11, 2021

karimi commented May 12, 2021

fraguada commented May 17, 2021

mrdoob May 17, 2021

Choose a reason for hiding this comment

fraguada May 17, 2021

Choose a reason for hiding this comment

mrdoob commented May 18, 2021

karimi commented Apr 12, 2021 •

edited by Mugen87

fraguada commented Apr 13, 2021 •

edited

fraguada commented Apr 13, 2021 •

edited

karimi May 3, 2021 •

edited