Documents can get huge, mostly because of the history. This can lead to difficulties t

NB: there is a companion tool to purge the history: <div class="Box Box--conde

Thanks <a class="user-mention notranslate" data-hovercard-type="user" data-hovercard-u

Rest API endpoint to purge history of a document about grist-core HOT 3 OPEN

fflorent commented on July 3, 2024

Rest API endpoint to purge history of a document

from grist-core.

Comments (3)

fflorent commented on July 3, 2024

NB: there is a companion tool to purge the history:

grist-core/app/server/companion.ts

Lines 55 to 67 in c0ce791

    
           // Add commands related to document history: 
        
           //   history prune <docId> [N] 
        
           export function addHistoryCommand(program: commander.Command, options: CommandOptions) { 
        
             const sub = section(program, { 
        
               sectionName: 'history', 
        
               sectionDescription: 'fiddle with history of a Grist document', 
        
               ...options, 
        
             }); 
        
             sub('prune <docId>') 
        
               .description('remove all but last N actions from doc') 
        
               .argument('[N]', 'number of actions to keep', parseIntForCommander, 1) 
        
               .action(pruneActionHistory); 
        
           }

However:

it is only available to the administrator hosting the Grist instance;
it's unclear whether the tool can be used in the context of multi-worker instance, with S3 storage backend;

from grist-core.

paulfitz commented on July 3, 2024

There is also a /states/remove endpoint, not documented. You can see it being exercised here:

grist-core/test/server/lib/DocApi.ts

Lines 3217 to 3241 in 91e0a62

    
           it("POST /docs/{did}/states/remove removes old states", async function () { 
        
             // Check doc has plenty of states. 
        
             let resp = await axios.get(`${serverUrl}/api/docs/${docIds.Timesheets}/states`, chimpy); 
        
             assert.equal(resp.status, 200); 
        
             const states: DocState[] = resp.data.states; 
        
             assert.isAbove(states.length, 5); 
        
             // Remove all but 3. 
        
             resp = await axios.post(`${serverUrl}/api/docs/${docIds.Timesheets}/states/remove`, {keep: 3}, chimpy); 
        
             assert.equal(resp.status, 200); 
        
             resp = await axios.get(`${serverUrl}/api/docs/${docIds.Timesheets}/states`, chimpy); 
        
             assert.equal(resp.status, 200); 
        
             assert.lengthOf(resp.data.states, 3); 
        
             assert.equal(resp.data.states[0].h, states[0].h); 
        
             assert.equal(resp.data.states[1].h, states[1].h); 
        
             assert.equal(resp.data.states[2].h, states[2].h); 
        
             // Remove all but 1. 
        
             resp = await axios.post(`${serverUrl}/api/docs/${docIds.Timesheets}/states/remove`, {keep: 1}, chimpy); 
        
             assert.equal(resp.status, 200); 
        
             resp = await axios.get(`${serverUrl}/api/docs/${docIds.Timesheets}/states`, chimpy); 
        
             assert.equal(resp.status, 200); 
        
             assert.lengthOf(resp.data.states, 1); 
        
             assert.equal(resp.data.states[0].h, states[0].h); 
        
           });

from grist-core.

fflorent commented on July 3, 2024

Thanks @paulfitz!

To fix this issue, I tend to think we may just document this API as well as GET /states/.

There could also be an enhancement to offer an option which limits the history size in another issue (so the docs don't get huge). WDYT?

from grist-core.

Rest API endpoint to purge history of a document about grist-core HOT 3 OPEN

Comments (3)

Related Issues (20)

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent

	// Add commands related to document history:
	// history prune <docId> [N]
	export function addHistoryCommand(program: commander.Command, options: CommandOptions) {
	const sub = section(program, {
	sectionName: 'history',
	sectionDescription: 'fiddle with history of a Grist document',
	...options,
	});
	sub('prune <docId>')
	.description('remove all but last N actions from doc')
	.argument('[N]', 'number of actions to keep', parseIntForCommander, 1)
	.action(pruneActionHistory);
	}

	it("POST /docs/{did}/states/remove removes old states", async function () {
	// Check doc has plenty of states.
	let resp = await axios.get(`${serverUrl}/api/docs/${docIds.Timesheets}/states`, chimpy);
	assert.equal(resp.status, 200);
	const states: DocState[] = resp.data.states;
	assert.isAbove(states.length, 5);

	// Remove all but 3.
	resp = await axios.post(`${serverUrl}/api/docs/${docIds.Timesheets}/states/remove`, {keep: 3}, chimpy);
	assert.equal(resp.status, 200);
	resp = await axios.get(`${serverUrl}/api/docs/${docIds.Timesheets}/states`, chimpy);
	assert.equal(resp.status, 200);
	assert.lengthOf(resp.data.states, 3);
	assert.equal(resp.data.states[0].h, states[0].h);
	assert.equal(resp.data.states[1].h, states[1].h);
	assert.equal(resp.data.states[2].h, states[2].h);

	// Remove all but 1.
	resp = await axios.post(`${serverUrl}/api/docs/${docIds.Timesheets}/states/remove`, {keep: 1}, chimpy);
	assert.equal(resp.status, 200);
	resp = await axios.get(`${serverUrl}/api/docs/${docIds.Timesheets}/states`, chimpy);
	assert.equal(resp.status, 200);
	assert.lengthOf(resp.data.states, 1);
	assert.equal(resp.data.states[0].h, states[0].h);
	});