@dcl/asset-packs 0.0.0-20230908135400.commit-e2c5b3c → 0.0.0-20230911215327.commit-4ff713d

package/.dockerignore

@@ -0,0 +1,7 @@
+node_modules/
+dist
+Dockerfile
+docker-compose.yml
+minio-mc-entrypoint.sh
+.env
+.git

package/Dockerfile

@@ -0,0 +1,15 @@
+FROM node:18-alpine
+
+WORKDIR /app
+
+COPY package.json /app/package.json
+COPY package-lock.json /app/package-lock.json
+
+RUN npm ci
+
+COPY . /app
+
+# Dependencies to run an http server and serve the catalog and assets
+RUN npm install concurrently
+
+ENTRYPOINT ["./entrypoint.sh"]

package/README.md

@@ -25,20 +25,40 @@ Every [release](https://github.com/decentraland/asset-packs/releases) will be de
 You can develop this repo locally and test it within the Web Editor by doing the following:
 
 Go to this repo in your machine and do this:
-1. Run `npm run start:lib` to watch for changes.
-2. Run `npm run start:js` to start running the SDK7 scene locally (by default on port `8000`).
-3. Run `npm link` to allow other projects to symlink to this one.
-4. Copy the path to the `bin/index.js` in this repo (something like `/Users/my-user/path/to/asset-packs/bin/index.js`).
+
+#### Using the command line
+
+- To start the SDK7 scene and watch for changes:
+  1. Run `npm run start:lib` to watch for changes.
+  2. Run `npm run start:js` to start running the SDK7 scene locally (by default on port `8000`).
+  3. Run `npm link` to allow other projects to symlink to this one.
+  4. Copy the path to the `bin/index.js` in this repo (something like `/Users/my-user/path/to/asset-packs/bin/index.js`).
+
+- To start the catalog server:
+  1. Set the `AWS_ACCESS_KEY_ID` env var in `.env` to be your AWS access key.
+  2. Set the `AWS_SECRET_ACCESS_KEY` env var in `.env` to be your AWS secret key.
+  3. Set the `S3_BUCKET_NAME` env var in `.env` to be your S3 bucket.
+  4. Set the `AWS_STORAGE_URL` env var in `.env` to be your custom S3 object server.
+  5. Set the `CATALOG_SERVER_PORT` env var in `.env` to be `8002` (this is the catalog server we will start in the next step).
+  6. Run `npm run start:catalog` to start running an http server to serve the catalog.json and the asset-packs content from a custom S3 object server (by default on port `8002`).
+
+#### Using Docker
+
+If you have docker running on your device, you can start all these services using the `docker-compose.yml` file in this repo by running: `docker-compose up`.
+
+This will start the SDK7 scene and the catalog server with a minio S3 server to store the assets locally.
 
 Go the `js-sdk-toolchain` repo in your machine and do this:
+
 1. Run `cd packages/@dcl/inspector`.
 2. Run `npm link @dcl/asset-packs` to symlink to your local repository
 3. Run `npm start` to start a local dev server. It should start by default on port `8000` but since we are already using it for the SDK7 scene, it will start on port `8001`.
 
 Go to the `builder` repo in your machine and do this:
+
 1. Set the `REACT_APP_INSPECTOR_PORT` env var in `.env` to be `8001` (this is the `@dcl/inspector` dev server we started in the previous section).
-1. Set the `REACT_APP_BIN_INDEX_JS_DEV_JS_PATH` env var in `.env` to the path to the `bin/index.js` that you copied in the first section.
-2. Set the `REACT_APP_BIN_INDEX_JS_DEV_JS_PORT` to the port where the SDK7 started running (by defualt `8000`).
-3. Run `npm start` to start the builder local server which should start on port `3000`
+2. Set the `REACT_APP_BIN_INDEX_JS_DEV_PORT` to the port where the SDK7 started running (by defualt `8000`).
+3. Set the `REACT_APP_BIN_INDEX_JS_DEV_PATH` env var in `.env` to the path to the `bin/index.js` that you copied in the first section or if you're using docker, set the path to be `/app/bin/index.js`.
+4. Run `npm start` to start the builder local server which should start on port `3000`
 
 Now you are all set, you can start developing the SDK7 scene in this repo, use it from the local Builder and test it by previewing the scene, which should use your local Builder Server serving the development javascript files.

package/docker-compose.yml

@@ -0,0 +1,56 @@
+# Utilitarian compose file to locally run required external services
+# required by the asset-packs. Just by running `docker-compose up`
+# you will have a http-server and an s3 compatible local object storage
+# ready to be used.
+
+version: '3.8'
+
+services:
+  # HTTP server that serves the SDK7 scene locally via http://localhost:8000.
+  # HTTP server that serves the catalog and asset-packs via http://localhost:8002.
+  asset-packs:
+    build: .
+    env_file:
+      - .env
+    ports:
+      - 8000:8000
+      - 8002:8002
+    volumes:
+      - ./packs:/app/packs
+      - ./scripts:/app/scripts
+      - ./src:/app/src
+      - ./server.ts:/app/server.ts
+      - ./entrypoint.sh:/app/entrypoint.sh
+    links:
+      - minio
+
+  # Object storage compatible with aws-sdk.
+  # Comes with a UI that can be accessed via http://localhost:9001.
+  # https://min.io/
+  minio:
+    image: minio/minio
+    environment:
+      - MINIO_ROOT_USER=admin
+      - MINIO_ROOT_PASSWORD=password
+    ports:
+      - 9000:9000
+      - 9001:9001
+    volumes:
+      - minio_data:/data
+    command: server /data --console-address ":9001"
+
+  # Companion for the minio service in charge of initialization and
+  # provides an mc client for operating directly with the storage
+  # https://docs.min.io/minio/baremetal/reference/minio-cli/minio-mc.html
+  minio-mc:
+    image: minio/mc
+    depends_on:
+      - minio
+    env_file:
+      - .env
+    volumes:
+      - ./minio-mc-entrypoint.sh:/scripts/entrypoint.sh
+    entrypoint: /scripts/entrypoint.sh
+
+volumes:
+  minio_data:

package/entrypoint.sh

@@ -0,0 +1,3 @@
+#!/bin/sh
+npm run build
+npx concurrently "npm run start:catalog" "npm run start"

package/minio-mc-entrypoint.sh

@@ -0,0 +1,21 @@
+#!/bin/bash
+
+# Required as the minio service on the docker-compose file might
+# not be completely up on the execution of this file.
+sleep 5
+
+# Create an alias to the minio service so it can be accessed easily
+mc alias set minio http://minio:9000 admin password
+
+# Check if the bucket already exists
+if mc find minio/$S3_BUCKET_NAME ; then
+  echo "Bucket \"$S3_BUCKET_NAME\" already exists, no need to create it again"
+else
+  # Create the bucket and set the policy to public so anything can 
+  # be downloaded or uploaded
+  mc mb minio/$S3_BUCKET_NAME
+  mc anonymous set public minio/$S3_BUCKET_NAME
+fi
+
+# Keep the service running so it can be accessed later with docker-compose exec
+tail -f /dev/null

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dcl/asset-packs",
-  "version": "0.0.0-20230908135400.commit-e2c5b3c",
+  "version": "0.0.0-20230911215327.commit-4ff713d",
   "description": "",
   "main": "dist/definitions.js",
   "typings": "dist/definitions.d.ts",
@@ -12,6 +12,7 @@
     "start": "npm run start:js & npm run start:lib",
     "start:js": "sdk-commands start",
     "start:lib": "npm run build:lib -- --watch",
+    "start:catalog": "npm run catalog && npm run upload && ts-node --project tsconfig.scripts.json server.ts",
     "build:js": "sdk-commands build",
     "build:lib": "tsc --project tsconfig.lib.json",
     "build": "npm run build:js && npm run build:lib"
@@ -41,6 +42,8 @@
     "p-queue": "^7.4.1",
     "prettier": "^3.0.2",
     "rimraf": "^5.0.1",
+    "serve": "^14.2.1",
+    "serve-handler": "^6.1.5",
     "ts-node": "^10.9.1",
     "typescript": "^5.1.6"
   },
@@ -52,5 +55,5 @@
     "semi": false,
     "printWidth": 80
   },
-  "commit": "e2c5b3c1d39b8ebbb6cc92ec958bc13e55322586"
+  "commit": "4ff713d51c298c8147cf59aa173b713355de3443"
 }

package/server.ts

@@ -0,0 +1,31 @@
+const handler = require('serve-handler')
+const http = require('http')
+const dotenv = require('dotenv')
+
+dotenv.config()
+
+const serverHost = process.env.SERVER_HOST || '0.0.0.0'
+const serverPort = process.env.CATALOG_SERVER_PORT || 8002
+const awsStorageUrl = process.env.AWS_STORAGE_URL || ''
+const s3BucketName = process.env.S3_BUCKET_NAME || 'asset-packs'
+
+const server = http.createServer((request: any, response: any) => {
+  response.setHeader('Access-Control-Allow-Origin', '*')
+  response.setHeader('Access-Control-Allow-Methods', '*')
+
+  return handler(request, response, {
+    redirects: [
+      {
+        source: '/contents/:hash',
+        destination: `${awsStorageUrl.replace(
+          /:(?=\d)/,
+          '\\:', // Parse the port dots
+        )}/${s3BucketName}/contents/:hash`,
+      },
+    ],
+  })
+})
+
+server.listen(serverPort, serverHost, () => {
+  console.log(`Catalog server running at http://${serverHost}:${serverPort}`)
+})