Wstępna konfiguracja gita

Powiedzmy, że przypadkiem szykujesz się do DevWarsztatów z gita 😉 i coś tam trzeba zainstalować.

Konsola

Konsolę ściągamy ze strony https://git-scm.com/downloads dla odpowiedniego systemu. Klikamy wszędzie „Dalej” 🙂

Podstawowe ustawienia

Ustawiamy swoje dane

git config --global user.name "Krzysztof Morcinek"
git config --global user.email "your-email@gmail.com"

Domyślnym edytorem jest vim, którego wiele osób nie zna. Polecam więc zmienić na np notepad.

git config --global core.editor notepad

GitHub

Zakładamy konto na GitHubie https://github.com/join

Source Tree

Nieobowiązkowe, można ściągnąć z https://www.sourcetreeapp.com/ (trzeba zarejestrować email, to jedyne wymaganie). Wersje tylko dla Mac i Windows.

Kdiff3

Instalujemy: https://www.google.com/?q=kdiff3+download

Konfiguracja (zrobimy też to na warsztatach):

Na Windowsie dodajemy na dole pliku. ~/.gitconfig (może trzeba ścieżkę dostosować):

[merge]
tool = kdiff3
[mergetool "kdiff3"]
path = c:/Program Files/KDiff3/kdiff3.exe
[diff]
tool = kdiff3
guitool = kdiff3
[difftool "kdiff3"]
path = c:/Program Files/KDiff3/kdiff3.exe

Na Linuxie dodajemy na dole pliku. ~/.gitconfig:

[merge]
    tool = kdiff3
[diff]
    guitool = kdiff3

Gdzie chowasz swoje hacki?

Jest bug! 😦

function foo(){
    applyResultToDataTable();
    // more code
}

Wywołanie takiej funkcji powoduje błąd w rozmwiarze stylowania i tabelka z danymi jest niewidoczna. Na jednym środowisku działa na innym nie działa. Bug trudny do zlokalizowania/zrozumienia/naprawienia.

Ale można przyhaczyć 🙂 Okazuje się, że „malutki” timeout załatwia sprawę:

setTimeout(function(){
    applyResultToDataTable();
    // more code
}, 100);

Hacki się mszczą, ale teraz musimy dostarczyć paczkę

Dzisiaj zakładamy, że takie hacki się mszczą (dlaczego to osobny ciekawy temat). Kolejne założenie to takie, że w tym akurat momencie tak już zrobimy. Brak czasu lub skilla nie pozwala. Co więć dalej zrobić?

Na pewno można dodać opis:

// Workaround for columns width = 0px; after loading data to DataTables
setTimeout(function(){
    applyResultToDataTable();
    // more code
}, 100);

Kolejny tydzień, kolejny ten sam bug

Kod żyje, innego dnia dowiadujemy się że testy na innym widoku znalazły ten sam problem. I znów w innym miejscu dopisujemy:

// Workaround for columns width = 0px; after loading data to DataTables
setTimeout(function(){
    applyResultToDataTable();
    // more code
}, 100);

Wróc! Najczęściej tak się nie zdarza, najczęściej inny developer nie zna akurat „tego” hacka. Brak komunikacji i przesunięcie w czasie sprawiły, że nikt mu o nim nie powiedział. Więc dopisuje na nowo tego samego (po straceniu czasu na rozkminę), albo znajdzie nowy sposób załatania (i znowu straci czas). Kolejny smutny hack 😦

Bądź EXPLICIT

Ja sugeruję aby takie drogi na skróty od razu opisywać osobnymi metodami.

/*
 * Workaround for columns width = 0px; after loading data to DataTables
 */
function addTimeoutToFixNarrowDataTables(action){
    setTimeout(function(){
        action();
    }, 100);
}
function foo(){
    addTimeoutToFixNarrowDataTables(function(){
        applyResultToDataTable();
        // more code
    }
}

Czy nazwa addTimeoutToFixNarrowDataTables() jest właściwa? Tutaj będzie bardzo wiele opinii. Ja wychodzę z założenia, że lepiej wpisać tutaj wiele rzeczy, bo ktoś szukając rozwiazania swojego problemu w przyszłości znajdzie przynajmniej jedno słowo (korzystając z Search Everywhere). Zgadzam się, że w normalnym kodzie nie chciałbym takich dużych metoda, ale to jest właśnie Hack.

A gdzie umieścić taką metodę? Można gdzieś w klasie z której jest wołana, może jest bazowy kontroller lub serwis z którego kod potrzebujący może wywołać hacka. Ja bym jednak stworzył osobną klasę nazywającą się YouNameItHacks (ControllerHacks, DataTablesHacks, itd). Takich rzeczy nie należy ukrywać. Ktoś może zmarnować dużo czasu zanim znajdzie „dlaczego nowo pisany moduł na takiego dziwnego buga…”.

explicit hacks in visual studio solution

Jak nazwać? Gdzie umieścić? Podzielcie się waszymi pomysłami w komentarzach.

[Git] Czasem dopiero po chwili wiesz jak dobrze nazwać

Tak najpierw nazwałem commity:
Install angular
AngularJS TypeScript typings
Update jQuery definitions for TypeScript

A później samo do mnie doszło że lepszymi nazwami będzie:
Install angular with TypeScript typings (z połączenia dwóch pierwszych)
Update jQuery definitions for TypeScript

Dzięki funkcjonalności rebase interactive możemy pozmieniać nazwy (posklejać commity), aby było to bardziej sensowne. Opisuję jak to wyklikać z GUI.

[GIT] Szybkie przechodzenie między repozytoriami w konsoli

Idziemy do katalogu z zainstalowanym GITem do folderu etc (C:\Program Files\Git\etc).

Jest tam plik bash.bashrc.

Plik edytujemy jako administrator i na końcu dodajemy aliasy:

To samo można uzyskać na wiele innych sposobów (ten akurat działa w mojej konfiguracji systemu). Ten tutaj sprawia, przy otwieraniu konsoli gitowej dodane zostaną do basha aliasy. Dzięki temu możemy wyjść poza to co można dodać w .gitconfig i możemy korzystać z łączenia z komendami konsolowymi takimi jak grep w przykładzie.

Co gdy każdy programista ma inne lokalne ustawienia aplikacji?

Całkiem normalną sytuacją jest, gdy każdy sam sobie instaluje server bazy danych (powiedzmy SQL Server). Wtedy u każdego ta nazwa może być różna. Ktoś zainstalował wersję SQL Express, ktoś inny ma już kilka wersji SQL (2008, 2012, 2014, 2016, …) różnie nazwanych, u kogoś innego w poprzednim projekcie instancja musiała się konkretnie nazywać.

Podmiana w configu i ignorowanie

Prędzej czy później dochodzimy więc do sytuacji, że aby odpalić taką aplikację lokalnie każdy sobie podmienia connection string i robi tak, żeby System Kontroli Wersji nie widział tego jako zmiany, czyli żeby nie poszło z następnym commitem.

Wspólny Setup

Inne rozwiązanie to jakiś wspólny setup stawiania całego środowiska. Kiedyś było to klonowanie maszyny wirtualnej, teraz będą to kontenery lub skrypty, które to lokalnie ustawią. Jeśli jedynym problem, który próbujemy rozwiącać jest ta nazwa instancji servera, to takie podejście to duuuże przekombinowanie.

Proste rozwiązanie w kodzie

To wersja najprostsza, ale widać całą ideę. Dodajemy nazwę maszyny do nazwy connection stringa:

Niezmienne rzeczy jak providerName zostały usunięte.

W ostatnim projekcie na 4 developerów były 3 różne nazwy.

Czy warto korzystać z float zamiast double (oszczędność pamięci)

TLDR: Nie, nie warto.

618px-IEEE_754_Double_Floating_Point_Format.svg
Obrazek z https://en.wikipedia.org/wiki/Double-precision_floating-point_format

Wszędzie double

Wszędzie gdzie potrzebna jest wartość zmienno-przecinkowa używam double, ponieważ:

  • nie chce mi się rozkminiać, które wartości mogą być mniej dokładne (idąć dalej, co to znaczy mniej dokładne i kto o tym decyduje) – szkoda czasu.
  • gdyby system miał czasem float a czasem double – powodzenia w zabawie z konwersją, bo żeby je pomnożyć lub dodać to zostaną rozszerzone do double, a potem trzeba skrócić do float – szkoda czasu.
  • gdyby system miał wszędzie float – to by oznaczało, że ktoś świadomie przehandlował pamięć w zamian za dokładność – przypadek bardzo graniczny – w większości przypadków tak nie będzie, szkoda czasu.

Jeden raz użyłem float

Jedyny przypadek gdy w moim kodzie świadomie użyłem floata był gdy zczytywane były dane z mikrokontrolera i one rzeczywiście były floatem.

Float nie jest szybszy niż double

Jeśli już chcemy zchodzić tak głęboko to z Float vs Double Performance wynika:


On x86 processors, at least, float and double will each be converted to a 10-byte real by the FPU for processing. The FPU doesn’t have separate processing units for the different floating-point types it supports.

ale znajdzie się przypadek szczególny, gdzie większy rozmiar doubla wpłynie na rozmiar danych wysyłanych jednorazowo do procesora i cache… itd.

Czy mnie to w ogóle powinno obchodzić?

Wchodząc na pole takich optymalizacji warto się cofnąć i zastanowić czy naprawdę każdy developer w zespole rozumie co to wszystko oznacza? Czy znajome są każdemu pojęcia bottleneck, false-sharing, branch prediction? Wiem, że w pisaniu aplikacji biznesowych nie każdy je zna i nie są one każdemu potrzebne. Wtedy jedynym drogowskazem jest pisanie w sposób możliwie prosty – wszędzie double.

A jak się ma do tego decimal?

Decimal służy do czegoś innego (głównie kwoty pieniężne), więc celowo pomijam go w tej dyskusji.

Dzielenie z resztą bez rzutowania na float

Aby dzielenie odbyło się z resztą operacja musi się odbyć na typach double a nie na int, czyli żeby wynik nie był zaokrąglony do inta. W praktyce dzielenie na intach:

int result = 4/3; // result == 1
Kiedyś rzutowałem w ten sposób:
int rowsNeeded = (int)Math.Ceiling((double)Sources.Count / 2);
A od dziś dzięki Grzesiowi będę zmieniał drugą liczbę na explicit double (2D):
int rowsNeeded = (int)Math.Ceiling(Sources.Count / 2D);

Analogicznie dla decimal (literka M)

decimal amount = 4M;