Merge pull request #333 from code-dot-org/molly/global-context-part-2

Part 2 of adding global context

Author: molly-moen

org-code-javabuilder/lib/src/main/java/dev/javabuilder/LocalMetricClient.java

@@ -1,11 +1,12 @@
 package dev.javabuilder;
 
+import org.code.protocol.JavabuilderSharedObject;
 import org.code.protocol.MetricClient;
 
 // Local implementation of MetricClient. Since all we can do locally
 // is log and we already have regular logging for every metric,
 // these methods do nothing.
-public class LocalMetricClient implements MetricClient {
+public class LocalMetricClient extends JavabuilderSharedObject implements MetricClient {
   @Override
   public void publishSevereError() {}
 

org-code-javabuilder/lib/src/main/java/dev/javabuilder/LocalSystemExitHelper.java

@@ -2,13 +2,16 @@
 
 import org.code.javabuilder.PerformanceTracker;
 import org.code.javabuilder.SystemExitHelper;
+import org.code.protocol.JavabuilderContext;
 
 public class LocalSystemExitHelper implements SystemExitHelper {
 
   @Override
   public void exit(int status) {
-    PerformanceTracker.getInstance().trackInstanceEnd();
-    PerformanceTracker.getInstance().logPerformance();
+    PerformanceTracker performanceTracker =
+        (PerformanceTracker) JavabuilderContext.getInstance().get(PerformanceTracker.class);
+    performanceTracker.trackInstanceEnd();
+    performanceTracker.logPerformance();
     System.exit(status);
   }
 }

org-code-javabuilder/lib/src/main/java/dev/javabuilder/WebSocketServer.java

@@ -54,16 +54,18 @@ public WebSocketServer() {
   public void onOpen(Session session) {
     this.finishedExecution = false;
     JavabuilderContext.getInstance().destroyAndReset();
-    PerformanceTracker.resetTracker();
-    PerformanceTracker.getInstance().trackInstanceStart(Clock.systemUTC().instant());
+    PerformanceTracker performanceTracker = new PerformanceTracker();
+    JavabuilderContext.getInstance().register(PerformanceTracker.class, performanceTracker);
+    performanceTracker.trackInstanceStart(Clock.systemUTC().instant());
     // Decode the authorization token
     String token = session.getRequestParameterMap().get("Authorization").get(0);
     Base64.Decoder decoder = Base64.getDecoder();
     String payload = new String(decoder.decode(token.split("\\.")[1]));
     JSONObject queryInput = new JSONObject(payload);
 
     final String connectionId = "LocalhostWebSocketConnection";
-    final String levelId = queryInput.getString("level_id");
+    final String levelId =
+        queryInput.has("level_id") ? String.valueOf(queryInput.getInt("level_id")) : "noneProvided";
     final String channelId =
         queryInput.has("channel_id") ? queryInput.getString("channel_id") : "noneProvided";
     final ExecutionType executionType =
@@ -77,8 +79,8 @@ public void onOpen(Session session) {
     // turn off the default console logger
     this.logger.setUseParentHandlers(false);
 
-    MetricClient metricClient = new LocalMetricClient();
-    MetricClientManager.create(metricClient);
+    LocalMetricClient metricClient = new LocalMetricClient();
+    JavabuilderContext.getInstance().register(MetricClient.class, metricClient);
 
     Properties.setConnectionId(connectionId);
 
@@ -89,7 +91,6 @@ public void onOpen(Session session) {
     if (executionType == ExecutionType.TEST) {
       outputAdapter = new UserTestOutputAdapter(websocketOutputAdapter);
     }
-    final LifecycleNotifier lifecycleNotifier = new LifecycleNotifier();
 
     final ExceptionHandler exceptionHandler =
         new ExceptionHandler(outputAdapter, new LocalSystemExitHelper());
@@ -108,7 +109,6 @@ public void onOpen(Session session) {
                         compileList,
                         new LocalTempDirectoryManager(),
                         contentManager,
-                        lifecycleNotifier,
                         new LocalSystemExitHelper());
                 codeExecutionManager.execute();
               } catch (Throwable e) {
@@ -134,14 +134,17 @@ public void onOpen(Session session) {
   @OnClose
   public void myOnClose() {
     Logger.getLogger(MAIN_LOGGER).info("WebSocket closed.");
-    PerformanceTracker.getInstance().logPerformance();
+    PerformanceTracker performanceTracker =
+        (PerformanceTracker) JavabuilderContext.getInstance().get(PerformanceTracker.class);
+    performanceTracker.logPerformance();
     // If the websocket was closed before execution was finished, make sure we clean up.
     if (!this.finishedExecution) {
       if (codeExecutionManager != null) {
         this.codeExecutionManager.shutDown();
       }
       this.logger.removeHandler(this.logHandler);
     }
+    JavabuilderContext.getInstance().destroyAndReset();
   }
 
   /**

org-code-javabuilder/lib/src/main/java/org/code/javabuilder/AWSMetricClient.java

@@ -3,11 +3,12 @@
 import com.amazonaws.services.cloudwatch.AmazonCloudWatch;
 import com.amazonaws.services.cloudwatch.AmazonCloudWatchClientBuilder;
 import com.amazonaws.services.cloudwatch.model.*;
+import org.code.protocol.JavabuilderSharedObject;
 import org.code.protocol.MetricClient;
 
 // Metric Client which published metrics to AWS CloudWatch.
 // Requires cloudwatch:PutMetricData permission on the Lambda.
-public class AWSMetricClient implements MetricClient {
+public class AWSMetricClient extends JavabuilderSharedObject implements MetricClient {
   private final AmazonCloudWatch cloudWatchClient;
   private final Dimension functionNameDimension;
 

org-code-javabuilder/lib/src/main/java/org/code/javabuilder/AWSSystemExitHelper.java

@@ -7,6 +7,7 @@
 import com.amazonaws.services.apigatewaymanagementapi.model.GoneException;
 import java.util.logging.Handler;
 import java.util.logging.Logger;
+import org.code.protocol.JavabuilderContext;
 
 public class AWSSystemExitHelper implements SystemExitHelper {
   private final String connectionId;
@@ -19,8 +20,10 @@ public AWSSystemExitHelper(String connectionId, AmazonApiGatewayManagementApi ap
 
   @Override
   public void exit(int status) {
-    PerformanceTracker.getInstance().trackInstanceEnd();
-    PerformanceTracker.getInstance().logPerformance();
+    PerformanceTracker performanceTracker =
+        (PerformanceTracker) JavabuilderContext.getInstance().get(PerformanceTracker.class);
+    performanceTracker.trackInstanceEnd();
+    performanceTracker.logPerformance();
     this.cleanUpResources();
     System.exit(status);
   }

org-code-javabuilder/lib/src/main/java/org/code/javabuilder/CodeExecutionManager.java

@@ -23,7 +23,6 @@ public class CodeExecutionManager {
   private final ExecutionType executionType;
   private final List<String> compileList;
   private final TempDirectoryManager tempDirectoryManager;
-  private final LifecycleNotifier lifecycleNotifier;
   private final ContentManager contentManager;
   private final SystemExitHelper systemExitHelper;
   private final CodeBuilderRunnableFactory codeBuilderRunnableFactory;
@@ -53,7 +52,6 @@ public CodeExecutionManager(
       List<String> compileList,
       TempDirectoryManager tempDirectoryManager,
       ContentManager contentManager,
-      LifecycleNotifier lifecycleNotifier,
       SystemExitHelper systemExitHelper) {
     this(
         fileLoader,
@@ -62,7 +60,6 @@ public CodeExecutionManager(
         executionType,
         compileList,
         tempDirectoryManager,
-        lifecycleNotifier,
         contentManager,
         systemExitHelper,
         new CodeBuilderRunnableFactory());
@@ -75,7 +72,6 @@ public CodeExecutionManager(
       ExecutionType executionType,
       List<String> compileList,
       TempDirectoryManager tempDirectoryManager,
-      LifecycleNotifier lifecycleNotifier,
       ContentManager contentManager,
       SystemExitHelper systemExitHelper,
       CodeBuilderRunnableFactory codeBuilderRunnableFactory) {
@@ -85,7 +81,6 @@ public CodeExecutionManager(
     this.executionType = executionType;
     this.compileList = compileList;
     this.tempDirectoryManager = tempDirectoryManager;
-    this.lifecycleNotifier = lifecycleNotifier;
     this.contentManager = contentManager;
     this.systemExitHelper = systemExitHelper;
     this.codeBuilderRunnableFactory = codeBuilderRunnableFactory;
@@ -127,10 +122,7 @@ private void onPreExecute() throws InternalServerException {
     // Create the Global Protocol instance
     GlobalProtocol protocolInstance =
         new GlobalProtocol(
-            this.outputAdapter,
-            new InputHandler(this.inputAdapter),
-            this.lifecycleNotifier,
-            this.contentManager);
+            this.outputAdapter, new InputHandler(this.inputAdapter), this.contentManager);
     JavabuilderContext.getInstance().register(GlobalProtocol.class, protocolInstance);
 
     // Create temp folder
@@ -152,14 +144,12 @@ private void onPreExecute() throws InternalServerException {
 
   /**
    * Post-execution steps: 1) Notify listeners, 2) clean up global resources, 3) clear temporary
-   * folder, 4) close custom in/out streams, 5) Replace System.in/out with original in/out, 6)
-   * Destroy Global Protocol
+   * folder, 4) close custom in/out streams, 5) Replace System.in/out with original in/out
    */
   private void onPostExecute() {
     // Notify user and listeners
     LambdaUtils.safelySendMessage(
         this.outputAdapter, new StatusMessage(StatusMessageKey.EXITED), false);
-    this.lifecycleNotifier.onExecutionEnded();
     JavabuilderContext.getInstance().onExecutionEnded();
     try {
       // Close custom input/output streams
@@ -174,10 +164,9 @@ private void onPostExecute() {
       LoggerUtils.logTrackingException(e);
       this.systemExitHelper.exit(TEMP_DIRECTORY_CLEANUP_ERROR_CODE);
     } finally {
-      // Replace System in/out with original System in/out and reset JavabuilderContext
+      // Replace System in/out with original System in/out
       System.setIn(this.systemInputStream);
       System.setOut(this.systemOutputStream);
-      JavabuilderContext.getInstance().destroyAndReset();
       this.isInitialized = false;
     }
   }

org-code-javabuilder/lib/src/main/java/org/code/javabuilder/JavaRunner.java

@@ -6,10 +6,7 @@
 import java.util.List;
 import java.util.stream.Collectors;
 import org.code.javabuilder.util.JarUtils;
-import org.code.protocol.JavabuilderException;
-import org.code.protocol.OutputAdapter;
-import org.code.protocol.StatusMessage;
-import org.code.protocol.StatusMessageKey;
+import org.code.protocol.*;
 
 /** The class that executes the student's code */
 public class JavaRunner {
@@ -93,11 +90,13 @@ private boolean run(
             classLoaderUrls, JavaRunner.class.getClassLoader(), classNames, permissionLevel);
 
     boolean runResult;
-    PerformanceTracker.getInstance().trackUserCodeStart();
+    PerformanceTracker performanceTracker =
+        (PerformanceTracker) JavabuilderContext.getInstance().get(PerformanceTracker.class);
+    performanceTracker.trackUserCodeStart();
     try {
       runResult = runner.run(urlClassLoader);
     } finally {
-      PerformanceTracker.getInstance().trackUserCodeEnd();
+      performanceTracker.trackUserCodeEnd();
     }
 
     try {

org-code-javabuilder/lib/src/main/java/org/code/javabuilder/LambdaRequestHandler.java

@@ -98,8 +98,8 @@ public LambdaRequestHandler() {
   @Override
   public String handleRequest(Map<String, String> lambdaInput, Context context) {
     this.isSessionInitialized = false;
-    this.trackStartupPerformance();
     JavabuilderContext.getInstance().destroyAndReset();
+    this.trackStartupPerformance();
 
     // TODO: Because we reference the logger object throughout the codebase via
     // Logger.getLogger(MAIN_LOGGER), we need to set it up in the same scope as code execution to
@@ -181,8 +181,8 @@ private void initialize(Map<String, String> lambdaInput, String connectionId, Co
 
     Properties.setConnectionId(connectionId);
 
-    MetricClient metricClient = new AWSMetricClient(context.getFunctionName());
-    MetricClientManager.create(metricClient);
+    AWSMetricClient metricClient = new AWSMetricClient(context.getFunctionName());
+    JavabuilderContext.getInstance().register(MetricClient.class, metricClient);
 
     // Dashboard assets are only accessible if the dashboard domain is not localhost
     Properties.setCanAccessDashboardAssets(canAccessDashboardAssets);
@@ -196,12 +196,13 @@ private void initialize(Map<String, String> lambdaInput, String connectionId, Co
 
   private void trackStartupPerformance() {
     final Instant instanceStart = Clock.systemUTC().instant();
-    PerformanceTracker.resetTracker();
+    PerformanceTracker performanceTracker = new PerformanceTracker();
+    JavabuilderContext.getInstance().register(PerformanceTracker.class, performanceTracker);
     if (coldBoot) {
-      PerformanceTracker.getInstance().trackColdBoot(COLD_BOOT_START, COLD_BOOT_END, instanceStart);
+      performanceTracker.trackColdBoot(COLD_BOOT_START, COLD_BOOT_END, instanceStart);
       coldBoot = false;
     } else {
-      PerformanceTracker.getInstance().trackInstanceStart(instanceStart);
+      performanceTracker.trackInstanceStart(instanceStart);
     }
   }
 
@@ -260,7 +261,6 @@ private CodeExecutionManager createExecutionManager(
     final List<String> compileList = JSONUtils.listFromJSONObjectMember(options, "compileList");
 
     final AWSInputAdapter inputAdapter = new AWSInputAdapter(SQS_CLIENT, queueUrl, queueName);
-    final LifecycleNotifier lifecycleNotifier = new LifecycleNotifier();
     final AWSContentManager contentManager =
         new AWSContentManager(
             S3_CLIENT, CONTENT_BUCKET_NAME, javabuilderSessionId, CONTENT_BUCKET_URL, context);
@@ -273,7 +273,6 @@ private CodeExecutionManager createExecutionManager(
         compileList,
         tempDirectoryManager,
         contentManager,
-        lifecycleNotifier,
         new AWSSystemExitHelper(connectionId, API_CLIENT));
   }
 
@@ -303,8 +302,11 @@ private void shutDown(
       }
     }
 
-    PerformanceTracker.getInstance().trackInstanceEnd();
-    PerformanceTracker.getInstance().logPerformance();
+    PerformanceTracker performanceTracker =
+        (PerformanceTracker) JavabuilderContext.getInstance().get(PerformanceTracker.class);
+    performanceTracker.trackInstanceEnd();
+    performanceTracker.logPerformance();
+    JavabuilderContext.getInstance().destroyAndReset();
 
     this.cleanUpAWSResources(connectionId, api);
 

org-code-javabuilder/lib/src/main/java/org/code/javabuilder/PerformanceTracker.java

@@ -5,9 +5,7 @@
 import java.time.Clock;
 import java.time.Instant;
 import java.util.logging.Logger;
-import org.code.protocol.LoggerConstants;
-import org.code.protocol.MetricClient;
-import org.code.protocol.MetricClientManager;
+import org.code.protocol.*;
 import org.json.JSONObject;
 
 /**
@@ -19,7 +17,7 @@
  * Then, at the end of the project execution, PerformanceTracker.logPerformance can be invoked in
  * order to create a single record of the performance of the project execution.
  */
-public class PerformanceTracker {
+public class PerformanceTracker extends JavabuilderSharedObject {
   private static final String FIRST_INSTANCE = "firstInstance";
   private static final String COLD_BOOT_START = "coldBootStart";
   private static final String COLD_BOOT_END = "coldBootEnd";
@@ -35,25 +33,11 @@ public class PerformanceTracker {
   private static final String CLEANUP_TIME = "cleanupTime";
   private static final String TYPE = "performanceReport";
   private final JSONObject logs;
-  private static PerformanceTracker instance;
 
-  private PerformanceTracker() {
+  public PerformanceTracker() {
     this.logs = new JSONObject();
   }
 
-  public static PerformanceTracker getInstance() {
-    if (PerformanceTracker.instance == null) {
-      PerformanceTracker.instance = new PerformanceTracker();
-    }
-
-    return PerformanceTracker.instance;
-  }
-
-  /** Clear out all previous performance logs */
-  public static void resetTracker() {
-    PerformanceTracker.instance = new PerformanceTracker();
-  }
-
   public void trackColdBoot(Instant coldBootStart, Instant coldBootEnd, Instant instanceStart) {
     logs.put(COLD_BOOT_START, coldBootStart.toEpochMilli());
     logs.put(COLD_BOOT_END, coldBootEnd.toEpochMilli());
@@ -93,7 +77,8 @@ public void trackInstanceEnd() {
 
   public void logPerformance() {
     logs.put(LoggerConstants.TYPE, TYPE);
-    MetricClient metricClient = MetricClientManager.getInstance().getMetricClient();
+    MetricClient metricClient =
+        (MetricClient) JavabuilderContext.getInstance().get(MetricClient.class);
     if (!logs.isNull(COLD_BOOT_START) && !logs.isNull(COLD_BOOT_END)) {
       long coldBootTime = logs.getLong(COLD_BOOT_END) - logs.getLong(COLD_BOOT_START);
       logs.put(COLD_BOOT_TIME, coldBootTime);
@@ -119,6 +104,5 @@ public void logPerformance() {
     }
 
     Logger.getLogger(MAIN_LOGGER).info(logs.toString());
-    PerformanceTracker.instance = null;
   }
 }

org-code-javabuilder/lib/src/main/java/org/code/javabuilder/UserCodeCompiler.java

@@ -42,11 +42,13 @@ public void compileProgram() throws InternalServerException, UserInitiatedExcept
     this.outputAdapter.sendMessage(new StatusMessage(StatusMessageKey.COMPILING));
     DiagnosticCollector<JavaFileObject> diagnostics = new DiagnosticCollector<>();
 
-    PerformanceTracker.getInstance().trackCompileStart();
+    PerformanceTracker performanceTracker =
+        (PerformanceTracker) JavabuilderContext.getInstance().get(PerformanceTracker.class);
+    performanceTracker.trackCompileStart();
     CompilationTask task = getCompilationTask(diagnostics);
 
     boolean success = task.call();
-    PerformanceTracker.getInstance().trackCompileEnd();
+    performanceTracker.trackCompileEnd();
 
     // diagnostics will include any compiler errors
     for (Diagnostic<? extends JavaFileObject> diagnostic : diagnostics.getDiagnostics()) {