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.

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

supporting top of await #6671

Merged
merged 10 commits into from
Mar 31, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/spotty-keys-change.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@astrojs/vue': patch
---

Supporting the top of the await syntax sugar for Vue in the template's setup
19 changes: 19 additions & 0 deletions packages/astro/e2e/fixtures/vue-component/src/components/Test.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<script setup lang="ts">
import {onMounted, ref} from 'vue'
const props = defineProps(['id'])
/** The top-level await causes event handling to not work (button click) */
await new Promise((resolve) => setTimeout(resolve, 10));

const a = ref(1);

onMounted(()=>{
a.value = 2
})

</script>

<template>
<div :id="props.id">
{{ a }}
</div>
</template>
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
import Counter from '../components/Counter.vue';
import VueComponent from '../components/VueComponent.vue';
import AsyncTest from '../components/Test.vue'

const someProps = {
count: 0,
Expand Down Expand Up @@ -33,5 +34,6 @@ const someProps = {
</Counter>

<VueComponent id="client-only" client:only="vue" />
<AsyncTest id="client-test" client:only="vue" />
</body>
</html>
3 changes: 3 additions & 0 deletions packages/astro/e2e/fixtures/vue-component/src/pages/mdx.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
export { default } from '../components/Layout.astro';
import Counter from '../components/Counter.vue';
import VueComponent from '../components/VueComponent.vue';
import AsyncTest from '../components/Test.vue';

export const someProps = {
count: 0,
Expand All @@ -27,3 +28,5 @@ export const someProps = {
</Counter>

<VueComponent id="client-only" client:only="vue" />

<AsyncTest id="client-test" client:only="vue" />
19 changes: 18 additions & 1 deletion packages/astro/e2e/vue-component.test.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { prepareTestFactory } from './shared-component-tests.js';

import { expect } from '@playwright/test';
const { test, createTests } = prepareTestFactory({ root: './fixtures/vue-component/' });

const config = {
Expand All @@ -23,3 +23,20 @@ test.describe('Vue components in MDX files', () => {
pageSourceFilePath: './src/pages/mdx.mdx',
});
});


test('test the async vue component in astro', async ({ page, astro }) => {
await page.goto(astro.resolveUrl('/'));

const label = page.locator('#client-test');

await expect(label, 'component not hydrated').toHaveText('2');
});

test('test the async vue component in mdx', async ({ page, astro }) => {
await page.goto(astro.resolveUrl('/mdx/'));

const label = page.locator('#client-test');

await expect(label, 'component not hydrated').toHaveText('2');
});
19 changes: 16 additions & 3 deletions packages/integrations/vue/client.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { h, createSSRApp, createApp } from 'vue';
import { h, createSSRApp, createApp, Suspense } from 'vue';
import { setup } from 'virtual:@astrojs/vue/app';
import StaticHtml from './static-html.js';

Expand All @@ -13,13 +13,26 @@ export default (element) =>
for (const [key, value] of Object.entries(slotted)) {
slots[key] = () => h(StaticHtml, { value, name: key === 'default' ? undefined : key });
}

let content = h(Component, props, slots);
// related to https://github.com/withastro/astro/issues/6549
// if the component is async, wrap it in a Suspense component
if (isAsync(Component.setup)) {
content = h(Suspense, null, content)
}

if (client === 'only') {
const app = createApp({ name, render: () => h(Component, props, slots) });
const app = createApp({ name, render: () => content });
await setup(app);
app.mount(element, false);
} else {
const app = createSSRApp({ name, render: () => h(Component, props, slots) });
const app = createSSRApp({ name, render: () => content });
await setup(app);
app.mount(element, true);
}
};

function isAsync (fn) {
const constructor = fn?.constructor
return constructor && constructor.name === 'AsyncFunction';
}
1 change: 0 additions & 1 deletion packages/integrations/vue/test/app-entrypoint.test.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
import { loadFixture } from './test-utils.js';
import { expect } from 'chai';
import { parseHTML } from 'linkedom';

describe('App Entrypoint', () => {
/** @type {import('./test-utils').Fixture} */
let fixture;
Expand Down