Skip to content

Commit 05c41e3

Browse files
committed
docs(documentation): Update design
1 parent c980d1b commit 05c41e3

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

rfcs/0017-incremental-build.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ The `Task Runner` shall be enhanced to:
106106
3. Before executing a task, call the `determineExpectedOutput` method if provided. This allows the task to specify which resources it expects to write during its execution. The `Project Build Cache` can then use this information to detect and remove stale output resources that were produced in a previous execution of the task, but are no longer produced in the current execution.
107107
4. Execute the task with a new `cacheUtil` parameter, allowing it to access cache-related information during its execution. This can be used by tasks to optimize their processing based on which resources have changed since their last execution (see [Build Task Cache API](#build-task-cache-api) below).
108108
5. After a task has been executed, update the `Project Build Cache` with information about the resources read and written during the task's execution, as well as the set of resources expected to be written (as provided by the `determineExpectedOutput` method).
109-
* This can be achieved by providing the task with instances of the `workspace`-reader/writer and `dependencies`-reader that have been wrapped in `Tracker` instances. These trackers will monitor which resources are being accessed during the task's execution.
109+
* This can be achieved by providing the task with instances of the `workspace`-reader/writer and `dependencies`-reader that have been wrapped in ["Monitor"](#monitor) instances. They are responsible for observing which resources are being accessed during the task's execution.
110110
* The `Project Build Cache` will then:
111111
* Update the metadata in the respective `Build Task Cache`
112112
* Validate which resources have actually changed
@@ -140,9 +140,9 @@ In addition, tasks may also implement the following new methods:
140140

141141
These methods took some inspiration from to the existing [`determineRequiredDependencies` method](https://github.com/UI5/cli/blob/main/rfcs/0012-UI5-Tooling-Extension-API-3.md#new-api-2) ([docs](https://ui5.github.io/cli/stable/pages/extensibility/CustomTasks/#required-dependencies)).
142142

143-
#### Tracker
143+
#### Monitor
144144

145-
A `Tracker` is a wrapper around a `Reader` or `Writer` instance that monitors which resources are being accessed during its usage. It records the paths of resources that are read or written, along with the respective [`Resource`](https://ui5.github.io/cli/stable/api/@ui5_fs_Resource.html) instance. It also tracks which glob patterns have been used to request resources.
145+
A `Monitor` is a wrapper around a `Reader` or `Writer` instance that observes which resources are being accessed during its usage. It records the paths of resources that are read or written, along with the respective [`Resource`](https://ui5.github.io/cli/stable/api/@ui5_fs_Resource.html) instance. It also records which glob patterns have been used to request resources.
146146

147147
### Cache Creation
148148

@@ -229,16 +229,17 @@ The cache consists of two main parts:
229229
}
230230
}
231231
},
232-
"stages": {
233-
"task/replaceCopyright": { // Type and task name
232+
"stages": [
233+
"task/replaceCopyright",
234+
{
234235
// Virtual paths written by the task during execution, mapped to their cache metadata
235236
"/resources/project/namespace/Component.js": {
236237
"lastModified": 176468853453,
237238
"size": 4567,
238239
"integrity": "sha256-EvQbHDId8MgpzlgZllZv3lKvbK/h0qDHRmzeU+bxPMo="
239240
}
240241
}
241-
}
242+
]
242243
}
243244
}
244245
````

0 commit comments

Comments
 (0)