https://github.com/jonasbn/pxy-redirect
Experimental service for deployment on DigitalOceans app platform
https://github.com/jonasbn/pxy-redirect
app digitalocean do go golang service
Last synced: 4 months ago
JSON representation
Experimental service for deployment on DigitalOceans app platform
- Host: GitHub
- URL: https://github.com/jonasbn/pxy-redirect
- Owner: jonasbn
- License: mit
- Created: 2022-10-19T18:52:53.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-01-14T05:46:10.000Z (over 1 year ago)
- Last Synced: 2025-02-15T05:27:21.259Z (over 1 year ago)
- Topics: app, digitalocean, do, go, golang, service
- Language: HTML
- Homepage: https://pxy.fi/
- Size: 74.2 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# pxy-redirect
## Introduction
This is service I created for deployment on [DigitalOcean][DO]. The service has been replace by a serverless function [pxy-redirect-ow-function][FUNCTION]
It supports some documentation I have written up, which resulted in a bug. The bug could be observed when displaying a Markdown page on GitHub. which exceeded the size limit of what could be rendered a Markdown. Please see my [blog post][BLOG] for the long version.
## Description
The service takes a HTTP request, parses it and redirects to the designated documentation page on the [releases.llvm.org][LLVM] website.
The acceptable URLs being:
- `//`
So the first part has to be a number and the second part a string corresponding to the equivalent on the [releases.llvm.org][LLVM] website.
Example:
`/5/rsanitize-address`
Would be parsed and altered and redirected to:
`https://releases.llvm.org/5.0.0/tools/clang/docs/DiagnosticsReference.html#rsanitize-address`
## Diagnostics
This is a collection of errors which can be emitted from the service. Not all are visible to the end user and not all error scenarios are documented.
This section and documentation is primarily aimed and what can be recovered from.
### Unable to assemble URL (400)
This is the most common error it will provide additional information as to why the request was regarded as a bad request.
#### insufficient parts in provided url
The the request does not contain enough parts to assemble the redirect target URL.
#### first part of url is not a number
The first part of the URL should be a number (integer), which is translated to a version number.
#### second part of url is not a string
The second part of the URL should be a string.
### Unable to parse received URL error (500)
The URL could not be parsed.
### `ListenAndServe` fatal error
This error is emitted if the service is unable to start. The error message will contain details.
The error is not visible to the end-user as such, but the service will be unavailable.
## Resources and References
- [pxy-redirect-ow-function][FUNCTION]
- [My TIL collection: clang diagnostic flags](https://github.com/jonasbn/til/blob/master/clang/diagnostic_flags.md) (GitHub)
- [My TIL collection: clang diagnostic flags](http://jonasbn.github.io/til/clang/diagnostic_flags.html) (website)
- [clang diagnostic flags matrix generator](https://github.com/jonasbn/clang-diagnostic-flags-matrix)
- [llvm releases documentation site][LLVM]
- [DigitalOcean][DO]
[DO]: https://www.digitalocean.com/
[LLVM]: https://releases.llvm.org/
[pxy.fi]: https://pxy.fi/
[FUNCTION]: https://github.com/jonasbn/pxy-redirect-ow-function
[BLOG]: https://dev.to/jonasbn/challenges-solutions-and-more-challenges-and-more-solutions-4j3f