From 8c6367d82eff81c79afe53772499165dd2e7c3b0 Mon Sep 17 00:00:00 2001 From: Ajay Singh Date: Fri, 20 Dec 2024 10:32:32 -0800 Subject: [PATCH 1/3] remove deprecated field and related resolver --- graphql_api/types/plan/plan.graphql | 4 ---- graphql_api/types/plan/plan.py | 5 ----- .../types/plan_representation/plan_representation.graphql | 4 ---- graphql_api/types/plan_representation/plan_representation.py | 5 ----- 4 files changed, 18 deletions(-) diff --git a/graphql_api/types/plan/plan.graphql b/graphql_api/types/plan/plan.graphql index df832672de..505610c78a 100644 --- a/graphql_api/types/plan/plan.graphql +++ b/graphql_api/types/plan/plan.graphql @@ -11,10 +11,6 @@ type Plan { isTrialPlan: Boolean! marketingName: String! monthlyUploadLimit: Int - planName: String! - @deprecated( - reason: "Plan representations have used `value` for a while, making the frontend code hard to change" - ) planUserCount: Int pretrialUsersCount: Int tierName: String! diff --git a/graphql_api/types/plan/plan.py b/graphql_api/types/plan/plan.py index ada836133e..fca5bb5177 100644 --- a/graphql_api/types/plan/plan.py +++ b/graphql_api/types/plan/plan.py @@ -39,11 +39,6 @@ def resolve_marketing_name(plan_service: PlanService, info) -> str: return plan_service.marketing_name -@plan_bindable.field("planName") -def resolve_plan_name(plan_service: PlanService, info) -> str: - return plan_service.plan_name - - @plan_bindable.field("value") def resolve_plan_name_as_value(plan_service: PlanService, info) -> str: return plan_service.plan_name diff --git a/graphql_api/types/plan_representation/plan_representation.graphql b/graphql_api/types/plan_representation/plan_representation.graphql index 327e9f2e93..4af0ebc29b 100644 --- a/graphql_api/types/plan_representation/plan_representation.graphql +++ b/graphql_api/types/plan_representation/plan_representation.graphql @@ -1,9 +1,5 @@ type PlanRepresentation { marketingName: String! - planName: String! - @deprecated( - reason: "Plan representations have used `value` for a while, making the frontend code hard to change" - ) value: String! billingRate: String baseUnitPrice: Int! diff --git a/graphql_api/types/plan_representation/plan_representation.py b/graphql_api/types/plan_representation/plan_representation.py index c7b9c6fb95..3bdbfac9cb 100644 --- a/graphql_api/types/plan_representation/plan_representation.py +++ b/graphql_api/types/plan_representation/plan_representation.py @@ -17,11 +17,6 @@ def resolve_marketing_name(plan_data: PlanData, info) -> str: return plan_data.marketing_name -@plan_representation_bindable.field("planName") -def resolve_plan_name(plan_data: PlanData, info) -> str: - return plan_data.value - - @plan_representation_bindable.field("value") def resolve_plan_value(plan_data: PlanData, info) -> str: return plan_data.value From 481a6f3dc2a5e3bb3c93b9516e6f78d952c7436f Mon Sep 17 00:00:00 2001 From: Ajay Singh Date: Fri, 20 Dec 2024 10:35:08 -0800 Subject: [PATCH 2/3] update tests --- graphql_api/tests/test_owner.py | 12 ++++++------ graphql_api/tests/test_plan.py | 4 ---- graphql_api/tests/test_plan_representation.py | 2 -- 3 files changed, 6 insertions(+), 12 deletions(-) diff --git a/graphql_api/tests/test_owner.py b/graphql_api/tests/test_owner.py index 73d20d0411..9e38121c38 100644 --- a/graphql_api/tests/test_owner.py +++ b/graphql_api/tests/test_owner.py @@ -678,18 +678,18 @@ def test_owner_available_plans(self): query = """{ owner(username: "%s") { availablePlans { - planName + value } } } """ % (current_org.username) data = self.gql_request(query, owner=current_org) assert data["owner"]["availablePlans"] == [ - {"planName": "users-basic"}, - {"planName": "users-pr-inappm"}, - {"planName": "users-pr-inappy"}, - {"planName": "users-teamm"}, - {"planName": "users-teamy"}, + {"value": "users-basic"}, + {"value": "users-pr-inappm"}, + {"value": "users-pr-inappy"}, + {"value": "users-teamm"}, + {"value": "users-teamy"}, ] def test_owner_query_with_no_service(self): diff --git a/graphql_api/tests/test_plan.py b/graphql_api/tests/test_plan.py index e8c4767a43..013da95cd5 100644 --- a/graphql_api/tests/test_plan.py +++ b/graphql_api/tests/test_plan.py @@ -49,7 +49,6 @@ def test_owner_plan_data_when_trialing(self): trialStartDate trialTotalDays marketingName - planName value tierName billingRate @@ -75,7 +74,6 @@ def test_owner_plan_data_when_trialing(self): "trialStartDate": "2023-06-19T00:00:00", "trialTotalDays": None, "marketingName": "Developer", - "planName": "users-trial", "value": "users-trial", "tierName": "pro", "billingRate": None, @@ -107,7 +105,6 @@ def test_owner_plan_data_with_account(self): owner(username: "%s") { plan { marketingName - planName value tierName billingRate @@ -126,7 +123,6 @@ def test_owner_plan_data_with_account(self): data = self.gql_request(query, owner=self.current_org) assert data["owner"]["plan"] == { "marketingName": "Pro", - "planName": "users-pr-inappy", "value": "users-pr-inappy", "tierName": "pro", "billingRate": "annually", diff --git a/graphql_api/tests/test_plan_representation.py b/graphql_api/tests/test_plan_representation.py index 965038e961..2974b4ccee 100644 --- a/graphql_api/tests/test_plan_representation.py +++ b/graphql_api/tests/test_plan_representation.py @@ -35,7 +35,6 @@ def test_owner_pretrial_plan_data_when_trialing(self): owner(username: "%s") { pretrialPlan { marketingName - planName value billingRate baseUnitPrice @@ -48,7 +47,6 @@ def test_owner_pretrial_plan_data_when_trialing(self): data = self.gql_request(query, owner=current_org) assert data["owner"]["pretrialPlan"] == { "marketingName": "Developer", - "planName": "users-basic", "value": "users-basic", "billingRate": None, "baseUnitPrice": 0, From 16256ce381967a78e25566f84806c8df28283320 Mon Sep 17 00:00:00 2001 From: Ajay Singh Date: Fri, 20 Dec 2024 10:40:20 -0800 Subject: [PATCH 3/3] sort lines ascending --- .../types/plan_representation/plan_representation.graphql | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/graphql_api/types/plan_representation/plan_representation.graphql b/graphql_api/types/plan_representation/plan_representation.graphql index 4af0ebc29b..0937ff6514 100644 --- a/graphql_api/types/plan_representation/plan_representation.graphql +++ b/graphql_api/types/plan_representation/plan_representation.graphql @@ -1,8 +1,8 @@ type PlanRepresentation { - marketingName: String! - value: String! - billingRate: String baseUnitPrice: Int! benefits: [String!]! + billingRate: String + marketingName: String! monthlyUploadLimit: Int + value: String! }