doc/todo/dependency_types.mdwn

   1 Ikiwiki currently only has one type of dependency between pages
   2 (plus wikilinks special cased in on the side). This has resulted in various
   3 problems, and it's seemed for a long time to me that ikiwiki needs to get
   4 smarter about what types of dependencies are supported.
   5
   6 ### unnecessary work
   7
   8 The current single dependency type causes the depending page to be rebuilt
   9 whenever a matching dependency is added, removed, or *modified*. But a
  10 great many things don't care about the modification case, and often cause
  11 unnecessary page rebuilds:
  12
  13 * meta only cares if the pages are added or removed. Content change does
  14   not matter (unless show=title is used).
  15 * brokenlinks, orphans, pagecount, ditto (generally)
  16 * inline in archive mode cares about page title, author changing, but
  17   not content. (Ditto for meta with show=title.)
  18 * Causes extra work when solving the [[bugs/transitive_dependencies]]
  19   problem.
  20
  21 ### two types of dependencies needed for [[tracking_bugs_with_dependencies]]
  22
  23 >>  it seems that there are two types of dependency, and ikiwiki
  24 >>  currently only handles one of them.  The first type is "Rebuild this
  25 >>  page when any of these other pages changes" - ikiwiki handles this.
  26 >>  The second type is "rebuild this page when set of pages referred to by
  27 >>  this pagespec changes" - ikiwiki doesn't seem to handle this.  I
  28 >>  suspect that named pagespecs would make that second type of dependency
  29 >>  more important.  I'll try to come up with a good example. -- [[Will]]
  30
  31 >>> Hrm, I was going to build an example of this with backlinks, but it
  32 >>> looks like that is handled as a special case at the moment (line 458 of
  33 >>> render.pm).  I'll see if I can breapk
  34 >>> things another way.  Fixing this properly would allow removal of that special case. -- [[Will]]
  35
  36 >>>> I can't quite understand the distinction you're trying to draw
  37 >>>> between the two types of dependencies. Backlinks are a very special
  38 >>>> case though and I'll be suprised if they fit well into pagespecs.
  39 >>>> --[[Joey]]
  40
  41 >>>>> The issue is that the existential pagespec matching allows you to build things that have similar
  42 >>>>> problems to backlinks.
  43 >>>>> e.g. the following inline:
  44
  45     \[[!inline pages="define(~done, link(done)) and link(~done)" archive=yes]]
  46
  47 >>>>> includes any page that links to a page that links to done.  Now imagine I add a new link to 'done' on
  48 >>>>> 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
  49 >>>>> pages inlined, will change.  But, there is no dependency anywhere on the page that I altered, so
  50 >>>>> ikiwiki will not rebuild the page with the inline in it.  What is happening is that the page that I altered affects
  51 >>>>> the set of pages matched by the pagespec without itself being matched by the pagespec, and hence included in the dependency list.
  52
  53 >>>>> To make this work well, I think you need to recognise two types of dependencies for each page (and no
  54 >>>>> special cases for particular types of links, eg backlinks).  The first type of dependency says, "The content of
  55 >>>>> this page depends upon the content of these other pages".  The `add_depends()` in the shortcuts
  56 >>>>> plugin is of this form: any time the shortcuts page is edited, any page with a shortcut on it
  57 >>>>> is rebuilt.  The inline plugin also needs to add dependencies of this form to detect when the inlined
  58 >>>>> content changes.  By contrast, the map plugin does not need a dependency of this form, because it
  59 >>>>> doesn't actually care about the content of any pages, just which pages it needs to include (which we'll handle next).
  60
  61 >>>>> The second type of dependency says, "The content of this page depends upon the exact set of pages matched
  62 >>>>> by this pagespec".  The first type of dependency was about the content of some pages, the second type is about
  63 >>>>> which pages get matched by a pagespec.  This is the type of dependency tracking that the map plugin needs.
  64 >>>>> 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.
  65 >>>>> Inline needs this type of dependency as well as the previous type - This type handles a change in which pages
  66 >>>>> are inlined, the previous type handles a change in the content of any of those pages.  Shortcut does not need this type of
  67 >>>>> dependency.  Most of the places that use `add_depends()` seem to need this type of dependency rather than the first type.
  68
  69 >>>>>> Note that inline and map currently achieve the second type of dependency by
  70 >>>>>> explicitly calling `add_depends` for each page the displayed.
  71 >>>>>> If any of those pages are removed, the regular pagespec would not
  72 >>>>>> match them -- since they're gone. However, the explicit dependency
  73 >>>>>> on them does cause them to match. It's an ugly corner I'd like to
  74 >>>>>> get rid of. --[[Joey]]
  75
  76 >>>>> Implementation Details:  The first type of dependency can be handled very similarly to the current
  77 >>>>> dependency system.  You just need to keep a list of pages that the content depends upon.  You could
  78 >>>>> keep that list as a pagespec, but if you do this you might want to check that the pagespec doesn't change,
  79 >>>>> possibly by adding a dependency of the second type along with the dependency of the first type.
  80
  81 >>>>>> An example of the current system not tracking enough data is
  82 >>>>>> described in [[bugs/transitive_dependencies]].
  83 >>>>>> --[[Joey]]
  84
  85 >>>>> The second type of dependency is a little more tricky.  For each page, we'd need a list of pagespecs that
  86 >>>>> the page depended on, and for each pagespec you'd want to store the list of pages that currently match it.
  87 >>>>> On refresh, you'd need to check each pagespec to see if the set of pages that match it has changed, and if
  88 >>>>> that set has changed, then rebuild the dependent page(s).  Oh, and for this second type of dependency, I
  89 >>>>> don't think you can merge pagespecs.  If I wanted to know if either "\*" or "link(done)" changes, then just checking
  90 >>>>> to see if the set of pages matched by "\* or link(done)" changes doesn't work.
  91
  92 >>>>> The current system works because even though you usually want dependencies of the second type, the set of pages
  93 >>>>> referred to by a pagespec can only change if one of those pages itself changes.  i.e. A dependency check of the
  94 >>>>> first type will catch a dependency change of the second type with current pagespecs.
  95 >>>>> This doesn't work with backlinks, and it doesn't work with existential matching.  Backlinks are currently special-cased.  I don't know
  96 >>>>> how to special-case existential matching - I suspect you're better off just getting the dependency tracking right.
  97
  98 >>>>> I also tried to come up with other possible solutions: e.g. can we find the dependencies for a pagespec?  That
  99 >>>>> 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.
 100 >>>>> For old-style pagespecs without backlinks, the dependency set for a pagespec is the same as the set of pages the pagespec matches.
 101 >>>>> Unfortunately, with existential matching, the set of pages that each
 102 >>>>> pagespec depends upon can quickly become "*", which is not very useful.  -- [[Will]]
 103
 104 ### proposal
 105
 106 I propose the following. --[[Joey]]
 107
 108 * Add a second type of dependency, call it an "contentless dependency".
 109 * `add_depends` defaults to adding a regular ("full") dependency, as
 110   before. (So nothing breaks.)
 111 * `add_depends($page, $spec, content => 0)` adds an contentless dependency.
 112 * `refresh` only looks at added/removed pages when resolving contentless
 113   dependencies.
 114
 115 This seems straightforwardly doable. I'd like [[Will]]'s feedback on it, if
 116 possible. The type types of dependencies I am proposing are not identical
 117 to the two types he talks about above, but I hope are close enough that
 118 they can be used.
 119
 120 This doesn't deal with the stuff that only depend on the metadata of a
 121 page, as collected in the scan pass, changing.  But it does leave a window
 122 open for adding such a dependency type later.
 123
 124 ----
 125
 126 I implemented the above in a branch.
 127 [[!template id=gitbranch branch=origin/dependency-types author="[[joey]]"]]
 128
 129 Then I found some problems:
 130
 131 * pagestats is often used with a pagespec that uses `tagged()`.
 132   A pure contentless dependency does not work for that, it needs to look
 133   at link info.
 134 * orphans and brokenlinks cannot use contentless dependencies because they
 135   need to update when links change.
 136 * Something simple like pagecount, that seems like it could use a
 137   contentless dependency, can have a pagespec that uses metadata, like
 138   `author()` or `copyright()`.
 139
 140 Now I'm thinking about having a contentless dependency look at page
 141 metadata, and fire if the metadata changes. And it seems links should
 142 either be included in that, or there should be a way to make a dependency
 143 that fires when a page's links change. (And what about backlinks?)
 144
 145 It's easy to see when a page's links change, since there is `%oldlinks`.
 146 To see when metadata is changed is harder, since it's stored in the
 147 pagestate by the meta plugin.
 148
 149 (Alternative: Make add_depends look at the pagespec. Ie, if it is a simple
 150 page name, or a glob, we know a contentless dependency can be valid.
 151 If's more complex, convert the dependency from contentless to full. Finding
 152 a non-ad-hoc, non-sucky way to do that could be hard.)