Save edit summary to revision when editing schema

Author: alistair3149

resources/ext.neowiki/src/application/SchemaRepository.ts

@@ -3,7 +3,7 @@ import { Schema } from '@/domain/Schema.ts';
 
 export interface SchemaRepository extends SchemaLookup {
 
-	saveSchema( schema: Schema ): Promise<void>;
+	saveSchema( schema: Schema, comment?: string ): Promise<void>;
 
 }
 

resources/ext.neowiki/src/components/SchemaEditor/EditSchemaPage.vue

@@ -29,7 +29,7 @@ const handleSave = async ( summary: string ): Promise<void> => {
 	if ( !schemaEditor.value ) {
 		return;
 	}
-	await saveSchema( schemaEditor.value.getSchema(), summary );
+	await saveSchema( schemaEditor.value.getSchema(), summary || 'Update schema via NeoWiki UI' );
 };
 </script>
 

resources/ext.neowiki/src/components/SchemaEditor/SchemaEditorDialog.vue

@@ -54,7 +54,7 @@ const handleSave = async ( summary: string ): Promise<void> => {
 	}
 
 	const schema = schemaEditor.value.getSchema();
-	await saveSchema( schema, summary );
+	await saveSchema( schema, summary || 'Update schema via NeoWiki UI' );
 	emit( 'saved', schema );
 	open.value = false;
 };

resources/ext.neowiki/src/composables/useSchemaSaver.ts

@@ -2,23 +2,16 @@ import { NeoWikiServices } from '@/NeoWikiServices';
 import { Schema } from '@/domain/Schema';
 
 interface UseSchemaSaverReturn {
-	saveSchema: ( schema: Schema, editSummary: string ) => Promise<void>;
+	saveSchema: ( schema: Schema, comment?: string ) => Promise<void>;
 }
 
 export function useSchemaSaver(): UseSchemaSaverReturn {
 	const schemaRepository = NeoWikiServices.getSchemaRepository();
 
-	const saveSchema = async ( schema: Schema, editSummary: string ): Promise<void> => {
+	const saveSchema = async ( schema: Schema, comment?: string ): Promise<void> => {
 		try {
-			// TODO: Save edit summary to revision so it shows on the history page
-			await schemaRepository.saveSchema( schema );
-			mw.notify(
-				editSummary || 'No edit summary provided.',
-				{
-					title: `Updated ${ schema.getName() } schema`,
-					type: 'success',
-				},
-			);
+			await schemaRepository.saveSchema( schema, comment );
+			mw.notify( `Updated ${ schema.getName() } schema`, { type: 'success' } );
 		} catch ( error ) {
 			mw.notify(
 				error instanceof Error ? error.message : String( error ),

resources/ext.neowiki/src/persistence/RestSchemaRepository.ts

@@ -61,11 +61,11 @@ export class RestSchemaRepository implements SchemaRepository {
 		return await response.json();
 	}
 
-	public async saveSchema( schema: Schema ): Promise<void> {
+	public async saveSchema( schema: Schema, comment?: string ): Promise<void> {
 		const status = await this.pageSaver.savePage(
 			`Schema:${ encodeURIComponent( schema.getName() ) }`,
 			this.serializeSchema( schema ),
-			'Update schema via NeoWiki UI',
+			comment || 'Update schema via NeoWiki REST API',
 			'NeoWikiSchema',
 		);
 

resources/ext.neowiki/src/stores/SchemaStore.ts

@@ -36,8 +36,8 @@ export const useSchemaStore = defineStore( 'schema', {
 			await Promise.all( schemaNames.map( ( name ) => this.getOrFetchSchema( name ) ) );
 			return schemaNames;
 		},
-		async saveSchema( schema: Schema ): Promise<void> {
-			await NeoWikiExtension.getInstance().getSchemaRepository().saveSchema( schema );
+		async saveSchema( schema: Schema, comment?: string ): Promise<void> {
+			await NeoWikiExtension.getInstance().getSchemaRepository().saveSchema( schema, comment );
 			this.setSchema( schema.getName(), schema );
 		},
 	},

resources/ext.neowiki/tests/composables/useSchemaSaver.spec.ts

@@ -30,33 +30,32 @@ describe( 'useSchemaSaver', () => {
 		new PropertyDefinitionList( [] ),
 	);
 
+	const expectSuccessNotification = ( schema: Schema ): void => expect( mw.notify ).toHaveBeenCalledWith(
+		`Updated ${ schema.getName() } schema`,
+		expect.objectContaining( {
+			type: 'success',
+		} ),
+	);
+
 	it( 'saves schema successfully and notifies user', async () => {
 		const { saveSchema } = useSchemaSaver();
 		const schema = createMockSchema();
 		const summary = 'Test Summary';
 
 		await saveSchema( schema, summary );
 
-		expect( mockSaveSchema ).toHaveBeenCalledWith( schema );
-		expect( mw.notify ).toHaveBeenCalledWith(
-			summary,
-			expect.objectContaining( {
-				title: 'Updated TestSchema schema',
-				type: 'success',
-			} ),
-		);
+		expect( mockSaveSchema ).toHaveBeenCalledWith( schema, summary );
+		expectSuccessNotification( schema );
 	} );
 
 	it( 'uses default summary if none provided', async () => {
 		const { saveSchema } = useSchemaSaver();
 		const schema = createMockSchema();
 
-		await saveSchema( schema, '' );
+		await saveSchema( schema );
 
-		expect( mw.notify ).toHaveBeenCalledWith(
-			'No edit summary provided.',
-			expect.any( Object ),
-		);
+		expect( mockSaveSchema ).toHaveBeenCalledWith( schema, undefined );
+		expectSuccessNotification( schema );
 	} );
 
 	it( 'handles save error and notifies user', async () => {

resources/ext.neowiki/tests/persistence/RestSchemaRepository.neo4j.spec.ts

@@ -99,20 +99,33 @@ describe( 'RestSchemaRepository', () => {
 		it( 'should call the correct API endpoint with the right parameters', async () => {
 			vi.spyOn( pageSaver, 'savePage' );
 
+			await repository.saveSchema( testSchema, 'Comment for the edit' );
+
+			expect( pageSaver.savePage ).toHaveBeenCalledWith(
+				'Schema:TestSchema',
+				'{"serialized":"TestSchema"}',
+				'Comment for the edit',
+				'NeoWikiSchema',
+			);
+		} );
+
+		it( 'should use default summary if none provided', async () => {
+			vi.spyOn( pageSaver, 'savePage' );
+
 			await repository.saveSchema( testSchema );
 
 			expect( pageSaver.savePage ).toHaveBeenCalledWith(
 				'Schema:TestSchema',
 				'{"serialized":"TestSchema"}',
-				'Update schema via NeoWiki UI',
+				'Update schema via NeoWiki REST API',
 				'NeoWikiSchema',
 			);
 		} );
 
 		it( 'should throw an error if the API response failed', async () => {
 			repository = new RestSchemaRepository( apiUrl, mockHttpClient, mockSerializer, new FailingPageSaver() );
 
-			await expect( repository.saveSchema( testSchema ) )
+			await expect( repository.saveSchema( testSchema, 'Comment for the edit' ) )
 				.rejects
 				.toThrow( 'Error saving schema: Some reason' );
 		} );
@@ -126,12 +139,12 @@ describe( 'RestSchemaRepository', () => {
 
 			vi.spyOn( pageSaver, 'savePage' );
 
-			await repository.saveSchema( schemaWithSpecialChars );
+			await repository.saveSchema( schemaWithSpecialChars, 'Comment for the edit' );
 
 			expect( pageSaver.savePage ).toHaveBeenCalledWith(
 				'Schema:Test%2FSchema%20With%3ASpaces',
 				expect.anything(),
-				expect.anything(),
+				'Comment for the edit',
 				expect.anything(),
 			);
 		} );