fix: Update configuration controller, DTO, and tests for sandbox audit functionality

Author: Kanishka

src/controllers/configuration.js

@@ -88,9 +88,7 @@ function ConfigurationController(ctx) {
     // eslint-disable-next-line no-console
     console.log('[getLatest] Configuration version:', configuration.getVersion());
     // eslint-disable-next-line no-console
-    console.log('[getLatest] Configuration state:', configuration.state);
-    // eslint-disable-next-line no-console
-    console.log('[getLatest] Configuration state.sandboxAudits:', configuration.state?.sandboxAudits);
+    console.log('[getLatest] Configuration getSandboxAudits():', configuration.getSandboxAudits());
     const result = ConfigurationDto.toJSON(configuration);
     // eslint-disable-next-line no-console
     console.log('[getLatest] DTO result includes sandboxAudits:', !!result.sandboxAudits);
@@ -120,11 +118,6 @@ function ConfigurationController(ctx) {
         return notFound('Configuration not found');
       }
 
-      // Ensure state exists before updating
-      if (!config.state) {
-        config.state = {};
-      }
-
       // Update sandbox configurations for each audit type
       Object.keys(sandboxConfigs).forEach((auditType) => {
         // eslint-disable-next-line no-console
@@ -134,7 +127,7 @@ function ConfigurationController(ctx) {
 
       // Save the updated configuration
       // eslint-disable-next-line no-console
-      console.log('Saving updated configuration with sandbox audits:', config.state?.sandboxAudits);
+      console.log('Saving updated configuration with sandbox audits:', config.getSandboxAudits());
       await config.save();
       // eslint-disable-next-line no-console
       console.log('[updateSandboxConfig] Configuration saved successfully');

src/dto/configuration.js

@@ -22,16 +22,16 @@ export const ConfigurationDto = {
    */
   toJSON: (configuration) => {
     // eslint-disable-next-line no-console
-    console.log('[ConfigurationDto] Configuration state?.sandboxAudits:', configuration.state?.sandboxAudits);
+    console.log('[ConfigurationDto] Configuration getSandboxAudits():', configuration.getSandboxAudits());
 
     const result = {
       version: configuration.getVersion(),
       jobs: configuration.getJobs(),
       ...(configuration.getHandlers() ? { handlers: configuration.getHandlers() } : {}),
       queues: configuration.getQueues(),
       ...(configuration.getSlackRoles() ? { slackRoles: configuration.getSlackRoles() } : {}),
-      ...(configuration.state?.sandboxAudits
-        ? { sandboxAudits: configuration.state.sandboxAudits }
+      ...(configuration.getSandboxAudits()
+        ? { sandboxAudits: configuration.getSandboxAudits() }
         : {}),
     };
     return result;

test/controllers/configurations.test.js

@@ -40,6 +40,8 @@ describe('Configurations Controller', () => {
       getSlackRoles: () => {},
       getEnabledSandboxAudits: () => [],
       getSandboxAuditConfig: () => null,
+      getSandboxAudits: () => null,
+      setSandboxAudits: () => {},
     },
     {
       getVersion: () => 2,
@@ -89,6 +91,13 @@ describe('Configurations Controller', () => {
         if (auditType === 'meta-tags') return { expire: '15' };
         return null;
       },
+      getSandboxAudits: () => ({
+        enabledAudits: {
+          cwv: { expire: '10' },
+          'meta-tags': { expire: '15' },
+        },
+      }),
+      setSandboxAudits: () => {},
       state: {
         sandboxAudits: {
           enabledAudits: {
@@ -264,6 +273,8 @@ describe('Configurations Controller', () => {
       mockConfig = {
         state: {},
         updateSandboxAuditConfig: sandbox.stub(),
+        getSandboxAudits: sandbox.stub().returns({ enabledAudits: {} }),
+        setSandboxAudits: sandbox.stub(),
         save: sandbox.stub().resolves(mockConfig),
       };
 
@@ -384,27 +395,28 @@ describe('Configurations Controller', () => {
       expect(error.message).to.include('Error updating sandbox configuration: Save failed');
     });
 
-    it('should handle configuration with undefined state', async () => {
+    it('should handle configuration with null sandbox audits', async () => {
       context.attributes.authInfo.withProfile({ is_admin: true });
 
-      // Create a config without state property to test our fix
-      const configWithoutState = {
+      // Create a config with null sandbox audits to test our fix
+      const configWithNullSandboxAudits = {
         updateSandboxAuditConfig: sandbox.stub(),
+        getSandboxAudits: sandbox.stub().returns(null),
+        setSandboxAudits: sandbox.stub(),
         save: sandbox.stub().resolves(),
       };
-      mockDataAccess.Configuration.findLatest.resolves(configWithoutState);
+      mockDataAccess.Configuration.findLatest.resolves(configWithNullSandboxAudits);
       configurationsController = ConfigurationsController(context);
 
       const result = await configurationsController.updateSandboxConfig({
         data: { sandboxConfigs: { cwv: { expire: '10' } } },
       });
       const response = await result.json();
 
-      // Should initialize state and succeed
+      // Should succeed with null sandbox audits
       expect(result.status).to.equal(200);
-      expect(configWithoutState.state).to.deep.equal({});
-      expect(configWithoutState.updateSandboxAuditConfig).to.have.been.calledWith('cwv', { expire: '10' });
-      expect(configWithoutState.save).to.have.been.called;
+      expect(configWithNullSandboxAudits.updateSandboxAuditConfig).to.have.been.calledWith('cwv', { expire: '10' });
+      expect(configWithNullSandboxAudits.save).to.have.been.called;
       expect(response.message).to.equal('Sandbox configurations updated successfully');
     });
   });