FEATURE: Include optimized thumbnails for topics (#9215)
This introduces new APIs for obtaining optimized thumbnails for topics. There are a few building blocks required for this:
- Introduces new `image_upload_id` columns on the `posts` and `topics` table. This replaces the old `image_url` column, which means that thumbnails are now restricted to uploads. Hotlinked thumbnails are no longer possible. In normal use (with pull_hotlinked_images enabled), this has no noticeable impact
- A migration attempts to match existing urls to upload records. If a match cannot be found then the posts will be queued for rebake
- Optimized thumbnails are generated during post_process_cooked. If thumbnails are missing when serializing a topic list, then a sidekiq job is queued
- Topic lists and topics now include a `thumbnails` key, which includes all the available images:
```
"thumbnails": [
{
"max_width": null,
"max_height": null,
"url": "//example.com/original-image.png",
"width": 1380,
"height": 1840
},
{
"max_width": 1024,
"max_height": 1024,
"url": "//example.com/optimized-image.png",
"width": 768,
"height": 1024
}
]
```
- Themes can request additional thumbnail sizes by using a modifier in their `about.json` file:
```
"modifiers": {
"topic_thumbnail_sizes": [
[200, 200],
[800, 800]
],
...
```
Remember that these are generated asynchronously, so your theme should include logic to fallback to other available thumbnails if your requested size has not yet been generated
- Two new raw plugin outlets are introduced, to improve the customisability of the topic list. `topic-list-before-columns` and `topic-list-before-link`
2020-05-05 16:07:50 +08:00
|
|
|
# frozen_string_literal: true
|
|
|
|
require 'rails_helper'
|
|
|
|
|
|
|
|
describe "TopicThumbnail" do
|
2020-10-27 09:39:52 +08:00
|
|
|
let(:upload1) { Fabricate(:image_upload, width: 50, height: 50) }
|
FEATURE: Include optimized thumbnails for topics (#9215)
This introduces new APIs for obtaining optimized thumbnails for topics. There are a few building blocks required for this:
- Introduces new `image_upload_id` columns on the `posts` and `topics` table. This replaces the old `image_url` column, which means that thumbnails are now restricted to uploads. Hotlinked thumbnails are no longer possible. In normal use (with pull_hotlinked_images enabled), this has no noticeable impact
- A migration attempts to match existing urls to upload records. If a match cannot be found then the posts will be queued for rebake
- Optimized thumbnails are generated during post_process_cooked. If thumbnails are missing when serializing a topic list, then a sidekiq job is queued
- Topic lists and topics now include a `thumbnails` key, which includes all the available images:
```
"thumbnails": [
{
"max_width": null,
"max_height": null,
"url": "//example.com/original-image.png",
"width": 1380,
"height": 1840
},
{
"max_width": 1024,
"max_height": 1024,
"url": "//example.com/optimized-image.png",
"width": 768,
"height": 1024
}
]
```
- Themes can request additional thumbnail sizes by using a modifier in their `about.json` file:
```
"modifiers": {
"topic_thumbnail_sizes": [
[200, 200],
[800, 800]
],
...
```
Remember that these are generated asynchronously, so your theme should include logic to fallback to other available thumbnails if your requested size has not yet been generated
- Two new raw plugin outlets are introduced, to improve the customisability of the topic list. `topic-list-before-columns` and `topic-list-before-link`
2020-05-05 16:07:50 +08:00
|
|
|
let(:topic) { Fabricate(:topic, image_upload: upload1) }
|
2020-10-27 09:39:52 +08:00
|
|
|
let(:upload2) { Fabricate(:image_upload, width: 50, height: 50) }
|
2020-07-16 09:15:53 +08:00
|
|
|
let(:topic2) { Fabricate(:topic, image_upload: upload2) }
|
2020-08-14 06:54:28 +08:00
|
|
|
let(:upload3) { Fabricate(:upload_no_dimensions) }
|
|
|
|
let(:topic3) { Fabricate(:topic, image_upload: upload3) }
|
2020-07-16 09:15:53 +08:00
|
|
|
|
FEATURE: Include optimized thumbnails for topics (#9215)
This introduces new APIs for obtaining optimized thumbnails for topics. There are a few building blocks required for this:
- Introduces new `image_upload_id` columns on the `posts` and `topics` table. This replaces the old `image_url` column, which means that thumbnails are now restricted to uploads. Hotlinked thumbnails are no longer possible. In normal use (with pull_hotlinked_images enabled), this has no noticeable impact
- A migration attempts to match existing urls to upload records. If a match cannot be found then the posts will be queued for rebake
- Optimized thumbnails are generated during post_process_cooked. If thumbnails are missing when serializing a topic list, then a sidekiq job is queued
- Topic lists and topics now include a `thumbnails` key, which includes all the available images:
```
"thumbnails": [
{
"max_width": null,
"max_height": null,
"url": "//example.com/original-image.png",
"width": 1380,
"height": 1840
},
{
"max_width": 1024,
"max_height": 1024,
"url": "//example.com/optimized-image.png",
"width": 768,
"height": 1024
}
]
```
- Themes can request additional thumbnail sizes by using a modifier in their `about.json` file:
```
"modifiers": {
"topic_thumbnail_sizes": [
[200, 200],
[800, 800]
],
...
```
Remember that these are generated asynchronously, so your theme should include logic to fallback to other available thumbnails if your requested size has not yet been generated
- Two new raw plugin outlets are introduced, to improve the customisability of the topic list. `topic-list-before-columns` and `topic-list-before-link`
2020-05-05 16:07:50 +08:00
|
|
|
before do
|
|
|
|
SiteSetting.create_thumbnails = true
|
2020-10-27 09:39:52 +08:00
|
|
|
|
|
|
|
Topic.stubs(:thumbnail_sizes).returns([[49, 49]])
|
|
|
|
|
2020-07-07 05:30:57 +08:00
|
|
|
topic.generate_thumbnails!(extra_sizes: nil)
|
FEATURE: Include optimized thumbnails for topics (#9215)
This introduces new APIs for obtaining optimized thumbnails for topics. There are a few building blocks required for this:
- Introduces new `image_upload_id` columns on the `posts` and `topics` table. This replaces the old `image_url` column, which means that thumbnails are now restricted to uploads. Hotlinked thumbnails are no longer possible. In normal use (with pull_hotlinked_images enabled), this has no noticeable impact
- A migration attempts to match existing urls to upload records. If a match cannot be found then the posts will be queued for rebake
- Optimized thumbnails are generated during post_process_cooked. If thumbnails are missing when serializing a topic list, then a sidekiq job is queued
- Topic lists and topics now include a `thumbnails` key, which includes all the available images:
```
"thumbnails": [
{
"max_width": null,
"max_height": null,
"url": "//example.com/original-image.png",
"width": 1380,
"height": 1840
},
{
"max_width": 1024,
"max_height": 1024,
"url": "//example.com/optimized-image.png",
"width": 768,
"height": 1024
}
]
```
- Themes can request additional thumbnail sizes by using a modifier in their `about.json` file:
```
"modifiers": {
"topic_thumbnail_sizes": [
[200, 200],
[800, 800]
],
...
```
Remember that these are generated asynchronously, so your theme should include logic to fallback to other available thumbnails if your requested size has not yet been generated
- Two new raw plugin outlets are introduced, to improve the customisability of the topic list. `topic-list-before-columns` and `topic-list-before-link`
2020-05-05 16:07:50 +08:00
|
|
|
|
|
|
|
TopicThumbnail.ensure_consistency!
|
|
|
|
topic.reload
|
|
|
|
|
|
|
|
expect(topic.topic_thumbnails.length).to eq(1)
|
|
|
|
end
|
|
|
|
|
2020-07-16 09:15:53 +08:00
|
|
|
it "does not enque job if original image is too large" do
|
2020-07-17 04:30:23 +08:00
|
|
|
upload2.filesize = SiteSetting.max_image_size_kb.kilobytes + 1
|
2020-07-16 09:15:53 +08:00
|
|
|
SiteSetting.create_thumbnails = true
|
|
|
|
topic2.generate_thumbnails!(extra_sizes: nil)
|
|
|
|
|
|
|
|
TopicThumbnail.ensure_consistency!
|
|
|
|
topic2.reload
|
|
|
|
|
|
|
|
expect(topic2.topic_thumbnails.length).to eq(0)
|
2020-08-14 06:54:28 +08:00
|
|
|
expect(Jobs::GenerateTopicThumbnails.jobs.size).to eq(0)
|
|
|
|
end
|
|
|
|
|
|
|
|
it "does not enque job if image_upload width is nil" do
|
|
|
|
SiteSetting.create_thumbnails = true
|
|
|
|
topic3.image_url(enqueue_if_missing: true)
|
|
|
|
|
|
|
|
TopicThumbnail.ensure_consistency!
|
|
|
|
topic3.reload
|
|
|
|
|
|
|
|
expect(topic3.topic_thumbnails.length).to eq(0)
|
|
|
|
expect(Jobs::GenerateTopicThumbnails.jobs.size).to eq(0)
|
2020-07-16 09:15:53 +08:00
|
|
|
end
|
|
|
|
|
FEATURE: Include optimized thumbnails for topics (#9215)
This introduces new APIs for obtaining optimized thumbnails for topics. There are a few building blocks required for this:
- Introduces new `image_upload_id` columns on the `posts` and `topics` table. This replaces the old `image_url` column, which means that thumbnails are now restricted to uploads. Hotlinked thumbnails are no longer possible. In normal use (with pull_hotlinked_images enabled), this has no noticeable impact
- A migration attempts to match existing urls to upload records. If a match cannot be found then the posts will be queued for rebake
- Optimized thumbnails are generated during post_process_cooked. If thumbnails are missing when serializing a topic list, then a sidekiq job is queued
- Topic lists and topics now include a `thumbnails` key, which includes all the available images:
```
"thumbnails": [
{
"max_width": null,
"max_height": null,
"url": "//example.com/original-image.png",
"width": 1380,
"height": 1840
},
{
"max_width": 1024,
"max_height": 1024,
"url": "//example.com/optimized-image.png",
"width": 768,
"height": 1024
}
]
```
- Themes can request additional thumbnail sizes by using a modifier in their `about.json` file:
```
"modifiers": {
"topic_thumbnail_sizes": [
[200, 200],
[800, 800]
],
...
```
Remember that these are generated asynchronously, so your theme should include logic to fallback to other available thumbnails if your requested size has not yet been generated
- Two new raw plugin outlets are introduced, to improve the customisability of the topic list. `topic-list-before-columns` and `topic-list-before-link`
2020-05-05 16:07:50 +08:00
|
|
|
it "cleans up deleted uploads" do
|
|
|
|
upload1.delete
|
|
|
|
|
|
|
|
TopicThumbnail.ensure_consistency!
|
|
|
|
topic.reload
|
|
|
|
|
|
|
|
expect(topic.topic_thumbnails.length).to eq(0)
|
|
|
|
end
|
|
|
|
|
|
|
|
it "cleans up deleted optimized images" do
|
|
|
|
upload1.optimized_images.reload.delete_all
|
|
|
|
|
|
|
|
TopicThumbnail.ensure_consistency!
|
|
|
|
topic.reload
|
|
|
|
|
|
|
|
expect(topic.topic_thumbnails.length).to eq(0)
|
|
|
|
end
|
|
|
|
|
|
|
|
it "cleans up unneeded sizes" do
|
|
|
|
expect(topic.topic_thumbnails.length).to eq(1)
|
|
|
|
topic.topic_thumbnails[0].update_column(:max_width, 999999)
|
|
|
|
|
|
|
|
TopicThumbnail.ensure_consistency!
|
|
|
|
topic.reload
|
|
|
|
|
|
|
|
expect(topic.topic_thumbnails.length).to eq(0)
|
|
|
|
end
|
|
|
|
end
|