feat(azure): support custom configuration #1344

NicholasDawson · 2023-06-25T03:48:33Z

🔗 Linked issue

❓ Type of change

📖 Documentation (updates to the documentation or readme)
🐞 Bug fix (a non-breaking change that fixes an issue)
👌 Enhancement (improving an existing functionality like performance)
✨ New feature (a non-breaking change that adds functionality)
⚠️ Breaking change (fix or feature that would cause existing functionality to change)

📚 Description

I, along with many others deploying a Nitro server to Azure Static Web Apps, need to customize the staticwebapp.config.json file beyond what Nitro generates. Currently, Nitro overwrites the entire file on every compilation. It would be better if Nitro extended an existing configuration if present not overwrite the whole file.

I added thorough documentation to explain how the system will now load and utilize the configuration. Please reference that to learn a little more about my implementation.

Implementation Notes

I put a lot of thought into this implementation as there wasn't necessarily a right or wrong way to handle this. I didn't originally want to have a separate file custom.staticwebapp.config.json, but the reason I had to add it was that if Nitro and the user are writing to the same file there is no way to keep track of what needs to take priority or be overwritten. Especially for routes, if Nitro generated the config for pre-rendered routes, but then the user deletes that pre-rendered route, it would be expected that the config removes that next time it compiles. If I tried to merge changes into the staticwebapp.config.json then Nitro would essentially lose the ability to remove lines from the configuration, only add them.

Therefore it was necessary to introduce the convention of having the user add their own configuration to a file I called custom.staticwebapp.config.json to provide a clear distinction between what the user wants to add and what the final generated result (staticwebapp.config.json) is.

📝 Checklist

I have linked an issue or discussion.
I have updated the documentation accordingly.

nuxt-studio · 2023-06-25T03:48:36Z

✅ Live Preview ready!

Name	Edit	Preview	Latest Commit
nitro	Edit on Studio ↗︎	View Live Preview	`1bf18a7`

codecov · 2023-06-25T03:52:33Z

Codecov Report

Merging #1344 (1bf18a7) into main (6cfdf01) will increase coverage by 1.40%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##             main    #1344      +/-   ##
==========================================
+ Coverage   76.39%   77.80%   +1.40%     
==========================================
  Files          76       76              
  Lines        7790     7816      +26     
  Branches      784      797      +13     
==========================================
+ Hits         5951     6081     +130     
+ Misses       1837     1732     -105     
- Partials        2        3       +1

Files Changed	Coverage Δ
src/presets/azure.ts	`90.28% <100.00%> (+76.19%)`	⬆️

... and 2 files with indirect coverage changes

NicholasDawson · 2023-07-17T01:01:24Z

@Hebilicious
Can I please have an update on this PR? It has been 3 weeks, I tried really hard to add sufficient testing and documentation to make this PR easy to review and accept. I know you all must be very busy and I really appreciate your work, I would just appreciate an update on this PR.

Hebilicious · 2023-07-17T07:38:59Z

@Hebilicious Can I please have an update on this PR? It has been 3 weeks, I tried really hard to add sufficient testing and documentation to make this PR easy to review and accept. I know you all must be very busy and I really appreciate your work, I would just appreciate an update on this PR.

Hi @NicholasDawson , thank you for your hard work on this PR, and sorry for the time it took to review it.
I think these are all great changes that are well documented, and they will make the life of azure users easier.
@pi0 will then need to review it and approve it before it gets merged.

docs/content/2.deploy/providers/azure.md

Hebilicious · 2023-07-17T07:51:36Z

src/presets/azure.ts

+  // Attempt to load custom config
+  let customConfig = {};
+  try {
+    customConfig = JSON.parse(


This can fail silently if JSON.parse fails (invalid json).
Maybe we should actually throw an error if JSON.parse fails ?
One way to do it would be to check if the file exist first.

const customConfig = exists ? JSON.parse() : {}

I would get rid of the try-catch block and let the operation fail immediately instead of continuing with an invalid json

src/presets/azure.ts

test/fixture/custom.staticwebapp.config.json

…asDawson/nitro into azure-preset-enhancements

NicholasDawson · 2023-07-18T14:13:29Z

@Hebilicious I made fixes based on your feedback, let me know what you think

Hebilicious

I would get rid of the try catch block entirely.
Otherwise this looks good to me.

NicholasDawson · 2023-07-18T14:52:03Z

I would get rid of the try catch block entirely. Otherwise this looks good to me.

@Hebilicious All set.

NicholasDawson · 2023-07-24T13:39:02Z

@Hebilicious do you know if this PR is ready to be merged, or does @pi0 need to review as well? Just wondering where it stands.

Hebilicious · 2023-07-24T13:57:16Z

Pi is the code owner and has to review and merge all non documentation PRs.

pi0

Thanks so much for the PR ❤️ (and sorry it took long to review!)

I have made a couple of reactors to support via nitro.azure.config instead to avoid introducing second file and be consistent with other presets i hope you are happy with it.

NicholasDawson added 2 commits June 24, 2023 22:48

refactor: export fixtureDir to reference in test

8de7790

feat: enable azure preset to load custom config

3c02156

NicholasDawson added 2 commits June 25, 2023 00:05

test: add timeout of 10_000 to try to fix windows ci

8f4685a

Merge branch 'unjs:main' into azure-preset-enhancements

d6b92f0

Hebilicious self-requested a review June 30, 2023 19:15

Hebilicious self-assigned this Jun 30, 2023

Hebilicious added enhancement New feature or request preset:azure labels Jun 30, 2023 — with Volta.net

pi0 unassigned Hebilicious Jul 14, 2023

Hebilicious reviewed Jul 17, 2023

View reviewed changes

Hebilicious requested a review from pi0 July 17, 2023 08:01

NicholasDawson added 5 commits July 18, 2023 09:08

Merge branch 'unjs:main' into azure-preset-enhancements

1e3a8d2

docs: simplify azure preset custom config

e6c316a

refactor: improve custom azure swa config handling

2e66cd5

test: delete temp configs for azure preset testing

14d1fcb

Merge branch 'azure-preset-enhancements' of https://github.com/Nichol…

640ef3f

…asDawson/nitro into azure-preset-enhancements

Hebilicious reviewed Jul 18, 2023

View reviewed changes

refactor: remove try catch from loading custom config

e27bba3

Hebilicious mentioned this pull request Jul 19, 2023

feat(cloudflare-pages): add config to customize generated _routes.json #1312

Merged

7 tasks

pi0 added 3 commits August 21, 2023 01:04

Merge branch 'main' into pr/NicholasDawson/1344

ebcbb25

update snapshot

9893b97

refactor: support via azure.config

ec36532

pi0 added 3 commits August 21, 2023 01:18

update docs

d39c5c2

remove unused import

4ca2743

allow nested merging

83171e1

pi0 changed the title ~~feat: enable azure preset to load custom config~~ feat(azure): support custom configuration Aug 20, 2023

pi0 approved these changes Aug 20, 2023

View reviewed changes

simplify test to speedup total ci time and reduce timeout

1bf18a7

pi0 merged commit 4a6cbcb into nitrojs:main Aug 20, 2023
8 checks passed

pi0 mentioned this pull request Aug 21, 2023

[draft] v2.6.0 #1526

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(azure): support custom configuration #1344

feat(azure): support custom configuration #1344

NicholasDawson commented Jun 25, 2023

nuxt-studio bot commented Jun 25, 2023 •

edited

Loading

codecov bot commented Jun 25, 2023 •

edited

Loading

NicholasDawson commented Jul 17, 2023 •

edited

Loading

Hebilicious commented Jul 17, 2023 •

edited

Loading

Hebilicious Jul 17, 2023

Hebilicious Jul 18, 2023

NicholasDawson commented Jul 18, 2023

Hebilicious left a comment

NicholasDawson commented Jul 18, 2023

NicholasDawson commented Jul 24, 2023

Hebilicious commented Jul 24, 2023

pi0 left a comment

feat(azure): support custom configuration #1344

feat(azure): support custom configuration #1344

Conversation

NicholasDawson commented Jun 25, 2023

🔗 Linked issue

❓ Type of change

📚 Description

Implementation Notes

📝 Checklist

nuxt-studio bot commented Jun 25, 2023 • edited Loading

✅ Live Preview ready!

codecov bot commented Jun 25, 2023 • edited Loading

Codecov Report

NicholasDawson commented Jul 17, 2023 • edited Loading

Hebilicious commented Jul 17, 2023 • edited Loading

Hebilicious Jul 17, 2023

Choose a reason for hiding this comment

Hebilicious Jul 18, 2023

Choose a reason for hiding this comment

NicholasDawson commented Jul 18, 2023

Hebilicious left a comment

Choose a reason for hiding this comment

NicholasDawson commented Jul 18, 2023

NicholasDawson commented Jul 24, 2023

Hebilicious commented Jul 24, 2023

pi0 left a comment

Choose a reason for hiding this comment

nuxt-studio bot commented Jun 25, 2023 •

edited

Loading

codecov bot commented Jun 25, 2023 •

edited

Loading

NicholasDawson commented Jul 17, 2023 •

edited

Loading

Hebilicious commented Jul 17, 2023 •

edited

Loading