Add flags to run project in command line

.envrc

@@ -1,7 +1,7 @@
 strict_env
 
-if ! has nix_direnv_version || ! nix_direnv_version 3.0.4; then
-  source_url "https://raw.githubusercontent.com/nix-community/nix-direnv/3.0.4/direnvrc" "sha256-DzlYZ33mWF/Gs8DDeyjr8mnVmQGx7ASYqA5WlxwvBG4="
+if ! has nix_direnv_version || ! nix_direnv_version 3.1.0; then
+  source_url "https://raw.githubusercontent.com/nix-community/nix-direnv/3.1.0/direnvrc" "sha256-yMJ2OVMzrFaDPn7q8nCBZFRYpL/f0RcHzhmw/i6btJM="
 fi
 
 use flake

.github/workflows/bazel-build.yml

@@ -22,7 +22,7 @@ jobs:
         run: bazel run //:lint_bazel_files
       - name: Expose env variables
         run: |
-          cat << END > app/gui/.env.production
+          cat << END > app/common/.env.production
           ENSO_IDE_ENVIRONMENT="${{ vars.ENSO_CLOUD_ENVIRONMENT }}"
           ENSO_IDE_API_URL="${{ vars.ENSO_CLOUD_API_URL }}"
           ENSO_IDE_CHAT_URL="${{ vars.ENSO_CLOUD_CHAT_URL }}"

.github/workflows/ide-packaging.yml

@@ -329,6 +329,7 @@ jobs:
           rm dist/backend/project-manager.tar
       - run: ./run ide build --backend-source local --gui-upload-artifact false
         env:
+          ENSO_IDE_HOST: ${{ vars.ENSO_HOST }}
           ENSO_IDE_AG_GRID_LICENSE_KEY: ${{ vars.ENSO_AG_GRID_LICENSE_KEY }}
           ENSO_IDE_API_URL: ${{ vars.ENSO_CLOUD_API_URL }}
           ENSO_IDE_AUTH_ENDPOINT: ${{ vars.ENSO_CLOUD_AUTH_ENDPOINT }}

.github/workflows/release.yml

@@ -442,6 +442,7 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       - run: ./run ide upload --backend-source release --backend-release ${{env.ENSO_RELEASE_ID}} --sign-artifacts
         env:
+          ENSO_IDE_HOST: ${{ vars.ENSO_HOST }}
           ENSO_IDE_AG_GRID_LICENSE_KEY: ${{ vars.ENSO_AG_GRID_LICENSE_KEY }}
           ENSO_IDE_API_URL: ${{ vars.ENSO_CLOUD_API_URL }}
           ENSO_IDE_AUTH_ENDPOINT: ${{ vars.ENSO_CLOUD_AUTH_ENDPOINT }}

.gitmodules

@@ -1,3 +1,3 @@
-[submodule "app/gui/.dev-env"]
-	path = app/gui/.dev-env
+[submodule "app/common/.dev-env"]
+	path = app/common/.dev-env
 	url = ../dev-env.git

BUILD.bazel

@@ -42,7 +42,7 @@ write_source_files(
 buildifier(
     name = "lint_bazel_files",
     exclude_patterns = [
-        "./app/gui/.env.bazel",
+        "./app/common/.env.bazel",
     ],
     lint_mode = "warn",
     mode = "diff",
@@ -51,7 +51,7 @@ buildifier(
 buildifier(
     name = "format_bazel_files",
     exclude_patterns = [
-        "./app/gui/.env.bazel",
+        "./app/common/.env.bazel",
     ],
     lint_mode = "fix",
     mode = "fix",

CHANGELOG.md

@@ -38,6 +38,9 @@
   top.
 - [Context menu for connections][14325].
 - [Warnings and Errors no longer become transparent][14388]
+- [`--headless` flag to run a project without the User Interface][14310]
+- [Preview for assets (text, main files of Projects, audio, video, images) in
+  Right Sidebar][14310]
 - ["Delete and Connect Around" option in node's menu][14403]
 - [GeoMap visualization is now working without need of Mapbox Token in
   environment][14429]
@@ -63,6 +66,7 @@
 [14209]: https://github.com/enso-org/enso/pull/14209
 [14215]: https://github.com/enso-org/enso/pull/14215
 [14270]: https://github.com/enso-org/enso/pull/14270
+[14310]: https://github.com/enso-org/enso/pull/14310
 [14311]: https://github.com/enso-org/enso/pull/14311
 [14267]: https://github.com/enso-org/enso/pull/14267
 [14325]: https://github.com/enso-org/enso/pull/14325

app/gui/.env.bazel → app/common/.env.bazel

@@ -1,4 +1,4 @@
-# Bazel build step defaults to having all envs left as placeholders, so that they can be replaced later after the vite build step.
+# Bazel build step defaults to having all envs left as placeholders, so that they can be replaced late after the vite build step.
 ENSO_IDE_AG_GRID_LICENSE_KEY = "((%__ENSO_IDE_AG_GRID_LICENSE_KEY__%))"
 ENSO_IDE_API_URL = "((%__ENSO_IDE_API_URL__%))"
 ENSO_IDE_CLOUD_BUILD = "((%__ENSO_IDE_CLOUD_BUILD__%))"

app/common/.env.testing

@@ -0,0 +1,7 @@
+ENSO_IDE_API_URL=https://mock
+ENSO_IDE_HOST=https://ensoanalytics.com
+ENSO_IDE_COGNITO_USER_POOL_ID=mars_AAAAAAAAA
+ENSO_IDE_COGNITO_USER_POOL_WEB_CLIENT_ID=zzzzzzzzzzzzzzzzzzzzzzzzzz
+ENSO_IDE_COMMIT_HASH=abcdef0
+ENSO_IDE_CLOUD_BUILD=false
+ENSO_IDE_VERSION=0.0.1-testing

app/common/BUILD.bazel

@@ -1,3 +1,4 @@
+load("@aspect_bazel_lib//lib:copy_to_bin.bzl", "copy_to_bin")
 load("@aspect_rules_js//npm:defs.bzl", "npm_package")
 load("@aspect_rules_ts//ts:defs.bzl", "ts_config", "ts_project")
 load("@npm//:defs.bzl", "npm_link_all_packages", "npm_link_targets")
@@ -36,3 +37,9 @@ npm_package(
     ],
     visibility = ["//visibility:public"],
 )
+
+copy_to_bin(
+    name = "env_files",
+    srcs = glob([".env*"]),
+    visibility = ["//visibility:public"],
+)

app/common/package.json

@@ -18,18 +18,21 @@
   "main": "src/index.ts",
   "scripts": {
     "test:unit": "vitest run",
-    "compile": "tsc",
+    "typecheck": "tsc --noEmit",
+    "compile": "vite build",
     "lint": "eslint ./src --cache --max-warnings=0"
   },
   "dependencies": {
     "@internationalized/date": "3.7.0",
     "@types/node": "catalog:",
     "is-network-error": "^1.1.0",
+    "vite": "catalog:",
     "vue": "catalog:",
     "zod": "catalog:"
   },
   "devDependencies": {
     "@fast-check/vitest": "catalog:",
+    "vite-plugin-dts": "^4.5.4",
     "vitest": "catalog:"
   }
 }

app/common/src/accessToken.ts

@@ -16,3 +16,11 @@ export interface AccessToken {
    */
   readonly expireAt: string
 }
+
+export interface RawAccessToken {
+  readonly access_token: string
+  readonly client_id: string
+  readonly refresh_token: string
+  readonly refresh_url: string
+  readonly expire_at: string
+}

app/common/src/config.ts

@@ -0,0 +1,97 @@
+/**
+ * @file This file defines a global environment config that can be used throughout the app.
+ * It is included directly into index.html and kept as a separate built artifact, so that
+ * we can easily replace its contents in a separate build postprocessing step in `BUILD.bazel`.
+ */
+
+import { unsafeKeys } from './utilities/data/object.js'
+
+declare global {
+  interface ViteTypeOptions {
+    // strictImportMetaEnv: unknown
+  }
+
+  // This needs to be ts-ignore, because not all packages have this key defined.
+  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+  // @ts-ignore This key is also defined in Vite.
+  type ImportMetaEnvFallbackKey =
+    'strictImportMetaEnv' extends keyof ViteTypeOptions ? never : string
+
+  interface ImportMetaEnv {
+    [key: ImportMetaEnvFallbackKey]: any
+    BASE_URL: string
+    MODE: string
+    DEV: boolean
+    PROD: boolean
+    SSR: boolean
+  }
+
+  interface ImportMeta {
+    url: string
+    readonly env: ImportMetaEnv
+  }
+}
+
+const processEnv = typeof process !== 'undefined' ? process.env : {}
+
+/** When running dev server, the config variables are grabbed from appropriate .env file. */
+export const $config = {
+  ENVIRONMENT: processEnv.ENSO_IDE_ENVIRONMENT ?? import.meta.env?.ENSO_IDE_ENVIRONMENT,
+  ENSO_HOST:
+    processEnv.ENSO_IDE_HOST ?? (import.meta.env?.ENSO_IDE_HOST || 'https://ensoanalytics.com'),
+  API_URL: processEnv.ENSO_IDE_API_URL ?? import.meta.env?.ENSO_IDE_API_URL,
+  SENTRY_DSN: processEnv.ENSO_IDE_SENTRY_DSN ?? import.meta.env?.ENSO_IDE_SENTRY_DSN,
+  STRIPE_KEY: processEnv.ENSO_IDE_STRIPE_KEY ?? import.meta.env?.ENSO_IDE_STRIPE_KEY,
+  AUTH_ENDPOINT: processEnv.ENSO_IDE_AUTH_ENDPOINT ?? import.meta.env?.ENSO_IDE_AUTH_ENDPOINT,
+  COGNITO_USER_POOL_ID:
+    processEnv.ENSO_IDE_COGNITO_USER_POOL_ID ?? import.meta.env?.ENSO_IDE_COGNITO_USER_POOL_ID,
+  COGNITO_USER_POOL_WEB_CLIENT_ID:
+    processEnv.ENSO_IDE_COGNITO_USER_POOL_WEB_CLIENT_ID ??
+    import.meta.env?.ENSO_IDE_COGNITO_USER_POOL_WEB_CLIENT_ID,
+  GOOGLE_ANALYTICS_TAG:
+    processEnv.ENSO_IDE_GOOGLE_ANALYTICS_TAG ?? import.meta.env?.ENSO_IDE_GOOGLE_ANALYTICS_TAG,
+  COGNITO_DOMAIN: processEnv.ENSO_IDE_COGNITO_DOMAIN ?? import.meta.env?.ENSO_IDE_COGNITO_DOMAIN,
+  COGNITO_REGION: processEnv.ENSO_IDE_COGNITO_REGION ?? import.meta.env?.ENSO_IDE_COGNITO_REGION,
+  VERSION: processEnv.ENSO_IDE_VERSION ?? import.meta.env?.ENSO_IDE_VERSION,
+  COMMIT_HASH: processEnv.ENSO_IDE_COMMIT_HASH ?? import.meta.env?.ENSO_IDE_COMMIT_HASH,
+  YDOC_SERVER_URL: processEnv.ENSO_IDE_YDOC_SERVER_URL ?? import.meta.env?.ENSO_IDE_YDOC_SERVER_URL,
+  CLOUD_BUILD: processEnv.ENSO_IDE_CLOUD_BUILD ?? import.meta.env?.ENSO_IDE_CLOUD_BUILD,
+  AG_GRID_LICENSE_KEY:
+    processEnv.ENSO_IDE_AG_GRID_LICENSE_KEY ?? import.meta.env?.ENSO_IDE_AG_GRID_LICENSE_KEY,
+  GOOGLE_OAUTH_CLIENT_ID:
+    processEnv.ENSO_IDE_GOOGLE_OAUTH_CLIENT_ID ?? import.meta.env?.ENSO_IDE_GOOGLE_OAUTH_CLIENT_ID,
+  STRAVA_OAUTH_CLIENT_ID:
+    processEnv.ENSO_IDE_STRAVA_OAUTH_CLIENT_ID ?? import.meta.env?.ENSO_IDE_STRAVA_OAUTH_CLIENT_ID,
+  MS365_OAUTH_CLIENT_ID:
+    processEnv.ENSO_IDE_MS365_OAUTH_CLIENT_ID ?? import.meta.env?.ENSO_IDE_MS365_OAUTH_CLIENT_ID,
+  MAPBOX_API_TOKEN:
+    (typeof window === 'object' &&
+      window &&
+      'api' in window &&
+      typeof window.api === 'object' &&
+      window.api &&
+      'mapBoxApiToken' in window.api &&
+      typeof window.api.mapBoxApiToken === 'function' &&
+      window.api?.mapBoxApiToken()) ||
+    (processEnv.ENSO_IDE_MAPBOX_API_TOKEN ?? import.meta.env?.ENSO_IDE_MAPBOX_API_TOKEN),
+}
+
+/** Sets the global configuration. */
+export function setConfig(config: typeof $config) {
+  for (const k of unsafeKeys(config)) {
+    if (config[k] === undefined) {
+      continue
+    }
+    // Special-case as ENSO_HOST may currently be an empty string when it is unset in CI.
+    if (k === 'ENSO_HOST' && config[k] === '') {
+      continue
+    }
+    $config[k] = config[k]
+  }
+}
+
+// Undefined env variables are typed as `any`, but we want them to be `string | undefined`.
+export type $Config = {
+  [K in keyof typeof $config]: unknown extends (typeof $config)[K] ? string | undefined
+  : (typeof $config)[K]
+}

app/common/src/options.ts

@@ -7,6 +7,7 @@ const DEFAULT_PORT = 8080
 /** Schema for app-wide configuration options. */
 export const OptionsSchema = z.object({
   version: z.boolean().default(false),
+  headless: z.boolean().default(false),
   displayWindow: z.boolean().default(true),
   useServer: z.boolean().default(true),
   engineEnabled: z.boolean().default(true),

app/common/src/services/Backend.ts

@@ -1,7 +1,13 @@
 /** @file Type definitions common between all backends. */
 import { z } from 'zod'
 import type { DownloadOptions } from '../download.js'
-import { getText, resolveDictionary, type Replacements, type TextId } from '../text.js'
+import {
+  getText,
+  resolveDictionary,
+  type DefaultGetText,
+  type Replacements,
+  type TextId,
+} from '../text.js'
 import * as dateTime from '../utilities/data/dateTime.js'
 import * as newtype from '../utilities/data/newtype.js'
 import * as permissions from '../utilities/permissions.js'
@@ -97,8 +103,6 @@ export interface Logger {
   readonly error: (message: unknown, ...optionalParams: unknown[]) => void
 }
 
-export type GetText = <K extends TextId>(key: K, ...replacements: Replacements[K]) => string
-
 /** The {@link Backend} variant. If a new variant is created, it should be added to this enum. */
 export enum BackendType {
   local = 'local',
@@ -632,9 +636,6 @@ export interface CreateCustomerPortalSessionResponse {
   readonly url: string | null
 }
 
-/** Response from the "path/resolve" endpoint. */
-export interface PathResolveResponse extends Omit<AnyRealAsset, 'type' | 'ensoPath'> {}
-
 /** Whether a type is `any`. */
 type IsAny<T> = 0 extends 1 & T ? true : false
 
@@ -1686,13 +1687,13 @@ export class NotAuthorizedError extends NetworkError {}
 export abstract class Backend {
   abstract readonly type: BackendType
   abstract readonly baseUrl: URL
-  protected getText: GetText
+  protected getText: DefaultGetText
   private readonly client: HttpClient
   protected readonly downloader: (options: DownloadOptions) => void | Promise<void>
 
   /** Create a {@link Backend}. */
   constructor(
-    getText: GetText,
+    getText: DefaultGetText,
     client: HttpClient,
     downloader: (options: DownloadOptions) => void | Promise<void>,
   ) {
@@ -1705,7 +1706,7 @@ export abstract class Backend {
    * Set `this.getText`. This function is exposed rather than the property itself to make it clear
    * that it is intended to be mutable.
    */
-  setGetText(getText: GetText) {
+  setGetText(getText: DefaultGetText) {
     this.getText = getText
   }
 
@@ -1897,7 +1898,7 @@ export abstract class Backend {
     return (await this.resolveProjectAssetData(projectId, 'src/Main.enso', versionId)).text()
   }
   /** Resolve enso path to an asset */
-  abstract resolveEnsoPath(path: EnsoPath): Promise<PathResolveResponse>
+  abstract resolveEnsoPath(path: EnsoPath): Promise<AnyAsset>
   /** Resolve the data of a project asset relative to the project root directory. */
   abstract resolveProjectAssetData(
     projectId: ProjectId,

app/common/src/services/HttpClient.ts

@@ -148,6 +148,7 @@ export class HttpClient {
       }
     }
 
+    // On node.js, `navigator` seems to be defined, but `navigator.onLine` is always `undefined`.
     if (navigator.onLine !== undefined && !navigator.onLine) {
       return Promise.reject(new OfflineError('User is offline'))
     }
@@ -164,21 +165,25 @@ export class HttpClient {
       })) as ResponseWithTypedJson<T> & {
         readonly body: Method extends 'GET' | 'HEAD' ? null : NonNullable<Response['body']>
       }
-      if (typeof document !== 'undefined')
+      if (typeof document !== 'undefined') {
         document.dispatchEvent(new Event(FETCH_SUCCESS_EVENT_NAME))
+      }
       return response
     } catch (error) {
       // Even though the condition might seem always falsy,
       // offline mode might happen during the request
       // and this case need to be handled
       if (navigator.onLine !== undefined && !navigator.onLine) {
-        if (typeof document !== 'undefined') document.dispatchEvent(new Event(OFFLINE_EVENT_NAME))
+        if (typeof document !== 'undefined') {
+          document.dispatchEvent(new Event(OFFLINE_EVENT_NAME))
+        }
         throw new OfflineError('User is offline', { cause: error })
       }
 
       if (isNetworkError(error)) {
-        if (typeof document !== 'undefined')
+        if (typeof document !== 'undefined') {
           document.dispatchEvent(new Event(FETCH_ERROR_EVENT_NAME))
+        }
         throw new NetworkError(error.message, { cause: error })
       }
       throw error

app/common/src/services/LocalBackend.ts

@@ -6,8 +6,9 @@
  * the API.
  */
 import { markRaw } from 'vue'
+import { PRODUCT_NAME } from '../constants.js'
 import type { DownloadOptions } from '../download.js'
-import { PRODUCT_NAME } from '../index.js'
+import type { DefaultGetText } from '../text.js'
 import { toReadableIsoString } from '../utilities/data/dateTime.js'
 import { tryGetMessage } from '../utilities/errors.js'
 import {
@@ -87,7 +88,7 @@ export class LocalBackend extends backend.Backend {
 
   /** Create a {@link LocalBackend}. */
   constructor(
-    getText: backend.GetText,
+    getText: DefaultGetText,
     projectManagerInstance: ProjectManager,
     client = new HttpClient(),
     downloader: (options: DownloadOptions) => void | Promise<void>,
@@ -777,8 +778,8 @@ export class LocalBackend extends backend.Backend {
   }
 
   /** Resolve path to asset. In case of LocalBackend, this is just the filesystem path. */
-  override resolveEnsoPath(path: backend.EnsoPath): Promise<backend.PathResolveResponse> {
-    const { directoryPath } = getDirectoryAndName(Path(String(path)))
+  override resolveEnsoPath(path: backend.EnsoPath): Promise<backend.AnyAsset> {
+    const { directoryPath } = getDirectoryAndName(Path(path as string))
     return this.findAsset(directoryPath, 'ensoPath', path)
   }
 
@@ -874,15 +875,13 @@ export class LocalBackend extends backend.Backend {
     assetId: backend.AssetId,
     localProjectId: backend.ProjectId,
     parentDirectoryId: backend.DirectoryId,
-    baseUrl: URL,
     defaultHeaders: Record<string, string>,
   ): Promise<void> {
     const localProjectDirectory = backend.extractTypeAndPath(localProjectId).path
     const queryString = new URLSearchParams({
       assetId,
       parentDirectoryId,
       directory: localProjectDirectory,
-      baseUrl: baseUrl.toString(),
     }).toString()
     const response = await this.post(
       new URL(`/api/watcher/start?${queryString}`, location.href).toString(),