ぼざクリタグ広場 https://hub.nizika.monster
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 

526 lines
17 KiB

  1. require 'cgi'
  2. require 'rails_helper'
  3. require 'securerandom'
  4. RSpec.describe 'Wiki API', type: :request do
  5. let!(:user) { create_member_user! }
  6. let!(:tn) { TagName.create!(name: 'spec_wiki_title') }
  7. let!(:page) do
  8. WikiPage.create!(
  9. tag_name: tn,
  10. body: 'init',
  11. created_user: user,
  12. updated_user: user
  13. ).tap do |p|
  14. Wiki::Commit.content!(page: p, body: 'init', created_user: user, message: 'init')
  15. end
  16. end
  17. describe 'GET /wiki' do
  18. it 'returns wiki pages with title' do
  19. get '/wiki'
  20. expect(response).to have_http_status(:ok)
  21. expect(json).to be_an(Array)
  22. expect(json).not_to be_empty
  23. expect(json[0]).to have_key('title')
  24. expect(json.map { |p| p['title'] }).to include('spec_wiki_title')
  25. end
  26. end
  27. describe 'GET /wiki/:id' do
  28. subject(:request) do
  29. get "/wiki/#{ page_id }"
  30. end
  31. let(:page_id) { page.id }
  32. context 'when wiki page exists' do
  33. it 'returns wiki page with title' do
  34. request
  35. expect(response).to have_http_status(:ok)
  36. expect(json).to include(
  37. 'id' => page.id,
  38. 'title' => 'spec_wiki_title')
  39. end
  40. end
  41. context 'when wiki page does not exist' do
  42. let(:page_id) { 9_999_999 }
  43. it 'returns 404' do
  44. request
  45. expect(response).to have_http_status(:not_found)
  46. end
  47. end
  48. end
  49. describe 'POST /wiki' do
  50. let(:endpoint) { '/wiki' }
  51. let(:member) { create(:user, role: 'member') }
  52. let(:guest) { create(:user, role: 'guest') }
  53. def auth_headers(user)
  54. { 'X-Transfer-Code' => user.inheritance_code }
  55. end
  56. context 'when not logged in' do
  57. it 'returns 401' do
  58. post endpoint, params: { title: 'Test', body: 'Hello' }
  59. expect(response).to have_http_status(:unauthorized)
  60. end
  61. end
  62. context 'when logged in but not member' do
  63. it 'returns 403' do
  64. post endpoint, params: { title: 'Test', body: 'Hello' }, headers: auth_headers(guest)
  65. expect(response).to have_http_status(:forbidden)
  66. end
  67. end
  68. context 'when params invalid' do
  69. it 'returns 422 when title blank' do
  70. post endpoint, params: { title: '', body: 'Hello' }, headers: auth_headers(member)
  71. expect(response).to have_http_status(:unprocessable_entity)
  72. end
  73. it 'returns 422 when body blank' do
  74. post endpoint, params: { title: 'Test', body: '' }, headers: auth_headers(member)
  75. expect(response).to have_http_status(:unprocessable_entity)
  76. end
  77. end
  78. context 'when success' do
  79. it 'creates wiki_page and first content revision' do
  80. expect do
  81. post endpoint, params: { title: 'TestPage', body: "a\nb\nc", message: 'init' },
  82. headers: auth_headers(member)
  83. end
  84. .to change(WikiPage, :count).by(1)
  85. .and change(WikiRevision, :count).by(1)
  86. .and change(WikiVersion, :count).by(1)
  87. version = page.wiki_versions.order(:version_no).last
  88. expect(version).to have_attributes(
  89. version_no: 1,
  90. event_type: 'create',
  91. title: 'TestPage',
  92. body: "a\nb\nc",
  93. created_by_user_id: member.id
  94. )
  95. expect(response).to have_http_status(:created)
  96. page_id = json.fetch('id')
  97. expect(json.fetch('title')).to eq('TestPage')
  98. page = WikiPage.find(page_id)
  99. rev = page.current_revision
  100. expect(rev).to be_present
  101. expect(rev).to be_content
  102. expect(rev.message).to eq('init')
  103. # body が復元できること
  104. expect(page.body).to eq("a\nb\nc")
  105. # 行数とリレーションの整合
  106. expect(rev.lines_count).to eq(3)
  107. expect(rev.wiki_revision_lines.order(:position).pluck(:position)).to eq([0, 1, 2])
  108. expect(rev.wiki_lines.pluck(:body)).to match_array(%w[a b c])
  109. end
  110. it 'reuses existing WikiLine rows by sha256' do
  111. # 先に同じ行を作っておく
  112. WikiLine.create!(sha256: Digest::SHA256.hexdigest('a'), body: 'a', created_at: Time.current, updated_at: Time.current)
  113. post endpoint,
  114. params: { title: 'Reuse', body: "a\na" },
  115. headers: auth_headers(member)
  116. page = WikiPage.find(JSON.parse(response.body).fetch('id'))
  117. rev = page.current_revision
  118. expect(rev.lines_count).to eq(2)
  119. # "a" の WikiLine が増殖しない(1行のはず)
  120. expect(WikiLine.where(body: 'a').count).to eq(1)
  121. end
  122. it 'deduplicates duplicated new lines before upsert' do
  123. duplicated = 'duplicated_line_for_wiki_line_upsert_spec'
  124. post endpoint,
  125. params: { title: 'DuplicateNewLine', body: "#{ duplicated }\n#{ duplicated }" },
  126. headers: auth_headers(member)
  127. expect(response).to have_http_status(:created)
  128. page = WikiPage.find(json.fetch('id'))
  129. rev = page.current_revision
  130. expect(rev.lines_count).to eq(2)
  131. expect(WikiLine.where(body: duplicated).count).to eq(1)
  132. expect(rev.wiki_lines.where(body: duplicated).count).to eq(1)
  133. expect(rev.wiki_revision_lines.count).to eq(2)
  134. end
  135. it 'normalises CRLF and strips trailing newlines' do
  136. post endpoint,
  137. params: { title: 'NormalisedBody', body: "a\r\nb\r\n\r\n", message: 'normalise' },
  138. headers: auth_headers(member)
  139. expect(response).to have_http_status(:created)
  140. page = WikiPage.find(json.fetch('id'))
  141. rev = page.current_revision
  142. version = page.wiki_versions.order(:version_no).last
  143. expect(page.body).to eq("a\nb")
  144. expect(version.body).to eq("a\nb")
  145. expect(rev.lines_count).to eq(2)
  146. expect(rev.wiki_lines.order('wiki_revision_lines.position').map(&:body)).to eq(['a', 'b'])
  147. end
  148. end
  149. end
  150. describe 'PUT /wiki/:id' do
  151. let(:member) { create(:user, role: 'member', inheritance_code: SecureRandom.hex(16)) }
  152. let(:guest) { create(:user, role: 'guest', inheritance_code: SecureRandom.hex(16)) }
  153. def auth_headers(user)
  154. { 'X-Transfer-Code' => user.inheritance_code }
  155. end
  156. let!(:test_tag_name) { TagName.create!(name: 'TestPage') }
  157. let!(:page) do
  158. Wiki::Commit.create_content!(
  159. tag_name: test_tag_name,
  160. body: "a\nb",
  161. created_by_user: member,
  162. message: 'init')
  163. end
  164. context 'when not logged in' do
  165. it 'returns 401' do
  166. put "/wiki/#{page.id}", params: { title: 'TestPage', body: 'x' }
  167. expect(response).to have_http_status(:unauthorized)
  168. end
  169. end
  170. context 'when logged in but not member' do
  171. it 'returns 403' do
  172. put "/wiki/#{page.id}",
  173. params: { title: 'TestPage', body: 'x' },
  174. headers: auth_headers(guest)
  175. expect(response).to have_http_status(:forbidden)
  176. end
  177. end
  178. context 'when params invalid' do
  179. it 'returns 422 when body blank' do
  180. put "/wiki/#{page.id}",
  181. params: { title: 'TestPage', body: '' },
  182. headers: auth_headers(member)
  183. expect(response).to have_http_status(:unprocessable_entity)
  184. end
  185. it 'returns 422 when title mismatched (if you forbid rename here)' do
  186. put "/wiki/#{page.id}",
  187. params: { title: 'OtherTitle', body: 'x' },
  188. headers: auth_headers(member)
  189. # 君の controller 例だと title 変更は 422 にしてた
  190. expect(response).to have_http_status(:unprocessable_entity)
  191. end
  192. end
  193. context 'when success' do
  194. it 'creates new revision and returns 200' do
  195. current_id = page.wiki_revisions.maximum(:id)
  196. expect do
  197. put "/wiki/#{page.id}",
  198. params: { title: 'TestPage', body: "x\ny", message: 'edit', base_revision_id: current_id },
  199. headers: auth_headers(member)
  200. end
  201. .to change(WikiRevision, :count).by(1)
  202. .and change(WikiVersion, :count).by(1)
  203. version = page.wiki_versions.order(:version_no).last
  204. expect(version).to have_attributes(
  205. event_type: 'update',
  206. title: 'TestPage',
  207. body: "x\ny",
  208. created_by_user_id: member.id
  209. )
  210. expect(response).to have_http_status(:ok)
  211. page.reload
  212. rev = page.current_revision
  213. expect(rev).to be_content
  214. expect(rev.message).to eq('edit')
  215. expect(page.body).to eq("x\ny")
  216. expect(rev.base_revision_id).to eq(current_id)
  217. end
  218. it 'wiki page に対応する tag があれば tag version も作成する' do
  219. linked_tag_name = TagName.create!(name: 'wiki_linked_tag_for_version')
  220. linked_tag = Tag.create!(tag_name: linked_tag_name, category: :general)
  221. linked_page = WikiPage.create!(
  222. tag_name: linked_tag_name,
  223. body: 'before',
  224. created_user: member,
  225. updated_user: member
  226. )
  227. Wiki::Commit.content!(
  228. page: linked_page,
  229. body: 'before',
  230. created_user: member,
  231. message: 'init'
  232. )
  233. current_id = linked_page.wiki_revisions.maximum(:id)
  234. expect {
  235. put "/wiki/#{ linked_page.id }",
  236. params: {
  237. title: 'wiki_linked_tag_for_version',
  238. body: 'after',
  239. message: 'edit',
  240. base_revision_id: current_id,
  241. },
  242. headers: auth_headers(member)
  243. }
  244. .to change(WikiRevision, :count).by(1)
  245. .and change(WikiVersion, :count).by(1)
  246. .and change { linked_tag.reload.tag_versions.count }.by(1)
  247. expect(response).to have_http_status(:ok)
  248. version = linked_tag.reload.tag_versions.order(:version_no).last
  249. expect(version.event_type).to eq('update')
  250. expect(version.name).to eq('wiki_linked_tag_for_version')
  251. expect(version.created_by_user_id).to eq(member.id)
  252. end
  253. end
  254. # TODO: コンフリクト未実装のため,実装したらコメント外す.
  255. # context 'when conflict' do
  256. # it 'returns 409 when base_revision_id mismatches' do
  257. # # 先に別ユーザ(同じ member でもOK)が 1 回更新して先頭を進める
  258. # Wiki::Commit.content!(page: page, body: "zzz", created_user: member, message: 'other edit')
  259. # page.reload
  260. # stale_id = page.wiki_revisions.order(:id).first.id # わざと古い id
  261. # put "/wiki/#{page.id}",
  262. # params: { title: 'TestPage', body: 'x', base_revision_id: stale_id },
  263. # headers: auth_headers(member)
  264. # expect(response).to have_http_status(:conflict)
  265. # json = JSON.parse(response.body)
  266. # expect(json['error']).to eq('conflict')
  267. # end
  268. # end
  269. context 'when page not found' do
  270. it 'returns 404' do
  271. put "/wiki/99999999",
  272. params: { title: 'X', body: 'x' },
  273. headers: auth_headers(member)
  274. expect(response).to have_http_status(:not_found)
  275. end
  276. end
  277. end
  278. describe 'GET /wiki/title/:title' do
  279. it 'returns wiki page by title' do
  280. get "/wiki/title/#{CGI.escape('spec_wiki_title')}"
  281. expect(response).to have_http_status(:ok)
  282. expect(json).to have_key('id')
  283. expect(json).to have_key('title')
  284. expect(json['id']).to eq(page.id)
  285. expect(json['title']).to eq('spec_wiki_title')
  286. end
  287. it 'returns 404 when not found' do
  288. get "/wiki/title/#{ CGI.escape('nope') }"
  289. expect(response).to have_http_status(:not_found)
  290. end
  291. end
  292. describe 'GET /wiki/search' do
  293. before do
  294. # 追加で検索ヒット用
  295. TagName.create!(name: 'spec_wiki_title_2')
  296. WikiPage.create!(tag_name: TagName.find_by!(name: 'spec_wiki_title_2'), body: 'init',
  297. created_user: user, updated_user: user)
  298. TagName.create!(name: 'unrelated_title')
  299. WikiPage.create!(tag_name: TagName.find_by!(name: 'unrelated_title'), body: 'init',
  300. created_user: user, updated_user: user)
  301. end
  302. it 'returns up to 20 pages filtered by title like' do
  303. get "/wiki/search?title=#{CGI.escape('spec_wiki')}"
  304. expect(response).to have_http_status(:ok)
  305. expect(json).to be_an(Array)
  306. titles = json.map { |p| p['title'] }
  307. expect(titles).to include('spec_wiki_title', 'spec_wiki_title_2')
  308. expect(titles).not_to include('unrelated_title')
  309. end
  310. it 'returns all when title param is blank' do
  311. get "/wiki/search?title=#{CGI.escape('')}"
  312. expect(response).to have_http_status(:ok)
  313. expect(json).to be_an(Array)
  314. expect(json.map { |p| p['title'] }).to include('spec_wiki_title')
  315. end
  316. end
  317. describe 'GET /wiki/changes' do
  318. let!(:rev1) do
  319. Wiki::Commit.content!(page: page, body: "a\nb", created_user: user, message: 'r1')
  320. page.current_revision
  321. end
  322. let!(:rev2) do
  323. Wiki::Commit.content!(page: page, body: "a\nc", created_user: user, message: 'r2')
  324. page.current_revision
  325. end
  326. it 'returns latest revisions (optionally filtered by page id)' do
  327. get "/wiki/changes?id=#{page.id}"
  328. expect(response).to have_http_status(:ok)
  329. expect(json).to be_an(Array)
  330. expect(json).not_to be_empty
  331. top = json.first
  332. expect(top).to include(
  333. 'revision_id' => rev2.id,
  334. 'pred' => rev2.base_revision_id,
  335. 'succ' => nil,
  336. 'kind' => 'content',
  337. 'message' => 'r2'
  338. )
  339. expect(top['wiki_page']).to include('id' => page.id, 'title' => 'spec_wiki_title')
  340. expect(top['user']).to include('id' => user.id, 'name' => user.name)
  341. expect(top).to have_key('timestamp')
  342. # order desc をざっくり担保
  343. ids = json.map { |x| x['revision_id'] }
  344. expect(ids).to eq(ids.sort.reverse)
  345. end
  346. it 'returns empty array when page has no revisions and filtered by id' do
  347. # 別ページを作って revision 無し
  348. tn2 = TagName.create!(name: 'spec_no_rev')
  349. p2 = WikiPage.create!(tag_name: tn2, body: 'init', created_user: user, updated_user: user)
  350. get "/wiki/changes?id=#{p2.id}"
  351. expect(response).to have_http_status(:ok)
  352. expect(json).to eq([])
  353. end
  354. end
  355. describe 'GET /wiki/title/:title/exists' do
  356. it 'returns 204 when exists' do
  357. get "/wiki/title/#{CGI.escape('spec_wiki_title')}/exists"
  358. expect(response).to have_http_status(:no_content)
  359. expect(response.body).to be_empty
  360. end
  361. it 'returns 404 when not exists' do
  362. get "/wiki/title/#{CGI.escape('nope')}/exists"
  363. expect(response).to have_http_status(:not_found)
  364. end
  365. end
  366. describe 'GET /wiki/:id/exists' do
  367. it 'returns 204 when exists' do
  368. get "/wiki/#{page.id}/exists"
  369. expect(response).to have_http_status(:no_content)
  370. expect(response.body).to be_empty
  371. end
  372. it 'returns 404 when not exists' do
  373. get "/wiki/99999999/exists"
  374. expect(response).to have_http_status(:not_found)
  375. end
  376. end
  377. describe 'GET /wiki/:id/diff' do
  378. let!(:rev_a) do
  379. Wiki::Commit.content!(page: page, body: "a\nb\nc", created_user: user, message: 'A')
  380. page.current_revision
  381. end
  382. let!(:rev_b) do
  383. Wiki::Commit.content!(page: page, body: "a\nx\nc", created_user: user, message: 'B')
  384. page.current_revision
  385. end
  386. it 'returns diff json between revisions' do
  387. get "/wiki/#{page.id}/diff?from=#{rev_a.id}&to=#{rev_b.id}"
  388. expect(response).to have_http_status(:ok)
  389. expect(json).to include(
  390. 'wiki_page_id' => page.id,
  391. 'title' => 'spec_wiki_title',
  392. 'older_revision_id' => rev_a.id,
  393. 'newer_revision_id' => rev_b.id
  394. )
  395. expect(json['diff']).to be_an(Array)
  396. # ざっくり「b が消えて x が増えた」が含まれることを確認
  397. types = json['diff'].map { |x| x['type'] }
  398. expect(types).to include('removed', 'added').or include('removed').and include('added')
  399. end
  400. it 'uses latest as "to" when to is omitted' do
  401. get "/wiki/#{page.id}/diff?from=#{rev_a.id}"
  402. expect(response).to have_http_status(:ok)
  403. expect(json['older_revision_id']).to eq(rev_a.id)
  404. expect(json['newer_revision_id']).to eq(page.current_revision.id)
  405. end
  406. end
  407. describe 'Wiki::Commit.redirect!' do
  408. it 'raises because redirect revisions are deprecated' do
  409. target_tag_name = TagName.create!(name: 'redirect_deprecated_target')
  410. target = WikiPage.create!(
  411. tag_name: target_tag_name,
  412. body: 'target',
  413. created_user: user,
  414. updated_user: user
  415. )
  416. expect {
  417. Wiki::Commit.redirect!(
  418. page: page,
  419. redirect_page: target,
  420. created_user: user,
  421. message: 'redirect',
  422. base_revision_id: page.current_revision.id
  423. )
  424. }.to raise_error(RuntimeError, '廃止しました.')
  425. end
  426. end
  427. end