Switch to TypeScript and express & Add stats API #1
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
I can't request more than one reviewer at a time in a private repository, so I'll just ping @Ryujinx/developers and hope you'll take a look. :D |
riperiperi
reviewed
Jun 11, 2023
Setup environment for: - Typescript - express with ejs as the view engine
GitHub supports pnpm for dependabot natively now: https://github.blog/changelog/2023-06-12-dependabot-version-updates-now-supports-pnpm/
TSRBerry
changed the title
|
@riperiperi the latest changes were made for better Nix compatibility. Since these changes are now finished, feel free to take a look and review these as well. |
marysaka
approved these changes
Jun 28, 2023
7 tasks
riperiperi
approved these changes
Jul 2, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This should be the last thing that needs to be done before we can make this repo public.
Deployment notes
@marysaka make sure to block public access to
/info, it's just intended for health checks that could be used by a Kubernetes cluster for example. I wanted to add health checks for Docker as well, but we can only use commands for that and the node image does not have curl.Overview
The change to TypeScript was done for the server code, so it's easier to maintain. The static website code is still plain JavaScript as I didn't want to change too many things at once and the main goal of this PR was to get the stats API working again.
I also decided to use pnpm instead of npm for package management, since it's a lot faster and feels a little more modern.
In case dependabot creates update PRs a workflow will be triggered to update the(Dependabot now natively supports pnpm as well.)pnpm-lock.yamlas well, so it shouldn't break due to dependency updates.API changes
The new API is now using express and a Redis client to read the data provided by the LDN server.
Since the website and the LDN server have been split we needed to come up with a new way to provide stats for the website.
The API itself changed minimally and only in places where it was possible without breaking existing Ryujinx LDN builds.
The LDN server has already been adapted to write the data into a Redis database nearly in real time.
Possible future changes
Since we are now using express and TypeScript we can polish this website a lot more and potentially get rid of all the JavaScript with the help of a template engine like EJS.
By opening this repository to the public we might also see some external contributors with new ideas, so I hope these changes also make it easy to work with the website and won't be a hindrance to anyone who is interested.