feat: cache latest `fuels` version #3186

Dhaiwat10 · 2024-09-19T10:09:14Z

Closes TS-654

Closes Implement caching to check latest fuels version #3177

Summary

This PR adds a basic local cache for the latest fuels version fetched by the fuels CLI.

Checklist

All changes are covered by tests (or not applicable)
All changes are documented (or not applicable)
I reviewed the entire PR myself (preferably, on GH UI)
I described all Breaking Changes (or there's none)

vercel · 2024-09-19T10:09:18Z

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

Name	Status	Preview	Comments	Updated (UTC)
create-fuels-template	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 4, 2024 10:47am
fuels-template	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 4, 2024 10:47am
ts-api-docs	❌ Failed (Inspect)			Oct 4, 2024 10:47am
ts-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 4, 2024 10:47am

1 Skipped Deployment

Name	Status	Preview	Comments	Updated (UTC)
create-fuels-counter-example	⬜️ Ignored (Inspect)			Oct 4, 2024 10:47am

codspeed-hq · 2024-09-19T10:22:41Z

CodSpeed Performance Report

Merging #3186 will degrade performances by 60.41%

_{Comparing dp/fuels-version-cache (a8f0431) with next (a35d644)}

Summary

❌ 2 regressions
✅ 16 untouched benchmarks

⚠️ Please fix the performance issues or acknowledge them on CodSpeed.

Benchmarks breakdown

	Benchmark	`next`	`dp/fuels-version-cache`	Change
❌	`should successfully get transaction cost estimate for multi contract calls (x10 times)`	24.3 ms	30.8 ms	-20.88%
❌	`should successfully conduct a custom transfer between wallets (x10 times)`	48.1 ms	121.5 ms	-60.41%

packages/fuels/src/cli/utils/fuelsVersionCache.ts

packages/fuels/src/cli/utils/getLatestFuelsVersion.ts

packages/fuels/src/cli/utils/fuelsVersionCache.ts

packages/fuels/src/cli/utils/getLatestFuelsVersion.ts

github-actions · 2024-10-03T10:28:41Z

Coverage Report:

Lines	Branches	Functions	Statements
76.69%(+0.02%)	70.65%(-0.83%)	75.54%(-0.11%)	76.81%(+0.05%)

Changed Files:

Ok	File (✨=New File)	Lines	Branches	Functions	Statements
🔴	✨ internal/benchmarks/src/config.ts	0% (+0%)	0% (+0%)	0% (+0%)	0% (+0%)
🔴	internal/benchmarks/src/contract-interaction.bench.ts	0% (+0%)	0% (-100%)	0% (+0%)	0% (+0%)
🔴	internal/benchmarks/src/cost-estimation.bench.ts	0% (+0%)	0% (-100%)	0% (+0%)	0% (+0%)
🔴	internal/benchmarks/src/transaction-results.bench.ts	0% (+0%)	0% (-100%)	0% (+0%)	0% (+0%)
🔴	internal/benchmarks/src/wallet.bench.ts	0% (+0%)	0% (-100%)	0% (+0%)	0% (+0%)
🔴	packages/fuels/src/cli/commands/deploy/deployContract.ts	100% (+0%)	70% (-13.33%)	100% (+0%)	100% (+0%)
🔴	packages/fuels/src/cli/commands/deploy/proxy/types/Src14OwnedProxyFactory.ts	33.33% (-33.33%)	0% (+0%)	0% (-66.66%)	33.33% (-33.33%)
🔴	packages/fuels/src/cli/utils/checkForAndDisplayUpdates.ts	86.66% (-13.34%)	66.66% (-16.67%)	100% (+0%)	86.66% (-13.34%)
🔴	✨ packages/fuels/src/cli/utils/fuelsVersionCache.ts	54.54% (+54.54%)	16.66% (+16.66%)	50% (+50%)	54.54% (+54.54%)
✅	✨ packages/fuels/src/cli/utils/getLatestFuelsVersion.ts	100% (+100%)	100% (+100%)	100% (+100%)	100% (+100%)

packages/fuels/src/cli/utils/fuelsVersionCache.ts

petertonysmith94 · 2024-10-04T10:26:28Z

packages/fuels/src/cli/utils/getLatestFuelsVersion.ts

@@ -0,0 +1,25 @@
+import { checkAndLoadCache, saveToCache } from './fuelsVersionCache';
+
+export const getLatestFuelsVersion = async (): Promise<string | undefined> => {


Could we potentially document the throwable conditions here?

Not sure if I follow you, can you share some pseudo code? What do you mean by documenting the throwable conditions?

petertonysmith94 · 2024-10-04T10:27:24Z

packages/fuels/test/utils/mockCheckForUpdates.ts

@@ -0,0 +1,7 @@
+import * as checkForUpdatesMod from '../../src/cli/utils/checkForAndDisplayUpdates';
+
+export const mockCheckForUpdates = () => {


Why do we always mock a successful resolution?

Because as of now this helper for the mock is only used in places where we always expect this functionality to succeed or not run.

packages/fuels/src/cli.test.ts

arboleya · 2024-10-04T10:59:49Z

packages/fuels/src/cli/utils/fuelsVersionCache.ts

+  const doesVersionCacheExist = fs.existsSync(FUELS_VERSION_CACHE_FILE);
+
+  if (doesVersionCacheExist) {
+    const cachedVersion = fs.readFileSync(FUELS_VERSION_CACHE_FILE, 'utf-8');


Should we trim this?

Suggested change

const cachedVersion = fs.readFileSync(FUELS_VERSION_CACHE_FILE, 'utf-8');

const cachedVersion = fs.readFileSync(FUELS_VERSION_CACHE_FILE, 'utf-8').trim();

arboleya · 2024-10-04T11:08:33Z

packages/fuels/src/cli/utils/getLatestFuelsVersion.test.ts

+    const version = await getLatestFuelsVersion();
+    expect(fetchSpy).toHaveBeenCalled();
+    expect(version).toEqual('1.0.0');
+    expect(saveCacheSpy).toHaveBeenCalledWith('1.0.0');


Because [I'm presuming] you're mocking everything related to the cache, the tests may not cover some critical parts of the functionality. Can we get all files in 100%?

Think this relates - we should cover both success and failure conditions in my opinion.

Dhaiwat10 self-assigned this Sep 19, 2024

github-actions bot added the feat Issue is a feature label Sep 19, 2024

Dhaiwat10 marked this pull request as ready for review September 19, 2024 10:12

Dhaiwat10 requested review from digorithm, arboleya, Torres-ssf, danielbate, nedsalk, petertonysmith94 and maschad as code owners September 19, 2024 10:12

vercel bot deployed to Preview – ts-docs September 19, 2024 10:15 View deployment

vercel bot deployed to Preview – create-fuels-template September 19, 2024 10:15 View deployment

petertonysmith94 reviewed Sep 19, 2024

View reviewed changes

packages/fuels/src/cli/utils/fuelsVersionCache.ts Outdated Show resolved Hide resolved

packages/fuels/src/cli/utils/getLatestFuelsVersion.ts Outdated Show resolved Hide resolved

vercel bot had a problem deploying to Preview – ts-docs September 19, 2024 10:46 Failure

vercel bot had a problem deploying to Preview – create-fuels-template September 19, 2024 10:46 Failure

vercel bot deployed to Preview – ts-docs September 19, 2024 10:52 View deployment

vercel bot deployed to Preview – create-fuels-template September 19, 2024 10:53 View deployment

Dhaiwat10 requested a review from petertonysmith94 September 19, 2024 11:25

nedsalk previously approved these changes Sep 19, 2024

View reviewed changes

vercel bot deployed to Preview – create-fuels-template September 19, 2024 11:33 View deployment

vercel bot deployed to Preview – ts-docs September 19, 2024 11:33 View deployment

arboleya reviewed Sep 19, 2024

View reviewed changes

packages/fuels/src/cli/utils/fuelsVersionCache.ts Outdated Show resolved Hide resolved

packages/fuels/src/cli/utils/getLatestFuelsVersion.ts Show resolved Hide resolved

packages/fuels/src/cli/utils/getLatestFuelsVersion.ts Show resolved Hide resolved

Dhaiwat10 dismissed nedsalk’s stale review via 7c4d96f September 19, 2024 12:35

Dhaiwat10 requested review from nedsalk and arboleya September 19, 2024 12:35

vercel bot deployed to Preview – ts-docs September 19, 2024 12:43 View deployment

vercel bot deployed to Preview – create-fuels-template September 19, 2024 12:43 View deployment

arboleya previously approved these changes Sep 19, 2024

View reviewed changes

Dhaiwat10 added 7 commits October 3, 2024 15:37

remove data from type

8829edf

use a plan-text version file instead of json

fcfc05a

properly reset mocks

0da9888

fix tests failing

30e9179

update mock logic

92d2c56

fix merge conflict

7b07793

fix tests

3ecfed6

Dhaiwat10 force-pushed the dp/fuels-version-cache branch from f65abae to 3ecfed6 Compare October 3, 2024 10:08

Dhaiwat10 changed the base branch from master to next October 3, 2024 10:08

vercel bot had a problem deploying to Preview – ts-api-docs October 3, 2024 10:08 Failure

Dhaiwat10 requested review from petertonysmith94 and Torres-ssf October 3, 2024 10:10

Dhaiwat10 marked this pull request as ready for review October 3, 2024 10:10

vercel bot deployed to Preview – fuels-template October 3, 2024 10:13 View deployment

vercel bot deployed to Preview – ts-docs October 3, 2024 10:13 View deployment

Merge branch 'next' into dp/fuels-version-cache

4d19671

vercel bot deployed to Preview – fuels-template October 4, 2024 10:27 View deployment

vercel bot had a problem deploying to Preview – ts-api-docs October 4, 2024 10:27 Failure

vercel bot deployed to Preview – ts-docs October 4, 2024 10:27 View deployment

petertonysmith94 reviewed Oct 4, 2024

View reviewed changes

Dhaiwat10 added 2 commits October 4, 2024 16:08

refactor

9396b0e

use helper

a8f0431

vercel bot had a problem deploying to Preview – ts-api-docs October 4, 2024 10:42 Failure

vercel bot deployed to Preview – fuels-template October 4, 2024 10:46 View deployment

vercel bot deployed to Preview – ts-docs October 4, 2024 10:47 View deployment

arboleya reviewed Oct 4, 2024

View reviewed changes

arboleya deleted the branch next October 9, 2024 10:26

arboleya closed this Oct 9, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: cache latest `fuels` version #3186

feat: cache latest `fuels` version #3186

Dhaiwat10 commented Sep 19, 2024 •

edited

Loading

vercel bot commented Sep 19, 2024 •

edited

Loading

codspeed-hq bot commented Sep 19, 2024 •

edited

Loading

github-actions bot commented Oct 3, 2024

petertonysmith94 Oct 4, 2024

Dhaiwat10 Oct 4, 2024

petertonysmith94 Oct 4, 2024

Dhaiwat10 Oct 4, 2024

arboleya Oct 4, 2024

arboleya Oct 4, 2024

petertonysmith94 Oct 4, 2024

		@@ -0,0 +1,25 @@
		import { checkAndLoadCache, saveToCache } from './fuelsVersionCache';

		export const getLatestFuelsVersion = async (): Promise<string \| undefined> => {

		@@ -0,0 +1,7 @@
		import * as checkForUpdatesMod from '../../src/cli/utils/checkForAndDisplayUpdates';

		export const mockCheckForUpdates = () => {

	const cachedVersion = fs.readFileSync(FUELS_VERSION_CACHE_FILE, 'utf-8');
	const cachedVersion = fs.readFileSync(FUELS_VERSION_CACHE_FILE, 'utf-8').trim();

feat: cache latest fuels version #3186

feat: cache latest fuels version #3186

Conversation

Dhaiwat10 commented Sep 19, 2024 • edited Loading

Summary

Checklist

vercel bot commented Sep 19, 2024 • edited Loading

codspeed-hq bot commented Sep 19, 2024 • edited Loading

Merging #3186 will degrade performances by 60.41%

Summary

Benchmarks breakdown

github-actions bot commented Oct 3, 2024

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

feat: cache latest `fuels` version #3186

feat: cache latest `fuels` version #3186

Dhaiwat10 commented Sep 19, 2024 •

edited

Loading

vercel bot commented Sep 19, 2024 •

edited

Loading

codspeed-hq bot commented Sep 19, 2024 •

edited

Loading