Computer >> Hướng Dẫn Máy Tính >  >> Lập Trình >> Ruby

Refactor mã Ruby on Rails quan trọng với Scientist: Cách tiếp cận đã được chứng minh

Hãy hỏi bất kỳ kỹ sư phần mềm nào xem xét các phần quan trọng của mã production, chắc chắn họ sẽ chỉ ra ba điều cần refactor. Vậy tại sao lại có nhiều mã kém, mong manh, hoặc bị hiểu lầm vẫn chạy trong production?

Câu trả lời đơn giản: kỹ sư sợ chạm vào nó. Nhiệm vụ refactor được xác định và thêm vào backlog, nhưng hiếm khi đưa vào sprint hiện tại.

Có nhiều lý do cho điều này. Mã có thể do kỹ sư viết rồi rời team nhiều năm trước, và không ai hiểu hoàn toàn. Trong trường hợp khác, khả năng đó quan trọng đối với kinh doanh. Không ai muốn chịu trách nhiệm cho sự cố tiềm ẩn hoặc mất doanh thu.

Trong bài viết này, chúng ta sẽ xem cách dùng Scientist để di chuyển (migrate), refactor, và thay đổi mã production Ruby quan trọng với sự tự tin.

Nhưng trước, bạn có thể hỏi — không thể dùng test để đào móc vấn đề mã không?

Đây chính là việc Rails Testing làm, phải không?

Có, và không. Thường khó để có niềm tin hoàn toàn vào thay đổi mã trước triển khai. Unit test và system test pass. Tốt, sẵn sàng triển khai, phải không?

Thực tế là không có thay thế cho thế giới thực, tức là production. Điều gì nếu chất lượng dữ liệu kém hoặc test thiếu? Làm sao biết phần mềm mới sẽ perform đủ tốt để xử lý throughput production?

Team có dịch vụ công cộng đôi khi thấy họ cần xử lý vấn đề "bugwards compatibility" (tương thích ngược với bug). Khi bug tồn tại trong production một thời gian, client có thể viết mã phụ thuộc vào hành vi sai nhưng nhất quán. Khách hàng thường dùng phần mềm theo cách không ngờ tới.

Quan sát thay đổi Production trong Ruby và Rails với Scientist

Nếu production là nơi tốt nhất để có niềm tin vào thay đổi, thì hãy cân nhắc quan sát cách mã hành xử ở đó. Điều này nghe có vẻ đáng sợ lúc đầu, vì ý tưởng "test trong production" mâu thuẫn với thực hành kỹ thuật phần mềm kinh điển.

Tuy nhiên, tin tốt là việc này dễ dàng và an toàn trong Ruby và Rails dùng gem Scientist. Tên Scientist dựa trên phương pháp khoa học thực hiện thí nghiệm để xác minh giả thuyết. Trong trường hợp này, giả thuyết của chúng ta là mã mới làm được việc.

Lý do chúng ta có thể an toàn tiếp cận này xuất phát từ việc thí nghiệm vẫn dùng kết quả của mã hiện có. Mã mới chỉ được đánh giá cho mục đích quan sát và so sánh, cả về độ chính xác và hiệu năng. Chúng ta giảm thiểu lo ngại về độ bao phủ test đã thảo luận trước bằng cách đánh giá hiệu năng dùng dữ liệu và tham số thực tế. Thí nghiệm thường đánh giá tỷ lệ mẫu (sample rate) yêu cầu được chọn để giảm thiểu tác động lên production. Tuy nhiên, bạn có thể đánh giá mọi yêu cầu nếu muốn.

Hãy nhìn nhanh cách Scientist hoạt động theo cách Branch by Abstraction (Nhánh bằng trừu tượng).

Mô hình Branch by Abstraction trong Ruby's Scientist

Cách tiếp cận của Scientist bắt đầu với mô hình Branch by Abstraction do Martin Fowler mô tả là làm "một thay đổi quy mô lớn cho hệ thống phần mềm theo cách dần dần".

Chúng ta giới thiệu một lớp trừu tượng (abstraction layer) để cô lập mã đang cập nhật. Lớp này quyết định triển khai nào dùng để thí nghiệm minh bạch với phần còn lại của hệ thống. Kỹ thuật này liên quan đến dùng feature flag quyết định đường đi mã (code path).

Gem Scientist, xuất phát từ Github, triển khai mô hình này dùng một experiment (thí nghiệm). Mã hiện có gọi là control (kiểm soát), và triển khai mới là candidate (ứng cử viên). Cả hai đường đi mã chạy theo thứ tự ngẫu nhiên, nhưng chỉ kết quả control được trả về cho client.

Dùng Scientist để Refactor một Service Ruby

Xem xét service Ruby trả về ước số nguyên tố lớn nhất cho một số cho trước. Giả sử chúng ta đã xác định tối ưu hóa để cắt giảm tập ứng cử viên cần thiết, tăng tốc service.

Tuy nhiên, chủ service muốn chắc chắn không bug được đưa vào. Cũng muốn quan sát cải tiến hiệu năng. Hãy đưa vào mã sau, sửa client để gọi phương thức này:



Tại thời điểm này, chỉ biểu thức use (control) được gọi. Để thí nghiệm có giá trị, định nghĩa class Experiment tùy chỉnh để bật nó (100% thời gian dưới đây) và công bố kết quả (trong trường hợp này, chỉ log). Scientist tạo dữ liệu tuyệt vời nhưng mặc định không làm gì với nó. Phần đó để lại cho bạn.



Kết quả thí nghiệm sẽ được log, và chúng ta có thể cải tiến theo thời gian dựa trên phản hồi. Khi mã mới đáp ứng yêu cầu và niềm tin cao, thực hiện cutover (chuyển đổi) sang triển khai mới bằng cách đơn giản thay thế mã science bằng ủy quyền đến triển khai mới.

LabTech đơn giản hóa thí nghiệm Scientist trong Ruby on Rails

Bạn có thể dùng gem LabTech trong ứng dụng Rails để dễ dàng cấu hình Scientist và xử lý kết quả.

Ứng dụng dùng AppSignal có thể dùng helper Appsignal.instrument custom instrumentation để theo dõi thời gian sự kiện Scientist mất để hoàn thành. Bọc nó quanh các block mã thí nghiệm khác nhau để thấy sự kiện xuất hiện trong timeline hiệu năng.

Bây giờ, quay lại LabTech — trang web dưới chỉ chấp nhận một số để phân tích thừa số nguyên tố.

Refactor mã Ruby on Rails quan trọng với Scientist: Cách tiếp cận đã được chứng minh

Bắt đầu dễ dàng miễn là bạn có quyền truy cập console. Thứ nhất, thêm gem LabTech vào Gemfile và chạy bundle install.



Bảng lưu kết quả và cấu hình thí nghiệm, nên chạy migration database.



Lớp trừu tượng giống hệt nhau, trừ dùng module LabTech. Mã đầy đủ có sẵn trên GitHub.



Tại thời điểm này, thí nghiệm bị tắt, nên dùng console để bật nó trong mọi trường hợp hoặc phần trăm thời gian.



Chúng ta có thể chạy test và thí nghiệm sẽ được đánh giá. Để xem kết quả dạng văn bản, dùng một trong các lệnh sau từ Rails console.



Sau vài lần chạy thành công và một lỗi tạo ra, đây là ví dụ tóm tắt kết quả trông như thế nào. Có tổng quan thành công và thất bại, cũng như biểu đồ ASCII thể hiện khác biệt hiệu năng.



Gem Blazer cung cấp cách đẹp để phân tích kết quả dễ dàng. Dễ cài đặt và cho phép truy vấn SQL chạy trên bảng. Truy vấn ở đây cho thấy triển khai candidate nhanh hơn đáng kể so với gốc.

Refactor mã Ruby on Rails quan trọng với Scientist: Cách tiếp cận đã được chứng minh

Trong ví dụ service phân tích thừa số nguyên tố, sự tăng tốc trong triển khai cải tiến đến từ heuristic loại bỏ một số ứng cử viên cần cân nhắc. Khi xem xét số cao hơn và tìm ước số nguyên tố, chúng ta có thể dừng tìm kiếm sau khi đạt đến số mục tiêu chia cho ước số đó. Đường mã mới chỉ thêm một câu lệnh để đạt được điều này.

Chúng ta cũng thấy giảm thời gian thực thi dùng truy vấn Blazer trên bảng LabTech.

Refactor mã Ruby on Rails quan trọng với Scientist: Cách tiếp cận đã được chứng minh

Trường hợp dùng và Giới hạn của Scientist

Trường hợp dùng tối ưu cho Scientist bao gồm tìm kiếm (searches), tính toán (calculations), và mã không có side effect (hiệu ứng phụ). Mã bao gồm cập nhật transactional hoặc tích hợp bên ngoài như email không vừa vặn vào mô hình vì khả năng chạy hai lần (cả triển khai cũ và mới).

Đây không phải giới hạn nhỏ, vì nó loại bỏ vài trường hợp dùng. Tuy nhiên, có một số workaround (giải pháp thay thế) nếu thí nghiệm quan trọng đến thành công. Cân nhắc xem side effect có liên quan hay trùng lặp có vấn đề không. Ví dụ, trong một số trường hợp có thể không quan trọng nếu hai email được gửi trong đánh giá. Tùy chọn khác là để mã mới xác định kết quả nhưng không persist (lưu giữ) nó. Điều này ngăn so sánh hiệu năng có ý nghĩa. Tuy nhiên, nó cho phép xác minh độ chính xác.

Giới hạn khác xuất phát từ sự tập trung của Scientist vào giá trị trả về. Trong một số trường hợp, kết quả hợp lệ có thể thể hiện sự khác biệt theo thời gian, dù chúng chỉ bao gồm timestamp trong phản hồi hoặc một số yếu tố biến đổi. Trong nhiều trường hợp, chúng ta có thể viết logic so sánh tùy chỉnh trong thí nghiệm để xác minh độ chính xác vượt qua so sánh chuỗi cơ bản.

Cuối cùng, giới hạn của LabTech là nó chưa được port (chuyển đổi) sang Rails 7 tính đến thời điểm viết.

Thực hành tốt nhất cho thí nghiệm Scientist hiệu quả trong Rails

Xem xét các mục sau khi triển khai thí nghiệm:

  • Trong dự án Rails, Scientist có thể cấu hình trong initializer hoặc wrapper như gem Rails LabTech. Hầu hết ứng dụng Rails đã có database, nên LabTech tận dụng ActiveRecord để lưu kết quả.
  • Để tránh làm chậm development và testing, chỉ bật thí nghiệm trong môi trường staging và production.
  • Để giảm thiểu tác động tiềm ẩn lên production, chỉ chạy thí nghiệm trên một phần trăm yêu cầu. LabTech hỗ trợ điều này sẵn như tham số tùy chọn khi bật thí nghiệm (mặc định ban đầu là tắt). Dùng Scientist thuần túy, logic này dễ code trong phương thức enabled? của thí nghiệm.
  • Một số logic tốn tài nguyên, nên tỷ lệ lấy mẫu (sampling rate) thấp có thể là điểm bắt đầu tốt. Khi bạn có niềm tin với kết quả, tăng dần phần trăm yêu cầu được đánh giá.
  • Bạn có thể thêm thuộc tính ngữ cảnh (context attributes) để tận dụng tối đa kết quả. Ngữ cảnh thí nghiệm có thể đặt thành Hash có key là Symbol chứa dữ liệu sau đó có sẵn trong kết quả công bố, ví dụ:


Tổng kết: Quan sát và Giám sát ứng dụng Ruby với Scientist

Trong bài viết này, chúng ta khám phá cách dùng gem Scientist để thay đổi, di chuyển, và refactor mã Ruby trong production.

Chúng ta xem nguồn gốc Scientist trong mô hình Branch by Abstraction, rồi đi sâu vào refactor. Tiếp theo, chúng ta thấy LabTech giúp thu thập kết quả và cấu hình Scientist.

Sau đó chúng ta chạm đến một số giới hạn của Scientist trước khi cuối cùng nêu ra vài thực hành tốt nhất.

Bạn phải quan sát và giám sát điều gì đang xảy ra trong hệ thống. Tích hợp Scientist vào quy trình phát triển để thực hiện thay đổi quan trọng trong mã Ruby với niềm tin lớn hơn.

Happy coding!

P.S. Nếu bạn muốn đọc bài Ruby Magic ngay khi xuất bản, hãy đăng ký newsletter Ruby Magic của chúng tôi và đừng bỏ lỡ bất kỳ bài nào!

Refactor mã Ruby on Rails quan trọng với Scientist: Cách tiếp cận đã được chứng minh

Darren Broemmer

Darren thích truyền cảm hứng qua lời viết và làm cho điều phức tạp dễ hiểu. Sở thích bao gồm khoa học và vật lý, và đủ toán học để hiểu cả hai. Anh tạo nội dung chất lượng cao và giải pháp công nghệ, và thỉnh thoảng tweet về nó.

Tất cả bài viết của Darren Broemmer