@milaboratories/pl-middle-layer 1.14.32 → 1.15.0

package/src/middle_layer/project_overview.ts

@@ -24,7 +24,7 @@ import {
 import { constructBlockContextArgsOnly } from './block_ctx';
 import { ifNotUndef } from '../cfg_render/util';
 import { BlockPackInfo } from '../model/block_pack';
-import { BlockSection, normalizeBlockConfig } from '@platforma-sdk/model';
+import { BlockSection, extractConfig } from '@platforma-sdk/model';
 import { computableFromCfgOrRF } from './render';
 import { NavigationStates } from './navigation_states';
 
@@ -121,7 +121,7 @@ export function projectOverview(
 
       const limbo = new Set(renderingState.blocksInLimbo);
 
-      const blocks = [...allBlocks(structure)].map(({ id, label, renderingMode }) => {
+      const blocks = [...allBlocks(structure)].map(({ id, label: defaultLabel, renderingMode }) => {
         const info = notEmpty(infos.get(id));
         const gNode = notEmpty(currentGraph.nodes.get(id));
         let calculationStatus: BlockCalculationStatus = 'NotCalculated';
@@ -142,9 +142,9 @@ export function projectOverview(
 
         // sections
         const bpInfo = blockPack?.getDataAsJson<BlockPackInfo>();
-        const { sections, inputsValid, sdkVersion } =
-          ifNotUndef(bpInfo?.config, (blockConfU) => {
-            const blockConf = normalizeBlockConfig(blockConfU);
+        const { sections, title, inputsValid, sdkVersion } =
+          ifNotUndef(bpInfo?.config, (blockConfContainer) => {
+            const blockConf = extractConfig(blockConfContainer);
             const blockCtxArgsOnly = constructBlockContextArgsOnly(prj, id);
             return {
               sections: computableFromCfgOrRF(
@@ -153,6 +153,16 @@ export function projectOverview(
                 blockConf.sections,
                 blockConf.code
               ) as ComputableStableDefined<BlockSection[]>,
+              title: ifNotUndef(
+                blockConf.title,
+                (title) =>
+                  computableFromCfgOrRF(
+                    env,
+                    blockCtxArgsOnly,
+                    title,
+                    blockConf.code
+                  ) as ComputableStableDefined<string>
+              ),
               inputsValid: computableFromCfgOrRF(
                 env,
                 blockCtxArgsOnly,
@@ -169,7 +179,8 @@ export function projectOverview(
 
         return {
           id,
-          label,
+          label: title ?? defaultLabel,
+          title: title ?? defaultLabel,
           renderingMode,
           stale: info.prod?.stale !== false || calculationStatus === 'Limbo',
           missingReference: gNode.missingReferences,

package/src/middle_layer/render.ts

@@ -1,18 +1,24 @@
-import { Code, isFunctionHandle, TypedConfigOrFunctionHandle } from '@platforma-sdk/model';
+import { Code, isConfigLambda, TypedConfigOrConfigLambda } from '@platforma-sdk/model';
 import { Computable, ComputableRenderingOps } from '@milaboratories/computable';
 import { computableFromCfg } from '../cfg_render/executor';
 import { MiddleLayerEnvironment } from './middle_layer';
 import { computableFromRF } from '../js_render';
 import { BlockContextAny } from './block_ctx';
+import { hasActiveCfgComponents } from '../cfg_render/util';
+
+export function isActive(cfg: TypedConfigOrConfigLambda): boolean {
+  if (isConfigLambda(cfg)) return cfg.isActive === true;
+  else return hasActiveCfgComponents(cfg);
+}
 
 export function computableFromCfgOrRF(
   env: MiddleLayerEnvironment,
   ctx: BlockContextAny,
-  cfgOrFh: TypedConfigOrFunctionHandle,
+  cfgOrFh: TypedConfigOrConfigLambda,
   code: Code | undefined,
   ops: Partial<ComputableRenderingOps> = {}
 ): Computable<unknown> {
-  if (isFunctionHandle(cfgOrFh)) {
+  if (isConfigLambda(cfgOrFh)) {
     if (code === undefined) throw new Error('No code bundle.');
     return computableFromRF(env, ctx, cfgOrFh, code, ops);
   } else return computableFromCfg(env.driverKit, ctx, cfgOrFh, ops);

package/src/middle_layer/util.ts

@@ -3,9 +3,9 @@ import { projectFieldName } from '../model/project_model';
 import { Pl } from '@milaboratories/pl-client';
 import { ifNotUndef } from '../cfg_render/util';
 import { BlockPackInfo } from '../model/block_pack';
-import { normalizeBlockConfig } from '@platforma-sdk/model';
+import { BlockConfig, extractConfig } from '@platforma-sdk/model';
 
-export function getBlockCfg(prj: PlTreeNodeAccessor, blockId: string) {
+export function getBlockCfg(prj: PlTreeNodeAccessor, blockId: string): BlockConfig | undefined {
   return ifNotUndef(
     prj
       .traverse(
@@ -17,6 +17,8 @@ export function getBlockCfg(prj: PlTreeNodeAccessor, blockId: string) {
         { field: Pl.HolderRefField, assertFieldType: 'Input', errorIfFieldNotFound: true }
       )
       ?.getDataAsJson<BlockPackInfo>()?.config,
-    (cfg) => normalizeBlockConfig(cfg)
+    (cfg) => extractConfig(cfg)
   );
 }
+
+export const LogOutputStatus = process.env.MI_LOG_OUTPUT_STATUS;

package/src/model/block_pack.ts

@@ -1,8 +1,8 @@
-import { BlockConfigUniversal } from '@platforma-sdk/model';
+import { BlockConfigContainer } from '@platforma-sdk/model';
 import { BlockPackSpec } from '@milaboratories/pl-model-middle-layer';
 
 /** Define structure of block-pack data section */
 export interface BlockPackInfo {
   readonly source: BlockPackSpec;
-  readonly config: BlockConfigUniversal;
+  readonly config: BlockConfigContainer;
 }

package/src/model/block_pack_spec.ts

@@ -1,6 +1,6 @@
 import { ExplicitTemplate } from './template_spec';
 import { ResourceType } from '@milaboratories/pl-client';
-import { BlockConfig } from '@platforma-sdk/model';
+import { BlockConfigContainer } from '@platforma-sdk/model';
 import { BlockPackSpec } from '@milaboratories/pl-model-middle-layer';
 
 export type FrontendSpec = FrontendFromUrl | FrontendFromFolder;
@@ -40,7 +40,7 @@ export interface FrontendFromFolder extends FrontendFromFolderData {
 export interface BlockPackExplicit {
   type: 'explicit';
   template: ExplicitTemplate;
-  config: BlockConfig;
+  config: BlockConfigContainer;
   frontend: FrontendSpec;
   source: BlockPackSpec;
 }

package/src/model/project_model.ts

@@ -15,7 +15,10 @@ export interface Block {
   /** Unique block id */
   readonly id: string;
 
-  /** Label shown to the user */
+  /** 
+   * Label shown to the user
+   * @deprecated
+   * */
   label: string;
 
   /** How to approach block rendering */

package/src/mutator/block-pack/block_pack.test.ts

@@ -30,7 +30,7 @@ test.each([
     } as BlockPackSpecAny
   }
 ])('test load template from $spec.type', async ({ spec }) => {
-  const config = await preparation.getBlockConfig(spec);
+  const config = await preparation.getBlockConfigContainer(spec);
   expect(config).toBeDefined();
   expect(config.renderingMode).toEqual('Heavy');
 

package/src/mutator/block-pack/block_pack.ts

@@ -5,7 +5,7 @@ import { assertNever, Signer } from '@milaboratories/ts-helpers';
 import fs from 'node:fs';
 import { Dispatcher, request } from 'undici';
 import { createFrontend } from './frontend';
-import { BlockConfig } from '@platforma-sdk/model';
+import { BlockConfig, BlockConfigContainer } from '@platforma-sdk/model';
 import { loadPackDescription, RegistryV1 } from '@platforma-sdk/block-tools';
 import { BlockPackInfo } from '../../model/block_pack';
 import { resolveDevPacket } from '../../dev_env';
@@ -29,7 +29,7 @@ export class BlockPackPreparer {
     private readonly http?: Dispatcher
   ) {}
 
-  public async getBlockConfig(spec: BlockPackSpecAny): Promise<BlockConfig> {
+  public async getBlockConfigContainer(spec: BlockPackSpecAny): Promise<BlockConfigContainer> {
     switch (spec.type) {
       case 'explicit':
         return spec.config;
@@ -37,7 +37,7 @@ export class BlockPackPreparer {
       case 'dev-v1': {
         const devPaths = await resolveDevPacket(spec.folder, false);
         const configContent = await fs.promises.readFile(devPaths.config, { encoding: 'utf-8' });
-        return JSON.parse(configContent) as BlockConfig;
+        return JSON.parse(configContent) as BlockConfigContainer;
       }
 
       case 'dev-v2': {
@@ -45,7 +45,7 @@ export class BlockPackPreparer {
         const configContent = await fs.promises.readFile(description.components.model.file, {
           encoding: 'utf-8'
         });
-        return JSON.parse(configContent) as BlockConfig;
+        return JSON.parse(configContent) as BlockConfigContainer;
       }
 
       case 'from-registry-v1': {
@@ -55,7 +55,7 @@ export class BlockPackPreparer {
 
         const configResponse = await request(`${urlPrefix}/config.json`, httpOptions);
 
-        return (await configResponse.body.json()) as BlockConfig;
+        return (await configResponse.body.json()) as BlockConfigContainer;
       }
 
       case 'from-registry-v2': {
@@ -64,7 +64,7 @@ export class BlockPackPreparer {
         const components = await registry.getComponents(spec.id);
         return (await (
           await request(components.model.url, httpOptions)
-        ).body.json()) as BlockConfig;
+        ).body.json()) as BlockConfigContainer;
       }
 
       default:
@@ -86,7 +86,7 @@ export class BlockPackPreparer {
         // config
         const config = JSON.parse(
           await fs.promises.readFile(devPaths.config, 'utf-8')
-        ) as BlockConfig;
+        ) as BlockConfigContainer;
 
         // frontend
         const frontendPath = devPaths.ui;
@@ -113,7 +113,7 @@ export class BlockPackPreparer {
           await fs.promises.readFile(description.components.model.file, {
             encoding: 'utf-8'
           })
-        ) as BlockConfig;
+        ) as BlockConfigContainer;
         const workflowContent = await fs.promises.readFile(
           description.components.workflow.main.file
         );
@@ -155,7 +155,7 @@ export class BlockPackPreparer {
 
         // config
         const configResponse = await request(`${urlPrefix}/config.json`, httpOptions);
-        const config = (await configResponse.body.json()) as BlockConfig;
+        const config = (await configResponse.body.json()) as BlockConfigContainer;
 
         return {
           type: 'explicit',
@@ -177,7 +177,7 @@ export class BlockPackPreparer {
         const registry = this.v2RegistryProvider.getRegistry(spec.registryUrl);
         const components = await registry.getComponents(spec.id);
         const getModel = async () =>
-          (await (await request(components.model.url, httpOptions)).body.json()) as BlockConfig;
+          (await (await request(components.model.url, httpOptions)).body.json()) as BlockConfigContainer;
         const getWorkflow = async () =>
           await (await request(components.workflow.main.url, httpOptions)).body.arrayBuffer();
 

package/src/mutator/project.test.ts

@@ -1,3 +1,4 @@
+import { test, expect } from '@jest/globals';
 import { field, poll, TestHelpers, toGlobalResourceId } from '@milaboratories/pl-client';
 import { createProject, ProjectMutator, withProject } from './project';
 import { outputRef } from '../model/args';
@@ -28,6 +29,7 @@ test('simple test #1', async () => {
         { id: 'block1', label: 'Block1', renderingMode: 'Heavy' },
         {
           args: JSON.stringify({ numbers: [1, 2, 3] }),
+          uiState: "{}",
           blockPack: await TestBPPreparer.prepare(BPSpecEnterV041NotPrepared)
         }
       );
@@ -41,6 +43,7 @@ test('simple test #1', async () => {
         { id: 'block2', label: 'Block2', renderingMode: 'Heavy' },
         {
           args: JSON.stringify({ numbers: [3, 4, 5] }),
+          uiState: "{}",
           blockPack: await TestBPPreparer.prepare(BPSpecEnterV041NotPrepared)
         }
       );
@@ -57,6 +60,7 @@ test('simple test #1', async () => {
           args: JSON.stringify({
             sources: [outputRef('block1', 'column'), outputRef('block2', 'column')]
           }),
+          uiState: "{}",
           blockPack: await TestBPPreparer.prepare(BPSpecSumV042NotPrepared)
         }
       );
@@ -191,6 +195,7 @@ test('simple test #2 with bp migration', async () => {
         { id: 'block1', label: 'Block1', renderingMode: 'Heavy' },
         {
           args: JSON.stringify({ numbers: [1, 2, 3] }),
+          uiState: "{}",
           blockPack: await TestBPPreparer.prepare(BPSpecEnterV041NotPrepared)
         }
       );
@@ -198,6 +203,7 @@ test('simple test #2 with bp migration', async () => {
         { id: 'block2', label: 'Block2', renderingMode: 'Heavy' },
         {
           args: JSON.stringify({ numbers: [3, 4, 5] }),
+          uiState: "{}",
           blockPack: await TestBPPreparer.prepare(BPSpecEnterV041NotPrepared)
         }
       );
@@ -207,6 +213,7 @@ test('simple test #2 with bp migration', async () => {
           args: JSON.stringify({
             sources: [outputRef('block1', 'column'), outputRef('block2', 'column')]
           }),
+          uiState: "{}",
           blockPack: await TestBPPreparer.prepare(BPSpecSumV042NotPrepared)
         }
       );

package/src/mutator/project.ts

@@ -178,6 +178,7 @@ class BlockInfo {
 export interface NewBlockSpec {
   blockPack: BlockPackSpecPrepared;
   args: string;
+  uiState: string;
 }
 
 const NoNewBlocks = (blockId: string) => {
@@ -443,19 +444,19 @@ export class ProjectMutator {
   }
 
   /** Update block label */
-  public setBlockLabel(blockId: string, label: string): void {
-    const newStructure = this.structure;
-    let ok = false;
-    for (const block of allBlocks(newStructure))
-      if (block.id === blockId) {
-        block.label = label;
-        ok = true;
-        break;
-      }
-    if (!ok) throw new Error(`block ${blockId} not found`);
-    this.updateStructure(newStructure);
-    this.updateLastModified();
-  }
+  // public setBlockLabel(blockId: string, label: string): void {
+  //   const newStructure = this.structure;
+  //   let ok = false;
+  //   for (const block of allBlocks(newStructure))
+  //     if (block.id === blockId) {
+  //       block.label = label;
+  //       ok = true;
+  //       break;
+  //     }
+  //   if (!ok) throw new Error(`block ${blockId} not found`);
+  //   this.updateStructure(newStructure);
+  //   this.updateLastModified();
+  // }
 
   private createCtx(upstream: Set<string>, ctxField: 'stagingCtx' | 'prodCtx'): AnyRef {
     const upstreamContexts: AnyRef[] = [];
@@ -586,6 +587,12 @@ export class ProjectMutator {
       const argsRes = this.tx.createValue(Pl.JsonObject, binArgs);
       this.setBlockField(blockId, 'currentArgs', argsRes, 'Ready', binArgs);
 
+      // uiState
+      if (spec.uiState /* this check is for compatibility with old configs */) {
+        this.blockFrontendStates.set(blockId, spec.uiState);
+        this.changedBlockFrontendStates.add(blockId);
+      }
+
       // checking structure
       info.check();
     }

package/src/pool/result_pool.ts

@@ -9,7 +9,8 @@ import {
   ResultCollection,
   ResultPoolEntry,
   ValueOrError,
-  executePSpecPredicate
+  executePSpecPredicate,
+  mapValueInVOE
 } from '@platforma-sdk/model';
 import { notEmpty } from '@milaboratories/ts-helpers';
 import { outputRef } from '../model/args';
@@ -74,8 +75,49 @@ export class ResultPool {
     this.allSpecsAvailable = allSpecsAvailable;
   }
 
-  public getBlockLabel(blockId: string): string {
-    return notEmpty(this.blocks.get(blockId)?.info?.label, `block "${blockId}" not found`);
+  public getSpecByRef(blockId: string, exportName: string): PObjectSpec | undefined {
+    const block = this.blocks.get(blockId);
+    if (block === undefined) return undefined;
+    let result = block.prod?.results?.get(exportName)?.spec;
+    if (result !== undefined) return result;
+    result = block.staging?.results?.get(exportName)?.spec;
+    if (result !== undefined) return result;
+    if (block.staging === undefined) this.ctx.markUnstable(`staging_not_rendered:${blockId}`);
+    else if (!block.staging.locked) this.ctx.markUnstable(`staging_not_locked:${blockId}`);
+    else if (block.prod !== undefined && !block.prod.locked)
+      this.ctx.markUnstable(`prod_not_locked:${blockId}`);
+    // if prod is absent, returned undefined value is considered stable
+    return undefined;
+  }
+
+  public getDataOrErrorByRef(
+    blockId: string,
+    exportName: string
+  ): ValueOrError<PObject<PlTreeNodeAccessor>, string> | undefined {
+    const block = this.blocks.get(blockId);
+    if (block === undefined) return undefined;
+    let result = block.prod?.results?.get(exportName);
+    let data = result?.data?.();
+    if (result !== undefined && result.spec !== undefined && data !== undefined)
+      return mapValueInVOE(data, (value) => ({
+        id: derivePObjectId(result!.spec!, value),
+        spec: result!.spec!,
+        data: value
+      }));
+    if (result !== undefined) this.ctx.markUnstable(`no_data:${blockId}:${exportName}`);
+    if (block.prod !== undefined && !block.prod.locked)
+      this.ctx.markUnstable(`prod_not_locked:${blockId}`);
+    // if prod is absent, returned undefined value is considered stable
+    return undefined;
+  }
+
+  public getDataByRef(
+    blockId: string,
+    exportName: string
+  ): PObject<PlTreeNodeAccessor> | undefined {
+    const res = this.getDataOrErrorByRef(blockId, exportName);
+    if (res === undefined || !res.ok) return undefined;
+    return res.value;
   }
 
   public getData(): ExtendedResultCollection<PObject<PlTreeNodeAccessor>> {