@finos/legend-application-studio 26.1.3 → 26.1.4

package/src/components/editor/editor-group/service-editor/ServiceRegistrationEditor.tsx

@@ -29,6 +29,8 @@ import { ServiceExecutionMode } from '@finos/legend-graph';
 import { flowResult } from 'mobx';
 import { useEditorStore } from '../../EditorStoreProvider.js';
 import { useApplicationStore } from '@finos/legend-application';
+import { MASTER_SNAPSHOT_ALIAS } from '@finos/legend-server-depot';
+import { LATEST_PROJECT_REVISION } from '../../../../stores/editor/editor-state/element-editor-state/service/ServiceRegistrationState.js';
 
 export const ServiceRegistrationEditor = observer(() => {
   const editorStore = useEditorStore();
@@ -74,7 +76,10 @@ export const ServiceRegistrationEditor = observer(() => {
   // version
   const selectedVersion = registrationState.projectVersion
     ? {
-        label: registrationState.projectVersion,
+        label:
+          registrationState.projectVersion === MASTER_SNAPSHOT_ALIAS
+            ? LATEST_PROJECT_REVISION
+            : registrationState.projectVersion,
         value: registrationState.projectVersion,
       }
     : null;
@@ -151,145 +156,153 @@ export const ServiceRegistrationEditor = observer(() => {
       <PanelLoadingIndicator
         isLoading={registrationState.registrationState.isInProgress}
       />
-      <div className="panel__content__form">
-        {registrationState.registrationState.message && (
-          <div className="service-registration-editor__progress-msg">
-            {`${registrationState.registrationState.message}...`}
-          </div>
-        )}
-        <div className="panel__content__form__section">
-          <div className="panel__content__form__section__header__label">
-            Activate Service
-          </div>
-          <div
-            className="panel__content__form__section__toggler"
-            onClick={toggleActivatePostRegistration}
-          >
-            <button
-              className={clsx('panel__content__form__section__toggler__btn', {
-                'panel__content__form__section__toggler__btn--toggled':
-                  registrationState.activatePostRegistration,
-              })}
-              tabIndex={-1}
-            >
-              {registrationState.activatePostRegistration ? (
-                <CheckSquareIcon />
-              ) : (
-                <SquareIcon />
-              )}
-            </button>
-            <div className="panel__content__form__section__toggler__prompt">
-              Activates service after registration
+      <div className="panel__content">
+        <div className="panel__content__form">
+          {registrationState.registrationState.message && (
+            <div className="service-registration-editor__progress-msg">
+              {`${registrationState.registrationState.message}...`}
             </div>
-          </div>
-        </div>
-        <div className="panel__content__form__section">
-          <div className="panel__content__form__section__header__label">
-            Execution Server
-          </div>
-          <div className="panel__content__form__section__header__prompt">
-            The execution server where your service will be registered
-          </div>
-          <CustomSelectorInput
-            options={envOptions}
-            onChange={onServerEnvChange}
-            value={selectedEnvOption}
-            darkMode={true}
-          />
-        </div>
-        <div className="panel__content__form__section">
-          <div className="panel__content__form__section__header__label">
-            Service Type
-          </div>
-          <div className="panel__content__form__section__header__prompt">
-            The kind of service you want to register. Used to determine how the
-            metadata will be fetched
-          </div>
-          <CustomSelectorInput
-            options={serviceTypesOptions}
-            onChange={onServiceTypeSelectionChange}
-            value={selectedServiceType}
-            darkMode={true}
-          />
-        </div>
-        {registrationState.serviceExecutionMode ===
-          ServiceExecutionMode.FULL_INTERACTIVE && (
+          )}
           <div className="panel__content__form__section">
             <div className="panel__content__form__section__header__label">
-              Store Model
+              Activate Service
             </div>
             <div
               className="panel__content__form__section__toggler"
-              onClick={toggleUseStoreModel}
+              onClick={toggleActivatePostRegistration}
             >
               <button
                 className={clsx('panel__content__form__section__toggler__btn', {
                   'panel__content__form__section__toggler__btn--toggled':
-                    registrationState.TEMPORARY__useStoreModel,
+                    registrationState.activatePostRegistration,
                 })}
                 tabIndex={-1}
               >
-                {registrationState.TEMPORARY__useStoreModel ? (
+                {registrationState.activatePostRegistration ? (
                   <CheckSquareIcon />
                 ) : (
                   <SquareIcon />
                 )}
               </button>
               <div className="panel__content__form__section__toggler__prompt">
-                Use Store Model (slower)
+                Activates service after registration
               </div>
             </div>
           </div>
-        )}
-        {
           <div className="panel__content__form__section">
             <div className="panel__content__form__section__header__label">
-              Generate Lineage
+              Execution Server
             </div>
-            <div
-              className="panel__content__form__section__toggler"
-              onClick={toggleUseGenerateLineage}
-            >
-              <button
-                className={clsx('panel__content__form__section__toggler__btn', {
-                  'panel__content__form__section__toggler__btn--toggled':
-                    registrationState.TEMPORARY__useGenerateLineage,
-                })}
-                tabIndex={-1}
+            <div className="panel__content__form__section__header__prompt">
+              The execution server where your service will be registered
+            </div>
+            <CustomSelectorInput
+              options={envOptions}
+              onChange={onServerEnvChange}
+              value={selectedEnvOption}
+              darkMode={true}
+            />
+          </div>
+          <div className="panel__content__form__section">
+            <div className="panel__content__form__section__header__label">
+              Service Type
+            </div>
+            <div className="panel__content__form__section__header__prompt">
+              The kind of service you want to register. Used to determine how
+              the metadata will be fetched
+            </div>
+            <CustomSelectorInput
+              options={serviceTypesOptions}
+              onChange={onServiceTypeSelectionChange}
+              value={selectedServiceType}
+              darkMode={true}
+            />
+          </div>
+          {registrationState.serviceExecutionMode ===
+            ServiceExecutionMode.FULL_INTERACTIVE && (
+            <div className="panel__content__form__section">
+              <div className="panel__content__form__section__header__label">
+                Store Model
+              </div>
+              <div
+                className="panel__content__form__section__toggler"
+                onClick={toggleUseStoreModel}
               >
-                {registrationState.TEMPORARY__useGenerateLineage ? (
-                  <CheckSquareIcon />
-                ) : (
-                  <SquareIcon />
-                )}
-              </button>
-              <div className="panel__content__form__section__toggler__prompt">
-                Generate Lineage (slower)
+                <button
+                  className={clsx(
+                    'panel__content__form__section__toggler__btn',
+                    {
+                      'panel__content__form__section__toggler__btn--toggled':
+                        registrationState.TEMPORARY__useStoreModel,
+                    },
+                  )}
+                  tabIndex={-1}
+                >
+                  {registrationState.TEMPORARY__useStoreModel ? (
+                    <CheckSquareIcon />
+                  ) : (
+                    <SquareIcon />
+                  )}
+                </button>
+                <div className="panel__content__form__section__toggler__prompt">
+                  Use Store Model (slower)
+                </div>
               </div>
             </div>
-          </div>
-        }
+          )}
+          {
+            <div className="panel__content__form__section">
+              <div className="panel__content__form__section__header__label">
+                Generate Lineage
+              </div>
+              <div
+                className="panel__content__form__section__toggler"
+                onClick={toggleUseGenerateLineage}
+              >
+                <button
+                  className={clsx(
+                    'panel__content__form__section__toggler__btn',
+                    {
+                      'panel__content__form__section__toggler__btn--toggled':
+                        registrationState.TEMPORARY__useGenerateLineage,
+                    },
+                  )}
+                  tabIndex={-1}
+                >
+                  {registrationState.TEMPORARY__useGenerateLineage ? (
+                    <CheckSquareIcon />
+                  ) : (
+                    <SquareIcon />
+                  )}
+                </button>
+                <div className="panel__content__form__section__toggler__prompt">
+                  Generate Lineage (slower)
+                </div>
+              </div>
+            </div>
+          }
 
-        <div className="panel__content__form__section">
-          <div className="panel__content__form__section__header__label">
-            Project Version
-          </div>
-          <div className="panel__content__form__section__header__prompt">
-            The version of your project you want to use for registration. Only
-            relevant for semi-interactive and production services.
+          <div className="panel__content__form__section">
+            <div className="panel__content__form__section__header__label">
+              Project Version
+            </div>
+            <div className="panel__content__form__section__header__prompt">
+              The version of your project you want to use for registration. Only
+              relevant for semi-interactive and production services.
+            </div>
+            <CustomSelectorInput
+              options={registrationState.versionOptions ?? []}
+              onChange={onVersionSelectionChange}
+              value={selectedVersion}
+              darkMode={true}
+              disabled={registrationState.versionOptions === undefined}
+              placeholder={versionPlaceholder}
+              isLoading={
+                editorStore.sdlcState.fetchPublishedProjectVersionsState
+                  .isInProgress
+              }
+            />
           </div>
-          <CustomSelectorInput
-            options={registrationState.versionOptions ?? []}
-            onChange={onVersionSelectionChange}
-            value={selectedVersion}
-            darkMode={true}
-            disabled={registrationState.versionOptions === undefined}
-            placeholder={versionPlaceholder}
-            isLoading={
-              editorStore.sdlcState.fetchPublishedProjectVersionsState
-                .isInProgress
-            }
-          />
         </div>
       </div>
     </div>

package/src/components/editor/panel-group/DevToolPanel.tsx

@@ -34,7 +34,11 @@ export const DevToolPanel = observer(() => {
     engineConfig.setUseClientRequestPayloadCompression(
       !engineConfig.useClientRequestPayloadCompression,
     );
-  const toggleDataUrlEncoding = (): void =>
+  const toggleEngineClientRequestPayloadDebugging = (): void =>
+    engineConfig.setEnableDebuggingPayload(
+      !engineConfig.enableDebuggingPayload,
+    );
+  const toggleEngineClientDataURLEncoding = (): void =>
     engineConfig.setUseBase64ForAdhocConnectionDataUrls(
       !engineConfig.useBase64ForAdhocConnectionDataUrls,
     );
@@ -59,6 +63,13 @@ export const DevToolPanel = observer(() => {
           isReadOnly={false}
           update={toggleEngineClientRequestPayloadCompression}
         />
+        <PanelFormBooleanField
+          name="Engine client request payload debug"
+          prompt="Specifies if request payload should be downloaded for debugging purpose"
+          value={engineConfig.enableDebuggingPayload}
+          isReadOnly={false}
+          update={toggleEngineClientRequestPayloadDebugging}
+        />
         <PanelFormTextField
           name="Engine client base URL"
           value={engineConfig.baseUrl ?? ''}
@@ -70,12 +81,33 @@ export const DevToolPanel = observer(() => {
             !isValidUrl(engineConfig.baseUrl ?? '') ? 'Invalid URL' : ''
           }
         />
+        {Boolean(
+          editorStore.applicationStore.config.options
+            .TEMPORARY__serviceRegistrationConfig.length,
+        ) && (
+          <PanelFormTextField
+            name="Engine client service registration base URL"
+            value={engineConfig.baseUrlForServiceRegistration ?? ''}
+            isReadOnly={false}
+            update={(value: string | undefined): void =>
+              engineConfig.setBaseUrlForServiceRegistration(
+                value === '' ? undefined : value,
+              )
+            }
+            errorMessage={
+              Boolean(engineConfig.baseUrlForServiceRegistration) &&
+              !isValidUrl(engineConfig.baseUrlForServiceRegistration ?? '')
+                ? 'Invalid URL'
+                : ''
+            }
+          />
+        )}
         <PanelFormBooleanField
           name="Engine execution runner"
           prompt="Use Base64 encoding for adhoc connection data URLs"
           value={engineConfig.useBase64ForAdhocConnectionDataUrls}
           isReadOnly={false}
-          update={toggleDataUrlEncoding}
+          update={toggleEngineClientDataURLEncoding}
         />
         <PanelFormBooleanField
           name="Graph builder strict mode"

package/src/index.ts

@@ -94,10 +94,7 @@ export * from './stores/extensions/DSL_Generation_LegendStudioApplicationPlugin_
 export * from './stores/extensions/STO_Relational_LegendStudioApplicationPlugin_Extension.js';
 
 export { MINIMUM_SERVICE_OWNERS } from './stores/editor/editor-state/element-editor-state/service/ServiceEditorState.js';
-export {
-  LATEST_PROJECT_REVISION,
-  generateServiceManagementUrl,
-} from './stores/editor/editor-state/element-editor-state/service/ServiceRegistrationState.js';
+export { generateServiceManagementUrl } from './stores/editor/editor-state/element-editor-state/service/ServiceRegistrationState.js';
 export { ServicePureExecutionState } from './stores/editor/editor-state/element-editor-state/service/ServiceExecutionState.js';
 export { NewServiceModal } from './components/editor/editor-group/service-editor/NewServiceModal.js';
 export { FileSystem_File as GenerationFile } from './stores/editor/utils/FileSystemTreeUtils.js';

package/src/stores/editor/EditorStore.ts

@@ -56,6 +56,10 @@ import {
   AssertionError,
   guaranteeType,
   type Clazz,
+  returnUndefOnError,
+  downloadFileUsingDataURI,
+  formatDate,
+  ContentType,
 } from '@finos/legend-shared';
 import { EditorSDLCState } from './EditorSDLCState.js';
 import { ModelImporterState } from './editor-state/ModelImporterState.js';
@@ -85,6 +89,7 @@ import {
   ActionAlertType,
   APPLICATION_EVENT,
   DEFAULT_TAB_SIZE,
+  DEFAULT_DATE_TIME_FORMAT,
 } from '@finos/legend-application';
 import { LEGEND_STUDIO_APP_EVENT } from '../../__lib__/LegendStudioEvent.js';
 import type { EditorMode } from './EditorMode.js';
@@ -663,6 +668,23 @@ export class EditorStore implements CommandRegistrar {
             baseUrl: this.applicationStore.config.engineServerUrl,
             queryBaseUrl: this.applicationStore.config.engineQueryServerUrl,
             enableCompression: true,
+            payloadDebugger: (payload: unknown, identifier: string) => {
+              const content =
+                returnUndefOnError(() =>
+                  JSON.stringify(payload, undefined, 2),
+                ) ??
+                returnUndefOnError(() => `${payload}`) ??
+                '';
+              // TODO: we can also copy the debug content to clipboard
+              downloadFileUsingDataURI(
+                `PAYLOAD_DEBUG__${identifier}__${formatDate(
+                  new Date(Date.now()),
+                  DEFAULT_DATE_TIME_FORMAT,
+                )}.json`,
+                content,
+                ContentType.TEXT_PLAIN,
+              );
+            },
           },
         },
         {

package/src/stores/editor/editor-state/element-editor-state/service/ServiceExecutionState.ts

@@ -30,10 +30,6 @@ import {
   decorateRuntimeWithNewMapping,
   RuntimeEditorState,
 } from '../../../editor-state/element-editor-state/RuntimeEditorState.js';
-import {
-  generatePath,
-  generateExtensionUrlPattern,
-} from '@finos/legend-application/browser';
 import {
   type ServiceExecution,
   type PureExecution,
@@ -63,10 +59,7 @@ import {
   type LightQuery,
   QuerySearchSpecification,
 } from '@finos/legend-graph';
-import {
-  parseGACoordinates,
-  generateGAVCoordinates,
-} from '@finos/legend-storage';
+import { parseGACoordinates } from '@finos/legend-storage';
 import { runtime_addMapping } from '../../../../graph-modifier/DSL_Mapping_GraphModifierHelper.js';
 import type { EditorStore } from '../../../EditorStore.js';
 import {
@@ -94,22 +87,6 @@ import {
 } from '@finos/legend-query-builder';
 import { DEFAULT_TAB_SIZE } from '@finos/legend-application';
 
-enum DSL_SERVICE_PATH_PARAM_TOKEN {
-  PROJECT_ID = 'projectId',
-  GROUP_WORKSPACE_ID = 'groupWorkspaceId',
-  SERVICE_PATH = 'servicePath',
-}
-
-enum LEGEND_QUERY_PATH_PARAM_TOKEN {
-  GAV = 'gav',
-  SERVICE_PATH = 'servicePath',
-}
-
-const QUERY_ROUTE_PATTERN = Object.freeze({
-  CREATE_FROM_SERVICE_QUERY: `/create-from-service/:${LEGEND_QUERY_PATH_PARAM_TOKEN.GAV}/:${LEGEND_QUERY_PATH_PARAM_TOKEN.SERVICE_PATH}`,
-  UPDATE_PROJECT_SERVICE_QUERY: `/update-project-service-query/:${DSL_SERVICE_PATH_PARAM_TOKEN.PROJECT_ID}/:${DSL_SERVICE_PATH_PARAM_TOKEN.GROUP_WORKSPACE_ID}/:${DSL_SERVICE_PATH_PARAM_TOKEN.SERVICE_PATH}`,
-});
-
 export class ServiceExecutionParametersState extends LambdaParametersState {
   executionState: ServicePureExecutionState;
 
@@ -777,39 +754,6 @@ export abstract class ServicePureExecutionState extends ServiceExecutionState {
   updateExecutionQuery(): void {
     pureExecution_setFunction(this.execution, this.queryState.query);
   }
-
-  generateServiceQueryCreatorRoute = (
-    baseUrl: string,
-    groupId: string,
-    artifactId: string,
-    versionId: string,
-    servicePath: string,
-  ): string =>
-    baseUrl +
-    generatePath(QUERY_ROUTE_PATTERN.CREATE_FROM_SERVICE_QUERY, {
-      [LEGEND_QUERY_PATH_PARAM_TOKEN.GAV]: generateGAVCoordinates(
-        groupId,
-        artifactId,
-        versionId,
-      ),
-      [LEGEND_QUERY_PATH_PARAM_TOKEN.SERVICE_PATH]: servicePath,
-    });
-
-  generateProjectServiceQueryUpdaterRoute = (
-    projectId: string,
-    groupWorkspaceId: string,
-    servicePath: string,
-  ): string =>
-    generatePath(
-      generateExtensionUrlPattern(
-        QUERY_ROUTE_PATTERN.UPDATE_PROJECT_SERVICE_QUERY,
-      ),
-      {
-        [DSL_SERVICE_PATH_PARAM_TOKEN.PROJECT_ID]: projectId,
-        [DSL_SERVICE_PATH_PARAM_TOKEN.GROUP_WORKSPACE_ID]: groupWorkspaceId,
-        [DSL_SERVICE_PATH_PARAM_TOKEN.SERVICE_PATH]: servicePath,
-      },
-    );
 }
 
 export class InlineServicePureExecutionState extends ServicePureExecutionState {

package/src/stores/editor/editor-state/element-editor-state/service/ServiceRegistrationState.ts

@@ -49,11 +49,10 @@ import {
   ActionAlertType,
 } from '@finos/legend-application';
 import { compareSemVerVersions } from '@finos/legend-storage';
+import { MASTER_SNAPSHOT_ALIAS } from '@finos/legend-server-depot';
 
 export const LATEST_PROJECT_REVISION = 'Latest Project Revision';
 
-const PROD_SERVICE_EXECUTION_SERVER = 'PROD';
-
 export const PROJECT_SEMANTIC_VERSION_PATTERN = /^[0-9]*.[0-9]*.[0-9]*$/;
 
 export const generateServiceManagementUrl = (
@@ -163,24 +162,23 @@ export class ServiceConfigState {
       this.enableModesWithVersioning &&
       this.serviceExecutionMode !== ServiceExecutionMode.FULL_INTERACTIVE
     ) {
-      const semVerVersions = this.editorStore.sdlcState.projectPublishedVersions
-        .filter((v) => v.match(PROJECT_SEMANTIC_VERSION_PATTERN))
-        .sort((v1, v2) => compareSemVerVersions(v2, v1));
+      const semanticVersions =
+        this.editorStore.sdlcState.projectPublishedVersions
+          .filter((version) => version.match(PROJECT_SEMANTIC_VERSION_PATTERN))
+          .sort((v1, v2) => compareSemVerVersions(v2, v1));
       const snapshotVersions =
         this.editorStore.sdlcState.projectPublishedVersions
-          .filter((v) => !v.match(PROJECT_SEMANTIC_VERSION_PATTERN))
+          .filter((version) => !version.match(PROJECT_SEMANTIC_VERSION_PATTERN))
           .sort((v1, v2) => v1.localeCompare(v2));
       const options: ServiceVersionOption[] = snapshotVersions
-        .concat(semVerVersions)
+        .concat(semanticVersions)
         .map((version) => ({
           label: version,
           value: version,
         }));
-      if (
-        this.serviceEnv &&
-        this.serviceEnv.toUpperCase() === PROD_SERVICE_EXECUTION_SERVER
-      ) {
-        return semVerVersions.map((version) => ({
+      if (this.serviceEnv && this.serviceEnv.toUpperCase() === 'PROD') {
+        // NOTE: we disallow registering against snapshot versions in PROD
+        return semanticVersions.map((version) => ({
           label: version,
           value: version,
         }));
@@ -188,10 +186,12 @@ export class ServiceConfigState {
         if (this.serviceExecutionMode !== ServiceExecutionMode.PROD) {
           return [
             {
-              label: prettyCONSTName(LATEST_PROJECT_REVISION),
-              value: LATEST_PROJECT_REVISION,
+              label: LATEST_PROJECT_REVISION,
+              value: MASTER_SNAPSHOT_ALIAS,
             },
-            ...options,
+            ...options.filter(
+              (option) => option.value !== MASTER_SNAPSHOT_ALIAS,
+            ),
           ];
         }
       }
@@ -228,7 +228,7 @@ export class ServiceConfigState {
 
   updateVersion(): void {
     if (this.serviceExecutionMode === ServiceExecutionMode.SEMI_INTERACTIVE) {
-      this.projectVersion = LATEST_PROJECT_REVISION;
+      this.projectVersion = MASTER_SNAPSHOT_ALIAS;
     } else if (this.serviceExecutionMode === ServiceExecutionMode.PROD) {
       this.projectVersion =
         this.editorStore.sdlcState.projectPublishedVersions[0];
@@ -259,6 +259,7 @@ export class ServiceRegistrationState extends ServiceConfigState {
     enableModesWithVersioning: boolean,
   ) {
     super(editorStore, registrationOptions, enableModesWithVersioning);
+
     makeObservable(this, {
       activatePostRegistration: observable,
       setActivatePostRegistration: action,

package/src/stores/editor/sidebar-state/BulkServiceRegistrationState.ts

@@ -37,8 +37,6 @@ import {
 import { LEGEND_STUDIO_APP_EVENT } from '../../../__lib__/LegendStudioEvent.js';
 import { type ServiceRegistrationEnvironmentConfig } from '../../../application/LegendStudioApplicationConfig.js';
 
-export const LATEST_PROJECT_REVISION = 'Latest Project Revision';
-
 export enum REGISTRATION_RESULT {
   DID_NOT_RUN = 'DID_NOT_RUN',
   FAILED = 'FAILED',

package/src/stores/project-view/ProjectViewerStore.ts

@@ -24,6 +24,10 @@ import {
   LogEvent,
   IllegalStateError,
   StopWatch,
+  returnUndefOnError,
+  downloadFileUsingDataURI,
+  formatDate,
+  ContentType,
 } from '@finos/legend-shared';
 import {
   type ProjectViewerPathParams,
@@ -46,7 +50,10 @@ import {
   Workspace,
 } from '@finos/legend-server-sdlc';
 import { LEGEND_STUDIO_APP_EVENT } from '../../__lib__/LegendStudioEvent.js';
-import { DEFAULT_TAB_SIZE } from '@finos/legend-application';
+import {
+  DEFAULT_DATE_TIME_FORMAT,
+  DEFAULT_TAB_SIZE,
+} from '@finos/legend-application';
 import { resolveVersion, StoreProjectData } from '@finos/legend-server-depot';
 import {
   type WorkflowManagerState,
@@ -365,6 +372,23 @@ export class ProjectViewerStore {
             queryBaseUrl:
               this.editorStore.applicationStore.config.engineQueryServerUrl,
             enableCompression: true,
+            payloadDebugger: (payload: unknown, identifier: string) => {
+              const content =
+                returnUndefOnError(() =>
+                  JSON.stringify(payload, undefined, 2),
+                ) ??
+                returnUndefOnError(() => `${payload}`) ??
+                '';
+              // TODO: we can also copy the debug content to clipboard
+              downloadFileUsingDataURI(
+                `PAYLOAD_DEBUG__${identifier}__${formatDate(
+                  new Date(Date.now()),
+                  DEFAULT_DATE_TIME_FORMAT,
+                )}.json`,
+                content,
+                ContentType.TEXT_PLAIN,
+              );
+            },
           },
         },
         {