Skip to content

feat: Add support for Parse.File.setDirectory, setMetadata, setTags with stream-based file upload #10092

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mtrezza merged 3 commits into from
Mar 4, 2026
+242 −8
Merged

feat: Add support for Parse.File.setDirectory, setMetadata, setTags with stream-based file upload #10092

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
15eccb3
feat
mtrezza Mar 4, 2026
00eff2e
parse
mtrezza Mar 4, 2026
bec9c45
fix https://github.com/parse-community/parse-server/pull/10092#discus…
mtrezza Mar 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
"mongodb": "7.1.0",
"mustache": "4.2.0",
"otpauth": "9.4.0",
"parse": "8.3.0",
"parse": "8.4.0",
"path-to-regexp": "8.3.0",
"pg-monitor": "3.1.0",
"pg-promise": "12.6.0",
Expand Down
202 changes: 202 additions & 0 deletions spec/ParseFile.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2311,6 +2311,208 @@ describe('Parse.File testing', () => {
expect(b.url).toBeDefined();
});

it('saves file with directory via streaming upload (header)', async () => {
const headers = {
'Content-Type': 'text/plain',
'X-Parse-Application-Id': 'test',
'X-Parse-Master-Key': 'test',
'X-Parse-Upload-Mode': 'stream',
'X-Parse-File-Directory': 'stream-dir-test',
};
const response = await request({
method: 'POST',
headers,
url: 'http://localhost:8378/1/files/stream-header.txt',
body: 'stream directory header content',
});
const b = response.data;
expect(b.name).toMatch(/^stream-dir-test\/.*_stream-header.txt$/);
expect(b.url).toBeDefined();
});

it('rejects directory header without master key for streaming upload', async () => {
const headers = {
'Content-Type': 'text/plain',
'X-Parse-Application-Id': 'test',
'X-Parse-REST-API-Key': 'rest',
'X-Parse-Upload-Mode': 'stream',
'X-Parse-File-Directory': 'no-master',
};
try {
await request({
method: 'POST',
headers,
url: 'http://localhost:8378/1/files/stream-header.txt',
body: 'should fail',
});
fail('should have thrown');
} catch (error) {
expect(error.data.code).toEqual(Parse.Error.OPERATION_FORBIDDEN);
}
});

it('validates directory header for streaming upload', async () => {
const headers = {
'Content-Type': 'text/plain',
'X-Parse-Application-Id': 'test',
'X-Parse-Master-Key': 'test',
'X-Parse-Upload-Mode': 'stream',
'X-Parse-File-Directory': '../etc',
};
try {
await request({
method: 'POST',
headers,
url: 'http://localhost:8378/1/files/stream-header.txt',
body: 'should fail',
});
fail('should have thrown');
} catch (error) {
expect(error.data.code).toEqual(Parse.Error.INVALID_FILE_NAME);
}
});

it('saves file with metadata and tags via streaming upload headers', async () => {
spyOn(FilesController.prototype, 'createFile').and.callThrough();
const headers = {
'Content-Type': 'text/plain',
'X-Parse-Application-Id': 'test',
'X-Parse-Master-Key': 'test',
'X-Parse-Upload-Mode': 'stream',
'X-Parse-File-Metadata': JSON.stringify({ key1: 'value1' }),
'X-Parse-File-Tags': JSON.stringify({ tag1: 'tagValue1' }),
};
const response = await request({
method: 'POST',
headers,
url: 'http://localhost:8378/1/files/stream-meta.txt',
body: 'stream with metadata content',
});
const b = response.data;
expect(b.name).toMatch(/_stream-meta.txt$/);
expect(b.url).toBeDefined();
const options = FilesController.prototype.createFile.calls.argsFor(0)[4];
expect(options.metadata).toEqual({ key1: 'value1' });
expect(options.tags).toEqual({ tag1: 'tagValue1' });
});

it('saves file with directory, metadata, and tags via streaming upload headers', async () => {
spyOn(FilesController.prototype, 'createFile').and.callThrough();
const headers = {
'Content-Type': 'text/plain',
'X-Parse-Application-Id': 'test',
'X-Parse-Master-Key': 'test',
'X-Parse-Upload-Mode': 'stream',
'X-Parse-File-Directory': 'uploads',
'X-Parse-File-Metadata': JSON.stringify({ author: 'test' }),
'X-Parse-File-Tags': JSON.stringify({ env: 'test' }),
};
const response = await request({
method: 'POST',
headers,
url: 'http://localhost:8378/1/files/stream-all.txt',
body: 'stream with all file data',
});
const b = response.data;
expect(b.name).toMatch(/^uploads\/.*_stream-all.txt$/);
expect(b.url).toBeDefined();
const options = FilesController.prototype.createFile.calls.argsFor(0)[4];
expect(options.metadata).toEqual({ author: 'test' });
expect(options.tags).toEqual({ env: 'test' });
});

it('rejects invalid JSON in metadata header', async () => {
const headers = {
'Content-Type': 'text/plain',
'X-Parse-Application-Id': 'test',
'X-Parse-Master-Key': 'test',
'X-Parse-Upload-Mode': 'stream',
'X-Parse-File-Metadata': 'not-json',
};
try {
await request({
method: 'POST',
headers,
url: 'http://localhost:8378/1/files/stream-bad.txt',
body: 'should fail',
});
fail('should have thrown');
} catch (error) {
expect(error.data.code).toEqual(Parse.Error.INVALID_JSON);
}
});

it('rejects invalid JSON in tags header', async () => {
const headers = {
'Content-Type': 'text/plain',
'X-Parse-Application-Id': 'test',
'X-Parse-Master-Key': 'test',
'X-Parse-Upload-Mode': 'stream',
'X-Parse-File-Tags': '{bad',
};
try {
await request({
method: 'POST',
headers,
url: 'http://localhost:8378/1/files/stream-bad.txt',
body: 'should fail',
});
fail('should have thrown');
} catch (error) {
expect(error.data.code).toEqual(Parse.Error.INVALID_JSON);
}
});

it('rejects non-object metadata header', async () => {
const invalidValues = ['"a string"', '[1,2]', 'null', '42', 'true'];
for (const value of invalidValues) {
const headers = {
'Content-Type': 'text/plain',
'X-Parse-Application-Id': 'test',
'X-Parse-Master-Key': 'test',
'X-Parse-Upload-Mode': 'stream',
'X-Parse-File-Metadata': value,
};
try {
await request({
method: 'POST',
headers,
url: 'http://localhost:8378/1/files/stream-bad.txt',
body: 'should fail',
});
fail(`should have thrown for metadata: ${value}`);
} catch (error) {
expect(error.data.code).toEqual(Parse.Error.INVALID_JSON);
expect(error.data.error).toBe('Invalid JSON in X-Parse-File-Metadata header.');
}
}
});

it('rejects non-object tags header', async () => {
const invalidValues = ['"a string"', '[1,2]', 'null', '42', 'true'];
for (const value of invalidValues) {
const headers = {
'Content-Type': 'text/plain',
'X-Parse-Application-Id': 'test',
'X-Parse-Master-Key': 'test',
'X-Parse-Upload-Mode': 'stream',
'X-Parse-File-Tags': value,
};
try {
await request({
method: 'POST',
headers,
url: 'http://localhost:8378/1/files/stream-bad.txt',
body: 'should fail',
});
fail(`should have thrown for tags: ${value}`);
} catch (error) {
expect(error.data.code).toEqual(Parse.Error.INVALID_JSON);
expect(error.data.error).toBe('Invalid JSON in X-Parse-File-Tags header.');
}
}
});

it('validates directory - rejects trailing slash', async () => {
const file = new Parse.File('hello.txt', data, 'text/plain');
file.setDirectory('trailing/');
Expand Down
32 changes: 32 additions & 0 deletions src/Routers/FilesRouter.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -314,6 +314,38 @@ export class FilesRouter {
}
}

// For streaming uploads, read file data from headers since the body is the raw stream
if (req.get('X-Parse-Upload-Mode') === 'stream') {
req.fileData = {};
if (req.get('X-Parse-File-Directory')) {
req.fileData.directory = req.get('X-Parse-File-Directory');
}
if (req.get('X-Parse-File-Metadata')) {
try {
const parsed = JSON.parse(req.get('X-Parse-File-Metadata'));
if (!parsed || typeof parsed !== 'object' || Array.isArray(parsed)) {
throw new Error();
}
req.fileData.metadata = parsed;
} catch {
next(new Parse.Error(Parse.Error.INVALID_JSON, 'Invalid JSON in X-Parse-File-Metadata header.'));
return;
}
}
if (req.get('X-Parse-File-Tags')) {
try {
const parsed = JSON.parse(req.get('X-Parse-File-Tags'));
if (!parsed || typeof parsed !== 'object' || Array.isArray(parsed)) {
throw new Error();
}
req.fileData.tags = parsed;
} catch {
next(new Parse.Error(Parse.Error.INVALID_JSON, 'Invalid JSON in X-Parse-File-Tags header.'));
return;
}
}
}

// Validate directory option (requires master key)
const directory = req.fileData?.directory;
if (directory !== undefined) {
Expand Down
Loading