wsd: support PDF comment saving during unload with test

PDFs are view_comment type documents where
editing is not supported, but adding comments
are. This means that we do get ModifiedStatus=true
but we never get ModifiedStatus=false after
.uno:Save. This is because the save command is
handled in a special way in Core by invoking
save-as instead, which doesn't reset the
ModifiedStatus.

The issue with this was that DocBroker was
stuck on trying to save the document
before unloading, thinking it was modified
due to the stuck ModifiedStatus. Here,
we change the definition of isPossiblyModified()
to ignore the ModifiedStatus for such documents.
Instead, we rely on the last save being successful
and that no new user input exists past the last
save request.

In addition, we now have a new Cypress test
that reproduced the failure without the fix
and now passes with the fix.

Change-Id: Ida9d486ac93a588b9007c5e4583d8bf3c090a62d
Signed-off-by: Ashod Nakashian <ashod.nakashian@collabora.co.uk>

2 files changed, 32 insertions, 9 deletions

diff --git a/cypress_test/integration_tests/common/desktop_helper.js b/cypress_test/integration_tests/common/desktop_helper.js
index 4b96877565..0df91ecf23 100644
--- a/cypress_test/integration_tests/common/desktop_helper.js
+++ b/cypress_test/integration_tests/common/desktop_helper.js
@@ -276,11 +276,14 @@ function insertMultipleComment(docType, numberOfComments = 1, isMobile = false)
 	if (docType === 'calc') {
 		cy.wait(1000);
 	}
-	cy.get('#toolbar-up .w2ui-scroll-right').then($button => {
-		if ($button.is(':visible'))	{
-			$button.click();
-		}
-	});
+
+	if (docType !== 'draw') {
+		cy.get('#toolbar-up .w2ui-scroll-right').then($button => {
+			if ($button.is(':visible'))	{
+				$button.click();
+			}
+		});
+	}
 
 	if (mode === 'notebookbar') {
 		cy.wait(500);
@@ -292,15 +295,19 @@ function insertMultipleComment(docType, numberOfComments = 1, isMobile = false)
 		});
 	}
 
-	if	(docType === 'writer' && mode !== 'notebookbar') {
+	if (docType === 'writer' && mode !== 'notebookbar') {
 		cy.get('#toolbar-up .w2ui-scroll-right').click();
 	}
 
 	for (var n=0;n<numberOfComments;n++) {
 
-		actionOnSelector('insertAnnotation', (selector) => {
-			cy.get(selector).click();
-		});
+		if (docType === 'draw') {
+			cy.get('#menu-insert').click().get('#menu-insertcomment').click();
+		} else {
+			actionOnSelector('insertAnnotation', (selector) => {
+				cy.get(selector).click();
+			});
+		}
 
 		cy.wait(100);
 
diff --git a/cypress_test/integration_tests/desktop/draw/pdf_page_up_down_spec.js b/cypress_test/integration_tests/desktop/draw/pdf_page_up_down_spec.js
index 0d6af1675b..41e7cd5221 100644
--- a/cypress_test/integration_tests/desktop/draw/pdf_page_up_down_spec.js
+++ b/cypress_test/integration_tests/desktop/draw/pdf_page_up_down_spec.js
@@ -1,6 +1,7 @@
 /* global describe it cy require afterEach beforeEach */
 
 var helper = require('../../common/helper');
+var desktopHelper = require('../../common/desktop_helper');
 
 describe('PDF View Tests', function() {
 	var origTestFileName = 'pdf_page_up_down.pdf';
@@ -21,4 +22,19 @@ describe('PDF View Tests', function() {
 		cy.get('#map').type('{pageup}');
 		cy.get('#preview-frame-part-0').should('have.attr', 'style', 'border: 2px solid darkgrey;');
 	});
+
+	it('PDF insert comment', { env: { 'pdf-view': true } }, function() {
+
+		// Insert some comment into the PDF.
+		desktopHelper.insertMultipleComment('draw', 1, true);
+		cy.get('.cool-annotation-content-wrapper').should('exist');
+		cy.get('#annotation-content-area-1').should('contain','some text0');
+
+		// Reload to close and save. PDFs cannot really be edited,
+		// only comments can be inserted, so they are not saved
+		// directly, rather save-as is used. This failed because
+		// DocBroker expected to get ModifiedStatus=false, which
+		// never happens with save-as and so we couldn't unload.
+		helper.reload(testFileName, 'draw', true);
+	});
 });