Add constraint to ensure controllers are peerDependencies

[Gudahtt]

Description

A constraint has been added to ensure that each controller that a package depends on is also added as a peerDependency. This helps us ensure that controllers appear only once in the dependency tree on the client repositories.

Each controller is effectively a singleton because we only construct a single instance of each one. Typically they get added as dependencies only to get access to types in the controller package. If we don't add it as a peerDependency as well, it risks the versions getting out-of sync with what the client repository has installed.

Any missing peerDependency entries have been added to comply with this constraint.

Changes

None

Checklist

• I've updated the test suite for new or updated code as appropriate
• I've updated documentation for new or updated code as appropriate (note: this will usually be JSDoc)
• I've highlighted breaking changes using the "BREAKING" category above as appropriate

[mcmire]

Since we're just interested in other workspaces, could we also write this as the following? Might remove the need for is_controller.

Suggested change

	gen_enforced_dependency(WorkspaceCwd, DependencyIdent, DependencyRange, 'peerDependencies') :-
	workspace_has_dependency(WorkspaceCwd, DependencyIdent, DependencyRange, 'dependencies'),
	DependencyIdent \= '@metamask/base-controller',
	DependencyIdent \= '@metamask/eth-keyring-controller',
	is_controller(DependencyIdent).
	gen_enforced_dependency(WorkspaceCwd, DependencyIdent, DependencyRange, 'peerDependencies') :-
	workspace_has_dependency(WorkspaceCwd, DependencyIdent, DependencyRange, 'dependencies'),
	DependencyIdent \= '@metamask/base-controller',
	workspace_ident(_, DependencyIdent).

[Gudahtt]

Hmm, I think this would give us the wrong answer in two ways. We don't just care about workspaces here, we care about controllers. Controllers are singletons, regardless whether they live in this repo or not. But the other workspaces aren't. They're libraries that the clients can have multiple different versions of.

[mcmire]

I gotcha. That's fair.

[Gudahtt]

I was considering keeping it just to controllers in this repo, and adding another constraint to prevent depending on other controllers. Ideally any that are depended on here would be here. I guess we can consider that separately though.

[mcmire]

Looks good!