bogdanpolak/mailinglistvcl

Mailing List is sample Delphi VCL project (SQL client-server)

mailinglistvcl's Issues

Usunąć zbędne zależności Dialogu względem Ramki

Dialog Dialog.ResolveImportConflicts.pas zależy od ramki Frame.ImportContacts.TFrameImport. Potrzebuje jedynie dostępu do danych z aktualnego (jednego) wiersza w tabeli mtabEmails. Dane te są wyświetlane w kontrolkach a w kodzie są ustawiane pola boolean: Conflicts i Import.

MailingListVCL/project/Dialog.ResolveImportConflicts.pas

Lines 40 to 48 in 7d1757a

	function ShowDialog_ResolveConflicts(FrameImportContacts: TFrame): boolean;
	var
	frm: TDialogResolveConflicts;
	mr: Integer;
	begin
	try
	frm := TDialogResolveConflicts.Create(Application);
	frm.DataSource1.DataSet := (FrameImportContacts as TFrameImport).mtabEmails;
	mr := frm.ShowModal;

Zminimalizować zależności: Można użyć typu ogólnego TFDMemTable albo połączyć dane z interfejsem użytkownika przez interfejs.

Wyszukać miejsca gdzie są zaszyte SQL-e

Wyszukać miejsca a DFM-ach, gdzie są na stałe wpisane polecenia SQL w properties-ach TFDQuery.SQL.Text. Podobnie polecenia SQL które są klejone w kodzie na stringach.

Działanie potrzebne do wydzielenia (w przyszłości) repozytorium SQL-i

Zapisywanie i weryfikacji wersji aplikacji w zasobach

1. Zapisywanie wersji w zasobach aplikacji EXE
2. Odczytywanie zapisanej wersji w czasie uruchomienia aplikacji
3. Weryfikacja wersji z wersją zapisaną w konfiguracji projektu

Refaktoring: Frame.ImportContacts.pas - btnLoadNewEmailsClick

DONE (Zadanie zrobione):

MailingListVCL/project/Frame.ImportContacts.pas

Line 82 in 7d1757a

// { TODO: Zapytanie ukryte w atrybucie *.SQL.Text - code review }

Nie widoczne wypełnianie w pętli tabeli pamięciowej mtabEmails (TFDMemTable):

MailingListVCL/project/Frame.ImportContacts.pas

Lines 79 to 88 in 7d1757a

	mtabEmails.Open;
	mtabEmails.EmptyDataSet;
	mtabEmailsImport.DisplayValues := ';';
	// { TODO: Zapytanie ukryte w atrybucie *.SQL.Text - code review }
	// przypisano treść zapytania w kodzie
	dsQueryCurrEmails.SQL.Text :=
	'select email, firstname, lastname, company from Contacts ';
	dsQueryCurrEmails.Open();
	for i := 0 to jData.Count - 1 do
	myAddRowToImportTable(jData.Items[i] as TJSONObject);

Ukryta zależność w funkcji myAddRowToImportTable od globalnego dataseta dsQueryCurrEmail:

MailingListVCL/project/Frame.ImportContacts.pas

Lines 84 to 88 in 7d1757a

	dsQueryCurrEmails.SQL.Text :=
	'select email, firstname, lastname, company from Contacts ';
	dsQueryCurrEmails.Open();
	for i := 0 to jData.Count - 1 do
	myAddRowToImportTable(jData.Items[i] as TJSONObject);

Dwukrotne dodanie tej samej ramki

Gdy jest już otwarta ramka (na liście zakładek) próbie ponownego otwarcie wyskakuje wyjątek.

Procedura:

• Otwórz ramkę [Import kontaktów]
• Ponownie wybierz polecenie [Import kontaktów]

Zmiana zakładek nie przełącza ramek

Po przełaczeniu zakładek (ChromeTabs1) powinny przełączać się widoczne ramki. Jednak wudać tylko ostatnio daną ramkę.

Kroki:

• Zaloguj się
• Sprawdź czy widzisz główny ekaran oraz czy widoczna jest ramka powitalna (Welcome)
• Dodaj dowolną ramkę (np. Import kontaktów)
• Przełacz się na ramkę powitalną (Welcome)

Refaktoring Dialog.RunSQLScript.pas - demonstracyjne kontakty

Zamienić na tablicę dynamiczną:

MailingListVCL/project/Dialog.RunSQLScript.pas

Lines 53 to 55 in 7d1757a

	const
	NUMBER_OF_EMAILS = 5;
	EmailTableData: array [0 .. NUMBER_OF_EMAILS - 1] of TEmailRec =

Dokumentacja:

• http://blog.marcocantu.com/blog/2014_september_dynamic_arrays_delphixe7.html
• http://docwiki.embarcadero.com/RADStudio/Tokyo/en/Structured_Types_(Delphi)#String-Like_Operations_Supported_on_Dynamic_Arrays
• https://stackoverflow.com/questions/4070094/create-a-constant-array-of-strings

Formatowanie daty niezależne od systemu (najlepiej ISO):

MailingListVCL/project/Dialog.RunSQLScript.pas

Lines 57 to 58 in 7d1757a

	{ TODO : Poprawić: Formatowanie daty i czasu zależne od ustawień regionalnych }
	lastName: 'Polak'; comapny: 'BSC Polska'; regDate: '15.08.2018 19:30'),

Dokumentacja

• http://docwiki.embarcadero.com/Libraries/XE8/en/System.DateUtils.ISO8601ToDate

Poprawki na warsztaty - Dialog.RunSQLScript.pas

Zamienić na tablicę dynamiczną:

MailingListVCL/project/Dialog.RunSQLScript.pas

Lines 53 to 55 in 7d1757a

	const
	NUMBER_OF_EMAILS = 5;
	EmailTableData: array [0 .. NUMBER_OF_EMAILS - 1] of TEmailRec =

Dokumentacja:

• http://blog.marcocantu.com/blog/2014_september_dynamic_arrays_delphixe7.html
• http://docwiki.embarcadero.com/RADStudio/Tokyo/en/Structured_Types_(Delphi)#String-Like_Operations_Supported_on_Dynamic_Arrays
• https://stackoverflow.com/questions/4070094/create-a-constant-array-of-strings

Autentykacja - logowanie do aplikacji

1. Okno logowania
2. Weryfikacja z użytkownikiem zapisanym w bazie danych

Wydzielić i poprawić metodę checkDeveloperMode

Wydzielić metodę checkDeveloperMode:

MailingListVCL/project/Form.Main.pas

Lines 175 to 182 in 7d1757a

	{ TODO: Poprawić rozpoznawanie projektu: dpr w bieżącym folderze }
	{$IFDEF DEBUG}
	ext := '.dpr'; // do not localize
	sProjFileName := ChangeFileExt(ExtractFileName(Application.ExeName), ext);
	isDeveloperMode := FileExists('..\..\' + sProjFileName);
	{$ELSE}
	isDeveloperMode := False;
	{$ENDIF}

Refaktoring Form.Main.pas - tmrIdleTimer

Logika całej metody jest zbyt skomplikowana i mało czytelna:

MailingListVCL/project/Form.Main.pas

Lines 196 to 198 in 7d1757a

	begin
	{ TODO: Przebudować logikę metody. Jest zbyt skomplikowana i mało czytelna }
	tmr1 := (Sender as TTimer);

Koncepcja: stworzenie nowej metody eventOnFormFirstShow która będzie zawierała kilka metod (trzeba podzielić na prostsze elementy) - do dyskusji jakie ..

Zmienić nazwę timera na tmrFirstShow i logikę eventu tak aby wywoływany był tylko raz i potem blokowany: tmrFirstShow.Enabled := False (większe bezpieczeństwo)

Wyrzucenie demonstracyjnych kontaktów na zewnątrz

Wyrzucenie demonstracyjnych danych kontaktów z Dialog.RunSQLScript.pas gdzieś na zewnątrz:

MailingListVCL/project/Dialog.RunSQLScript.pas

Lines 43 to 46 in 7d1757a

	{ TODO : Nowocześniejsza struktura danych lub wyrzucenie danych na zewnątrz }
	type
	TEmailRec = record
	email: string;

(gdzie? - do dyskusji)

Poprawki na warsztaty - Frame.ImportContacts.pas

DONE (Zadanie zrobione):

MailingListVCL/project/Frame.ImportContacts.pas

Line 82 in 7d1757a

// { TODO: Zapytanie ukryte w atrybucie *.SQL.Text - code review }

Nie widoczne wypełnianie w pętli tabeli pamięciowej mtabEmails (TFDMemTable):

MailingListVCL/project/Frame.ImportContacts.pas

Lines 79 to 88 in 7d1757a

	mtabEmails.Open;
	mtabEmails.EmptyDataSet;
	mtabEmailsImport.DisplayValues := ';';
	// { TODO: Zapytanie ukryte w atrybucie *.SQL.Text - code review }
	// przypisano treść zapytania w kodzie
	dsQueryCurrEmails.SQL.Text :=
	'select email, firstname, lastname, company from Contacts ';
	dsQueryCurrEmails.Open();
	for i := 0 to jData.Count - 1 do
	myAddRowToImportTable(jData.Items[i] as TJSONObject);

Ukryta zależność w funkcji myAddRowToImportTable od globalnego dataseta dsQueryCurrEmail:

MailingListVCL/project/Frame.ImportContacts.pas

Lines 84 to 88 in 7d1757a

	dsQueryCurrEmails.SQL.Text :=
	'select email, firstname, lastname, company from Contacts ';
	dsQueryCurrEmails.Open();
	for i := 0 to jData.Count - 1 do
	myAddRowToImportTable(jData.Items[i] as TJSONObject);

Refaktoring: Frame.ImportContacts.pas - btnImportSelectedClick

Błąd #5 naprawiony. Jednak była to szybka poprawka. Cała funkcja wymaga refaktoringu.

MailingListVCL/project/Frame.ImportContacts.pas

Lines 103 to 105 in 7d1757a

	{ TODO: Błąd: jeśli lista do importu nie została wcześniej załadowana }
	{ TODO: Zamiana zwykłych INSERT-ów i UPADTE-ów do bazy na ArrayDML }
	// github: #5

Refaktoring kodu:

• Extract Method: FindContactID (email: string)
• Warto użyć TFDConnection.ExecScalar

MailingListVCL/project/Frame.ImportContacts.pas

Lines 115 to 122 in 7d1757a

	FDQuery2.SQL.Text := 'SELECT contactid FROM Contacts WHERE email=''' +
	email + '''';
	FDQuery2.Open;
	if FDQuery2.Eof then
	raise Exception.Create
	('Error! (FrameImport->btnImportSelected.OnClick) Email ' + email
	+ ' not found during import');
	id := FDQuery2.Fields[0].AsInteger;

Przechwytywany jest ogólny wyjątek (nie jest bezpieczne) i wygaszany:

MailingListVCL/project/Frame.ImportContacts.pas

Lines 150 to 156 in 7d1757a

	except
	on E: Exception do
	{ TODO: Brzydko pachnie! Wyciszam wszystkie wyjątki }
	// Potrzebny jest refaktoring metody powyżej aby przeanalizować
	ShowMessage
	('Teraz tego nie mogę zrobić! Zaimportuj najpierw listę kontaktów');
	end;

Funkcja [Zaimportuj zaznaczone] gdy lista importu nie została wcześniej załadowana

Ramka: Importu Kontakty
Jeśli lista do importu nie została wcześniej załadowana to po kliknięciu na button [Zaimportuj zaznaczone] wyskakuje wyjątek

Konieczne zwiększenie wydajność importu kontaktów

Początkowy import kontaktów trwa bardzo długo przy dużych listach. Proszę sprawdzić czy możliwa jest poprawa wydajności?