Add smoke-tests for types, build, etc #9633

NullVoxPopuli · 2025-01-09T22:58:11Z

Minimal reproduction of the problem I'm addressing: https://github.com/NullVoxPopuli/ts-types-package-json-exports-proof-for-ember-data

Description

Supersedes: #9631
Resolves: #9630

ember-data / warp-drive has enough going on it to warrant testing if new projects in various scenarios will work:

linting
type checking
building
a basic test

Unblocks:

[BUGFIX release]: tsconfig.json referenced paths to types instead of imports ember-cli/ember-cli#10612
- Fixes: 6.1, ember-data TS config is broken in monorepo when using npm or yarn@1 ember-cli/ember-cli#10611

Notes for the release

fix: tsconfig.json#compilerOptions#types can now use the package.json#exports paths, example:

"compilerOptions": {
  "types": [
      "ember-source/types",
      "ember-data/unstable-preview-types",
      "@ember-data/store/unstable-preview-types",
      "@ember-data/adapter/unstable-preview-types",
      "@ember-data/graph/unstable-preview-types",
      "@ember-data/json-api/unstable-preview-types",
      "@ember-data/legacy-compat/unstable-preview-types",
      "@ember-data/request/unstable-preview-types",
      "@ember-data/request-utils/unstable-preview-types",
      "@ember-data/model/unstable-preview-types",
      "@ember-data/serializer/unstable-preview-types",
      "@ember-data/tracking/unstable-preview-types",
      "@warp-drive/core-types/unstable-preview-types"
  ]
}

Notes for review

NPM is not as understanding when it comes to tarballs:

npm error code ERESOLVE
npm error ERESOLVE could not resolve
npm error
npm error While resolving: @ember-data/[email protected]
npm error Found: @ember-data/[email protected]
npm error node_modules/@ember-data/store
npm error   dev @ember-data/store@"file:./ember-data-store-5.4.0-alpha.126.tgz" from the root project
npm error   peer @ember-data/store@"*" from @ember-data/[email protected]
npm error   node_modules/@ember-data/adapter
npm error     dev @ember-data/adapter@"file:./ember-data-adapter-5.4.0-alpha.126.tgz" from the root project
npm error     @ember-data/adapter@"*" from [email protected]
npm error     node_modules/ember-data
npm error       dev ember-data@"file:./ember-data-5.4.0-alpha.126.tgz" from the root project
npm error   7 more (@ember-data/debug, @ember-data/graph, ...)
npm error
npm error Could not resolve dependency:
npm error peer @ember-data/store@"^4.12.0 || ^5.0.0" from @ember-data/[email protected]
npm error node_modules/@ember-data/rest
npm error   dev @ember-data/rest@"file:./ember-data-rest-5.4.0-alpha.126.tgz" from the root project
npm error
npm error Conflicting peer dependency: @ember-data/[email protected]
npm error node_modules/@ember-data/store
npm error   peer @ember-data/store@"^4.12.0 || ^5.0.0" from @ember-data/[email protected]
npm error   node_modules/@ember-data/rest
npm error     dev @ember-data/rest@"file:./ember-data-rest-5.4.0-alpha.126.tgz" from the root project

the install-time peer checking here isn't as important as the post-install peer checking -- we don't want npm using the versions from package.json exactly, but the versions installed the specifiers in the package.json -- kinda surprised they have this bug, tbh

scripts/test-package-manager.mjs

NullVoxPopuli · 2025-01-14T23:15:48Z

.npmrc

Without these changes not all node_modules directories have the right bins in node_modules -- for example, @warp-drive/ember did not have glint, and would fail to build its types

…ompilerOptions#types Fix: #9630 Fix: ember-cli/ember-cli#10611 Related: - ember-cli/ember-cli#10613 Unblocks: - ember-cli/ember-cli#10612

runspired · 2025-01-26T18:53:41Z

packages/rest/src/-private/builders/query.ts

seems odd for these to have been removed ....

likely: a minor lint update / transitive dep changed the meaning of what needs to be disabled.
now: the lint-disable is only needed on the actual real implementation, not the overrides/declarations

runspired · 2025-01-26T18:57:09Z

tests/vite-basic-compat/app/services/store.js

why was this needed?

runspired · 2025-01-26T19:21:05Z

packages/request/src/-private/context.ts

-  private declare _isCacheHandler: boolean;
-  private declare _finalized: boolean;
+  declare private _isCacheHandler: boolean;
+  declare private _finalized: boolean;


as far as I can tell TS doesn't specify the order on this nor care https://tsplay.dev/WJKaRw

declare-first does seem better though

lint:fix did this

runspired · 2025-01-26T19:22:05Z

tests/vite-basic-compat/app/type-tests.ts

@@ -0,0 +1,34 @@
+/**
+ * These tests are more fro the out-of-monorepo tests,


Suggested change

* These tests are more fro the out-of-monorepo tests,

* These tests are more for the out-of-monorepo tests,

runspired · 2025-01-26T19:23:13Z

tests/vite-basic-compat/ember-cli-build.js

+  /**
+   * TODO: find another way to set this config,
+   *       because the most modern of apps will not have a compat build
+   */


once embroider/macros picks a new key that's all we need. app and __dirname here are just for the macros API that needs them.

(probably should remove this comment though)

runspired · 2025-01-26T19:24:28Z

tests/vite-basic-compat/tests/application/visit-test.ts

@@ -13,6 +11,8 @@ module('it works', function (hooks) {
  });

  test('we can use the store', async function (assert) {
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore this repo loads the declarations for qunit in the wrong order


Suggested change

// @ts-ignore this repo loads the declarations for qunit in the wrong order

// @ts-expect-error this repo loads the declarations for qunit in the wrong order

runspired · 2025-01-26T19:31:26Z

tests/warp-drive__experiments/package.json

@@ -17,7 +17,7 @@
  "scripts": {
    "build:tests": "IS_TESTING=true EMBER_CLI_TEST_COMMAND=true ember build --output-path=dist-test --suppress-sizes",
    "_build:production": "bun run build:tests -e production",
-    "lint": "eslint . --quiet --cache --cache-strategy=content",


accidental check-in?

nay -- eslint's cache being buggy is why ci and editor and cli are sometimes not in agreement

NullVoxPopuli changed the title ~~Smoke test with non pnpm~~ Add smoke-tests for types, build, etc Jan 9, 2025

This was referenced Jan 9, 2025

WIP: Add out-of-monorepo smoke tests #9631

Closed

Add new flag for new: --ember-data (default), and --no-ember-data ember-cli/ember-cli#10613

Merged

ember-cli 6.1, eslint 9, eslint flat config, RFC#1055 embroider-build/addon-blueprint#320

Merged

NullVoxPopuli commented Jan 10, 2025

View reviewed changes

scripts/test-package-manager.mjs Outdated Show resolved Hide resolved

NullVoxPopuli changed the base branch from main to fix-publish January 11, 2025 22:51

NullVoxPopuli force-pushed the smoke-test-with-non-pnpm branch from 9cc348f to 7b0eda0 Compare January 11, 2025 23:03

Base automatically changed from fix-publish to main January 14, 2025 20:12

NullVoxPopuli force-pushed the smoke-test-with-non-pnpm branch 2 times, most recently from fb5e4d5 to d1de3f5 Compare January 14, 2025 22:22

NullVoxPopuli commented Jan 14, 2025

View reviewed changes

NullVoxPopuli force-pushed the smoke-test-with-non-pnpm branch from bf68cd4 to e134254 Compare January 15, 2025 21:35

NullVoxPopuli marked this pull request as ready for review January 15, 2025 22:24

NullVoxPopuli mentioned this pull request Jan 22, 2025

[BUGFIX release]: tsconfig.json referenced paths to types instead of imports ember-cli/ember-cli#10612

Open

Correctly configure package.json#exports for use with tsconfig.json#c…

bed0680

…ompilerOptions#types Fix: #9630 Fix: ember-cli/ember-cli#10611 Related: - ember-cli/ember-cli#10613 Unblocks: - ember-cli/ember-cli#10612

NullVoxPopuli force-pushed the smoke-test-with-non-pnpm branch from 27208ad to bed0680 Compare January 22, 2025 15:19

Fix lints by removing eslint cache

84e8f87

NullVoxPopuli added a commit to NullVoxPopuli/ts-types-package-json-exports-proof-for-ember-data that referenced this pull request Jan 22, 2025

Repro to prove that emberjs/data#9633 works

bcf5702

This was referenced Jan 22, 2025

6.1, ember-data TS config is broken in monorepo when using npm or yarn@1 ember-cli/ember-cli#10611

Open

Prevent #1688 (and other accidental prettier breakages) glimmerjs/glimmer-vm#1689

Merged

runspired reviewed Jan 26, 2025

View reviewed changes

tests/vite-basic-compat/app/services/store.js Outdated

Copy link

Contributor

runspired Jan 26, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why was this needed?

runspired reviewed Jan 26, 2025

View reviewed changes

NullVoxPopuli added 3 commits January 27, 2025 18:21

Smoke Tests: dt-types pass

cf5f22a

Smoke: native-types pass

53ff4dd

ope

b87b989

NullVoxPopuli added 9 commits January 27, 2025 18:40

Revert changes to vite-basic-compat

11f6711

lockfile

a7aff84

Revert npmrc

68f0897

revert pnpm-lock

d89a0c1

Smoke tests don't need their own lint config

04f2b1e

Use correct script name

5681acd

Remove added files to vite-basic-compat

2bf9775

Prettier

9bce62b

Revert misguided lint-induced changes

17cd2a9

runspired added 🎯 canary PR is targeting canary (default) 🏷️ bug This PR primarily fixes a reported issue labels Jan 29, 2025

runspired self-assigned this Jan 29, 2025

runspired merged commit 3a720ae into main Jan 29, 2025
29 checks passed

runspired deleted the smoke-test-with-non-pnpm branch January 29, 2025 01:11

NullVoxPopuli mentioned this pull request Jan 31, 2025

Update TS Guides for Native Types ember-learn/guides-source#2064

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add smoke-tests for types, build, etc #9633

Add smoke-tests for types, build, etc #9633

NullVoxPopuli commented Jan 9, 2025 •

edited

Loading

NullVoxPopuli Jan 14, 2025

runspired Jan 26, 2025

NullVoxPopuli Jan 26, 2025

runspired Jan 26, 2025

runspired Jan 26, 2025

NullVoxPopuli Jan 26, 2025

runspired Jan 26, 2025

runspired Jan 26, 2025

runspired Jan 26, 2025

runspired Jan 26, 2025

runspired Jan 26, 2025

NullVoxPopuli Jan 26, 2025

		@@ -0,0 +1,34 @@
		/**
		* These tests are more fro the out-of-monorepo tests,

	* These tests are more fro the out-of-monorepo tests,
	* These tests are more for the out-of-monorepo tests,

	// @ts-ignore this repo loads the declarations for qunit in the wrong order
	// @ts-expect-error this repo loads the declarations for qunit in the wrong order

Add smoke-tests for types, build, etc #9633

Add smoke-tests for types, build, etc #9633

Conversation

NullVoxPopuli commented Jan 9, 2025 • edited Loading

Description

Notes for the release

Notes for review

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

NullVoxPopuli commented Jan 9, 2025 •

edited

Loading