search

CarnegieLearningWeb / UpGrade

Framework for adding A/B testing to education applications
https://www.upgradeplatform.org/
BSD 3-Clause "New" or "Revised" License
25 stars 12 forks source link

Remove `addMetrics` from client library? #1332

Open danoswaltCL opened 3 months ago

danoswaltCL commented 3 months ago

Is your feature request related to a problem? Please describe. The addMetrics method is a little out of place in the client library, as it is not tied to user actions in the client, and is an administrative task that would normally require a different kind of authorization. This is a little confusing and incomplete anyway, as one cannot do other CRUD operations other than add.

Describe the solution you'd like 1) Remove method from libraries. 2) Remove endpoint from experiment client controller 3) Unify the CRUD operations for metrics so they are all grouped under one controller and one swagger section

Alternatively, we could decide that metrics are fine as a client-initiated task, in which case we should give the client libraries full CRUD access instead of just add.

amurphy-cl commented 3 months ago

This exists because of a request from @SritterCL, because the MATHia server sends which metrics can be collected, and it's done through the client-side SDK. Aside from this case (implemented but not used), it doesn't need to be in the client SDK.