M3-5873: Build `api-v4` and `validation` with `tsup` with backwards compatibility #8484

bnussman · 2022-08-04T23:20:32Z

✨ Description

Use tsup for building @linode/api-v4 and @linode/validation

📝 Details

Deprecates yarn up in favor of yarn dev
Runs a dev server for @linode/validation so it rebuilds automatically when you are using yarn dev / yarn up
Changes any src/ prefixed imports in @linode/api-v4 and @linode/validation to be relative path imports (../)
- We should do this to keeps those packages simple. Aliases can causes extra complexity and is not beneficial in small packages like ours.
Configure Cloud Manger's jest to use @linode/api-v4 and @linode/validation's srcinstead of lib.
- We do this because jest was having trouble resolving exports because of its lackluster esm or exports support.
Type generation is handled by tsc
Use incremental tsc compilation for @linode/api-v4 and @linode/validation for faster typechecking
We are going to publish esm, commonjs, and iife as 3 bundled formats
- This results in 3 respective index.jss for each format (excluding type files)
- Cloud Manager consumes esm
- Jest will consume commonjs
- Dependencies are only bundled into the index.js file for the iife format so it is suitable for web use

🧪 How to test

Test all of Cloud Manager, @linode/api-v4, and @linode/validation
Run yarn from root dir to update dependencies
run rm -rf packages/api-v4/lib && rm -rf packages/validation/lib && rm packages/api-v4/index.js && rm packages/api-v4/index.d.ts && rm packages/validation/index.js && rm packages/validation/index.d.ts to clear old builds of api-v4 and validation
run yarn up

bnussman · 2022-08-05T15:53:29Z

packages/manager/package.json

+      "@linode/api-v4/lib(.*)$": "<rootDir>/../api-v4/src/$1",
+      "@linode/validation/lib(.*)$": "<rootDir>/../validation/src/$1"


This should be able to be removed after we update Jest. Newer versions of Jest support the exports values in the package.json, and hopefully Jest will pull the required commonjs files

Edit: I tested it and confirmed that a jest upgrade allows us to remove these. We can do that down the road

jdamore-linode

I'm gonna finish reviewing this later, but so far I'm liking everything I see! Nice work!

jdamore-linode · 2022-08-05T17:56:37Z

packages/api-v4/src/databases/databases.ts

@@ -2,14 +2,14 @@ import {
  createDatabaseSchema,
  updateDatabaseSchema,
 } from '@linode/validation/lib/databases.schema';
-import { BETA_API_ROOT as API_ROOT } from 'src/constants';
+import { BETA_API_ROOT as API_ROOT } from '../constants';


No problem here, but curious why there's a need to change to relative paths -- does tsup have issues with TypeScript's path aliases? If so, is the path property in tsconfig.json still necessary?

tsup handled it fine, it actually was a problem with the temporary jest change above

Ah that makes sense. Thanks!

jdamore-linode · 2022-08-05T17:59:15Z

packages/api-v4/package.json

-    "build:node": "yarn build --config webpack.node.config.js",
+    "start": "concurrently --raw \"tsc -w --preserveWatchOutput\" \"tsup --watch\"",
+    "build": "concurrently --raw \"tsc\" \"tsup\"",
+    "build:node": "echo not needed",


The only other reference I can find to build:node is in .github/workflows/ci.yml. I'll do some more searching later, but maybe we can get rid of this script altogether?

I was worried our internal pipeline used it, but it appears like it does not. I'll remove it.

jdamore-linode

Really, really nice! Great work @bnussman

DevDW

Going to finish testing this in-depth first thing tomorrow but for now I've confirmed that the app compiles and Cloud appears to be functioning well

DevDW

Great job! Resurfaced a question and once this gets released, some updates will need to be made to https://www.npmjs.com/package/@linode/api-v4 and maybe https://www.npmjs.com/package/@linode/validation to keep them accurate.

DevDW · 2022-08-11T15:48:44Z

packages/manager/package.json

-    "@linode/api-v4": "^0.75.0",
-    "@linode/validation": "0.12.0",
+    "@linode/api-v4": "*",
+    "@linode/validation": "*",


Going to resurface this question #8447 (comment). Were you able to find any documentation? Is yarn going to pull the correct versions as specified in the corresponding package.json files?

I did a bit of looking and didn't find anything super great, but here is the docs on how versioning with the * works.

https://classic.yarnpkg.com/lang/en/docs/dependency-versions/#toc-x-ranges

I found some looking around and people say that yarn will resolve the * to the latest version of a dependency and will check a monorepo's workspaces first

https://blog.charlesloubao.com/one-line-javascript-tip-1-how-to-install-a-local/

bnussman added 2 commits August 4, 2022 16:52

working

92ccc72

fix unit tests by pulling from src

348fb63

bnussman added the Proof of Concept label Aug 4, 2022

bnussman self-assigned this Aug 4, 2022

bnussman changed the title ~~Use \tsup\ for api-v4 and validation with backwards compatibility~~ Use tsup for api-v4 and validation with backwards compatibility Aug 4, 2022

bnussman added 2 commits August 4, 2022 19:30

fix isEmpty export from api-v4

65284a7

fixed volume exports

a59cae6

bnussman mentioned this pull request Aug 5, 2022

M3-5873: Use tsup for validation and api-v4 #8447

Closed

update package.jsons to meet requirements

208492c

bnussman commented Aug 5, 2022

View reviewed changes

bnussman requested review from jdamore-linode and DevDW August 5, 2022 16:06

bnussman changed the title ~~Use tsup for api-v4 and validation with backwards compatibility~~ M3-5873: Build api-v4 and validation with tsup with backwards compatibility Aug 5, 2022

run @linode/validation dev server on yarn dev

a4595ad

bnussman removed the Proof of Concept label Aug 5, 2022

jdamore-linode reviewed Aug 5, 2022

View reviewed changes

removed build:node from @linode/api-v4

9a3a26b

jdamore-linode approved these changes Aug 10, 2022

View reviewed changes

DevDW reviewed Aug 10, 2022

View reviewed changes

DevDW approved these changes Aug 11, 2022

View reviewed changes

bnussman merged commit a4222c0 into linode:develop Aug 11, 2022

This was referenced Aug 12, 2022

M3-5918: Remove babel and webpack following use of tsup #8495

Merged

M3-5919: Update Storybook and Add New Webpack 5 Loader #8497

Merged

bnussman-akamai mentioned this pull request Sep 26, 2024

chore: [M3-8662] - Update Github Actions actions #11009

Merged

12 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

M3-5873: Build `api-v4` and `validation` with `tsup` with backwards compatibility #8484

M3-5873: Build `api-v4` and `validation` with `tsup` with backwards compatibility #8484

bnussman commented Aug 4, 2022 •

edited

Loading

bnussman Aug 5, 2022 •

edited

Loading

jdamore-linode left a comment

jdamore-linode Aug 5, 2022

bnussman Aug 5, 2022

jdamore-linode Aug 5, 2022

jdamore-linode Aug 5, 2022

bnussman Aug 5, 2022

jdamore-linode left a comment

DevDW left a comment

DevDW left a comment

DevDW Aug 11, 2022

bnussman Aug 11, 2022

		"@linode/api-v4/lib(.*)$": "<rootDir>/../api-v4/src/$1",
		"@linode/validation/lib(.*)$": "<rootDir>/../validation/src/$1"

M3-5873: Build api-v4 and validation with tsup with backwards compatibility #8484

M3-5873: Build api-v4 and validation with tsup with backwards compatibility #8484

Conversation

bnussman commented Aug 4, 2022 • edited Loading

✨ Description

📝 Details

🧪 How to test

bnussman Aug 5, 2022 • edited Loading

Choose a reason for hiding this comment

jdamore-linode left a comment

Choose a reason for hiding this comment

jdamore-linode Aug 5, 2022

Choose a reason for hiding this comment

bnussman Aug 5, 2022

Choose a reason for hiding this comment

jdamore-linode Aug 5, 2022

Choose a reason for hiding this comment

jdamore-linode Aug 5, 2022

Choose a reason for hiding this comment

bnussman Aug 5, 2022

Choose a reason for hiding this comment

jdamore-linode left a comment

Choose a reason for hiding this comment

DevDW left a comment

Choose a reason for hiding this comment

DevDW left a comment

Choose a reason for hiding this comment

DevDW Aug 11, 2022

Choose a reason for hiding this comment

bnussman Aug 11, 2022

Choose a reason for hiding this comment

M3-5873: Build `api-v4` and `validation` with `tsup` with backwards compatibility #8484

M3-5873: Build `api-v4` and `validation` with `tsup` with backwards compatibility #8484

bnussman commented Aug 4, 2022 •

edited

Loading

bnussman Aug 5, 2022 •

edited

Loading