Removing Cyclical Dependencies In User-Flow Tests

[ChristopherPHolder]

Removing Cyclical Dependencies In User-Flow

• This is a blocker for migrating to esbuild
  • Blocker for migrating to vitest
  • Blocker to migrating to lighthouse +v10
• Improve the quality of the codebase.

Current State:

There are to sources of cyclical dependencies in user-flow both of which are related to testing

• cli <-> user-flow-cli-testing
• cli -> test-data -> user-flow-cli-testing -> cli

Cyclical Dependencies between the cli and user-flow-cli-testing

What is user-flow-cli-testing?

It is a testing utils lib that is used to facilitate the testing of certain parts of the cli.

Usage

This library seems to be imported in 3 other libraries

cli

• Imported 5 times

1. packages/cli/src/lib/commands/collect/utils/persist/persist-flow.test.ts

• UserFlowCliProject
• UserFlowCliProjectFactory

2. packages/cli/src/lib/commands/collect/utils/user-flow/load-flow.test.ts

• UserFlowCliProject,
• UserFlowCliProjectFactory,
• UserFlowProjectConfig

3. packages/cli/src/lib/commands/init/processes/generate-userflow.test.ts

• withUserFlowProject

4. packages/cli/src/lib/global/cli-mode/cli.mode.test.ts

• setupEnvVars
• teardownEnvVars

5. packages/cli/src/lib/pre-set.test.ts

• setupEnvVars
• teardownEnvVars

sandbox

• Imported 14 times

1. packages/sandbox/e2e/cli/configuration.test.ts

• UserFlowCliProject
• UserFlowCliProjectFactory
• UserFlowProjectConfig

2. packages/sandbox/e2e/commands/collect/collect-configuration.test.ts

• SANDBOX_BASE_RC_JSON
• UserFlowCliProject
• UserFlowCliProjectFactory

3. packages/sandbox/e2e/commands/collect/collect.budgets.test.ts

• DEFAULT_RC_NAME
• LH_NAVIGATION_BUDGETS_NAME_DEFAULT
• UserFlowCliProject
• UserFlowCliProjectFactory
• UserFlowProjectConfig

4. packages/sandbox/e2e/commands/collect/collect.config.test.ts

• UserFlowCliProject
• UserFlowCliProjectFactory
• UserFlowProjectConfig
• withUserFlowProject

5. packages/sandbox/e2e/commands/collect/collect.dry-run.test.ts

• UserFlowCliProject
• UserFlowCliProjectFactory

6. packages/sandbox/e2e/commands/collect/collect.format.test.ts

• UserFlowCliProject
• UserFlowCliProjectFactory

7. packages/sandbox/e2e/commands/collect/collect.ufPath.test.ts

• UserFlowCliProject
• UserFlowCliProjectFactory

8. packages/sandbox/e2e/commands/init/init-configuration.test.ts

• SANDBOX_BASE_RC_JSON
• UserFlowCliProject
• UserFlowCliProjectFactory

9. packages/sandbox/e2e/commands/init/init.test.ts

• ENTER
• SANDBOX_BASE_RC_JSON
• UserFlowCliProject
• UserFlowCliProjectFactory
• withUserFlowProject

10. packages/sandbox/e2e/commands/init/rc-config.test.ts

• CLI_DEFAULT_RC_JSON,
• DECLINE_BOOLEAN,
• ENTER,
• SANDBOX_BASE_RC_JSON,
• UserFlowCliProject,
• UserFlowCliProjectFactory

11. packages/sandbox/e2e/jest/expect.collect.budget.ts

• UserFlowCliProject

12. packages/sandbox/e2e/jest/expect.collect.format.ts

• UserFlowCliProject

13. packages/sandbox/e2e/jest/expect.collect.ts

• UserFlowCliProject

14. packages/sandbox/e2e/jest/expect.ts

• UserFlowCliProject

test-data

• Imported 8 times

1. packages/test-data/src/lib/config/lh-config.ts

• LhConfigJson

2. packages/test-data/src/lib/sandboxes/empty/cfg.ts

• UserFlowProjectConfig

3. packages/test-data/src/lib/sandboxes/initialized/cfg.ts

• UserFlowProjectConfig

4. packages/test-data/src/lib/sandboxes/remote/cfg.ts

• DEFAULT_RC_NAME
• UserFlowProjectConfig

5. packages/test-data/src/lib/sandboxes/remote/rc.ts

• RcJson
• SANDBOX_BASE_RC_JSON

6. packages/test-data/src/lib/sandboxes/static/cfg.ts

• UserFlowProjectConfig, DEFAULT_RC_NAME

7. packages/test-data/src/lib/sandboxes/static/rc.ts

• RcJson,
• SANDBOX_BASE_RC_JSON
• SERVE_COMMAND_PORT

8. packages/test-data/src/lib/sandboxes/user-flowrc.base.ts

• DEFAULT_COLLECT_UF_PATH
• DEFAULT_COLLECT_URL
• DEFAULT_PERSIST_OUT_PATH
• getEnvPreset
• RcJson
• ReportFormat

---

Concat and sorted list of imports

'Test Helper Classes'

• UserFlowCliProject (21)
• UserFlowCliProjectFactory (12)

'Test Helper Functions'

• withUserFlowProject (2)
• setupEnvVars (2)
• teardownEnvVars (2)

'Test Helper Type'

• UserFlowProjectConfig (4)

'Internal Type'

• RcJson (3)
• ReportFormat (1)

'External Lib Type'

• LhConfigJson (1)

'Dynamic Values'

• SANDBOX_BASE_RC_JSON (6)
• CLI_DEFAULT_RC_JSON (1)
• getEnvPreset (1)

'CONSTANT_VALUES'

• DEFAULT_COLLECT_UF_PATH (1)
• DEFAULT_COLLECT_URL (1)
• DEFAULT_PERSIST_OUT_PATH (1)
• SERVE_COMMAND_PORT (1)
• DECLINE_BOOLEAN (1)
• LH_NAVIGATION_BUDGETS_NAME_DEFAULT (1)
• DEFAULT_RC_NAME (3)
• ENTER (2)

Suggested solution

• [ ] Create a seed-data lib for default values

All values values identified as 'CONSTANT_VALUES' can be moved to a lib called seed data. This lib cannot depend on any internal lib as it should only contain defaults. If the constant value is used in multiple libraries it should be moved to this lib. Values that should not be located here are those who are only used as test data, and those can be placed in test-data. Optional: Seed data has no internal dependencies. If a type is required it should be type-cased externally when it is used. If a value will require being used with typecasting a comment can be made with the value.

• [ ] Modify default data where it is used not in its where it is declared.

The data named as a const but that requires being modified to be used in different environments should be modified at its final destination. If necessary we can have a helper that takes a constant value and modifies it after being given an argument. The const should be moved to seed-data and a helper should be implemented in the test that modifies it there.

• [ ] Types from external libs should be used directly and not imported from an internal lib

• [ ] Internal types should be consumed from the source and exported by user-flow-cli-testing

• [ ] Test Helper Type need to be generic and not import from cli

I am aware of the fact that this makes things a lot less readable, however if the cli testing utils is going to be used inside of cli it cannot import anything from cli. However, the benefit is that simply by insuring that it does not require the importing from the cli itself it will make the tool useful for any other projects consuming the cli helper

• [ ] Rename user-flow-cli-testing to cli-tester

As this will now become a generic tool it can be renamed to reflect the fact.

Assertions

• [ ] seed-data does not depend on any internal lib
• [ ] test-data does not depend on external lib
• [ ] cli-tester does not depend on any internal lib
• [ ] cli depends on test-data, seed-data and cli-tester
• [ ] sandbox depends on cli, test-data, seed-data and cli-tester

[ChristopherPHolder]

Creating proper module boundaries would help prevent this in the future.