split out dependency type issue into its own todo
[ikiwiki.git] / doc / todo / dependency_types.mdwn
1 Moved this relevant discussion to here from
2 [[tracking_bugs_with_dependencies]]: --[[Joey]]
3
4 >>  it seems that there are two types of dependency, and ikiwiki
5 >>  currently only handles one of them.  The first type is "Rebuild this
6 >>  page when any of these other pages changes" - ikiwiki handles this.
7 >>  The second type is "rebuild this page when set of pages referred to by
8 >>  this pagespec changes" - ikiwiki doesn't seem to handle this.  I
9 >>  suspect that named pagespecs would make that second type of dependency
10 >>  more important.  I'll try to come up with a good example. -- [[Will]]
11
12 >>> Hrm, I was going to build an example of this with backlinks, but it
13 >>> looks like that is handled as a special case at the moment (line 458 of
14 >>> render.pm).  I'll see if I can breapk
15 >>> things another way.  Fixing this properly would allow removal of that special case. -- [[Will]]
16
17 >>>> I can't quite understand the distinction you're trying to draw
18 >>>> between the two types of dependencies. Backlinks are a very special
19 >>>> case though and I'll be suprised if they fit well into pagespecs.
20 >>>> --[[Joey]] 
21
22 >>>>> The issue is that the existential pagespec matching allows you to build things that have similar
23 >>>>> problems to backlinks.
24 >>>>> e.g. the following inline:
25
26     \[[!inline pages="define(~done, link(done)) and link(~done)" archive=yes]]
27
28 >>>>> includes any page that links to a page that links to done.  Now imagine I add a new link to 'done' on
29 >>>>> some random page somewhere - a page which some other page links to which didn't previously get included - the set of pages accepted by the pagespec, and hence the set of
30 >>>>> pages inlined, will change.  But, there is no dependency anywhere on the page that I altered, so
31 >>>>> ikiwiki will not rebuild the page with the inline in it.  What is happening is that the page that I altered affects
32 >>>>> the set of pages matched by the pagespec without itself being matched by the pagespec, and hence included in the dependency list.
33
34 >>>>> To make this work well, I think you need to recognise two types of dependencies for each page (and no
35 >>>>> special cases for particular types of links, eg backlinks).  The first type of dependency says, "The content of
36 >>>>> this page depends upon the content of these other pages".  The `add_depends()` in the shortcuts
37 >>>>> plugin is of this form: any time the shortcuts page is edited, any page with a shortcut on it
38 >>>>> is rebuilt.  The inline plugin also needs to add dependencies of this form to detect when the inlined
39 >>>>> content changes.  By contrast, the map plugin does not need a dependency of this form, because it
40 >>>>> doesn't actually care about the content of any pages, just which pages it needs to include (which we'll handle next).
41
42 >>>>> The second type of dependency says, "The content of this page depends upon the exact set of pages matched
43 >>>>> by this pagespec".  The first type of dependency was about the content of some pages, the second type is about
44 >>>>> which pages get matched by a pagespec.  This is the type of dependency tracking that the map plugin needs.
45 >>>>> If the set of pages matched by map pagespec changes, then the page with the map on it needs to be rebuilt to show a different list of pages.
46 >>>>> Inline needs this type of dependency as well as the previous type - This type handles a change in which pages
47 >>>>> are inlined, the previous type handles a change in the content of any of those pages.  Shortcut does not need this type of
48 >>>>> dependency.  Most of the places that use `add_depends()` seem to need this type of dependency rather than the first type.
49
50 >>>>>> Note that inline and map currently achieve the second type of dependency by
51 >>>>>> explicitly calling `add_depends` for each page the displayed.
52 >>>>>> If any of those pages are removed, the regular pagespec would not
53 >>>>>> match them -- since they're gone. However, the explicit dependency
54 >>>>>> on them does cause them to match. It's an ugly corner I'd like to
55 >>>>>> get rid of. --[[Joey]]
56
57 >>>>> Implementation Details:  The first type of dependency can be handled very similarly to the current
58 >>>>> dependency system.  You just need to keep a list of pages that the content depends upon.  You could
59 >>>>> keep that list as a pagespec, but if you do this you might want to check that the pagespec doesn't change,
60 >>>>> possibly by adding a dependency of the second type along with the dependency of the first type.
61
62 >>>>>> An example of the current system not tracking enough data is 
63 >>>>>> described in [[bugs/transitive_dependencies]].
64 >>>>>> --[[Joey]] 
65
66 >>>>> The second type of dependency is a little more tricky.  For each page, we'd need a list of pagespecs that
67 >>>>> the page depended on, and for each pagespec you'd want to store the list of pages that currently match it.
68 >>>>> On refresh, you'd need to check each pagespec to see if the set of pages that match it has changed, and if
69 >>>>> that set has changed, then rebuild the dependent page(s).  Oh, and for this second type of dependency, I
70 >>>>> don't think you can merge pagespecs.  If I wanted to know if either "\*" or "link(done)" changes, then just checking
71 >>>>> to see if the set of pages matched by "\* or link(done)" changes doesn't work.
72
73 >>>>> The current system works because even though you usually want dependencies of the second type, the set of pages
74 >>>>> referred to by a pagespec can only change if one of those pages itself changes.  i.e. A dependency check of the
75 >>>>> first type will catch a dependency change of the second type with current pagespecs.
76 >>>>> This doesn't work with backlinks, and it doesn't work with existential matching.  Backlinks are currently special-cased.  I don't know
77 >>>>> how to special-case existential matching - I suspect you're better off just getting the dependency tracking right.
78
79 >>>>> I also tried to come up with other possible solutions: e.g. can we find the dependencies for a pagespec?  That
80 >>>>> would be the set of pages where a change on one of those pages could lead to a change in the set of pages matched by the pagespec.
81 >>>>> For old-style pagespecs without backlinks, the dependency set for a pagespec is the same as the set of pages the pagespec matches.
82 >>>>> Unfortunately, with existential matching, the set of pages that each
83 >>>>> pagespec depends upon can quickly become "*", which is not very useful.  -- [[Will]]