Skip to content

[RFC] 0014 Task Workers #897

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.

Sign up for GitHub

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

Open
wants to merge 14 commits into
base: main
Choose a base branch
from
Open

[RFC] 0014 Task Workers #897

Changes from 1 commit
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
a393f2e
Add RFC0014: Task Workers
RandomByte Nov 10, 2023
62722e5
Add diagram
RandomByte Nov 10, 2023
aa2b93d
Link PR
RandomByte Nov 10, 2023
7ec9327
Update terminology
RandomByte Nov 13, 2023
54006d8
Update processor signatures, terms and diagram
RandomByte Nov 13, 2023
c0fc4fe
Formatting
RandomByte Nov 13, 2023
9d4cb25
Add motivation for disabling workers
RandomByte Nov 14, 2023
025954c
Update based on latest discussions
RandomByte Nov 22, 2023
1326b0c
Explain task processor execution order in more detail
RandomByte Nov 23, 2023
4d09820
Update API signatures
RandomByte Nov 27, 2023
69756bf
Formatting: Convert tabs to spaces
RandomByte Nov 27, 2023
bc48b2f
Update configuration options
RandomByte Dec 8, 2023
d63565b
Decide on configuration option
RandomByte Dec 18, 2023
94f04fd
Wording and detail updates
RandomByte Dec 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 22 additions & 4 deletions rfcs/0014-task-workers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@ With this RFC, we extend this concept to custom tasks. A task can define one or
* **`resources`**: An array of `@ui5/fs/Resource` provided by the task
* **`options`**: An object provided by the task
* **`fs`**: An optional fs-interface provided by the task
* **`log`**: A @ui5/logger instance. TODO: Should the log messages be printed directly or sent back to the main thread (and grouped there)?
* **`resourceFactory`** Specification-version dependent object providing helper functions to create and manage resources.
- **`resourceFactory.createResource`** Creates a `@ui5/fs/Resource` (similar to [TaskUtil#resourceFactory.createResource](https://sap.github.io/ui5-tooling/stable/api/@ui5_project_build_helpers_TaskUtil.html#~resourceFactory))
- No other API for now and now general "ProcessorUtil" or similar, since processors should remain as UI5 Tooling independent as possible
Expand Down Expand Up @@ -133,7 +134,7 @@ return [
]
```

#### Example
#### Processor Example

```js
/**
Expand All @@ -146,7 +147,7 @@ return [
* @param {@ui5/project/ProcessorResourceFactory} parameters.resourceFactory Helper object providing functions for creating and managing resources
* @returns {Promise<object|Array|@ui5/fs/Resource|@ui5/fs/Resource[]>} Promise resolving with either a flat object containing Resource instances as values, or an array of Resources
*/
module.exports = function({resources, options, fs, resourceFactory}) {
module.exports = function({resources, options, fs, log, resourceFactory}) {
// [...]
};
````
Expand All @@ -161,10 +162,24 @@ metadata:
name: pi
task:
path: lib/tasks/pi.js
# Option 1
processors:
computePi: lib/tasks/piProcessor.js

# Option 2
processors:
- name: computePi
path: lib/tasks/piProcessor.js


# Option 3
processors:
computePi:
path: lib/tasks/piProcessor.js
```

**TODO:** Decide on configuration style. Option 1 does not allow for introducing additional per-processor configuration in the future (e.g. max CPU threads, priority, etc.)
Copy link
Member

Choose a reason for hiding this comment

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

I find option 3 the most consistent one, as it has a very similar structure as the task itself, and order does not matter (right?), so there's no reason for option 2.

Copy link
Member Author

Choose a reason for hiding this comment

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

I agree and updated that part


### Task API

Tasks defining processors in their `ui5.yaml` configuration shall be provided with a new `processors` object, allowing them to trigger execution of the configured processors.
Expand All @@ -177,20 +192,23 @@ The `processors.execute` function shall accept the following parameters:

The `execute` function shall validate that `resources` only contains `@ui5/fs/Resource` instances and that `options` adheres to the requirements stated in [Serializing Data](#serializing-data).

#### Task Example

```js
/**
* Custom task example
*
* @param {Object} parameters Parameters
* @param {DuplexCollection} parameters.workspace DuplexCollection to read and write files
* @param {AbstractReader} parameters.dependencies Reader or Collection to read dependency files
* @param {@ui5/project/build/helpers/TaskUtil|object} [parameters.taskUtil] TaskUtil
* @param {object} processors
* @param {Object} parameters.options Options
* @param {string} parameters.options.projectName Project name
* @param {string} [parameters.options.configuration] Task configuration if given in ui5.yaml
* @param {object} processors
* @returns {Promise<undefined>} Promise resolving with undefined once data has been written
*/
module.exports = function({workspace, options, processors}) {
module.exports = function({workspace, taskUtil, processors, options}) {
const res = await processors.execute("computePi", {
resources: [workspace.byPath("/already-computed.txt")] // Input resources
options: { // Processor configuration
Expand Down