refactor: locate next.config.js by root publish directory, instead of root of repository

[rayriffy]

Description

This PR should solves #115 to handle edge cases when user build Netlify site and export .next and next.config.js to somewhere else. In case of Nx after build is succeed, next.config and .next is generated in dists/apps/<application name> which is nessesary to use this plugin but current code still always looking next.config.js in root repository causing builds to failed due to plugin error.

https://github.com/netlify/netlify-plugin-nextjs/blob/2f564b151552358689ea578563a52f2713345ccd/helpers/getNextConfig.js#L15

[ehmicky]

Thanks a lot @rayriffy!

For the Nx specific logic, I will delegate to @lindsaylevine, but the PR looks good otherwise from a code standpoint, except for one small suggestion 👍

I am wondering though: next.config.js is loaded is many more places in this plugin that copyNextAssets.js. You can see it by checking which functions are calling getNextConfig(). Shouldn't all of those places also use the publish directory as base?

[lindsaylevine]

thanks so much for this!!! +1 to what mickael said about getNextConfig/getNextDistDir being called in several places :)

[rayriffy]

I've make changes that being requested and my god my eyes now in tears.

Yes, I just realized that getNextConfig() is being called everywhere that turns out when I finished traced back everything. I ended up with up to 40 file changes (which is almost entire plugin) and 3 test suites failed regards to copying files suites.

I already reverted those changes because clearly this is way out of my control. Might try again tmr if you wanted to.

[lindsaylevine]

oh my goodness @rayriffy

[lindsaylevine]

@rayriffy i think we might want to rethink how our config gets passed around after seeing all the work this has taken 😲 we really appreciate it though and will keep you updated

[rayriffy]

I am thinking about some kind of file-based configuration generated in onPreBuild and have some functions (getPluginConfig etc.) to read configuration from file systems.

PS. Yeah, it quite hard to track down all functions that needs to be modified, I would like to suggest to enforce named exports stack and refactor code to TypeScript.

[lindsaylevine]

hey @rayriffy! i'm so sorry for neglecting this PR. i think i felt bad about closing it after all of your hard work! :( here's what happened overall though:

your last comment stemmed a big conversation internally about the right way we could do this.

I am thinking about some kind of file-based configuration generated in onPreBuild and have some functions (getPluginConfig etc.) to read configuration from file systems.

we were lightly exploring ideas of global config, file-based config like you suggested, passing down the config everywhere like you did in your work (with publishPath), etc. ultimately we knew it'd take a lot of work/thought before we could really prioritize this, and so here we are 😅 .

i'm opening a new issue shortly with our plan going forward. it'll be very close to what you've done, but passing the nextConfig down. i will make sure that, in this work, we will also check for a config in the publish dir if we cannot find one at the root.

thank you so much for all your hard work on this. i/we truly appreciate it <3. let me know if you have any other feedback. i'll keep the exports/typescript note in mind though that would be difficult to prioritize any time soon :/.