test(tests dir): added vitest and coverage reporting GitHub Actions workflow #8

KemingHe · 2024-07-26T20:08:15Z

Deliverables

Mon. 07/29 Update

@ad1992 Git hard reset to only implement testing, refactored naming 3rd time in e3264f8.

Sun. 07/28 Update

~~@ad1992 , done 10~~

~~Added query result caching via private cache: { [query: string]: Result };.~~
~~Added and maintained 100% test coverage of cache hit and miss.~~

~~For details, see: c476214~~

Fri. 07/26 Update

@ad1992 , done #3

Unittest 100% statement coverage for utils.ts and Fuzzy.ts.
Vitest benchmarking utils.ts performance (see package.json and __tests__/benchmark.json)
GitHub Actions workflow node-ci.yml to auto yarn install and test per push/PR.

MOST IMPORTANT

ZERO functional code changes.

Screenshot of GitHub (auto-trigger) Actions run output:

vercel · 2024-07-26T20:08:18Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
fuzzify	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jul 29, 2024 4:40pm

KemingHe · 2024-07-26T20:13:34Z

@ad1992 Let me know how you like the yarn test:bench:compare feature. I will let you decide how to incorporate it into the contrib workflow (prob an edit to README.md) so that future devs doesn't break performance on top of functionality. ☀️

ad1992 · 2024-07-26T20:55:08Z

Ohh wow, this PR looks great @KemingHe, very happy to see the tests being added so soon!
I will be reviewing this PR tomorrow

ad1992

Thanks @KemingHe for the PR ✨

I am thinking should we just add coverage instead of benchmarks ? wdyt ?
This one I mean. - https://github.com/davelosert/vitest-coverage-report-action

__tests__/utils.test.ts

__tests__/Fuzzy.test.ts

KemingHe · 2024-07-28T19:17:32Z

Thanks @KemingHe for the PR ✨

I am thinking should we just add coverage instead of benchmarks ? wdyt ? This one I mean. - https://github.com/davelosert/vitest-coverage-report-action

@ad1992

Removed all benchmark test and script in 9bfc05c.
Impletemented coverage reporting in 9bfc05c, see screenshot below:

KemingHe · 2024-07-28T19:19:00Z

100% coverage in global Lines, Statements, Functions, and Branches.

Implemented testing for both cache hit and cache miss cases. done #10

ad1992

Looks great @KemingHe!
Let's remove caching related stuff from this PR as discussed in the issue

ad1992 · 2024-07-29T07:53:59Z

.github/workflows/node-ci.yml

@@ -0,0 +1,39 @@
+# ./.github/workflows/node-ci.yml


let's rename this file to test-coverage-pr.yml

Renamed in e3264f8.

ad1992 · 2024-07-29T07:56:15Z

__tests__/Fuzzy.test.ts

+import Fuzzy from '../src/Fuzzy';
+
+// Fuzzy class test suite.
+describe('Fuzzy', () => {


Suggested change

describe('Fuzzy', () => {

describe('Test Fuzzy', () => {

Let's add a Test in each describe block just to make it more consistent

Renamed in e3264f8.

package.json

ad1992 · 2024-07-29T07:58:48Z

.github/workflows/node-ci.yml

+# ./.github/workflows/node-ci.yml
+#
+# Auto CI/CD for Node.js projects using GitHub Actions.
+name: Node CI


Suggested change

name: Node CI

name: Test Coverage Pull Request

Renamed in e3264f8.

ad1992 · 2024-07-29T07:59:59Z

.github/workflows/node-ci.yml

+  workflow_dispatch:
+
+jobs:
+  yarn-vitest:


Suggested change

yarn-vitest:

coverage:

Renamed in e3264f8.

ad1992 · 2024-07-29T08:00:16Z

.github/workflows/node-ci.yml

+
+jobs:
+  yarn-vitest:
+    name: Yarn Vitest


Suggested change

name: Yarn Vitest

name: Test Coverage

Renamed in e3264f8.

KemingHe · 2024-07-29T14:31:01Z

Looks great @KemingHe! Let's remove caching related stuff from this PR as discussed in the issue

@ad1992

Hard reset to only testing in e3264f8.

KemingHe · 2024-07-29T14:38:40Z

Also @ad1992 , since >90% of our conversation has been about naming preferences, I propose that you provide the exact software specifications in ALL future instances BEFORE I start coding.

I can understand that this project is your world and everything and it must be perfect. However, I'm also just an unpaid volunteer and doing this out of my own free will.

Warning

If the micro-management continues, this will be my last commit to the project.

ad1992 · 2024-07-29T16:29:18Z

Also @ad1992 , since >90% of our conversation has been about naming preferences, I propose that you provide the exact software specifications in ALL future instances BEFORE I start coding.

I can understand that this project is your world and everything and it must be perfect. However, I'm also just an unpaid volunteer and doing this out of my own free will.

Warning

If the micro-management continues, this will be my last commit to the project.

Thank you for sharing your concerns. I understand that discussing naming preferences can be annoying, but they are important to ensure consistency, clarity, and maintenance. However not all naming changes are necessary, some are good to have, so feel free to comment where you have a different opinion and we can learn from each other.

As mentioned in Readme, this library is at a very early stage and it will take me some time to bring everything in the documentation.

I acknowledge and appreciate the voluntary effort you are putting into this project and I am a volunteer as well so I hope we both have the same goals to improve the library and at the same time keep it maintainable as well.

From my side, I will try to add details and document as much as possible but as I mentioned it will take me some time as well, until then I will jump in and take care of those undocumented changes as well.

I hope we can continue working together smoothly and improve the library :).
Thanks again for your contributions so far ✨

ad1992

I have removed the caching-related code and tests
Rest all looks good @KemingHe

For some reason, the types for globals aren't working even though specified in tsconfig. Will fix it in separate PR.

package.json

test(__tests__ dir): added vitest and benchmarking to workflow

74f3516

vercel bot deployed to Preview July 26, 2024 20:08 View deployment

KemingHe mentioned this pull request Jul 26, 2024

Test (__tests__ dir and .github/workflows): propose to implement unittests and automation #3

Closed

ad1992 requested changes Jul 27, 2024

View reviewed changes

__tests__/utils.test.ts Outdated Show resolved Hide resolved

__tests__/utils.test.ts Outdated Show resolved Hide resolved

__tests__/utils.test.ts Outdated Show resolved Hide resolved

__tests__/Fuzzy.test.ts Outdated Show resolved Hide resolved

test(__tests__): refactored according to feedback.

9bfc05c

vercel bot deployed to Preview July 28, 2024 19:10 View deployment

chore(index.test.ts): fixed typo.

dea26e8

vercel bot deployed to Preview July 28, 2024 19:22 View deployment

Merge branch 'main' into test-addunittests-keminghe

a020e58

vercel bot deployed to Preview July 28, 2024 23:11 View deployment

feat(Fuzzy.ts): added query result in-mem caching.

c476214

Implemented testing for both cache hit and cache miss cases. done #10

vercel bot deployed to Preview July 28, 2024 23:54 View deployment

KemingHe changed the title ~~test(__tests__ dir): added vitest and benchmarking to workflow~~ test(__tests__ dir): added vitest and coverage reporting GitHub Actions workflow Jul 29, 2024

KemingHe mentioned this pull request Jul 29, 2024

Add caching #10

Open

ad1992 requested changes Jul 29, 2024

View reviewed changes

chore(git): hard reset to only testing implementation.

e3264f8

vercel bot deployed to Preview July 29, 2024 14:26 View deployment

test(__tests__/__snapshots/): updated snapshots.

d21b62b

vercel bot deployed to Preview July 29, 2024 14:52 View deployment

remove caching related stuff

ca5420f

vercel bot deployed to Preview July 29, 2024 16:40 View deployment

ad1992 approved these changes Jul 29, 2024

View reviewed changes

package.json Show resolved Hide resolved

ad1992 merged commit c98e6aa into ad1992:main Jul 29, 2024
3 checks passed

KemingHe deleted the test-addunittests-keminghe branch July 29, 2024 18:26

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

test(tests dir): added vitest and coverage reporting GitHub Actions workflow #8

test(tests dir): added vitest and coverage reporting GitHub Actions workflow #8

KemingHe commented Jul 26, 2024 •

edited

Loading

vercel bot commented Jul 26, 2024 •

edited

Loading

KemingHe commented Jul 26, 2024

ad1992 commented Jul 26, 2024

ad1992 left a comment

KemingHe commented Jul 28, 2024

KemingHe commented Jul 28, 2024

ad1992 left a comment

ad1992 Jul 29, 2024

KemingHe Jul 29, 2024

ad1992 Jul 29, 2024

KemingHe Jul 29, 2024

ad1992 Jul 29, 2024

KemingHe Jul 29, 2024

ad1992 Jul 29, 2024

KemingHe Jul 29, 2024

ad1992 Jul 29, 2024

KemingHe Jul 29, 2024

KemingHe commented Jul 29, 2024

KemingHe commented Jul 29, 2024 •

edited

Loading

ad1992 commented Jul 29, 2024 •

edited

Loading

ad1992 left a comment

test(__tests__ dir): added vitest and coverage reporting GitHub Actions workflow #8

test(__tests__ dir): added vitest and coverage reporting GitHub Actions workflow #8

Conversation

KemingHe commented Jul 26, 2024 • edited Loading

Deliverables

Mon. 07/29 Update

Sun. 07/28 Update

Fri. 07/26 Update

vercel bot commented Jul 26, 2024 • edited Loading

KemingHe commented Jul 26, 2024

ad1992 commented Jul 26, 2024

ad1992 left a comment

Choose a reason for hiding this comment

KemingHe commented Jul 28, 2024

KemingHe commented Jul 28, 2024

ad1992 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

KemingHe commented Jul 29, 2024

KemingHe commented Jul 29, 2024 • edited Loading

ad1992 commented Jul 29, 2024 • edited Loading

ad1992 left a comment

Choose a reason for hiding this comment

test(tests dir): added vitest and coverage reporting GitHub Actions workflow #8

test(tests dir): added vitest and coverage reporting GitHub Actions workflow #8

KemingHe commented Jul 26, 2024 •

edited

Loading

vercel bot commented Jul 26, 2024 •

edited

Loading

KemingHe commented Jul 29, 2024 •

edited

Loading

ad1992 commented Jul 29, 2024 •

edited

Loading