* Prevent clobbering of new fields by old plugins.
* Apply suggestions from code review
Spelling and copy paste error.
Co-Authored-By: crspeller <crspeller@gmail.com>
* MM-7633: Optimize memory utilization during file uploads
Refactored the file upload code to reduce redundant buffering and stream
directly to the file store. Added tests.
Benchmark results:
```
levs-mbp:mattermost-server levb$ go test -v -run nothing -bench Upload -benchmem ./app
...
BenchmarkUploadFile/random-5Mb-gif-raw-ish_DoUploadFile-4 10 122598031 ns/op 21211370 B/op 1008 allocs/op
BenchmarkUploadFile/random-5Mb-gif-raw_UploadFileTask-4 100 20211926 ns/op 5678750 B/op 126 allocs/op
BenchmarkUploadFile/random-5Mb-gif-UploadFiles-4 2 1037051184 ns/op 81806360 B/op 3705013 allocs/op
BenchmarkUploadFile/random-5Mb-gif-UploadFileTask-4 2 933644431 ns/op 67015868 B/op 3704410 allocs/op
BenchmarkUploadFile/random-2Mb-jpg-raw-ish_DoUploadFile-4 100 13110509 ns/op 6032614 B/op 8052 allocs/op
BenchmarkUploadFile/random-2Mb-jpg-raw_UploadFileTask-4 100 10729867 ns/op 1738303 B/op 125 allocs/op
BenchmarkUploadFile/random-2Mb-jpg-UploadFiles-4 2 925274912 ns/op 70326352 B/op 3718856 allocs/op
BenchmarkUploadFile/random-2Mb-jpg-UploadFileTask-4 2 995033336 ns/op 58113796 B/op 3710943 allocs/op
BenchmarkUploadFile/zero-10Mb-raw-ish_DoUploadFile-4 30 50777211 ns/op 54791929 B/op 2714 allocs/op
BenchmarkUploadFile/zero-10Mb-raw_UploadFileTask-4 50 36387339 ns/op 10503920 B/op 126 allocs/op
BenchmarkUploadFile/zero-10Mb-UploadFiles-4 30 48657678 ns/op 54791948 B/op 2719 allocs/op
BenchmarkUploadFile/zero-10Mb-UploadFileTask-4 50 37506467 ns/op 31492060 B/op 131 allocs/op
...
```
https://mattermost.atlassian.net/browse/MM-7633https://github.com/mattermost/mattermost-server/issues/7801
[Place an '[x]' (no spaces) in all applicable fields. Please remove unrelated fields.]
- [x] Added or updated unit tests (required for all new features)
- [ ] Added API documentation (required for all new APIs)
- [ ] All new/modified APIs include changes to the drivers
*N/A*???
- [x] Includes text changes and localization file ([.../i18n/en.json](https://github.com/mattermost/mattermost-server/blob/master/i18n/en.json)) updates
Overview of changes:
- api4
- Replaced `uploadFile` handler with `uploadFileStream` that reduces
unnecessary buffering.
- Added/refactored tests for the new API.
- Refactored apitestlib/Check...Status functions.
- app
- Added App.UploadFileTask, a more efficient refactor of UploadFile.
- Consistently set `FileInfo.HasPreviewImage`
- Added benchmarks for the new and prior implementations
- Replaced passing around `*image.Image` with `image.Image` in the
existing code.
- model
- Added a more capable `client4.UploadFiles` API to match the new server
API’s capabilities.
- I18n
- Replaced `api.file.upload_file.bad_parse.app_error` with a more generic
`api.file.upload_file.read_request.app_error`
- plugin
- Removed type `plugin.multiPluginHookRunnerFunc` in favor of using
`func(hooks Hooks) bool` explicitly, to help with testing
- tests
- Added test files for testing images
Still remaining, but can be separate PRs - please let me know the preferred
course of action
- Investigate JS client API - how does it do multipart?
- Performance loss from old code on (small) image processing?
- Deprecate the old functions, change other API implementations to use
UploadFileTask
Definitely separate future PRs - should I file tickets foe these?
- Only invoke t.readAll() if there are indeed applicable plugins to run
- Find a way to leverage goexif buffer rather than re-reading
Suggested long-term improvements - should I file separate tickets for these?
- Actually allow uploading of large (GB-sized) files. This may require a
change in how the file is passed to plugins.
- (Many) api4 tests should probably be subtests and share a server setup -
will be much faster
- Performance improvements in image processing (goexif/thumbnail/preview)
(maybe use https://mattermost.atlassian.net/browse/MM-10188 for this)
Questions:
1. I am commiting MBs of test images, are there better alternatives? I can
probably create much less dense images that would take up considerably less
space, even at pretty large sizes
2. I18n: Do I need to do anything special for the string change? Or just wait
until it gets picked up and translated/updated?
3. The image dimensions are flipped in resulting FileInfo to match the actual
orientation. Is this by design? Should add a test for it, perhaps?
4. What to do in the case of partial success? S3 but not DB, some files but not
others? For now, just doing what the old code did, I think.
5. Make maxUploadDrainBytes configurable? Also, should this be the systemic
behavior of all APIs with non-empty body? Otherwise dropped altogether?
Check all other ioutil.ReadAll() from sockets. Find a way to set a total
byte limit on request Body?
* WIP - Fixed for GetPluginsEnvironment() changes
* WIP - PR feedback
1. Refactored checkHTTPStatus to improve failure messages
2. Use `var name []type` rather than `name := ([]type)(nil)`
3. Replaced single-letter `p` with a more intention-revealing `part`
4. Added tests for full image size, `HasPreviewImage`
* WIP - rebased (c.Session->c.App.Session)
* WIP - PR feedback: eliminated use of Request.MultipartReader
Instead of hacking the request object to use r.MultipartReader now have own
functions `parseMultipartRequestHeader` and `multipartReader` eliminating the
need to hack the request object to use Request.MultipartReader limitations.
* WIP - PR feedback: UploadFileX with functional options
* WIP - PR feedback: style
* WIP - PR feedback: errors cleanup
* WIP - clarified File Upload benchmarks
* WIP - PR feedback: display the value of erroneous formname
* WIP - PR feedback: fixed handling of multiple channel_ids
* WIP - rebased from master - fixed tests
* PR Feedback
* PR feedback - moved client4.UploadFiles to _test for now
* wip
* wip
* After running make plugin-mocks
* Add
TestUpdateUserActive and run make pluginapi
* Adding plugin_api_test.go
* Better formatting of code using gofmt
* Fix tests and run make pluginapi
* Specify the minimum server version on the comments
* Include more tests as per the CR
* Fix tests
* Checking err.Id intsead of err & Removed comments and trailing spaces
* wip
* Fix tests as per CR and spaces
* Make changes to tests as per CR
* refactor GetDirectChannel and CreateDirectChannel in one function
* remove CreateDirectChannel plugin api and update GetDirectChannel and GetGroupChannel plugin api
* update tests
* Add interactive dialogs
* Fix unit test
* Updates per feedback
* Fix typo
* Updates per feedback, add icon_url and error returns
* Updates per feedback
* Update per feedback
* [MM-11861] Design & implement a better way for plugins to update their own configuration
Added GetPluginConfig and SavePluginConfig plugin APIs.
Added test cases for testing new APIs.
* Fixed gofmt error
* Minor changes requested in PR
* Change GetTeamMembers() and GetPublicChannelsForTeam() arguments to page, perPage for plugin API
* Add test for GetPublicChannelsForTeam()
* Add test for GetTeamMembers()
* Changes as requested
* Change return from GetPublicChannelsForTeam() to []*model.Channel
* Add GetTeamsUnreadForUser to plugin api
* Remove teamIdToExclude from plugin method GetTeamsUnreadForUser
* Add minimum server version to plugin API doc of GetTeamsUnreadForUser
* Moving goroutine pool
* Auto refactor
* Moving plugins.
* Auto refactor
* Moving fields to server
* Auto refactor
* Removing siteurl duplication.
* Moving reset of app fields
* Auto refactor
* Formatting
* Moving niling of Server to after last use
* Fixing unit tests.
* adds GetUsersInChannelByStatus to plugin api with generated rpc code.
* fixed typo in comment with actual func name
* replaced Response model with AppError in output of GetUsersInChannelByStatus
* removed etag param from GetUsersInChannelByStatus since it is not used
* plugin api for GetUsersInChannelByStatus updated to take the limit, conforming to the app api.
* fixed an issue in my own logic on app/plugin integration.
* adds GetUsersInChannelByStatus to plugin api with generated rpc code.
* fixed typo in comment with actual func name
* replaced Response model with AppError in output of GetUsersInChannelByStatus
* removed etag param from GetUsersInChannelByStatus since it is not used
* plugin api for GetUsersInChannelByStatus updated to take the limit, conforming to the app api.
* fixed an issue in my own logic on app/plugin integration.
* GetUsersInChannelByStatus changed to more generic GetUsersInChannel which takes a sortBy parameter, allowing for more granular/extensible sorting functionality in the future
* GetUsersInChannel accepts sort parameter of 'username' and 'status'. Both values are consts in model pkg.
* Documents minimum server version for GetUsersInChannel.
* adds GetUsersInChannelByStatus to plugin api with generated rpc code.
* fixed typo in comment with actual func name
* replaced Response model with AppError in output of GetUsersInChannelByStatus
* removed etag param from GetUsersInChannelByStatus since it is not used
* plugin api for GetUsersInChannelByStatus updated to take the limit, conforming to the app api.
* fixed an issue in my own logic on app/plugin integration.
* adds GetUsersInChannelByStatus to plugin api with generated rpc code.
* Resolved conflict on rebase
* replaced Response model with AppError in output of GetUsersInChannelByStatus
* removed etag param from GetUsersInChannelByStatus since it is not used
* plugin api for GetUsersInChannelByStatus updated to take the limit, conforming to the app api.
* fixed an issue in my own logic on app/plugin integration.
* GetUsersInChannelByStatus changed to more generic GetUsersInChannel which takes a sortBy parameter, allowing for more granular/extensible sorting functionality in the future
* GetUsersInChannel accepts sort parameter of 'username' and 'status'. Both values are consts in model pkg.
* Documents minimum server version for GetUsersInChannel.
* replaces GetUsersInChannel from #9608 / #9643 with sortBy functionality
Expire K/V Values
Regenerate Code
pathfix
Update Expiry on Update
Check for Exit Signal
gofmt
Rewrote Go Routine
Remove tempoarily cleanup loop
fix expiretime
TEST: Expired Watchdog as GoRoutine
Check if Srv is nil
Use Scheduler/Worker for Expired Key CleanUp
add license
fix scheduler job type; DoJob Restructuring
Remove unused imports and constants
move db migration from 5.4 to 5.5
