Skip to content

fix case of subdomain term #382

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Mar 4, 2023
Merged

fix case of subdomain term #382

merged 4 commits into from
Mar 4, 2023

Conversation

cat5inthecradle
Copy link
Contributor

I'm nearly certain this variable rename would be a no-op on the actual template.

Copy link

@Hamms Hamms left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

one nit, otherwise LGTM; thanks for picking this up so quickly!

As an aside, there is also an argument to be made that the phrase "Base Domain Name" is a bit confusing. Technically, something like code.org is just called a "base domain", and consists of two parts: the "domain name" (code) and the "top-level domain" (org). We're kind of smashing together the two different-but-related concepts of "base domain" and "domain name" to produce a phrase which I think we consistently use to refer to just one of those concepts. Either way, though, that's a discussion for another PR.

Type: String
Description: Sub domain name for javabuilder service.
Description: Sub domain name for javabuilder service (e.g. 'javabuilder' in 'javabuilder.code.org').
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit:

Suggested change
Description: Sub domain name for javabuilder service (e.g. 'javabuilder' in 'javabuilder.code.org').
Description: Subdomain name for javabuilder service (e.g. 'javabuilder' in 'javabuilder.code.org').

Looks like the corresponding line in 3-app already got updated!

@cat5inthecradle
Copy link
Contributor Author

cat5inthecradle commented Feb 3, 2023

As an aside, there is also an argument to be made that the phrase "Base Domain Name" is a bit confusing. Technically, something like code.org is just called a "base domain", and consists of two parts: the "domain name" (code) and the "top-level domain" (org). We're kind of smashing together the two different-but-related concepts of "base domain" and "domain name" to produce a phrase which I think we consistently use to refer to just one of those concepts. Either way, though, that's a discussion for another PR.

I don't know what the best term is here for domain + tld, I avoided DomainName to make it more clear that it wouldn't include a subdomain. We're using BaseDomain in three ways:

  1. To identify when we're using 'dev-code.org' (these could be refactored away I think)
  2. To identify the hosted zone (nameserver) for new dns records (could be refactored to use hostedzoneID, which we already require)
  3. To assist with the creation of certain urls like subdomain-http.domain.tld and subdomain-content.domain.tld (these could be refactored to service-subdomain.domain.tld or service.subdomain.domain.tld
  4. related, we create alarms named subdomain_alarm_name, so having the subdomain distinct is also useful.

Edit-to-add: Changing those additional urls, alarms, etc, would probably break continuity with some existing logs and data, and would at the very least need to be strategically timed to ensure we have useful data for the school year.

@Hamms
Copy link

Hamms commented Feb 3, 2023

Best term I'd say for domain + tld is just BaseDomain. In general:

TopLevelDomain = 'org'
DomainName = 'code'
Subdomains = ['studio']
BaseDomain = [DomainName, TopLevelDomain].join('.')
Hostname = [*Subdomains, BaseDomain].join('.')

Copy link
Contributor

@sureshc sureshc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit - feature branch name is way too hilarious

@cat5inthecradle
Copy link
Contributor Author

discussion of whether we need to maintain log/alarm continuity: https://codedotorg.slack.com/archives/C03DBDN67B7/p1675465733136349

@cat5inthecradle cat5inthecradle merged commit 4c7d74a into main Mar 4, 2023
@cat5inthecradle cat5inthecradle deleted the case-smash branch March 4, 2023 04:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants