Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

WIP: Fix for issue 2261 #2264

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

WIP: Fix for issue 2261 #2264

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cd4903e
feat: conditionally export renderToStrings based on environment
Sandbagger Nov 30, 2023
9b30a2b
chore: removed comment
Sandbagger Dec 14, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 4 additions & 1 deletion src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,17 @@
import { VueWrapper } from './vueWrapper'
import BaseWrapper from './baseWrapper'
import { mount, shallowMount } from './mount'
import { renderToString } from './renderToString'
import { renderToString as _renderToString } from './renderToString'
import { MountingOptions } from './types'
import { RouterLinkStub } from './components/RouterLinkStub'
import { createWrapperError } from './errorWrapper'
import { config } from './config'
import { flushPromises } from './utils/flushPromises'
import { enableAutoUnmount, disableAutoUnmount } from './utils/autoUnmount'

// is __SSR__ avaialble? If so, preferable to use that?
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In Vue Core SSR defined in rollup config https://github.com/vuejs/core/blob/da4a4fb5e8eee3c6d31f24ebd79a9d0feca56cb2/rollup.config.js#L148

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know what's best. Maybe a variable defined in the rollup config would make more sense.

@lmiller1990 I think you were the one who set up the build config. Do you have an opinion on this?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd expect we want to mirror what core does where possible!

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Either way, if it works, and we've got a test, happy to move forward with this. Did you want to make a change @Sandbagger? Any opinion @cexbrayat ?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Vue core uses a build variable, so I think it would be better to mirror that if @Sandbagger feels like trying this. Otherwise I'm OK with merging this (once the comment is removed)

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks chaps. I'll give rollup config variable a go.

const isNode = typeof window === 'undefined'
const renderToString = ( isNode ? _renderToString : null)

Check failure on line 15 in src/index.ts

View workflow job for this annotation

GitHub Actions / build (18) 

Replace `(·isNode·?··_renderToString··:·null)` with `isNode·?·_renderToString·:·null`

Check failure on line 15 in src/index.ts

View workflow job for this annotation

GitHub Actions / build (20) 

Replace `(·isNode·?··_renderToString··:·null)` with `isNode·?·_renderToString·:·null`
export {
mount,
shallowMount,
Expand Down
10 changes: 10 additions & 0 deletions tests/index.jsdom.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
// @vitest-environment jsdom
import { describe, expect, it } from 'vitest'

import * as exports from '../src/index'
describe('index.js exports', () => {
it('in a browser environment renderToString should not be exported', () => {
// data type of null is object
expect(typeof exports.renderToString).toEqual('object');

Check failure on line 8 in tests/index.jsdom.spec.ts

View workflow job for this annotation

GitHub Actions / build (18) 

Delete `;`

Check failure on line 8 in tests/index.jsdom.spec.ts

View workflow job for this annotation

GitHub Actions / build (20) 

Delete `;`
});

Check failure on line 9 in tests/index.jsdom.spec.ts

View workflow job for this annotation

GitHub Actions / build (18) 

Delete `;`

Check failure on line 9 in tests/index.jsdom.spec.ts

View workflow job for this annotation

GitHub Actions / build (20) 

Delete `;`
})

Check failure on line 10 in tests/index.jsdom.spec.ts

View workflow job for this annotation

GitHub Actions / build (18) 

Insert `⏎`

Check failure on line 10 in tests/index.jsdom.spec.ts

View workflow job for this annotation

GitHub Actions / build (20) 

Insert `⏎`
9 changes: 9 additions & 0 deletions tests/index.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
// @vitest-environment node
import { describe, expect, it } from 'vitest'

import * as exports from '../src/index'
describe('index.js exports', () => {
it('in a node environment renderToString should be exported', () => {
expect(typeof exports.renderToString).toEqual('function');

Check failure on line 7 in tests/index.spec.ts

View workflow job for this annotation

GitHub Actions / build (18) 

Delete `;`

Check failure on line 7 in tests/index.spec.ts

View workflow job for this annotation

GitHub Actions / build (20) 

Delete `;`
});

Check failure on line 8 in tests/index.spec.ts

View workflow job for this annotation

GitHub Actions / build (18) 

Delete `;`

Check failure on line 8 in tests/index.spec.ts

View workflow job for this annotation

GitHub Actions / build (20) 

Delete `;`
})

Check failure on line 9 in tests/index.spec.ts

View workflow job for this annotation

GitHub Actions / build (18) 

Insert `⏎`

Check failure on line 9 in tests/index.spec.ts

View workflow job for this annotation

GitHub Actions / build (20) 

Insert `⏎`