add testCommentsAndPassThroughCoexist

Author: rpg600

tests/PhpSpreadsheetTests/Writer/Xlsx/DrawingPassThroughTest.php

@@ -440,4 +440,94 @@ public function testDrawingPassThroughEnabledFlagIsSetCorrectly(): void
 
         $spreadsheet2->disconnectWorksheets();
     }
+
+    /**
+     * Test that VML drawings (used by comments) and DrawingML (used by shapes/images)
+     * coexist without interference when pass-through is enabled.
+     * This addresses the concern that comments use the drawings folder with VML files.
+     * The template file already contains a comment in D1, so this test verifies that
+     * existing comments are preserved AND new comments can be added.
+     */
+    public function testCommentsAndPassThroughCoexist(): void
+    {
+        // Load file with drawings (image + shape) and enable pass-through
+        // Note: The template already contains a comment in D1
+        $reader = new XlsxReader();
+        $reader->setEnableDrawingPassThrough(true);
+        $spreadsheet = $reader->load(self::TEMPLATE);
+
+        $sheet = $spreadsheet->getActiveSheet();
+
+        // Verify the existing comment is loaded
+        $existingComment = $sheet->getComment('D1');
+        $existingCommentText = $existingComment->getText()->getPlainText();
+        self::assertNotEmpty($existingCommentText, 'Template should contain a comment in D1');
+
+        // Add a new comment to the sheet
+        $sheet->getComment('A1')->getText()->createText('Test comment with pass-through');
+        $sheet->getComment('A1')->setAuthor('Test Author');
+
+        // Save the file
+        $tempFile = File::temporaryFilename();
+        $writer = new XlsxWriter($spreadsheet);
+        $writer->save($tempFile);
+        $spreadsheet->disconnectWorksheets();
+
+        // Verify the file structure contains both VML (for comments) and DrawingML (for shapes)
+        $zip = new ZipArchive();
+        $zip->open($tempFile);
+
+        // Check for VML drawing (used by comments)
+        $vmlDrawing = $zip->getFromName('xl/drawings/vmlDrawing1.vml');
+        self::assertNotFalse($vmlDrawing, 'VML drawing for comments should exist');
+        self::assertStringContainsString('urn:schemas-microsoft-com:vml', $vmlDrawing, 'VML should contain VML namespace');
+
+        // Check for DrawingML (used by shapes/images)
+        $drawingXml = $zip->getFromName('xl/drawings/drawing1.xml');
+        self::assertNotFalse($drawingXml, 'DrawingML for shapes/images should exist');
+        self::assertStringContainsString('<xdr:sp', $drawingXml, 'DrawingML should contain shape (preserved by pass-through)');
+        self::assertStringContainsString('<xdr:pic', $drawingXml, 'DrawingML should contain image');
+
+        // Check for comments XML (should contain both existing and new comments)
+        $commentsXml = $zip->getFromName('xl/comments1.xml');
+        self::assertNotFalse($commentsXml, 'Comments XML should exist');
+        self::assertStringContainsString('Test comment with pass-through', $commentsXml, 'New comment (A1) should be in comments XML');
+        self::assertStringContainsString($existingCommentText, $commentsXml, 'Existing comment (D1) should be preserved in comments XML');
+
+        $zip->close();
+
+        // Reload and verify everything is still intact
+        $reader2 = new XlsxReader();
+        $reader2->setEnableDrawingPassThrough(true);
+        $spreadsheet2 = $reader2->load($tempFile);
+        $sheet2 = $spreadsheet2->getActiveSheet();
+
+        // Verify both comments are preserved (existing and new)
+        $existingCommentReloaded = $sheet2->getComment('D1');
+        self::assertSame($existingCommentText, $existingCommentReloaded->getText()->getPlainText(), 'Existing comment (D1) should be preserved after reload');
+
+        $newComment = $sheet2->getComment('A1');
+        self::assertSame('Test comment with pass-through', $newComment->getText()->getPlainText(), 'New comment (A1) should be preserved after reload');
+
+        // Verify drawings are still in collection (image only, shape is in pass-through XML)
+        $drawings = $sheet2->getDrawingCollection();
+        self::assertCount(1, $drawings, 'Drawing collection should contain the image');
+
+        // Verify pass-through data still contains shapes
+        $unparsedData = $spreadsheet2->getUnparsedLoadedData();
+        $codeName = $sheet2->getCodeName();
+        self::assertArrayHasKey('sheets', $unparsedData);
+        self::assertIsArray($unparsedData['sheets']);
+        self::assertArrayHasKey($codeName, $unparsedData['sheets']);
+        self::assertIsArray($unparsedData['sheets'][$codeName]);
+        self::assertArrayHasKey('Drawings', $unparsedData['sheets'][$codeName]);
+        $drawings = $unparsedData['sheets'][$codeName]['Drawings'];
+        self::assertIsArray($drawings);
+        $drawingXmlFromData = reset($drawings);
+        self::assertIsString($drawingXmlFromData);
+        self::assertStringContainsString('<xdr:sp', $drawingXmlFromData, 'Pass-through XML should still contain shapes');
+
+        $spreadsheet2->disconnectWorksheets();
+        unlink($tempFile);
+    }
 }