[Bug] Strange behavior on ng-doc 16.3.2 about ng-doc

[skoropadas]

@R-Bower ok great I think we've found the problem, I specifically made it so that the cache could be completely disabled by returning to the process as it was before the cache in case something like this happens, because the cache is quite a big feature and most likely will not work correctly on all projects from the start. I'll try to reproduce this locally and fix it, thank you for the feedback!

[R-Bower]

Cool, thanks for the quick response!

[skoropadas]

The reason that the project was built correctly after switching the builder is that NgDoc resets the cache after changing the configuration, so I decided to disable the cache function by default, I have not yet been able to reproduce a similar problem on other projects, apparently, its stability depends on the environment. It seems that the only way to solve it is to get a project in which it is reproduced so that it would be possible to debug its behavior and understand what's going on.

I'm also gonna refactor the builder, reduce the delay between the NgDoc and Angular builders, and maybe slightly increase the build speed, so maybe this problem will go away by itself, anyway will see!

[R-Bower]

There are only two hard things in Computer Science: cache invalidation and naming things.

[skoropadas]

It was working initially, but fails if I remove the .ng-doc folder contents and attempt a fresh build. I can't get it to work after that.

Got it, thank you 👍 I'll continue checking 🤔

[R-Bower]

I can get caching to work in dev mode by following these steps:

1. Set cache: false in ng-doc.config.ts
2. Build
3. Set cache: true in ng-doc.config.ts
4. Serve in dev mode.

It's quite fast. Looking forward to when this is fixed :)

[R-Bower]

So far I've tested the following:

• Start dev mode without .ng-doc folder.
• Start dev mode with .ng-doc folder from previous build.
• Start dev mode with .ng-doc folder, but the folder is empty.
• Build without .ng-doc folder.

Everything seems to be working as expected. Hot reloading is also working.

[skoropadas]

So far I've tested the following:

• Start dev mode without .ng-doc folder.
• Start dev mode with .ng-doc folder from previous build.
• Start dev mode with .ng-doc folder, but the folder is empty.
• Build without .ng-doc folder.

Everything seems to be working as expected. Hot reloading is also working.

Awesome! Then I will merge the changes, and release them together with the next version. But I think let this feature be turned off by default for now, if there are no other problems with it in the future, then I will turn it on. Thanks a lot for the feedback! 👍

[R-Bower]

Anytime, happy to help!

[skoropadas]

@R-Bower it's not reproducible in my new branch, so maybe I've already fixed it 🙃 I want to test a new feature and changes that I've done and release them tomorrow, so let's wait a bit :)

[skoropadas]

Looks like something was not generated correctly, few questions to understand your issue better:

• Did you migrate to 16.3.x using this #57 migration?
• Does it work if you provide cache: false in the ng-doc.config.ts?

Migration should migrate properties from ng-doc.dependencies.ts to ng-doc.page.ts and remove ng-doc.dependencies.ts files.

[R-Bower]

I did migrate, yeah. I also removed all of my page modules and converted every demo component to standalone. I'll try with cache disabled and see if it fixes the issue.

[R-Bower]

Confirmed working with cache: false.

[skoropadas]

@R-Bower hey, could you try to enable the cache on version 16.4.x and try to build the app several times? I wonder if this problem has been solved 🤔

[R-Bower]

Sure, I'll give it a go today!

[R-Bower]

It was working initially, but fails if I remove the .ng-doc folder contents and attempt a fresh build. I can't get it to work after that.

[R-Bower]

Feel free to release some pre-release builds and I'll test them for you.

[skoropadas]

Feel free to release some pre-release builds and I'll test them for you.

That would be awesome! Thank you! 😊

[skoropadas]

I can get caching to work in dev mode by following these steps:

1. Set cache: false in ng-doc.config.ts
2. Build
3. Set cache: true in ng-doc.config.ts
4. Serve in dev mode.

It's quite fast. Looking forward to when this is fixed :)

Maybe I know what the problem is, can you try the 16.4.3-beta.1 version?

So, the cache should be invalidated if the .ng-doc folder doesn't exist but if only one file there was changed there, then the cache should be invalidated only for the page that depends on this file.

[R-Bower]

This appears to be working, will keep testing and let you know.

[skoropadas]

This appears to be working, will keep testing and let you know.

Ok, thank you 👍

[R-Bower]

I thought I commented this yesterday, but apparently it didn't get posted. The app fails to build in this situation:

1. Create ng-doc page.
2. Start dev mode or build.
3. Stop dev mode.
4. Remove ng-doc page.
5. Start dev mode.

The page can't be found and an error is thrown in .ng-doc/app/ng-doc.routing.ts. The app doesn't compile until the offending route is removed from the routes config in this file. Removing the entire .ng-doc folder and restarting also works in this circumstance.

[skoropadas]

I thought I commented this yesterday, but apparently it didn't get posted. The app fails to build in this situation:

1. Create ng-doc page.
2. Start dev mode or build.
3. Stop dev mode.
4. Remove ng-doc page.
5. Start dev mode.

The page can't be found and an error is thrown in .ng-doc/app/ng-doc.routing.ts. The app doesn't compile until the offending route is removed from the routes config in this file. Removing the entire .ng-doc folder and restarting also works in this circumstance.

I'll check it, thank you! I also found other bugs related to the cache and auto-rebuild when the cache is enabled. I'll release it with a new feature soon.

[skoropadas]

🎉 This issue has been resolved in version 16.5.0 🎉

The release is available on:

• v16.5.0
• GitHub release

Your semantic-release bot 📦🚀