Conway Shim API

[nickcastel50]

This is a full implementation of a shim for the Web-IFC read API capabilities. I will place build instructions here since I don't want to edit the developer guide just yet until it lands, and there are currently no extra build instructions in the readme.

Build Instructions:

1. yarn add ./bldrs-conway-v0.0.1.tgz --production
2. yarn add shx

Conway Shim:

1. yarn build-conway
2. yarn serve-share-conway

Original Web-IFC

1. yarn build-webifc
2. yarn serve-share-webifc

[netlify]

✅ Deploy Preview for bldrs-share ready!

Name	Link
🔨 Latest commit	46fad93
🔍 Latest deploy log	https://app.netlify.com/sites/bldrs-share/deploys/6525a78d1142c00008e87a94
😎 Deploy Preview	https://deploy-preview-789--bldrs-share.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	1 paths audited Performance: 25 (🔴 down 1 from production) Accessibility: 84 (no change from production) Best Practices: 100 (no change from production) SEO: 92 (no change from production) PWA: - View the detailed breakdown and full score reports

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[pablo-mayrgundter]

Per convo, logging and error should accumulate to a vector during Init, OpenModel and Geometry/Mesh calls, etc. to optionally be accessed after each call by a method compatible with web-ifc, GetAndClearErrors.

Only variant we thought up was to keep a map by IFC type, or perhaps by error type, to keep counts instead of 1:1 vector, since there is usually a high count involved that is slow to log.

[ConorStokes]

This model is probably not appropriate for the server-side use cases where a process might fall over halfway through (say due to hitting the heap allocation limit) and we'd want the contents of the log to determine where. I strongly recommend abstracting logging such that accumulating in a vector in this fashion is optional for use cases where it's appropriate. That's partly why I suggested using a proxy that allowed multiple logging targets.

…

On Tue, Sep 19, 2023 at 11:53 PM Pablo Mayrgundter ***@***.***> wrote: Per convo, logging and error should accumulate to a vector during Init, OpenModel and Geometry/Mesh calls, etc. to optionally be accessed after each call by a method compatible with web-ifc, GetAndClearErrors <https://ifcjs.github.io/web-ifc/docs/classes/web_ifc.IfcAPI.html#GetAndClearErrors> . Only variant we thought up was to keep a map by IFC type, or perhaps by error type, to keep counts instead of 1:1 vector, since there is usually a high count involved that is slow to log. — Reply to this email directly, view it on GitHub <#789 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ABGKI3O7BL6DQLBYUPMLGU3X3G5WNANCNFSM6AAAAAA4YVMI34> . You are receiving this because you are subscribed to this thread.Message ID: ***@***.***>

[pablo-mayrgundter]

Ok, builds for me.. nice :)

Please respond to My&Conor's comments about logging.

Couples questions on build. Where did you land with Ogali's build process? Should we see 2 previews here? Also, is this safe to check-in and won't affect production?

[nickcastel50]

Ok, builds for me.. nice :)

Please respond to My&Conor's comments about logging.

Couples questions on build. Where did you land with Ogali's build process? Should we see 2 previews here? Also, is this safe to check-in and won't affect production?

Regarding logging, a logging proxy that maps to multiple targets makes sense. I think this should come in a later PR though as geometry type coverage is taking precedence, and then we can circle back and hit logging across Conway / Conway-Geom, Shim, Sentry, etc.

As for build process, it looks like it's just generating one link still. If you checked this in, it would currently deploy Conway Shim and not Web-IFC, which might not be what we want yet due to coverage. We should page @oogali about how we can deploy this using the subdomain(s) as discussed.

[pablo-mayrgundter]

Ok yep, should check in without overriding prod.. LGTM and I'll hand off to Ogali now

[pablo-mayrgundter]

[netlify]

✅ Deploy Preview for bldrs-share-v2 ready!

Name	Link
🔨 Latest commit	46fad93
🔍 Latest deploy log	https://app.netlify.com/sites/bldrs-share-v2/deploys/6525a78d2af3dc0008bba895
😎 Deploy Preview	https://deploy-preview-789--bldrs-share-v2.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[pablo-mayrgundter]

Hey Nick,

We brought up at mtg the possibility that all you need to do here is flip the default from conway to web-ifc. Is that all that's left to determine?

If so, I suggest trying that and submitting, but stand by to revert if need be.

How's the sound?

[nickcastel50]

Hey Nick,

We brought up at mtg the possibility that all you need to do here is flip the default from conway to web-ifc. Is that all that's left to determine?

If so, I suggest trying that and submitting, but stand by to revert if need be.

How's the sound?

Hey @pablo-mayrgundter, Ogali and I took a look on Friday. In addition to changing the default "build" back to web-ifc (that change is already here), there are a few changes I just pushed up for Github actions, so it will actually test and run both the shim and original web-ifc backend. Once I can confirm the Github Action changes work we should be good to go.