2017-12-14 21:15:04 -05:00
|
|
|
{
|
|
|
|
|
"name": "discourse",
|
|
|
|
|
"version": "1.0.0",
|
|
|
|
|
"main": "index.js",
|
|
|
|
|
"repository": "git@github.com:discourse/discourse.git",
|
|
|
|
|
"author": "Discourse",
|
2020-04-29 12:18:21 -04:00
|
|
|
"license": "GPL-2.0-only",
|
2018-10-03 10:15:43 -04:00
|
|
|
"dependencies": {
|
2022-02-02 17:41:42 -05:00
|
|
|
"@discourse/moment-timezone-names-translations": "^1.0.0",
|
2022-06-20 09:25:13 -04:00
|
|
|
"@fortawesome/fontawesome-free": "5.15.4",
|
2022-09-20 11:43:28 -04:00
|
|
|
"@highlightjs/cdn-assets": "^11.6.0",
|
2021-12-14 11:21:49 -05:00
|
|
|
"@json-editor/json-editor": "^2.6.1",
|
2021-12-29 11:02:37 -05:00
|
|
|
"ace-builds": "1.4.13",
|
2021-08-23 07:49:49 -04:00
|
|
|
"chart.js": "3.5.1",
|
|
|
|
|
"chartjs-plugin-datalabels": "^2.0.0",
|
2021-09-09 09:25:58 -04:00
|
|
|
"diffhtml": "^1.0.0-beta.20",
|
2018-10-03 10:15:43 -04:00
|
|
|
"magnific-popup": "1.1.0",
|
2022-09-12 04:56:39 -04:00
|
|
|
"moment": "2.29.4",
|
2022-11-16 10:57:40 -05:00
|
|
|
"moment-timezone": "0.5.39",
|
2022-11-16 12:59:15 -05:00
|
|
|
"pikaday": "1.8.2",
|
2022-06-18 14:30:12 -04:00
|
|
|
"squoosh": "discourse/squoosh#dc9649d",
|
2021-02-02 01:08:29 -05:00
|
|
|
"workbox-cacheable-response": "^4.3.1",
|
2019-07-15 12:05:55 -04:00
|
|
|
"workbox-core": "^4.3.1",
|
|
|
|
|
"workbox-expiration": "^4.3.1",
|
|
|
|
|
"workbox-routing": "^4.3.1",
|
|
|
|
|
"workbox-strategies": "^4.3.1",
|
2021-09-09 09:25:58 -04:00
|
|
|
"workbox-sw": "^4.3.1"
|
2018-10-03 10:15:43 -04:00
|
|
|
},
|
2017-12-14 21:15:04 -05:00
|
|
|
"devDependencies": {
|
2022-11-16 15:38:57 -05:00
|
|
|
"@mixer/parallel-prettier": "^2.0.3",
|
2022-11-17 18:03:05 -05:00
|
|
|
"chrome-launcher": "^0.15.1",
|
2022-11-17 17:21:10 -05:00
|
|
|
"chrome-remote-interface": "^0.31.3",
|
2022-12-28 11:50:31 -05:00
|
|
|
"eslint-config-discourse": "^3.3.0",
|
DEV: Chat service object initial implementation (#19814)
This is a combined work of Martin Brennan, Loïc Guitaut, and Joffrey Jaffeux.
---
This commit implements a base service object when working in chat. The documentation is available at https://discourse.github.io/discourse/chat/backend/Chat/Service.html
Generating documentation has been made as part of this commit with a bigger goal in mind of generally making it easier to dive into the chat project.
Working with services generally involves 3 parts:
- The service object itself, which is a series of steps where few of them are specialized (model, transaction, policy)
```ruby
class UpdateAge
include Chat::Service::Base
model :user, :fetch_user
policy :can_see_user
contract
step :update_age
class Contract
attribute :age, :integer
end
def fetch_user(user_id:, **)
User.find_by(id: user_id)
end
def can_see_user(guardian:, **)
guardian.can_see_user(user)
end
def update_age(age:, **)
user.update!(age: age)
end
end
```
- The `with_service` controller helper, handling success and failure of the service within a service and making easy to return proper response to it from the controller
```ruby
def update
with_service(UpdateAge) do
on_success { render_serialized(result.user, BasicUserSerializer, root: "user") }
end
end
```
- Rspec matchers and steps inspector, improving the dev experience while creating specs for a service
```ruby
RSpec.describe(UpdateAge) do
subject(:result) do
described_class.call(guardian: guardian, user_id: user.id, age: age)
end
fab!(:user) { Fabricate(:user) }
fab!(:current_user) { Fabricate(:admin) }
let(:guardian) { Guardian.new(current_user) }
let(:age) { 1 }
it { expect(user.reload.age).to eq(age) }
end
```
Note in case of unexpected failure in your spec, the output will give all the relevant information:
```
1) UpdateAge when no channel_id is given is expected to fail to find a model named 'user'
Failure/Error: it { is_expected.to fail_to_find_a_model(:user) }
Expected model 'foo' (key: 'result.model.user') was not found in the result object.
[1/4] [model] 'user' ❌
[2/4] [policy] 'can_see_user'
[3/4] [contract] 'default'
[4/4] [step] 'update_age'
/Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/update_age.rb:32:in `fetch_user': missing keyword: :user_id (ArgumentError)
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:202:in `instance_exec'
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:202:in `call'
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:219:in `call'
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:417:in `block in run!'
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:417:in `each'
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:417:in `run!'
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:411:in `run'
from <internal:kernel>:90:in `tap'
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:302:in `call'
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/spec/services/update_age_spec.rb:15:in `block (3 levels) in <main>'
```
2023-02-13 07:09:57 -05:00
|
|
|
"jsdoc": "^4.0.0",
|
2022-11-07 11:13:21 -05:00
|
|
|
"lefthook": "^1.2.0",
|
DEV: Chat service object initial implementation (#19814)
This is a combined work of Martin Brennan, Loïc Guitaut, and Joffrey Jaffeux.
---
This commit implements a base service object when working in chat. The documentation is available at https://discourse.github.io/discourse/chat/backend/Chat/Service.html
Generating documentation has been made as part of this commit with a bigger goal in mind of generally making it easier to dive into the chat project.
Working with services generally involves 3 parts:
- The service object itself, which is a series of steps where few of them are specialized (model, transaction, policy)
```ruby
class UpdateAge
include Chat::Service::Base
model :user, :fetch_user
policy :can_see_user
contract
step :update_age
class Contract
attribute :age, :integer
end
def fetch_user(user_id:, **)
User.find_by(id: user_id)
end
def can_see_user(guardian:, **)
guardian.can_see_user(user)
end
def update_age(age:, **)
user.update!(age: age)
end
end
```
- The `with_service` controller helper, handling success and failure of the service within a service and making easy to return proper response to it from the controller
```ruby
def update
with_service(UpdateAge) do
on_success { render_serialized(result.user, BasicUserSerializer, root: "user") }
end
end
```
- Rspec matchers and steps inspector, improving the dev experience while creating specs for a service
```ruby
RSpec.describe(UpdateAge) do
subject(:result) do
described_class.call(guardian: guardian, user_id: user.id, age: age)
end
fab!(:user) { Fabricate(:user) }
fab!(:current_user) { Fabricate(:admin) }
let(:guardian) { Guardian.new(current_user) }
let(:age) { 1 }
it { expect(user.reload.age).to eq(age) }
end
```
Note in case of unexpected failure in your spec, the output will give all the relevant information:
```
1) UpdateAge when no channel_id is given is expected to fail to find a model named 'user'
Failure/Error: it { is_expected.to fail_to_find_a_model(:user) }
Expected model 'foo' (key: 'result.model.user') was not found in the result object.
[1/4] [model] 'user' ❌
[2/4] [policy] 'can_see_user'
[3/4] [contract] 'default'
[4/4] [step] 'update_age'
/Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/update_age.rb:32:in `fetch_user': missing keyword: :user_id (ArgumentError)
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:202:in `instance_exec'
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:202:in `call'
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:219:in `call'
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:417:in `block in run!'
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:417:in `each'
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:417:in `run!'
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:411:in `run'
from <internal:kernel>:90:in `tap'
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:302:in `call'
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/spec/services/update_age_spec.rb:15:in `block (3 levels) in <main>'
```
2023-02-13 07:09:57 -05:00
|
|
|
"puppeteer-core": "^13.7.0",
|
|
|
|
|
"tidy-jsdoc": "^1.4.1"
|
2018-11-05 15:10:27 -05:00
|
|
|
},
|
|
|
|
|
"scripts": {
|
2022-07-13 11:54:45 -04:00
|
|
|
"postinstall": "yarn --cwd app/assets/javascripts/discourse $(node -e 'if(JSON.parse(process.env.npm_config_argv).original.includes(`--frozen-lockfile`)){console.log(`--frozen-lockfile`)}')"
|
2021-08-04 16:04:58 -04:00
|
|
|
},
|
|
|
|
|
"engines": {
|
2022-06-28 14:52:31 -04:00
|
|
|
"node": "16.* || >= 18",
|
2021-08-04 16:04:58 -04:00
|
|
|
"npm": "please-use-yarn",
|
|
|
|
|
"yarn": ">= 1.21.1"
|
2017-12-14 21:15:04 -05:00
|
|
|
}
|
|
|
|
|
}
|
