mirror of
https://github.com/discourse/discourse.git
synced 2024-11-28 16:56:19 +08:00
f8480ed911
* FEATURE: Exposing a way to add a generic report filter ## Why do we need this change? Part of the work discussed [here](https://meta.discourse.org/t/gain-understanding-of-file-uploads-usage/104994), and implemented a first spike [here](https://github.com/discourse/discourse/pull/6809), I am trying to expose a single generic filter selector per report. ## How does this work? We basically expose a simple, single generic filter that is computed and displayed based on backend values passed into the report. This would be a simple contract between the frontend and the backend. **Backend changes:** we simply need to return a list of dropdown / select options, and enable the report's newly introduced `custom_filtering` property. For example, for our [Top Uploads](https://github.com/discourse/discourse/pull/6809/files#diff-3f97cbb8726f3310e0b0c386dbe89e22R1423) report, it can look like this on the backend: ```ruby report.custom_filtering = true report.custom_filter_options = [{ id: "any", name: "Any" }, { id: "jpg", name: "JPEG" } ] ``` In our javascript report HTTP call, it will look like: ```js { "custom_filtering": true, "custom_filter_options": [ { "id": "any", "name": "Any" }, { "id": "jpg", "name": "JPG" } ] } ``` **Frontend changes:** We introduced a generic `filter` param and a `combo-box` which hooks up into the existing framework for fetching a report. This works alright, with the limitation of being a single custom filter per report. If we wanted to add, for an instance a `filesize filter`, this will not work for us. _I went through with this approach because it is hard to predict and build abstractions for requirements or problems we don't have yet, or might not have._ ## How does it look like?  ## More on the bigger picture The major concern here I have is the solution I introduced might serve the `think small` version of the reporting work, but I don't think it serves the `think big`, I will try to shed some light into why. Within the current design, It is hard to maintain QueryParams for dynamically generated params (based on the idea of introducing more than one custom filter per report). To allow ourselves to have more than one generic filter, we will need to: a. Use the Route's model to retrieve the report's payload (we are now dependent on changes of the QueryParams via computed properties) b. After retrieving the payload, we can use the `setupController` to define our dynamic QueryParams based on the custom filters definitions we received from the backend c. Load a custom filter specific Ember component based on the definitions we received from the backend |
||
|---|---|---|
| .. | ||
| admin | ||
| discourse | ||
| discourse-common | ||
| docs | ||
| ember-addons | ||
| locales | ||
| pretty-text | ||
| select-kit | ||
| wizard | ||
| activate-account.js.no-module.es6 | ||
| admin.js.erb | ||
| application.js | ||
| auto-redirect.js.no-module.es6 | ||
| deprecated.js | ||
| discourse-loader.js | ||
| discourse-objects.js | ||
| discourse.js.es6 | ||
| embed-application.js.no-module.es6 | ||
| ember_include.js.erb | ||
| ember_jquery.js | ||
| ember-shim.js | ||
| env.js | ||
| google-tag-manager.js.no-module.es6 | ||
| google-universal-analytics.js.no-module.es6 | ||
| main_include_admin.js | ||
| markdown-it-bundle.js | ||
| omniauth-complete.js.no-module.es6 | ||
| onpopstate-handler.js.no-module.es6 | ||
| plugin-third-party.js.erb | ||
| plugin.js.erb | ||
| polyfills.js | ||
| preload-application-data.js.no-module.es6 | ||
| preload-store.js.es6 | ||
| pretty-text-bundle.js | ||
| print-page.js | ||
| service-worker.js.erb | ||
| set-prototype-polyfill.js | ||
| template_include.js.erb | ||
| vendor.js | ||
| wizard-application.js | ||
| wizard-start.js.no-module.es6 | ||
| wizard-vendor.js | ||
