https://github.com/github/fiber-fragments
:framed_picture: Micro fragmentation middleware for fiber :rocket: that enables to build microservice frontends.
https://github.com/github/fiber-fragments
fiber fragments go microservices works-with-codespaces
Last synced: 2 days ago
JSON representation
:framed_picture: Micro fragmentation middleware for fiber :rocket: that enables to build microservice frontends.
- Host: GitHub
- URL: https://github.com/github/fiber-fragments
- Owner: github
- License: mit
- Archived: true
- Created: 2021-06-28T08:04:15.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-08-30T10:17:22.000Z (about 4 years ago)
- Last Synced: 2024-09-30T00:20:18.459Z (about 1 year ago)
- Topics: fiber, fragments, go, microservices, works-with-codespaces
- Language: Go
- Homepage:
- Size: 174 KB
- Stars: 26
- Watchers: 4
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Fragments
[](https://github.com/github/fiber-fragments/actions/workflows/main.yaml)
[](https://goreportcard.com/report/github.com/github/fiber-fragments)
[](https://opensource.org/licenses/MIT)
[](https://twitter.com/SwiftOnSecurity)
Fragments middleware for [Fiber](https://github.com/gofiber/fiber) enables building microservices for the frontend.
A `` symbolizes a part of a template that can be served by a singular microservice. Thus, making a fragment the contract between different services and teams within a large engineering organization. The middleware concurrently fetches those parts from the service and replaces it in the template. It supports `GET` and `POST` [HTTP methods](https://developer.mozilla.org/de/docs/Web/HTTP/Methods) to fetcht the content. Related resources like CSS or JavaScript are injected via the [HTTP `LINK` entity header field](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Link). A `` can occure in the [`body` element](https://developer.mozilla.org/de/docs/Web/HTML/Element/body) or the [`header` element](https://developer.mozilla.org/de/docs/Web/HTML/Element/header). See [Example](#example) to learn more about using fragments.
[Tailor](https://github.com/zalando/tailor) by Zalando is prior art for this middleware.
## Fragement(s)
A `fragment` will be hybrid-polymorphic (if this is a thing). On the server it is parsed and evaluate by the middleware. 🦄 In the browser it will be a web component that received data from the middleware (**this is still work in progress ⚠️**).
### Server
* `src` The source to fetch for replacement in the DOM
* `method` can be of `GET` (default) or `POST`.
* `primary` denotes a fragment that sets the response code of the page
* `id` is an optional unique identifier (optional)
* `ref`is an optional forward reference to an `id` (optional)
* `timeout` timeout of a fragement to receive in milliseconds (default is `300`)
* `deferred` is deferring the fetch to the browser
* `fallback` is the fallback source in case of timeout/error on the current fragment
## Example
Import the middleware package this is part of the Fiber web framework.
```go
package main
import (
"github.com/gofiber/fiber/v2"
"github.com/gofiber/template/html"
"github.com/github/fiber-fragments"
)
```
After you initiate your Fiber app, you can plugin in the fragments middleware. The middleware draws the templates for the fragments to load from the template engine. Thus it supports using all [template](https://github.com/gofiber/template) engines supported by the Fiber team.
```go
// Create a new engine
engine := html.New("./views", ".html")
// Pass the engine to the Views
app := fiber.New(fiber.Config{
Views: engine,
})
// Associates the route with a specific template with fragments to render
app.Get("/index", fragments.Template(fragments.Config{}, "index", fiber.Map{}, "layouts/main"))
// this would listen to port 8080
app.Listen(":8080")
```
```html
Example
```
The `example` folder contains many examples. You can learn how to use a forward reference of content for fetching outer and inner content and replace either one.
## Benchmark(s)
This is run on a MacBook Pro 16 inch locally. It is the `example` run.
* Parsing a local template with extrapolation with the fragments
* Parsing the fragments
* Doing fragments
* Inlining results and adding `Link` header resources to the output
```bash
echo "GET http://127.0.0.1:8080/index" | vegeta attack -duration=5s -rate 2000 | tee results.bin | vegeta report
vegeta report -type=json results.bin > metrics.json
cat results.bin | vegeta plot > plot.html
cat results.bin | vegeta report -type="hist[0,100ms,200ms,300ms]"
Requests [total, rate, throughput] 10000, 2000.26, 2000.15
Duration [total, attack, wait] 5s, 4.999s, 285.172µs
Latencies [min, mean, 50, 90, 95, 99, max] 183.725µs, 251.517µs, 226.993µs, 310.698µs, 394.601µs, 563.022µs, 1.347ms
Bytes In [total, mean] 6240000, 624.00
Bytes Out [total, mean] 0, 0.00
Success [ratio] 100.00%
Status Codes [code:count] 200:10000
Error Set:
Bucket # % Histogram
[0s, 100ms] 10000 100.00% ###########################################################################
[100ms, 200ms] 0 0.00%
[200ms, 300ms] 0 0.00%
[300ms, +Inf] 0 0.00%
```
## License
[MIT](/LICENSE)