* fix: improved count handler for stories not found
* feat: removed performance-now
* feat: cleaned up processors, exposed counts
* feat: increased verb of schd jobs
* fix: removed dead code
* fix: improve wordlist highlighting and perf
* fix: updated tests
* fix: implmeneted new regexp lib/patterns
* fix: improve comment body css
* fix: take into account the tree shaking is disabled
See: https://github.com/webpack/webpack/issues/7094
Co-authored-by: Chi Vinh Le <vinh@vinh.tech>
Co-authored-by: Kim Gardner <kgardnr@gmail.com>
* Add tenantID and siteID to StoryCreatedEventPayload
* fix: added tenantID to payload
* Remove tenantID from StoryCreatedCoralEvent
* Add tenantDomain to webhook schema
* fix: small comment fixes
Co-authored-by: Wyatt Johnson <me@wyattjoh.ca>
* add allcomments option to slack config
* create separate class for hadnling slack event publishing
* add strings
Co-authored-by: Wyatt Johnson <wyattjoh@gmail.com>
Co-authored-by: Kim Gardner <kgardnr@gmail.com>
* feat: initial impl
* Create preliminary SSO rotation components
CORL-929
* Create rotateSSOKey mutation
CORL-929
* Fix sorting by date for SSO keys
CORL-929
* Show tool tips beside expiring/expired statuses
CORL-929
* Hook up Deactivate and Delete SSO key mutations
CORL-929
* Tweak expired tooltip on SSO keys
CORL-929
* Replace old SSO key config with key rotation
CORL-929
* Fix copy button for SSO key's secret
CORL-929
* Refactor SSOKeyCard func's into components
All the func's building the sub-components
were prime targets for component's with props.
CORL-929
* Update tests to match SSO Key rotation
CORL-929
* Fix typo in translation id
CORL-929
* Test key rotation
CORL-929
* Plumb disabled through SSO key rotation
CORL-929
* Remove duplicate input/payload pairs from schema
For some reason it perfectly duplicated the
input/payload pairs for SSO key rotation on
rebase.
CORL-929
* Remove debug logging
CORL-929
* Use switch instead of if's to compute SSO date field
CORL-929
* Use switch to compute SSO action button state
CORL-929
* Use switch to compute SSO StatusField state
CORL-929
* Remove 10 second key rotation option
CORL-929
* Use memo in sorting SSO keys
CORL-929
Co-authored-by: Wyatt Johnson <wyattjoh@gmail.com>
* chore: ADR on Relay and Apollo
* chore: typo
* chore: add neg cons
* chore: add another pos
* chore: remove neg, because apollo needed an introspection query as a build step too..
* chore: fix number
* chore: deco
* chore: typo
* chore: clarification
Co-authored-by: Wyatt Johnson <wyattjoh@gmail.com>
* Add additional error handling around logQuery
We are seeing that sometimes the context has
an undefined logger. We probably want to catch
this case and ensure we don't fail. If it happens
again, we will catch everything we need to know
and that will help us resolve the issue in the
future.
CORL-933
* Simplify logging objects for efficiency
Some of the objects that we were going to log
are too large to be dumped to the logging context.
Instead, prefer simple boolean evaluation of their
existence.
CORL-933
* Fix various Q&A moderation/tagging issues
- Allow Staff members to have their questions
answered and appropriately tagged
- Properly filter answering for only top level
questions (comments)
- Add documentation around various moderation
phases and comment creation steps
- Remove unnecessary status filter when setting
the status for a comment
* fix: abstracted out perspective configs
* fix: reworked tag injection
* Fix sorting/unused imports
Co-authored-by: Wyatt Johnson <accounts+github@wyattjoh.ca>
* [CORL-863] Allow streams to be converted/configured to Q&A (#2809)
* Create preliminary schema changes for Q&A
Adds a mode and expert User onto the StorySettings.
Adds a mode selection drop down on a story's
Configure tab.
CORL-863
* Allow multiple experts, remove form elements from search
Makes the previous expert user on a Q&A story now
an array of users who can be assigned.
Converts the previous form based search that was
pulled from the admin community area into a set
of events built on callbacks.
CORL-863
* Create addExpertToStory mutation
CORL-863
* Create removeExpertFromStory mutation
CORL-863
* Conditionally show the the expert selection options
CORL-863
* Create a dropdown search control for Q&A experts
CORL-863
* Fixing up tests to match new QA stream options
Adds a few localization fixes to make sure tests
pass.
Updates existing snapshots.
CORL-863
* Add load more button to expert search list
CORL-863
* Update experts query to match react upgrades
CORL-863
* Move the Q&A config to its own section under stream config
Create enable and disable Q&A mutations/button toggle.
CORL-863
* Fix alignment and layout of expert list items
CORL-863
* Define translations and update tests
CORL-863
* Use official copy for Q&A config
CORL-863
* [CORL-856] Show expert badge on comments (#2829)
* Create preliminary schema changes for Q&A
Adds a mode and expert User onto the StorySettings.
Adds a mode selection drop down on a story's
Configure tab.
CORL-863
* Allow multiple experts, remove form elements from search
Makes the previous expert user on a Q&A story now
an array of users who can be assigned.
Converts the previous form based search that was
pulled from the admin community area into a set
of events built on callbacks.
CORL-863
* Create addExpertToStory mutation
CORL-863
* Create removeExpertFromStory mutation
CORL-863
* Conditionally show the the expert selection options
CORL-863
* Create a dropdown search control for Q&A experts
CORL-863
* Fixing up tests to match new QA stream options
Adds a few localization fixes to make sure tests
pass.
Updates existing snapshots.
CORL-863
* Add load more button to expert search list
CORL-863
* Update experts query to match react upgrades
CORL-863
* Move the Q&A config to its own section under stream config
Create enable and disable Q&A mutations/button toggle.
CORL-863
* Fix alignment and layout of expert list items
CORL-863
* Define translations and update tests
CORL-863
* Use official copy for Q&A config
CORL-863
* Show expert badges on comments when Q&A is enabled
CORL-856
* Update mutation responses and tests due to added expert fields
CORL-856
* Use EXPERT user tags to denote expert users
Removes the need for viewerIsExpert and
authorIsExpert loader/resolvers on Stories
and Comments respectively.
CORL-856
* [CORL-879] Add an unanswered tab to stream when in Q&A mode (#2838)
* Create preliminary schema changes for Q&A
Adds a mode and expert User onto the StorySettings.
Adds a mode selection drop down on a story's
Configure tab.
CORL-863
* Allow multiple experts, remove form elements from search
Makes the previous expert user on a Q&A story now
an array of users who can be assigned.
Converts the previous form based search that was
pulled from the admin community area into a set
of events built on callbacks.
CORL-863
* Create addExpertToStory mutation
CORL-863
* Create removeExpertFromStory mutation
CORL-863
* Conditionally show the the expert selection options
CORL-863
* Create a dropdown search control for Q&A experts
CORL-863
* Fixing up tests to match new QA stream options
Adds a few localization fixes to make sure tests
pass.
Updates existing snapshots.
CORL-863
* Add load more button to expert search list
CORL-863
* Update experts query to match react upgrades
CORL-863
* Move the Q&A config to its own section under stream config
Create enable and disable Q&A mutations/button toggle.
CORL-863
* Fix alignment and layout of expert list items
CORL-863
* Define translations and update tests
CORL-863
* Use official copy for Q&A config
CORL-863
* Show expert badges on comments when Q&A is enabled
CORL-856
* Update mutation responses and tests due to added expert fields
CORL-856
* Use EXPERT user tags to denote expert users
Removes the need for viewerIsExpert and
authorIsExpert loader/resolvers on Stories
and Comments respectively.
CORL-856
* Show an unanswered comment stream when Q&A is enabled
CORL-879
* Do not visually show the unanswered tag
CORL-879
* [CORL-859] Convert Featured stream into Answered for Q&A (#2842)
* Create preliminary schema changes for Q&A
Adds a mode and expert User onto the StorySettings.
Adds a mode selection drop down on a story's
Configure tab.
CORL-863
* Allow multiple experts, remove form elements from search
Makes the previous expert user on a Q&A story now
an array of users who can be assigned.
Converts the previous form based search that was
pulled from the admin community area into a set
of events built on callbacks.
CORL-863
* Create addExpertToStory mutation
CORL-863
* Create removeExpertFromStory mutation
CORL-863
* Conditionally show the the expert selection options
CORL-863
* Create a dropdown search control for Q&A experts
CORL-863
* Fixing up tests to match new QA stream options
Adds a few localization fixes to make sure tests
pass.
Updates existing snapshots.
CORL-863
* Add load more button to expert search list
CORL-863
* Update experts query to match react upgrades
CORL-863
* Move the Q&A config to its own section under stream config
Create enable and disable Q&A mutations/button toggle.
CORL-863
* Fix alignment and layout of expert list items
CORL-863
* Define translations and update tests
CORL-863
* Use official copy for Q&A config
CORL-863
* Show expert badges on comments when Q&A is enabled
CORL-856
* Update mutation responses and tests due to added expert fields
CORL-856
* Use EXPERT user tags to denote expert users
Removes the need for viewerIsExpert and
authorIsExpert loader/resolvers on Stories
and Comments respectively.
CORL-856
* Show an unanswered comment stream when Q&A is enabled
CORL-879
* Create preliminary schema changes for Q&A
Adds a mode and expert User onto the StorySettings.
Adds a mode selection drop down on a story's
Configure tab.
CORL-863
* Do not visually show the unanswered tag
CORL-879
* Allow multiple experts, remove form elements from search
Makes the previous expert user on a Q&A story now
an array of users who can be assigned.
Converts the previous form based search that was
pulled from the admin community area into a set
of events built on callbacks.
CORL-863
* Create addExpertToStory mutation
CORL-863
* Create removeExpertFromStory mutation
CORL-863
* Create a dropdown search control for Q&A experts
CORL-863
* Fixing up tests to match new QA stream options
Adds a few localization fixes to make sure tests
pass.
Updates existing snapshots.
CORL-863
* Add load more button to expert search list
CORL-863
* Update experts query to match react upgrades
CORL-863
* Move the Q&A config to its own section under stream config
Create enable and disable Q&A mutations/button toggle.
CORL-863
* Fix alignment and layout of expert list items
CORL-863
* Define translations and update tests
CORL-863
* Show expert badges on comments when Q&A is enabled
CORL-856
* Use official copy for Q&A config
CORL-863
* Update mutation responses and tests due to added expert fields
CORL-856
* Use EXPERT user tags to denote expert users
Removes the need for viewerIsExpert and
authorIsExpert loader/resolvers on Stories
and Comments respectively.
CORL-856
* Create the answered stream for Q&A
CORL-859
* Sort the Q&A on Most Voted by default
CORL-859
* Fix type mismatch between post comment form and fragments
CORL-859
* Adding localizations for Q&A tags
* Hide feature flags in Q&A streams
* Allow experts to clear answered questions
Can click a button that shows up in the unanswered
tab under answered questions to refresh the stream,
clearing the answered questions from that tab.
* Show arrow upvote icon when in Q&A mode
Also localized the upvote text so it can
be translated.
* Hide mod/report buttons on answered questions
* Remove unnecessary fragment container
* Remove errant debug console log
* Make story mode required on story settings
* Make remove button outlined, not filled
* Further schema changes around Q&A and experts
Rename add/remove story expert to removeStoryExpert
and addStoryExpert naming.
Replace enableQA and disableQA mutators with single
updateStoryMode mutator.
* Remove story mode from UpdateStorySettings
* Replace inline string val's with enum
* add dependencies to useEffect
* docs cleanup around tags.type index check
* Approve a question when it is answered in Q&A
Approves using the author's id as the moderator
* Add comment around use of TAG on comments edge
* Use tagFilter instead of $elemMatch to filter by tags
* Improve responsive styles for expert list items
* Update copy to "Done" from "Remove answered questions"
* Text styling for no users found text
Styles the expert search list to have proper
text styling when no users are found for the
search keyword.
* Remove duplicate checks around story experts
Not necessary as Mongo does this for us.
* Fix a missed "sort imports" during rebase
* Refactor Q&A moderation phases for clarity
Simplify logic and update comments.
Rename: "answered" -> "tagExpertAnswers"
Rename: "unanswered" -> "tagUnansweredQuestions"
* Remove username & email from add expert mutation
* Format expert list emails with Localized
* Break out no comments logic into fragment
* Remove ref handling from expert search field
Use value assignment on TextField instead.
* Replace Box with Flex and CSS
* Show Q&A tooltip on Answered tab
Co-authored-by: Kim Gardner <kgardnr@gmail.com>
* feat: added new linking backend
* feat: added duplicateEmail to hash
* fix: stored the duplicate email on the user
* feat: initial implmentation of account linking in auth
* test: fix unit tests
* fix+test: translations and tests added
* chore+test: rename view to LINK_ACCOUNT + more tests
* feat+test: account linking admin + more tests
* feat: Handle incomplete accounts
* chore: add some comments
* feat: expose duplicateEmail through graphql and impl for stream
* feat: admin to use duplicateEmail from graphql
* fix: no need to validate password for account linking
* fix: dont validate password
* fix: no need to render error message when account was incomplete
* chore: log to console when encountering incomplete account
* chore: adjust comment
* chore: simplify + add comments
* chore: wording
* chore: comments
Co-authored-by: Vinh <vinh@vinh.tech>
Co-authored-by: Kim Gardner <kgardnr@gmail.com>
* show comment counts for stories in story table
* remove debug code
* add 'approved' moderation queue to moderation tabs
* add site/story specific routes
* Revert "remove debug code"
This reverts commit ed3a44304d225c79336423f34d0bde57a998cd69.
* Revert "show comment counts for stories in story table"
This reverts commit 61eb00c70c873fd2d10f1476601c7a69ae12651d.
* use SHORT_NUMBER fluent function to format comment counts
* fix: short number algo
* chore: remove whitespace
* chore: rename var
Co-authored-by: Vinh <vinh@vinh.tech>
* move download comments to my comments tab
* only show download comments if available
* move ignored users management to same tab as notifications, rename to preferences
* fix query and ts defs
* add url to jwt
* make account tab go to external url if provided
* ensure url is an optional jwt field
* update tabs for stream profile
* update classnames for tabs
* fix tests
* feat: initial webhook impl
* feat: added support for key rotation
* feat: harmonized fetcher
* feat: added expired secrets cleaning
* feat: event system refactor
* feat: added story event
* feat: simplfiied webhook handler
* feat: added ref's to locations where user events can be added
* feat: added UI to support webhooks
* fix: renaming some Webhook -> WebhookEndpoint
* fix: review comments to adjuist flow
* feat: added localizations
* fix: linting, updated snapshots
* fix: adapted for new fluent
* fix: rearranged folders
* fix: linting
* feat: added webhooks documentation
* feat: improved toc generation
* feat: added some tests to webhooks
* fix: chain transition hooks
* feat: added tests around webhook ui
* fix: renamed events
* fix: adjusted circle markdown linting
* fix: adjusted doctoc script call
* review: review fixes
* review: review comments
* review: adjusted signing secret confirmation
* review: adjusted styles to harmonize button usage
* fix: updated snapshots and tests
* review: move form out of webhooks
Moved the form out of the webhooks by relocating the layout used for the
route associated with the configure routes.
* fix: fixed bugs and snapshots with tests
* feat: revised slack message format to use block api
* fix: fixed a small text bug
Co-authored-by: Vinh <vinh@vinh.tech>
Co-authored-by: Kim Gardner <kgardnr@gmail.com>
* resovle import error by removing useContext from ui component
* update snaps
* create useUIContext hook
* add site and community models
* create sites and communities on install
* add site name to install wizard
* add site id to stories
* pass site id to stream query in embed
* fix spec
* add sites query
* list sites in organization config
* add route for new sites
* add create site mutation
* view and update sites
* show embed codes for sites
* add site id to comments
* allow filtering moderation queues by site id
* add site selector to queue
* move sites config routes
* Revert "move sites config routes"
This reverts commit 4ed5345d3e1df6263f8390b64214956c43c4d8cd.
* update sites routes
* show site name in moderate card
* remove site selector from queue selector
* style create site form
* edit site form
* clean up ts
* move :storyID paths to /storeis/:storyID
* make queues respect site id
* add site switcher
* styles for site selector
* add global notifications
* style app notifications
* clear notifications after x miliseconds
* use notification component in add site form
* fix types
* make notifications dismissable
* dismiss site created notification
* remove button letter spacing if lowercase
* filter stories by site in search
* add site name to story search results
* add site column to stories table
* filter stories table by site
* make sure notification displays after site creation
* paginate sites table
* paginage site selector
* add paginated site filter to stories table
* fix merge conflicts
* sort by createdAt
* default to 20 sites
* delete comments
* add translation tags
* make site ID not mandatory
* Fix tests and specs
* only include site id in embed code for multisite
* update tenant cache when adding first site
* only show site selector if multiple sites
* use story url instead of site id for story upsert
* update snaps
* make ui conditional on multisite
* update snaps and remove unnecessary site ID
* sloppily calculate counts for filtered queues
* get origins of allowed domains
* add migration
* enable migration
* only show permitted domains if mulltisite is false
* remove site id from embed code
* update snaps
* undo updates to singletonresolver
* remove refernces to communities
* fix mints
* remove community reference
* update copy in installation
* use sites services in installer
* remove unused loader
* correct error text for useNotification
* order sites by name
* make multisite a computed property
* use map/filter instead of for/of for url origins
* add missing/incorrect translations
* remove references to siteID
* remove references to tenant isURLpermitted
* add comments to schema updates
* simplify filtering stories by site
* remove domains config from advanced
* fix: adjusted CSP header generation
* add migration to create indexes on site
* clear notifications on navigate
* remove count for filtering by site
* throw duplicate error for allowed domains
* handle errors for create/update sites
* remove contacturl and contactemail from sites
* fix types for counts
* sort imports
* ensure props get passed down to link version of button component
* add url and email fields back into organization config
* sort imports
* fix moderation queues resolver types
* fix appearance of sites dropdown
* add status role to notificaiton
* remove duplicate layout file
* fix: rename allowedDomains -> allowdOrigins
* move Link conditional from button to basebutton component
* fix merge conflict
* fix mutation optimistic response
* make sure to prop gets passed to link
* change labels on install steps
* show story's site in site selector when moderating by story
* feat: support site counting
* update snap
* remove multisite from settings
* move paginated select to admin/components
* fix circular import errors
* remove uicontext component from v2 timestamp
Co-authored-by: Wyatt Johnson <accounts+github@wyattjoh.ca>
* [Fix] Use .match instead of .test to avoid false positives when matching regex returned groups
* Add test to assure memoized regexp for banned words will match properly
* fix: fixes bug with wordlist matching
Co-authored-by: Wyatt Johnson <accounts+github@wyattjoh.ca>
* CRUD announcements
* only show announcement if not disabled
* make announcements dismissable
* add announcement mutations
* update announcement form logic
* style announcements on stream
* update snap
* localize strings
* close form if announcement is removed
* move announcement config below sitewide commenting config
* move date calculation inside useMemo
* move announcementconfig code to announcementconfigcontainer
* use coralContext for localStorage
* fix type of announcement createdAt
* move announcement form to modal
* remove payload pruning from configure route
* simplify announcement display logic
* make validation message full width
Co-authored-by: Kim Gardner <kgardnr@gmail.com>
When a user did not have any comments when the migration 1575649180000
hits, they are not migrated to get a `commentCounts` property. This
migration finds those users without `commentCounts` and sets them to the
empty comment counts.
Co-authored-by: Kim Gardner <kgardnr@gmail.com>
* Adding Swedish translation
* updated snap file for Swedish translation
* Translated sv/auth.ftl and partially translated install.ftl and errors.ftl to swedish
* Translated server/error completly and removed the swedish translation file install
* Fixed merge conflict with Finnish language that was added before this PR was completed
* Fixed wrong semi colon and white space
Co-authored-by: Kim Gardner <kgardnr@gmail.com>
We don't want to clog up the variables list with every
design token from AirTable. Instead, more efficient to
use Post CSS var's that compile down into the CSS bundle
more efficiently.
CORL-748
* Semi-bold selected text on radio buttons
Makes it very obvious which item is selected.
CORL-875
* fix: updated snapshots
Co-authored-by: Wyatt Johnson <accounts+github@wyattjoh.ca>
* Align the sidebar and config content in Admin>Configure
CORL-874
* fix: updated snapshots
Co-authored-by: Wyatt Johnson <accounts+github@wyattjoh.ca>
* fix: addresses CORL-848
Fixed copy for new commenters feature.
* fix: address CORL-847
Revert the line hight changes on select fields for now.
* fix: addressed CORL-851
Changed copy on CSS field.
* fix: addressed CORL-840
Changed deletion window to 24 hours.
Refactored durations to use TIME enum.
* Create activeStories GraphQL query endpoint
Set lastCommentedAt on stories when they are
commented upon.
Use lastCommentedAt to retrieve the activeStories.
Create a migration to partial index
lastCommentedAt on stories to make retrieval fast.
CORL-836
* fix: adjusted query to use index, more @auth directives
Co-authored-by: Wyatt Johnson <accounts+github@wyattjoh.ca>
* Bump line-height on select to account for hanging font characters
Prevents characters like "g" or "j" being cut off at the
bottom of the select.
CORL-829
* Create new tall line height
Use it for the select boxes to allow for dangling
characters like 'g' and 'j'.
CORL-829
* Allow sending of moderation decisions to Google
If enabled in the config, moderation decisions can
be sent to Google.
Simplify OnOffField test id's
Consolidate guard clauses
Reconstruct tenant url's when sending perspective feedback
Use the comment revision id when sending perspective feedback
Use retrieveStory instead of findStory
Clarify logging warning levels on perspective feedback
Clean html tags from sent comment body
Fix include to match new graph context refactors
CORL-825
* Handle asynchronous perspective operation more cleanly
CORL-825
* feat: initial impl
* Create preliminary comment moderation slices
CORL-688
* Move slices logic into stacks
CORL-688
* Create user comment counts
CORL-688
* Create naive mutation that initializes user comment counts
CORL-688
* Use bulk updates in user counts migration
CORL-688
* fix: review
* fix: fixed issue with aggregation
* Migrate creating comment into stacks
CORL-688
* Migrate editing a comment to the stacks
CORL-688
* Break publishing comment status out of updateAllCounts
CORL-688
* review: removed variable scoping in favor of export
* revert: feb8e8196cd448f5cd24f1ca2eb0b91fe9bd43c7
* review: simplification of stacks implementation
This simplifies the stacks implementation to better reuse code related
to count management and event publishing. This can be used to great
effect with the upcomming events PR #2738.
* Consolidate the tenant and common context together
CORL-688
* review: removed variable scoping in favor of export
* revert: feb8e8196cd448f5cd24f1ca2eb0b91fe9bd43c7
* review: simplification of stacks implementation
This simplifies the stacks implementation to better reuse code related
to count management and event publishing. This can be used to great
effect with the upcomming events PR #2738.
* fix: check if authorID is null before update user counts
CORL-688
* Consolidate common/tenant context supporting files
CORL-688
* feat: renamed TenantContext -> GraphContext
Co-authored-by: Wyatt Johnson <accounts+github@wyattjoh.ca>
* add new commenters config
* fix specs and fixtures, add translation strings
* save whether a commenter is new
* fix specs and snaps
* add admin role to new config options
* Update copy
* remvoe unused ref
* feat: initial impl
* Create preliminary comment moderation slices
CORL-688
* Move slices logic into stacks
CORL-688
* Create user comment counts
CORL-688
* Create naive mutation that initializes user comment counts
CORL-688
* Use bulk updates in user counts migration
CORL-688
* fix: review
* fix: fixed issue with aggregation
* Migrate creating comment into stacks
CORL-688
* Migrate editing a comment to the stacks
CORL-688
* Break publishing comment status out of updateAllCounts
CORL-688
* review: removed variable scoping in favor of export
* revert: feb8e8196cd448f5cd24f1ca2eb0b91fe9bd43c7
* review: simplification of stacks implementation
This simplifies the stacks implementation to better reuse code related
to count management and event publishing. This can be used to great
effect with the upcomming events PR #2738.
* Remove un-necessary isNew flags on users
CORL-664
* review: removed variable scoping in favor of export
* revert: feb8e8196cd448f5cd24f1ca2eb0b91fe9bd43c7
* review: simplification of stacks implementation
This simplifies the stacks implementation to better reuse code related
to count management and event publishing. This can be used to great
effect with the upcomming events PR #2738.
* fix: check if authorID is null before update user counts
CORL-688
* fix: addressed bug in shared count retrival
Co-authored-by: Tessa Thornton <tessathornton@gmail.com>
Co-authored-by: Wyatt Johnson <accounts+github@wyattjoh.ca>
* feat: initial impl
* Create preliminary comment moderation slices
CORL-688
* Move slices logic into stacks
CORL-688
* Create user comment counts
CORL-688
* Create naive mutation that initializes user comment counts
CORL-688
* Use bulk updates in user counts migration
CORL-688
* fix: review
* fix: fixed issue with aggregation
* Migrate creating comment into stacks
CORL-688
* Migrate editing a comment to the stacks
CORL-688
* Break publishing comment status out of updateAllCounts
CORL-688
* review: removed variable scoping in favor of export
* revert: feb8e8196cd448f5cd24f1ca2eb0b91fe9bd43c7
* review: simplification of stacks implementation
This simplifies the stacks implementation to better reuse code related
to count management and event publishing. This can be used to great
effect with the upcomming events PR #2738.
* fix: check if authorID is null before update user counts
CORL-688
Co-authored-by: Wyatt Johnson <accounts+github@wyattjoh.ca>
* Prefix comment download filename with "coral"
CORL-827
* Scrub html tags from downloaded comment data
CORL-828
Co-authored-by: Kim Gardner <kgardnr@gmail.com>
Co-authored-by: Wyatt Johnson <accounts+github@wyattjoh.ca>
Count management has been adjusted to instead preserve the zero values
of the counts. Old count maintainence functions were also removed
because they were untested and not used.
Co-authored-by: Kim Gardner <kgardnr@gmail.com>
Need to set the message content width so that
the text knows how to wrap. Also accounts for
when the icon is present to set width to the
correct value so it doesn't shift past the edge
of the message box container.
CORL-802
Co-authored-by: Kim Gardner <kgardnr@gmail.com>
* Create preliminary schema for setting Slack channels
CORL-645
* Implement preliminary slack notification using tenant slack channels
CORL-645
* Very preliminarily get data loading with FieldArray's for slack channels
CORL-645
* Update settings input on schema to allow saving Slack settings to tenant
CORL-645
* Filter off UNMODERATED queue events from slack channels
We don't send these to slack through our filters, we only care
about pending, reported, and featured
CORL-645
* Include a moderation link in comments pushed to Slack
CORL-645
* Hook up proper callback functions for adding/removing slack channels
CORL-645
* Add missing translation for Slack navigation item
CORL-645
* Update snapshots for preliminary Slack configuration changes
CORL-645
* Add some FormField wrappers around slack config elements
Makes the UI appear a little nicer
CORL-645
* Set up slack config to only provide one slack channel
We need to do this until we can get ArrayField's working
in final-form.
CORL-645
* Disable the other trigger checkboxes when "All Comments" is checked
CORL-645
* Clean up the formatting of Slack messages
CORL-645
* Add error handling around sending comments to Slack
CORL-645
* Add links to external Slack setup documentation
CORL-645
* Replace form state with wrapped field element
CORL-645
* Clean up fetch request sending Slack notifications
CORL-645
* Prefer global string replacement over RegEx
CORL-645
* Use URL class to construct comment URL's
CORL-645
* Require slack configuration in schema
CORL-645
* Initialize Slack in fixtures
Also fix up a flaky test that wasn't waiting
on form submission and on-change events.
CORL-645
* Preliminarily fix up styles to match other config pages
CORL-645
* Create placeholder add/remove buttons
* Convert SlackConfigContainer to FunctionalComponent
CORL-645
* Add name field to slack channels
CORL-645
* Disable inner fields on Slack channel when not enabled
CORL-645
* Improve the delete channel button
CORL-645
* Use pureMerge to extract slack channel settings
CORL-645
* Do a bit of cleanup on the add channel button
CORL-645
* Update the styling of the Slack config
- Use sub header for channel headings
- Update add channel button text
- Move the remove channel button down
- Other minor spacing tweaks
CORL-645
* Handle comment insertion in stream when sort by oldest
Push the comment to the end of current cursored
comment stream so it shows up.
CORL-758
* Make commenstOrderBy a client only mutation parameter
CORL-758
* fix: addressed linting issue
* Create preliminary schema for setting Slack channels
CORL-645
* Implement preliminary slack notification using tenant slack channels
CORL-645
* Very preliminarily get data loading with FieldArray's for slack channels
CORL-645
* Update settings input on schema to allow saving Slack settings to tenant
CORL-645
* Filter off UNMODERATED queue events from slack channels
We don't send these to slack through our filters, we only care
about pending, reported, and featured
CORL-645
* Include a moderation link in comments pushed to Slack
CORL-645
* Hook up proper callback functions for adding/removing slack channels
CORL-645
* Add missing translation for Slack navigation item
CORL-645
* Update snapshots for preliminary Slack configuration changes
CORL-645
* Add some FormField wrappers around slack config elements
Makes the UI appear a little nicer
CORL-645
* Set up slack config to only provide one slack channel
We need to do this until we can get ArrayField's working
in final-form.
CORL-645
* Disable the other trigger checkboxes when "All Comments" is checked
CORL-645
* Clean up the formatting of Slack messages
CORL-645
* Add error handling around sending comments to Slack
CORL-645
* Add links to external Slack setup documentation
CORL-645
* Replace form state with wrapped field element
CORL-645
* Clean up fetch request sending Slack notifications
CORL-645
* Prefer global string replacement over RegEx
CORL-645
* Use URL class to construct comment URL's
CORL-645
* Require slack configuration in schema
CORL-645
* Initialize Slack in fixtures
Also fix up a flaky test that wasn't waiting
on form submission and on-change events.
CORL-645
* Preliminarily fix up styles to match other config pages
CORL-645
* Create placeholder add/remove buttons
* Convert SlackConfigContainer to FunctionalComponent
CORL-645
* Add name field to slack channels
CORL-645
* Disable inner fields on Slack channel when not enabled
CORL-645
* Improve the delete channel button
CORL-645
* Use pureMerge to extract slack channel settings
CORL-645
* Do a bit of cleanup on the add channel button
CORL-645
* CORL-729 Upgrade final form, fix and improve tests
This is a squashed rebase from these commits:
a300b31c23ab11e5e6f0668bc03ece7697360aaa feat: error on optimisic response warnings during test
dd8a9776865ec41d346e23ae0743d0d4fb0caa21 fix: turn off @typescript-eslint/prefer-regexp-exec rule
b995daacf1722cace60d755e672cb6a3a20d6bc2 feat: mute false warnings in test
e44f9e28307cd63a82c1fb7ac013667dd7b7bc46 fix: wrap remaining tests with act
afbd4329b97f3dbc9f873ea4ff234d98bb651ccf feat: fail when act(async () => ...) without await warnings
51dfb60b7d75411ba2e1a28db33f4aba5cf84de1 feat: fail tests with act warnings
97f93546ed8113e207882411eb4cdb7675b0796c fix: mock window.resizeTo globally in tests
850958b8c4d2fc0aca67ae580296433af223f8ab fix: more tests with act
24c05ab88e9a416e4962acc3f20f2c764ba07657 fix: wrap charCountEditComment test in acts
ed590b82d147470bba74055dc682e6b70d2e76fb fix signInWithEmail
4a2b9402cb6ce9565d99ae1a950eaa422ff603c3 fix: PostCommentFormContainer
815ebe6ef364d954d4bd0a35495934c9d014170b fix: use final form initialize instead of reset and remove obsolete
d3101f2112ed3ffe8d06609620e31e6655d2cf6d Merge branch 'feature/CORL-729-final-form' of https://github.com/coralproject/talk into feature/CORL-729-final-form
a0658da610a5f39b6fae78ffb8dd291b22d54e50 fix: addEmailAddress
60f7fc99a44dfa49dfd401a0ef49c60973b3e8e3 fix: use proper act pattern in renderConfigure.spec.tsx
d66bdfc2245c2b1ee03a1b3a3a56f1d5ba14ddc4 Stop propagation of Modal content click events (#2706)
ec6689594136e22a5b9f05ea284162702dc4955d fix: use proper act pattern in createUsername.spec.tsx
ef239496964a5f9a91ee1c4424ad81537c4f47fe fix: stream configuration
c7e06a0c6aef6b299c41392af81f8a20855028bf fix: user proper act pattern in streamConfiguration
9712e659e394a898500ed649464ff14d4870e589 Merge branch 'feature/CORL-729-final-form' of https://github.com/coralproject/talk into feature/CORL-729-final-form
9e5cfbaf3593615b457055de23f187fa07edd4c4 fix: signIn test
99b44a4a1bbb7ff2cd44c6821ad33b80f90c4a99 fix: user proper act pattern in stories.spec.tsx
ed7c1a92f93ab9aaa85ff92837b0ed21560cb358 fix: user proper act pattern in addEmailAddress
a04b392cb2148b9a24791b062027796c409d053e fix: remove obsolete snapshots
59df67c0f9b9d26c74e2cca7d333f5868b0b202d fix: signUp test
7656f179df95b4cd96b37afbc88a1c3a2944fdf4 fix: use proper act pattern on createPassword
85246fbf1f9ab49ad3a09c11ab79bf537059b548 fix: use correct act() pattern in createUsername.spec.tsx
d5239373a2d1bbed0bfe8c1ca62ef6a70ef5c7d9 fix: the correct way to use act on form submit :-)
d84ecd168354f4acb422a5ddb725fb8faf9c3184 fix: moderation test
d8df62ab1a6486144684ff917c47e6e375ffbe03 fix: reportComment test
2756e3184bb292168e8d34e201f340c3799941e6 fix: auth tests
a28695dbdd313a7bc3dade9ac1f92d6ef0061526 Properly handle final-form actions in tests
2fafc8ea3458c5b15b66f3d65f0947672dd1a516 Update snapshots now that final form isn't overwriting props
1f9bbaec8678a7653124898ba4a2e84ddc1ef243 fix: prevent final form from overwriting field props
f6c66c003d1917db2dcb3f757e8a303266c381fa fix: prevent final form fields overwrite out props
48d1fc7318ee4ba7bf72839127e9a0b1487c1729 chore: rename translation string
728373da5728a4e7c039bd0c3a3cf0037e9f5177 fix: purge relay metadata from request
7cdea925087a6b9b6e318bbb1b31b798be87dc2f fix: radiobuttons
9735bae79222219a81a28d458976a596201b650b chore: revert obsolete checks
0b556e1693584430a5814e81d87b0f233efd1a30 fix: refactor admin configure
b245afc7b196035bcb454e031c966e63c77ce522 fix: implement withForm HOC
5787400051211f5d2e1773d7207f32b66b02a2a1 Update the Configure page form state to properly load form values
8c2af3e22a96a3d2e50e7f06fb45d1fb79cf0c8e Replace form.reset() with setTimeout(form.reset)
27d9c90e3f0166cc2db45db461619be15a3cb950 Update radio buttons and on/off fields to work with final-form updates
b852dd14af85b14ff8e0d2823e1e83bf278b29b9 Replace any on OnSubmit with typed form submission interfaces
f049a70aaf4872825ac3b2aa62dc5cb7f945290a (f) Preliminarily get Coral compiling with latest final-form libraries
* feat: act is now actAndReturn
* fix: print original filename and line number in custom console impl
* feat: trace process warnings
* fix: server warnings about potentially memory leak with too many listeners
* add comment revisions
* add strings
* update fixtures
* fix fixtures
* [CORL-629] Update admin moderation containers to use new branding tokens (#2600)
* Convert the moderation card components to use new styles
CORL-629
* Style the details area in the moderate card using new font and color styles
CORL-629
* Update FlagDetails on Moderate Card to match new branding styles
CORL-629
* Remove typography from ModerateCard Username
CORL-629
* Remove unnecessary new typography tokens created while experimenting
CORL-629
* Update background colors of username buttons on moderate card
CORL-629
* Update approve reject buttons to use new colors
CORL-629
* Fix alignment of username and "Reply to" in InReplyTo component
CORL-629
* Update moderated by on moderate card to match new branding
CORL-629
* Create distinct admin marker and counter components with new branding styles
Update moderate card components to use these distinct newly branded styles.
CORL-629
* Create independent Tabs control with new styling for admin area
Use it on the moderate card details area.
CORL-629
* Remove letter spacing from moderate card styles
CORL-629
* Update "DETAILS" tab on moderate card to be named "INFO"
CORL-629
* Update some missing v2 css variables
CORL-629
* Tweak the spacing of the COMMENT link and title on the moderate card
CORL-629
* Update details font color on moderate card
CORL-629
* Update spacing on newly styled Admin Tab component
CORL-629
* Update spacing of reply to username on the moderate card
CORL-629
* Update moderate card comment text area minimum width and height
CORL-629
* Update vertical divider on moderate card to updated branding
CORL-629
* Introduce new bold open sans font face
Downgrades all existing bold's to semi-bold as they were equivalent before.
CORL-629
* Update moderate card details tabs to use new bold open sans font
CORL-629
* Create an admin specific timestamp control that implements new branding
CORL-629
* Migrate shared moderate card styles into child component files
CORL-629
* [CORL-631] Update admin side main navigation to new branding styles (#2625)
* Convert the moderation card components to use new styles
CORL-629
* Style the details area in the moderate card using new font and color styles
CORL-629
* Update FlagDetails on Moderate Card to match new branding styles
CORL-629
* Remove typography from ModerateCard Username
CORL-629
* Remove unnecessary new typography tokens created while experimenting
CORL-629
* Update background colors of username buttons on moderate card
CORL-629
* Update approve reject buttons to use new colors
CORL-629
* Fix alignment of username and "Reply to" in InReplyTo component
CORL-629
* Update moderated by on moderate card to match new branding
CORL-629
* Create distinct admin marker and counter components with new branding styles
Update moderate card components to use these distinct newly branded styles.
CORL-629
* Create independent Tabs control with new styling for admin area
Use it on the moderate card details area.
CORL-629
* Remove letter spacing from moderate card styles
CORL-629
* Update "DETAILS" tab on moderate card to be named "INFO"
CORL-629
* Update some missing v2 css variables
CORL-629
* Tweak the spacing of the COMMENT link and title on the moderate card
CORL-629
* Update details font color on moderate card
CORL-629
* Update spacing on newly styled Admin Tab component
CORL-629
* Update spacing of reply to username on the moderate card
CORL-629
* Update moderate card comment text area minimum width and height
CORL-629
* Update vertical divider on moderate card to updated branding
CORL-629
* Introduce new bold open sans font face
Downgrades all existing bold's to semi-bold as they were equivalent before.
CORL-629
* Update moderate card details tabs to use new bold open sans font
CORL-629
* Create an admin specific timestamp control that implements new branding
CORL-629
* Migrate shared moderate card styles into child component files
CORL-629
* Update main navigation admin side to use new branding styles
CORL-631
* Bring in some preliminary color and font styles for the search bar
This helps it match navigation, but does not update all the sub-styles of
the search bar's many child components.
CORL-631
* [CORL-694] use new styles for decision history (#2644)
* use new styles for decision history
* remove reference to nonexistent variable
* update snaps
* [CORL 695] admin branding - user menu (#2650)
* update user menu, popover, and dropdown to new design tokens
* fix feature button colours
* use v2 spacing vars
* admin branding: tables (#2651)
* update user menu, popover, and dropdown to new design tokens
* fix feature button colours
* use v2 spacing vars
* style stories and users table
* update snap
* update user status font weight
* remove duplicate declaration
* fix line height references
* update design tokens for text inputs and selects (#2658)
* use box shadow instead of outline for focus states
* Update snapshots to adjust for resolved merge conflicts
* Bring new branding styles to button components (#2667)
* Create preliminary filled and outline buttons that match branding
* Add adornment button variant to newly branded button
* Add the ghost variant to the newly branded button component
* Add underlined variant to the newly branded button component
* Remove external Icon composes property
* Convert camel-case button variables to kebab-case
* [CORL-672] Configuration pages new branding (#2673)
* style config side nav
* general configuration tab branding
* organization tab branding
* moderation configuration branding
* banned/suspect words config branding
* email config branding
* advanced settings branding
* auth config branding
* move helpertext and fieldset components
* add textarea component
* add back gutters on table search
* update snaps
* fix header component to accept labels
* use new spacing form components
* use spacing components for advanced config
* fix tests
* fix line height of radio buttons
* update validation message branding
* update snaps
* fix paths casing
* try lowercase then
* add docs for new form components
* move description component
* update snaps
* move components to /ui/v2
* [CORL-673] Update the moderate area search menu to use new branding styles (#2672)
* Create preliminary filled and outline buttons that match branding
* Add adornment button variant to newly branded button
* Add the ghost variant to the newly branded button component
* Add underlined variant to the newly branded button component
* Remove external Icon composes property
* Convert camel-case button variables to kebab-case
* Preliminarily migrate raw components into v2 to prep for branding updates
CORL-673
* Preliminarily update the search results bar to use new branding tokens
CORL-673
* Update styles to new branding on migrated v2 client-ui components
CORL-673
* Update see all and moderate all search option icons
CORL-673
* style config side nav
* general configuration tab branding
* organization tab branding
* moderation configuration branding
* banned/suspect words config branding
* email config branding
* advanced settings branding
* auth config branding
* move helpertext and fieldset components
* add textarea component
* add back gutters on table search
* update snaps
* fix header component to accept labels
* use new spacing form components
* use spacing components for advanced config
* fix tests
* fix line height of radio buttons
* update validation message branding
* update snaps
* fix paths casing
* try lowercase then
* add docs for new form components
* move description component
* update snaps
* move components to /ui/v2
* Set size="md" on the Icon component and not the Localized component
CORL-673
* tag component
* [CORL-669] user drawer + misc branding (#2686)
* tag component
* top of user drawer branding
* recent history in drawer
* add tooltips component
* use correct spacing prop
* history tabs
* user history and rejected comments
* move callout component'
* moderator notes components
* account history table
* table user row
* swap in tabs components
* remove overflow:hidden on buttons
* update snaps
* replace overflow scroll with auto
* clean up from rebasing vs master
* fix ts
* sort exports
* fix confusing linting errors
* update snaps
* clean up nav bar design
* adjust nav hover colors
* comment content component
* update nav hover styles
* fix search bar border
* clean up moderate card components
* more user drawer cleanup
* user role switcher
* update textfield vars and variants
* update components in community page
* move clickoutside component
* clean up stories table
* moderate route components
* single moderate view
* queue components
* delay component
* relative time component
* decision history components
* user drawer components cleanup
* configure components
* clean up buttons
* update snaps
* add all exports
* [CORL-674] admin branding: modals (#2695)
* update hotkeys modal components
* hotkeys modal
* user status change modals
* user status change modals
* invite users modal
* fix tests
* fix incorrect i18n string
* resolve merge conflicts
* move fonts to devdeps
* Fix username props interface
* fix dom nesting in components
* update formatting in strings
* rewrite delay component as functional component
* remove tslint comments
* change configure header component props
* chore: upgraded node 12, more log lines
- upgraded from 10 LTS to 12 LTS
- added log line with userID to GraphQL
log entry
* fix: adjusted some intl formats
* feature: use react-axe and fix some a11y issues in stream
* fix: adapt snapshots
* chore: fix axe warnings in auth and account bundle
* chore: improve accessibility in install bundle
* chore: add some comments
Thank you for submitting a pull request! Please note that by contributing to Coral, you agree to our Code of Conduct: http://code-of-conduct.voxmedia.com/
Before submitting your PR, please verify that:
Thank you for submitting a pull request! Please note that by contributing to
Coral, you agree to our Code of Conduct: http://code-of-conduct.voxmedia.com/
Before submitting your Pull Request (or PR), please verify that:
* [ ] Your code is up-to-date with the base branch
* [ ] You've successfully run `npm run test` locally
_Viewer Network Events_ are events that involves a network request and thus can succeed or fail. Succeeding events will have a `.success` appended to the event name while failing events have an `.error` appended to the event name.
_Viewer Network Events_ are events that involves a network request and thus can succeed or fail. Succeeding events will have a `.success` appended to the event name while failing events have an `.error` appended to the event name.
Moreover _Viewer Network Events_ contains the `rtt` field which indicates the time it needed from initiating the request until the _UI_ has been updated with the response data.
Example events:
```
createComment.success
{
@@ -53,6 +74,7 @@ createComment.error
```
## Event List
<!-- START docs:events -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN npm run docs:events -->
Conversation surrounding contributions begins when you can create an issue
describing your issue or suggestion.
### When should I create an issue?
@@ -26,9 +66,7 @@ File an issue as soon as you have an idea of something you'd like to contribute.
We would love to hear what you're thinking and help refine the idea to make it
into the Coral ecosystem.
Please file issues if you would like to contribute to Coral.
### What should I include?
### What should I include in my issue?
Coral has adopted an iterative, agile development philosophy. All contributions
that make it into the Coral repository should start with a user story in this
@@ -38,8 +76,8 @@ form:
This exercise does two things:
-allows us to ground our technical choices in a clear, simple product need.
-expresses that product need in a way that doesn't imply a specific technical
-Allows us to ground our technical choices in a clear, simple product need.
-Expresses that product need in a way that doesn't imply a specific technical
solution allowing for debate as to the best way to solve the problem.
Please feel free to provide as much detail as possible when filing the issue but
@@ -49,6 +87,72 @@ technical or design solutions.
If you have a specific technical or design solution in mind, please submit it as
the first comment on the thread.
### When should I create a pull request?
File a pull request if you've created an issue in our [issues](https://github.com/coralproject/talk/issues)
page and have heard back from a member or contributor to Coral. This allows our
team to review the proposed changes prior to time being spent if the team
already has the feature/fix in the road map.
### What should I include in my pull request?
When you create a pull request, the template will describe the required
components needed for it to be reviewed by a member of the Coral team. You
should end up filling out:
- What does this PR (pull request) do?
- How do I test this PR?
You should describe what Github issue or ticket that the PR is associated with
to assist the review process. If this PR is resolving a particular bug, a
testing strategy should be described in the testing section. If this PR is
contributing a new feature, a description should describe a scenario to test or
verify the new functionality.
## Reviewing pull requests
Reviewing pull requests in Coral is generally completed by the core Coral team
that is composed of developers employed by Vox Media Inc, but external reviews
or suggestions are also welcomed.
Our review process generally follows a few core principles:
### Ensure contributions are linted and tested
It is the job of CI linting and tests to notify of style issues within the
codebase. If it is not possible for style issues to be encapsulated as a
linting rule, it shouldn't be concretely enforced during the review process.
This can ensure that code reviews contain more meaningful feedback tied to the
contribution rather than nit-picking on stylistic choices.
Reviewers must ensure that linting and tests pass in CI and locally prior to a
review taking place. You can do this by running `npm run generate` followed by
`npm run lint` and `npm run test`.
### Review the feature/fixes
Any new features added to Coral should be reviewed for bugs through a manual
verification process to ensure that they function on your machine. If possible
you should review any automated tests that were added (or not added) related to
the feature.
While the Coral team is not strict on test driven development (or TDD), any
contributions that include tests are greatly appreciated, and preferred over
those that do not.
### Review architectural decisions
Any substantial changes made to the codebase should be reviewed to ensure
that they conform to the current way code/services are laid out.
Architecture Decision Records (or [ADR](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions)) are now being used to describe architectural decisions and can be found in the `src/docs/architecture/decisions` directory.
### Verify localizations
While we don't have any automated tools at the time of writing that will
verify this in CI, any stringsbeing added that are presented to the end user
should be wrapped in localization components to support other languages.
## Localization
We use the [fluent](http://projectfluent.org/) library and store our
@@ -64,3 +168,384 @@ where the string is used.
Once a language has enough coverage, it should be added to
`src/core/common/helpers/i18n/locales.ts`.
The [Perspective API](https://github.com/conversationai/perspectiveapi/blob/master/2-api/methods.md#analyzecomment-request)
also supports comments in specific languages. When the language is supported in
Coral and supported by the Perspective API, the language should be added to the
language map in `src/core/server/services/comments/pipeline/phases/toxic.ts`.
## Documentation
Documentation that is publicly shown on
[docs.coralproject.net](https://docs.coralproject.net/coral/) is stored under
the `release/4` branch as it contains information for versions 4.0 onwards of
Coral.
To contribute new docs, you can either click the "Suggest Edits" in the top
right of each page, or you can edit directly via source. We suggest that for
individual fixes or contributions to the documentation.
If you want to contribute via source files, you can follow the procedure
outlined below:
1. Clone the Talk repository via `git clone https://github.com/coralproject/talk.git`
2. Switch to the `release/4` branch via `git checkout release/4`
3. Follow the procedure outlined on that branch's [CONTRIBUTING.md](https://github.com/coralproject/talk/blob/release/4/CONTRIBUTING.md#contributing-documentation) file for contributing documentation changes
4. Create a pull request to merge your changes back into the `release/4` branch
## Design Principles
### GraphQL
Coral relies heavily on [GraphQL](https://graphql.org) as the query language for
the API and the runtime on the server that powers resolving data from data
sources. This heavily influences a lot of the decisions around how we create and
consume it's API internally and how we expose it to others to interact with.
There are many GraphQL types in our [`schema.graphql`](https://github.com/coralproject/talk/blob/master/src/core/server/graph/schema/schema.graphql)
that define the way we handle data in our API. We'll try to outline a few of
them here with examples to help you understand their uses.
#### Types
Similar to defining an interface or a _struct_ definition, GraphQL has flexible
types that can be used to define data types that are used for querying data from
the API. This retrieval can happen directly via a query, or after executing an
action using a mutation and querying its response result.
An example of these types is the `Comment` and its nested `CommentRevision`
type:
```graphql
"""
Comment is a comment left by a User on an Story or another Comment as a reply.
"""
typeComment{
"""
id is the identifier of the Comment.
"""
id:ID!
"""
body is the content of the Comment, and is an alias to the body of the
`revision.body`.
"""
body:String
"""
revision is the current revision of the Comment's body.
"""
revision:CommentRevision
"""
revisionHistory stores the previous CommentRevision's, with the most recent
edit last.
"""
revisionHistory:[CommentRevision!]!
@auth(
roles:[MODERATOR,ADMIN]
userIDField:"author_id"
permit:[SUSPENDED,BANNED,PENDING_DELETION]
)
"""
status represents the Comment's current status.
"""
status:COMMENT_STATUS!
}
```
Notice how the `Comment` type can nest more custom defined types. A `Comment`
can have a current `CommentRevision` named `revision`. It also has a list of its
historical `revisionHistory`:
```graphql
typeCommentRevision{
"""
id is the identifier of the CommentRevision.
"""
id:ID!
"""
comment is the reference to the original Comment associated with the current
Comment.
"""
comment:Comment!
"""
actionCounts stores the counts of all the actions for the CommentRevision
Mutations are a request to GraphQL to initiate an action which will result in a response. As such,they're broken up into an `Input` and `Payload` pair that matches a mutation's request and response pair.
An example is the `CreateCommentInput` and `CreateCommentPayload`:
```graphql
"""
CreateCommentInput provides the input for the createComment Mutation.
"""
inputCreateCommentInput{
"""
storyID is the ID of the Story where we are creating a comment on.
"""
storyID:ID!
"""
nudge when true will instead return an error related to recoverable moderation
faults such as a toxic comment or spam comment to provide user feedback to
nudge the user to correct the comment.
"""
nudge:Boolean=false
"""
body is the Comment body, the content of the Comment.
"""
body:String!
"""
clientMutationId is required for Relay support.
"""
clientMutationId:String!
}
"""
CreateCommentPayload contains the created Comment after the createComment
mutation.
"""
typeCreateCommentPayload{
"""
edge is the possibly created comment edge.
"""
edge:CommentEdge!
"""
clientMutationId is required for Relay support.
"""
clientMutationId:String!
}
```
The `CreateCommentInput` type contains some parameters that allow us to execute
the mutation. These are:
-`storyID` - the story we are submitting the comment to.
-`body` - the body of our comment.
-`nudge` - whether we should return validation prompts to the user about
improper comment language.
-`clientMutationId` - the identifier used by Relay to identify this mutation,
our front-end state cache to process the mutation request. This is the only
place in the code-base that we do not capitalize the acronym when written in
camel-case, this is unfortunately due to legacy reasons from within Relay.
The returned response for a mutation is a what we call a Payload, in this case
it's `CreateCommentPayload`. This usually has a response that is the full data
type of whatever was modified by the earlier called mutation action. The
properties on this type are:
-`edge` - we return the full comment edge that was created by the previous
input. This is done so that the mutation request can query whatever it needs
to from the returned input to update state on the client.
-`clientMutationId` - an identifier used by Relay (our front-end client state
cache) to process the mutation request.
#### Access Permissions On Types
Sometimes, you only want specific users to be allowed to view certain
information. For instance, we have roles that are defined in our schema so we
can filter who can have access to what.
These roles are used with directives on our schema that GraphQL then enforces
when trying to resolve requests a user makes. If the user has the specified role
associated with their signed-in account, they are given access to the requested
data.
An example of this is the `revisionHistory` on the `Comment` type:
```graphql
fragmentonComment{
"""
revisionHistory stores the previous CommentRevision's, with the most recent
edit last.
"""
revisionHistory:[CommentRevision!]!
@auth(
roles:[MODERATOR,ADMIN]
userIDField:"author_id"
permit:[SUSPENDED,BANNED,PENDING_DELETION]
)
}
```
Here we see the `@auth` directive. It has documentation describing the various
parameters allowed located in the [`schema.graphql`](https://github.com/coralproject/talk/blob/master/src/core/server/graph/schema/schema.graphql)
file, we'll discuss below what this particular set of parameters can be read as:
- The roles that are allowed to access this information are `MODERATOR` and
`ADMIN` as defined by the `roles` argument.
- We let the directive know that the author of the comment is `author_id` from
the `Comment` by defining the `userIDField`. It's a rule of thumb in Coral if
the Author created the document, they have permission to view it. A Comment
for example is authored by a user, with the underlying field associated with
the id of that author living on the `author_id` field. You can see how this
is related if you look at the resolver for the `Comment` type to see that it
is based off of the `Comment` interface from `src/core/server/models/comment`.
- We permit returning comments when the author has the following conditions
associated with their account: `SUSPENDED`, `BANNED`, or `PENDING_DELETION`.
These directives can be simpler, for example the `metadata` property on the
Here we see an auth directive with only roles defined. This is sufficient to
make sure that the metadata property is only accessible to `ADMIN` and
`MODERATOR` user roles.
Note: Wondering how the user roles are defined? They're simply an enumeration
type that is also defined in the schema.
```graphql
enumUSER_ROLE{
COMMENTER
STAFF
MODERATOR
ADMIN
}
```
#### Arrays of Items
Sometimes you don't want a singular property, your property is instead a
collection of items.
The `revisionHistory` from the `Comment` is again useful as an example:
```graphql
fragmentonComment{
"""
revisionHistory stores the previous CommentRevision's, with the most recent
edit last.
"""
revisionHistory:[CommentRevision!]!
}
```
The interior type `CommentRevision` is required using the `!` and the outer
array is also required using `!`.
We do this for a couple of reasons:
- This ensures that we do not return null/undefined values within the array.
- Why would we return a null when we can just return nothing for null values?
- We want the array to always be defined, if empty, we return and empty array (i.e. `[]`).
- This can be handled nicely in our resolvers. We simply check if the retrieved values is null or undefined and simply return an empty array in its stead.
These little tweaks aren't necessary, but they ease the use of our API by making
the results for arrays predictable and strongly typed.
#### Documenting
As you may have noticed, there is quite a bit of documentation in the schema examples listed here.
We typically follow these two rules in commenting our GraphQL types:
- Always comment the property within a type describing its purpose on its parent type
i.e. `createdAt` on our `Setting` type:
```graphql
fragment on Setting {
"""
createdAt is the time that the Settings was created at.
"""
createdAt: Time! @auth(roles: [ADMIN])
}
```
- Always comment the purpose of each type
i.e. the `Comment` type:
```graphql
"""
Comment is a comment left by a User on an Story or another Comment as a reply.
@@ -28,13 +28,11 @@ You can get started with Coral using our [Documentation](https://docs.coralproje
## Pre-Launch Guide
You’ve installed Talk on your server, and you’re preparing to launch it on your site. The real community work starts now, before you go live. You have a unique opportunity pre-launch to set your community up for success. Read our [Talk Community Guide](https://coralproject.net/blog/youve-installed-talk-now-what/).
You’ve installed Coral on your server, and you’re preparing to launch it on your site. The real community work starts now, before you go live. You have a unique opportunity pre-launch to set your community up for success. Read our [Community Guides](https://guides.coralproject.net/start-here/) to learn more.
## More Resources
- [Our Blog](https://coralproject.net/blog)
- [Community Guides for Journalism](https://guides.coralproject.net/)
- [More About Us](https://coralproject.net/)
- [Learn more about Coral and sign up for a webinar](https://coralproject.net/)
Some files were not shown because too many files have changed in this diff
Show More
Reference in New Issue
Block a user
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.