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.
This commit is contained in:
Aman Agrawal 2023-12-12 08:43:30 +00:00 committed by Tim Abbott
parent ab1a8a0151
commit cf68f8ae24
4 changed files with 27 additions and 27 deletions

View File

@ -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)

View File

@ -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)

View File

@ -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">

View File

@ -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.",
);