@likec4/language-server 1.18.0 → 1.19.1

package/src/view-utils/manual-layout.ts

@@ -1,7 +1,13 @@
+import type * as c4 from '@likec4/core'
 import { isAutoLayoutDirection, type ViewManualLayout } from '@likec4/core'
 import { decode, encode } from '@msgpack/msgpack'
 import { fromBase64, toBase64 } from '@smithy/util-base64'
+import { AstUtils, CstUtils } from 'langium'
 import { mapValues } from 'remeda'
+import type { ast } from '../ast'
+import { logger } from '../logger'
+
+const { getDocument } = AstUtils
 
 function pack({
   nodes,
@@ -89,3 +95,22 @@ export function deserializeFromComment(comment: string): ViewManualLayout {
   const decodedb64 = fromBase64(b64)
   return unpack(decode(decodedb64) as any) as ViewManualLayout
 }
+
+export function parseViewManualLayout(node: ast.LikeC4View): c4.ViewManualLayout | undefined {
+  const commentNode = CstUtils.findCommentNode(node.$cstNode, ['BLOCK_COMMENT'])
+  if (!commentNode || !hasManualLayout(commentNode.text)) {
+    return undefined
+  }
+  try {
+    return deserializeFromComment(commentNode.text)
+  } catch (e) {
+    const doc = getDocument(node)
+    logger.warn(e)
+    logger.warn(
+      `Ignoring manual layout of "${node.name ?? 'unnamed'}" at ${doc.uri.fsPath}:${
+        1 + (commentNode.range.start.line || 0)
+      }`
+    )
+    return undefined
+  }
+}

package/src/views/configurable-layouter.ts

@@ -0,0 +1,65 @@
+import { GraphvizLayouter, GraphvizWasmAdapter } from '@likec4/layouts'
+import { GraphvizBinaryAdapter } from '@likec4/layouts/graphviz/binary'
+import { isEmpty } from 'remeda'
+import which from 'which'
+import { logger } from '../logger'
+import type { LikeC4Services } from '../module'
+
+function graphvizBinPath() {
+  try {
+    return which.sync('dot')
+  } catch (error) {
+    logger.error('Error checking for native Graphviz:', error)
+    return null
+  }
+}
+
+export const ConfigurableLayouter = {
+  likec4: {
+    Layouter(services: LikeC4Services): GraphvizLayouter {
+      logger.debug('Creating ConfigurableLayouter')
+      const wasmAdapter = new GraphvizWasmAdapter()
+      const layouter = new GraphvizLayouter(wasmAdapter)
+      const langId = services.LanguageMetaData.languageId
+      services.shared.workspace.ConfigurationProvider.onConfigurationSectionUpdate((update) => {
+        logger.debug('Configuration update', update)
+        if (update.section === langId) {
+          try {
+            const { mode, path } = update.configuration.graphviz ?? {
+              mode: 'wasm',
+              path: '',
+            }
+
+            if (mode === 'wasm') {
+              layouter.changePort(wasmAdapter)
+              logger.info('use graphviz wasm')
+              return
+            }
+
+            let binaryPath = isEmpty(path) ? graphvizBinPath() : path
+
+            if (binaryPath === null) {
+              layouter.changePort(wasmAdapter)
+              logger.warn(`No Graphviz binaries found on PATH, use graphviz wasm`)
+              services.shared.lsp.Connection?.window.showWarningMessage(
+                'No Graphviz binaries found on PATH, set path to binaries in settings.',
+              )
+              return
+            }
+
+            layouter.changePort(new GraphvizBinaryAdapter(binaryPath))
+
+            logger.info(`use graphviz binary: ${binaryPath}`)
+          } catch (error) {
+            logger.error('Failed to update configuration', error)
+          }
+          return
+        }
+
+        logger.warn('Unexpected configuration update', update)
+      })
+
+      return layouter
+    },
+  },
+}

package/src/views/index.ts

@@ -0,0 +1 @@
+export { LikeC4Views } from './likec4-views'

package/src/views/likec4-views.ts

@@ -0,0 +1,139 @@
+import type { ComputedView, DiagramView, OverviewGraph, ViewId } from '@likec4/core'
+import { GraphvizLayouter } from '@likec4/layouts'
+import { type Cancellation, type WorkspaceCache } from 'langium'
+import { values } from 'remeda'
+import { logger, logWarnError } from '../logger'
+import type { LikeC4Services } from '../module'
+
+export type GraphvizOut = {
+  dot: string
+  diagram: DiagramView
+}
+
+type GraphvizSvgOut = {
+  id: ViewId
+  dot: string
+  svg: string
+}
+
+export class LikeC4Views {
+  private cache = new WeakMap<ComputedView, GraphvizOut>()
+
+  private viewsWithReportedErrors = new Set<ViewId>()
+
+  constructor(private services: LikeC4Services) {
+  }
+
+  private get layouter(): GraphvizLayouter {
+    return this.services.likec4.Layouter
+  }
+
+  async computedViews(cancelToken?: Cancellation.CancellationToken): Promise<ComputedView[]> {
+    const model = await this.services.likec4.ModelBuilder.buildComputedModel(cancelToken)
+    return model ? values(model.views) : []
+  }
+
+  async layoutAllViews(cancelToken?: Cancellation.CancellationToken): Promise<Array<Readonly<GraphvizOut>>> {
+    const views = await this.computedViews(cancelToken)
+    if (views.length === 0) {
+      return []
+    }
+    const results = [] as GraphvizOut[]
+    const tasks = [] as Promise<GraphvizOut>[]
+    for (const view of views) {
+      this.viewsWithReportedErrors.delete(view.id)
+      tasks.push(
+        this.layouter.layout(view)
+          .then(result => {
+            this.cache.set(view, result)
+            return result
+          })
+          .catch(e => {
+            this.cache.delete(view)
+            logWarnError(e)
+            return Promise.reject(e)
+          }),
+      )
+    }
+    for (const task of await Promise.allSettled(tasks)) {
+      if (task.status === 'fulfilled') {
+        results.push(task.value)
+      }
+    }
+    return results
+  }
+
+  async layoutView(viewId: ViewId, cancelToken?: Cancellation.CancellationToken): Promise<GraphvizOut | null> {
+    const model = await this.services.likec4.ModelBuilder.buildComputedModel(cancelToken)
+    if (!model) {
+      return null
+    }
+    const view = model.views[viewId]
+    if (!view) {
+      return null
+    }
+    let cached = this.cache.get(view)
+    if (cached) {
+      return cached
+    }
+    try {
+      const result = await this.layouter.layout(view)
+      this.viewsWithReportedErrors.delete(viewId)
+      this.cache.set(view, result)
+      return result
+    } catch (e) {
+      if (!this.viewsWithReportedErrors.has(viewId)) {
+        const errMessage = e instanceof Error ? e.message : '' + e
+        this.services.shared.lsp.Connection?.window.showErrorMessage(`LikeC4: ${errMessage}`)
+        this.viewsWithReportedErrors.add(viewId)
+      }
+      logger.error(e)
+      return Promise.reject(e)
+    }
+  }
+
+  async diagrams(): Promise<Array<DiagramView>> {
+    const layouted = await this.layoutAllViews()
+    return layouted.map(l => l.diagram)
+  }
+
+  async viewsAsGraphvizOut(): Promise<Array<GraphvizSvgOut>> {
+    const KEY = 'All-LayoutedViews-DotWithSvg'
+    const cache = this.services.WorkspaceCache as WorkspaceCache<string, GraphvizSvgOut[]>
+    if (cache.has(KEY)) {
+      return await Promise.resolve(cache.get(KEY)!)
+    }
+    const views = await this.computedViews()
+    const tasks = views.map(async view => {
+      const { dot, svg } = await this.layouter.svg(view)
+      return {
+        id: view.id,
+        dot,
+        svg,
+      }
+    })
+    const succeed = [] as GraphvizSvgOut[]
+    const settledResult = await Promise.allSettled(tasks)
+    for (const result of settledResult) {
+      if (result.status === 'fulfilled') {
+        succeed.push(result.value)
+      } else {
+        logWarnError(result.reason)
+      }
+    }
+    cache.set(KEY, succeed)
+    return succeed
+  }
+
+  async overviewGraph(): Promise<OverviewGraph> {
+    const KEY = 'OverviewGraph'
+    const cache = this.services.WorkspaceCache as WorkspaceCache<string, OverviewGraph>
+    if (cache.has(KEY)) {
+      return await Promise.resolve(cache.get(KEY)!)
+    }
+    const views = await this.computedViews()
+    const overviewGraph = await this.layouter.layoutOverviewGraph(views)
+    cache.set(KEY, overviewGraph)
+    return overviewGraph
+  }
+}

package/dist/browser.cjs

@@ -1,25 +0,0 @@
-'use strict';
-
-const lsp = require('langium/lsp');
-const browser = require('vscode-languageserver/browser');
-const module$1 = require('./shared/language-server.CO_nmHiL.cjs');
-
-function startLanguageServer() {
-  const messageReader = new browser.BrowserMessageReader(self);
-  const messageWriter = new browser.BrowserMessageWriter(self);
-  const connection = browser.createConnection(messageReader, messageWriter);
-  const services = module$1.createLanguageServices({ connection });
-  lsp.startLanguageServer(services.shared);
-  return {
-    ...services,
-    connection,
-    messageReader,
-    messageWriter
-  };
-}
-
-exports.LikeC4Module = module$1.LikeC4Module;
-exports.createCustomLanguageServices = module$1.createCustomLanguageServices;
-exports.createLanguageServices = module$1.createLanguageServices;
-exports.setLogLevel = module$1.setLogLevel;
-exports.startLanguageServer = startLanguageServer;

package/dist/browser.d.cts

@@ -1,23 +0,0 @@
-import { L as LikeC4SharedServices, a as LikeC4Services } from './shared/language-server.Da6ey08o.cjs';
-export { D as DeploymentsIndex, e as DocumentDeploymentsIndex, g as FqnIndex, F as FqnIndexEntry, I as IsValidFn, l as LanguageServicesContext, k as LikeC4AddedServices, h as LikeC4ModelBuilder, i as LikeC4ModelLocator, j as LikeC4ModelParser, d as LikeC4Module, M as ModelParsedListener, f as computeDocumentFqn, c as createCustomLanguageServices, b as createLanguageServices, m as createSharedServices, s as setLogLevel } from './shared/language-server.Da6ey08o.cjs';
-import * as vscode_languageserver from 'vscode-languageserver';
-import { BrowserMessageReader, BrowserMessageWriter } from 'vscode-languageserver/browser';
-import 'langium';
-import 'langium/lsp';
-import 'vscode-languageserver-types';
-import '@likec4/core';
-import 'type-fest';
-import './protocol.cjs';
-import 'vscode-jsonrpc';
-import 'vscode-uri';
-import '@likec4/log';
-
-declare function startLanguageServer(): {
-    connection: vscode_languageserver.Connection;
-    messageReader: BrowserMessageReader;
-    messageWriter: BrowserMessageWriter;
-    shared: LikeC4SharedServices;
-    likec4: LikeC4Services;
-};
-
-export { LikeC4Services, LikeC4SharedServices, startLanguageServer };

package/dist/browser.d.mts

@@ -1,23 +0,0 @@
-import { L as LikeC4SharedServices, a as LikeC4Services } from './shared/language-server.Dj4iDjtB.mjs';
-export { D as DeploymentsIndex, e as DocumentDeploymentsIndex, g as FqnIndex, F as FqnIndexEntry, I as IsValidFn, l as LanguageServicesContext, k as LikeC4AddedServices, h as LikeC4ModelBuilder, i as LikeC4ModelLocator, j as LikeC4ModelParser, d as LikeC4Module, M as ModelParsedListener, f as computeDocumentFqn, c as createCustomLanguageServices, b as createLanguageServices, m as createSharedServices, s as setLogLevel } from './shared/language-server.Dj4iDjtB.mjs';
-import * as vscode_languageserver from 'vscode-languageserver';
-import { BrowserMessageReader, BrowserMessageWriter } from 'vscode-languageserver/browser';
-import 'langium';
-import 'langium/lsp';
-import 'vscode-languageserver-types';
-import '@likec4/core';
-import 'type-fest';
-import './protocol.mjs';
-import 'vscode-jsonrpc';
-import 'vscode-uri';
-import '@likec4/log';
-
-declare function startLanguageServer(): {
-    connection: vscode_languageserver.Connection;
-    messageReader: BrowserMessageReader;
-    messageWriter: BrowserMessageWriter;
-    shared: LikeC4SharedServices;
-    likec4: LikeC4Services;
-};
-
-export { LikeC4Services, LikeC4SharedServices, startLanguageServer };

package/dist/browser.mjs

@@ -1,20 +0,0 @@
-import { startLanguageServer as startLanguageServer$1 } from 'langium/lsp';
-import { BrowserMessageReader, BrowserMessageWriter, createConnection } from 'vscode-languageserver/browser';
-import { c as createLanguageServices } from './shared/language-server.oO_9JoAG.mjs';
-export { L as LikeC4Module, a as createCustomLanguageServices, s as setLogLevel } from './shared/language-server.oO_9JoAG.mjs';
-
-function startLanguageServer() {
-  const messageReader = new BrowserMessageReader(self);
-  const messageWriter = new BrowserMessageWriter(self);
-  const connection = createConnection(messageReader, messageWriter);
-  const services = createLanguageServices({ connection });
-  startLanguageServer$1(services.shared);
-  return {
-    ...services,
-    connection,
-    messageReader,
-    messageWriter
-  };
-}
-
-export { createLanguageServices, startLanguageServer };

package/dist/index.cjs

@@ -1,53 +0,0 @@
-'use strict';
-
-const lsp = require('langium/lsp');
-const node$1 = require('vscode-languageserver/node');
-const langium = require('langium');
-const node = require('langium/node');
-const node_fs = require('node:fs');
-const promises = require('node:fs/promises');
-const node_path = require('node:path');
-const module$1 = require('./shared/language-server.CO_nmHiL.cjs');
-
-const LikeC4FileSystem = {
-  fileSystemProvider: () => new SymLinkTraversingFileSystemProvider()
-};
-class SymLinkTraversingFileSystemProvider extends node.NodeFileSystemProvider {
-  async readDirectory(folderPath) {
-    const dirents = await promises.readdir(folderPath.fsPath, { withFileTypes: true });
-    return dirents.map((dirent) => this.followUri(langium.UriUtils.joinPath(folderPath, dirent.name)));
-  }
-  followUri(uri) {
-    const directoryPath = node_path.dirname(uri.fsPath);
-    const stat = node_fs.lstatSync(uri.fsPath);
-    if (stat.isSymbolicLink()) {
-      const resolved_link = node_fs.readlinkSync(uri.fsPath);
-      const linked_path = node_path.resolve(directoryPath, resolved_link);
-      return this.followUri(langium.URI.file(linked_path));
-    } else {
-      return {
-        isFile: stat.isFile(),
-        isDirectory: stat.isDirectory(),
-        uri
-      };
-    }
-  }
-}
-
-function startLanguageServer() {
-  const connection = node$1.createConnection(node$1.ProposedFeatures.all);
-  const services = module$1.createLanguageServices({ connection, ...LikeC4FileSystem });
-  lsp.startLanguageServer(services.shared);
-  return {
-    ...services,
-    connection
-  };
-}
-
-exports.LikeC4Module = module$1.LikeC4Module;
-exports.createCustomLanguageServices = module$1.createCustomLanguageServices;
-exports.createLanguageServices = module$1.createLanguageServices;
-exports.lspLogger = module$1.logger;
-exports.setLogLevel = module$1.setLogLevel;
-exports.LikeC4FileSystem = LikeC4FileSystem;
-exports.startLanguageServer = startLanguageServer;

package/dist/index.d.cts

@@ -1,34 +0,0 @@
-import { L as LikeC4SharedServices, a as LikeC4Services } from './shared/language-server.Da6ey08o.cjs';
-export { D as DeploymentsIndex, e as DocumentDeploymentsIndex, g as FqnIndex, F as FqnIndexEntry, I as IsValidFn, l as LanguageServicesContext, k as LikeC4AddedServices, h as LikeC4ModelBuilder, i as LikeC4ModelLocator, j as LikeC4ModelParser, d as LikeC4Module, M as ModelParsedListener, f as computeDocumentFqn, c as createCustomLanguageServices, b as createLanguageServices, m as createSharedServices, n as lspLogger, s as setLogLevel } from './shared/language-server.Da6ey08o.cjs';
-import * as vscode_languageserver_lib_common_inlineCompletion_proposed from 'vscode-languageserver/lib/common/inlineCompletion.proposed';
-import * as vscode_languageserver from 'vscode-languageserver';
-import { URI, FileSystemNode } from 'langium';
-import { NodeFileSystemProvider } from 'langium/node';
-import 'langium/lsp';
-import 'vscode-languageserver-types';
-import '@likec4/core';
-import 'type-fest';
-import './protocol.cjs';
-import 'vscode-jsonrpc';
-import 'vscode-uri';
-import '@likec4/log';
-
-declare const LikeC4FileSystem: {
-    fileSystemProvider: () => SymLinkTraversingFileSystemProvider;
-};
-/**
- * A file system provider that follows symbolic links.
- * @see https://github.com/likec4/likec4/pull/1213
- */
-declare class SymLinkTraversingFileSystemProvider extends NodeFileSystemProvider {
-    readDirectory(folderPath: URI): Promise<FileSystemNode[]>;
-    followUri(uri: URI): FileSystemNode;
-}
-
-declare function startLanguageServer(): {
-    connection: vscode_languageserver._Connection<vscode_languageserver._, vscode_languageserver._, vscode_languageserver._, vscode_languageserver._, vscode_languageserver._, vscode_languageserver._, vscode_languageserver_lib_common_inlineCompletion_proposed.InlineCompletionFeatureShape, vscode_languageserver._>;
-    shared: LikeC4SharedServices;
-    likec4: LikeC4Services;
-};
-
-export { LikeC4FileSystem, LikeC4Services, LikeC4SharedServices, startLanguageServer };

package/dist/index.d.mts

@@ -1,34 +0,0 @@
-import { L as LikeC4SharedServices, a as LikeC4Services } from './shared/language-server.Dj4iDjtB.mjs';
-export { D as DeploymentsIndex, e as DocumentDeploymentsIndex, g as FqnIndex, F as FqnIndexEntry, I as IsValidFn, l as LanguageServicesContext, k as LikeC4AddedServices, h as LikeC4ModelBuilder, i as LikeC4ModelLocator, j as LikeC4ModelParser, d as LikeC4Module, M as ModelParsedListener, f as computeDocumentFqn, c as createCustomLanguageServices, b as createLanguageServices, m as createSharedServices, n as lspLogger, s as setLogLevel } from './shared/language-server.Dj4iDjtB.mjs';
-import * as vscode_languageserver_lib_common_inlineCompletion_proposed from 'vscode-languageserver/lib/common/inlineCompletion.proposed';
-import * as vscode_languageserver from 'vscode-languageserver';
-import { URI, FileSystemNode } from 'langium';
-import { NodeFileSystemProvider } from 'langium/node';
-import 'langium/lsp';
-import 'vscode-languageserver-types';
-import '@likec4/core';
-import 'type-fest';
-import './protocol.mjs';
-import 'vscode-jsonrpc';
-import 'vscode-uri';
-import '@likec4/log';
-
-declare const LikeC4FileSystem: {
-    fileSystemProvider: () => SymLinkTraversingFileSystemProvider;
-};
-/**
- * A file system provider that follows symbolic links.
- * @see https://github.com/likec4/likec4/pull/1213
- */
-declare class SymLinkTraversingFileSystemProvider extends NodeFileSystemProvider {
-    readDirectory(folderPath: URI): Promise<FileSystemNode[]>;
-    followUri(uri: URI): FileSystemNode;
-}
-
-declare function startLanguageServer(): {
-    connection: vscode_languageserver._Connection<vscode_languageserver._, vscode_languageserver._, vscode_languageserver._, vscode_languageserver._, vscode_languageserver._, vscode_languageserver._, vscode_languageserver_lib_common_inlineCompletion_proposed.InlineCompletionFeatureShape, vscode_languageserver._>;
-    shared: LikeC4SharedServices;
-    likec4: LikeC4Services;
-};
-
-export { LikeC4FileSystem, LikeC4Services, LikeC4SharedServices, startLanguageServer };

package/dist/index.mjs

@@ -1,46 +0,0 @@
-import { startLanguageServer as startLanguageServer$1 } from 'langium/lsp';
-import { createConnection, ProposedFeatures } from 'vscode-languageserver/node';
-import { UriUtils, URI } from 'langium';
-import { NodeFileSystemProvider } from 'langium/node';
-import { lstatSync, readlinkSync } from 'node:fs';
-import { readdir } from 'node:fs/promises';
-import { dirname, resolve } from 'node:path';
-import { c as createLanguageServices } from './shared/language-server.oO_9JoAG.mjs';
-export { L as LikeC4Module, a as createCustomLanguageServices, l as lspLogger, s as setLogLevel } from './shared/language-server.oO_9JoAG.mjs';
-
-const LikeC4FileSystem = {
-  fileSystemProvider: () => new SymLinkTraversingFileSystemProvider()
-};
-class SymLinkTraversingFileSystemProvider extends NodeFileSystemProvider {
-  async readDirectory(folderPath) {
-    const dirents = await readdir(folderPath.fsPath, { withFileTypes: true });
-    return dirents.map((dirent) => this.followUri(UriUtils.joinPath(folderPath, dirent.name)));
-  }
-  followUri(uri) {
-    const directoryPath = dirname(uri.fsPath);
-    const stat = lstatSync(uri.fsPath);
-    if (stat.isSymbolicLink()) {
-      const resolved_link = readlinkSync(uri.fsPath);
-      const linked_path = resolve(directoryPath, resolved_link);
-      return this.followUri(URI.file(linked_path));
-    } else {
-      return {
-        isFile: stat.isFile(),
-        isDirectory: stat.isDirectory(),
-        uri
-      };
-    }
-  }
-}
-
-function startLanguageServer() {
-  const connection = createConnection(ProposedFeatures.all);
-  const services = createLanguageServices({ connection, ...LikeC4FileSystem });
-  startLanguageServer$1(services.shared);
-  return {
-    ...services,
-    connection
-  };
-}
-
-export { LikeC4FileSystem, createLanguageServices, startLanguageServer };