[BUGFIX release beta canary] Fix Model lifecycle event deprecations

[HeroicEric]

• Related RFC: https://github.com/emberjs/rfcs/blob/master/text/0329-deprecated-ember-evented-in-ember-data.md
• Original PR: [CHORE] RFC-0329 - adding deprecation about using evented in ember-data #6059

tl;dr;

• Fixes bugs with deprecation logic for Model lifecycle event methods
• Adds URL to deprecation guide
• Adds tests for Model lifecycle event method deprecations

---

Deprecations were added for the following model lifecycle events becameError, becameInvalid, didCreate, didDelete, didLoad, didUpdate, ready, rolledBack in #6059.

There was a discussion on the PR that suggested adding an additional check to make sure that that the deprecations were only triggered for instances of Ember Data's Model class #6059 (comment)

This extra check was added but it accidentally was checking for this to be an instance of the Model class, but that can never be true since this will always be an instance of InternalModel:

data/packages/store/addon/-private/system/model/internal-model.ts

Lines 446 to 455 in 5e49539

	if (this instanceof Model && typeof this._record[methodName] === 'function') {
	deprecate(
	`Attempted to define ${methodName} on ${this._record.modelName}#${this._record.id}`,
	deprecations[methodName],
	{
	id: 'ember-data:record-lifecycle-event-methods',
	until: '4.0',
	}
	);
	}

Since we only want to check for these deprecations for instances of Model, I moved the deprecation logic to the Model class

#6059 also included a mechanism for tracking deprecations that were logged per model class so we could prevent logging multiple deprecations for the same model class and deprecated lifecycle method pair:

data/packages/store/addon/-private/system/model/internal-model.ts

Lines 61 to 77 in 5e49539

	let INSTANCE_DEPRECATIONS;
	let lookupDeprecations;
	if (DEBUG) {
	INSTANCE_DEPRECATIONS = new WeakMap();
	lookupDeprecations = function lookupInstanceDrecations(instance) {
	let deprecations = INSTANCE_DEPRECATIONS.get(instance);
	if (!deprecations) {
	deprecations = {};
	INSTANCE_DEPRECATIONS.set(instance, deprecations);
	}
	return deprecations;
	};
	}

This also fixes a bug with the deprecation tracking logic which was that we were never actually adding the logged deprecations to the WeakMap meant to keep track of them, so the same deprecation would be logged multiple times.

[HeroicEric]

this here was always an instance of InternalModel so this conditional was always false

[HeroicEric]

This is already wrapped an in if (DEBUG) { on https://github.com/emberjs/data/pull/6395/files#diff-f80cb1aa960a031cbf31acf375a55b0aR1343

[HeroicEric]

This never evaluated to true because we were never adding the found deprecated method to deprecations, so deprecations always had a value of {}

[snewcomer]

👍

[snewcomer]

I wonder if there is a way to avoid creating these data structures in memory if a user doesn't define any of these at all. Perhaps a majority don't? What do you think?

[HeroicEric]

I definitely agree that the majority a model classes won't be defining any of these methods. I'm not sure if there is a way to avoid creating these but I'm not sure it matters much since this code will only run in development. It's not clear from this diff but this is all wrapped inside of an if (DEBUG)

[snewcomer]

I like your tests 💯