[Bug?]: project:sync is broken

[arimendelow]

What's not working?

Following the contribution instructions, I'm attempting to work on a Redwood package alongside my existing project. My project is fully up to date.

I'm running into a few fully breaking issues:

It flat out breaks my project

After I run the project:sync command, I see a successful output:

I then run yarn rw dev, but my project now has random breaking issues:

Sync is broken and crashes

I then tried to see if syncing even worked, so I went to the package that I want to work on (auth-providers/dbAuth), and added a simple console log just to see if it would sync. Doing that leads to project:sync crashing:

I've run git clean -fxd, yarn cache clean... it seems to be an issue with the project itself.

Am I doing something wrong?

Thanks!

How do we reproduce the bug?

No response

What's your environment? (If it applies)

No response

Are you interested in working on this?

• I'm interested in working on this

[arimendelow]

I confirmed that the first issue (failed to execute 'createElement' on 'Document') is a problem with the canary, not the sync itself.

However, trying to run sync once I've upgraded my project to the canary now gives the following:

[jtoar]

Hey @arimendelow, I'm actually working on that fixing that error here #8579. I think I have it fixed and discovered a few more things that weren't quite right with that script. There's still a few improvements I want to make, but I think it fixes the issue you're seeing. Could you confirm for me by pulling down that branch and running yarn rwfw project:sync from there?

[jtoar]

@arimendelow and about the SVG change, yes that's one of the breaking changes we're working out for the next major. The change was in this PR: #8301, and WIP codemod here: #8564

[arimendelow]

@jtoar ahhh thanks for the quick reply! that SVG change is easy enough.

I pulled down and built your branch, and then after cleaning up both my project and the fw with git clean -fxd -e .env; yarn cache clean, I ran yarn rwfw project:sync - same error on attempt to sync. Should I be doing something differently?

[jtoar]

@arimendelow No I don't think so, all the steps you mentioned seemed like enough. I'll just have to keep trying things to figure out what's going on. I'll post a short video soon showing what I'm doing just so you can double check

[arimendelow]

@jtoar sounds good :)

[jtoar]

@arimendelow A higher resolution is taking longer to process but here's what I'm doing (there's no audio, just a quick recording I did with Mac's screenshot utility): https://www.youtube.com/watch?v=0yLUZ2GhX-A

One thing I should've asked: what's your OS?

[jtoar]

Also I'll add: sorry, I'm force pushing to that branch a lot which means if you want the new changes they're a little harder to get locally

[arimendelow]

@jtoar thanks! that's pretty in line with what I was doing, I'll pull down your latest changes and report back.

macOS....whatever the latest is 😄

[arimendelow]

lol yeah i was wondering what was going on there. no worries!

[arimendelow]

@jtoar just tried with your latest changes, still have this issue.

are you able to make edits to DbAuthHandler in sync mode? maybe give that a try as a repro

[arimendelow]

@jtoar is there a recommended workflow for working on the framework while you're working on this fix? cc @thedavidprice @cannikin if you have any suggestions :)

[cannikin]

You could use project:copy instead...you'd have to do it every time there's a change in the framework though. :(

[arimendelow]

yeah, i was thinking there'd be a command like that - better than nothing! is that what you've been doing?

[cannikin]

Yeah there's been a couple of times when project:sync wouldn't work for me. I believe there's a --watch flag which makes it even better, it kind of acts like sync but isn't quite as fast!

[arimendelow]

cool, thanks @cannikin! do you folks think there's an ETA on this fix or should I get used to using project:copy? 🙃

[thedavidprice]

@arimendelow If you could try out this PR locally and provide feedback to @jtoar it would be very helpful! (no pressure, to be clear)
#8579

[arimendelow]

@thedavidprice do you know if there have been meaningful updates to the PR since yesterday? as of yesterday, it still didn't work (see above)

[thedavidprice]

@arimendelow just worked for me ✅

[arimendelow]

@thedavidprice have you tried editing packages/auth-providers/dbAuth/api/src/DbAuthHandler.ts? I just tried with the latest changes (did git clean etc ofc) and I'm still getting the error out.

[thedavidprice]

@arimendelow Gah, I just reproduced the error after editing the file. The first time I simply walked through the steps outlined in the PR. Great catch.

I've updated the review here:
#8579 (review)

[arimendelow]

@thedavidprice thanks for the support 🙂 hurdle 1 of what I assume to be many on my journey to add OAuth to dbAuth!

[arimendelow]

@jtoar @thedavidprice project:sync is now working perfectly for me, with one exception - whenever I make a change in a web-side file, I need to do a git clean and rebuild on the project side before it's reflected. Even project:copy didn't work for this.

Is that expected? It's quite annoying, but workable.

[jtoar]

@arimendelow By web-side file, do you mean in your redwood project? Or in the @redwoodjs/web package? (Or any @redwoodjs package that eventually ends up on the web side?)

[arimendelow]

It was specifically the web side auth stuff from the Redwood side

[arimendelow]

The auth context provider, for example

[jtoar]

Thanks @arimendelow I can reproduce that; the first change takes effect but not subsequent ones, even after re-starting the dev server. I'm guessing it has to do with Vite caching, but don't know for sure so I'll read up on it and ask the team.

[jtoar]

@arimendelow so Vite node_modules caching is definitely a thing and it only re-bundles based on these events, which project:sync doesn't fall under:

• Package manager lockfile content, e.g. package-lock.json, yarn.lock, pnpm-lock.yaml or bun.lockb.
• Patches folder modification time.
• Relevant fields in your vite.config.js, if present.
• NODE_ENV value.

Source: https://vitejs.dev/guide/dep-pre-bundling.html#file-system-cache.

We'll figure out how to make this easier, but for now this should save you from having to do a git clean and rebuild. Start your dev server like this:

yarn rw dev --forward="--force"

Make sure you see this in your terminal:

web | Forced re-optimization of dependencies

You'll have to restart your dev server every time you make a change, but it'll be much faster than a full git clean and rebuild.

[arimendelow]

ahhhh yup makes sense - the workaround works great, thanks @jtoar! :)

[arimendelow]

I'll close this bug as I feel your PR fixed it