b073f190bb66a8e081f784fb246b88c8750e628a
[ikiwiki.git] / doc / bugs / transitive_dependencies.mdwn
1 If a sidebar contains a map, or inline (etc), one would expect a
2 change/add/remove of any of the mapped/inlined pages to cause a full wiki
3 rebuild. But this does not happen.
4
5 If page A inlines page B, which inlines page C, a change to C will cause B
6 to be updated, but A will not "notice" that this means A needs to be
7 updated.
8
9 One way to look at this bug is that it's a bug in where dependencies are
10 recorded when preprocessing the rendered or sidebar page. The current code
11 does:
12
13         add_depends($params{page}, $somepage);
14
15 Where `$params{page}` is page B. If this is changed to `$params{destpage}`,
16 then the dependency is added to page A, and updates to C cause it to
17 change. This does result in the page A's getting lots more dependency info
18 recorded than before (essentially a copy of all the B's dependency info).
19
20 It's also a fragile, since all plugins that handle dependencies have to be
21 changed, and do this going forward. And it seems non-obvious that this should
22 be done. Or really, whether to use `page` or `destpage` there. Currently,
23 making the "wrong" choice and using `destpage` instead of `page` (which nearly
24 everything uses) will just result in semi-redundant dependency info being
25 recorded. If we make destpage mandatory to fix this, goofing up will lead to
26 this bug coming back. Ugh.
27
28 ----
29
30 ## rebuild = change approach
31
32 [[!template id=gitbranch branch=origin/transitive-dependencies author="[[joey]]"]]
33
34 Another approach to fix it is to say that anything that causes a
35 rebuild of B is treated as a change of B. Then when C is changed, B is
36 rebuilt due to dependencies, and in turn this means A is rebuilt because B
37 "changed". 
38
39 This is essentially what is done with wikilinks now, and why, if a sidebar
40 links to page C, add/remove of C causes all pages to be rebuilt, as seen 
41 here:
42
43         removing old page meep
44         building sidebar.mdwn, which links to meep
45         building TourBusStop.mdwn, which depends on sidebar
46         building contact.mdwn, which depends on sidebar
47         ...
48
49 Downsides here:
50
51 * Means a minimum of 2x as much time spent resolving dependencies,
52   at least in my simple implementation, which re-runs the dependency
53   resolution loop until no new pages are rebuilt.
54   (I added an optimisation that gets it down to 1.5X as much work on
55   average, still 2x as much worst case. I suppose building a directed
56   graph and traversing it would be theoretically more efficient.)
57 * Causes extra work for some transitive dependencies that we don't
58   actually care about. For example, changing index causes
59   plugins/brokenlinks to update in the first pass; if there's a second
60   pass, plugins/map is then updated, because it depends on plugins/brokenlinks.
61   (Of course, this is just a special case of the issue that a real
62   modification to plugins/brokenlinks causes an unnecessary update of plugins/map,
63   because we have [[only_one_kind_of_dependency|todo/dependency_types]].)
64   (Fixed now for cases like this one where contenless dependencies avoid
65   the unnecessary work.)
66
67 --[[Joey]]