run type checking in all packages with turbo

[christianvogt]

Part of https://issues.redhat.com/browse/RHOAIENG-16880

Description

Type checking was not currently run for packages in the monorepo. This change adds a type-check script to each package. Introduced Turbo Repo to orchestrate type checking.

Turbo repo can run the type checking tasks in parallel and cache the results so that the type check is only run in packages, or their dependencies, when relevant files have changed.

In order for turbo to create a dependency graph, each package must define their own dependencies. Therefore I removed all frontend monorepo packages from the root package.json to the individual package.json per package.

Added cypress as a separate package to make it easier to type check and separate it from the app source.

Updated backend to also use turbo. (in future will look to combine the backend in the monorepo)

Updated github test action to include type-check and cache the .turbo directory for both frontend and backend for faster runs. You can check out the action logs to see the misses and hits for the cache.

Turbo will cache the results of the type check run and if the cache is missed it will run type checking for that package. Since type checking can depend on types changing outside of a package, we must tell turbo that type checking depends on a package's dependencies. We want type checking of each package to run in parallel, but we don't want to use the turbo dependsOn: "^type-check" task option because that would run dependent type checks in sequence. To get past this, I figured out that I can create a no-op task. By making type-check depend on ^no-op, turbo will evaluate no-op script in each dependent package in sequence of the dependency graph. But since no-op doesn't exist, the check is essentially skipped very quickly and therefore immediately the real type checking occurs. But by doing this little trick, turbo includes the files of dependent packages as part of the cache key. Thereby creating a cache miss if any dependent package file changes. Without this little trick, only files within a package would be considered as part of the cache key.

How Has This Been Tested?

PR checks (see github actions log)

npm run test:type-check

Testing cache validation:

• run npm run test:type-check at least once to establish the cache
• make a change to a cypress test
• run type-check and observe a cache miss for cypress package
• make a change to a file in frontend/src
• run type-check and observe a cache miss for all packages but the plugin-core package

Test Impact

N/A

Request review criteria:

Self checklist (all need to be checked):

• The developer has manually tested the changes and verified that the changes work
• Testing instructions have been added in the PR body (for PRs involving changes that are not immediately obvious).
• The developer has added tests or explained why testing cannot be added (unit or cypress tests for related changes)

If you have UI changes:

• Included any necessary screenshots or gifs if it was a UI change.
• Included tags to the UX team if it was a UI/UX change.

After the PR is posted & before it merges:

• The developer has tested their solution on a cluster by using the image produced by the PR to main

Summary by CodeRabbit

• New Features

  • Introduced Turbo as a task runner for type checking in both backend and frontend.
  • Added dedicated type-checking scripts and configurations across backend, frontend, and internal packages.
  • Implemented a new automated type-checking job in the workflow, ensuring type checks complete before other tests.

• Chores

  • Updated workspace and dependency management for improved tooling and monorepo compatibility.
  • Enhanced .gitignore to exclude Turbo artifacts.
  • Refined and modularized linting and type-checking scripts for parallel execution.

• Style

  • Adjusted ESLint rules and import ordering for improved code consistency.

[coderabbitai]

Walkthrough

This update introduces Turbo as a task runner for type checking in both backend and frontend, adds type-checking scripts and configurations across multiple packages, and updates the workflow to include a dedicated type-check job. It also adjusts linting, dependency management, workspace settings, ESLint rules, and TypeScript configurations, while refining npm scripts for parallel execution and modularity.

Changes

File(s)	Change Summary
.github/workflows/test.yml	Adds a Type-Check job using Turbo, updates job dependencies to require type-checking before tests.
.gitignore	Adds .turbo directory to ignore list.
package.json	Refactors lint/type-check scripts to use npm-run-all, adds parallelization, introduces type-check scripts for backend and frontend.
backend/package.json, frontend/package.json	Sets [email protected], switches type-check to Turbo, adds Turbo as a devDependency, adjusts dependencies and workspace scope (frontend).
backend/turbo.json, frontend/turbo.json, frontend/src/turbo.json	Adds Turbo configuration files defining tasks and input scoping.
frontend/packages/kserve/package.json, frontend/packages/modelServing/package.json	Adds type-check scripts and dependencies sections for internal packages.
frontend/packages/plugin-core/package.json, frontend/src/package.json	Adds type-check scripts and dependencies for plugin-core and src packages.
frontend/src/tests/cypress/package.json, frontend/src/tests/cypress/tsconfig.json	Adds Cypress test package and TypeScript config, sets up type-checking and import mapping.
frontend/packages/plugin-core/src/core/useResolvedExtensions.ts	Adds TODO comment and ESLint directive for an import, no functional changes.
frontend/.eslintrc.js	Refines import order, expands rule overrides, removes no-console rule, broadens file patterns.
frontend/packages/tsconfig/tsconfig.json	Changes baseUrl, adds files array, adjusts included/excluded files.

Sequence Diagram(s)

sequenceDiagram
    participant Developer
    participant CI Workflow
    participant Turbo
    participant Backend
    participant Frontend

    Developer->>CI Workflow: Push code / PR opened
    CI Workflow->>Type-Check Job: Start type checking
    Type-Check Job->>Turbo: Run turbo run type-check
    Turbo->>Backend: Run tsc --noEmit (type-check)
    Turbo->>Frontend: Run tsc --noEmit (type-check)
    Type-Check Job-->>CI Workflow: Type checking complete
    CI Workflow->>Tests: Run tests (after type-check passes)

Loading

Suggested labels

lgtm, area/quality

Poem

In burrows deep, the Turbo runs,
Checking types before tests are spun.
Linting, fixing, hopping fast,
No stray carrots left unpassed!
With scripts and configs all aligned,
This codebase hops ahead—refined!
🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d394205 and 8f985cc.

⛔ Files ignored due to path filters (2)

• backend/package-lock.json is excluded by !**/package-lock.json
• frontend/package-lock.json is excluded by !**/package-lock.json

📒 Files selected for processing (17)

• .github/workflows/test.yml (5 hunks)
• .gitignore (1 hunks)
• backend/package.json (3 hunks)
• backend/turbo.json (1 hunks)
• frontend/.eslintrc.js (3 hunks)
• frontend/package.json (3 hunks)
• frontend/packages/kserve/package.json (1 hunks)
• frontend/packages/modelServing/package.json (1 hunks)
• frontend/packages/plugin-core/package.json (1 hunks)
• frontend/packages/plugin-core/src/core/useResolvedExtensions.ts (1 hunks)
• frontend/packages/tsconfig/tsconfig.json (1 hunks)
• frontend/src/__tests__/cypress/package.json (1 hunks)
• frontend/src/__tests__/cypress/tsconfig.json (1 hunks)
• frontend/src/package.json (2 hunks)
• frontend/src/turbo.json (1 hunks)
• frontend/turbo.json (1 hunks)
• package.json (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (17)

• .gitignore
• frontend/packages/plugin-core/src/core/useResolvedExtensions.ts
• frontend/packages/plugin-core/package.json
• frontend/turbo.json
• backend/turbo.json
• frontend/src/package.json
• frontend/packages/kserve/package.json
• frontend/.eslintrc.js
• frontend/packages/tsconfig/tsconfig.json
• frontend/src/tests/cypress/tsconfig.json
• frontend/src/turbo.json
• frontend/src/tests/cypress/package.json
• frontend/packages/modelServing/package.json
• backend/package.json
• package.json
• .github/workflows/test.yml
• frontend/package.json

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)

• GitHub Check: Cypress-Setup
• GitHub Check: Lint

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 3

🧹 Nitpick comments (6)

frontend/packages/plugin-core/src/core/useResolvedExtensions.ts (1)

8-10: Refactor shared utility import
Relying on an internal path and disabling lint rules couples this package to another. Move allSettledPromises to a shared utilities module or expose it as a published package to remove the workaround.

frontend/packages/tsconfig/tsconfig.json (1)

28-30: Simplify JS include pattern.

Use "${configDir}/**/*.js" instead of "${configDir}/**/**.js" for clarity and broader matching.

- "include": ["${configDir}/**/*.ts", "${configDir}/**/*.tsx", "${configDir}/**/*.jsx", "${configDir}/**/**.js"],
+ "include": ["${configDir}/**/*.ts", "${configDir}/**/*.tsx", "${configDir}/**/*.jsx", "${configDir}/**/*.js"],

frontend/src/turbo.json (1)

5-10: Exclude nested Cypress files explicitly.

To ensure all files under __tests__/cypress are ignored, use !__tests__/cypress/** instead of !__tests__/cypress.

 "inputs": [
   "$TURBO_DEFAULT$",
-  "!__tests__/cypress"
+  "!__tests__/cypress/**"
 ]

frontend/packages/kserve/package.json (1)

12-15: Use workspace specifier for dependencies.

Pinning to "*" can lead to unpredictable versions. Prefer "workspace:*" for consistent local package resolution.

   "dependencies": {
-    "@odh-dashboard/internal": "*",
-    "@odh-dashboard/model-serving": "*"
+    "@odh-dashboard/internal": "workspace:*",
+    "@odh-dashboard/model-serving": "workspace:*"
   }

.github/workflows/test.yml (1)

5-5: Clarify DO_NOT_TRACK usage
The global DO_NOT_TRACK: 1 flag is introduced here—please document which CI tools or scripts respect this variable and confirm it has no unintended side-effects on caching or telemetry.

package.json (1)

50-53: Modularize and parallelize type-check scripts
Defining test:type-check, test:type-check:backend, and test:type-check:frontend cleanly scopes type checking per package. For future simplification, consider replacing the npm-run-all invocation with a root-level turbo run type-check to leverage Turbo’s full dependency graph.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d28ea66 and 64d4854.

⛔ Files ignored due to path filters (2)

• backend/package-lock.json is excluded by !**/package-lock.json
• frontend/package-lock.json is excluded by !**/package-lock.json

📒 Files selected for processing (17)

• .github/workflows/test.yml (4 hunks)
• .gitignore (1 hunks)
• backend/package.json (3 hunks)
• backend/turbo.json (1 hunks)
• frontend/.eslintrc.js (3 hunks)
• frontend/package.json (3 hunks)
• frontend/packages/kserve/package.json (1 hunks)
• frontend/packages/modelServing/package.json (1 hunks)
• frontend/packages/plugin-core/package.json (1 hunks)
• frontend/packages/plugin-core/src/core/useResolvedExtensions.ts (1 hunks)
• frontend/packages/tsconfig/tsconfig.json (1 hunks)
• frontend/src/__tests__/cypress/package.json (1 hunks)
• frontend/src/__tests__/cypress/tsconfig.json (1 hunks)
• frontend/src/package.json (2 hunks)
• frontend/src/turbo.json (1 hunks)
• frontend/turbo.json (1 hunks)
• package.json (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (3)

• GitHub Check: Type-Check
• GitHub Check: Cypress-Setup
• GitHub Check: Lint

🔇 Additional comments (26)

.gitignore (1)

24-25: Ignore Turbo cache directory
Adding .turbo to .gitignore ensures Turbo’s cache artifacts aren’t committed to version control.

frontend/packages/plugin-core/package.json (1)

6-8: Add type-check npm script
Defines tsc --noEmit for package-level type checking, aligning with the repository-wide Turbo configuration.

frontend/turbo.json (1)

4-7: Configure Turbo tasks for type checking
The no-op placeholder and type-check dependency chain are set correctly for caching across workspaces.

frontend/src/__tests__/cypress/tsconfig.json (1)

2-2: Extend base TS config correctly.

Using extends: "@odh-dashboard/tsconfig/tsconfig.json" aligns the Cypress tests with the monorepo’s centralized configuration.

frontend/packages/tsconfig/tsconfig.json (2)

21-21: Update baseUrl to package root.

Changing baseUrl from ${configDir}/src to ${configDir} correctly scopes module resolution to the config package directory.

---

26-27: Confirm intentional use of both include and files.

Per TS behavior, specifying "files" overrides "include". Verify this is intended for a config-only package with no TS source, so only the two declaration files are compiled.

frontend/packages/kserve/package.json (1)

6-8: Add type-check script.

Introducing "type-check": "tsc --noEmit" aligns this package with the monorepo’s standardized type-check workflow.

backend/package.json (4)

7-7: Lock npm version for reproducibility.

Adding "packageManager": "[email protected]" ensures consistent installs across environments.

---

33-33: Delegate test:type-check to Turbo.

Switching from direct tsc to "turbo run type-check" leverages caching and parallelism as intended.

---

35-35: Add standalone type-check script.

Defining "type-check": "tsc --noEmit" supports direct validation and inter-package dependencies in Turbo.

---

75-75: Introduce Turbo as a dev dependency.

Adding "turbo": "^2.4.2" enables use of Turbo CLI for orchestrating tasks in the backend workspace.

frontend/src/package.json (2)

5-7: LGTM! Type-check script follows best practices.

The addition of the type-check script using tsc --noEmit is appropriate for TypeScript type checking without generating output files, aligning with the PR's goal of introducing type checking across packages.

---

26-28: LGTM! Internal dependency correctly added.

The addition of the @odh-dashboard/plugin-core dependency with wildcard version "*" is appropriate for internal monorepo packages.

frontend/src/__tests__/cypress/package.json (1)

1-21: LGTM! Well-structured Cypress test package.

The new Cypress test package follows the established patterns:

• Appropriate type-check script using tsc --noEmit
• Correct imports mapping for the #~/* internal module pattern
• Proper internal dependency declaration with wildcard versioning

This separation enables better type checking and aligns with the monorepo restructuring goals.

frontend/packages/modelServing/package.json (2)

6-8: LGTM! Type-check script added consistently.

The type-check script follows the same pattern as other packages in the monorepo, ensuring consistent type checking across all packages.

---

13-16: LGTM! Dependencies correctly added.

The addition of internal dependencies @odh-dashboard/internal and @odh-dashboard/plugin-core with wildcard versioning is appropriate for monorepo packages.

frontend/.eslintrc.js (3)

214-217: LGTM! Import grouping updated for internal pattern.

The addition of the #~/** pattern for internal imports correctly supports the new imports mapping introduced in the Cypress package and aligns with the monorepo restructuring.

---

470-470: LGTM! Cypress directory properly excluded.

The exclusion of src/__tests__/cypress/** prevents lint rule conflicts with the newly separated Cypress package that has its own configuration.

---

482-482: LGTM! Package file matching expanded appropriately.

Changing from ${pkg}/src/** to ${pkg}/** allows ESLint to process all files in monorepo packages, supporting the broader package structure introduced with the type checking changes.

frontend/package.json (4)

7-7: LGTM! Package manager version specified.

Specifying the package manager version ensures consistent npm behavior across different environments and aligns with modern Node.js best practices.

---

10-10: LGTM! Workspace correctly extended.

Adding src/__tests__/cypress to workspaces properly includes the new Cypress test package in the monorepo workspace configuration.

---

40-40: LGTM! Type checking migrated to Turbo.

The change from direct TypeScript compiler commands to turbo run type-check enables parallel execution and caching benefits as outlined in the PR objectives.

---

167-167: LGTM! Turbo dependency added.

The addition of Turbo as a devDependency supports the new build orchestration system for type checking across the monorepo.

.github/workflows/test.yml (2)

40-69: Approve: New Type-Check job configuration
The Type-Check job correctly restores dependency caches, caches Turbo’s .turbo artifacts with primary and fallback keys, and invokes npm run test:type-check. This aligns with the PR’s goal of parallel, cached type checking across packages.

---

332-333: Approve: Enforce type checking before final Tests
Adding Type-Check to the needs list of the Tests job ensures type errors are caught early in the pipeline, matching the PR’s objective.

package.json (1)

45-47: Approve: Parallel lint scripts via npm-run-all
Switching to run-p test:lint:* consolidates and parallelizes backend and frontend linting. Confirm that test:lint:backend and test:lint:frontend cover all intended files.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 82.54%. Comparing base (a4e3849) to head (8f985cc).
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #4381      +/-   ##
==========================================
+ Coverage   82.53%   82.54%   +0.01%     
==========================================
  Files        1761     1761              
  Lines       36885    36885              
  Branches    10935    10935              
==========================================
+ Hits        30443    30447       +4     
+ Misses       6442     6438       -4     

Files with missing lines	Coverage Δ
...ages/plugin-core/src/core/useResolvedExtensions.ts	86.66% <ø> (ø)

... and 8 files with indirect coverage changes

---

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a4e3849...8f985cc. Read the comment docs.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[jenny-s51]

Tested locally per the PR instructions, Turbo caching and parallel type-checking working as expected across all packages.

Great work @christianvogt - this is an awesome improvement to code quality that will scale really well in the monorepo.

[lucferbux]

Spent some time learning a little bit more about turborepo and test it locally, it works really well, great job here @christianvogt

Can you rebase? Once the conflict is solved I'll approve it

[christianvogt]

@lucferbux i rebased the PR and also removed the extra type check run which was previously included with unit tests now that type checking is a separate step.

[lucferbux]

/lgtm

Cool output btw

[lucferbux]

/approve

[openshift-ci]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: jenny-s51, lucferbux

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [lucferbux]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[christianvogt]

rebased on top of #4381 due to lint check running OOM.