mirrors/signal-desktop
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 2 Wiki Activity Actions 1

Rename writeAttachmentData to writeNewAttachmentData

Browse source
This commit is contained in:
Daniel Gasienica 2018-04-03 21:06:29 -04:00
parent 36771a2dab
commit efd673083d
7 changed files with 28 additions and 25 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
app/attachments.js
View file

@ -43,10 +43,10 @@ exports.createReader = (root) => {
};
};
// createWriter :: AttachmentsPath ->
// ArrayBuffer ->
// IO (Promise RelativePath)
exports.createWriter = (root) => {
// createWriterForNew :: AttachmentsPath ->
// ArrayBuffer ->
// IO (Promise RelativePath)
exports.createWriterForNew = (root) => {
if (!isString(root)) {
throw new TypeError('"root" must be a path');
}

10
js/modules/types/attachment/migrate_data_to_file_system.js
View file

@ -7,15 +7,15 @@ const {
// type Context :: {
// writeAttachmentData :: ArrayBuffer -> Promise (IO Path)
// writeNewAttachmentData :: ArrayBuffer -> Promise (IO Path)
// }
//
// migrateDataToFileSystem :: Attachment ->
// Context ->
// Promise Attachment
exports.migrateDataToFileSystem = async (attachment, { writeAttachmentData } = {}) => {
if (!isFunction(writeAttachmentData)) {
throw new TypeError('"writeAttachmentData" must be a function');
exports.migrateDataToFileSystem = async (attachment, { writeNewAttachmentData } = {}) => {
if (!isFunction(writeNewAttachmentData)) {
throw new TypeError('"writeNewAttachmentData" must be a function');
}
const { data } = attachment;
@ -32,7 +32,7 @@ exports.migrateDataToFileSystem = async (attachment, { writeAttachmentData } = {
` got: ${typeof attachment.data}`);
}
const path = await writeAttachmentData(data);
const path = await writeNewAttachmentData(data);
const attachmentWithoutData = omit(
Object.assign({}, attachment, { path }),

8
js/modules/types/message.js
View file

@ -166,13 +166,13 @@ const toVersion3 = exports._withSchemaVersion(
);
// UpgradeStep
exports.upgradeSchema = async (message, { writeAttachmentData } = {}) => {
if (!isFunction(writeAttachmentData)) {
throw new TypeError('`context.writeAttachmentData` is required');
exports.upgradeSchema = async (message, { writeNewAttachmentData } = {}) => {
if (!isFunction(writeNewAttachmentData)) {
throw new TypeError('`context.writeNewAttachmentData` is required');
}
return toVersion3(
await toVersion2(await toVersion1(await toVersion0(message))),
{ writeAttachmentData }
{ writeNewAttachmentData }
);
};

4
preload.js
View file

@ -113,11 +113,11 @@ window.ProxyAgent = require('proxy-agent');
const attachmentsPath = Attachments.getPath(app.getPath('userData'));
const deleteAttachmentData = Attachments.createDeleter(attachmentsPath);
const readAttachmentData = Attachments.createReader(attachmentsPath);
const writeAttachmentData = Attachments.createWriter(attachmentsPath);
const writeNewAttachmentData = Attachments.createWriterForNew(attachmentsPath);
// Injected context functions to keep `Message` agnostic from Electron:
const upgradeSchemaContext = {
writeAttachmentData,
writeNewAttachmentData,
};
const upgradeMessageSchema = message =>
Message.upgradeSchema(message, upgradeSchemaContext);

9
test/app/attachments_test.js
View file

@ -13,7 +13,7 @@ const NAME_LENGTH = 64;
const PATH_LENGTH = PREFIX_LENGTH + NUM_SEPARATORS + NAME_LENGTH;
describe('Attachments', () => {
describe('createWriter', () => {
describe('createWriterForNew', () => {
let tempRootDirectory = null;
before(() => {
tempRootDirectory = tmp.dirSync().name;
@ -25,9 +25,12 @@ describe('Attachments', () => {
it('should write file to disk and return path', async () => {
const input = stringToArrayBuffer('test string');
const tempDirectory = path.join(tempRootDirectory, 'Attachments_createWriter');
const tempDirectory = path.join(
tempRootDirectory,
'Attachments_createWriterForNew'
);
const outputPath = await Attachments.createWriter(tempDirectory)(input);
const outputPath = await Attachments.createWriterForNew(tempDirectory)(input);
const output = await fse.readFile(path.join(tempDirectory, outputPath));
assert.lengthOf(outputPath, PATH_LENGTH);

12
test/modules/types/attachment_test.js
View file

@ -120,14 +120,14 @@ describe('Attachment', () => {
};
const expectedAttachmentData = stringToArrayBuffer('Above us only sky');
const writeAttachmentData = async (attachmentData) => {
const writeNewAttachmentData = async (attachmentData) => {
assert.deepEqual(attachmentData, expectedAttachmentData);
return 'abc/abcdefgh123456789';
};
const actual = await Attachment.migrateDataToFileSystem(
input,
{ writeAttachmentData }
{ writeNewAttachmentData }
);
assert.deepEqual(actual, expected);
});
@ -145,12 +145,12 @@ describe('Attachment', () => {
size: 1111,
};
const writeAttachmentData = async () =>
const writeNewAttachmentData = async () =>
'abc/abcdefgh123456789';
const actual = await Attachment.migrateDataToFileSystem(
input,
{ writeAttachmentData }
{ writeNewAttachmentData }
);
assert.deepEqual(actual, expected);
});
@ -163,11 +163,11 @@ describe('Attachment', () => {
size: 1111,
};
const writeAttachmentData = async () =>
const writeNewAttachmentData = async () =>
'abc/abcdefgh123456789';
try {
await Attachment.migrateDataToFileSystem(input, { writeAttachmentData });
await Attachment.migrateDataToFileSystem(input, { writeNewAttachmentData });
} catch (error) {
assert.strictEqual(
error.message,

2
test/modules/types/message_test.js
View file

@ -85,7 +85,7 @@ describe('Message', () => {
const expectedAttachmentData = stringToArrayBuffer('It’s easy if you try');
const context = {
writeAttachmentData: async (attachmentData) => {
writeNewAttachmentData: async (attachmentData) => {
assert.deepEqual(attachmentData, expectedAttachmentData);
return 'abc/abcdefg';
},