Service Agent Factory - Hardcoded Agents

washi · December 15, 2021, 3:49pm

At the moment ServiceAgentFactory.GetAgent contains a huge switch iterating through a large number of agents. But the agents could be specified in the model and the switch could be dropped.

github.com

origam/origam/blob/08ec345c1d124bcf5a7ad015a56780755958f7f6/backend/Origam.Workbench.Services/ServiceAgentFactory.cs#L94-L163

    
      
          switch (serviceName)
          {
              case "DataService":
                  result = (IServiceAgent)Reflector.InvokeObject("Origam.Workflow.DataServiceAgent", "Origam.Workflow");
                  break;
          
          
    case "DataTransformationService":
                  result = (IServiceAgent)Reflector.InvokeObject("Origam.Workflow.TransformationAgent", "Origam.Workflow");
                  break;
          
          
    case "Simplicor.WarehouseService":
                  result = (IServiceAgent)Reflector.InvokeObject("Origam.Workflow.SimplicorService.WarehouseServiceAgent", "Origam.Workflow.SimplicorService");
                  break;
          
          
    case "MailService":
                  result = (IServiceAgent)Reflector.InvokeObject("Origam.Workflow.MailServiceAgent", "Origam.Workflow");
                  break;
          
          
    case "ReportService":
                  result = (IServiceAgent)Reflector.InvokeObject("Origam.Workflow.ReportServiceAgent", "Origam.Workflow");

This file has been truncated. show original

Is there a reason why it is done this way?

tvavrda · December 16, 2021, 1:56pm

Currently not. It became like this in an iterative way and the time came when we could just push the class names from the code to the model.

jsusen · January 10, 2024, 9:23am

Removing the switch is not a straigh forward process. I tried moving the class paths to the model and deleting everyting except for the default case. This resulted in a problem in the ConnectRuntime method:

github.com

origam/origam/blob/38c27cbcc033e33d541f75bbe2e2fbb8839d847d/backend/Origam.OrigamEngine/OrigamEngine.cs#L137


      
          			log.Info("Connecting ORIGAM Runtime.");
          			AppDomain.CurrentDomain.SetPrincipalPolicy(
                          PrincipalPolicy.NoPrincipal);
                      SecurityManager.SetServerIdentity();
          			SetActiveConfiguration(configName);
          			var settings = ConfigurationManager.GetActiveConfiguration();
          			if (customServiceFactory != null)
          			{
          				serviceFactory = customServiceFactory;
          			}
          			serviceFactory.InitializeServices();
          			SchemaService schema 
                          = ServiceManager.Services.GetService<SchemaService>();
          			log.Info("Loading model " + settings.Name + ", Package ID: " + settings.DefaultSchemaExtensionId.ToString());
          			schema.LoadSchema(settings.DefaultSchemaExtensionId);
          			log.Info("Loading model finished successfully. Version loaded: " + schema.ActiveExtension.Version);
          			InitializeSchemaItemProviders(schema);
          			// upgrade database
          			if (settings.ExecuteUpgradeScriptsOnStart)
          			{
          				log.Info("Checking database version.");

The GetAgent method from the ServiceAgentFactory is called in the InitializeServices method. And fails with NullReferenceException.

It looks like moving the InitializeSchemaItemProviders before the InitializeServices method might help but it does not. InitializeSchemaItemProviders depends on some services…

So i moved the services outside of the InitializeServices method. That helped but then another exception wast encountered.

This time in OrigamXmlManager.

This seems to be more complicated than originally thought so I shelved this task.

tvavrda · January 11, 2024, 6:01am

Cannot we move at least some of them? I guess we only have a problem with somethimg like DataService.