Skip to content

mia-platform/cdn-publish

BranchesTags

Repository files navigation

CDN publish

CDN publish is a Node.js bin CLI to manage files on Mia's instance of the bunny.net global CDN storage service.

An instance of a bunny CDN provides a file storage API that is scoped for your organization by a storageZoneName which is usually provided to you via secret sharing tools like vault.

Such storageZoneName combined with an access key gives full access to file operations like

  • downloads
  • put/patch
  • delete

Beside providing a helpful (we hope!) wrapper around the basic HTTP client needed to query the API, CDN publish provides opinionated behaviors that make the put/patch API look like npm publish and yarn npm publish

npm-like behaviors

CDN publish implements an npm publish-like behavior. When we reference npm publish we also refer to the yarn wrapper for yarn 2+. The most notable behaviours are:

  1. npm publish will use the package.json file available in the working directory to establish:
    1. which files to push -> files key
    2. the scope of your package by using the name key first slice before a / which most often starts with an @ sign.
  2. npmjs registry does not allow to PUT twice the same semver version of a package, like 0.1.0 or 3.0.10-rc2. Although we cannot enforce it on the file storage API, CDN publish enforces it (with possibility to override) on the client side. This is useful to avoid incorrect CI runs.

CDN publish behaves in the exact same fashion.

How to use it

CDN publish is focused on npm packages publish.

CDN publish has always two required parameter:

  • -s or --storage-zone-name which is the storageZoneName you're targetting;
  • -k or --storage-access-key which is the API key of the storageZoneName you're targetting.

Typically a release/deploy pipeline will take care or install node, build your library and caching the build results which must be available to the cdn release job/step.

As a CLI for file storage

CDN publish can be invoked as a standalone binary from npm by installing on your global npm bin store

npm install -g @mia-platform/cdn-publish

and then

cdn [options] [command]

GitHub Action

In a GitHub workflow, the CDN publish CLI can be called by running its container as per the following snippet:

cdn-release:
  needs:
    []
    # 👆 your dependencies
  name: Release on CDN
  runs-on: ubuntu-latest

  build:
    steps:
    - name: Build
      run: yarn build --dir dist
      # 👆 your build commands, depends on the project

      - name: Archive Production Artifacts
        uses: actions/upload-artifact@v2
        with:
          name: built-project
          path: dist/

  cdn-release:
    needs: build
    name: Test CDN
    runs-on: ubuntu-latest

    steps:
     - name: Download Artifacts
       uses: actions/download-artifact@v2
       with:
         name: built-project
         path: ./dist

     - name: Publish to Mia CDN
       run: |
        docker run --rm -v $PWD/dist:/dist miaplatform/cdn-publish cdn -k "$STORAGE_ACCESS_KEY" -s "$STORAGE-ZONE" --project ./dist

Or, if you are running a job with npm installed, you can simply install the cli:

cdn-release:
  needs:
    []
    # 👆 your dependencies
  name: Release on CDN
  runs-on: ubuntu-latest

  steps:
   - name: Use Node.js 18
     uses: actions/setup-node@v3
     with:
       node-version: 18

    - name: Install CDN Publish CLI
      run: npm i -g @mia-platform/cdn-publish

    # ... steps to build or download artifact

    - name: Publish to Mia CDN
      run: cdn publish -k "$STORAGE_ACCESS_KEY" -s "$STORAGE-ZONE"

GitLab job

In a GitLab CI, the CDN publish CLI can be called by running its container as per the following snippet

cdn-release:
  stage: release
  image: miaplatform/cdn-publish
  needs:
    []
    # 👆 your dependencies
  rules:
    []
    # 👆 your rules
  cache:
    []
    # 👆 your cache
  script:
    - cdn publish -k "$STORAGE_ACCESS_KEY" -s "$STORAGE-ZONE" --project ./dist

From source code

This repository can be used as well to run CDN publish

git clone https://github.com/mia-platform/cdn-publish.git

then install (we recommend using nvm to ensure proper Node.js versioning)

npm i
# or
yarn install

then you can either run Typescript code

npm run cli:run [options] [command]
# or
yarn cli:run [options] [command]

or build and test the final bundled binary

npm run build
# or
yarn build

# and then
node dist/index.cjs [options] [command]

Commands and Syntax

Here's a list of available commands that CDN publish provides. The placeholder cdn stands for the command invocation, which could either be:

  1. [npm] npx --package "@mia-platform/cdn-publish" cdn
  2. [yarn] yarn dlx --package "@mia-platform/cdn-publish" cdn
  3. [docker container] cdn
  4. [local bundle] node dist/index.cjs
  5. [local install] npm i -g . && cdn

Help

Provides information on commands and options

cdn help [command]

list

List

Provides a list of the file currently available on the storage service under a given path/directory

cdn list [options] <dir>

with options:

  • -k, --storage-access-key -- required, the storageZoneName access key
  • -s, --storage-zone-name -- required, the storageZoneName
  • -u, --base-url -- the api base url, default is: https://storage.bunnycdn.com

list

Publish

Allows to put/patch files onto the CDN file storage service

cdn publish [options]

the files optional argument takes precedence over anything specified in the package.json file selected (or defaulted) by the invocation of CDN publish

with options:

  • -k, --storage-access-key -- required, the storageZoneName access key
  • -s, --storage-zone-name -- required, the storageZoneName
  • -u, --base-url -- the api base url, default is: https://storage.bunnycdn.com
  • -p, --project -- used to override the location of the package.json file. Useful for repositories with workspaces
  • -b, --batch-size -- number of files to be uploaded concurrently
  • --scope -- a directory to prepend to all pushed files. Defaults to the package.json's name field matched against /^@([^/]+)\//
  • --override-version [string] -- in case the pushed context is sem-versioned, allows to opt-out of the client no-double-push policy on semver packages.
  • --checksum -- requires the server to fail the push if uploaded file has a checksum that does not match with the one computed on the client side.

publish

Upload

Allows to put/patch files onto the CDN file storage service

cdn upload [options] [files...]

the files are the list of files or directories to push on the cdn. It will throw an error if the folder it is not empty.

with options:

  • -k, --storage-access-key -- required, the storageZoneName access key
  • -s, --storage-zone-name -- required, the storageZoneName
  • -u, --base-url -- the api base url, default is: https://storage.bunnycdn.com
  • -b, --batch-size -- number of files to be uploaded concurrently.
  • --dest -- a directory to prepend to all pushed files.
  • --checksum -- requires the server to fail the push if uploaded file has a checksum that does not match with the one computed on the client side.

upload

Delete

Provides cleanup/delete of a directory or a file on the file storage service

cdn delete [options] <dir>

with options:

  • -k, ---access-key -- required, the storageZoneName access key
  • -s, --storage-zone-name -- required, the storageZoneName
  • -u, --base-url -- the api base url, default is: https://storage.bunnycdn.com
  • --avoid-throwing -- in case of error it avoids returning an exit 1. Useful for CI/CD environments.

delete

Commands to manage pull zones

Here is a list of commands used to be able to interact with pull zones:

Caution: The '--access-key' token should not be confused with the '--storage-access-key' token, which is used only for file management purposes.

List

Provides a list of the avaiable pullzones

cdn pullzone list [options]

with options:

  • -k, --access-key -- required, the storageZoneName access key
  • -u, --base-url -- the api base url, default is: https://api.bunny.net
  • -s, --search -- a query param to filter results (NB. Broken in bunny API!)

pullzone_list

Purge

The following command is used to purge pull zones, either individually selected or all of them by default. Upon execution, the command provides information about the zone ID and the corresponding API response status, to know the successfully purged zones.

cdn pullzone purge [options]

with options:

  • -k, --access-key -- required, the storageZoneName access key
  • -u, --base-url -- the api base url, default is: https://api.bunny.net
  • -z, --zone -- to purge only a specific zone id

pullzone_list

Local Development

To run locally this CLI, after checkout, install dependencies by running:

# when using nvm to keep track of node version
nvm use

yarn install

then to run the source code:

yarn cli:run [options] [command]

to get help, just run:

yarn cli:run help

If you'd like to run the bundled CDN CLI:

yarn build
node dist/index.cjs [options] [command]

Integration tests

Beside unit tests, integration tests against a test instance of mia bunny CDN are available when running github actions on PR merge request.

If you have access, by owning the test environment access key, integration tests are available also locally.

First initialize some environment variables, for instance by running the following steps:

# .env.local is gitignored
touch .env.local
echo -e "CDN_STORAGE_ACCESS_KEY=<CHANGE_ME>" >> .env.local
echo -e "CDN_STORAGE_ZONE_NAME=<CHANGE_ME>" >> .env.local
echo -e "CDN_STORAGE_BASE_URL=https://storage.bunnycdn.com" >> .env.local
echo -e "CDN_API_BASE_URL=https://api.bunny.net" >> .env.local

and then run:

yarn test:integration

⚠️ integration tests are not 100% stable: you might need re-running tests multiple times, Be very careful here!

About

A client for Mia's CDN storage API

Resources

Readme

License

Apache-2.0 license

Code of conduct

Code of conduct

Security policy

Security policy
Activity
Custom properties

Stars

2 stars

Watchers

1 watching

Forks

0 forks
Report repository

Contributors 4

  •  
  •  
  •  
  •  

Languages