Support pre-release versions for PureScript tool #27

JordanMartinez · 2022-02-25T23:37:35Z

Fixes #26 using the below syntax

steps:
  - uses: actions/checkout@v2
  - uses: purescript-contrib/setup-purescript@main
    with:
      purescript: "unstable-0.15.0"

Similar to using latest as the version string, the code will find the most recent pre-release version whose version matches the one used in the string. So unstable-0.15.0 or unstable-v0.15.0 would drop the unstable- prefix and parse the 0.15.0 part as its corresponding Version value. Using the Version value, we search for the first pre-release version that has the same version (albeit different pre-release or build metadata). Thus, unstable-0.15.0 would match 0.15.0-rc.1, 0.15.0-rc.2, or 0.15.0-rc.3, etc.. Moreover, unstable-0.15.1 would not find 0.15.0-rc.1 or vice versa.

In the event there are multiple pre-releases, we use whichever one was published most recently. GitHub's API returns the most recent releases first, so we don't have to do any additional sorting. If this ever changes, we'd need to update the code.

Using this API URL: https://api.github.com/repos/purescript/purescript/releases?per_page=10&page=1 the releases at the given index prove this ordering:

index 6: v0.14.0
index 7: v0.14.0-rc.5
index 8: v0.14.0-rc.4
index 9: v0.14.0-rc.3

src/Setup/UpdateVersions.purs

src/Setup/BuildPlan.purs

thomashoneyman · 2022-02-28T17:44:09Z

@JordanMartinez Thanks for putting this together!

I don't think we need this amount of flexibility around the unstable option; I would prefer that unstable simply refers to the very latest version of the compiler, regardless of whether it is an rc or not. The same way that latest lets you get the latest (stable) version of the compiler, but you can't say "latest-0.15.1", unstable would get you the latest version of the compiler including release candidates.

If we want to let you opt in to the latest in a particular series or something then we should probably support SemVer ranges rather than come up with our own scheme.

JordanMartinez · 2022-02-28T17:47:30Z

Ok, I'll update this PR to do that.

JordanMartinez · 2022-02-28T18:27:17Z

unstable now works exactly like latest (across all tools, not just PureScript) except that pre-releases are included.

src/Setup/UpdateVersions.purs

thomashoneyman · 2022-02-28T18:47:23Z

I can’t give this a good review until later today, but at a glance it looks good to me.

thomashoneyman · 2022-02-28T22:07:16Z

src/Setup/BuildPlan.purs

+      liftEffect do
+        Core.info $ fold [ "Fetching most recent version (pre-release or not) for ", Tool.name tool ]
+      version <- liftAff $ fetchFromGitHubReleases AnyRelease (Tool.repository tool)
+      pure (pure { tool, version })


Usually we read the latest tag from the stored versions.json file:
https://github.com/purescript-contrib/setup-purescript/blob/main/dist/versions.json

We do this because it's really easy to burn requests to the GitHub API and these versions don't change that frequently. You can see this in practice in the Latest case right above this, where we read the file.

I think we might want to update the format of this file to something like:

{ "purs": { "stable": ..., "unstable": ... }, ... }

and then we can read either the latest stable or unstable version depending on what the user wants. Note that if we ever want to update to the latest unstable version faster than the daily check this repo does, we can always manually update the versions.json file right away.

(At this point it would probably help to have an actual type and JSON encoding / decoding, rather than the inline thing we've got going now)

I keep trying to write this but then run into friction over the design of this project. Could you clarify why Tool and Key are separate things?

The difference is a little annoying, and we probably should have just used the executable name for everything. But the reason it exists is that there can be a difference between the name of a tool (PureScript) and the name of the executable (purs).

Other than that, the only difference between Tool and Key is that the tool is a data type and the key is a string, the actual thing the user types into their action.yml file.

thomashoneyman · 2022-02-28T22:08:35Z

We also need to update the README to acknowledge this is a possible version to specify:

https://github.com/purescript-contrib/setup-purescript#specify-versions

This JSON encoding doesn't yet produce the JSON that would decode properly here.

Note: for tools using fetchFromGitHubTags, latest is the same as unstable

JordanMartinez · 2022-03-01T12:56:09Z

~~So... I ran node update.js locally and it never terminated. I'm assuming that's a bug in my code?~~

Edit: it did terminate but it took a long time.

JordanMartinez · 2022-03-01T13:13:00Z

CI is failing because it's attempting to read master's versions.json file rather than the updated one I pushed here.

Perhaps we should add an env check to use the PR's versions.json file if we detect we're in CI?

JordanMartinez · 2022-03-01T13:44:59Z

CI now builds.

JordanMartinez · 2022-03-01T18:39:08Z

Per a call with Thomas, the following issues were pointed out.

First, while most of contrib libraries use setup-purescript@main, the problem is other libraries may be using setup-purescript@someVersion. The compiled code always checks the main branch's versions.json file to see what the latest version is. By migrating the schema to something else, such libraries' CI will fail.

One could ask, "Why wasn't this repo released, such that the versions file is frozen to prevent such migration issues?" Freezing the file like that would prevent the latest version field from working. Either one would have to call GitHub's API to get that info every time CI ran, which could lead to rate limiting, or one can read the versions.json file and use less requests. So, reading the main branch's versions.json file is actually necessary for the "latest version" feature.

Second, to workaround this design constraint, we can provide different versions of the versions.json file. For example, the versions.json file will remain untouched. But we can create a versions-v2.json that does use the schema proposed here (i.e. purs: { latest: ..., unstable: ... }. By using two separate files, we enable the following workflow:

updating the versions.json will update all versions.json files, such that the "latest version" feature still works regardless of which version of setup-purescript CI is using
for the current main branch, only read from the latest versions.json file (i.e. versions-v2.json for this PR)
if we need to support new versions or change the schema again, we can create a new file (e.g. versions-v3.json) and the old code will still function correctly.

Third, since this new design touches a couple of things, we'll want to implement it in a single module to keep everything together.

Note: this PR still updates purs to v0.14.7

JordanMartinez · 2022-03-01T21:05:45Z

@thomashoneyman I haven't tested this locally, but this is the design I went with. I can walk you through this via a call if that would help, but I'll try to summarize things below.

I put the version files in src/Setup/Data/VersionFiles.purs. latestVersion should point to the latest one, so that way it's easier to verify that we're updating every usage of it. Perhaps you want even more code moved into VersionFiles.purs, but I thought this was a good start to see if my approach is good.

In the codecs, I decided not to reuse things like Tool.name because I'm not sure if we would want to change that in the future or not (e.g. add new cases, etc.). So, the codecs should continue to work despite whatever changes we make to the Tool type.

thomashoneyman · 2022-03-01T21:13:48Z

README.md

+Each tool can accept one of the following:
+- a semantic version (only exact versions currently supported)
+- the string `"latest"`, which represents the latest non-prerelease version
+- the string `"unstable"`, which represents the latest version (pre-release or not)


Perhaps we can specify that:

"latest" will bring in the latest version that uses major, minor, and patch, but it will omit versions using build metadata or prerelease identifiers

"unstable" will bring in the latest version no matter what it is (ie. build metadata and prerelease identifiers are accepted)

thomashoneyman · 2022-03-01T21:19:44Z

src/Setup/Data/VersionFiles.purs

+  -- in case we add support for other tools in the future...
+  toolToMbString = case _ of


Maybe just printTool for the name, and update the comment to say something like:

-- We preserve the set of tools that existed at the time this version format was produced; -- if more tools are added, they should map to `Nothing`

thomashoneyman · 2022-03-01T21:21:09Z

src/Setup/UpdateVersions.purs

+      Just versions' -> do
+        let
+          unstable = firstUnstableVersion <|> Array.head versions'
+          latest = Array.find (not <<< Version.isPreRelease) versions'


This really ought to check for build metadata, too. We can check that the Version.buildMetadata list is empty.

https://github.com/hdgarrood/purescript-versions/blob/9799321bfa516b05d68bea8da7b706219e87edd8/src/Data/Version.purs#L85-L86

thomashoneyman · 2022-03-01T21:22:02Z

src/Setup/UpdateVersions.purs

+                      pure
+                        if isDraft then Nothing
+                        else Just version


This is a little clunky (I know it's not your code) -- mind updating it to use guard?

I tried, but either implementation of guard doesn't work.

src/Setup/UpdateVersions.purs:165:23 165 guard isDraft ^^^^^^^^^^^^^ No type class instance was found for Control.Alternative.Alternative Aff while applying a function guard of type Alternative t2 => Boolean -> t2 Unit to argument isDraft while checking that expression guard isDraft has type t0 t1 in value declaration toolVersions

and

src/Setup/UpdateVersions.purs:165:23 165 guard isDraft version ^^^^^^^^^^^^^^^^^^^^^ Could not match type Version with type t0 (Maybe t3)

or

src/Setup/UpdateVersions.purs:165:23 165 guard isDraft $ Just version ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Could not match type Version with type Maybe t3

Ah, the ol' guardA. No worries, we can leave it as-is.

thomashoneyman · 2022-03-01T21:22:34Z

This looks good enough for me! With my comments addressed we can move forward. Thanks!

JordanMartinez · 2022-03-01T21:52:51Z

Also, did you want to update your PureScript version in Nix? Looks like you're on v0.14.3 right now.

thomashoneyman · 2022-03-01T22:00:47Z

If you don't mind, it would be great to update! Thanks!

src/Setup/Data/VersionFiles.purs

JordanMartinez added 4 commits February 25, 2022 17:08

Run constructBuildPlan in Aff

bdfa409

Enable fFGHR to use first pre-release found

05cc8f5

Dedent 'where' functions and add type sigs

cdd7670

Export fFGHR and use in getVersionField

2bdff82

JordanMartinez commented Feb 25, 2022

View reviewed changes

src/Setup/UpdateVersions.purs Outdated Show resolved Hide resolved

JordanMartinez commented Feb 25, 2022

View reviewed changes

src/Setup/BuildPlan.purs Outdated Show resolved Hide resolved

JordanMartinez mentioned this pull request Feb 28, 2022

Export Version.patch hdgarrood/purescript-versions#10

Closed

Make unstable get latest release (pre-release or not)

e7b9356

thomashoneyman reviewed Feb 28, 2022

View reviewed changes

src/Setup/UpdateVersions.purs Outdated Show resolved Hide resolved

JordanMartinez added 2 commits February 28, 2022 12:54

Rename any release to stable release

e68d290

Put branch on new line

2325aac

thomashoneyman reviewed Feb 28, 2022

View reviewed changes

JordanMartinez added 10 commits February 28, 2022 16:32

Update readme about 'unstable' version

93b1078

Duplicate logic for unstable; print different info msg

406f938

Parse desired label's version

604dd73

This JSON encoding doesn't yet produce the JSON that would decode properly here.

Relocate ToolMap; define and use its Json codecs

da96920

Use 1 API call run to get latest and unstable

a935a5e

Note: for tools using fetchFromGitHubTags, latest is the same as unstable

Update spago deps to fix error

0dcfa89

Use custom Map codec to produce more common json

ecf352a

Rebuild code in nix-shell

38f1b1a

Run node update.js

bb08218

Merge branch 'main' into support-pre-release-versions

85b8dd5

Temp - print json being decoded

700c10e

JordanMartinez added 2 commits March 1, 2022 07:40

Use env to determine which versions file to use

25b6c93

Run npm run build while in nix-shell

eefd145

JordanMartinez added 3 commits March 1, 2022 07:47

No longer print debug info

1d5cd86

Remove unneeded import

abd548e

Run npm run build while in nix-shell

736b373

Revert versions.json schema change

25dcbd5

Note: this PR still updates purs to v0.14.7

JordanMartinez mentioned this pull request Mar 1, 2022

Make first alpha release for v0.15.0 purescript/purescript#4251

Merged

5 tasks

JordanMartinez added 5 commits March 1, 2022 14:57

Add v2 file; encode to all versions, decode from v2

d17111a

Drop ToolMap type

50d457d

Add foreign-object

3792b8e

Run npm run build in nix-shell

80997ca

Run node update.js

4d596c5

thomashoneyman reviewed Mar 1, 2022

View reviewed changes

JordanMartinez added 4 commits March 1, 2022 15:39

Update readme's description of latest and unstable

2ceffc7

Rename to printTool; update comment

a1dd73b

Account for build metadata

1ee3587

Add lists to fix spago error

085bc4e

Run npm run build in nix-shell

b3725fa

thomashoneyman reviewed Mar 1, 2022

View reviewed changes

src/Setup/Data/VersionFiles.purs Outdated Show resolved Hide resolved

Add blank line to end of file

2fcfbb8

thomashoneyman approved these changes Mar 1, 2022

View reviewed changes

JordanMartinez merged commit 05b797a into main Mar 1, 2022

JordanMartinez deleted the support-pre-release-versions branch March 1, 2022 22:07

JordanMartinez mentioned this pull request Mar 1, 2022

Update version.json file path for v2 schema #28

Merged

		-- in case we add support for other tools in the future...
		toolToMbString = case _ of

Support pre-release versions for PureScript tool #27

Support pre-release versions for PureScript tool #27

Uh oh!

Conversation

JordanMartinez commented Feb 25, 2022

Uh oh!

Uh oh!

Uh oh!

thomashoneyman commented Feb 28, 2022

Uh oh!

JordanMartinez commented Feb 28, 2022

Uh oh!

JordanMartinez commented Feb 28, 2022

Uh oh!

Uh oh!

thomashoneyman commented Feb 28, 2022

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

JordanMartinez Feb 28, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

thomashoneyman commented Feb 28, 2022

Uh oh!

JordanMartinez commented Mar 1, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

JordanMartinez commented Mar 1, 2022

Uh oh!

JordanMartinez commented Mar 1, 2022

Uh oh!

JordanMartinez commented Mar 1, 2022

Uh oh!

JordanMartinez commented Mar 1, 2022

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

thomashoneyman commented Mar 1, 2022

Uh oh!

JordanMartinez commented Mar 1, 2022

Uh oh!

thomashoneyman commented Mar 1, 2022

Uh oh!

Uh oh!

Uh oh!

JordanMartinez Feb 28, 2022 •

edited

Loading

JordanMartinez commented Mar 1, 2022 •

edited

Loading