Merge branch 'develop' into wip/db/14142-ydoc-websocket

Author: 4e6

CHANGELOG.md

@@ -29,6 +29,7 @@
 - [Launching another Enso process via `Process_Builder`][14753]
 - [Redshift schema support.][14735]
 - [`Process_Builder.set_env`.][14799]
+- [New `Profile` API for timing code execution.][14827]
 
 [14522]: https://github.com/enso-org/enso/pull/14522
 [14476]: https://github.com/enso-org/enso/pull/14476
@@ -42,6 +43,7 @@
 [14753]: https://github.com/enso-org/enso/pull/14753
 [14735]: https://github.com/enso-org/enso/pull/14735
 [14799]: https://github.com/enso-org/enso/pull/14799
+[14827]: https://github.com/enso-org/enso/pull/14827
 
 #### Enso Language & Runtime
 

app/common/src/services/Backend/types.ts

@@ -10,32 +10,32 @@ export const KSUID = newtypeConstructor<KSUID>()
 export type OrganizationId = Newtype<`organization-${string}`, 'OrganizationId'>
 export const OrganizationId = newtypeConstructor<OrganizationId>()
 /** Whether a given {@link string} is an {@link OrganizationId}. */
-export function isOrganizationId(id: unknown): id is OrganizationId {
-  return typeof id === 'string' && id.startsWith('organization-')
+export function isOrganizationId(id: string): id is OrganizationId {
+  return id.startsWith('organization-')
 }
 
 /** Unique identifier for a user in an organization. */
 export type UserId = Newtype<string, 'UserId'>
 export const UserId = newtypeConstructor<UserId>()
 /** Whether a given {@link string} is an {@link UserId}. */
-export function isUserId(id: unknown): id is UserId {
-  return typeof id === 'string' && id.startsWith('user-')
+export function isUserId(id: string): id is UserId {
+  return id.startsWith('user-')
 }
 
 /** Unique identifier for a user group. */
 export type UserGroupId = Newtype<`usergroup-${string}`, 'UserGroupId'>
 export const UserGroupId = newtypeConstructor<UserGroupId>()
 /** Whether a given {@link string} is an {@link UserGroupId}. */
-export function isUserGroupId(id: unknown): id is UserGroupId {
-  return typeof id === 'string' && id.startsWith('usergroup-')
+export function isUserGroupId(id: string): id is UserGroupId {
+  return id.startsWith('usergroup-')
 }
 
 /** Unique identifier for a directory. */
 export type DirectoryId = Newtype<`directory-${string}`, 'DirectoryId'>
 export const DirectoryId = newtypeConstructor<DirectoryId>()
 /** Whether a given {@link unknown} is an {@link DirectoryId}. */
-export function isDirectoryId(id: unknown): id is DirectoryId {
-  return typeof id === 'string' && id.startsWith('directory-')
+export function isDirectoryId(id: string): id is DirectoryId {
+  return id.startsWith('directory-')
 }
 
 /**
@@ -63,8 +63,8 @@ export const ErrorAssetId = newtypeConstructor<ErrorAssetId>()
 export type ProjectId = Newtype<string, 'ProjectId'>
 export const ProjectId = newtypeConstructor<ProjectId>()
 /** Whether a given {@link unknown} is an {@link ProjectId}. */
-export function isProjectId(id: unknown): id is ProjectId {
-  return typeof id === 'string' && id.startsWith('project-')
+export function isProjectId(id: string): id is ProjectId {
+  return id.startsWith('project-')
 }
 
 /** Unique identifier for an uploaded file. */

app/common/src/services/LocalBackend.ts

@@ -779,9 +779,24 @@ 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.AnyAsset> {
+  override async resolveEnsoPath(path: backend.EnsoPath): Promise<backend.AnyAsset> {
     const { directoryPath } = getDirectoryAndName(Path(path as string))
-    return this.findAsset(directoryPath, 'ensoPath', path)
+    const directoryContents = await this.listDirectory({
+      parentId: newDirectoryId(directoryPath),
+      filterBy: null,
+      labels: null,
+      recentProjects: false,
+      rootPath: this.rootPath(),
+      sortExpression: null,
+      sortDirection: null,
+      from: null,
+      pageSize: null,
+    })
+    const entry = directoryContents.assets.find((asset) => asset.ensoPath === path)
+    if (entry == null) {
+      throw new backend.AssetDoesNotExistError()
+    }
+    return entry
   }
 
   /** Resolve the data of a project asset relative to the project root directory. */
@@ -1129,33 +1144,6 @@ export class LocalBackend extends backend.Backend {
   override getMapboxToken() {
     return this.invalidOperation()
   }
-
-  /** Find asset details using directory listing. */
-  private async findAsset<Key extends keyof backend.AnyAsset>(
-    directory: Path,
-    key: Key,
-    value: backend.AnyAsset[Key],
-  ) {
-    const directoryContents = await this.listDirectory({
-      parentId: newDirectoryId(directory),
-      filterBy: null,
-      labels: null,
-      recentProjects: false,
-      rootPath: this.rootPath(),
-      sortExpression: null,
-      sortDirection: null,
-      from: null,
-      pageSize: null,
-    })
-    const entry = directoryContents.assets.find((content) => content[key] === value)
-    if (entry == null) {
-      if (backend.isDirectoryId(value)) {
-        throw new backend.DirectoryDoesNotExistError()
-      }
-      throw new backend.AssetDoesNotExistError()
-    }
-    return entry as never
-  }
 }
 
 markRaw(LocalBackend.prototype)

app/common/src/services/RemoteBackend/ids.ts

@@ -1,11 +1,5 @@
 /** @file ID encoding and decoding that is specific to cloud backend. */
-import { DirectoryId, UserGroupId, UserId, type AssetId, type OrganizationId } from '../Backend.js'
-import { TEAMS_DIRECTORY_ID, USERS_DIRECTORY_ID } from '../Backend/remoteBackendPaths.js'
-
-/** Whether the given directory is a special directory that cannot be written to. */
-export function isSpecialReadonlyDirectoryId(id: AssetId) {
-  return id === USERS_DIRECTORY_ID || id === TEAMS_DIRECTORY_ID
-}
+import { DirectoryId, UserGroupId, UserId, type OrganizationId } from '../Backend.js'
 
 /**
  * Extract the ID from the given user group ID.
@@ -51,52 +45,7 @@ export function userIdToDirectoryId(id: UserId): DirectoryId {
   return DirectoryId(`directory-${extractIdFromUserId(id)}`)
 }
 
-/**
- * Convert a directory ID to a user ID.
- * @param id - The directory ID.
- * @returns The user ID.
- */
-export function directoryIdToUserId(id: DirectoryId): UserId {
-  return UserId(`user-${extractIdFromDirectoryId(id)}`)
-}
-
 /** Convert organization ID to a directory ID. */
 export function organizationIdToDirectoryId(id: OrganizationId): DirectoryId {
   return DirectoryId(`directory-${extractIdFromOrganizationId(id)}`)
 }
-
-/**
- * Convert a directory ID to a user group ID.
- * @param id - The directory ID.
- * @returns The user group ID.
- */
-export function directoryIdToUserGroupId(id: DirectoryId): UserGroupId {
-  return UserGroupId(`usergroup-${extractIdFromDirectoryId(id)}`)
-}
-
-/**
- * Whether the given string is a valid organization ID.
- * @param id - The string to check.
- * @returns Whether the string is a valid organization ID.
- */
-export function isOrganizationId(id: string): id is OrganizationId {
-  return id.startsWith('organization-')
-}
-
-/**
- * Whether the given string is a valid user ID.
- * @param id - The string to check.
- * @returns Whether the string is a valid user ID.
- */
-export function isUserId(id: string): id is UserId {
-  return id.startsWith('user-')
-}
-
-/**
- * Whether the given string is a valid user group ID.
- * @param id - The string to check.
- * @returns Whether the string is a valid user group ID.
- */
-export function idIsUserGroupId(id: string): id is UserGroupId {
-  return id.startsWith('usergroup-')
-}

app/gui/src/dashboard/pages/dashboard/Drive/DriveBar/DriveBarNavigation.tsx

@@ -151,7 +151,7 @@ export function DriveBarNavigation() {
   const canNavigateUp = parentId >= 0
 
   const navigateToDirectory = useEventCallback((id: React.Key) => {
-    if (isDirectoryId(id)) {
+    if (typeof id === 'string' && isDirectoryId(id)) {
       setDriveLocation(id, category.id)
     }
   })
@@ -163,11 +163,9 @@ export function DriveBarNavigation() {
       return
     }
 
-    if (!isDirectoryId(id)) {
-      return
+    if (typeof id === 'string' && isDirectoryId(id)) {
+      await moveAssetsMutation([[...selectedIds], id])
     }
-
-    await moveAssetsMutation([[...selectedIds], id])
   })
 
   const navigateToParent = useEventCallback(() => {

distribution/lib/Standard/Base/0.0.0-dev/docs/api/Logging.md

@@ -6,10 +6,13 @@
     - Info
     - Severe
     - Warning
+- type Profile
+    - time_execution level:(Standard.Base.Logging.Log_Level|Standard.Base.Nothing.Nothing) ~label:Standard.Base.Data.Text.Text ~function:Standard.Base.Any.Any suffix_callback:Standard.Base.Any.Any= module:Standard.Base.Any.Any= -> Standard.Base.Any.Any
 - type Progress
     - advance self amount:Standard.Base.Data.Numbers.Integer= -> Standard.Base.Logging.Progress
     - close self -> Standard.Base.Any.Any
     - log self detail:Standard.Base.Data.Text.Text -> Standard.Base.Logging.Progress
     - run label:Standard.Base.Data.Text.Text up_to:Standard.Base.Data.Numbers.Integer action:(Standard.Base.Logging.Progress -> Standard.Base.Any.Any) step:Standard.Base.Data.Numbers.Integer= handle_name:Standard.Base.Data.Text.Text= -> Standard.Base.Any.Any
     - to_text self -> Standard.Base.Any.Any
 - Standard.Base.Any.Any.log_message self ~message:Standard.Base.Data.Text.Text level:Standard.Base.Logging.Log_Level= -> Standard.Base.Any.Any
+- Standard.Base.Logging.Log_Level.from that:Standard.Base.Data.Text.Text -> Standard.Base.Logging.Log_Level

distribution/lib/Standard/Base/0.0.0-dev/src/Logging.enso

@@ -1,13 +1,16 @@
 import project.Any.Any
 import project.Data.Numbers.Integer
 import project.Data.Text.Text
+import project.Data.Time.Duration.Duration
 import project.Error.Error
 import project.Errors.Illegal_Argument.Illegal_Argument
 import project.Internal.Meta_Helpers
 import project.Meta
+import project.Nothing.Nothing
 import project.Runtime.Managed_Resource.Managed_Resource
 import project.Runtime.Ref.Ref
 from project.Data.Boolean import False, True
+from project.Data.Text.Extensions import all
 
 polyglot java import org.enso.base.ProgressHandle
 polyglot java import org.slf4j.LoggerFactory
@@ -133,6 +136,48 @@ type Log_Level
     ## Severe level log message.
     Severe
 
+Log_Level.from (that:Text) =
+    case that.to_case ..Lower of
+        "finest" -> ..Finest
+        "trace" -> ..Finest
+        "fine" -> ..Fine
+        "debug" -> ..Fine
+        "info" -> ..Info
+        "warning" -> ..Warning
+        _ -> ..Severe
+
+## Utility type for profiling
+
+   Should be controlled by an environment variable set to the log level:
+   - `ENSO_PROFILE_VIZZES` - for visualizations.
+   - `ENSO_PROFILE_SQL` - for SQL queries.
+   - `ENSO_PROFILE_TABLE` - for table function calls.
+type Profile
+    ## ---
+       advanced: true
+       icon: time
+       ---
+       Time the evaluation of a function, log the duration and return the result.
+
+       ## Arguments
+        - `level`: Log level to log the duration at. If `Nothing`, the duration is not logged.
+        - `label`: Label to log with the duration.
+        - `function`: Function to execute.
+        - `suffix_callback`: Optional callback to generate a suffix for the log message based
+           on the result of the function. The callback is only called if `level` is not `Nothing`.
+        - `module`: Module to log the message to. Defaults to `Profile`.
+    time_execution level:(Log_Level | Nothing) ~label:Text ~function suffix_callback=Nothing module=Profile =
+        if Nothing == level then @Tail_Call function else
+            pair = Duration.time_execution function
+
+            ## If the function threw an error, we just return the error
+            Error.return_if_error pair.second
+
+            duration = pair.first
+            suffix = if suffix_callback == Nothing then "" else suffix_callback pair.second
+            module.log_message ("Execution time for " + label + ": " + duration.to_text + suffix) level
+            pair.second
+
 private log_impl logger ~message level args =
     builder = case level of
         Log_Level.Finest -> logger.atTrace

distribution/lib/Standard/Database/0.0.0-dev/src/Internal/JDBC_Connection.enso

@@ -2,8 +2,11 @@ from Standard.Base import all
 import Standard.Base.Errors.Illegal_Argument.Illegal_Argument
 import Standard.Base.Errors.Illegal_State.Illegal_State
 import Standard.Base.Errors.Unimplemented.Unimplemented
+import Standard.Base.Logging.Log_Level
+import Standard.Base.Logging.Profile
 import Standard.Base.Runtime.Context
 import Standard.Base.Runtime.Managed_Resource.Managed_Resource
+import Standard.Base.Runtime.State
 from Standard.Base.Enso_Cloud.Enso_Secret import as_hideable_value
 
 from Standard.Table import Table, Value_Type
@@ -61,7 +64,7 @@ type JDBC_Connection
        Runs the provided callback only if no thread is currently inside a
        `synchronized` critical section (including the current thread).
     run_maintenance_action_if_possible : (Nothing -> Any) -> Nothing
-    run_maintenance_action_if_possible self callback =
+    run_maintenance_action_if_possible self callback = Context.Output.with_enabled <|
         self.operation_synchronizer.runMaintenanceActionIfPossible callback
 
     ## ---
@@ -256,23 +259,23 @@ private _set_statement_values stmt:PreparedStatement statement_setter:Statement_
    A helper that logs performed SQL queries/statements run-time to a profiling
    file, if an environment variable is set.
 private _profile_sql_if_enabled (jdbc_connection : JDBC_Connection) (~query_text : Text) ~action (skip_log:Boolean=False) =
-    path = if skip_log then "" else
-        Environment.get "ENSO_SQL_PROFILING_PATH" . if_nothing Environment.get "ENSO_SQL_LOG_PATH" . if_nothing ""
-    if path.is_empty then action else
-        duration_and_result = Duration.time_execution action
-        result = duration_and_result.second
-        ## If the action returns a dataflow error, `time_execution` returns the error, no duration.
-           We could work around this. But we don't want to - the failing queries likely did not run anyway,
-           so their time info would most likely be an outlier. For current purposes it makes sense to ignore such cases.
-        Error.return_if_error result
-
-        padded_query = query_text.to_display_text.pad length=80
-        millis = duration_and_result.first.total_milliseconds
-        millis_text = (millis.to_text.pad length=5 with_pad=' ' at=..Left) + ' ms'
-
-        # E.g. [SQLite] SELECT * FROM "test" ... --> 12 ms
+    make_label =
         db_id = jdbc_connection.with_metadata .getDatabaseProductName
-        log_line = "[" + db_id + "] " + padded_query + " --> " + millis_text + '\n'
+        "[" + db_id + "] " + query_text.to_display_text
+
+    result = Profile.time_execution _profile_level label=make_label module=JDBC_Connection <|
+        action
+
+    ## If the action returns a dataflow error, `time_execution` returns the error, no duration.
+       We could work around this. But we don't want to - the failing queries likely did not run anyway,
+       so their time info would most likely be an outlier. For current purposes it makes sense to ignore such cases.
+    Error.return_if_error result
+
+    path = if skip_log then "" else Environment.get "ENSO_SQL_LOG_PATH" . if_nothing ""
+    if path.is_empty then result else
+        # E.g. [Time] [SQLite] SELECT * FROM "test"
+        padded_query = make_label.pad 100
+        log_line = "[" + Date_Time.now.to_text + "] " + padded_query + '\n'
         Context.Output.with_enabled <|
             log_line.write path on_existing_file=Existing_File_Behavior.Append
 
@@ -285,3 +288,11 @@ private _profile_sql_if_enabled (jdbc_connection : JDBC_Connection) (~query_text
    this Connection concurrently.
 private _synchronized (jdbc_connection : JDBC_Connection) ~action =
     jdbc_connection.operation_synchronizer.runSynchronizedAction _->action
+
+private _profile_level = State.get Table if_missing=_profile_level_from_env
+
+private _profile_level_from_env =
+    env_val = Environment.get "ENSO_PROFILE_SQL"
+    if env_val == Nothing then Nothing else
+        level = Log_Level.from env_val
+        if level.is_error then Nothing else level