Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Partially call site.process on production #294

Closed
wants to merge 4 commits into from
Closed

Conversation

mertkahyaoglu
Copy link
Member

Fixes #289

As @parkr explains the problem here, the two threads (one for API and one for Jekyll) that Jekyll Admin boots up are overlapping somehow and causing a confusion in some cases, for example, writing to a file.

The solution I can think of for this problem is to call site.process partially since some of the methods are already called after regeneration. (correct me if I'm wrong)

I only used site.read which gets the site data from the filesystem and stores it in internal data structures to be able to send the newly created pages/documents to the front end properly.

For the tests to pass, I added a check whether ENV variable is set or not. If so, it calls complete site.process since site regeneration is not available for tests.

@parkr, @benbalter Let me know if this is a good solution. Looks like it worked for me.

@mertkahyaoglu
Copy link
Member Author

mertkahyaoglu commented Feb 21, 2017

@parkr @benbalter Is this good to go? I would love to resolve this before the upcoming release :shipit:

site.process
else
site.read
end
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you explain what are you trying to do here? I'm afraid I'm having trouble following.

Copy link
Member Author

@mertkahyaoglu mertkahyaoglu Feb 21, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm trying try to eliminate the overlapping parts between two threads (regeneration and api server).

Does incremental regeneration call any methods from site.process ? If so, calling them again after writing to a file might cause a confusion. Do we really need to call all methods of site.process, rather than just a few ones that are really necessary for the API ? Because when I use only site.read, everything seems to work.

The if statement there is for tests to pass.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@parkr See #289 (comment) for context. Is the race condition in the write? In the read? In the generate? Any way to unthread things? We need to write and generate so previews work.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This isn't really a race condition in the traditional sense. We boot up a Watcher from jekyll-watch which runs site.process every time a file saved. The issue here appears to be: if opts["watch"] && opts["serving"] are passed to Jekyll, then the watcher in another thread runs site.process and you're also trying to run site.process at the same time and it can cause confusion. I think if there's another Jekyll process running, the call to site.process is not necessary here at all. Can you get away with just calling site.read?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you get away with just calling site.read?

Will that introduce a race condition if the file isn't yet written to disk?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will that introduce a race condition if the file isn't yet written to disk?

Yeah, I encountered that once but comparing with the current version, this is an improvement 😄

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What if, instead, we disable watch and manually call site.process (which should then be blocking). As of right now, each write will require two reads (and I believe now, two full processes).

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That makes sense. However I have no idea how to disable it.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@parkr any bright ideas? We'd need to force watch to false. Perhaps the same way we do for the Pages gem?

@mertkahyaoglu
Copy link
Member Author

mertkahyaoglu commented Mar 9, 2017

Should I merge this as a temporary(not complete) solution for now ?

@parkr
Copy link
Member

parkr commented Mar 9, 2017

I think we're whacking this with a way bigger stick than we need to. I chatted with @benbalter and it sounds like we can simply read in the document using the various Jekyll classes and throw it away when the request is done. I'm writing up a PR now.

@mertkahyaoglu
Copy link
Member Author

mertkahyaoglu commented Mar 9, 2017

@park Awesome 🎉

Closing in favor of #320

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants