chore(javascript): use tsup bundler #3640

shortcuts · 2024-08-31T19:52:15Z

🧭 What and Why

🎟 JIRA Ticket:

Changes included:

closes algolia/algoliasearch-client-javascript#1544

use tsup instead of rollup, just because I wanted to try it out and it seems to exactly do what we need, a bit faster and easier to configure.

also add attw and publint, in order to debug the exported types, package.json#export field, and the resolved imports.

use tsup (chore)
setup attw and publint (helps with the fix of [bug]: Could not find a declaration file for module '@algolia/client-search' in v5.2.2 algoliasearch-client-javascript#1544)
update commons (was outdated)
provide node and browser bundle for clients (same as with rollup, but now it works again)
provide node bundle for fetch requester (feat)
use esm mini output from tsup into rollup for umd

how to verify it works?

generate and builds the js clients
go to clients/algoliasearch-client-javascript
run test:size, should be all green without being too far from the threshold
run test:bundle on many clients, they are all green
try the 5.2.4-beta.2 directly

algolia-bot · 2024-08-31T19:52:28Z

✔️ Code generated!

Name	Link
🪓 Triggered by	`801b4ae0e1fef99c2f3f30ff320fef154a659f02`
🍃 Generated commit	`4844297e352b8aa77d6e1c26aef483b32105ac5f`
🌲 Generated branch	`generated/chore/javascript-bundle-assertions`

📊 Benchmark results

Benchmarks performed on the method using a mock server, the results might not reflect the real-world performance.

Language	Req/s
javascript	1694
php	1512
python	1020
csharp	1013
ruby	967
java	962
swift	778
go	566
kotlin	501

github-actions · 2024-09-02T14:20:44Z

🚀 Deployed on https://66d6e8f6064dad0b14d73522--api-clients-automation.netlify.app

millotp

this is huuuge, congrats !

millotp · 2024-09-03T06:18:45Z

.github/workflows/check.yml

@@ -226,6 +226,10 @@ jobs:
        if: ${{ startsWith(env.head_ref, 'chore/prepare-release-') }}
        run: cd clients/algoliasearch-client-javascript && yarn test:size

+      - name: Test JavaScript bundle and types
+        if: ${{ startsWith(env.head_ref, 'chore/prepare-release-') }}
+        run: cd clients/algoliasearch-client-javascript && yarn test:bundle


millotp · 2024-09-03T06:20:10Z

clients/algoliasearch-client-javascript/base.tsup.config.ts

+    ...getBaseConfig(cwd),
+    platform: 'browser',
+    format: ['esm'],
+    target: ['chrome109', 'safari15.6', 'firefox115', 'edge126'],


ie is also a valid target, don't you want to include it ?

The enum for target are prefixes actually, if you don't give a precise version for browsers it asks for it at runtime

millotp · 2024-09-03T06:20:49Z

clients/algoliasearch-client-javascript/package.json

@@ -12,7 +12,8 @@
    "release:bump": "lerna version ${0:-patch} --no-changelog --no-git-tag-version --no-push --exact --force-publish --yes",
    "release:publish": "tsc --project scripts/tsconfig.json && node scripts/dist/scripts/publish.js",
    "test": "lerna run test $*",
-    "test:size": "bundlesize"
+    "test:size": "bundlesize",
+    "test:bundle": "lerna run test:bundle --verbose --skip-nx-cache --include-dependencies"


why the skip cache everywhere ? on the build step too ?

nx and lerna was still in an early phase when I set it up and there wad cache issues, I guess it's legacy but we should be able to remove it as on the ci there's always no cache

we could cache the .nx folder on the CI

idk how flaky it is but yup maybe

millotp · 2024-09-03T06:24:19Z

templates/javascript/clients/algoliasearch/lite.d.mustache

@@ -1,2 +1,2 @@
 // eslint-disable-next-line import/no-unresolved
-export * from './dist/lite/builds/node';
+export * from './dist/lite/node';


can you delete this template and just create the d.ts file directly pls ?

This allows adding a new client without touching the js repo normally, if we remove those it means documenting to add them etc... it's easier that way

some files already need to be copied manually, I think we will just copy the package if we add a new spec

some files already need to be copied manually

true but ideally you'd just add your spec and that's it

millotp · 2024-09-03T06:24:24Z

templates/javascript/clients/algoliasearch/lite.mustache

millotp · 2024-09-03T06:24:32Z

templates/javascript/clients/index.d.mustache

@@ -1,2 +1,2 @@
 // eslint-disable-next-line import/no-unresolved
-export * from './dist/{{#isAlgoliasearchClient}}algoliasearch/{{/isAlgoliasearchClient}}builds/node';
+export * from './dist/node';


millotp

nothing to add, gg !

Co-authored-by: Clément Vannicatte <vannicattec@gmail.com>

algolia/api-clients-automation#3640 Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com> Co-authored-by: Clément Vannicatte <vannicattec@gmail.com>

xPaw · 2024-09-12T17:09:17Z

After this release, the umd build lite client (dist/lite/builds/browser.umd.js) is being exported as window.lite.liteClient, but before it was being exported as window[ 'algoliasearch/lite' ].liteClient, this does not seem ideal.

shortcuts · 2024-09-12T19:43:53Z

indeed @xPaw and this shouldn't have changed (created an issue #3700), I'll try to see if we can provide both

chore(javascript): assert against bundled package

445289b

shortcuts self-assigned this Aug 31, 2024

shortcuts added 4 commits September 1, 2024 00:19

feat: tsup

0571a41

chore: gen failures

610bca3

feat: tsup but that works except algoliasearch

a9b0ae2

feat: tsup but now algoliasearch works

1c7c9b8

shortcuts changed the title ~~chore(javascript): assert against bundled package~~ chore(javascript): use tsup bundler Sep 1, 2024

shortcuts added 7 commits September 1, 2024 23:25

fix: algoliasearch imports and tests

c24242b

feat: node and browser for fetch requester

8f81c94

chore: test

98ef2ce

chore: can't reproduce?

8de72b7

feat: umd

b9ba52a

Merge branch 'main' into chore/javascript-bundle-assertions

b30393d

chore: deps

a551920

shortcuts mentioned this pull request Sep 2, 2024

[bug]: Could not find a declaration file for module '@algolia/client-search' in v5.2.2 algolia/algoliasearch-client-javascript#1544

Closed

shortcuts added 6 commits September 2, 2024 14:28

Merge branch 'main' into chore/javascript-bundle-assertions

ec87f65

fix: path to algoliasearch

2a7122a

fix: minify esm

ed1edc3

fix: algoliasearch deps and lite imports

750deb1

fix: algoliasearch deps and lite imports

ff711aa

Merge branch 'main' into chore/javascript-bundle-assertions

1ea8cd8

shortcuts changed the title ~~chore(javascript): use tsup bundler~~ chore(javascript): use tsup bundler [skip-bc] Sep 2, 2024

shortcuts added 5 commits September 2, 2024 15:49

chore: reuse some config

4a320a9

chore: generation file

7614289

Merge branch 'main' into chore/javascript-bundle-assertions

19a9a4d

chore: lite root files

44605ac

chore: template files

8c6ca79

shortcuts marked this pull request as ready for review September 2, 2024 14:03

shortcuts requested a review from a team as a code owner September 2, 2024 14:03

shortcuts requested review from Fluf22 and millotp September 2, 2024 14:03

shortcuts changed the title ~~chore(javascript): use tsup bundler [skip-bc]~~ chore(javascript): use tsup bundler Sep 2, 2024

shortcuts added 7 commits September 2, 2024 16:28

chore: legacy algoliasearch umd file name

33b0d9d

Merge branch 'main' into chore/javascript-bundle-assertions

5e89f1d

chore: prevent flaky builds

9323543

Merge branch 'main' into chore/javascript-bundle-assertions

1778083

chore: publint and attw on the ci

3e9cbcb

chore: also on commons

d79ed18

chore: template

177c6f0

millotp reviewed Sep 3, 2024

View reviewed changes

shortcuts added 6 commits September 3, 2024 09:40

chore: model not models

96e338a

chore: package and tsup fixes

f1e404c

chore: do not mix types and imports

214ad33

fix: esm with ts refs

42f5382

chore: filter requester not matching env

1140310

fix: filter on external deps

9534650

millotp approved these changes Sep 3, 2024

View reviewed changes

shortcuts merged commit ff0c996 into main Sep 3, 2024
25 checks passed

shortcuts deleted the chore/javascript-bundle-assertions branch September 3, 2024 11:52

algolia-bot added a commit that referenced this pull request Sep 3, 2024

chore(javascript): use tsup bundler (#3640) (generated) [skip ci]

4a39f64

Co-authored-by: Clément Vannicatte <vannicattec@gmail.com>

BigGillyStyle mentioned this pull request Sep 11, 2024

[bug]: 5.2.5+ breaks Parcel algolia/algoliasearch-client-javascript#1551

Closed

shortcuts mentioned this pull request Sep 12, 2024

[bug]: window export changed after tsup bundler #3700

Closed

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore(javascript): use tsup bundler #3640

chore(javascript): use tsup bundler #3640

shortcuts commented Aug 31, 2024 •

edited

Loading

algolia-bot commented Aug 31, 2024 •

edited

Loading

github-actions bot commented Sep 2, 2024 •

edited

Loading

millotp left a comment

millotp Sep 3, 2024

millotp Sep 3, 2024 •

edited

Loading

shortcuts Sep 3, 2024

millotp Sep 3, 2024

shortcuts Sep 3, 2024

millotp Sep 3, 2024

shortcuts Sep 3, 2024

millotp Sep 3, 2024

shortcuts Sep 3, 2024

millotp Sep 3, 2024

shortcuts Sep 3, 2024

millotp Sep 3, 2024

millotp Sep 3, 2024

millotp left a comment

xPaw commented Sep 12, 2024 •

edited

Loading

shortcuts commented Sep 12, 2024

chore(javascript): use tsup bundler #3640

chore(javascript): use tsup bundler #3640

Conversation

shortcuts commented Aug 31, 2024 • edited Loading

🧭 What and Why

Changes included:

how to verify it works?

algolia-bot commented Aug 31, 2024 • edited Loading

✔️ Code generated!

github-actions bot commented Sep 2, 2024 • edited Loading

millotp left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

millotp Sep 3, 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

millotp left a comment

Choose a reason for hiding this comment

xPaw commented Sep 12, 2024 • edited Loading

shortcuts commented Sep 12, 2024

shortcuts commented Aug 31, 2024 •

edited

Loading

algolia-bot commented Aug 31, 2024 •

edited

Loading

github-actions bot commented Sep 2, 2024 •

edited

Loading

millotp Sep 3, 2024 •

edited

Loading

xPaw commented Sep 12, 2024 •

edited

Loading