Page MenuHomeSealhub

Dodanie obsługi .webp do komponentu responsive-image
ClosedPublic

Authored by michal.starski on May 21 2019, 22:56.
Tags
None
Referenced Files
F972196: D620.id.diff
Sun, Nov 24, 15:26
Unknown Object (File)
Fri, Nov 22, 11:41
Unknown Object (File)
Fri, Nov 22, 08:48
Unknown Object (File)
Fri, Nov 22, 07:12
Unknown Object (File)
Fri, Nov 22, 06:49
Unknown Object (File)
Fri, Nov 22, 00:39
Unknown Object (File)
Thu, Nov 21, 18:38
Unknown Object (File)
Thu, Nov 21, 10:43

Details

Reviewers
arkadiusz-wieczorek
kuba-orlik
Group Reviewers
Unknown Object (Project)
Maniphest Tasks
Unknown Object (Maniphest Task)
Commits
rSEALPAGE3e73509457e3: Dodanie obsługi .webp do komponentu responsive-image
Summary

Ref T1500

Diff Detail

Repository
rSEALPAGE Sealpage
Branch
webp-resp-img
Lint
No Lint Coverage
Unit
No Test Coverage
Build Status
Buildable 1755
Build 1755: arc lint + arc unit

Event Timeline

There are a very large number of changes, so older changes are hidden. Show Older Changes
This revision now requires changes to proceed.May 24 2019, 09:36
michal.starski marked an inline comment as done.
  • moved after() to be after describe

responsive_image trzeba też eksportować w components/index.js

This revision now requires changes to proceed.May 24 2019, 15:46
components/responsive-image/responsive-image.html.js
20

Trzeba jeszcze komponent dostosować do nowego API (klasa Component - zob. np. komponent [Markdown](https://hub.sealcode.org/diffusion/SEALPAGE/browse/master/components/markdown/markdown.html.js)

michal.starski marked an inline comment as done.
  • adjusted ResponsiveImage for the new Component API

Accept, z jedną zmianą

components/responsive-image/responsive-image.html.js
105–122

zbyt rozległy zapis. Wystarczy:

renderFn: responsive_image_creator,
This revision is now accepted and ready to land.May 30 2019, 16:09

W tym momencie nie można wylądować ze względu na występujący error

TypeError: Error.captureStackTrace is not a function
This revision is now accepted and ready to land.May 30 2019, 21:56

W tym momencie nie można wylądować ze względu na występujący error

TypeError: Error.captureStackTrace is not a function

Możesz przytoczyć cały stack?

This revision now requires changes to proceed.Jun 3 2019, 21:15

W tym momencie nie można wylądować ze względu na występujący error

TypeError: Error.captureStackTrace is not a function

Możesz przytoczyć cały stack?

image.png (497×979 px, 123 KB)

Podejrzewam, że przyczyną tych błędów jest fakt, że na front idzie kod z depsami przeznaczonymi tylko na backend (np. ta libka do obróbki zdjęć). Mam proponowane rozwiązanie:

https://forum.sealcode.org/t/sealpage-przeyslenia-dot-podzialu-komponentow-na-pliki-dla-backendu-i-front-endu/1052

kuba-orlik changed the visibility from "Unknown Object (Project) (Project)" to "Public (No Login Required)".Jun 18 2019, 16:57
  • merge
  • initial responsive-image refactor for webp support
  • removed unnecessary files and fixed tests for the new api
kuba-orlik requested changes to this revision.Jul 3 2019, 13:33

Potrzebna dokumentacja

This revision now requires changes to proceed.Jul 3 2019, 13:33
  • Added some docs about Plugins
kuba-orlik requested changes to this revision.Jul 9 2019, 13:57

Proponuję w dokumentacji (i w kodzie?) zmienić nazwę Plugins na ExternalComponents. Taka nazwa będzie imho lepiej odzwierciedlała stan faktyczny. "Plugin" będzie lepiej zarezerwować na przyszłość, kiedy będą jakieś paczki z dużą ilością powiązanych funkcjonalności, np. plugin do robienia blogów, itp. Wiem, że trochę późno to zgłaszam, ale pomoże nam to zapobiec problemom na przyszłość

README.md
87–88 ↗(On Diff #2373)

A czy tu nie trzeba najpierw zaimportować Sealpage'a? Żeby Component nie było undefined?

128 ↗(On Diff #2373)

(...) - an array of plugins

129 ↗(On Diff #2373)

into *the* array

160 ↗(On Diff #2373)

what do display => what is being displayed

170–177 ↗(On Diff #2373)

tutaj mamy trochę kolizję na słowie control, co utrudnia czytelnosć. Proponuję zmienić ten używany w przykładach komponent na Greet, który we wcześniejszym przykładzie pisze tylko Hello, a w późniejszym dostaje prop-a name i pisze Hello, ${name}

components/responsive-image/responsive-image.html.js
84

zamiast robić tu warunek specjalny dla webp proponuję w argsach podawać po prostu config osobno dla każdego formatu:

{
webp: {..},
png: {...}
}
84–85

{ i return są tutaj niepotrzebne, można zostawić gołe arrow function;

ext => resolutions.map //...
88

jeżeli źródłowy plik jest w png, to nie konwertujmy go do jpg, bo to może powodować niechciane artefakty. Proponuję abyśmy zawsze brali webp + format źródłowego zdjęcia. Np. webp+png, webp+jpeg.

92

do depsów trzeba też dodać config - wybraną dla aktualnego pliku rozdzielczość, format, jakość itp. Aby ich zmiana powodowała przerenderowanie

This revision now requires changes to proceed.Jul 9 2019, 13:57
michal.starski marked 9 inline comments as done.
  • renamed plugin -> externalComponents
  • changes in responsive-image.html.js

@kuba-orlik patrzyłeś/wykonywałeś npm test? Czy jest on dobrze napisany?

wcześniej npm test mi przechodziło, ale teraz rzuca:

0 passing (220ms)
2 failing

1) responsive-image-creator
     Should create images with given resolutions:
   Error: ENOENT: no such file or directory, access '/home/kuba/projects/midline/sealpage/components/responsive-image/test/images/test-img-200.cdb2366880b69ed5764e43ad0b19c728.webp'
    at Object.accessSync (fs.js:197:3)
    at Context.<anonymous> (components/responsive-image/test/responsive-image.test.js:41:8)

2) responsive-image-creator
     Should resolve a valid responsive html picture tag:

    AssertionError [ERR_ASSERTION]: '<picture><sourcesrcset="images/test-img-200.07814c16e5bde1564ae925bf47cffe5e.webp200w,images/test-img-300.07814c16e5bde1564ae925bf47cffe5e.webp300w"sizes="100px"alt="alt"/><sourcesrcset="images/test-img-200.07814c16e5bde1564ae925bf47cffe5e.jpg200w,images/test-img-300.07814c16e5bde1564ae925bf47cffe5e.jpg300w"sizes="100px"alt="alt"/><imgsrc="images/test-img-300.07814c16e5bde1564ae925bf47cffe5e.jpg"alt="alt"/></picture>' == '<picture><sourcesrcset="images/test-img-200.cdb2366880b69ed5764e43ad0b19c728.webp200w,images/test-img-300.cdb2366880b69ed5764e43ad0b19c728.webp300w"sizes="100px"alt="alt"/><sourcesrcset="images/test-img-200.cdb2366880b69ed5764e43ad0b19c728.jpg200w,images/test-img-300.cdb2366880b69ed5764e43ad0b19c728.jpg300w"sizes="100px"alt="alt"/><imgsrc="images/test-img-300.cdb2366880b69ed5764e43ad0b19c728.jpg"alt="alt"/></picture>'
    + expected - actual

    -<picture><sourcesrcset="images/test-img-200.07814c16e5bde1564ae925bf47cffe5e.webp200w,images/test-img-300.07814c16e5bde1564ae925bf47cffe5e.webp300w"sizes="100px"alt="alt"/><sourcesrcset="images/test-img-200.07814c16e5bde1564ae925bf47cffe5e.jpg200w,images/test-img-300.07814c16e5bde1564ae925bf47cffe5e.jpg300w"sizes="100px"alt="alt"/><imgsrc="images/test-img-300.07814c16e5bde1564ae925bf47cffe5e.jpg"alt="alt"/></picture>
    +<picture><sourcesrcset="images/test-img-200.cdb2366880b69ed5764e43ad0b19c728.webp200w,images/test-img-300.cdb2366880b69ed5764e43ad0b19c728.webp300w"sizes="100px"alt="alt"/><sourcesrcset="images/test-img-200.cdb2366880b69ed5764e43ad0b19c728.jpg200w,images/test-img-300.cdb2366880b69ed5764e43ad0b19c728.jpg300w"sizes="100px"alt="alt"/><imgsrc="images/test-img-300.cdb2366880b69ed5764e43ad0b19c728.jpg"alt="alt"/></picture>
    
    at Context.<anonymous> (components/responsive-image/test/responsive-image.test.js:79:10)
README.md
179 ↗(On Diff #2386)

Tu chyba lepiej dać 'text' :)

components/responsive-image/responsive-image.html.js
76

image_path można stąd wyrzucić. Jeżeli file_hash się nie zmieniło, to nie ma potrzeby re-renderować tylko jak sie zmieni nazwa pliku

80

alt też można wyrzucić z tej listy. nie ma wpływu na plik wynikowy

81

tutaj najlepiej byłoby dać tylko te optionsy, które dotyczą aktualnie obrabianego typu pliku, np. tylko webp albo tylko jpg

This revision now requires changes to proceed.Jul 10 2019, 15:42
michal.starski marked 4 inline comments as done.
  • applied diff suggestions
  • fixed test to have adjustable file hash
michal.starski mentioned this in Unknown Object (Maniphest Task).Jul 12 2019, 12:31
kuba-orlik added inline comments.
components/responsive-image/test/responsive-image.test.js
24–29

Myślę, że ten test zaczyna być powoli kopią implementacji samego komponentu. Jak już to chcemy testować, to proponuję zamiast sprawdzania wartości hasza w nazwie pliku sprawdzać coś bardziej wysokopoziomowego, a mianowicie: czy hasz w pliku się zmienia, jeżeli plik źródłowy się zmienia? Nie musimy wtedy przywiązywać się do konkretnej wartości hasha ani nawet funkcji haszującej. Wywołajmy komponent raz, i sprawdźmy, czy daje prawidłowo sformowany obrazek (w tym celu najlepiej sprawdzi się jakaś libka do parsowania fragmentów html-a). Następnie wywołujemy komponent drugi raz i sprawdzamy, że daje dokładnie taki sam wynik jak poprzednim razem. Następnie Wywołujemy trzeci raz, ale zmieniamy tylko obrazek źródłowy - i powinno dać inny rezultat

This revision now requires changes to proceed.Jul 12 2019, 17:24
  • improved ResponsiveImage tests
kuba-orlik added inline comments.
components/responsive-image/test/responsive-image.test.js
40–43
68–72

nie musimy trzymać srcset i pattern w osobnej stałej, zmniejsza to czytelność. Proponuję po prostu:

assert(
  /images\/test-img-\d{3}\.[a-z0-9]{32}\.(webp|jpg)\s[0-9]{3}w/.test(
    child.attribs.srcset
  )
);
107–109

Te asserty są w callbacku, więc wydaje się, że nie zostaną wychwycone przez Mocha. Z jakiegoś powodu jednak są wychwytane, ale nie wiem jakim cudem. Niemniej jednak polecam spromisifikować readdir

This revision now requires changes to proceed.Jul 15 2019, 11:58
michal.starski marked 3 inline comments as done.
  • promisified fs.readdir
This revision is now accepted and ready to land.Jul 16 2019, 15:28