202 lines
9.5 KiB
Markdown
202 lines
9.5 KiB
Markdown
# React Tutorial - Part 4: Workspace Optimization
|
|
|
|
## Testing Affected Projects
|
|
|
|
`affected` is a mechanism that relies on your git metadata to determine the projects in your workspace that were affected by a given commit.
|
|
|
|
Run the command:
|
|
|
|
```shell
|
|
git add . && git commit -m "commiting to test affected"
|
|
```
|
|
|
|
Then make a change to the styles of your `common-ui` project:
|
|
|
|
```css {% fileName="libs/common-ui/src/lib/common-ui.module.css" %}
|
|
.container {
|
|
color: 'blue;';
|
|
}
|
|
```
|
|
|
|
You can visualize how our workspace is affected by this change using the command:
|
|
|
|
```shell
|
|
npx nx affected:graph
|
|
```
|
|
|
|
|
|
|
|
The change made to the `common-ui` project is also affecting the `admin` and `store` projects. This can be leveraged run tasks only on the projects that were affected by this commit.
|
|
|
|
To run the `test` targets only for affected projects, run the command:
|
|
|
|
```shell
|
|
npx nx affected --target=test
|
|
```
|
|
|
|
This can be particularly helpful in CI pipelines for larger repos, where most commits only affect a small subset of the entire workspace.
|
|
|
|
{% card title="Affected Documentation" description="Checkout Affected documentation for more details" url="/nx/affected" /%}
|
|
|
|
## Task Caching
|
|
|
|
`affected` allows you to "skip" tasks that couldn't possibly be affected by your changes. Task Caching allows you to "replay" tasks that have already been run.
|
|
|
|
Task Caching is informed by "inputs" and "outputs":
|
|
|
|
### Inputs
|
|
|
|
Inputs for your task caching includes by default any environment details and all the source code of the projects and dependencies affecting your project.
|
|
|
|
When running a task, Nx will determine all the inputs for your task and create a hash that will be used to index your cache. If you've already run this task with the same inputs, your cache will already be populated at this index, and Nx will replay the results stored in the cache.
|
|
|
|
If this index does not exist, Nx will run the command and if the command succeeds, it will store the result in the cache.
|
|
|
|
### Outputs
|
|
|
|
Outputs of the cache include the terminal output created by the task, as well as any files created by the task - for example: the artifact created by running a `build` task.
|
|
|
|
Outputs are defined for every target in your workspace:
|
|
|
|
```json {% fileName="libs/products/project.json" %}
|
|
{
|
|
"name": "products",
|
|
"$schema": "../../node_modules/nx/schemas/project-schema.json",
|
|
"sourceRoot": "libs/products/src",
|
|
"projectType": "library",
|
|
"targets": {
|
|
"build": {
|
|
"executor": "@nrwl/js:tsc",
|
|
"outputs": ["{options.outputPath}"],
|
|
"options": {
|
|
"outputPath": "dist/libs/products",
|
|
"main": "libs/products/src/index.ts",
|
|
"tsConfig": "libs/products/tsconfig.lib.json",
|
|
"assets": ["libs/products/*.md"]
|
|
}
|
|
},
|
|
"lint": {
|
|
"executor": "@nrwl/linter:eslint",
|
|
"outputs": ["{options.outputFile}"],
|
|
"options": {
|
|
"lintFilePatterns": ["libs/products/**/*.ts"]
|
|
}
|
|
},
|
|
"test": {
|
|
"executor": "@nrwl/jest:jest",
|
|
"outputs": ["{workspaceRoot}/coverage/libs/products"],
|
|
"options": {
|
|
"jestConfig": "libs/products/jest.config.ts",
|
|
"passWithNoTests": true
|
|
}
|
|
}
|
|
},
|
|
"tags": []
|
|
}
|
|
```
|
|
|
|
Outputs are stored in the cache so that terminal output can be replayed, and any created files can be pulled from your cache, and placed where they were created the original time the task was run.
|
|
|
|
### Example
|
|
|
|
To see caching in action, run the command:
|
|
|
|
```{% command="npx nx build admin" path="~/myorg" %}
|
|
|
|
> nx run admin:build:production
|
|
|
|
Entrypoint main 139 KiB = runtime.54e36ebee261465d.js 1.19 KiB main.623d91691bdb6754.css 42 bytes main.303fe7c1dcf5306b.js 137 KiB
|
|
Entrypoint polyfills 93.5 KiB = runtime.54e36ebee261465d.js 1.19 KiB polyfills.bd0d0abec287a28e.js 92.3 KiB
|
|
Entrypoint styles 1.19 KiB = runtime.54e36ebee261465d.js 1.19 KiB styles.ef46db3751d8e999.css 0 bytes
|
|
chunk (runtime: runtime) main.623d91691bdb6754.css, main.303fe7c1dcf5306b.js (main) 144 KiB (javascript) 50 bytes (css/mini-extract) [initial] [rendered]
|
|
chunk (runtime: runtime) polyfills.bd0d0abec287a28e.js (polyfills) 301 KiB [initial] [rendered]
|
|
chunk (runtime: runtime) styles.ef46db3751d8e999.css (styles) 50 bytes (javascript) 80 bytes (css/mini-extract) [initial] [rendered]
|
|
chunk (runtime: runtime) runtime.54e36ebee261465d.js (runtime) 3.23 KiB [entry] [rendered]
|
|
webpack compiled successfully (0c0df3e6c70c6b7b)
|
|
|
|
———————————————————————————————————————————————————————————————————————————————————————————————————
|
|
|
|
> NX Successfully ran target build for project admin (4s)
|
|
```
|
|
|
|
Since you have not run the `build` target before for the `admin` project, Nx runs the `build`, and populates the results in `dist/apps/admin` as specified in the `admin` project's `project.json` file for the `build` target.
|
|
|
|
Next, remove your dist directory:
|
|
|
|
```shell
|
|
rm -rf dist
|
|
```
|
|
|
|
And run the command again:
|
|
|
|
```{% command="npx nx build admin" path="~/myorg" %}
|
|
|
|
> nx run admin:build:production [local cache]
|
|
|
|
Entrypoint main 139 KiB = runtime.54e36ebee261465d.js 1.19 KiB main.623d91691bdb6754.css 42 bytes main.303fe7c1dcf5306b.js 137 KiB
|
|
Entrypoint polyfills 93.5 KiB = runtime.54e36ebee261465d.js 1.19 KiB polyfills.bd0d0abec287a28e.js 92.3 KiB
|
|
Entrypoint styles 1.19 KiB = runtime.54e36ebee261465d.js 1.19 KiB styles.ef46db3751d8e999.css 0 bytes
|
|
chunk (runtime: runtime) main.623d91691bdb6754.css, main.303fe7c1dcf5306b.js (main) 144 KiB (javascript) 50 bytes (css/mini-extract) [initial] [rendered]
|
|
chunk (runtime: runtime) polyfills.bd0d0abec287a28e.js (polyfills) 301 KiB [initial] [rendered]
|
|
chunk (runtime: runtime) styles.ef46db3751d8e999.css (styles) 50 bytes (javascript) 80 bytes (css/mini-extract) [initial] [rendered]
|
|
chunk (runtime: runtime) runtime.54e36ebee261465d.js (runtime) 3.23 KiB [entry] [rendered]
|
|
webpack compiled successfully (0c0df3e6c70c6b7b)
|
|
|
|
———————————————————————————————————————————————————————————————————————————————————————————————————
|
|
|
|
> NX Successfully ran target build for project admin (59ms)
|
|
|
|
Nx read the output from the cache instead of running the command for 1 out of 1 tasks.
|
|
```
|
|
|
|
Notice that `[local cache]` is mentioned in the terminal output, and that this time the command only took 59ms to run.
|
|
|
|
Also notice that the result of your build has been added back to the `dist/apps/admin` directory.
|
|
|
|
{% card title="More Task Caching Details" description="See the documentation for more information on caching." url="/core-features/cache-task-results" /%}
|
|
|
|
## Configuring Task Pipelines
|
|
|
|
Next, run the command `npx nx build store`:
|
|
|
|
```{% command="npx nx build store" path="~/myorg" %}
|
|
|
|
✔ 1/1 dependent project tasks succeeded [0 read from cache]
|
|
|
|
Hint: you can run the command with --verbose to see the full dependent project outputs
|
|
|
|
———————————————————————————————————————————————————————————————————————————————————————————————————
|
|
|
|
|
|
> nx run store:build:production
|
|
|
|
Entrypoint main 139 KiB = runtime.54e36ebee261465d.js 1.19 KiB main.623d91691bdb6754.css 42 bytes main.94f9a4a3cec4f056.js 138 KiB
|
|
Entrypoint polyfills 93.5 KiB = runtime.54e36ebee261465d.js 1.19 KiB polyfills.bd0d0abec287a28e.js 92.3 KiB
|
|
Entrypoint styles 1.19 KiB = runtime.54e36ebee261465d.js 1.19 KiB styles.ef46db3751d8e999.css 0 bytes
|
|
chunk (runtime: runtime) main.623d91691bdb6754.css, main.94f9a4a3cec4f056.js (main) 145 KiB (javascript) 50 bytes (css/mini-extract) [initial] [rendered]
|
|
chunk (runtime: runtime) polyfills.bd0d0abec287a28e.js (polyfills) 301 KiB [initial] [rendered]
|
|
chunk (runtime: runtime) styles.ef46db3751d8e999.css (styles) 50 bytes (javascript) 80 bytes (css/mini-extract) [initial] [rendered]
|
|
chunk (runtime: runtime) runtime.54e36ebee261465d.js (runtime) 3.23 KiB [entry] [rendered]
|
|
webpack compiled successfully (06e95dfdacea84c7)
|
|
|
|
———————————————————————————————————————————————————————————————————————————————————————————————————
|
|
|
|
> NX Successfully ran target build for project store and 1 task(s) it depends on (5s)
|
|
```
|
|
|
|
Notice the line here:
|
|
|
|
```text
|
|
✔ 1/1 dependent project tasks succeeded [0 read from cache]
|
|
```
|
|
|
|
This is because your `store` project depends on your `products` project, which also has a `build` target. By default Nx is configured to run the `build` target for any dependencies that have a `build` target, before running the `build` on the original project.
|
|
|
|
This feature allows the Nx graph to dynamically maintain task dependencies, rather than having to manually maintain those task dependencies as your workspace continues to grow.
|
|
|
|
{% card title="More On The Task Pipeline Configuration" description="See the Task Pipeline Configuration Guide for more details on how to configure your Task Graph." url="/concepts/task-pipeline-configuration" /%}
|
|
|
|
## What's Next
|
|
|
|
- Continue to [5: Summary](/react-tutorial/5-summary)
|