Async/await и правильность codestye?

Question

[vetsmen]

Доброго времени суток. Есть данный код:

const createUser = async (username, userid, auth_type, img) => {
	try {
		let isRegister = await connection.query('SELECT username, userid, img FROM Users WHERE userids = ?', [userid]);

		let query = (isRegister && isRegister[0] && (isRegister[0].username !== username || isRegister[0].img !== img)) ?
			await connection.query('UPDATE Users SET ? WHERE userid = ?', [{username, img}, userid]) :
			await connection.query('INSERT INTO Users SET ?', {username, userid, auth_type, img});
			
		return true;
	} catch(error) {
		console.log(error);
		return false;
	}
};

if(createUser(123, 123, 1, 123)) {
	console.log(1);
} else {
	console.log(2);
}

Адекватный ли codestyle у функции createUser? И чтобы работала функция с console.log(1/2), мне нужно обернуть createUser в промис?

Comments

[Demian Smith]

Кодстайл ВСЕГДА очень холиварная тема. Для того чтоб её предотвратить, современные проекты используют eslint + prettier. Советую начать их тоже использовать там, где с кодом работает больше одного человека. Иначе холиваров не избежать.

Answer 1

[Վիտալի Լագունով]

Первое что бросается в глаза — использованы пробелы вместо табов, это быдлокодерство (почему — гуглить по запросу "Tab indent space alignment"). Также после if нужен пробел.

if (createUser(123, 123, 1, 123)) писать бессмысленно, т. к. функция createUser() всегда сразу же возвращает промис ещё до начала фактического выполнения функции. Только потом спустя функция начнёт выполняться, и в тот момент, когда выполнение дойдёт до return или throw, функция заполнит этот промис результатом или ошибкой. Т. е. суть в том, что async-функция — это функция, возвращающая промис. Раньше вам приходилось самому возвращать промис, а теперь функция возвращает его за вас. (PS. В реальности, если вдаваться в подробности, то на самом деле функция начнёт выполняться сразу же до первого await, но даже если await'ов не будет, возвращён будет всё-равно промис).

Чтобы решить проблему, нужно либо написать createUser(123, 123, 1, 123).then(bool => { ... }), либо обернуть вызов функции в другую async-функцию, чтобы была возможность использовать await. Конечно же, такая обёртка тоже вернёт промис.

Также нужно отметить, что try catch писать необязательно, вместо этого можно отловить ошибку прямо в указанной выше обёртке (или с помощью .then(value => {}, err => {})). Т. е. отловить ошибку рано или поздно придётся, но необязательно это делать в каждой функции — чаще всего достаточно один раз в конце.

Comments

[Demian Smith]

Вот этот документ считается образцовым JS стайлгадом: https://github.com/airbnb/javascript (60к звёзд на гитхабе как бы намекают). Насколько я знаю, все известные проекты следуют ему по умолчанию. Вот что он говорит про табы/пробелы https://github.com/airbnb/javascript#whitespace

[ivanovSP]

vitaliy2, что сейчас является лучшей практикой, если не airbnb?
Писать свой велосипед и всем доказывать что он лучше?


Без разницы будет пробел или не будет, самое главное что бы это правило было введено на всех ваших проектах (всех проектах компании)

Таких как вы еще 1000 человек, которые все хотят переписать под себя, именно против таких как вы и создавались эти стандарты

[Demian Smith]

vitaliy2, полез гуглить, но так и не разобрался в чём соль. Виноват что туповат. Можете прояснить если не сложно?

Ради интереса, можете показать какой-нибудь известный проект на гитхабе (с больше чем 1 контрибьютром), который юзает табы вместо пробелов? Или я вообще не туда лезу?

[Վիտալի Լագունով]

ivanovSP, самое главное — это как раз, чтобы на месте табов юзались именно табы, а не пробелы, а на месте пробелов — пробелы, а не табы (не путать со смешиванием пробелов и табов — это ещё большее быдлокодерство, чем всё пробелами или всё табами). Пункт с пробелами и табами даже не обговаривается, иначе будет много головной боли. Tab indent space alignment не имеет ни одного недостатка (я пытался найти хотя бы малейший недостаток 3 года, и так и не смог).

Всё остальное уже менее критично, и тут возможно, что такие популярные штуки на 60к звёзд подойдут (сам я точно не знаю). Конечно же, лучше перед введением каждого пункта проверить их на адекватность, чтобы не попалась какая-нибудь такая же падла, как с пробелами. Но, как я сказал ранее, остальные пункты менее критичны. Что-то конкретное я посоветовать не могу, т. к. не разбираюсь в вопросе.

[Վիտալի Լագունով]

В "catch (error)" после catch тоже пробел стоит поставить.

[Վիտալի Լագունով]

Ну и да, стоит конечно же выбрать современный код-стайл. Если в той фигне юзаются пробелы вместо табов, это говорит о том, что код-стайл устарел, и я бы всё-таки посмотрел в сторону другого код-стайла.

[vetsmen]

vitaliy2, можешь показать на моем примере в теме, как лучше обработать ошибку без try/catch?

[Վիտալի Լագունով]

Demian Smith,

который юзает табы вместо пробелов

Для начала, в этой фразе грубейшая ошибка. На том месте, где я говорю ставить табы, там и должны быть табы, и если вы вдруг поставите пробелы, то это будут пробелы вместо табов, а не наоборот.

Насчёт полного объяснения — ок, напишу статью на хабре или хотя бы развёрнутый комментарий, и скину сюда ссылку или этот комментарий. Видимо, гугл плохо объясняет, либо люди шокированы, когда им говорят, что стиль, в правильность которого их убедили — абсолютно неправильный :)

[Վիտալի Լագունով]

const createUser = async (username, userid, auth_type, img) => {
	let isRegister = await connection.query('SELECT username, userid, img FROM Users WHERE userids = ?', [userid]);

	let query = (isRegister && isRegister[0] && (isRegister[0].username !== username || isRegister[0].img !== img)) ?
		await connection.query('UPDATE Users SET ? WHERE userid = ?', [{username, img}, userid]) :
		await connection.query('INSERT INTO Users SET ?', {username, userid, auth_type, img});
};

createUser(123, 123, 1, 123).then(v => {
	console.log(1);
}, err => {
	console.log(2);
});

[Վիտալի Լագունով]

Суть в том, что функция createUser по своей логике не должна отлавливать эту ошибку — её должны отлавливать те, кто эту функцию использует. Если этих "тех" тоже кто-то использует, то они тоже не должны отлавливать, и т. д.

[Վիտալի Լագունով]

Ну и конечно нужно отметить, что непойманное исключение не обвалит приложение, а просто заполнит промис ошибкой. В прочем, в будущем сделают, чтобы если вообще никто не ловит его, то обвалит (так будет на всех промисах, к самому throw это отношения не имеет).

[Demian Smith]

vitaliy2, спасибо что прояснили. Даже сам захотел внедрить его в компании, где я работаю. Но блин, там несколько сотен джаваскрипт разработчиков и всем им по душе стайлгайд от airbnb. Так что они наверняка попросят предъявить альтернативный общепринятый стайлгайд. Но я не могу его найти. Может вы подскажете? Ну и для убедительности попросят показать хоть один, а лучше парочку, известных проектов, которые используют Tab indent space alignment. Но я не могу найти ни одного. Angular, react, vue, ember, meteor, next.js, все они использует 2 пробела для отступа. Вроде jQuery юзает Tab indent space alignment. Но меня, чёрт возьми, засмеют, если я буду использовать либу десятилетней давности в качестве примера. Можете помочь с этим? Как убедить несколько сотен быдлокодеров?

[vetsmen]

vitaliy2, что возвращает функция "v" в самом выводе? И разве не обязательно брать в круглые скобки, вида (v) => {}, (err) => {} etc.?

[Վիտալի Լագունով]

Demian Smith,

Так что они наверняка попросят предъявить альтернативный общепринятый стайлгайд.

Думаю, не нужно прямо сразу торопиться, а перед этим составить хорошую статью, где очень хорошо объяснено всё, и дать им всем почитать. После того, как убедились, что все прочли, большинство итак сами захотят такой стиль, т. к. в нём действительно нет недостатков.

После этого дать почитать тим-лиду, а он уже примет решение. Если кто-то будет не согласен — пожалуйста, пусть назовут хоть один недостаток, и тогда их мнение будет учтено. Если они не могут назвать недостатки, то пусть следуют мнению тех, кто может чётко объяснить свою позицию. А назвать недостатки они и не смогут, потому что их нет :) В общем всё решается легко :)

[Վիտալի Լագունով]

Demian Smith, давайте я составлю статью для хабра, а перед публикацией вы посмотрите, как можно эту статью улучшить. Там уже есть одна статья, но её уровень слишком низок.

[Վիտալի Լագունով]

vetsmen, как и в обычной функции, если return не написан, возвращается undefined. Соответственно, v будет undefined.

Не брать в скобки можно, если аргумент ровно один. Я бы даже сказал нужно, если не планируется, что в будущем количество аргументов может измениться.

Ну и советую Вам изучить промисы, это важно для понимания async await.

[Demian Smith]

vitaliy2, недостатков табов вроде мало. Навскидку только этот могу назвать



Гитхаб и битбаккет показывают табы как 6 (или даже 8) пробелов. Код ревью неудобно проводить, строки прыгают.

Ну и девелоперы, которые юзают пробелы для отступов зарабатывают больше денег (https://stackoverflow.blog/2017/06/15/developers-u... Чисто статистически. Но это Голландия, они сколнны принимать решения, основанные на статистических данных. Дикари, что с них взять.

Думаю, задача предстоит непростая:
1. убедить гитхаб и битбакет чтоб сократили размер таба в своих шрифтах, ато код ревью хромает
2. поменять общественное мнение по поводу программистов, юзающих табы и что нужно платить им больше

[Վիտալի Լագունով]

Demian Smith,

Гитхаб и битбаккет показывают табы как 6 (или даже 8) пробелов.

Абсолютная неправда. Они показывают ровно столько пробелов, сколько Вы скажете. Конечно же, это тоже должно быть отражено в статье.

Каждый пользователь настраивает размер таба в своём браузере сам:

body {
	-moz-tab-size: 4 !important;
	-webkit-tab-size: 4 !important;
	-o-tab-size: 4 !important;
	tab-size: 4 !important;
}

Для гитхаба нужно прописать другой код:

.tab-size {
	-moz-tab-size: 4 !important;
	-webkit-tab-size: 4 !important;
	-o-tab-size: 4 !important;
	tab-size: 4 !important;
}

девелоперы, которые юзают пробелы для отступов зарабатывают больше денег

Явно не из-за того, что юзают пробелы. Просто чаще попадается, что они меньшие быдлокодеры, чем кто всё табами. Но и то, и то — быдлокодерство.

1. убедить гитхаб и битбакет чтоб сократили размер таба в своих шрифтах

См. выше. Хотя гитхабу стоило бы добавить инструкцию в настройки профиля, а то, как мне кажется, большинство не понимают, что они должны настроить табы сами.

Кстати, здесь как раз снова проявляется преимущество табов — каждый пользователь гибхаба или других сайтов сам выбирает размер таба.

поменять общественное мнение по поводу программистов, юзающих табы и что нужно платить им больше

См. выше. Одно не является следствием другого — это грубая математическая ошибка так думать.

[Վիտալի Լագունով]

Навскидку только этот могу назвать

Как мы выяснили, это не недостаток, а просто Вы не настроили в браузере размер таба. В этом и достоинство таба, что можно самому настроить.

[Demian Smith]

vitaliy2, ухты, даже не знал что есть свойство tab-size, спасибо. Удачи со статьёй! Чиркните когда закончите https://habrahabr.ru/users/search/