feat: add support for npm package by b4s36t4 · Pull Request #488 · tailcallhq/tailcall

b4s36t4 · 2023-10-13T15:51:53Z

Summary:
This PR adds support for tailcall npm package to be publishable via CI pipelines.

Issue Reference(s):
Fixes #470

/claim #470

Build & Testing:

I ran cargo test successfully.
I have run ./lint.sh to address and fix linting issues.

Checklist:

I have added relevant unit & integration tests.
I have updated the documentation accordingly (if applicable).
I have performed a self-review of my own code.

Demo

as.mp4

b4s36t4 · 2023-10-13T15:57:30Z

Heavily inspired from swc and biomejs implementations.

This version only installs the binary depends on the arch of user's system @tusharmath

tusharmath · 2023-10-14T06:49:17Z

Saw the video ❤️
Will we be able to use it by installing globally?

npm i -g @tailcallhq/tailcall

tusharmath · 2023-10-14T06:49:26Z

Can you run ./lint.sh

npm/tailcall/package.json

tusharmath · 2023-10-14T06:51:52Z

.github/workflows/ci.yml

+        # CD to package and publish and move back to top-level folder
+        run: for package in npm/*; do cd $package; npm publish --tag latest --access public --provenance; cd ../..; done
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}


Can we not publish everything together? What happens if one of the publish command fails?

Can we log after every publish?

If one of them fails other one continues.

Logging in the sense? Just printing that one of the package is published right?

Also by default npm would console everything related to push and the reason for push fails etc.

Good point. npm logs should be enough.

but ignoring error in that case could mask the problem as the ci will pass successfully and to know about problem we need to thoroughly read through logs or inspect npm packages

we can also add an dry-run npm release workflow in order to able to test that everything works as expected especially before merging this

We should use npm publish --workspaces command instead of looping using bash.

https://docs.npmjs.com/cli/v7/commands/npm-publish#workspaces

.github/workflows/ci.yml

tusharmath · 2023-10-14T06:54:35Z

We can remove the generated files from being committed to git?

b4s36t4 · 2023-10-14T08:03:45Z

Yes, we can able to run it globally too.

I will update the PR with the comments you provided. Thanks.

b4s36t4 · 2023-10-14T08:06:13Z

I can't able to lint.sh can you provide a doc on how to run it? Some errors it seems.

tusharmath · 2023-10-14T10:27:54Z

There are a few other comments @b4s36t4
For the lint, you can just run prettier. The build is passing, so it might not be required.

b4s36t4 · 2023-10-14T10:37:31Z

I think due to the difference in remote config and other issues.
Also I did a force push which caused some of issues stale.

If you could can you please review it again?

except removing postinstall.js file exporting in package.json.

Rest looks good to me based on previous review.

tusharmath · 2023-10-14T10:38:57Z

Yikes!
Commenting below so that it doesn't get lost —

Remove generated files from Git.

npm/tailcall/scripts/generate-packages.js

.github/workflows/ci.yml

meskill · 2023-10-15T08:02:03Z

.github/workflows/ci.yml

+        # CD to package and publish and move back to top-level folder
+        run: for package in npm/*; do cd $package; npm publish --tag latest --access public --provenance; cd ../..; done
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}


but ignoring error in that case could mask the problem as the ci will pass successfully and to know about problem we need to thoroughly read through logs or inspect npm packages

npm/tailcall/scripts/generate-packages.js

npm/tailcall/package.json

.github/workflows/ci.yml

npm/tailcall/scripts/generate-packages.js

.github/workflows/ci.yml

b4s36t4 · 2023-10-15T12:04:28Z

@meskill Thanks for the review, it does make a lot of sense to make your suggested changes. It did came up nice and easy.

Really appreciate it :)

b4s36t4 · 2023-10-15T12:04:48Z

@tusharmath Please review the PR now. Let me know if there's anything missing thanks :).

tusharmath · 2023-10-15T12:07:49Z

@b4s36t4 #488 (comment)

b4s36t4 · 2023-10-15T12:11:01Z

I don't think there are any generated files. All the package.json files are intended.

https://github.com/swc-project/swc/tree/main/scripts/npm/ see this for the reference.

tusharmath · 2023-10-15T12:13:30Z

@b4s36t4 Though SWC is committing the files to git, I don't think it's a good idea for our current setup. These files can be generated, and contain the release version in them. We will end up creating a commit everytime we make a release, which is unnecessary.

b4s36t4 · 2023-10-15T12:18:21Z

Will update.

b4s36t4 · 2023-10-16T16:35:18Z

@tusharmath Sorry for asking questions such lately.

But As you mentioned we need to wipe/no-commit package.json files committed to github, I want to bring this attention if we delete the package.json and do this file generation with the script wouldn't that be complex?

If you see we're building the tailcall for different platforms for different arch types handling these conditions inside the script would make the script a bit complex, agree?

As per the comment to commit everytime the package.json we don't have to. We can keep them as a read-only files (need to remove version key from package.json) except I don't see any problem with committing these files.

Let me know your thoughts.

tusharmath · 2023-10-17T10:09:37Z

But As you mentioned we need to wipe/no-commit package.json files committed to github, I want to bring this attention if we delete the package.json and do this file generation with the script wouldn't that be complex?

It would be easier to manage the platforms this way. We could just configure the script to generate the package.json file for that particular platform. This is quite standard in node.js projects actually.

If you see we're building the tailcall for different platforms for different arch types handling these conditions inside the script would make the script a bit complex, agree?

I am not sure why should the build script change. What I am saying is - we should write a node.js script, that generates the dirs, readme, package.json, and copy appropriate release builds for the platforms we wish to support. Those package.json should be created from a template.package.json.

As per the comment to commit everytime the package.json we don't have to. We can keep them as a read-only files (need to remove version key from package.json) except I don't see any problem with committing these files.

You are right we don't "need" to commit. However as discussed, generating the files using a template would make it easier for us to change the meta data about the package easily.

tusharmath · 2023-10-17T10:11:41Z

npm/tailcall/package.json

+  "engines": {
+    "node": ">=14.*"
+  }
+}


This should be a private package.
set private:true.

Add workspaces for each supported platform.

github-actions · 2023-10-19T11:02:37Z

Action required: PR inactive for 2 days.
Status update or closure in 2 days.

b4s36t4 · 2023-10-19T11:05:26Z

Working on few other things, probably would be completing things by tomorrow.

github-actions · 2023-10-21T13:02:49Z

Action required: PR inactive for 2 days.
Status update or closure in 2 days.

github-actions · 2023-10-23T13:04:24Z

PR closed after 2 days of inactivity.

tusharmath · 2023-11-03T11:06:16Z

/tip $10 @b4s36t4

algora-pbc · 2023-11-03T11:06:32Z

🎉🎈 @b4s36t4 has been awarded $10! 🎈🎊

algora-pbc bot mentioned this pull request Oct 13, 2023

Publish tailcall on npm #470

Closed

algora-pbc bot added the 🙋 Bounty claim label Oct 13, 2023

b4s36t4 force-pushed the feat/npm branch from 2519a75 to 0218d91 Compare October 13, 2023 16:04

tusharmath reviewed Oct 14, 2023

View reviewed changes

npm/tailcall/package.json Outdated Show resolved Hide resolved

tusharmath reviewed Oct 14, 2023

View reviewed changes

npm/tailcall/package.json Outdated Show resolved Hide resolved

tusharmath reviewed Oct 14, 2023

View reviewed changes

.github/workflows/ci.yml Outdated Show resolved Hide resolved

b4s36t4 force-pushed the feat/npm branch from 77028e1 to 23c0345 Compare October 14, 2023 08:17

tusharmath reviewed Oct 14, 2023

View reviewed changes

npm/tailcall/scripts/generate-packages.js Show resolved Hide resolved

tusharmath mentioned this pull request Oct 14, 2023

add npm publish #483

Closed

algora-pbc bot mentioned this pull request Oct 14, 2023

Pass operations to check command #416

Closed

meskill reviewed Oct 15, 2023

View reviewed changes

tusharmath reviewed Oct 17, 2023

View reviewed changes

github-actions bot added the Stale label Oct 19, 2023

github-actions bot removed the Stale label Oct 19, 2023

github-actions bot added the Stale label Oct 21, 2023

github-actions bot closed this Oct 23, 2023

tusharmath reopened this Nov 1, 2023

b4s36t4 added 5 commits November 1, 2023 10:56

feat: add support for npm package

3f1a581

fix: refactoring

c0f12c9

fix: run lint

dbf405e

fix: update npm run command

a4806b7

fix: imporve ci pipeline

3e2809f

tusharmath force-pushed the feat/npm branch from 9c46057 to 3e2809f Compare November 1, 2023 05:26

tusharmath changed the base branch from main to npm-package November 1, 2023 05:26

tusharmath changed the base branch from npm-package to main November 1, 2023 05:26

tusharmath enabled auto-merge (squash) November 1, 2023 05:27

tusharmath changed the base branch from main to npm-package November 1, 2023 05:28

tusharmath merged commit a177f16 into tailcallhq:npm-package Nov 1, 2023

tusharmath mentioned this pull request Nov 1, 2023

feat: publish npm package #532

Closed

5 tasks

algora-pbc bot added the 💰 Rewarded label Nov 3, 2023

github-actions bot added the state: inactive No current action needed/possible; issue fixed, out of scope, or superseded. label Dec 31, 2023

Conversation

b4s36t4 commented Oct 13, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

b4s36t4 commented Oct 13, 2023

Uh oh!

tusharmath commented Oct 14, 2023

Uh oh!

tusharmath commented Oct 14, 2023

Uh oh!

Uh oh!

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!

Uh oh!

tusharmath commented Oct 14, 2023

Uh oh!

b4s36t4 commented Oct 14, 2023

Uh oh!

b4s36t4 commented Oct 14, 2023

Uh oh!

tusharmath commented Oct 14, 2023

Uh oh!

b4s36t4 commented Oct 14, 2023

Uh oh!

tusharmath commented Oct 14, 2023

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

b4s36t4 commented Oct 15, 2023

Uh oh!

b4s36t4 commented Oct 15, 2023

Uh oh!

tusharmath commented Oct 15, 2023

Uh oh!

b4s36t4 commented Oct 15, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tusharmath commented Oct 15, 2023

Uh oh!

b4s36t4 commented Oct 15, 2023

Uh oh!

b4s36t4 commented Oct 16, 2023

Uh oh!

tusharmath commented Oct 17, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Oct 19, 2023

Uh oh!

b4s36t4 commented Oct 19, 2023

Uh oh!

github-actions bot commented Oct 21, 2023

Uh oh!

github-actions bot commented Oct 23, 2023

Uh oh!

tusharmath commented Nov 3, 2023

Uh oh!

algora-pbc bot commented Nov 3, 2023

Uh oh!

b4s36t4 commented Oct 13, 2023 •

edited

Loading

b4s36t4 commented Oct 15, 2023 •

edited

Loading