From cf68f8ae240ee06ff701a269463539639fa78fb6 Mon Sep 17 00:00:00 2001
From: Aman Agrawal <amanagr@zulip.com>
Date: Tue, 12 Dec 2023 08:43:30 +0000
Subject: [PATCH] legacy_server_logic: Rename id and key variable names.

Rename server_org_id to zulip_org_id.
Rename server_org_secret/server_org_key to zulip_org_key.
---
 corporate/tests/test_remote_billing.py       | 16 ++++++++--------
 corporate/views/remote_billing_page.py       | 10 +++++-----
 templates/corporate/legacy_server_login.html | 14 +++++++-------
 web/src/billing/remote_billing_auth.ts       | 14 +++++++-------
 4 files changed, 27 insertions(+), 27 deletions(-)

diff --git a/corporate/tests/test_remote_billing.py b/corporate/tests/test_remote_billing.py
index 015226e130..8f829f8f2e 100644
--- a/corporate/tests/test_remote_billing.py
+++ b/corporate/tests/test_remote_billing.py
@@ -465,7 +465,7 @@ class LegacyServerLoginTest(BouncerTestCase):
     ) -> "TestHttpResponse":
         now = timezone_now()
         with time_machine.travel(now, tick=False):
-            payload = {"server_org_id": self.uuid, "server_org_secret": self.secret}
+            payload = {"zulip_org_id": self.uuid, "zulip_org_key": self.secret}
             if next_page is not None:
                 payload["next_page"] = next_page
             result = self.client_post(
@@ -568,10 +568,10 @@ class LegacyServerLoginTest(BouncerTestCase):
             ["Authenticate server for Zulip billing management"], result
         )
 
-    def test_server_login_invalid_server_org_id(self) -> None:
+    def test_server_login_invalid_zulip_org_id(self) -> None:
         result = self.client_post(
             "/serverlogin/",
-            {"server_org_id": "invalid", "server_org_secret": "secret"},
+            {"zulip_org_id": "invalid", "zulip_org_key": "secret"},
             subdomain="selfhosting",
         )
         self.assertEqual(result.status_code, 200)
@@ -580,10 +580,10 @@ class LegacyServerLoginTest(BouncerTestCase):
             result,
         )
 
-    def test_server_login_invalid_server_org_secret(self) -> None:
+    def test_server_login_invalid_zulip_org_key(self) -> None:
         result = self.client_post(
             "/serverlogin/",
-            {"server_org_id": self.uuid, "server_org_secret": "invalid"},
+            {"zulip_org_id": self.uuid, "zulip_org_key": "invalid"},
             subdomain="selfhosting",
         )
         self.assertEqual(result.status_code, 200)
@@ -595,7 +595,7 @@ class LegacyServerLoginTest(BouncerTestCase):
 
         result = self.client_post(
             "/serverlogin/",
-            {"server_org_id": self.uuid, "server_org_secret": self.secret},
+            {"zulip_org_id": self.uuid, "zulip_org_key": self.secret},
             subdomain="selfhosting",
         )
         self.assertEqual(result.status_code, 200)
@@ -653,7 +653,7 @@ class LegacyServerLoginTest(BouncerTestCase):
         # First test an invalid next_page value.
         result = self.client_post(
             "/serverlogin/",
-            {"server_org_id": self.uuid, "server_org_secret": self.secret, "next_page": "invalid"},
+            {"zulip_org_id": self.uuid, "zulip_org_key": self.secret, "next_page": "invalid"},
             subdomain="selfhosting",
         )
         self.assert_json_error(result, "Invalid next_page", 400)
@@ -678,7 +678,7 @@ class LegacyServerLoginTest(BouncerTestCase):
 
         result = self.client_post(
             "/serverlogin/",
-            {"server_org_id": self.uuid, "server_org_secret": "invalid", "next_page": "billing"},
+            {"zulip_org_id": self.uuid, "zulip_org_key": "invalid", "next_page": "billing"},
             subdomain="selfhosting",
         )
         self.assertEqual(result.status_code, 200)
diff --git a/corporate/views/remote_billing_page.py b/corporate/views/remote_billing_page.py
index 8d2943c8ca..3fad10520f 100644
--- a/corporate/views/remote_billing_page.py
+++ b/corporate/views/remote_billing_page.py
@@ -426,12 +426,12 @@ def create_remote_billing_confirmation_link(
 def remote_billing_legacy_server_login(
     request: HttpRequest,
     *,
-    server_org_id: Optional[str] = None,
-    server_org_secret: Optional[str] = None,
+    zulip_org_id: Optional[str] = None,
+    zulip_org_key: Optional[str] = None,
     next_page: VALID_NEXT_PAGES_TYPE = None,
 ) -> HttpResponse:
     context: Dict[str, Any] = {"next_page": next_page}
-    if server_org_id is None or server_org_secret is None:
+    if zulip_org_id is None or zulip_org_key is None:
         context.update({"error_message": False})
         return render(request, "corporate/legacy_server_login.html", context)
 
@@ -439,7 +439,7 @@ def remote_billing_legacy_server_login(
         return HttpResponseNotAllowed(["POST"])
 
     try:
-        remote_server = get_remote_server_by_uuid(server_org_id)
+        remote_server = get_remote_server_by_uuid(zulip_org_id)
     except RemoteZulipServer.DoesNotExist:
         context.update(
             {
@@ -450,7 +450,7 @@ def remote_billing_legacy_server_login(
         )
         return render(request, "corporate/legacy_server_login.html", context)
 
-    if not constant_time_compare(server_org_secret, remote_server.api_key):
+    if not constant_time_compare(zulip_org_key, remote_server.api_key):
         context.update({"error_message": _("Invalid zulip_org_key for this zulip_org_id.")})
         return render(request, "corporate/legacy_server_login.html", context)
 
diff --git a/templates/corporate/legacy_server_login.html b/templates/corporate/legacy_server_login.html
index 1931f10f05..9a07a098e6 100644
--- a/templates/corporate/legacy_server_login.html
+++ b/templates/corporate/legacy_server_login.html
@@ -27,19 +27,19 @@
                             </div>
                         </div>
                         <div class="input-box server-login-form-field">
-                            <label for="server-org-id" class="inline-block label-title">
-                                server_org_id
+                            <label for="zulip-org-id" class="inline-block label-title">
+                                zulip_org_id
                                 <a href="https://zulip.readthedocs.io/en/stable/production/mobile-push-notifications.html" target="_blank">
                                     <i class="fa fa-question-circle-o" aria-hidden="true"></i>
                                 </a>
                             </label>
-                            <input id="server-org-id" name="server_org_id" class="required" type="text"/>
-                            <div class="alert alert-danger server-login-form-field-error server_org_id-error"></div>
+                            <input id="zulip-org-id" name="zulip_org_id" class="required" type="text"/>
+                            <div class="alert alert-danger server-login-form-field-error zulip_org_id-error"></div>
                         </div>
                         <div class="input-box server-login-form-field">
-                            <label for="password" class="inline-block label-title">server_org_key</label>
-                            <input id="password" name="server_org_secret" class="required" type="password"/>
-                            <div class="alert alert-danger server-login-form-field-error server_org_secret-error"></div>
+                            <label for="password" class="inline-block label-title">zulip_org_key</label>
+                            <input id="password" name="zulip_org_key" class="required" type="password"/>
+                            <div class="alert alert-danger server-login-form-field-error zulip_org_key-error"></div>
                         </div>
                         <div id="server-login-page-button-container">
                             <button type="submit" id="server-login-button" class="stripe-button-el invoice-button">
diff --git a/web/src/billing/remote_billing_auth.ts b/web/src/billing/remote_billing_auth.ts
index 7fbddc9663..d147fdc050 100644
--- a/web/src/billing/remote_billing_auth.ts
+++ b/web/src/billing/remote_billing_auth.ts
@@ -1,21 +1,21 @@
 import $ from "jquery";
 
 function handle_submit_for_server_login_form(form: HTMLFormElement): void {
-    // Get value of server_org_id.
-    const server_org_id = $<HTMLInputElement>("#server-org-id").val();
-    const $error_field = $(".server_org_id-error");
-    if (server_org_id === undefined) {
+    // Get value of zulip_org_id.
+    const zulip_org_id = $<HTMLInputElement>("#zulip-org-id").val();
+    const $error_field = $(".zulip_org_id-error");
+    if (zulip_org_id === undefined) {
         // Already handled by `validate` plugin.
         return;
     }
 
-    // Check if server_org_id is in UUID4 format.
+    // Check if zulip_org_id is in UUID4 format.
     // https://melvingeorge.me/blog/check-if-string-valid-uuid-regex-javascript
     // Regex was modified by linter after copying from above link according to this rule:
     // https://github.com/sindresorhus/eslint-plugin-unicorn/blob/main/docs/rules/better-regex.md
     const is_valid_uuid = /^[\da-f]{8}(?:\b-[\da-f]{4}){3}\b-[\da-f]{12}$/gi;
-    // Check if server_org_id is in UUID4 format.
-    if (!is_valid_uuid.test(server_org_id)) {
+    // Check if zulip_org_id is in UUID4 format.
+    if (!is_valid_uuid.test(zulip_org_id)) {
         $error_field.text(
             "Wrong zulip_org_id format. Check to make sure zulip_org_id and zulip_org_key are not swapped.",
         );