juju / bakeryjs

Javascript implementation of the Macaroon Bakery

Juju is an open source application orchestration engine that enables any application operation (deployment, integration, lifecycle management) on any infrastructure (Kubernetes or otherwise) at any scale (development or production) in the same easy way (typically, one line of code), through special operators called ‘charms’.

👉	Juju	Learn how to quickly deploy, integrate, and manage charms on any cloud with Juju. It's as simple as juju deploy foo, juju integrate foo bar, ..., on any cloud.
	Charmhub	Sample our existing charms on Charmhub. A charm can be a cluster (OpenStack, Kubernetes), a data platform (PostgreSQL, MongoDB, etc.), an observability stack (Canonical Observability Stack), an MLOps solution (Kubeflow), and so much more.
	Charm SDK	Write your own charm! Juju is written in Go, but our SDK supports easy charm development in Python.

Give it a try!

Let's use Juju to deploy, configure, and integrate some Kubernetes charms:

Set up

You will need a cloud and Juju. The quickest way is to use a Multipass VM launched with the charm-dev blueprint.

Install Multipass: Linux | macOS | Windows. On Linux:

sudo snap install multipass

Use Multipass to launch an Ubuntu VM with the charm-dev blueprint:

multipass launch --cpus 4 --memory 8G --disk 30G --name tutorial-vm charm-dev 

Open a shell into the VM:

multipass shell tutorial-vm

Verify that you have Juju and two localhost clouds:

juju clouds

Bootstrap a Juju controller into the MicroK8s cloud:

juju bootstrap microk8s tutorial-controller

Add a workspace, or 'model':

juju add-model tutorial-model

Deploy, configure, and integrate a few things

Deploy Mattermost:

juju deploy mattermost-k8s

See more: Charmhub | mattermost-k8s

Deploy PostgreSQL:

juju deploy postgresql-k8s --channel 14/stable --trust

See more: Charmhub | postgresql-k8s

Enable security in your PostgreSQL deployment:

juju deploy tls-certificates-operator
juju config tls-certificates-operator generate-self-signed-certificates="true" ca-common-name="Test CA"
juju integrate postgresql-k8s tls-certificates-operator

Integrate Mattermost with PostgreSQL:

juju integrate mattermost-k8s postgresql-k8s:db

Watch your deployment come to life:

juju status --watch 1s

(Press Ctrl-C to quit. Drop the --watch 1s flag to get the status statically. Use the --relations flag to view more information about your integrations.)

Test your deployment

When everything is in active or idle status, note the IP address and port of Mattermost and pass them to curl:

curl <IP address>:<port>/api/v4/system/ping

You should see the output below:

{"AndroidLatestVersion":"","AndroidMinVersion":"","IosLatestVersion":"","IosMinVersion":"","status":"OK"}

Congratulations!

You now have a Kubernetes deployment consisting of a Mattermost backed by PosgreSQL with TLS-encrypted traffic!

Clean up

Delete your Multipass VM:

multipass delete --purge tutorial-vm

Uninstall Multipass: Linux | macOS | Windows. On Linux:

snap remove multipass

Next steps

Learn more

• Read our user docs
• Read our developer docs

Chat with us

Read our Code of conduct and:

• Join our chat: Matrix
• Join our forum: Discourse

File an issue

• Report a Juju bug on Launchpad
• Raise a general https://juju.is/docs documentation issue on Github | juju/docs

Make your mark

• Read our documentation contributor guidelines and help improve a doc
• Read our codebase contributor guidelines and help improve the codebase

bakeryjs's Issues

Add documentation

This documentation could include:

• What does this package do?
• Who should use this lib?
• How do I interface with this library?
• Why is it named "bakery"?
• What is a "macaroon"?
• API/Functions etc. descriptions.
• Usage examples.
• List of projects that use it.

visit func can be called multiple times

If a macaroon key changes on the server, the next request(s) can result in multiple calls to visit which opens n windows per request. While this isn't likely to occur in production frequently, it can result in some surprising behaviour to the user, particularly if the client is making quite a few requests.

Would it be possible to make calls to the visit function more state aware, so that only one tab/window will be opened at once?

It would be nice if js bakery could be updated with fixes for multi-caveat discharge and available on npm registry

Package size increased from 61.8 kB to 532 kB in 1.2.0

Package size went through the roof in the latest release. This results in bundle size increases across different projects that use this package (e.g. https://github.com/canonical-web-and-design/maas-ui)

version	1.1.0	1.2.0
size	61.8 kB	532 kB

Looks like it might've been caused by the PR below which adds webpack 5 support:
#39

callback not being called in case of TLS cert error in bakery request

When bakery tries to discharge a 3rd party caveat to an https endpoint whose certificate is not trusted (e.g. self-signed), the POST /discharge fails, but the error is not propagated to the caller's callback as it doesn't contain a JSON text in the body (IOW, JSON.parse() fails).

As a side note, it would be nice if the returned error could always be a string, so that the caller can use it for user feedback.

Webpack > 5 no longer polyfills node.js core modules

Webpack > 5 no longer polyfills node.js core modules by default, so getting bakeryjs working requires installing a few core modules as well. These packages should probably be included explicitly as part of this project.

These core modules include buffer, crypto, stream and util.

Unique macaroon stored for every url

Currently, every request made by the bakery stores a unique macaroon for that url, resulting in a macaroon handshake for every new request. The internal implementation appears to store macaroons by url rather than host.

Migrate to yarn

As we're using yarn for other projects, consider migrating this project to yarn.

Investigate removal of crypto polyfill

all browsers that we officially support can handle Web Cryptography natively. We should consider dropping the crypto polyfills that are added to the @canonical/macaroon-bakery especially if it's a dependency of a dependency.

https://webteam.canonical.com/practices/browser-support
https://caniuse.com/?search=crypto

canonical/maas-ui#4260 (comment)

Migrate to typescript

It would be very helpful if this was migrated to TypeScript to provide type definitions for the consuming projects.

Migrate to canonical-web-and-design org

As bakeryjs is used by several projects outside of Juju now, it would make sense to migrate this to the webteam org.

Compiled typescript is failing

When building a project like jujulib we are getting the following output:

$ yarn build
yarn run v1.22.19
$ tsc
node_modules/@canonical/macaroon-bakery/dist/bakery.d.ts:12:66 - error TS7016: Could not find a declaration file for module 'macaroon'. '/home/goulin/Lab/juju/js-libjuju/node_modules/macaroon/macaroon.js' implicitly has an 'any' type.
  Try `npm i --save-dev @types/macaroon` if it exists or add a new declaration (.d.ts) file containing `declare module 'macaroon';`

12 import { Macaroon, Error as MacaroonError, MacaroonObject } from "macaroon";
                                                                    ~~~~~~~~~~


Found 1 error in node_modules/@canonical/macaroon-bakery/dist/bakery.d.ts:12

error Command failed with exit code 2.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.

Return response headers

Ideally the xhr object from _request could be returned with response headers (needed for pagination etc.).