Exploration: Make SelectPanel item.id required

[siddharthkp]

Caution

Breaking changes expected. Need to migrate instances in github/github before merging this. This might be a really big task, so we'd need to see how much time do we want to give this as part of v38 tasks

• Exploration for https://github.com/github/primer/issues/5556
• Integration tests: https://github.com/github/github-ui/pull/1042

Notes:

Problem

1. SelectPanel passes items to FilteredActionList which further passes them to ActionList
2. Because of this implementation detail, it's became common practice in github/github to import ActionList item types to type items before passing them to SelectPanel (unfortunate because you aren't directly interacting with ActionList here, leaky type abstraction 😢)
3. Because FilteredActionList used to internally use deprecated/ActionList (not anymore), there are a bunch of imports of ItemInput from deprecated/ActionList (backward compatible), both in primer/react and github/github-ui
4. This means if we make item.id required for SelectPanel (in FilteredActionList), we get a lot of type errors because it doesn't match deprecated/ActionList types that folks are still using to type their items.

Solution

We need to break the problem into 2 parts

1. (Make the change easier to make)
   • We should export item types from SelectPanel (re-exported from FilteredActionList)
   • update all the imports in primer/react
   • and github/github-ui (there are a bunch of these)
2. (Make the easy change) Make item.id required and update instances where id is missing in items (very few of these)

Rollout strategy

• Patch release
• Minor release
• Major release; if selected, include a written rollout or migration plan
• None; if selected, include a brief description as to why

Testing & Reviewing

Merge checklist

• Added/updated tests
• Added/updated documentation
• Added/updated previews (Storybook)
• Changes are SSR compatible
• Tested in Chrome
• Tested in Firefox
• Tested in Safari
• Tested in Edge
• (GitHub staff only) Integration tests pass at github/github (Learn more about how to run integration tests)

[changeset-bot]

🦋 Changeset detected

Latest commit: d7a6475

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages

Name	Type
@primer/react	Major
@primer/styled-react	Major

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[github-actions]

👋 Hi, this pull request contains changes to the source code that github/github depends on. If you are GitHub staff, we recommend testing these changes with github/github using the integration workflow. Thanks!

[siddharthkp]

Exploration complete, updated task list in https://github.com/github/primer/issues/5556 👍