Skip to content

Vue3#20787

Draft
dannon wants to merge 112 commits intogalaxyproject:devfrom
dannon:vue3-2025-07
Draft

Vue3#20787
dannon wants to merge 112 commits intogalaxyproject:devfrom
dannon:vue3-2025-07

Conversation

@dannon
Copy link
Member

@dannon dannon commented Aug 19, 2025

The test migration is still a giant pain, there are warnings, but the app builds, runs, and much of it does work. Very obviously still a work in progress, but I'm making this into a PR for at least a little more visibility, hoping to reduce conflicts and recruit folks to help test manually, fix tests, etc.

I will try to keep this rebased frequently so the branch doesn't slip away into the darkness yet again. (and, I rebased yesterday and it's already got 6 conflicted files)

Also, I have separated this from the vite branch as that actually (somewhat unexpectedly) had evenmore blockers than this one did. We still want to swap over, but we can push this one first at this point. The previous perceived dependency on the vite migration was primarily typescript errors we have for the most part now addressed in the build.

Unit test status (~10% failing, which is still a lot.)
image

Notes:

  • We're running with significant whitespace mode on in the vue compiler -- this is not the default and we should swap over time.

STATUS AND TASK LIST

Vue 3 Migration - Parallel Work Task List

Current Status (2026-01-13)

  • Branch: vue3-2025-07 (~230 commits ahead of dev)
  • Build: Production build compiles successfully
  • Unit Tests: 203 failing / 83 passing files (699/601 tests)
  • Selenium Tests: Not yet run on this iteration

Narrative Summary: Understanding the Failures

The Core Problem: Bootstrap-Vue + @vue/compat Slot Incompatibility

The biggest blocker is Bootstrap-Vue's incompatibility with Vue 3's @vue/compat mode. This manifests as:

TypeError: Cannot read properties of null (reading 'ce')
    at renderSlot (vue.cjs.js:6178:32)

Why this happens: Bootstrap-Vue was built for Vue 2's slot API. Vue 3 fundamentally changed how slots work internally. The @vue/compat compatibility layer handles most Vue 2 patterns, but Bootstrap-Vue's internal slot manipulation triggers edge cases where the rendering context (currentRenderingInstance) is null when it shouldn't be.

Components affected:

  • BPopover - 8 files using it
  • BTable - 39 files using it
  • BModal with custom slots
  • BTabs / BTab
  • Any component passing slot props

This is why many tests show "empty DOMWrapper" errors - the components aren't rendering because of these slot errors.

Secondary Issues

1. Vue Test Utils v1 → v2 API Changes

We've built adapters to handle most of these, but some tests still use old patterns:

  • wrapper.destroy()wrapper.unmount()
  • propsDataprops
  • Some mount option differences

2. Axios Mock Issues

Tests that use axios directly (not through our API client) hit mock configuration issues with Vitest's different mocking approach.

3. Console Warning Failures

We use vitest-fail-on-console to catch unexpected warnings. Many Vue compat deprecation warnings trigger test failures. We've suppressed common ones, but some leak through.

4. Store Setup Issues

Some tests don't properly set up required Pinia stores (e.g., provideScopedWorkflowStores).


Parallelizable Task List

Category A: Quick Fixes (Individual files, no dependencies)

These can be done in parallel by anyone. Each is a small, self-contained fix.

Task File Issue Effort
A1 PersistentTaskProgressMonitorAlert.test.ts Missing import { vi } from 'vitest' 5 min
A2 ObjectStoreBadge.test.ts Wrong import path: tests/jest/helpers@tests/vitest/helpers 5 min
A3 FormData.test.ts Wrong import path: tests/jest/helpers@tests/vitest/helpers 5 min
A4 FormSelectMany.test.ts Wrong import path (verify) 5 min
A5 ToolsList.test.ts Wrong import path (verify) 5 min

Category B: VTU v2 API Updates (Pattern-based, can be split)

Fix tests using deprecated Vue Test Utils v1 patterns.

Task Pattern Count Description
B1 wrapper.destroy() 4 files Change to wrapper.unmount()
B2 propsData 5 files Change to props in mount options
B3 vi.spyOn() on non-function 8 files Fix spy setup (need to spy on method, not object)
B4 Empty DOMWrapper calls ~50 tests Fix selectors or add await for async rendering

How to find these:

# Find wrapper.destroy
grep -r "wrapper.destroy()" client/src --include="*.test.*"

# Find propsData
grep -r "propsData" client/src --include="*.test.*"

# Find problematic spyOn
grep -r "vi.spyOn" client/src --include="*.test.*"

Category C: Bootstrap-Vue Slot Issues (Requires component changes)

These tests fail because the components use Bootstrap-Vue components with slots. Two options for each:

  1. Skip the test temporarily (with TODO comment explaining why)
  2. Replace Bootstrap-Vue component with alternative
Task Component BV Usage Recommendation
C1 TemplateSummaryPopover.vue BPopover Replace with Floating UI or skip test
C2 InstanceDropdown.vue BDropdown Replace or skip test
C3 EditSecretsForm.vue Various Review and fix/skip
C4 VaultSecret.vue Form components Review and fix/skip
C5 Grid components (14 files) BTable Major effort - see Category E

Category D: Store/Context Setup Issues

Tests failing because required context/stores aren't set up.

Task Test File Missing Setup
D1 WorkflowInvocationState.test.ts provideScopedWorkflowStores
D2 JobStep.test.ts Workflow store setup
D3 Several workflow-related tests Same pattern

Fix approach: Add proper store setup in test's beforeEach:

import { provideScopedWorkflowStores } from "@/stores/workflowEditorStateStore";
// Then use in mount options or setup

Category E: Major Component Migrations (Blocking decisions)

These require team decision on approach before proceeding.

Task Scope Options
E1 BTable usage (39 files) 1) Migrate to Bootstrap-Vue-Next, 2) Replace with custom table, 3) Skip tests until full migration
E2 BPopover usage (8 files) 1) Migrate to Bootstrap-Vue-Next, 2) Replace with Floating UI, 3) Skip tests
E3 BModal with custom slots Same as above

Category F: Test Infrastructure

Task Description Effort
F1 Review vitest-fail-on-console rules Some warnings may need to be suppressed
F2 Fix axios mock configuration Update tests/vitest/__mocks__/axios.js if needed
F3 Review and update test helpers tests/vitest/helpers.js may need more compatibility shims

Priority Order

Phase 1: Quick Wins (Unblocks ~10 tests)

  1. A1-A5: Fix import paths and missing imports
  2. B1-B2: Fix wrapper.destroy() and propsData

Phase 2: Pattern Fixes (Unblocks ~30-50 tests)

  1. B3-B4: Fix vi.spyOn and empty DOMWrapper issues
  2. D1-D3: Fix store setup issues

Phase 3: Strategic Decisions

  1. E1-E3: Team decides on Bootstrap-Vue approach
    • If migrating to BV-Next: start E1-E3 migrations
    • If staying with compat: skip affected tests with TODOs

Phase 4: Component Replacements (if needed)

  1. C1-C5: Replace/fix Bootstrap-Vue slot components

How to test the changes?

(Select all options that apply)

  • I've included appropriate automated tests.
  • This is a refactoring of components with existing test coverage.
  • Instructions for manual testing are as follows:
    1. [add testing steps and prerequisites here if you didn't write automated tests covering all your changes]

License

  • I agree to license these and all my past contributions to the core galaxy codebase under the MIT license.

@jmchilton
Copy link
Member

Very exciting stuff - thank you so much!

Would you be okay if I wrote a wrapper Vue test mount that would allow us to use either of these patterns based on what version is available? I feel like we can start migrating all the tests without the upgrade that way. We an use the new paradigms now and it would simplify this branch a lot of getting using paradigms that will reduce conflicts in the future.

Also I think the upgrade of prettier in the middle there seems like it is a causing a lot of unrelated changes. Is it possible we can pull that out and apply to our current codebase or that we can remove it and apply it after the Vue 3 migration is done?

@dannon dannon force-pushed the vue3-2025-07 branch 2 times, most recently from 8e8bdf8 to fe3fdcb Compare August 26, 2025 15:06
@dannon
Copy link
Member Author

dannon commented Oct 28, 2025

Post-release-rebase update:

The branch builds and runs successfully with all TypeScript errors resolved. Selenium testing found a few reactivity issues - collection builders weren't emitting events properly (fixed by swapping @update to @input), the workflow editor has some step update problems, and there's an accessibility issue with the dataset library multiselect. On the Jest side, tests are blocked because Babel transforms our Vue Router 4 ESM imports to CommonJS, which breaks Vue Router's conditional exports. I'm experimenting with Vitest as an alternative since we want to migrate to it anyway for the better Vite integration - got Bootstrap Vue and vue-rx mocked successfully, but components with slots still fail because of how @vue/compat handles rendering. Just trying to figure out the right order of operations here - whether to push through on Vitest now, stick with Jest until we're fully on Vue 3, or some hybrid approach.

@mvdbeek
Copy link
Member

mvdbeek commented Oct 28, 2025

Can you update the lock file so we can see the tests ?

@dannon dannon changed the title Vue3? Vue3 Nov 19, 2025
@dannon dannon force-pushed the vue3-2025-07 branch 2 times, most recently from 98ec6ef to 7a92e2f Compare November 21, 2025 14:10
@dannon dannon force-pushed the vue3-2025-07 branch 2 times, most recently from 5909563 to e399b43 Compare December 16, 2025 03:24
@dannon dannon force-pushed the vue3-2025-07 branch 4 times, most recently from bc044ad to b3cfc95 Compare January 14, 2026 03:49
@davelopez
Copy link
Contributor

@dannon what would be the best way to work on the upgrades and fixes?

  • create PR's against this branch?
  • direct commit to this branch?
  • other?

Regarding Fix axios mock configuration (F2), I think we should completely replace axios mock usages with useServerMock for consistency and compatibility for when we replace the axios calls with openAPI fetcher ones in the future.

@dannon
Copy link
Member Author

dannon commented Jan 20, 2026

@davelopez Was just rebasing this and see your comment -- so sorry I missed it! Yeah, just push here or however you prefer, no worries!

@dannon dannon added this to the 26.1 milestone Jan 27, 2026
Add name prop to all Multiselect components to fix invalid aria-label
attribute. vue-multiselect generates aria-label as 'name-searchbox', so
when name is empty it becomes '-searchbox' which is invalid.
Turns out vue-multiselect needs both name and id props - it uses name
for aria-label and id for aria-controls. Without id it was generating
aria-controls="listbox-null" which is invalid.

Unfortunately there's still a bug in vue-multiselect 3.3.1 where the
listbox element only exists when the dropdown is open, so aria-controls
points to a non-existent element when closed. This is a known issue
(shentao/vue-multiselect#1780) that would
need a library fix or migration to something like vue-accessible-multiselect.

But at least now the IDs are properly formatted instead of "null".
BFormInput in Bootstrap Vue 2 emits 'input' events, not 'update' events.
The incorrect @update handler prevented the collection name input from
responding to user input, causing all collection builder tests to fail.
Replace deprecated filter syntax with localize() function calls and clean up test files.
- Change @vitejs/plugin-vue2 to @vitejs/plugin-vue
- Add vue → @vue/compat alias for Vue 3 compatibility mode
- Add vue/dist/vue.esm.js alias pointed to @vue/compat
- Configure template compiler with compatConfig MODE: 2
- Update build-config.shared.js vue alias to use @vue/compat
portal-vue uses Vue.extend which doesn't exist in Vue 3. This adds:
- A Vite plugin to intercept portal-vue imports and redirect to mock
- Mock portal-vue module using Vue 3's Teleport component
- bootstrap-vue ESM alias for better Vite transformation
Replace Vue 2 config (Vue.config.productionTip) with @vue/compat
configureCompat call. Suppress expected migration warnings for
Vue 2 features used in tests.
- Remove createLocalVue (not available in VTU v2)
- Return global mount options object for mount()
- Add bootstrap-vue component stubs (incompatible with Vue 3)
- Remove vue-rx and bootstrap-vue plugins (Vue 2 only)
- Update createTestRouter with catch-all route
- Use global mount options instead of localVue
- Add router to global plugins
- Merge getLocalVue() stubs with test-specific stubs
Use $scopedSlots (Vue 2 compat API) with fallback to $slots for
passing slot props in render function. The pure Vue 3 renderSlot()
doesn't work correctly with compat mode's slot handling.
Same fix as ExpandedItems - use $scopedSlots with $slots fallback
since the pure Vue 3 slot API doesn't pass props correctly in compat.
Configure shouldFailOnWarn to show Vue compat mode warnings without
failing tests. This allows migration to proceed while keeping warnings
visible for tracking progress.
Switched to createRouter/createWebHistory, added setActivePinia call, and
suppress Vue compat warnings during migration.
Created adapters that allow old Vue 2 test patterns to work without modifying
individual test files:

- vue-test-utils-adapter.ts: Transforms { global: localVue, pinia, router }
  mount options to proper VTU v2 format with plugins array
- vue-router-adapter.ts: Provides VueRouter constructor for tests using the
  old `import VueRouter from 'vue-router'` and `new VueRouter()` pattern
- helpers.js: Added .use() method to getLocalVue() for localVue.use() calls
- setup.ts: Relaxed fail-on-console to not fail on Vue compat warnings

These adapters are a bridge during migration - tests can be updated to use
proper Vue 3 patterns incrementally while the adapters keep things working.
@vue/compat's CJS build requires 'entities' but doesn't declare it as a
dependency. Using pnpm's packageExtensions to inject the dependency is
cleaner than public-hoist-pattern in .npmrc.

Minor formatting.
- Add missing vi import in PersistentTaskProgressMonitorAlert test
- Remove duplicate jest helper imports (now using vitest helpers)
- Update VueRouter usage to v4 pattern with createTestRouter()
- Change wrapper.destroy() to wrapper.unmount() (VTU v2 API)
- Change propsData to props in mount options (VTU v2 API)
Regenerated pnpm-lock.yaml to resolve conflicts from rebase against
upstream/dev. Fixed remaining .sync modifiers in upload components,
removed unused catch variables and GLink import, converted empty
interface to type alias.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants