fix for new store updates

Author: cianmSAP

packages/sap-systems-ext/src/commands/system/delete.ts

@@ -1,10 +1,9 @@
 import type { StoredSystemViewNode, SystemCommandContext } from '../../types/system';
 import type { PanelManager, SystemPanel } from '../../panel';
-import { BackendSystemKey, SystemService, type BackendSystem } from '@sap-ux/store';
+import { BackendSystemKey, type BackendSystem } from '@sap-ux/store';
 import { window } from 'vscode';
-import { t, confirmPrompt, TelemetryHelper, geti18nOpts } from '../../utils';
+import { t, confirmPrompt, TelemetryHelper, geti18nOpts, getBackendSystemService } from '../../utils';
 import { ConfirmationPromptType, SYSTEMS_EVENT, SystemAction, SystemActionStatus } from '../../utils/constants';
-import SystemsLogger from '../../utils/logger';
 
 /**
  * Returns a command handler function that deletes a specified system.
@@ -16,7 +15,7 @@ export const deleteSystemCommandHandler =
     (context: SystemCommandContext) =>
     async (system: StoredSystemViewNode): Promise<void> => {
         const backendSystemKey = new BackendSystemKey({ url: system.url, client: system.client });
-        const systemService = new SystemService(SystemsLogger.logger);
+        const systemService = await getBackendSystemService();
         const backendSystem = await systemService.read(backendSystemKey);
 
         if (!backendSystem) {

packages/sap-systems-ext/src/commands/system/import.ts

@@ -1,9 +1,9 @@
 import type { SystemConfig, SystemCommandContext, SystemConfigFile } from '../../types/system';
-import { BackendSystem, BackendSystemKey, SystemService, type SystemType } from '@sap-ux/store';
+import { BackendSystem, BackendSystemKey, type SystemType } from '@sap-ux/store';
 import { window, workspace } from 'vscode';
 import { platform } from 'node:os';
 import { readFileSync } from 'node:fs';
-import { confirmPrompt, TelemetryHelper, t } from '../../utils';
+import { confirmPrompt, TelemetryHelper, t, getBackendSystemService } from '../../utils';
 import {
     ConfirmationPromptType,
     SystemAction,
@@ -12,7 +12,6 @@ import {
     SYSTEMS_EVENT
 } from '../../utils/constants';
 import { SystemPanel } from '../../panel';
-import SystemsLogger from '../../utils/logger';
 
 /**
  * Returns a command handler function that handles importing a system configuration from a file.
@@ -24,7 +23,7 @@ export const importSystemCommandHandler = (commandContext: SystemCommandContext)
     try {
         const systemConfig = await getImportSystemConfig();
         const backendSystemKey = new BackendSystemKey({ url: systemConfig.url, client: systemConfig.client });
-        const systemService = new SystemService(SystemsLogger.logger);
+        const systemService = await getBackendSystemService();
         const existingSystem = await systemService.read(backendSystemKey);
 
         // if the system already exists, confirm if the user wants to overwrite

packages/sap-systems-ext/src/commands/system/launchAppGen.ts

@@ -1,14 +1,14 @@
 import type { StoredSystemViewNode, SystemCommandContext } from '../../types/system';
 import { commands, window } from 'vscode';
-import { TelemetryHelper, t } from '../../utils';
+import { TelemetryHelper, getBackendSystemService, t } from '../../utils';
 import {
     fioriToolsAppModAppGenLaunchCmd,
     launchAppGenCmdType,
     SystemAction,
     SystemActionStatus,
     SYSTEMS_EVENT
 } from '../../utils/constants';
-import { BackendSystemKey, SystemService } from '@sap-ux/store';
+import { BackendSystemKey } from '@sap-ux/store';
 import SystemsLogger from '../../utils/logger';
 
 /**
@@ -21,7 +21,7 @@ export const launchAppGenCommandHandler =
     (_context: SystemCommandContext) =>
     async (system: StoredSystemViewNode): Promise<void> => {
         if (system.url) {
-            const systemService = new SystemService(SystemsLogger.logger);
+            const systemService = await getBackendSystemService();
             const backendSystem = await systemService.read(
                 new BackendSystemKey({ url: system.url, client: system.client })
             );

packages/sap-systems-ext/src/commands/system/show.ts

@@ -1,10 +1,9 @@
 import type { StoredSystemViewNode, SystemCommandContext } from '../../types/system';
-import { BackendSystemKey, SystemService, type BackendSystem } from '@sap-ux/store';
+import { BackendSystemKey, type BackendSystem, type Service } from '@sap-ux/store';
 import { window } from 'vscode';
 import { SystemPanel } from '../../panel';
-import { TelemetryHelper, t } from '../../utils';
+import { TelemetryHelper, getBackendSystemService, t } from '../../utils';
 import { SystemAction, LaunchViewStatus, SystemPanelViewType, SYSTEMS_EVENT } from '../../utils/constants';
-import SystemsLogger from '../../utils/logger';
 
 /**
  * Returns a command handler function that shows the details of a specified system.
@@ -16,7 +15,7 @@ export const showSystemsCommandHandler =
     (context: SystemCommandContext) =>
     async (system?: StoredSystemViewNode, statusMsg?: string): Promise<void> => {
         try {
-            const systemService = new SystemService(SystemsLogger.logger);
+            const systemService = await getBackendSystemService();
             const backendSystemKey = await getBackendSystemKey(systemService, system);
             const storedBackendSystem = await systemService.read(backendSystemKey);
             if (!storedBackendSystem) {
@@ -41,7 +40,7 @@ export const showSystemsCommandHandler =
  * @returns - the backend system key
  */
 async function getBackendSystemKey(
-    systemService: SystemService,
+    systemService: Service<BackendSystem, BackendSystemKey>,
     system?: StoredSystemViewNode
 ): Promise<BackendSystemKey> {
     if (system) {
@@ -57,7 +56,9 @@ async function getBackendSystemKey(
  * @param systemService - the system service for the store
  * @returns - the selected backend system key
  */
-async function sapSystemDropdownPicker(systemService: SystemService): Promise<BackendSystemKey> {
+async function sapSystemDropdownPicker(
+    systemService: Service<BackendSystem, BackendSystemKey>
+): Promise<BackendSystemKey> {
     const allBackendSystems = await systemService.getAll({ includeSensitiveData: false });
     const quickPickItems = allBackendSystems.map((system) => ({
         label: system.name,

packages/sap-systems-ext/src/panel/system/actions/updateSystem.ts

@@ -1,8 +1,8 @@
 import type { UpdateSystem } from '@sap-ux/sap-systems-ext-types';
 import type { PanelContext } from '../../../types/system';
-import { SystemService, type BackendSystem } from '@sap-ux/store';
+import type { BackendSystem } from '@sap-ux/store';
 import { commands, window } from 'vscode';
-import { getBackendSystem, geti18nOpts, TelemetryHelper, t } from '../../../utils';
+import { getBackendSystem, geti18nOpts, TelemetryHelper, t, getBackendSystemService } from '../../../utils';
 import { updateSystemStatus, validateSystemName } from '../utils';
 import {
     SystemAction,
@@ -11,7 +11,6 @@ import {
     SystemPanelViewType,
     SYSTEMS_EVENT
 } from '../../../utils/constants';
-import SystemsLogger from '../../../utils/logger';
 
 /**
  * This action updates or creates a system based on the provided details.
@@ -87,7 +86,8 @@ async function updateHandler(
     // this requires us to delete the existing system, dispose of the panel, and create and load a new one
     if (panelViewType === SystemPanelViewType.View && !systemExistsInStore && context.backendSystem) {
         context.disposePanel();
-        await new SystemService(SystemsLogger.logger).delete(context.backendSystem);
+        const systemService = await getBackendSystemService();
+        await systemService.delete(context.backendSystem);
         newPanelMsg = t('info.systemUpdated', { system: newSystem.name });
     }
 
@@ -149,7 +149,8 @@ async function saveSystem(
 ): Promise<void> {
     // ensure the user display name is set to the username
     const newBackendSystem = { ...backendSystem, userDisplayName: backendSystem.username };
-    await new SystemService(SystemsLogger.logger).write(newBackendSystem, {
+    const systemService = await getBackendSystemService();
+    await systemService.write(newBackendSystem, {
         force: systemExistsInStore
     });
     const i18nKey = systemPanelViewType === SystemPanelViewType.Create ? 'info.systemSaved' : 'info.systemUpdated';

packages/sap-systems-ext/src/panel/system/utils/validate.ts

@@ -1,6 +1,5 @@
-import { SystemService, type BackendSystem } from '@sap-ux/store';
-import { t } from '../../../utils';
-import SystemsLogger from '../../../utils/logger';
+import type { BackendSystem } from '@sap-ux/store';
+import { getBackendSystemService, t } from '../../../utils';
 
 /**
  * Validates the provided system information.
@@ -25,7 +24,8 @@ export function validateSystemInfo(input: BackendSystem): boolean | string {
  * @throws error if the new name already exists in the store (and is not the current name)
  */
 export async function validateSystemName(newName: string, currentName?: string): Promise<true> {
-    const allSystems = await new SystemService(SystemsLogger.logger).getAll({ includeSensitiveData: false });
+    const systemService = await getBackendSystemService();
+    const allSystems = await systemService.getAll({ includeSensitiveData: false });
     const newSystemName = newName.trim();
 
     const nameExists = allSystems.some(

packages/sap-systems-ext/src/providers/sapSystemsProvider.ts

@@ -1,7 +1,7 @@
 import type { TreeDataProvider, Command, ExtensionContext, Event } from 'vscode';
-import { SystemService, type BackendSystem } from '@sap-ux/store';
+import type { BackendSystem } from '@sap-ux/store';
 import { commands, TreeItem, TreeItemCollapsibleState, Uri, EventEmitter } from 'vscode';
-import { t, getDisplayName } from '../utils';
+import { t, getDisplayName, getBackendSystemService } from '../utils';
 import { SystemCommands } from '../utils/constants';
 import SystemsLogger from '../utils/logger';
 
@@ -113,7 +113,7 @@ export class SapSystemsProvider implements TreeDataProvider<TreeItem> {
         let systems: BackendSystem[] = [];
         try {
             await commands.executeCommand('setContext', 'sap.ux.tools.sapSystems.treeLoading', true);
-            const systemService = new SystemService(SystemsLogger.logger);
+            const systemService = await getBackendSystemService();
             systems = await systemService.getAll({ includeSensitiveData: false });
             return systems;
         } catch (error) {

packages/sap-systems-ext/src/utils/store.ts

@@ -1,6 +1,19 @@
-import { BackendSystemKey, SystemService, type BackendSystem } from '@sap-ux/store';
+import { getService, BackendSystemKey, type BackendSystem, type Service } from '@sap-ux/store';
 import SystemsLogger from './logger';
 
+/**
+ *  Get the backend system service instance.
+ *
+ * @returns the backend system service instance
+ */
+export async function getBackendSystemService(): Promise<Service<BackendSystem, BackendSystemKey>> {
+    const backendService = await getService<BackendSystem, BackendSystemKey>({
+        logger: SystemsLogger.logger,
+        entityName: 'system'
+    });
+    return backendService;
+}
+
 /**
  * Fetches a backend system based on the provided system details.
  *
@@ -14,7 +27,7 @@ export async function getBackendSystem(system: { url: string; client?: string })
         url: system.url,
         client: system?.client
     });
-    const systemService = new SystemService(SystemsLogger.logger);
+    const systemService = await getBackendSystemService();
     const backendSystem = await systemService.read(backendSystemKey);
     return backendSystem;
 }

packages/sap-systems-ext/test/unit/commands/system/delete.test.ts

@@ -9,7 +9,7 @@ const systemServiceDeleteMock = jest.fn();
 
 jest.mock('@sap-ux/store', () => ({
     ...jest.requireActual('@sap-ux/store'),
-    SystemService: jest.fn().mockImplementation(() => ({
+    getService: jest.fn().mockImplementation(() => ({
         read: systemServiceReadMock,
         delete: systemServiceDeleteMock
     }))

packages/sap-systems-ext/test/unit/commands/system/import.test.ts

@@ -9,7 +9,7 @@ const systemServiceReadMock = jest.fn();
 
 jest.mock('@sap-ux/store', () => ({
     ...jest.requireActual('@sap-ux/store'),
-    SystemService: jest.fn().mockImplementation(() => ({
+    getService: jest.fn().mockImplementation(() => ({
         read: systemServiceReadMock
     }))
 }));