[Bug] Ember data doens't work with embroider starting with 4.8.x

[mkszepp]

Description

There is not anymore possible to use ember-data with embroider, starting with 4.8.x.

In v4.9.1 we get this error:
Error Error while processing route: index Assertion Failed: Expected store.createRecordDataFor to be implemented but it wasn't

data/packages/store/addon/-private/store-service.ts

Lines 2392 to 2406 in f8acfc1

	createRecordDataFor(
	identifier: StableRecordIdentifier,
	storeWrapper: RecordDataStoreWrapper
	): RecordData | RecordDataV1 {
	if (HAS_RECORD_DATA_PACKAGE) {
	// we can't greedily use require as this causes
	// a cycle we can't easily fix (or clearly pin point) at present.
	//
	// it can be reproduced in partner tests by running
	// node ./scripts/packages-for-commit.js && pnpm test-external:ember-observer
	if (_RecordData === undefined) {
	_RecordData = (
	importSync('@ember-data/record-data/-private') as typeof import('@ember-data/record-data/-private')
	).RecordData;
	}

This is because the private-build-infra HAS_RECORD_DATA_PACKAGE says, that the package @ember-data/record-data is not present.

data/packages/private-build-infra/addon/available-packages.ts

Line 5 in f8acfc1

HAS_RECORD_DATA_PACKAGE: '@ember-data/record-data',

Fix

We can fix this problem by replacing the line with HAS_RECORD_DATA_PACKAGE: '@ember-data/record-data/-private',

[mkszepp]

In ember-data v4.10.x there is necessary to replace all moduleExists("@ember-data/json-api") with moduleExists("@ember-data/json-api/-private"), so it works also with embroider

[mkszepp]

I have checked again this problem and the fix for this issue is better to add index.ts in package/record-data and replace all imports of @ember-data/record-data/-private with '@ember-data/record-data' in v4.9.1. After that the record-data packages works also with embroider.

I think we can do the same thing for @ember-data/json-api in v.4.10.x.

[ztjohns]

I have checked again this problem and the fix for this issue is better to add index.ts in package/record-data and replace all imports of @ember-data/record-data/-private with '@ember-data/record-data' in v4.9.1. After that the record-data packages works also with embroider.

I think we can do the same thing for @ember-data/json-api in v.4.10.x.

Is this something we would need to do on a developers side while trying to update to the latest stable tag or is this more internal to embroider and ember-data.

I recently asked about this issue and discord and was told to roll back to 4.7.3 for ED for the time being.

Thank you!

[mkszepp]

@ztjohns the bug for v4.9 must be fixed in ember-data (pr is already open)... after that, it should be possible to use with embroider without workaround in your project.

For v4.10 we need changes in embroider + the fix in ember data. See embroider-build/embroider#1322 (comment)

I'm atm on 4.4, because 4.7 has varios bugs, which will not be backportet from 4.8/4.9 (for example identifier bug + problem with more than 1500 records). Beginning with 4.5+ my app was always buggy, so i recommend you to stay on 4.4.

When this bug is fixed in latest relesed ember-data version, i think that we should also backport all fixes to the lts 4.8.

A workaround in your project for 4.9 could be to create the index.ts or replace the package check string while build process. I think more is not necessary.

A workaround, maybe not perfect, but it should be work for 4.9.1:
ember-cli-build.js (add before module.exports)

const fs = require('fs');
fs.writeFileSync(
  `node_modules/@ember-data/private-build-infra/addon/available-packages.ts`,
  `export default {
  HAS_EMBER_DATA_PACKAGE: 'ember-data',
  HAS_STORE_PACKAGE: '@ember-data/store',
  HAS_MODEL_PACKAGE: '@ember-data/model',
  HAS_RECORD_DATA_PACKAGE: '@ember-data/record-data/-private',
  HAS_ADAPTER_PACKAGE: '@ember-data/adapter',
  HAS_SERIALIZER_PACKAGE: '@ember-data/serializer',
  HAS_DEBUG_PACKAGE: '@ember-data/debug',
};`
);

[Turbo87]

related: #8296 (comment) :)

[runspired]

the issue here is likely in embroider. These addons function as normal traditional ember addons. Its unclear why that would break in more recent embroider versions, especially when the embroider tests in this repo are passing...

[mkszepp]

@runspired atm ember data has only one test for embroider if the build works, but it is no test for accessing to a model/store... right?
Maybe there is necessary to add some tests for that, so also ember data will be failed under embroider...

Normally other packages are using the same test like without embroider, but ember data doens't do this atm...

[rreckonerr]

The same issue is blocking me from upgrading from 4.4 to 4.8

[runspired]

@mkszepp are you on discord? would love to sync up and see if we can get to the root of some of this

[runspired]

pretty sure @embroider/test-setup is not compatible currently with EmberApp (only EmberAddon) and therefore isn't usable by us. See glimmerjs/glimmer.js#406 for an error encountered trying to setup that way.

[mkszepp]

@runspired thank, confirm that it works without any workaround, package rules... in v4.11.x.