show latest major version available in `gleam deps update` #3876

andho · 2024-11-22T04:01:44Z

This PR aims to solve #3843.
The sample output from that issue:

 % gleam deps update
  Resolving versions
Downloading packages
 Downloaded 2 packages in 0.01s
 
Hint: the following dependencies have new major versions available...

- wibble@2
- wobble@3

Todos

~~Handle Async: fireoff the checks and show the results at the end.~~ Didn't make sense to do this.
Telemetry? Not sure it's needed for this optional part.
~~Merge version check into a single call~~ Hexpm API doesn't have this. Went with cache instead.
Get the direct dependencies only

lpil · 2024-12-02T15:40:16Z

Hello! Are you still working on this one? Thanks

andho · 2024-12-05T12:27:10Z

Hello! Are you still working on this one? Thanks

I was hoping to work on it this weekend but some things have come up. I can only get back to it next weekend.

andho · 2024-12-06T15:32:25Z

Just the major version hist without any other output is weird though:

Helpful, but looks weird.

inoas · 2024-12-09T13:41:40Z

Could a flag be provided that forces a non-zero exit-code if major deps updates are available?

Would that make sense?

The idea would be to have a CI check that goes red if deps are not up to date.

lpil

Very nice! I've left some small notes inline.

lpil · 2024-12-09T15:47:50Z

compiler-core/src/dependency.rs

+            ]
+            .into_iter()
+            .collect(),
+            //requirements: HashMap::new(),


Unused code here

Haha, this is embarrassing.
PS. Fixed.

lpil · 2024-12-09T15:49:13Z

compiler-cli/src/dependencies.rs

+            let result = runtime_cache.get(package);
+
+            if let Some(result) = result {
+                return Ok(result.clone());


Rather than clone the entire package lets record the highest version here.

Oh! This function is originally used by the DependencyProvider. But as the major version need the same info, but to avoid multiple http calls to hexpm, I've added caching here.

I think the way to avoid cloning would be to have PackageFetcher own package (and return a ref) but that would have to touch the dependency resolution part so I didn't want to include in this PR (increased scope).

Here's an implementation with PackageFetcher owning packages and RefCounting: andho@851b9a6

Ah I just realized I never wired up the same PackageFetcher to be used in other parts of the dependency resolution so the cache is not even used. I'll see about getting that wired up soon.

PackageFetcher is now passed by reference in all instances and instantiated in list and download only.

It would be best to do that as to not clone everything. Do you think it would be complex or involved?

lpil · 2024-12-09T15:50:10Z

compiler-core/src/dependency.rs

+            let Some(latest) = &hexpackage
+                .releases
+                .iter()
+                .map(|release| release.version.clone())


Can take a reference here and avoid cloning

lpil · 2024-12-09T15:50:35Z

compiler-core/src/dependency.rs

+                .sorted_by(|a, b| b.cmp(a))
+                .next()


Using .max will be faster than sorting and taking the first

lpil · 2024-12-09T15:51:38Z

compiler-cli/src/dependencies.rs

+
+        // lazily assuming the longest version could be 8 characters. eg: 1.1234.2
+        // excluding qualifiers other than x.y.z
+        eprintln!("{name}:{padding} {v1:<8} -> {v2:<8}");


Let's render this to a string and then snapshot test the function. This function can then just print the string and not be responsible for formatting and printing

andho · 2024-12-13T05:34:52Z

Could a flag be provided that forces a non-zero exit-code if major deps updates are available?

Would that make sense?

The idea would be to have a CI check that goes red if deps are not up to date.

@inoas I think the flag would make more sense in a gleam deps outdated command instead.

…pendencies ✨

…or direct dependencies ✨

…st ✨

…err instead of stdout ♻️

…ns ✨

…eable ♻️

… calls ✨

…of `sort` ♻️

…cy resolution and major version resolution to reduce network calls to hexpm ♻️

lpil

Great, thank you.

I gave it a try and while the information is there and useful I don't think it fits in at all with any of the other information printed. How can we show this better?

Should it be shown for all resolution or only for gleam update? If the latter it would be easier to make a good output format for it.

andho · 2024-12-18T03:36:35Z

Should it be shown for all resolution or only for gleam update?

It makes sense to show for gleam update and gleam deps download

Although it was helpful when I recently did gleam build and I saw that decode package was updated to 1.0.0. But due to the execution order it would take some rearranging to get this output to come last.

I'd say for an MVP show only in gleam update and gleam deps download. I'll only have to add a flag to download fn.

lpil · 2024-12-19T11:55:54Z

Sounds great!

andho mentioned this pull request Nov 22, 2024

Notify of new major versions available when running gleam update #3843

Closed

lpil marked this pull request as draft November 22, 2024 13:50

andho force-pushed the notify-major-version branch from 320e39f to fa633dc Compare December 6, 2024 03:33

andho marked this pull request as ready for review December 6, 2024 15:25

andho force-pushed the notify-major-version branch from 300e9eb to 2f1055d Compare December 9, 2024 11:02

lpil reviewed Dec 9, 2024

View reviewed changes

lpil marked this pull request as draft December 9, 2024 15:55

andho force-pushed the notify-major-version branch from 0781fc3 to c2e7c65 Compare December 12, 2024 16:21

andho added 11 commits December 13, 2024 12:15

feat(dependency): add function to get latest major version info of de…

a3d177a

…pendencies ✨

feat(dependencies): check and show new major versions are available f…

5c49632

…or direct dependencies ✨

feat: only check for major version for direct dependencies ✨

9085d45

feat: ignore pre release versions and sort versions before getting la…

0226753

…st ✨

refactor(dependencies): output major version availability hint to std…

ef55422

…err instead of stdout ♻️

refactor: move major version check into a separate testable unit ♻️

8725777

feat(dependencies): pretty print major version update hint into colum…

48488cc

…ns ✨

refactor: improve the test case so the direct dependency is not updat…

f268f8f

…eable ♻️

feat(dependencies): cache package info from hexpm to reduce duplicate…

7fdbcd7

… calls ✨

refactor(dependencies): return formatted string and eprint ♻️

dd24f26

refactor(dependency): remove unnecessary clone and use max instead …

ce0b650

…of `sort` ♻️

andho force-pushed the notify-major-version branch from c2e7c65 to ce0b650 Compare December 13, 2024 07:15

refactor(dependencies): use the same PackageFetcher during dependen…

839318a

…cy resolution and major version resolution to reduce network calls to hexpm ♻️

andho force-pushed the notify-major-version branch from 100bf86 to 839318a Compare December 13, 2024 12:54

docs(dependencies): fix doc comment for cache_package 🐛 📝

9411d63

andho marked this pull request as ready for review December 13, 2024 13:03

andho changed the title ~~Draft: show latest major version available in gleam deps update~~ show latest major version available in gleam deps update Dec 14, 2024

andho requested a review from lpil December 14, 2024 13:05

lpil reviewed Dec 17, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

show latest major version available in `gleam deps update` #3876

show latest major version available in `gleam deps update` #3876

andho commented Nov 22, 2024 •

edited

Loading

lpil commented Dec 2, 2024

andho commented Dec 5, 2024

andho commented Dec 6, 2024

inoas commented Dec 9, 2024 •

edited

Loading

lpil left a comment •

edited

Loading

lpil Dec 9, 2024

andho Dec 12, 2024 •

edited

Loading

lpil Dec 9, 2024

andho Dec 12, 2024

andho Dec 13, 2024

andho Dec 13, 2024

andho Dec 13, 2024

lpil Dec 17, 2024

lpil Dec 9, 2024

andho Dec 13, 2024

lpil Dec 9, 2024

andho Dec 13, 2024

lpil Dec 9, 2024

andho Dec 13, 2024

andho commented Dec 13, 2024

lpil left a comment

andho commented Dec 18, 2024

lpil commented Dec 19, 2024

show latest major version available in gleam deps update #3876

Are you sure you want to change the base?

show latest major version available in gleam deps update #3876

Conversation

andho commented Nov 22, 2024 • edited Loading

Todos

lpil commented Dec 2, 2024

andho commented Dec 5, 2024

andho commented Dec 6, 2024

inoas commented Dec 9, 2024 • edited Loading

lpil left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

andho Dec 12, 2024 • edited Loading

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

andho commented Dec 13, 2024

lpil left a comment

Choose a reason for hiding this comment

andho commented Dec 18, 2024

lpil commented Dec 19, 2024

show latest major version available in `gleam deps update` #3876

show latest major version available in `gleam deps update` #3876

andho commented Nov 22, 2024 •

edited

Loading

inoas commented Dec 9, 2024 •

edited

Loading

lpil left a comment •

edited

Loading

andho Dec 12, 2024 •

edited

Loading