chore(logging): Implement requested changes to improve logging

Author: EmmanuelStan12

JShellAPI/src/main/java/org/togetherjava/jshellapi/service/DockerService.java

@@ -58,7 +58,7 @@ public DockerService(Config config, StartupScriptsService startupScriptsService)
             pullImage();
         }
         cleanupLeftovers(WORKER_UNIQUE_ID);
-        executor.submit(() -> initializeCachedContainer(StartupScriptId.EMPTY));
+        executor.submit(() -> initializeCachedContainer(StartupScriptId.CUSTOM_DEFAULT));
     }
 
     private void cleanupLeftovers(UUID currentId) {
@@ -106,6 +106,7 @@ private void pullImage() throws InterruptedException {
      * @return The ID of the created container.
      */
     private String createContainer(String name) {
+        LOGGER.debug("Creating container '{}'", name);
         HostConfig hostConfig = HostConfig.newHostConfig()
             .withAutoRemove(true)
             .withInit(true)
@@ -137,10 +138,13 @@ private String createContainer(String name) {
      *
      * @param name Name of the container.
      * @param startupScriptId Script to initialize the container with.
+     * @throws IOException if an I/O error occurs.
      * @return The ContainerState of the newly created container.
      */
     public ContainerState initializeContainer(String name, StartupScriptId startupScriptId)
             throws IOException {
+        LOGGER.info("Initializing container '{}' with Startup script ID: {}", name,
+                startupScriptId);
         if (startupScriptId == null || cachedContainers.isEmpty()
                 || !cachedContainers.containsKey(startupScriptId)) {
             String containerId = createContainer(name);
@@ -159,27 +163,34 @@ public ContainerState initializeContainer(String name, StartupScriptId startupSc
      * @param startupScriptId Script to initialize the container with.
      */
     private void initializeCachedContainer(StartupScriptId startupScriptId) {
-        String containerName = cachedContainerName();
+        LOGGER.info("Initializing cached container with Startup script ID: {}", startupScriptId);
+        String containerName = newCachedContainerName();
         String id = createContainer(containerName);
         startContainer(id);
 
         try {
             ContainerState containerState = setupContainerWithScript(id, startupScriptId);
             cachedContainers.put(startupScriptId, containerState);
         } catch (IOException e) {
+            LOGGER.error("Could not initialize container '{}'", id, e);
             killContainerByName(containerName);
             throw new RuntimeException(e);
         }
     }
 
     /**
+     * Setup container with startup script and also initializes input and output streams for the
+     * container.
+     *
      * @param containerId The id of the container
      * @param startupScriptId The startup script id of the session
      * @return ContainerState of the spawned container.
      * @throws IOException if an I/O error occurs
      */
     private ContainerState setupContainerWithScript(String containerId,
             StartupScriptId startupScriptId) throws IOException {
+        LOGGER.info("Setting up container with id '{}' with Startup script ID: {}", containerId,
+                startupScriptId);
         startContainer(containerId);
         PipedInputStream containerInput = new PipedInputStream();
         BufferedWriter writer =
@@ -201,9 +212,13 @@ private ContainerState setupContainerWithScript(String containerId,
      * @param containerId the ID of the container to start
      */
     private void startContainer(String containerId) {
-        if (!isContainerRunning(containerId)) {
-            client.startContainerCmd(containerId).exec();
+        boolean isRunning = isContainerRunning(containerId);
+        if (isRunning) {
+            LOGGER.debug("Container '{}' is already running.", containerId);
+            return;
         }
+        LOGGER.debug("Container '{}' is not running. Starting it now.", containerId);
+        client.startContainerCmd(containerId).exec();
     }
 
     /**
@@ -233,7 +248,7 @@ public void onNext(Frame object) {
                         String payloadString =
                                 new String(object.getPayload(), StandardCharsets.UTF_8);
                         if (object.getStreamType() == StreamType.STDOUT) {
-                            pipeOut.write(object.getPayload()); // Write stdout data to pipeOut
+                            pipeOut.write(object.getPayload());
                         } else {
                             LOGGER.warn("Received STDERR from container {}: {}", containerId,
                                     payloadString);
@@ -257,7 +272,7 @@ public boolean isContainerRunning(String containerId) {
         return Boolean.TRUE.equals(containerResponse.getState().getRunning());
     }
 
-    private String cachedContainerName() {
+    private String newCachedContainerName() {
         return "cached_session_" + UUID.randomUUID();
     }