Skip to content
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.

Sign up for GitHub

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

fix: update demo server URLs to 'checkmate-demo.bluewavelabs.ca' #1364

Merged
merged 1 commit into from
Dec 12, 2024
Merged

fix: update demo server URLs to 'checkmate-demo.bluewavelabs.ca' #1364

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Docker/dist/nginx/conf.d/default.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ server {
listen 80;
listen [::]:80;

server_name uptime-demo.bluewavelabs.ca;
server_name checkmate-demo.bluewavelabs.ca;
server_tokens off;

location /.well-known/acme-challenge/ {
Expand Down
2 changes: 1 addition & 1 deletion Docker/test/docker-compose.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ services:
client:
image: uptime_client:latest
environment:
UPTIME_APP_API_BASE_URL: "https://uptime-demo.bluewavelabs.ca/api/v1"
UPTIME_APP_API_BASE_URL: "https://checkmate-demo.bluewavelabs.ca/api/v1"
Copy link

Choose a reason for hiding this comment

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

💡 Codebase verification

Yo, hold up! There's a domain mismatch that's making me nervous!

The test environment's Nginx configuration uses checkmate-test.bluewavelabs.ca as the server name, but the API URL in the docker-compose is set to checkmate-demo.bluewavelabs.ca. This inconsistency could cause connectivity issues:

  • Docker/test/nginx/conf.d/default.conf uses checkmate-test.bluewavelabs.ca
  • Docker/test/docker-compose.yaml uses checkmate-demo.bluewavelabs.ca

The test environment should consistently use the test domain across all configurations to maintain proper separation from production.

🔗 Analysis chain

Straight outta consistency check!

The environment variable update matches the prod configuration, maintaining consistency across environments. However, using the same domain for both test and prod environments might cause confusion.

Consider using different subdomains for test and prod environments (e.g., test.checkmate-demo vs checkmate-demo) to prevent confusion.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check if there are any remaining references to the old domain
rg "uptime-demo.bluewavelabs.ca" Docker/test/

Length of output: 45

Script:

#!/bin/bash
# Let's check both test and prod docker-compose files to compare the domains
echo "=== Checking Docker/test/docker-compose.yaml ==="
grep -A1 "UPTIME_APP_API_BASE_URL" Docker/test/docker-compose.yaml

echo -e "\n=== Checking Docker/prod/docker-compose.yaml ==="
grep -A1 "UPTIME_APP_API_BASE_URL" Docker/prod/docker-compose.yaml

# Let's also check for any other environment variables with domains
echo -e "\n=== Checking all domain references in Docker directory ==="
rg -i "bluewavelabs.ca" Docker/

Length of output: 2639

ports:
- "80:80"
- "443:443"
Expand Down
2 changes: 1 addition & 1 deletion Docker/test/prod/docker-compose.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ services:
client:
image: uptime_client:latest
environment:
UPTIME_APP_API_BASE_URL: "https://uptime-demo.bluewavelabs.ca/api/v1"
UPTIME_APP_API_BASE_URL: "https://checkmate-demo.bluewavelabs.ca/api/v1"
ports:
- "80:80"
- "443:443"
Expand Down
8 changes: 4 additions & 4 deletions Docker/test/prod/nginx/conf.d/default.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ server {
listen 80;
listen [::]:80;

server_name uptime-demo.bluewavelabs.ca;
server_name checkmate-demo.bluewavelabs.ca;
server_tokens off;

location /.well-known/acme-challenge/ {
Expand Down Expand Up @@ -38,10 +38,10 @@ server {
listen 443 default_server ssl http2;
listen [::]:443 ssl http2;

server_name uptime-demo.bluewavelabs.ca;
server_name checkmate-demo.bluewavelabs.ca;

ssl_certificate /etc/nginx/ssl/live/uptime-demo.bluewavelabs.ca/fullchain.pem;
ssl_certificate_key /etc/nginx/ssl/live/uptime-demo.bluewavelabs.ca/privkey.pem;
ssl_certificate /etc/nginx/ssl/live/checkmate-demo.bluewavelabs.ca/fullchain.pem;
ssl_certificate_key /etc/nginx/ssl/live/checkmate-demo.bluewavelabs.ca/privkey.pem;

location / {
root /usr/share/nginx/html;
Expand Down
2 changes: 1 addition & 1 deletion Server/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@
}
},
{
"url": "https://uptime-demo.bluewavelabs.ca/{API_PATH}",
"url": "https://checkmate-demo.bluewavelabs.ca/{API_PATH}",
"description": "Bluewave Demo Server",
"variables": {
"PORT": {
Expand Down
2 changes: 1 addition & 1 deletion guides/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ It regularly checks whether a server/website is accessible and performs optimall

## Demo

We have a [demo](https://uptime-demo.bluewavelabs.ca/) where you can test how the Uptime Manager works. The username is [[email protected]](mailto:[email protected]) and the password is Demouser1!
We have a [demo](https://checkmate-demo.bluewavelabs.ca/) where you can test how the Uptime Manager works. The username is [[email protected]](mailto:[email protected]) and the password is Demouser1!

## Questions & ideas

Expand Down
2 changes: 1 addition & 1 deletion guides/developers-guide/general-project-structure.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ When making changes to the Front end please always keep future developers in min

### Back end

The back end of this project is not especially complex and is built around Express. The back end is a RESTful API and the [documentation can be found here](https://uptime-demo.bluewavelabs.ca/api-docs).
The back end of this project is not especially complex and is built around Express. The back end is a RESTful API and the [documentation can be found here](https://checkmate-demo.bluewavelabs.ca/api-docs).

The application consists of several main conceptual models:

Expand Down
2 changes: 1 addition & 1 deletion guides/users-guide/quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,7 @@ Our API is documented in accordance with the [OpenAPI spec](https://www.openapis

You can see the documentation on your local development server at http://localhost:{port}/api-docs

You can also view the documentation on our demo server at [https://uptime-demo.bluewavelabs.ca/api-docs](https://uptime-demo.bluewavelabs.ca/api-docs)
You can also view the documentation on our demo server at [https://checkmate-demo.bluewavelabs.ca/api-docs](https://checkmate-demo.bluewavelabs.ca/api-docs)
Copy link

Choose a reason for hiding this comment

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

💡 Codebase verification

Yo dawg, we got a 301 redirect situation with that API docs URL!

Listen up, the URL's giving us a 301 redirect (that's a permanent move), and I noticed it wants a trailing slash. Plus, I found the new checkmate-demo URL consistently used across the whole codebase - in the docs, Docker configs, and OpenAPI specs. That's straight fire! 🔥

But here's the deal:

  • The API docs URL should include that trailing slash to avoid the redirect: https://checkmate-demo.bluewavelabs.ca/api-docs/
  • All other references to the demo server are properly updated and consistent
🔗 Analysis chain

Yo, the URL update looks solid! Let's verify it's working though.

The URL change from uptime-demo to checkmate-demo aligns perfectly with the PR objectives. Just wanna make sure it's actually accessible.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check if the new demo server URL is accessible
# Expected: 200 OK response

curl -I https://checkmate-demo.bluewavelabs.ca/api-docs

Length of output: 553

Script:

#!/bin/bash
# Let's check if there are any other occurrences of the old or new demo URLs in the codebase
rg -i "uptime-demo.bluewavelabs.ca|checkmate-demo.bluewavelabs.ca" -A 2 -B 2

Length of output: 5212


### Error handling

Expand Down