**Summary** This task migrates `gitlab_subscription_histories` plan filtering from `hosted_plan_id` (database foreign key to `plans.id`) to `hosted_plan_name_uid` (in-memory enum identifier), removing the dependency on the `plans` table. #### Phase 1: Make `hosted_plan_name_uid` the Source of Truth for Writes The `hosted_plan_name_uid` column already exists on `gitlab_subscription_histories` and is being backfilled (`BackfillGitlabSubscriptionHistoriesHostedPlanNameUid`). The `create_from_change` class method in `ee/app/models/gitlab_subscriptions/subscription_history.rb` already captures both `hosted_plan_id` and `hosted_plan_name_uid` via `TRACKED_ATTRIBUTES`, since the source `GitlabSubscription` attributes include both columns. 1. **Confirm the backfill migration** `BackfillGitlabSubscriptionHistoriesHostedPlanNameUid` has completed on production `hosted_plan_name_uid` is the authoritative value on write. `hosted_plan_id` is still populated for backward compatibility with existing readers. #### Phase 2: Switch All Reads to `hosted_plan_name_uid` This phase eliminates every read of `hosted_plan_id` in the `gitlab_subscription_histories` context, replacing it with `hosted_plan_name_uid`. 1. **`GitlabSubscriptions::SubscriptionHistory`** (`ee/app/models/gitlab_subscriptions/subscription_history.rb`): - Replace `scope :with_all_ultimate_plans` to filter on `hosted_plan_name_uid` instead of `joins(:hosted_plan).where(hosted_plan: { name: ... })`: ```ruby scope :with_all_ultimate_plans, -> do uids = EE::Plan::ALL_ULTIMATE_PLANS.map { |n| Plan.plan_name_uids[n] } where(hosted_plan_name_uid: uids) end ``` - Replace `scope :with_namespace_subscription` to remove the `hosted_plan` eager-load, since the plan can now be resolved from `hosted_plan_name_uid` in memory: ```ruby scope :with_namespace_subscription, -> { includes(namespace: :gitlab_subscription) } ``` 2. **`Security::UnassignPolicyConfigurationsForExpiredLicensesCronWorker`** (`ee/app/workers/security/unassign_policy_configurations_for_expired_licenses_cron_worker.rb`): - Update `active_ultimate_subscription?` to check `hosted_plan_name_uid` on the subscription instead of loading `hosted_plan` via the FK: ```ruby def active_ultimate_subscription?(subscription) return false unless subscription && !subscription.expired? uid = subscription.hosted_plan_name_uid Plan::ALL_ULTIMATE_PLANS.map { |n| Plan.plan_name_uids[n] }.include?(uid) end ``` - Note: The `expired_ultimate_subscriptions` chain already benefits from the updated `with_all_ultimate_plans` scope above 3. **`GitlabSubscription#premium_plan_not_renewed?`** (`ee/app/models/gitlab_subscription.rb`): - Update the `SubscriptionHistory` query to filter on `hosted_plan_name_uid` instead of `hosted_plan_id`: ```ruby previous_premium_gs = GitlabSubscriptions::SubscriptionHistory .where(gitlab_subscription_id: id, hosted_plan_name_uid: Plan::PLAN_NAME_UID_LIST[:premium]) .order(:id).last ``` - This avoids overlap with [#596996](https://gitlab.com/gitlab-org/gitlab/-/work_items/596996) which handles the `GitlabSubscription` model's own `hosted_plan_id` reads 4. **Update test factories** in `ee/spec/factories/gitlab_subscriptions/subscription_histories.rb`: Set `hosted_plan_name_uid` as a primary attribute when creating history records, deriving it from the associated plan 5. **All corresponding specs**, including: - `ee/spec/models/gitlab_subscriptions/subscription_history_spec.rb` - `ee/spec/workers/security/unassign_policy_configurations_for_expired_licenses_cron_worker_spec.rb` - `ee/spec/requests/groups/usage_quotas_spec.rb` - `ee/spec/requests/api/graphql/namespace_query_spec.rb` No application code reads `hosted_plan_id` from `gitlab_subscription_histories`. The column is still written but never consumed. --- #### Phase 3: Cleanup Remove all vestiges of `hosted_plan_id` from the `gitlab_subscription_histories` context. 1. **Stop writing `hosted_plan_id`**: Remove `hosted_plan_id` from `TRACKED_ATTRIBUTES` in `ee/app/models/gitlab_subscriptions/subscription_history.rb`, so `create_from_change` no longer copies it from the source subscription attributes 2. **Remove the `hosted_plan_id` column**: Add a database migration to drop `hosted_plan_id` from `gitlab_subscription_histories` 3. **Remove dead code**: - `belongs_to :hosted_plan` from `GitlabSubscriptions::SubscriptionHistory` - `has_many :gitlab_subscription_histories` from `EE::Plan` (`ee/app/models/ee/plan.rb`) - Note: The `has_many :hosted_subscriptions` association on `EE::Plan` is owned by [#596996](https://gitlab.com/gitlab-org/gitlab/-/work_items/596996) and should only be removed once that task's cleanup phase is also complete 4. **Clean up database metadata**: - Remove `gitlab_subscription_histories.hosted_plan_id` from `db/integer_ids_not_yet_initialized_to_bigint.yml` (if present) - Mark the `BackfillGitlabSubscriptionHistoriesHostedPlanNameUid` migration as finalized 5. **Update all remaining specs** that reference `hosted_plan_id` in the subscription histories context 6. **Coordinate with the broader effort** in [#571422](https://gitlab.com/gitlab-org/gitlab/-/work_items/571422) to ensure alignment with the overall plan to drop `plans.id` **Note:** The `has_many :hosted_subscriptions` association on `EE::Plan` can only be fully removed once the parallel `gitlab_subscriptions` migration ([#596996](https://gitlab.com/gitlab-org/gitlab/-/work_items/596996)) has also completed its cleanup phase. However, the `has_many :gitlab_subscription_histories` association on `EE::Plan` can be removed independently in this task's cleanup, since no other code path depends on it once the reads are migrated. The `gitlab_subscription_histories` table no longer has a `hosted_plan_id` column or `belongs_to :hosted_plan` association. All plan-based history filtering operates entirely through `hosted_plan_name_uid`, with no dependency on the `plans` table's `id` column.