# Workspace Settings (Deprecated)

{% hint style="warning" %}
This content has been deprecated.

Please see [this](https://github.com/island-is/island.is/blob/main/apps/system-e2e/README.md) document for our latest strategy in E2E testing.
{% endhint %}

Various project settings can be controlled from the `project.json` file, located in each project folder.

## E2E Testing Configuration

The default Nx setup for E2E tests is experiencing timeouts during some of our tests. This is due to long build and compile time of `NextJS` apps. In effort to optimize this process we have created an `e2e-ci.js` script in the `scripts/` directory. It starts by creating a production build of the app under testing, before starting the Cypress tests. Following is a documentation of the configuration needed to enable the `e2e-ci` task.

### Pre-requisites

#### Setting API\_MOCKS

**NextJS**

We need to make sure that the `API_MOCKS` environment variable is set in the `next.config.js`

```javascript
// ...
serverRuntimeConfig: {
  // ...
},
publicRuntimeConfig: {
  // ...
},
env: {
  API_MOCKS: process.env.API_MOCKS,
},
```

**React**

For React apps we have a common webpack config in `libs/share/webpack` which we use to make sure the `API_MOCKS` environment variable is set, along with other common plugins and settings.

Your `webpack.config.js` should look like this:

```javascript
// eslint-disable-next-line @typescript-eslint/no-var-requires
const nrwlConfig = require('./../../libs/shared/webpack/nrwl-config')

module.exports = (config, context) => {
  // Add our common webpack config
  nrwlConfig(config)

  // Here you can add app specific config

  return config
}
```

#### devServerTarget and Cypress baseUrl

We need to set the `devServerTarget` for the `production` config of the `e2e` task for the corresponding `e2e` project.

We also need to let Cypress now what the `baseUrl` of our app is (as we are running it manually). That is done by adding `baseUrl` to the `options` key of the `e2e` task.

See the following example for the `web` project:

```json
"e2e": {
  "executor": "@nx/cypress:cypress",
  "options": {
    "cypressConfig": "apps/web-e2e/cypress.config.ts",
    "tsConfig": "apps/web-e2e/tsconfig.e2e.json",
    "baseUrl": "http://localhost:4200",
    "devServerTarget": "web:serve"
  },
  "configurations": {
    "production": {
      "devServerTarget": ""
    }
  }
},
```

### Add `e2e-ci` task

Finally we need to add a `e2e-ci` task to the `architect` property of the corrensponding `e2e` project.

#### NextJS

```json
"e2e-ci": {
  "executor": "@nx/workspace:run-commands",
  "options": {
    "command": "yarn e2e-ci -n web-e2e -d dist/apps/web"
  }
},
```

#### React

```json
"e2e-ci": {
  "executor": "@nx/workspace:run-commands",
  "options": {
    "command": "yarn e2e-ci -n service-portal-e2e -t react -f dist/apps/service-portal -b /minarsidur"
  }
},
```

#### Configure

The `e2e-ci.js` script requires few parameters:

* `-n` - Required. The name of the e2e project. The script uses this name to find the name of the target app (by stripping of the `-e2e` ending).
* `-d` - Required. Sets the output directory for the production build.
* `-s` - Boolean to indicate if to use `--skip-nx-cache`
* `-t` - Only for React. Sets the app type to `react`.
* `-b` - Optional for React. If the app is deployed to a sub-directory, that is the `base` in `index.html` this option is needed to set that path.

Further details can be found be using the `-h` parameter for the script:

```
node scripts/e2e-ci.js -h
```

### E2E test locally

To test e2e locally it can either be done like before using the `e2e`task

```bash
yarn e2e web-e2e
```

or using the `e2e-ci` task

```bash
yarn nx run web-e2e:e2e-ci
```

### E2E in CI

This task is executed as part of our GitHub CI pipeline via the `40_e2e.sh`.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.devland.is/development/workspace-settings.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.