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

fix: useRequest useLoadingDelay plugin bug #198

Merged
merged 3 commits into from
May 12, 2024
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
15 changes: 15 additions & 0 deletions .github/COMMIT-zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,18 @@
feat: your commit

```

### 📌 可能存在的问题

如果运行 `pnpm docs:dev` 提示报错,可以尝试一下以下操作:

- 检查 `node` 版本: 建议使用 `node 16`, `node 18` 版本开发
- 构建包后再运行: `pnpm build` 后再运行 `pnpm docs:dev`

```bash
# 构建包
pnpm build

# 运行文档
pnpm docs:dev
```
15 changes: 15 additions & 0 deletions .github/COMMIT.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,18 @@
feat: your commit

```

### 📌 Possible Problems

If running 'pnpm docs:dev' prompts an error, try the following:

- Check 'node' version: It is recommended to use 'node 16', 'node 18' version development
- build and run: 'pnpm build and run' pnpm docs:dev '

```bash
# build project
pnpm build

# run docs
pnpm docs:dev
```
27 changes: 18 additions & 9 deletions packages/hooks/src/useRequest/__tests__/delay.spec.ts
Original file line number Diff line number Diff line change
@@ -1,18 +1,27 @@
import { sleep } from 'test-utils/sleep'
import { mount } from '@vue/test-utils'
import useRequest from '../useRequest'

function getUsername(): Promise<string> {
return new Promise(resolve => {
setTimeout(() => {
resolve(`vue-hooks-plus useRequest A ${new Date().getTime()}`)
}, 1)
})
}

import Demo from '../docs/loadingDelay/demo/demo.vue'

describe('useRequest/LoadingDelay', () => {
it(' should data work ', async () => {
const wrapper = mount(Demo)
const text = wrapper.findAll('div').at(1)
const { loading, run: runData } = useRequest(() => getUsername())
const { loading: loading1, run: runData1 } = useRequest(() => getUsername(), {
loadingDelay: 300,
})
runData()
runData1()
await sleep(10)
expect(loading.value).toBe(false)
expect(loading1.value).toBe(true)

expect(text?.text()).toBe('Username:')
await sleep(301)
expect(text?.text()).toBe('Username:loading...')

await sleep(1000)
expect(text?.text()).toBe('Username:vue-hooks-plus useRequest A')
})
})
2 changes: 1 addition & 1 deletion packages/hooks/src/useRequest/__tests__/polling.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ describe('polling', () => {
result.run()
expect(result.loading.value).toBeTruthy()
expect(result.data?.value).toBeUndefined()
await sleep(1000)
await sleep(1050)
expect(result.data?.value).toBe(data)
expect(result.loading.value).toBeFalsy()
})
Expand Down
26 changes: 12 additions & 14 deletions packages/hooks/src/useRequest/docs/loadingDelay/demo/demo.vue
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
<template>
<div>Username:{{ data }}</div>
<div>Username:{{ loading ? 'loading...' : data1 }}</div>
<div>Username:{{ loading ? 'loading' : data }}</div>
<div>Username:{{ loading1 ? 'loading...' : data1 }}</div>
<vhp-button @click="run">run</vhp-button>
</template>

<script lang="ts" setup>
Expand All @@ -9,21 +10,18 @@
function getUsername(): Promise<string> {
return new Promise(resolve => {
setTimeout(() => {
resolve('vue-hooks-plus useRequest')
}, 1000)
resolve(`vue-hooks-plus useRequest A ${new Date().getTime()}`)
}, 1)
})
}

function getUsername1(): Promise<string> {
return new Promise(resolve => {
setTimeout(() => {
resolve('vue-hooks-plus useRequest A')
}, 1000)
})
}

const { data } = useRequest(() => getUsername())
const { data: data1, loading } = useRequest(() => getUsername1(), {
const { data, loading, run: runData } = useRequest(() => getUsername())
const { data: data1, loading: loading1, run: runData1 } = useRequest(() => getUsername(), {
loadingDelay: 300,
})

const run = () => {
runData()
runData1()
}
</script>
60 changes: 22 additions & 38 deletions packages/hooks/src/useRequest/plugins/useLoadingDelayPlugin.ts
Original file line number Diff line number Diff line change
@@ -1,44 +1,28 @@
import { unref, ref } from "vue";
import type { UseRequestPlugin, Timeout } from "../types";

const useLoadingDelayPlugin: UseRequestPlugin<unknown, unknown[]> = (
fetchInstance,
{ loadingDelay }
) => {
const timerRef = ref<Timeout>();
if (!unref(loadingDelay)) {
return {};
}

const cancelTimeout = () => {
if (timerRef.value) {
clearTimeout(timerRef.value);
}
};

import { ref, unref } from 'vue'
import { Timeout, UseRequestPlugin } from '../types'

const useLoadingDelayPlugin: UseRequestPlugin<unknown, unknown[]> = (inst, { loadingDelay }) => {
const delayRef = ref<Timeout>()

return {
name: "loadingDelayPlugin",
onBefore: () => {
cancelTimeout();
timerRef.value = setTimeout(() => {
fetchInstance.setState({
loading: true,
});
}, (unref(loadingDelay)) as number);

return {
loading: false,
};
},
name: 'loadingDelayPlugin',
onFinally: () => {
cancelTimeout();
},
onCancel: () => {
cancelTimeout();
if (delayRef.value) {
clearTimeout(unref(delayRef.value))

delayRef.value = undefined
}

inst.setState({
loading: true,
})
setTimeout(() => {
inst.setState({
loading: false,
})
}, unref(loadingDelay))
},
};
};
}
}

export default useLoadingDelayPlugin;
export default useLoadingDelayPlugin
Loading