@webbdays/tailcall 0.0.1-security → 0.0.30

package/README.md

@@ -1,5 +1,134 @@
-# Security holding package
+[![Tailcall Logo](https://raw.githubusercontent.com/tailcallhq/tailcall/main/assets/logo_main.svg)](https://tailcall.run)
 
-This package contained malicious code and was removed from the registry by the npm security team. A placeholder was published to ensure users are not affected in the future.
+Tailcall is an open-source solution for building [high-performance] GraphQL backends.
 
-Please refer to www.npmjs.com/advisories?search=%40webbdays%2Ftailcall for more information.
+Please support us by giving the repository a star
+![image](https://raw.githubusercontent.com/tailcallhq/tailcall/main/assets/star-our-repo.gif)
+
+[high-performance]: https://github.com/tailcallhq/graphql-benchmarks
+
+[![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=for-the-badge&logo=x&color=black&labelColor=black)](https://twitter.com/intent/tweet?text=%40tailcallhq%20is%20building%20a%20high-performance%20API%20Orchestration%20solution%20over%20%23GraphQL.%0A%0ACheck%20it%20out%20at%3A%0A%F0%9F%94%97%20https%3A%2F%2Ftailcall.run%20%0A%F0%9F%94%97%20https%3A%2F%2Fgithub.com%2Ftailcallhq%2Ftailcall%20%0A%0A&hashtags=api,http,rest,grpc,graphql,nocode,microservice,opensource)
+[![Discord](https://img.shields.io/discord/1044859667798568962?style=for-the-badge&cacheSeconds=120&logo=discord)](https://discord.gg/kRZBPpkgwq)
+
+[![Open Bounties](https://img.shields.io/endpoint?url=https%3A%2F%2Fconsole.algora.io%2Fapi%2Fshields%2Ftailcallhq%2Fbounties%3Fstatus%3Dopen&style=for-the-badge)](https://console.algora.io/org/tailcallhq/bounties?status=open)
+[![Rewarded Bounties](https://img.shields.io/endpoint?url=https%3A%2F%2Fconsole.algora.io%2Fapi%2Fshields%2Ftailcallhq%2Fbounties%3Fstatus%3Dcompleted&style=for-the-badge)](https://console.algora.io/org/tailcallhq/bounties?status=completed)
+[![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/tailcallhq/tailcall/ci.yml?style=for-the-badge)](https://github.com/tailcallhq/tailcall/actions)
+![GitHub release (by tag)](https://img.shields.io/github/downloads/tailcallhq/tailcall/total?style=for-the-badge)
+[![Discord](https://img.shields.io/discord/1044859667798568962?style=for-the-badge&cacheSeconds=60)](https://discord.gg/kRZBPpkgwq)
+[![Codecov](https://img.shields.io/codecov/c/github/tailcallhq/tailcall?style=for-the-badge)](https://app.codecov.io/gh/tailcallhq/tailcall)
+
+## Installation
+
+### NPM
+
+```bash
+npm i -g @tailcallhq/tailcall
+```
+
+### Yarn
+
+```bash
+yarn global add @tailcallhq/tailcall
+```
+
+### Home Brew
+
+```bash
+brew tap tailcallhq/tailcall
+brew install tailcall
+```
+
+### Curl
+
+```bash
+curl -sSL https://raw.githubusercontent.com/tailcallhq/tailcall/master/install.sh | bash
+```
+
+### Docker
+
+```bash
+docker pull ghcr.io/tailcallhq/tailcall/tc-server
+docker run -p 8080:8080 -p 8081:8081 ghcr.io/tailcallhq/tailcall/tc-server
+```
+
+## Get Started
+
+The below file is a standard `.graphQL` file, with a few additions such as `@server` and `@http` directives. So, basically, we specify the GraphQL schema and how to resolve that GraphQL schema in the same file, without having to write any code!
+
+```graphql
+schema
+  @server(port: 8000, hostname: "0.0.0.0")
+  @upstream(baseURL: "http://jsonplaceholder.typicode.com", httpCache: 42) {
+  query: Query
+}
+
+type Query {
+  posts: [Post] @http(path: "/posts")
+  user(id: Int!): User @http(path: "/users/{{.args.id}}")
+}
+
+type User {
+  id: Int!
+  name: String!
+  username: String!
+  email: String!
+  phone: String
+  website: String
+}
+
+type Post {
+  id: Int!
+  userId: Int!
+  title: String!
+  body: String!
+  user: User @http(path: "/users/{{.value.userId}}")
+}
+```
+
+Now, run the following command to start the server with the full path to the jsonplaceholder.graphql file that you created above.
+
+```bash
+tailcall start ./jsonplaceholder.graphql
+```
+
+Head out to [docs] to learn about other powerful tailcall features.
+
+[docs]: https://tailcall.run/docs
+
+### Benchmarks
+
+Throughput comparison of various GraphQL solutions for a N + 1 query:
+
+```graphql
+query {
+  posts {
+    title
+    body
+    user {
+      name
+    }
+  }
+}
+```
+
+![Throughput Histogram](https://raw.githubusercontent.com/tailcallhq/graphql-benchmarks/main/assets/req_sec_histogram1.png)
+
+Check out detailed benchmarks on our benchmarking [repository](https://github.com/tailcallhq/graphql-benchmarks).
+
+### Contributing
+
+Your contributions are invaluable! Kindly go through our [contribution guidelines] if you are a first time contributor.
+
+[contribution guidelines]: https://tailcall.run/docs/contribution-guidelines
+
+### Support Us
+
+⭐️ Give us a star.
+
+👀 Watch us for updates.
+
+### License
+
+This initiative is protected under the Apache 2.0 License.
+
+<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=82cc2ee2-ff41-4844-9ae6-c9face103e81" />

package/build-matrix.yaml

@@ -0,0 +1,80 @@
+build:
+  [
+    linux-x64-gnu,
+    linux-x64-musl,
+    linux-arm64-gnu,
+    linux-arm64-musl,
+    linux-ia32-gnu,
+    darwin-arm64,
+    darwin-x64,
+    win32-x64-msvc,
+    win32-arm64-msvc,
+    win32-ia32-msvc,
+  ]
+include:
+  - build: linux-x64-gnu
+    os: ubuntu-latest
+    rust: stable
+    target: x86_64-unknown-linux-gnu
+    libc: glibc
+
+  - build: linux-x64-musl
+    os: ubuntu-latest
+    rust: stable
+    target: x86_64-unknown-linux-musl
+    libc: musl
+    cross: true
+
+  - build: linux-arm64-gnu
+    os: ubuntu-latest
+    rust: stable
+    target: aarch64-unknown-linux-gnu
+    libc: glibc
+    cross: true
+
+  - build: linux-arm64-musl
+    os: ubuntu-latest
+    rust: stable
+    target: aarch64-unknown-linux-musl
+    libc: musl
+    cross: true
+
+  - build: linux-ia32-gnu
+    os: ubuntu-latest
+    rust: stable
+    target: i686-unknown-linux-gnu
+    libc: glibc
+    cross: true
+
+  - build: darwin-arm64
+    os: macos-latest
+    rust: stable
+    target: aarch64-apple-darwin
+
+  - build: darwin-x64
+    os: macos-latest
+    rust: stable
+    target: x86_64-apple-darwin
+
+  - build: win32-x64-msvc
+    os: windows-latest
+    rust: stable
+    target: x86_64-pc-windows-msvc
+    libc: msvc
+    ext: ".exe"
+
+  - build: win32-arm64-msvc
+    os: windows-latest
+    rust: stable
+    target: aarch64-pc-windows-msvc
+    features: --no-default-features --features cli
+    libc: msvc
+    ext: ".exe"
+    test: false # TODO: tests are broken without default features
+
+  - build: win32-ia32-msvc
+    os: windows-latest
+    rust: stable
+    target: i686-pc-windows-msvc
+    libc: msvc
+    ext: ".exe"

package/package.json

@@ -1,6 +1,42 @@
 {
+  "description": "A high-performance GraphQL proxy, optimized for cloud-native environments, covering edge, middle, and service layers.",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/tailcallhq/tailcall"
+  },
+  "homepage": "https://tailcall.run/",
+  "keywords": [
+    "graphql",
+    "proxy",
+    "api-gateway",
+    "rust",
+    "http",
+    "grpc",
+    "bff",
+    "backend-for-frontend",
+    "microservices",
+    "high-performance",
+    "edge"
+  ],
   "name": "@webbdays/tailcall",
-  "version": "0.0.1-security",
-  "description": "security holding package",
-  "repository": "npm/security-holder"
-}
+  "type": "module",
+  "version": "0.0.30",
+  "scarfSettings": {
+    "defaultOptIn": true,
+    "allowTopLevel": true
+  },
+  "dependencies": {
+    "detect-libc": "^2.0.2",
+    "@scarf/scarf": "^1.3.0",
+    "yaml": "^2.3.3",
+    "axios": "^1.7.4"
+  },
+  "scripts": {
+    "postinstall": "node ./scripts/post-install.js",
+    "preinstall": "node ./scripts/pre-install.js"
+  },
+  "bin": {
+    "tailcall": "bin/tailcall"
+  }
+}

package/scripts/post-install.js

@@ -0,0 +1,63 @@
+const version = "0.0.30";
+// @ts-check
+import {familySync, GLIBC, MUSL} from "detect-libc"
+import {exec} from "child_process"
+import util from "util"
+import get_matched_platform from "./utils.js"
+import fs from "fs"
+import axios from "axios"
+import {resolve, dirname} from "path"
+import {fileURLToPath} from "url"
+
+const execa = util.promisify(exec)
+const os = process.platform
+const arch = process.arch
+const libcFamily = familySync()
+
+let libc = ""
+if (os === "win32") {
+  libc = "msvc"
+} else {
+  libc = libcFamily === GLIBC ? "gnu" : libcFamily === MUSL ? "musl" : ""
+}
+
+const matched_platform = get_matched_platform(os, arch, libc)
+if (matched_platform != null) {
+  const targetPlatform = matched_platform
+
+  let targetPlatformExt = ""
+  if (Object.keys(targetPlatform).includes("ext")) {
+    targetPlatformExt = targetPlatform.get("ext")
+  }
+
+  const pkg_download_base_url = "https://github.com/tailcallhq/tailcall/releases/download/"
+  const specific_url = `v${version}/tailcall-${targetPlatform.get("target")}${targetPlatformExt}`
+  const full_url = pkg_download_base_url + specific_url
+
+  console.log(`Downloading Tailcall for ${targetPlatform.get("target")}${targetPlatformExt}  ...`)
+
+  const output_path = `bin/tailcall-${targetPlatform.get("target")}${targetPlatformExt}`
+  download_binary(full_url, output_path)
+}
+
+async function download_binary(full_url, output_path) {
+  const file = fs.createWriteStream(output_path)
+  axios({
+    url: full_url,
+    method: "GET",
+    responseType: "stream",
+  }).then((response) => {
+    response.data.pipe(file)
+    file.on("finish", async () => {
+      const __dirname = dirname(fileURLToPath(import.meta.url))
+
+      const directoryPath = resolve(__dirname, "../")
+      const packageJsonString = fs.readFileSync(resolve(directoryPath, "./package.json"), "utf8")
+      const packageJson = JSON.parse(packageJsonString)
+      packageJson.bin = {tailcall: output_path}
+      fs.writeFileSync(resolve(directoryPath, "./package.json"), JSON.stringify(packageJson, null, 2), "utf8")
+
+      console.log("Tailcall binary downloaded successfully")
+    })
+  })
+}

package/scripts/pre-install.js

@@ -0,0 +1,23 @@
+// @ts-check
+import {familySync, GLIBC, MUSL} from "detect-libc"
+import get_matched_platform from "./utils.js"
+
+const os = process.platform
+const arch = process.arch
+const libcFamily = familySync()
+
+let libc = ""
+if (os === "win32") {
+  libc = "msvc"
+} else {
+  libc = libcFamily === GLIBC ? "gnu" : libcFamily === MUSL ? "musl" : ""
+}
+
+const matched_platform = get_matched_platform(os, arch, libc)
+
+if (matched_platform == null) {
+  const redColor = "\x1b[31m"
+  const resetColor = "\x1b[0m"
+  console.error(`${redColor} Tailcall does not support platform - ${os}, arch - ${arch}, libc - ${libc} ${resetColor}`)
+  process.exit(1)
+}

package/scripts/utils.js

@@ -0,0 +1,24 @@
+import fs from "fs"
+import {dirname, resolve} from "path"
+import {fileURLToPath} from "url"
+import YML from "yaml"
+
+const __dirname = dirname(fileURLToPath(import.meta.url))
+
+export default function get_matched_platform(os, arch, libc) {
+  const directoryPath = resolve(__dirname, "../")
+  const file = fs.readFileSync(resolve(directoryPath, "./build-matrix.yaml"), "utf8")
+  const build_matrix = YML.parse(file, {mapAsMap: true})
+
+  let found = null
+  build_matrix.get("include").forEach((platform) => {
+    const split = platform.get("build").split("-")
+    const platform_arch = split.at(1)
+    const platform_os = split.at(0)
+    const platform_libc = split.at(-1)
+    if (platform_arch == arch && platform_os == os && platform_libc == libc) {
+      found = platform
+    }
+  })
+  return found
+}