-
Notifications
You must be signed in to change notification settings - Fork 392
change: [UIE-9923] - Exclude test files when building Linode API-v4 SDK #13303
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: develop
Are you sure you want to change the base?
change: [UIE-9923] - Exclude test files when building Linode API-v4 SDK #13303
Conversation
Cloud Manager UI test results🔺 3 failing tests on test run #2 ↗︎
Details
TroubleshootingUse this command to re-run the failing tests: pnpm cy:run -s "cypress/e2e/core/firewalls/firewall-landing-page.spec.ts,cypress/e2e/core/linodes/clone-linode.spec.ts,cypress/e2e/core/objectStorage/access-key.e2e.spec.ts" |
|||||||||||||||||||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Seems fine!
The only downside I see is that we won't catch type errors present in *.test.ts files in CI with this change, which is not a huge deal.
In the future maybe we'll let the bundler (tsup or other tool) handle the .d.ts generation rather than tsc itself and we can re-evaluate this
|
Thanks @bnussman-akamai!
Ah, I didn't consider this at all -- thanks for pointing that out. Right now |
Description 📝
This is a quick PR to exclude
*.test.tsfiles when building the API-v4 JS SDK. Currently,request.test.tsdepends onvitest, butvitestis not specified as a dependency in the API-v4 SDK'spackage.json; instead, it's a workspace-level dependency.As a result, the only way our team can build the SDK is by depending on
vitestand keeping it in sync with Manager's version, or by installing all of Cloud Manager's dependencies which is way overkill for what we need (happy to elaborate offline for anybody curious).Excluding test files from the build seems correct, and incidentally resolves the issue we are facing. Happy to answer any questions!
Changes 🔄
.test.tsfiles when building API-v4 SDKScope 🚢
Upon production release, changes in this PR will be visible to:
Target release date 🗓️
N/A. Low urgency: we only need this to be present in
develop, and can work around it in the meantime.Preview 📷
Screenshot of the API-v4 SDK build directory before and after applying this change:
How to test 🧪
Prerequisites
We can rely on CI to confirm that this change doesn't cause any issues when consuming the SDK.
Author Checklists
As an Author, to speed up the review process, I considered 🤔
👀 Doing a self review
❔ Our contribution guidelines
🤏 Splitting feature into small PRs
➕ Adding a changeset
🧪 Providing/improving test coverage
🔐 Removing all sensitive information from the code and PR description
🚩 Using a feature flag to protect the release
👣 Providing comprehensive reproduction steps
📑 Providing or updating our documentation
🕛 Scheduling a pair reviewing session
📱 Providing mobile support
♿ Providing accessibility support
As an Author, before moving this PR from Draft to Open, I confirmed ✅