sourcemaps.io - GitLite

KO | EN

gitlite — search

#python #react #typescript #llm #android #machine-learning #rust #deep-learning #linux #docker #nodejs #macos #awesome-list #openai

sourcemaps.io

(★ 63)

Web-based Source Map validator

File Explorer

Download Latest Version (.zip)

- - deploy.yml
- sentry-release.sh
- - check.ico
  - check_2048.png
  - manifest.json
- - App.css
  - App.tsx
  - index.css
  - main.tsx
  - registerServiceWorker.js
  - vite-env.d.ts
- .eslintrc.json
- .gitignore
- eslint.config.js
- index.html
- package-lock.json
- package.json
- README.md
- tsconfig.app.json
- tsconfig.app.tsbuildinfo
- tsconfig.json
- tsconfig.node.json
- tsconfig.node.tsbuildinfo
- vite.config.ts
- - dev.ts
  - index.ts
- .eslintrc.json
- .gcloudignore
- cors.json
- jest.config.js
- package-lock.json
- package.json
- tsconfig.json
.eslintignore
.gitignore
.nvmrc
LICENSE
Makefile
package-lock.json
package.json
README.md

# Installation Guide

1. Get the code

git clone https://github.com/getsentry/sourcemaps.io

Downloads the entire project code from GitHub to your computer.

cd sourcemaps.io

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

cd client

This project's files live in a subfolder, so move into it first.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

3. Make

Medium

Prerequisites

Git Needed to download the project code from GitHub.
Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).

make test

Compiles the code based on the generated build configuration to produce an executable.

make client-server

Compiles the code based on the generated build configuration to produce an executable.

make backend-server

Compiles the code based on the generated build configuration to produce an executable.

make deploy

Compiles the code based on the generated build configuration to produce an executable.

✅ If it finishes without errors, it worked. Try running the generated executable directly.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# sourcemaps.io [![deploy & test](https://github.com/getsentry/sourcemaps.io/actions/workflows/deploy.yml/badge.svg)](https://github.com/getsentry/sourcemaps.io/actions/workflows/deploy.yml)

_A re-write of [sourcemap-validator](https://github.com/mattrobenolt/sourcemap-validator) using React, Node, and Google Cloud Functions._

![image](https://user-images.githubusercontent.com/2153/28230025-2d1c756e-689a-11e7-8e57-e1078820103c.png)

[sourcemaps.io](http://v2.sourcemaps.io) is a web application that takes a URL for a target transpiled/minified JavaScript file (e.g. `https://example.com/js/app.min.js`), and verifies:

- `sourceMappingURL` or `[X-]SourceMap` header is present
- Both the transpiled/minified file and source map file are reachable via HTTP
- The resolved source map is valid JSON, and parses using Mozilla's [source-map](https://github.com/mozilla/source-map) library
- Lines and columns line up as expected
- ... and more, see [tests](/tests)

## Development

### Run tests

```bash
make test
```

### Run a local server for client (React) development

```bash
make client-server
```

### Run a local server for backend development

A local development server will serve the validation function for development.

```bash
make backend-server
```

**NOTE:** Right now the local server still writes JSON reports to a production Google Cloud Storage bucket. You must have the following shell variables exported (see _Deploy to Google Cloud Platform_ below).

```
export GCLOUD_PROJECT=myproject-server
export GCLOUD_DATA_BUCKET=myproject-reports
make backend-server
```

## Deploy to Google Cloud Platform

This repository is already configured to automatically deploy to https://sourcemaps.io. But for posterity, this documents how to configure your own Google Cloud deployment environment and how to use the deploy scripts.

### Configure your Project

1. Create a new project in [Google Cloud Platform](https://cloud.google.com/), e.g. `myproject`
2. Enable Cloud Functions
3. Create **3 buckets** in Cloud Storage, for:
   1. staging the **cloud function** (e.g. `myproject-server`)
   1. storing **report data** (e.g. `myproject-reports`)
   1. storing **static web content** (e.g. `myproject-web`)

NOTE: Your deployed cloud function must be configured to use [Cloud Functions Node 10 runtime](https://cloud.google.com/functions/docs/concepts/nodejs-10-runtime) (or newer).

### Install the gcloud CLI

Follow Google Cloud's instructions for [installing the gcloud CLI](https://cloud.google.com/sdk/docs/install).

### Deploying

First authenticate with Google Cloud Platform:

```bash
gcloud auth login
```

Then initiate the deploy:

```bash
# Used for deploy
export GCLOUD_PROJECT=myproject
export GCLOUD_APP_BUCKET=myproject-server
export GCLOUD_DATA_BUCKET=myproject-reports
export GCLOUD_WWW_BUCKET=myproject-web
export GCLOUD_SERVICE_KEY=<base64 encoded service-key json object>

# Used for creating a new release in your sentry instance:
export SENTRY_AUTH_TOKEN=sntrys_abcxyz
export SENTRY_CLIENT_PROJECT=MY-PROJECT
export SENTRY_ORG=MY-ORG

make deploy
```

NOTE: The deploy script will set READ permissions on `GCLOUD_DATA_BUCKET` and `GCLOUD_WWW_BUCKET`.

### Invoking the Serverless Function

The deployed serverless function is publicly accessible over HTTP. To trigger the function manually, do:

```bash
$ curl -X GET "https://${region}-${GCLOUD_PROJECT}.cloudfunctions.net/validateSourceFile?url=http://example.org/static/app.js"
```