@quatronic/qore 0.1.4 → 0.1.6

package/README.md

@@ -46,7 +46,26 @@ the portal. Working from a personal fork whose `origin` the portal doesn't
 know? As long as an `upstream` remote points at the real repository, that one
 resolves — the context line then says `(upstream)`.
 
-Pass `--module <slug|id>` to pick a module explicitly; the flag always wins
+Outside a repository, with a projects folder set (see `qore init`), the
+order is: the project you are standing in; else `[project]` /
+`--project <ref>` (`app`, `app/module`, `tenant/app` or `tenant/app/module`,
+matched against your local checkouts); else an interactive pick. `qore dev`
+takes the reference as an argument (`qore dev <app>`); `qore dev`, `qore env
+pull`, `qore run` and `qore status` take `--project`. `qore run --project`
+only chooses which module's secrets are used; the command still runs in the
+current directory. `qore env pull --project` writes into the located module,
+and a relative `--target` then resolves against that project directory, not
+the directory you ran it from.
+
+Logged out with a projects folder set, the local lookup still runs first: a
+folder that holds no projects gives `QORE_PROJECT_NOT_FOUND`; otherwise the
+project is located exactly as when logged in (a match, a picker, or
+`QORE_CONTEXT_REQUIRED` without a terminal), and the login error comes from
+the portal lookup that follows. Only without a projects folder does a logged-out
+command outside a project go straight to the login error.
+
+Pass `--module <slug|id>` to pick a module explicitly (it keeps its meaning and,
+like `--app`, still uses the portal lookup when you are not in a project); the flag always wins
 over the git remote. Inside a repository, `qore` still looks up the remote's
 own module (from the cache, or with one extra request) only so the context
 line can tell you when the flag overrides it. If a module is linked to more
@@ -92,7 +111,9 @@ qore env pull
 
 - The target file defaults to the module type's own convention (e.g.
   `.env.local`), or `.qore.json`'s `envFile`, or `--target <path>` — always
-  resolved against, and required to stay inside, the repository.
+  required to stay inside the repository. `envFile` resolves against the
+  repository root; `--target` against the current directory, or with
+  `--project` against the located project directory.
 - If the file doesn't exist yet, it's seeded from `.env.example` when one is
   present.
 - Existing values you've hand-edited are kept by default. A key the portal
@@ -301,6 +322,39 @@ If a repository resolves to no module on any portal you're logged in to,
 the error lists the portals it tried and, when a staging repository looks
 likely, suggests `qore login --portal staging`.
 
+### Projects folder & `qore init`
+
+`qore init` is the guided setup. It runs four steps and reports each as
+`done`, `already` or `skipped`, so running it again is safe:
+
+1. **Projects folder**: where your apps live (default `~/qore`; `--root <path>`
+   sets it without asking). Nothing existing is moved.
+2. **Login**: skipped when you are already logged in, and with `--no-input`.
+3. **Tenant**: `already` when a tenant is active (`done` right after the login
+   step logged you in). Otherwise skipped with
+   `--no-input` or when you are not logged in (run `qore tenant use <slug>`
+   later), skipped with no tenants, selected without a prompt when you have
+   one, a picker when you have several.
+4. **First app**: `--clone <app>` (with `--tenant <slug>` to disambiguate)
+   clones it; interactively it asks.
+
+With `--json`, stdout is one document: `{"projectsRoot": "<path>|null",
+"steps": {"root"|"login"|"tenant"|"clone": {"status", "detail?"}}}`.
+
+Apps clone into `<root>/<tenant>/<app>/<module>`. A checkout outside the
+folder registers itself the first time you use it (`qore clone <app> <dir>`,
+`qore dev`, ...); a registered checkout that was deleted is dropped. With a
+projects folder set, `qore dev`, `qore env pull`, `qore run` and `qore status`
+work from any directory (see Repository context).
+
+```sh
+qore config root              # show the folder and how many projects it holds
+qore config root <path>       # set it
+qore config root --unset      # clear it; known projects stay findable
+```
+
+`qore doctor` checks that the folder exists and is writable.
+
 ### Workspaces
 
 `qore clone` sets up a local directory holding one or more of an app's
@@ -319,6 +373,9 @@ qore sync                     # clone any module that's new, fetch the rest
 qore sync --pull              # ...and fast-forward every clean repository with an upstream
 ```
 
+- **Where it clones.** Without `[dir]` and with a projects folder set, `qore
+  clone` uses `<root>/<tenant>/<app>`. Without a projects folder it behaves as
+  described above and prints a tip to run `qore init`.
 - **`--protocol https|ssh`** picks the clone URL (default `https`). `ssh`
   rewrites `https://github.com/o/r` to `git@github.com:o/r.git`; your own
   git `insteadOf` config still applies on top of either.
@@ -485,8 +542,8 @@ qore whoami --json
 | Code | Meaning |
 |------|---------|
 | 0 | Success |
-| 1 | Internal error, `git` is not installed or not on `PATH`, the OS keychain is unavailable/access was denied, or qore itself needs a newer Node (`QORE_NODE_VERSION`, checked by `qore doctor`'s own `node` check against qore's own `process.version`); `qore dev`: its package manager isn't installed (`QORE_PACKAGE_MANAGER`), its install failed (`QORE_INSTALL_FAILED`), Docker is missing (`QORE_DOCKER_MISSING`), not running (`QORE_DOCKER_NOT_RUNNING`) or its compose v2 plugin is missing (`QORE_DOCKER_COMPOSE_MISSING`), a `db:up`/service failed, never became healthy (`QORE_SERVICE_UNHEALTHY`) or its data is incompatible (`QORE_SERVICE_DATA_INCOMPATIBLE`), or the repository's own `engines.node` doesn't match the `node` on `PATH` (`QORE_NODE_VERSION`, a different check from qore's own — `qore doctor`'s `node:<module>` check, run only in a trusted repository) |
-| 2 | Missing or invalid context (e.g. a bad `--portal` value, or no module selected), or the module is part of several apps and no `--app` was given; `qore dev`: a port is already in use (`QORE_PORT_IN_USE`) or the repository's dev setup isn't supported (`QORE_DEV_UNSUPPORTED`) |
+| 1 | Internal error, `git` is not installed or not on `PATH`, the OS keychain is unavailable/access was denied, or qore itself needs a newer Node (`QORE_NODE_VERSION`, checked by `qore doctor`'s own `node` check against qore's own `process.version`); `qore dev`: its package manager isn't installed (`QORE_PACKAGE_MANAGER`), its install failed (`QORE_INSTALL_FAILED`), Docker is missing (`QORE_DOCKER_MISSING`), not running (`QORE_DOCKER_NOT_RUNNING`) or its compose v2 plugin is missing (`QORE_DOCKER_COMPOSE_MISSING`), a `db:up`/service failed, never became healthy (`QORE_SERVICE_UNHEALTHY`) or its data is incompatible (`QORE_SERVICE_DATA_INCOMPATIBLE`), or the repository's own `engines.node` doesn't match the `node` on `PATH` (`QORE_NODE_VERSION`, a different check from qore's own — `qore doctor`'s `node:<module>` check, run only in a trusted repository); or the projects folder isn't writable (`QORE_ROOT_NOT_WRITABLE`, fix its permissions or choose another folder) |
+| 2 | Missing or invalid context (e.g. a bad `--portal` value, or no module selected), or the module is part of several apps and no `--app` was given; `qore dev`: a port is already in use (`QORE_PORT_IN_USE`) or the repository's dev setup isn't supported (`QORE_DEV_UNSUPPORTED`); projects folder: not set and not inside a project, for a logged-in user (`QORE_ROOT_NOT_SET`, run `qore init`; logged out with no folder you get the login error, exit 4, and logged out with a folder the local lookup runs first, so an empty folder still gives `QORE_PROJECT_NOT_FOUND`), not usable as a folder (`QORE_ROOT_INVALID`, pick another with `qore init --root <path>`), or no local project matches the reference or the folder holds none (`QORE_PROJECT_NOT_FOUND`, run `qore clone <app>`) |
 | 4 | Not logged in, session/login expired, login denied, or clock skew |
 | 5 | Access denied — lost tenant access, resource not found, no developer access |
 | 6 | Auth or API temporarily unreachable/unavailable |
@@ -511,6 +568,38 @@ and never in an environment variable.
 - `NODE_EXTRA_CA_CERTS` can point at an additional CA bundle, for portals or
   identity providers behind a corporate proxy with a private root CA.
 
+## Privacy
+
+`qore` sends crash reports to Quatronic so we can find and fix bugs. It is on by
+default; the first interactive run says so once, on stderr.
+
+**What is sent**, to Sentry (EU region, project `qore-cli`):
+
+- errors qore did not anticipate — a bug in qore, not an expected error such as
+  "not logged in" or "port in use";
+- one health record per run: whether it crashed or not;
+- with each: the qore version, the Node version, the OS, whether it ran in CI, the
+  command name (e.g. `env pull`), the stack trace, and the error message;
+- the method, host and status code of the HTTP requests qore made before a crash.
+
+**Removed before sending:** tokens, keys and other secrets, environment variable
+values (including the local env qore fetched), argument values, e-mail addresses,
+URL query strings, and your home directory (paths show as `~`). This is pattern-based:
+an error message about a file qore failed to parse can still quote a fragment of it.
+
+**Never attached:** your hostname, your user account, your tenant, or an IP address.
+qore sends no field that carries an IP; the address a report arrives from is dropped
+by the Sentry project's "Prevent Storing of IP Addresses" setting, part of its infra setup.
+
+**Turning it off** (the first match wins):
+
+1. `DO_NOT_TRACK=1`
+2. `QORE_TELEMETRY=0` (or `QORE_TELEMETRY=1` to turn it on)
+3. `qore config telemetry off` (or `on`)
+
+`qore config telemetry` and `qore doctor` show the current state and where it
+comes from. A build from source or a fork carries no DSN and sends nothing.
+
 ## Releasing
 
 See [RELEASING.md](./RELEASING.md).

package/dist/chunk-OAU6HJHZ.js

@@ -0,0 +1,140 @@
+#!/usr/bin/env node
+
+!function(){try{var e="undefined"!=typeof window?window:"undefined"!=typeof global?global:"undefined"!=typeof globalThis?globalThis:"undefined"!=typeof self?self:{},n=(new e.Error).stack;n&&(e._sentryDebugIds=e._sentryDebugIds||{},e._sentryDebugIds[n]="885f6de1-0da7-54a5-86df-beaf550bdd8a")}catch(e){}}();
+import { createRequire as __qoreCreateRequire } from "node:module"; const require = __qoreCreateRequire(import.meta.url);
+
+// src/core/telemetry/scrub.ts
+var SECRET_ENV_KEY = /TOKEN|SECRET|PASSWORD|PASSWD|PRIVATE|API_?KEY|ACCESS_?KEY|DSN|AUTH|CREDENTIAL|COOKIE|SESSION/i;
+var KEEP_CONTEXTS = /* @__PURE__ */ new Set(["runtime", "os"]);
+var PATTERNS = [
+  // an unterminated block runs to the end, so a truncated key is still dropped
+  [/-----BEGIN [A-Z0-9 ]{1,40}-----[\s\S]*?(?:-----END [A-Z0-9 ]{1,40}-----|$)/g, "[pem]"],
+  // query strings and fragments carry OAuth codes, states and signed-URL tokens
+  [/\b([a-z][a-z0-9+.-]{0,30}:\/\/[^\s?#"'<>]*)[?#][^\s"'<>]*/gi, "$1"],
+  [/\b(authorization["']?\s*[=:]\s*)(\[redacted\]|"[^"]*"|'[^']*'|[A-Za-z][A-Za-z0-9_-]{0,30}\s+[^\s,;&]+|[^\s,;&]+)/gi, "$1[redacted]"],
+  [/\bBearer\s+[A-Za-z0-9._~+/=-]+/gi, "Bearer [redacted]"],
+  [/\bBasic\s+[A-Za-z0-9+/=]{8,}/gi, "Basic [redacted]"],
+  [/\beyJ[A-Za-z0-9_-]{5,}\.[A-Za-z0-9_-]{5,}\.[A-Za-z0-9_-]*/g, "[jwt]"],
+  [/\b(?:gh[pousr]_[A-Za-z0-9]{20,}|github_pat_[A-Za-z0-9_]{20,}|sntr[ysu]_[A-Za-z0-9+/=_-]{20,}|npm_[A-Za-z0-9]{20,}|sk-[A-Za-z0-9_-]{20,}|xox[abpr]-[A-Za-z0-9-]{10,}|[sr]k_(?:live|test)_[A-Za-z0-9]{10,}|(?:AKIA|ASIA)[0-9A-Z]{16})/g, "[token]"],
+  // URL credentials, which is also what a DSN's public key looks like
+  [/\b([a-z][a-z0-9+.-]{0,30}:\/\/)[^\s/:@]+(?::[^\s/@]*)?@/gi, "$1[redacted]@"],
+  [/[A-Za-z0-9._%+-]{1,64}@[A-Za-z0-9-]{1,63}(?:\.[A-Za-z0-9-]{1,63}){0,8}\.[A-Za-z]{2,24}\b/g, "[email]"],
+  // affixes are bounded so a long run of key-like characters cannot backtrack quadratically
+  [/\b([A-Za-z0-9_.-]{0,40}(?:(?:token|secret|password|passwd|pwd|api[_-]?key|access[_-]?key|private[_-]?key|auth|credential|dsn|session|cookie)[A-Za-z0-9_.-]{0,40}|key))(["']?\s*[=:]\s*)(\[redacted\]|"[^"]*"|'[^']*'|[^\s&,;]+)/gi, "$1$2[redacted]"]
+];
+var escapeRe = (s) => s.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
+var longestFirst = (xs, min) => [...new Set(xs.filter((x) => x.length >= min))].sort((a, b) => b.length - a.length);
+function buildScrubContext(o) {
+  const words = new Set(o.commandWords);
+  const argvValues = o.argv.flatMap((a) => {
+    if (a.startsWith("-")) {
+      const i = a.indexOf("=");
+      return i > 0 ? [a.slice(i + 1)] : [];
+    }
+    return words.has(a) ? [] : [a];
+  });
+  const secretEnvValues = Object.entries(o.env).flatMap(([k, v]) => v && SECRET_ENV_KEY.test(k) ? [v] : []);
+  return { home: o.home, platform: o.platform, argvValues: longestFirst(argvValues, 3), secretEnvValues: longestFirst(secretEnvValues, 8) };
+}
+function addSecretValues(ctx, values) {
+  ctx.secretEnvValues = longestFirst([...ctx.secretEnvValues, ...values], 8);
+}
+function replaceLiteral(s, needle, repl, flags) {
+  return s.replace(new RegExp(escapeRe(needle), flags), () => repl);
+}
+function replaceHome(s, ctx) {
+  const win = ctx.platform === "win32";
+  const plain = [ctx.home, ...win ? [ctx.home.replace(/\\/g, "/")] : []];
+  const variants = /* @__PURE__ */ new Set([...plain, ...plain.map((h) => encodeURI(h).replace(/[?#]/g, encodeURIComponent))]);
+  let out = s;
+  for (const h of [...variants].filter((v) => v.length > 1).sort((a, b) => b.length - a.length)) {
+    out = out.replace(new RegExp(`${escapeRe(h)}(?![A-Za-z0-9._-])`, win ? "gi" : "g"), () => "~");
+  }
+  return out;
+}
+var PKG = "node_modules/@quatronic/qore/";
+var NM = "node_modules/";
+function rewritePath(p, ctx) {
+  if (p.startsWith("app://") || !/^(?:file:\/\/|\/|[A-Za-z]:[\\/])/.test(p)) return { path: p };
+  let s = p.replace(/^file:\/\//, "");
+  if (ctx.platform === "win32") s = s.replace(/\\/g, "/").replace(/^\/(?=[A-Za-z]:)/, "");
+  const pkg = s.lastIndexOf(PKG);
+  const nm = s.lastIndexOf(NM);
+  if (pkg >= 0 && pkg === nm) return { path: `app:///${s.slice(pkg + PKG.length)}`, inApp: true };
+  if (nm >= 0) return { path: `app:///${s.slice(nm)}`, inApp: false };
+  return { path: `app:///${replaceHome(s, ctx).replace(/^\/+/, "")}` };
+}
+function framePath(p, ctx) {
+  return rewritePath(p, ctx).path;
+}
+function scrubText(s, ctx) {
+  let out = s;
+  for (const v of ctx.secretEnvValues) out = replaceLiteral(out, v, "[env]", "g");
+  for (const v of ctx.argvValues) out = replaceLiteral(out, v, "[arg]", "g");
+  out = replaceHome(out, ctx);
+  for (const [re, repl] of PATTERNS) out = out.replace(re, repl);
+  return out;
+}
+function hostOf(url) {
+  if (typeof url !== "string") return void 0;
+  try {
+    return new URL(url).host;
+  } catch {
+    return void 0;
+  }
+}
+function scrubBreadcrumb(b, ctx) {
+  if (b.category === "console") return null;
+  if (b.type === "http" || b.category === "http" || b.category === "fetch") {
+    const d = b.data ?? {};
+    return {
+      type: b.type,
+      category: b.category,
+      level: b.level,
+      timestamp: b.timestamp,
+      data: { method: d.method ?? d["http.method"], host: hostOf(d.url) ?? d.host, status_code: d.status_code }
+    };
+  }
+  return { ...b, message: b.message === void 0 ? void 0 : scrubText(b.message, ctx), data: void 0 };
+}
+function scrubEvent(e, ctx) {
+  e.user = { ip_address: null };
+  delete e.server_name;
+  delete e.request;
+  delete e.extra;
+  delete e.modules;
+  for (const k of Object.keys(e.contexts ?? {})) if (!KEEP_CONTEXTS.has(k)) delete e.contexts[k];
+  if (e.message !== void 0) e.message = scrubText(e.message, ctx);
+  if (e.logentry?.message !== void 0) {
+    e.logentry.message = scrubText(e.logentry.message, ctx);
+    delete e.logentry.params;
+  }
+  for (const v of e.exception?.values ?? []) {
+    if (v.value !== void 0) v.value = scrubText(v.value, ctx);
+    for (const f of v.stacktrace?.frames ?? []) {
+      for (const k of ["filename", "abs_path"]) {
+        if (!f[k]) continue;
+        const r = rewritePath(f[k], ctx);
+        f[k] = r.path;
+        if (r.inApp !== void 0) f.in_app = r.inApp;
+      }
+      if (f.module) f.module = replaceHome(f.module, ctx);
+      delete f.vars;
+      delete f.pre_context;
+      delete f.context_line;
+      delete f.post_context;
+    }
+  }
+  for (const img of e.debug_meta?.images ?? []) if (img.code_file) img.code_file = framePath(img.code_file, ctx);
+  if (e.breadcrumbs) e.breadcrumbs = e.breadcrumbs.map((b) => scrubBreadcrumb(b, ctx)).filter((b) => b !== null);
+  return e;
+}
+
+export {
+  buildScrubContext,
+  addSecretValues,
+  scrubBreadcrumb,
+  scrubEvent
+};
+//# sourceMappingURL=chunk-OAU6HJHZ.js.map
+//# debugId=885f6de1-0da7-54a5-86df-beaf550bdd8a