' ).text( String( plugin.slug ) ), @@ -345,14 +373,26 @@ } /** - * Shows whether the plugin's domains carry the author's record, and whether the submitter's address is at one. + * Shows whether the plugin's domains carry the author's record, and whether the submitter's address is at one, and + * marks the check when all were checked and none proves they own it. * - * @param {jQuery} $owner The owner details. + * @param {jQuery} $owner The owner check. * @param {Object} owner The check. * @param {Object|null} plugin The plugin, if known. * @param {Object} strings Labels. */ function showOwner( $owner, owner, plugin, strings ) { + // Any of them proves it; unknown ones, null, weren't checked. + if ( + [ 'author', 'plugin', 'email' ].every( + ( key ) => false === owner[ key ] + ) + ) { + $owner + .addClass( 'is-ignored' ) + .attr( 'title', strings.owner_ignored ); + } + [ 'author', 'plugin' ].forEach( ( key ) => { if ( true === owner[ key ] ) { $owner @@ -366,7 +406,7 @@ } ); if ( plugin && plugin.submitter ) { - addRow( $owner, strings.submitter, [ + addRow( $owner.find( '.wporg-review-details' ), strings.submitter, [ String( plugin.submitter.username ), $( '' ), $( '' ) @@ -388,8 +428,9 @@ * @param {jQuery} $panel Panel. * @param {Object} strings Labels. * @param {function(Object): void} onPlugin Called with the plugin, once it's known. + * @param {number} attempt How many times it was asked for already. */ - function loadPlugin( $panel, strings, onPlugin ) { + function loadPlugin( $panel, strings, onPlugin, attempt = 0 ) { $.getJSON( String( $panel.data( 'url' ) ) ) .done( ( result ) => { const plugin = result && result.plugin ? result.plugin : null; @@ -408,6 +449,17 @@ } } ) .fail( ( xhr ) => { + if ( 429 === xhr.status && attempt < RETRY.times ) { + const next = attempt + 1; + const wait = + next * RETRY.after + Math.random() * RETRY.jitter; + + setTimeout( () => { + loadPlugin( $panel, strings, onPlugin, next ); + }, wait ); + return; + } + addRow( $panel.find( '.wporg-review-plugin' ), strings.status, [ $( '' ).text( 429 === xhr.status ? strings.throttled : strings.failed @@ -417,62 +469,28 @@ } /** - * Reads the agent's preference for the tab's title. - * - * @return {boolean} Whether they want the full title. - */ - function prefersFullTitle() { - try { - return '1' === window.localStorage.getItem( FULL_TITLE_KEY ); - } catch { - return false; - } - } - - /** - * Keeps the agent's preference for the tab's title. + * Puts the marks of the review's flags before the tab's title, its subject's short version in it without the + * conversation's number, and keeps it that way as FreeScout changes it, like when it counts new replies. * - * @param {boolean} full Whether they want the full title. + * @param {jQuery} $data What the page says about the conversation's subject. + * @param {string[]} flags Flags. */ - function preferFullTitle( full ) { - try { - if ( full ) { - window.localStorage.setItem( FULL_TITLE_KEY, '1' ); - } else { - window.localStorage.removeItem( FULL_TITLE_KEY ); - } - } catch { - // Then it's only for this page. + function manageTitle( $data, flags ) { + const subject = String( $data.attr( 'data-subject' ) || '' ); + const number = String( $data.attr( 'data-number' ) || '' ); + if ( ! subject || ! number ) { + return; } - } - /** - * Puts the marks of the review's flags before the tab's title, shortens the subject in it, and keeps it that way as - * FreeScout changes it, like when it counts new replies. - * - * @param {jQuery} $panel Panel. - * @param {string[]} flags Flags. - * @param {Object} strings Labels. - */ - function manageTitle( $panel, flags, strings ) { const marks = Object.keys( TITLE_MARKS ) .filter( ( flag ) => flags.includes( flag ) ) .map( ( flag ) => TITLE_MARKS[ flag ] ) .join( '' ); - const subject = String( $panel.attr( 'data-subject' ) || '' ); - let shortSubject = String( $panel.attr( 'data-short-subject' ) || '' ); - - // Shortening only goes one way: a short subject that holds the full one could never be told from it. - if ( ! subject || shortSubject.includes( subject ) ) { - shortSubject = ''; - } - if ( ! marks && ! shortSubject ) { - return; - } - - const $toggle = $panel.find( '.wporg-review-title-toggle' ); - let full = prefersFullTitle(); + // FreeScout's title starts with the number and the subject; the short one, with the short subject alone. + const long = '#' + number + ' ' + subject; + const short = + String( $data.attr( 'data-short-subject' ) || '' ) || subject; // FreeScout's count of new replies goes first, then the marks. const prefix = new RegExp( @@ -485,14 +503,8 @@ const match = document.title.match( prefix ); let rest = document.title.slice( match[ 0 ].length ); - /* - * Each way only replaces what the other way leaves, so another pass changes nothing: the short subject may be - * part of the full one, but not the other way around. - */ - if ( shortSubject && full && ! rest.includes( subject ) ) { - rest = rest.replace( shortSubject, subject ); - } else if ( shortSubject && ! full ) { - rest = rest.replace( subject, shortSubject ); + if ( rest.startsWith( long ) ) { + rest = short + rest.slice( long.length ); } const title = @@ -501,18 +513,8 @@ document.title = title; } }; - const label = () => - $toggle.text( full ? strings.short_title : strings.full_title ); update(); - label(); - - $toggle.on( 'click', () => { - full = ! full; - preferFullTitle( full ); - update(); - label(); - } ); const element = document.querySelector( 'title' ); if ( element ) { @@ -524,6 +526,81 @@ } } + /** + * Shows a marked subject in an element, which keeps the subject itself for hovering and copying. + * + * @param {jQuery} $element Element. + * @param {Object} subjects Subject, and marked subject. + */ + function markSubject( $element, subjects ) { + $element + .addClass( 'wporg-subject' ) + .attr( { + title: subjects.subject, + 'data-wporg-subject': subjects.subject, + } ) + .text( subjects.marked ); + } + + /** + * Marks the subjects of the conversation and of its sender's previous conversations, as the page says; lists of + * conversations come marked already. + * + * @param {jQuery} $data What the page says about the conversation's subject. + */ + function markSubjects( $data ) { + let subjects; + try { + subjects = JSON.parse( String( $data.attr( 'data-subjects' ) ) ); + } catch { + return; + } + + $( '.sidebar-block-list a.help-link' ).each( function () { + const id = String( $( this ).attr( 'href' ) || '' ).match( + /\/conversation\/(\d+)/ + ); + const item = id && subjects[ id[ 1 ] ]; + const node = item && this.lastChild; + if ( + node && + window.Node.TEXT_NODE === node.nodeType && + node.nodeValue.trim() === item.subject + ) { + const $subject = $( '' ); + markSubject( $subject, item ); + $( node ).replaceWith( $subject ); + } + } ); + + const current = + subjects[ String( $data.attr( 'data-conversation-id' ) ) ]; + const $heading = $( '.conv-subjtext > span' ).first(); + if ( ! current || ! $heading.length ) { + return; + } + + /* + * FreeScout's editor keeps the subject itself, and puts what the agent saves in the heading, which shows as it is + * until the page loads again. + */ + const update = () => { + const text = $heading.text(); + if ( text === current.subject ) { + markSubject( $heading, current ); + } else if ( text !== current.marked ) { + $heading.removeAttr( 'title data-wporg-subject' ); + } + }; + + update(); + new window.MutationObserver( update ).observe( $heading[ 0 ], { + childList: true, + characterData: true, + subtree: true, + } ); + } + /** * The username in the last Review ID line of a text, read the way the module's ReviewId class reads it. * @@ -668,6 +745,110 @@ return check; } + /** + * The rows of the conversations a worklist's Open button opens, in the order it opens them. + * + * @param {jQuery} $button The button. + * @return {jQuery[]} Rows. + */ + function rowsToOpen( $button ) { + return String( $button.attr( 'data-conversations' ) || '' ) + .split( ',' ) + .filter( Boolean ) + .map( ( id ) => + $button + .closest( '.wporg-worklist-section' ) + .find( 'tr[data-conversation_id="' + id + '"]' ) + ) + .filter( ( $row ) => $row.length ); + } + + /** + * Unmarks the conversations an Open button would open. + */ + function unmarkRowsToOpen() { + $( '.wporg-worklist tr.is-to-open' ).removeClass( 'is-to-open' ); + $( '.wporg-worklist-open-order' ).remove(); + } + + // The My Reviews and My Cases folders show a member's conversations, or a tag's, as soon as they're chosen. + $( document ).on( 'change', '.wporg-worklist-filter', function () { + this.form.submit(); + } ); + + // Their Open buttons mark which conversations they'd open, and in what order. + $( document ).on( + 'mouseenter focus', + '.wporg-worklist-open-button', + function () { + unmarkRowsToOpen(); + rowsToOpen( $( this ) ).forEach( ( $row, index ) => { + $row.addClass( 'is-to-open' ) + .find( '.wporg-worklist-name' ) + .prepend( + $( '' ).text( + index + 1 + ) + ); + } ); + } + ); + $( document ).on( + 'mouseleave blur', + '.wporg-worklist-open-button', + unmarkRowsToOpen + ); + + /* + * And open them in new tabs, in that order, telling each when and in which position it was opened; browsers block + * all but the first, unless the site may open pop-ups. + */ + $( document ).on( 'click', '.wporg-worklist-open-button', function () { + const $button = $( this ); + const batch = String( Date.now() ); + let blocked = 0; + + rowsToOpen( $button ).forEach( ( $row, index ) => { + const href = $row.find( 'a[href]' ).first().attr( 'href' ); + if ( ! href ) { + return; + } + + const url = new URL( href, window.location.href ); + url.searchParams.set( OPEN_PARAMS.batch, batch ); + url.searchParams.set( OPEN_PARAMS.order, String( index + 1 ) ); + if ( ! window.open( url.href, '_blank' ) ) { + blocked++; + } + } ); + + if ( blocked ) { + const strings = + $button.closest( '.wporg-worklist-open' ).data( 'strings' ) || + {}; + const message = String( strings.blocked || '' ).replace( + ':count', + blocked + ); + + if ( 'function' === typeof window.showFloatingAlert ) { + window.showFloatingAlert( 'error', message ); + } else { + window.alert( message ); // eslint-disable-line no-alert + } + } + } ); + + // Their conversations someone is participating in get FreeScout's own bulk actions, which modules like Tags add to. + $( function () { + if ( + $( '.wporg-worklist .conv-checkbox' ).length && + 'function' === typeof window.converstationBulkActionsInit + ) { + window.converstationBulkActionsInit(); + } + } ); + $( function () { const $panel = $( '.wporg-review' ); if ( ! $panel.length ) { @@ -703,6 +884,9 @@ checkReply(); loadPlugin( $panel, strings, ( plugin ) => { + // For the header's Copy button, which collects the download URLs of the plugins open. + $( document ).trigger( 'wporgpluginreview:plugin', [ plugin ] ); + if ( plugin.submitter && plugin.submitter.username ) { authors.add( String( plugin.submitter.username ).toLowerCase() @@ -710,13 +894,77 @@ checkReply(); } } ); + } ); + + // The plugin directory's subjects, for the plugins team, with or without a review to show. + $( function () { + const $data = $( '.wporg-subjects' ).first(); + if ( ! $data.length ) { + return; + } + markSubjects( $data ); manageTitle( - $panel, - String( $panel.attr( 'data-flags' ) || '' ) + $data, + String( $( '.wporg-review' ).attr( 'data-flags' ) || '' ) .split( ' ' ) - .filter( Boolean ), - strings + .filter( Boolean ) ); } ); + + // Copying a marked subject copies the subject itself. + $( document ).on( 'copy', ( event ) => { + const view = ( event.target.ownerDocument || document ).defaultView; + const selection = view && view.getSelection(); + const clipboard = + event.originalEvent && event.originalEvent.clipboardData; + if ( ! selection || selection.isCollapsed || ! clipboard ) { + return; + } + + const marked = $( '[data-wporg-subject]' ) + .filter( function () { + return selection.containsNode( this ); + } ) + .get(); + if ( ! marked.length ) { + return; + } + + const copied = selection.toString(); + const ranges = []; + for ( let i = 0; i < selection.rangeCount; i++ ) { + ranges.push( selection.getRangeAt( i ).cloneRange() ); + } + + // Each is found after the text selected before it, as the selection reads it, last first so the others stay put. + let text = copied; + marked.reverse().forEach( ( element ) => { + const before = element.ownerDocument.createRange(); + before.setStart( + ranges[ 0 ].startContainer, + ranges[ 0 ].startOffset + ); + before.setEndBefore( element ); + selection.removeAllRanges(); + selection.addRange( before ); + + const shown = $( element ).text(); + const at = text.indexOf( shown, selection.toString().length ); + if ( -1 !== at ) { + text = + text.slice( 0, at ) + + String( $( element ).attr( 'data-wporg-subject' ) ) + + text.slice( at + shown.length ); + } + } ); + + selection.removeAllRanges(); + ranges.forEach( ( range ) => selection.addRange( range ) ); + + if ( text !== copied ) { + clipboard.setData( 'text/plain', text ); + event.preventDefault(); + } + } ); } )( jQuery ); diff --git a/freescout.wordpress.net/Modules/WPOrgPluginReview/README.md b/freescout.wordpress.net/Modules/WPOrgPluginReview/README.md index bf8025e50f..6b0bacbf06 100644 --- a/freescout.wordpress.net/Modules/WPOrgPluginReview/README.md +++ b/freescout.wordpress.net/Modules/WPOrgPluginReview/README.md @@ -1,6 +1,6 @@ # WP.org Plugin Review -Shows the latest plugin review of a conversation in its sidebar, for the plugins team, read from the review emails in FreeScout's database. +Shows the latest plugin review of a conversation in its sidebar, for the plugins team, read from the review emails in FreeScout's database. Adds [My Reviews and My Cases](#my-reviews-and-my-cases) folders of the reviews and cases each member is working on. ## Who sees it @@ -14,17 +14,65 @@ A conversation gets the **Plugin Review** panel once the team has sent it a revi - **Details** from the latest Review ID: the slug, linked to the plugin's edit page on WordPress.org, the submitter's profile, and how many reviews there were and when. - **Flags**: the review's own (like `TRM` for naming, and `OWN` for ownership), and `UPD` while the author owes an update: a review asked for one, none approved the plugin, and since the latest review email, WordPress.org hasn't confirmed an upload, or the team wrote to the author again after the latest confirmation. The browser tab's title starts with ๐ด for `UPD`, ๐ for `TRM`, and ๐ค for `OWN`, in that order. -- **Names**, for `TRM`: the name the plugin was submitted with, and the name and slug the review suggests. -- **Owner**, for `OWN`: the domains of the plugin's Author URI and Plugin URI, marked "DNS verified" when they carry the `wordpressorg-{username}-verification` TXT record the ownership emails ask for. The username is the Review ID's, or the submitter's when it doesn't name one. -- **The plugin as it is now**, from WordPress.org by the Review ID's plugin ID, or by its slug for reviews that don't carry the ID: its status, who's assigned to it, a button that copies its ZIP's URL (with the review info the review tools read, while it's in review), and, once it's released, links to its page and its security scans. A naming review also shows its current name and slug, in green when it's the suggested name and in red when it's still the original; an ownership review shows the submitter, with their email address in green when it's at one of the plugin's domains. +- **Names**, for `TRM`: the name the plugin was submitted with, and the name and slug the review suggests, if it suggests any. Once the plugin's current name is known, the section is green when it's the suggested name (or slug, when the review suggests no name), red when it's still the original, and orange when it's another name that needs a look. +- **Owner**, for `OWN`: the domains of the plugin's Author URI and Plugin URI, marked "DNS verified" when they carry the `wordpressorg-{username}-verification` TXT record the ownership emails ask for. The username is the Review ID's, or the submitter's when it doesn't name one. The section is red when neither domain is verified and the submitter's email address isn't at either. +- **The plugin as it is now**, from WordPress.org by the Review ID's plugin ID, or by its slug for reviews that don't carry the ID: its status, who's assigned to it, a button that copies its ZIP's URL (with the review info the review tools read, while it's in review), and, once it's released, links to its page and its security scans. A naming review also shows its current name and slug; an ownership review shows the submitter, with their email address in green when it's at one of the plugin's domains. - **Issues** the review lists, under their headings' ๐ด (or the older `##`); warnings, under ๐ก, aren't listed. Clicking one scrolls to it in the email. Quoted text is left out, so an author's reply that quotes a review isn't read as one. What WordPress.org and DNS say is loaded after the page, so neither holds it up. -The tab's title also shortens the plugin directory's subjects, like "R: My Plugin" for "[WordPress Plugin Directory] Review in Progress: My Plugin"; a link at the bottom of the panel switches back to the full title, which the browser remembers. +The plugin directory's most common subjects show with a mark in place of everything before the plugin's name, replies and forwards included: in the conversation, its tab's title, the sender's previous conversations, and lists of conversations. The full subject shows on hover and in the subject's editor, and is what gets copied. + +| Subject | Shows as | +| --- | --- | +| [WordPress Plugin Directory] Review in Progress: My Plugin | ๐ My Plugin | +| [WordPress Plugin Directory] Closure Notice - Licensing/Trademark Violation: My Plugin | ๐โข๏ธ My Plugin | +| [WordPress Plugin Directory] Closure Notice - Guideline Violation: My Plugin | ๐๐ My Plugin | +| [WordPress Plugin Directory] Notice: My Plugin | ๐โน๏ธ My Plugin | +| [WordPress Plugin Directory] Security Notice: My Plugin | ๐๐ก๏ธ My Plugin | +| [WordPress Plugin Directory] Rejection Explanation: My Plugin | ๐๐ซ My Plugin | + +The tab's title leaves out the conversation's number, and shortens the plugin directory's other subjects too, like "Closed (Author Request): My Plugin". Marks are in `Services/Subject.php`. While an agent writes a reply, a warning shows above it when the reply has a Review ID for a username other than the latest review's and the plugin's submitter's, until they say it's the right one: it would send one author's review to another. +## My Reviews and My Cases + +The plugins team's mailbox gets two folders, right after Unassigned and before Mine, set apart from the folders after them, for the same agents as the panel: **My Reviews**, of the open and pending conversations assigned to the Plugin Reviews team, and **My Cases**, of the Plugin Admins team's: questions, guideline reports, replies to rejections, sockpuppets, adoptions, and the like. Each has three sections: + +- **Reviews (or Cases) I'm participating in**: ones the agent sent a reply to. Notes and drafts don't count. +- **Reviews (or Cases) I'm mentioned in**: ones with a note that mentions the agent, with the Mentions module's `@` mentions. Mentions of a team the agent is in don't count. +- **Reviews that need a reviewer**, or **Cases that need a volunteer**: ones with `PRTRN` in a note, and ones no member replied to yet: no member of the plugins team's teams, as they are now, so replies from other agents, workflows, and former members don't count. Without the Teams module, any agent's reply does. + +Each conversation shows only in the first section it belongs to, the longest waiting first, with its tags and how many threads it has, as FreeScout counts them: emails, not notes. Every one shows, without pages. The reviewer or volunteer at the top switches to another member of the plugins team's teams, to see theirs, and My Cases can be filtered by a tag its conversations have. Agents who may only see the conversations assigned to them see only those here too. + +Conversations someone is participating in can be selected, and changed together with FreeScout's bulk actions: status, assignee, and deleting, and the Tags and Workflows modules' tags and manual workflows. + +Without the Teams module, both folders are of the mailbox's open and pending conversations, whoever they're assigned to. With it, but without a team of that name, they're empty. + +The folders aren't stored: they're added to the mailbox's folders as they're listed. Their counts are how many active conversations the agent is participating in: the ones whose sender wrote last, like core's folders count. Every member's count comes from one query per folder, kept in FreeScout's cache for up to ten minutes, and forgotten sooner when an agent's reply is published or removed, a sender replies, or a conversation in the mailbox changes status, assignee, or mailbox, or is deleted, merged, or imported. Agents who may only see the conversations assigned to them have theirs counted on their own, and kept the same way. A page takes one query for which sections every conversation belongs to, and a few to load the ones that do and their tags; with a thousand open conversations, that's a few tens of milliseconds. + +Their definitions, like the team and what the sections are called, are in `Services/Worklist.php`. + +### Opening conversations + +Next to the participating section's heading, two buttons open its active conversations in new tabs: up to 25 at a time, or as many as the agent chooses under **Conversations to open** in their profile, up to 100. Neither opens a conversation whose sender has waited less than 12 hours, since its latest reply, as Waiting Since shows. Hovering or focusing a button marks the conversations it would open, numbered in order. + +- **Open Oldest First**: the longest waiting first. +- **Open Progress Based**: the longest waiting first, after each has waited as long as the team's replies to it make it: the more replies, the worse the review went, and the longer the others go first. The team's emails count, its first one included when the team wrote it, and notes don't. 1 or 2 replies wait at least a day, 3 or 4 two days, 5 or 6 four, 7 or 8 five, 9 or 10 six, and more, eight. The `sockpuppet` and `sockpuppeting` tags add four days. A conversation that has waited that long is ahead of one that waited longer but has to wait more: they go by how long they've waited beyond it. + +The waits are `OpenOrder::WAIT_DAYS` and `OpenOrder::TAG_WAIT_DAYS`, in `Services/OpenOrder.php`. Browsers open the first tab and block the rest unless the site may open pop-ups; the page says how many were blocked, so the agent can allow them once. Each conversation opens with `wporg_open_batch`, when the button was clicked, and `wporg_open_order`, its position, which keep their download URLs in that order. + +## Copying download URLs + +For reviewing plugins in bulk with a local tool, the header has a **Copy X URLs** button, for the same agents as the panel, once they have open conversations whose panel knows the plugin's download URL. It copies them as `"||โฆ"`: in quotes, separated by pipes, each once, in the order the agent opened them. The ones the Open buttons opened go by their batch and position, whichever tab loaded first; the others by when they loaded. The trash bin next to it forgets them all. + +In the sidebar's **Plugins & Themes** panel, each plugin's download link has a button after it: **+** adds its URL to them, after the others, and **โ**, once it's there, removes it, however it got there. URLs added this way stay until they're removed, as no page holds them. WPOrgSidebar triggers `wporgsidebar:panel` on a panel once it's loaded, which is when the buttons are added. + +The URLs are only in the agent's browser: each conversation's page keeps its own, in `localStorage`, as soon as WordPress.org tells the panel the plugin, and removes it as it closes. It also holds a [Web Lock](https://developer.mozilla.org/docs/Web/API/Web_Locks_API) of the same name while it's open, which the browser lets go of however the page ends, even when it crashes or closes without saying so; the URLs of pages that don't hold theirs anymore are left out, and removed. A reload keeps the page's place. + +So that many tabs opening at once don't lose their URLs to the 120 plugins an agent may ask WordPress.org for in a minute, the panel asks again for those it was refused, up to three times, after 20 seconds or more, and longer each time. + ## WordPress.org The plugin comes from `api.wordpress.org/dotorg/freescout/plugin-review.php`, which only answers for the plugins team's mailbox (its address starts with `plugins`). Requests are signed with `WPORG_API_URL` and `WPORG_API_SECRET`, like the sidebar's panels, through WPOrgSidebar's client. Without them, the panel shows what the review emails say. diff --git a/freescout.wordpress.net/Modules/WPOrgPluginReview/Resources/views/downloads.blade.php b/freescout.wordpress.net/Modules/WPOrgPluginReview/Resources/views/downloads.blade.php new file mode 100644 index 0000000000..fc34f56831 --- /dev/null +++ b/freescout.wordpress.net/Modules/WPOrgPluginReview/Resources/views/downloads.blade.php @@ -0,0 +1,7 @@ +{{-- In the header's menu: copies the download URLs of the plugins in review the agent has open, shown once there are any; downloads.js fills it. --}} + + + + + + diff --git a/freescout.wordpress.net/Modules/WPOrgPluginReview/Resources/views/panel.blade.php b/freescout.wordpress.net/Modules/WPOrgPluginReview/Resources/views/panel.blade.php index 3f4d90a704..ba7fe457c6 100644 --- a/freescout.wordpress.net/Modules/WPOrgPluginReview/Resources/views/panel.blade.php +++ b/freescout.wordpress.net/Modules/WPOrgPluginReview/Resources/views/panel.blade.php @@ -12,28 +12,30 @@ ); @endphp {{-- FreeScout's own sidebar block, like Previous Conversations. --}} - @@ -88,32 +90,45 @@ @endif @if ( $review['names'] ) - {{ __( 'Names' ) }} - - {{ __( 'Original' ) }} - {{ '' !== $review['names']['original'] ? $review['names']['original'] : 'โ' }} - {{ __( 'Suggested' ) }} - {{ '' !== $review['names']['suggested'] ? $review['names']['suggested'] : 'โ' }} - @if ( '' !== $review['names']['suggested_slug'] ) - {{ __( 'Suggested slug' ) }} - - {{ $review['names']['suggested_slug'] }} - - - @endif - + @php + $names = $review['names']; + @endphp + {{-- The script colors it once it knows the plugin's current name. --}} + + {{ __( 'Names' ) }} + + {{ __( 'Original' ) }} + {{ '' !== $names['original'] ? $names['original'] : 'โ' }} + @if ( '' !== $names['suggested'] || '' !== $names['suggested_slug'] ) + {{ __( 'Suggested' ) }} + + {{ $names['suggested'] }} + @if ( '' !== $names['suggested_slug'] ) + @if ( '' !== $names['suggested'] ) + + @endif + {{ $names['suggested_slug'] }} + + @endif + + @endif + + @endif @if ( $review['owner'] ) - {{ __( 'Owner' ) }} - - @foreach ( array( 'author' => __( 'Author host' ), 'plugin' => __( 'Plugin host' ) ) as $key => $label ) - @if ( '' !== $review['owner'][ $key . '_host' ] ) - {{ $label }} - {{ $review['owner'][ $key . '_host' ] }} - @endif - @endforeach - + {{-- The script colors it once it knows whether the author proved they own the plugin. --}} + + {{ __( 'Owner' ) }} + + @foreach ( array( 'author' => __( 'Author host' ), 'plugin' => __( 'Plugin host' ) ) as $key => $label ) + @if ( '' !== $review['owner'][ $key . '_host' ] ) + {{ $label }} + {{ $review['owner'][ $key . '_host' ] }} + @endif + @endforeach + + @endif @if ( $review['issues'] ) @@ -126,11 +141,6 @@ @endforeach @endif - - @if ( '' !== $short_subject ) - {{-- Its label says what a click does, once the script knows which title the tab has. --}} - - @endif diff --git a/freescout.wordpress.net/Modules/WPOrgPluginReview/Resources/views/profile.blade.php b/freescout.wordpress.net/Modules/WPOrgPluginReview/Resources/views/profile.blade.php new file mode 100644 index 0000000000..2a278c8782 --- /dev/null +++ b/freescout.wordpress.net/Modules/WPOrgPluginReview/Resources/views/profile.blade.php @@ -0,0 +1,9 @@ +{{-- In the user's profile, like core's fields: how many conversations My Reviews and My Cases open at a time. --}} + + {{ __( 'Conversations to open' ) }} + + + + {{ __( 'How many conversations the Open buttons of My Reviews and My Cases open in new tabs at a time, up to :max.', array( 'max' => $max ) ) }} + + diff --git a/freescout.wordpress.net/Modules/WPOrgPluginReview/Resources/views/subjects.blade.php b/freescout.wordpress.net/Modules/WPOrgPluginReview/Resources/views/subjects.blade.php new file mode 100644 index 0000000000..65fae8beec --- /dev/null +++ b/freescout.wordpress.net/Modules/WPOrgPluginReview/Resources/views/subjects.blade.php @@ -0,0 +1,2 @@ +{{-- What the page's script needs to mark the subjects of the conversation, its tab's title, and its previous conversations. --}} + diff --git a/freescout.wordpress.net/Modules/WPOrgPluginReview/Resources/views/worklist.blade.php b/freescout.wordpress.net/Modules/WPOrgPluginReview/Resources/views/worklist.blade.php new file mode 100644 index 0000000000..7324867a77 --- /dev/null +++ b/freescout.wordpress.net/Modules/WPOrgPluginReview/Resources/views/worklist.blade.php @@ -0,0 +1,126 @@ +@extends('layouts.app') + +@php + $name = $user->getFullName(); + $headings = $list->headings( $is_viewer ? null : $name ); + $descriptions = $list->descriptions( $name ); + $title = $folder->getTypeName() . ' - ' . $mailbox->name; +@endphp + +@section('title', $folder->active_count ? '(' . (int) $folder->active_count . ') ' . $title : $title) + +@section('body_attrs')@parent data-mailbox_id="{{ $mailbox->id }}"@endsection + +@section('sidebar') + @include('partials/sidebar_menu_toggle') + @include('mailboxes/sidebar_menu_view') +@endsection + +@section('content') + + + {{ $list->member_label() }} + + @foreach ( $reviewers as $reviewer ) + id === (int) $user->id ) selected @endif>{{ $reviewer->getFullName() }} + @endforeach + + @if ( $tags ) + {{ __( 'Tag' ) }} + + {{ __( 'All tags' ) }} + @foreach ( $tags as $tag_id => $tag_option ) + {{ $tag_option['name'] }} ({{ $tag_option['count'] }}) + @endforeach + + @endif + {{ __( 'Show' ) }} + {{ __( 'Open and pending conversations assigned to :team.', array( 'team' => $list->team ) ) }} + + + @foreach ( $sections as $section => $conversations ) + @php + // Conversations someone is participating in can be changed together, with FreeScout's own bulk actions. + $selectable = 'participating' === $section && $conversations; + @endphp + + + + {{ $headings[ $section ] }} + {{ count( $conversations ) }} + + @if ( 'participating' === $section && $conversations ) + {{-- Opens the active ones in new tabs; hovering or focusing a button marks which, in order. --}} + + + {{ __( 'Open Oldest First' ) }} {{ count( $open['oldest'] ) }} + + + {{ __( 'Open Progress Based' ) }} {{ count( $open['progress'] ) }} + + {{ __( 'Up to :limit at a time', array( 'limit' => $limit ) ) }} + + @endif + + {{ $descriptions[ $section ] }} + + @if ( $conversations ) + @if ( $selectable ) + @include('conversations/partials/bulk_actions', array( 'mailbox' => $mailbox )) + @endif + + + + @if ( $selectable ) + {{ __( 'Select All Conversations' ) }} + @endif + {{ __( 'Sender' ) }} + {{ __( 'Conversation' ) }} + {{ __( 'Threads' ) }} + {{ __( 'Waiting Since' ) }} + + + + @foreach ( $conversations as $conversation ) + @php + $url = $conversation->url(); + @endphp + {{-- conv-row and conv-subject let the Tags module show tags added in bulk. --}} + + @if ( $selectable ) + + {{ __( 'Select Conversation' ) }}: {{ $conversation->getSubject() }} + + @endif + + + @if ( $conversation->customer ){{ $conversation->customer->getFullName( true ) }}@endif + {{ $conversation->customer_email }} + + + + + + @if ( ! $conversation->isActive() ){{ $conversation->getStatusName() }}@endif + @action('conversations_table.before_subject', $conversation){{ $conversation->getSubject() }}@action('conversations_table.after_subject', $conversation) + + {{ $conversation->preview }} + + + + {{ (int) $conversation->threads_count }} + + + {{ $conversation->getWaitingSince( $folder ) }} + + + @endforeach + + + @else + {{ $list->empty_text() }} + @endif + + @endforeach + +@endsection diff --git a/freescout.wordpress.net/Modules/WPOrgPluginReview/Services/IssueNames.php b/freescout.wordpress.net/Modules/WPOrgPluginReview/Services/IssueNames.php index 380f239f12..88d0195ff3 100644 --- a/freescout.wordpress.net/Modules/WPOrgPluginReview/Services/IssueNames.php +++ b/freescout.wordpress.net/Modules/WPOrgPluginReview/Services/IssueNames.php @@ -101,6 +101,13 @@ final class IssueNames { array( 'Phoning Home / Collecting User Data Without Opt-In Consent', 'Phoning Home / Collecting User Data', self::PRIORITY_HIGH ), array( 'The main file of the plugin has a name that does not follow the convention', 'Main plugin file naming', self::PRIORITY_NORMAL ), array( 'Arbitrary input in sensitive function parameters or calls', 'Arbitrary input in sensitive parameters/calls', self::PRIORITY_HIGH ), + array( 'The plugin has problems when it is activated', 'Activation issues', self::PRIORITY_NORMAL ), + array( 'Writing data to disallowed or incorrect locations, and/or asking users to edit plugin files', 'Writing data out of recommended directories', self::PRIORITY_LOW ), + array( 'There are unusual users in the "Contributors" list for this plugin', 'Unusual "Contributors"', self::PRIORITY_NORMAL ), + array( 'High position for your admin dashboard menu item', 'High position dashboard menu', self::PRIORITY_LOW ), + array( 'Improper handling of authentication cookies, keys, and salts.', 'Improper handling of authentication cookies, keys, and salts', self::PRIORITY_HIGH ), + array( 'Direct integration with a third-party AI provider detected.', 'Direct AI integration', self::PRIORITY_LOW ), + array( 'The functionality described is not in the plugin', 'Functionality not in the plugin', self::PRIORITY_HIGH ), ); /** diff --git a/freescout.wordpress.net/Modules/WPOrgPluginReview/Services/OpenOrder.php b/freescout.wordpress.net/Modules/WPOrgPluginReview/Services/OpenOrder.php new file mode 100644 index 0000000000..57ffb85f85 --- /dev/null +++ b/freescout.wordpress.net/Modules/WPOrgPluginReview/Services/OpenOrder.php @@ -0,0 +1,295 @@ + + */ + public const WAIT_DAYS = array( + 0 => 0, + 2 => 1, + 4 => 2, + 6 => 4, + 8 => 5, + 10 => 6, + PHP_INT_MAX => 8, + ); + + /** + * The days conversations with these tags wait on top of that. + * + * @var array + */ + public const TAG_WAIT_DAYS = array( + 'sockpuppet' => 4, + 'sockpuppeting' => 4, + ); + + /** + * Seconds in an hour. + * + * @var int + */ + private const HOUR = 3600; + + /** + * Seconds in a day. + * + * @var int + */ + private const DAY = 86400; + + /** + * Where the agents' choices of how many to open are kept, followed by their user ID. + * + * @var string + */ + private const LIMIT_OPTION = 'wporgpluginreview.open_limit.'; + + /** + * The active conversations to open, the longest waiting first. + * + * @param Conversation[] $conversations Conversations. + * @param int $limit How many to open at most. + * @return int[] Conversation IDs, in the order to open them. + */ + public static function oldest_first( array $conversations, int $limit ): array { + $waits = self::waits( $conversations ); + arsort( $waits ); + + return array_slice( array_keys( $waits ), 0, max( 0, $limit ) ); + } + + /** + * The active conversations to open by progress: the longest waiting, after each waits as many days as WAIT_DAYS and + * TAG_WAIT_DAYS make it. A conversation that waited that long is ahead of one that waited longer but has to wait + * more. + * + * @param Conversation[] $conversations Conversations. + * @param int $limit How many to open at most. + * @return int[] Conversation IDs, in the order to open them. + */ + public static function progress_based( array $conversations, int $limit ): array { + $waits = self::waits( $conversations ); + $replies = self::team_replies( array_keys( $waits ) ); + $tags = self::tags( array_keys( $waits ) ); + + // How long each waited beyond what it has to; the ones that didn't wait enough yet are left out. + $ahead = array(); + foreach ( $waits as $id => $seconds ) { + $beyond = $seconds - self::wait_days( $replies[ $id ] ?? 0, $tags[ $id ] ?? array() ) * self::DAY; + if ( $beyond >= 0 ) { + $ahead[ $id ] = $beyond; + } + } + arsort( $ahead ); + + return array_slice( array_keys( $ahead ), 0, max( 0, $limit ) ); + } + + /** + * How many days a conversation waits at least before it's opened by progress. + * + * @param int $replies How many replies the team sent to it. + * @param string[] $tags Its tags. + * @return int + */ + public static function wait_days( int $replies, array $tags ): int { + $days = 0; + foreach ( self::WAIT_DAYS as $most => $wait ) { + if ( $replies <= $most ) { + $days = $wait; + break; + } + } + + foreach ( $tags as $tag ) { + $days += self::TAG_WAIT_DAYS[ strtolower( $tag ) ] ?? 0; + } + + return $days; + } + + /** + * How many conversations an agent opens at a time. + * + * @param User $user Agent. + * @return int + */ + public static function limit( User $user ): int { + try { + // Not from Option's cache, which setting and removing options leave as it was. + $limit = (int) \Option::get( self::LIMIT_OPTION . $user->id, self::DEFAULT_LIMIT, true, false ); + } catch ( \Throwable $e ) { + \Log::error( '[WPOrgPluginReview] Could not read how many conversations user ' . $user->id . ' opens: ' . $e->getMessage() ); + + return self::DEFAULT_LIMIT; + } + + return $limit >= 1 ? min( $limit, self::MAX_LIMIT ) : self::DEFAULT_LIMIT; + } + + /** + * Sets how many conversations an agent opens at a time, between 1 and MAX_LIMIT; the default when it's empty. + * + * @param User $user Agent. + * @param mixed $limit How many, as sent. + * @return void + */ + public static function set_limit( User $user, mixed $limit ): void { + if ( ! is_numeric( $limit ) || self::DEFAULT_LIMIT === (int) $limit ) { + \Option::remove( self::LIMIT_OPTION . $user->id ); + + return; + } + + \Option::set( self::LIMIT_OPTION . $user->id, max( 1, min( (int) $limit, self::MAX_LIMIT ) ) ); + } + + /** + * Forgets an agent's choice, when they're deleted. + * + * @param int $user_id User ID. + * @return void + */ + public static function forget_limit( int $user_id ): void { + \Option::remove( self::LIMIT_OPTION . $user_id ); + } + + /** + * How long the senders of the active conversations that are old enough to open have waited. + * + * @param Conversation[] $conversations Conversations. + * @return array Seconds, by conversation ID. + */ + private static function waits( array $conversations ): array { + $now = Carbon::now(); + $waits = array(); + foreach ( $conversations as $conversation ) { + if ( Conversation::STATUS_ACTIVE !== (int) $conversation->status ) { + continue; + } + + $since = $conversation->last_reply_at ?? $conversation->created_at; + if ( ! $since ) { + continue; + } + + $since = $since instanceof \DateTimeInterface ? $since->getTimestamp() : Carbon::parse( (string) $since )->getTimestamp(); + $seconds = $now->getTimestamp() - $since; + if ( $seconds >= self::MIN_AGE_HOURS * self::HOUR ) { + $waits[ (int) $conversation->id ] = $seconds; + } + } + + // Ties go to the conversation that came in first. + ksort( $waits ); + + return $waits; + } + + /** + * How many replies the team sent to conversations: their published emails written by agents, the first one + * included, and not notes. + * + * @param int[] $ids Conversation IDs. + * @return array By conversation ID. + */ + private static function team_replies( array $ids ): array { + if ( ! $ids ) { + return array(); + } + + return \DB::table( 'threads' ) + ->whereIn( 'conversation_id', $ids ) + ->where( 'type', Thread::TYPE_MESSAGE ) + ->where( 'state', Thread::STATE_PUBLISHED ) + ->groupBy( 'conversation_id' ) + ->selectRaw( 'conversation_id, count(*) as total' ) + ->pluck( 'total', 'conversation_id' ) + ->map( + static function ( mixed $total ): int { + return (int) $total; + } + ) + ->all(); + } + + /** + * The tags of conversations that make them wait longer, with the Tags module. + * + * @param int[] $ids Conversation IDs. + * @return array Tag names, by conversation ID. + */ + private static function tags( array $ids ): array { + if ( ! $ids || ! Worklist::has_tags() ) { + return array(); + } + + try { + $tags = array(); + $rows = \DB::table( 'conversation_tag' ) + ->join( 'tags', 'tags.id', '=', 'conversation_tag.tag_id' ) + ->whereIn( 'conversation_tag.conversation_id', $ids ) + ->whereIn( 'tags.name', array_keys( self::TAG_WAIT_DAYS ) ) + ->select( 'conversation_tag.conversation_id', 'tags.name' ) + ->get(); + + foreach ( $rows as $row ) { + $tags[ (int) $row->conversation_id ][] = (string) $row->name; + } + + return $tags; + } catch ( \Throwable $e ) { + \Log::error( '[WPOrgPluginReview] Could not read the tags of the conversations to open: ' . $e->getMessage() ); + + return array(); + } + } +} diff --git a/freescout.wordpress.net/Modules/WPOrgPluginReview/Services/Reviewers.php b/freescout.wordpress.net/Modules/WPOrgPluginReview/Services/Reviewers.php index f2d3101923..0c60cf82f6 100644 --- a/freescout.wordpress.net/Modules/WPOrgPluginReview/Services/Reviewers.php +++ b/freescout.wordpress.net/Modules/WPOrgPluginReview/Services/Reviewers.php @@ -12,7 +12,7 @@ use App\User; /** - * Tells members of the plugins team's teams apart, with the Teams module. + * Tells members of the plugins team's teams apart, and finds its teams, with the Teams module. * * Teams is a premium module, which most contributors don't have; without it, everyone who can see the plugins team's * mailbox is taken for a reviewer. Not final, so tests can answer for Teams. @@ -26,6 +26,21 @@ class Reviewers { */ private const TEAM_PREFIX = 'Plugin'; + /** + * The name of the team that plugin reviews are assigned to. + * + * @var string + */ + public const REVIEW_TEAM = 'Plugin Reviews'; + + /** + * The name of the team that cases are assigned to: questions, guideline reports, replies to rejections, and the + * like. + * + * @var string + */ + public const ADMIN_TEAM = 'Plugin Admins'; + /** * The Teams module's alias. * @@ -68,6 +83,34 @@ public function includes( ?User $user ): bool { return false; } + /** + * A team's ID: the Teams module assigns conversations to a team as if it were a user. + * + * @param string $name The team's name, like REVIEW_TEAM. + * @return int|null Null without the Teams module; 0 when Teams has no such team, or can't tell, which no + * conversation is assigned to. + */ + public function team_id( string $name ): ?int { + if ( ! \App\Module::isActive( self::TEAMS_MODULE ) ) { + return null; + } + + try { + $id = array_search( $name, $this->teams(), true ); + if ( false === $id ) { + \Log::error( '[WPOrgPluginReview] There is no ' . $name . ' team.' ); + + return 0; + } + + return (int) $id; + } catch ( \Throwable $e ) { + \Log::error( '[WPOrgPluginReview] Could not find the ' . $name . ' team: ' . $e->getMessage() ); + + return 0; + } + } + /** * The names of the teams a user is a member of, as the Teams module tells them. * @@ -81,11 +124,24 @@ protected function team_names( User $user ): array { } $team_ids = array_map( 'intval', (array) $teams::getUserTeamIds( (int) $user->id ) ); - $names = array(); + + return array_values( array_intersect_key( $this->teams(), array_flip( $team_ids ) ) ); + } + + /** + * The Teams module's teams. + * + * @return string[] Names, by team ID. + */ + protected function teams(): array { + $teams = self::TEAMS; + if ( ! class_exists( $teams ) ) { + return array(); + } + + $names = array(); foreach ( $teams::getTeams( true ) as $team ) { - if ( in_array( (int) $team->id, $team_ids, true ) ) { - $names[] = (string) $team->first_name; - } + $names[ (int) $team->id ] = (string) $team->first_name; } return $names; diff --git a/freescout.wordpress.net/Modules/WPOrgPluginReview/Services/Subject.php b/freescout.wordpress.net/Modules/WPOrgPluginReview/Services/Subject.php index 206e4ac9ea..3d9944a055 100644 --- a/freescout.wordpress.net/Modules/WPOrgPluginReview/Services/Subject.php +++ b/freescout.wordpress.net/Modules/WPOrgPluginReview/Services/Subject.php @@ -1,6 +1,6 @@ '๐', + 'Closure Notice - Licensing/Trademark Violation' => '๐โข๏ธ', + 'Closure Notice - Guideline Violation' => '๐๐', + 'Notice' => '๐โน๏ธ', + 'Security Notice' => '๐๐ก๏ธ', + 'Rejection Explanation' => '๐๐ซ', + ); + + /** + * Short names of the other kinds of email, for the browser tab; others keep their own name. * * @var string[] */ private const KINDS = array( - 'Review in Progress' => 'R', - 'Rejection Explanation' => 'Rejected', - 'Security Notice' => 'Security', - 'Closure Notice' => 'Closed', + 'Closure Notice' => 'Closed', ); /** - * A subject's short version. + * A subject with its kind's mark in place of everything before the plugin's name, which the conversation, its tab, + * and lists of conversations show. + * + * @param string $subject Subject. + * @return string Empty if it isn't of one of the kinds with a mark. + */ + public static function marked( string $subject ): string { + $subject = self::without_prefix( $subject ); + $colon = null === $subject ? false : strpos( $subject, ': ' ); + if ( false === $colon ) { + return ''; + } + + $mark = self::MARKS[ trim( substr( $subject, 0, $colon ) ) ] ?? ''; + + return '' === $mark ? '' : $mark . ' ' . trim( substr( $subject, $colon + 2 ) ); + } + + /** + * A subject's short version, for the browser tab: the marked one, or one without the prefix for other kinds. * * @param string $subject Subject. * @return string Empty if it isn't one of the plugin directory's. */ public static function short( string $subject ): string { - // Replies and forwards keep the subject they answer. - $subject = trim( (string) preg_replace( '/^(?:(?:re|fwd?)\s*:\s*)+/i', '', trim( $subject ) ) ); - if ( 0 !== stripos( $subject, self::PREFIX ) ) { + $marked = self::marked( $subject ); + if ( '' !== $marked ) { + return $marked; + } + + $subject = self::without_prefix( $subject ); + if ( null === $subject ) { return ''; } - $subject = trim( substr( $subject, strlen( self::PREFIX ) ) ); - $colon = strpos( $subject, ': ' ); + $colon = strpos( $subject, ': ' ); if ( false === $colon ) { return $subject; } @@ -70,4 +103,20 @@ public static function short( string $subject ): string { return $short . ': ' . $name; } + + /** + * A plugin directory's subject without its prefix, nor those of replies and forwards. + * + * @param string $subject Subject. + * @return string|null Null if it isn't one of the plugin directory's. + */ + private static function without_prefix( string $subject ): ?string { + // Replies and forwards keep the subject they answer. + $subject = trim( (string) preg_replace( '/^(?:(?:re|fwd?)\s*:\s*)+/i', '', trim( $subject ) ) ); + if ( 0 !== stripos( $subject, self::PREFIX ) ) { + return null; + } + + return trim( substr( $subject, strlen( self::PREFIX ) ) ); + } } diff --git a/freescout.wordpress.net/Modules/WPOrgPluginReview/Services/Worklist.php b/freescout.wordpress.net/Modules/WPOrgPluginReview/Services/Worklist.php new file mode 100644 index 0000000000..4c0d3a0c29 --- /dev/null +++ b/freescout.wordpress.net/Modules/WPOrgPluginReview/Services/Worklist.php @@ -0,0 +1,686 @@ + new self( 'reviews', 'my-reviews', Reviewers::REVIEW_TEAM, 229, 'tasks', false ), + 'cases' => new self( 'cases', 'my-cases', Reviewers::ADMIN_TEAM, 230, 'briefcase', true ), + ); + } + + return self::$all; + } + + /** + * My Reviews: the Plugin Reviews team's. + * + * @return self + */ + public static function reviews(): self { + return self::all()['reviews']; + } + + /** + * My Cases: the Plugin Admins team's. + * + * @return self + */ + public static function cases(): self { + return self::all()['cases']; + } + + /** + * The worklist of a page. + * + * @param string $slug The page's part of its URL. + * @return self|null + */ + public static function by_slug( string $slug ): ?self { + foreach ( self::all() as $worklist ) { + if ( $worklist->slug === $slug ) { + return $worklist; + } + } + + return null; + } + + /** + * The pages' parts of their URLs, for the route. + * + * @return string[] + */ + public static function slugs(): array { + return array_values( + array_map( + static function ( self $worklist ): string { + return $worklist->slug; + }, + self::all() + ) + ); + } + + /** + * The worklist of a folder. + * + * @param mixed $folder Folder. + * @return self|null Null if it isn't one of theirs. + */ + public static function of_folder( mixed $folder ): ?self { + foreach ( self::all() as $worklist ) { + if ( $worklist->is_folder( $folder ) ) { + return $worklist; + } + } + + return null; + } + + /** + * The folder's name. + * + * @return string + */ + public function name(): string { + return 'cases' === $this->key ? __( 'My Cases' ) : __( 'My Reviews' ); + } + + /** + * What a member is called, for choosing whose conversations to show. + * + * @return string + */ + public function member_label(): string { + return 'cases' === $this->key ? __( 'Volunteer' ) : __( 'Reviewer' ); + } + + /** + * The sections' headings. + * + * @param string|null $name The member's name; null for the agent's own. + * @return string[] By section. + */ + public function headings( ?string $name ): array { + if ( 'cases' === $this->key ) { + return array( + 'participating' => null === $name ? __( 'Cases Iโm participating in' ) : __( 'Cases :name is participating in', array( 'name' => $name ) ), + 'mentioned' => null === $name ? __( 'Cases Iโm mentioned in' ) : __( 'Cases :name is mentioned in', array( 'name' => $name ) ), + 'needs' => __( 'Cases that need a volunteer' ), + ); + } + + return array( + 'participating' => null === $name ? __( 'Reviews Iโm participating in' ) : __( 'Reviews :name is participating in', array( 'name' => $name ) ), + 'mentioned' => null === $name ? __( 'Reviews Iโm mentioned in' ) : __( 'Reviews :name is mentioned in', array( 'name' => $name ) ), + 'needs' => __( 'Reviews that need a reviewer' ), + ); + } + + /** + * What's in the sections. + * + * @param string $name The member's name. + * @return string[] By section. + */ + public function descriptions( string $name ): array { + return array( + 'participating' => __( 'With a reply from :name.', array( 'name' => $name ) ), + 'mentioned' => __( 'With a note that mentions :name.', array( 'name' => $name ) ), + 'needs' => 'cases' === $this->key + ? __( 'With :marker in a note, or without a reply from a volunteer yet.', array( 'marker' => self::NEEDS_MARKER ) ) + : __( 'With :marker in a note, or without a reply from a reviewer yet.', array( 'marker' => self::NEEDS_MARKER ) ), + ); + } + + /** + * What an empty section says. + * + * @return string + */ + public function empty_text(): string { + return 'cases' === $this->key ? __( 'No cases.' ) : __( 'No reviews.' ); + } + + /** + * The page of the folder. + * + * @param int $mailbox_id Mailbox ID. + * @return string + */ + public function url( int $mailbox_id ): string { + return route( + 'wporgpluginreview.worklist', + array( + 'mailbox_id' => $mailbox_id, + 'worklist' => $this->slug, + ) + ); + } + + /** + * The folder's ID. + * + * @return int + */ + public function folder_id(): int { + return -$this->folder_type; + } + + /** + * Whether a folder is this worklist's. + * + * @param mixed $folder Folder. + * @return bool + */ + public function is_folder( mixed $folder ): bool { + return $folder instanceof Folder && $this->folder_type === (int) $folder->type; + } + + /** + * The folder, as the mailbox's folder list shows it. + * + * @param Mailbox $mailbox Mailbox. + * @return Folder + */ + public function folder( Mailbox $mailbox ): Folder { + $folder = new Folder(); + $folder->id = $this->folder_id(); + $folder->mailbox_id = (int) $mailbox->id; + $folder->type = $this->folder_type; + $folder->active_count = 0; + $folder->total_count = 0; + + return $folder; + } + + /** + * Adds the worklists' folders to a mailbox's folder list, after Unassigned and before Mine, with how many active + * conversations the agent is participating in. + * + * @param Collection $folders The mailbox's folders. + * @param Mailbox $mailbox Mailbox. + * @param User $user The agent. + * @return Collection + */ + public static function add_folders( Collection $folders, Mailbox $mailbox, User $user ): Collection { + $added = array(); + foreach ( self::all() as $worklist ) { + $folder = $worklist->folder( $mailbox ); + try { + $folder->active_count = $worklist->active_count( $mailbox, $user ); + } catch ( \Throwable $e ) { + \Log::error( '[WPOrgPluginReview] Could not count the ' . $worklist->key . ' of user ' . $user->id . ': ' . $e->getMessage() ); + } + $added[] = $folder; + } + + $list = array(); + $placed = false; + foreach ( $folders as $item ) { + if ( ! $placed && Folder::TYPE_MINE === (int) $item->type ) { + array_push( $list, ...$added ); + $placed = true; + } + + $list[] = $item; + + if ( ! $placed && Folder::TYPE_UNASSIGNED === (int) $item->type ) { + array_push( $list, ...$added ); + $placed = true; + } + } + + if ( ! $placed ) { + array_unshift( $list, ...$added ); + } + + return $folders->make( $list ); + } + + /** + * How many active conversations an agent is participating in, as the folder list shows it: the ones whose sender + * wrote last, like core's folders count. + * + * Every member's count comes from one query, kept until something changes them; agents who may only see what's + * assigned to them get theirs counted, and kept, on its own. + * + * @param Mailbox $mailbox Mailbox. + * @param User $user The agent. + * @return int + */ + public function active_count( Mailbox $mailbox, User $user ): int { + if ( $user->canSeeOnlyAssignedConversations() ) { + return (int) \Cache::remember( + $this->counts_key( (int) $mailbox->id, (int) $user->id ), + now()->addMinutes( self::COUNTS_MINUTES ), + function () use ( $mailbox, $user ): int { + return $this->conversations( $mailbox, $user ) + ->where( 'conversations.status', Conversation::STATUS_ACTIVE ) + ->addWhereExistsQuery( self::threads( Thread::TYPE_MESSAGE )->where( 'threads.created_by_user_id', $user->id ) ) + ->count(); + } + ); + } + + $counts = \Cache::remember( + $this->counts_key( (int) $mailbox->id ), + now()->addMinutes( self::COUNTS_MINUTES ), + function () use ( $mailbox ): array { + return $this->conversations( $mailbox ) + ->where( 'conversations.status', Conversation::STATUS_ACTIVE ) + ->join( 'threads', 'threads.conversation_id', '=', 'conversations.id' ) + ->where( 'threads.type', Thread::TYPE_MESSAGE ) + ->where( 'threads.state', Thread::STATE_PUBLISHED ) + ->whereNotNull( 'threads.created_by_user_id' ) + ->groupBy( 'threads.created_by_user_id' ) + ->toBase() + ->selectRaw( 'threads.created_by_user_id as user_id, count(distinct conversations.id) as total' ) + ->pluck( 'total', 'user_id' ) + ->map( + static function ( mixed $total ): int { + return (int) $total; + } + ) + ->all(); + } + ); + + return (int) ( $counts[ (int) $user->id ] ?? 0 ); + } + + /** + * Forgets the worklists' counts of a mailbox, after something that may change them. + * + * @param int $mailbox_id Mailbox ID. + * @return void + */ + public static function forget_counts( int $mailbox_id ): void { + try { + \Cache::forever( self::version_key( $mailbox_id ), uniqid( '', true ) ); + } catch ( \Throwable $e ) { + \Log::error( '[WPOrgPluginReview] Could not forget the worklists\' counts of mailbox ' . $mailbox_id . ': ' . $e->getMessage() ); + } + } + + /** + * Where the members' counts of a mailbox are kept, or an agent's own; forgetting them moves them to new keys. + * + * @param int $mailbox_id Mailbox ID. + * @param int|null $user_id The agent, if they're counted on their own. + * @return string + */ + private function counts_key( int $mailbox_id, ?int $user_id = null ): string { + $key = 'wporgpluginreview.worklist.' . $this->key . '.active_counts.' . $mailbox_id . '.' . \Cache::get( self::version_key( $mailbox_id ), '' ); + + return null === $user_id ? $key : $key . '.' . $user_id; + } + + /** + * Where the version of a mailbox's counts is kept. + * + * @param int $mailbox_id Mailbox ID. + * @return string + */ + private static function version_key( int $mailbox_id ): string { + return 'wporgpluginreview.worklist.counts_version.' . $mailbox_id; + } + + /** + * The members whose conversations can be shown: the mailbox's users who are members of the plugins team's teams. + * + * @param Mailbox $mailbox Mailbox. + * @return Collection Users, by name. + */ + public static function reviewers( Mailbox $mailbox ): Collection { + $reviewers = app( Reviewers::class ); + + // The Teams module adds its teams to the list, as users who aren't active. + return collect( $mailbox->usersHavingAccess( true ) ) + ->filter( + static function ( mixed $user ) use ( $reviewers ): bool { + return $user instanceof User && $user->isActive() && $reviewers->includes( $user ); + } + ) + ->values(); + } + + /** + * A member's conversations, by section. + * + * @param Mailbox $mailbox Mailbox. + * @param User $user The member. + * @param User $viewer Who's looking: they only see the conversations they may. + * @return array Conversations by section, the longest waiting first. + */ + public function sections( Mailbox $mailbox, User $user, User $viewer ): array { + return self::load( $this->section_ids( $mailbox, $user, $viewer, self::reviewers( $mailbox ) ) ); + } + + /** + * The IDs of a member's conversations, by section. + * + * A conversation needs someone when a note says so, or when no member replied to it yet: none of the mailbox's + * users who are members of the plugins team's teams, as they are now. + * + * @param Mailbox $mailbox Mailbox. + * @param User $user The member. + * @param User $viewer Who's looking: they only see the conversations they may. + * @param Collection $reviewers The members, as reviewers() tells them. + * @return array Conversation IDs by section, the longest waiting first. + */ + public function section_ids( Mailbox $mailbox, User $user, User $viewer, Collection $reviewers ): array { + $member_ids = $reviewers->pluck( 'id' )->all(); + + $rows = $this->conversations( $mailbox, $viewer ) + ->select( 'conversations.id' ) + ->selectSub( self::threads( Thread::TYPE_MESSAGE )->where( 'threads.created_by_user_id', $user->id ), 'participating' ) + ->selectSub( self::threads( Thread::TYPE_NOTE )->where( 'threads.body', 'like', '%' . self::mention( $user ) . '%' ), 'mentioned' ) + ->selectSub( self::threads( Thread::TYPE_NOTE )->where( 'threads.body', 'like', '%' . self::NEEDS_MARKER . '%' ), 'needs' ) + ->selectSub( self::threads( Thread::TYPE_MESSAGE )->whereIn( 'threads.created_by_user_id', $member_ids ), 'answered' ) + ->orderBy( 'conversations.last_reply_at' ) + ->orderBy( 'conversations.id' ) + ->toBase() + ->get(); + + $ids = array_fill_keys( self::SECTIONS, array() ); + foreach ( $rows as $row ) { + $row->needs = $row->needs || ! $row->answered; + + foreach ( self::SECTIONS as $section ) { + if ( $row->$section ) { + $ids[ $section ][] = (int) $row->id; + break; + } + } + } + + return $ids; + } + + /** + * The tags of conversations, to filter them by, with the Tags module. + * + * @param array $ids Conversation IDs by section. + * @param int $selected The tag filtered by, if any, which is listed even when none of the + * conversations have it anymore. + * @return array By tag ID, by name. + */ + public static function tags( array $ids, int $selected = 0 ): array { + $all = array_merge( ...array_values( $ids ) ); + if ( ! self::has_tags() ) { + return array(); + } + + try { + $tags = array(); + if ( $all ) { + $rows = \DB::table( 'conversation_tag' ) + ->join( 'tags', 'tags.id', '=', 'conversation_tag.tag_id' ) + ->whereIn( 'conversation_tag.conversation_id', $all ) + ->groupBy( 'tags.id', 'tags.name' ) + ->select( 'tags.id', 'tags.name' ) + ->selectRaw( 'count(*) as total' ) + ->get(); + + foreach ( $rows as $row ) { + $tags[ (int) $row->id ] = array( + 'name' => (string) $row->name, + 'count' => (int) $row->total, + ); + } + } + + if ( $selected && ! isset( $tags[ $selected ] ) ) { + $name = \DB::table( 'tags' )->where( 'id', $selected )->value( 'name' ); + if ( null !== $name ) { + $tags[ $selected ] = array( + 'name' => (string) $name, + 'count' => 0, + ); + } + } + + uasort( + $tags, + static function ( array $a, array $b ): int { + return strnatcasecmp( $a['name'], $b['name'] ); + } + ); + + return $tags; + } catch ( \Throwable $e ) { + \Log::error( '[WPOrgPluginReview] Could not read the tags to filter by: ' . $e->getMessage() ); + + return array(); + } + } + + /** + * Keeps the conversations with a tag. + * + * @param array $ids Conversation IDs by section. + * @param int $tag_id Tag ID. + * @return array + */ + public static function filter_by_tag( array $ids, int $tag_id ): array { + $all = array_merge( ...array_values( $ids ) ); + $tagged = $all + ? array_flip( + \DB::table( 'conversation_tag' ) + ->where( 'tag_id', $tag_id ) + ->whereIn( 'conversation_id', $all ) + ->pluck( 'conversation_id' ) + ->map( + static function ( mixed $id ): int { + return (int) $id; + } + ) + ->all() + ) + : array(); + + return array_map( + static function ( array $section ) use ( $tagged ): array { + return array_values( + array_filter( + $section, + static function ( int $id ) use ( $tagged ): bool { + return isset( $tagged[ $id ] ); + } + ) + ); + }, + $ids + ); + } + + /** + * Loads conversations by section, with what conversation lists show of them. + * + * @param array $ids Conversation IDs by section. + * @return array + */ + public static function load( array $ids ): array { + $all = array_merge( ...array_values( $ids ) ); + if ( ! $all ) { + return $ids; + } + + $conversations = self::preload( Conversation::whereIn( 'id', $all )->with( 'customer' )->get() )->keyBy( 'id' ); + + return array_map( + static function ( array $section ) use ( $conversations ): array { + return array_values( array_filter( array_map( array( $conversations, 'get' ), $section ) ) ); + }, + $ids + ); + } + + /** + * Whether there are tags to filter by: the Tags module is on, and its tables are there. + * + * @return bool + */ + public static function has_tags(): bool { + try { + return \App\Module::isActive( 'tags' ) && \Schema::hasTable( 'tags' ) && \Schema::hasTable( 'conversation_tag' ); + } catch ( \Throwable $e ) { + return false; + } + } + + /** + * Lets modules load what they show in conversation lists for all the conversations at once, like the Tags module + * their tags, as core's lists do. + * + * @param Collection $conversations Conversations. + * @return Collection + */ + private static function preload( Collection $conversations ): Collection { + try { + $preloaded = \Eventy::filter( 'conversations_table.preload_table_data', $conversations ); + + return $preloaded instanceof Collection ? $preloaded : $conversations; + } catch ( \Throwable $e ) { + \Log::error( '[WPOrgPluginReview] Could not preload the worklist\'s conversations: ' . $e->getMessage() ); + + return $conversations; + } + } + + /** + * The team's open and pending conversations in the mailbox, or, without the Teams module, the mailbox's. + * + * @param Mailbox $mailbox Mailbox. + * @param User|null $viewer Who's looking, if they only see the conversations they may. + * @return Builder + */ + private function conversations( Mailbox $mailbox, ?User $viewer = null ): Builder { + $query = Conversation::query() + ->where( 'conversations.mailbox_id', $mailbox->id ) + ->where( 'conversations.state', Conversation::STATE_PUBLISHED ) + ->whereIn( 'conversations.status', array( Conversation::STATUS_ACTIVE, Conversation::STATUS_PENDING ) ); + + $team_id = app( Reviewers::class )->team_id( $this->team ); + if ( null !== $team_id ) { + $query->where( 'conversations.user_id', $team_id ); + } + + // Like core's folders, for users who may only see what's assigned to them; Teams adds their teams' conversations. + if ( $viewer && $viewer->canSeeOnlyAssignedConversations() && ! \Eventy::filter( 'folder.only_assigned_condition', false, $query, (int) $viewer->id ) ) { + $query->where( 'conversations.user_id', $viewer->id ); + } + + return $query; + } + + /** + * Whether a conversation has a published thread of a type, to narrow down. + * + * @param int $type Thread type. + * @return QueryBuilder + */ + private static function threads( int $type ): QueryBuilder { + return \DB::table( 'threads' ) + ->selectRaw( '1' ) + ->whereColumn( 'threads.conversation_id', 'conversations.id' ) + ->where( 'threads.type', $type ) + ->where( 'threads.state', Thread::STATE_PUBLISHED ) + ->limit( 1 ); + } + + /** + * How the Mentions module marks a user up in a note. + * + * @param User $user User. + * @return string + */ + private static function mention( User $user ): string { + return 'data-mentioned-id="' . (int) $user->id . '"'; + } +} diff --git a/freescout.wordpress.net/Modules/WPOrgPluginReview/module.json b/freescout.wordpress.net/Modules/WPOrgPluginReview/module.json index fec79c243e..22911f8fab 100644 --- a/freescout.wordpress.net/Modules/WPOrgPluginReview/module.json +++ b/freescout.wordpress.net/Modules/WPOrgPluginReview/module.json @@ -2,8 +2,8 @@ "name": "WP.org Plugin Review", "alias": "wporgpluginreview", "img": "/modules/wporgpluginreview/img/icon.svg", - "description": "Shows the latest plugin review of a conversation in its sidebar: its details, flags, and issues, from the review emails' Review ID lines.", - "version": "1.0.0", + "description": "Shows the latest plugin review of a conversation in its sidebar: its details, flags, and issues, from the review emails' Review ID lines. Adds My Reviews and My Cases folders of the reviews and cases an agent replied to, is mentioned in, or that need someone, and a header button that copies the download URLs of the plugins in review they have open.", + "version": "1.0.1", "detailsUrl": "https://github.com/WordPress/wordpress.org/tree/trunk/freescout.wordpress.net/Modules/WPOrgPluginReview", "author": "WordPress.org", "authorUrl": "https://wordpress.org/", diff --git a/freescout.wordpress.net/Modules/WPOrgPluginReview/tests/DownloadsTest.php b/freescout.wordpress.net/Modules/WPOrgPluginReview/tests/DownloadsTest.php new file mode 100644 index 0000000000..8c34a19391 --- /dev/null +++ b/freescout.wordpress.net/Modules/WPOrgPluginReview/tests/DownloadsTest.php @@ -0,0 +1,103 @@ +app->register( WPOrgPluginReviewServiceProvider::class ); + } + + /** + * Clears the modules' cache, which outlives the test's database. + * + * @return void + */ + protected function tearDown(): void { + \App\Module::clearModulesCache(); + + parent::tearDown(); + } + + /** + * Members of the plugins team's teams get the button, hidden until there are URLs, and its script. + * + * @return void + */ + public function test_reviewers_get_the_button(): void { + $this->actingAs( $this->create_user() ); + + $html = $this->header(); + + $this->assertStringContainsString( 'assertStringContainsString( 'class="wporg-downloads-copy"', $html ); + $this->assertStringContainsString( 'class="wporg-downloads-clear"', $html ); + $this->assertStringContainsString( 'Copy :count URLs', html_entity_decode( $html ) ); + + $scripts = implode( ' ', (array) \Eventy::filter( 'javascripts', array() ) ); + $this->assertStringContainsString( '/js/downloads.js', $scripts ); + } + + /** + * Members of other teams don't. + * + * @return void + */ + public function test_others_dont(): void { + $this->actingAs( $this->create_user() ); + + \App\Module::clearModulesCache(); + \App\Module::setActive( Reviewers::TEAMS_MODULE, true ); + \App\Module::clearModulesCache(); + $this->app->instance( + Reviewers::class, + new class() extends Reviewers { + /** + * The names of the teams a user is a member of. + * + * @param User $user User. + * @return string[] + */ + protected function team_names( User $user ): array { + return array( 'Themes' ); + } + } + ); + + $this->assertSame( '', $this->header() ); + } + + /** + * What the module adds to the header's menu. + * + * @return string + */ + private function header(): string { + ob_start(); + \Eventy::action( 'menu.append' ); + + return trim( (string) ob_get_clean() ); + } +} diff --git a/freescout.wordpress.net/Modules/WPOrgPluginReview/tests/MarkedSubjectsTest.php b/freescout.wordpress.net/Modules/WPOrgPluginReview/tests/MarkedSubjectsTest.php new file mode 100644 index 0000000000..88760f0acb --- /dev/null +++ b/freescout.wordpress.net/Modules/WPOrgPluginReview/tests/MarkedSubjectsTest.php @@ -0,0 +1,161 @@ +app->register( WPOrgPluginReviewServiceProvider::class ); + + $this->mailbox = $this->create_mailbox( 'Plugins', 'plugins@wordpress.test' ); + $this->sender = $this->create_sender(); + $this->actingAs( $this->create_user() ); + } + + /** + * The conversation tells its script its subjects, for its title, and the marked subjects of the sender's others in + * the mailbox, for the sidebar, escaped. + * + * @return void + */ + public function test_conversation_has_its_subjects_and_its_previous_ones(): void { + $conversation = $this->conversation( '[WordPress Plugin Directory] Review in Progress: My ' ); + $rejection = $this->conversation( 'Re: [WordPress Plugin Directory] Rejection Explanation: Old Plugin' ); + $this->conversation( 'Question about my plugin' ); + $elsewhere = $this->conversation( '[WordPress Plugin Directory] Notice: Other Plugin', $this->create_mailbox( 'Themes', 'themes@wordpress.test' ) ); + + $html = $this->subjects( $conversation ); + + $this->assertStringContainsString( 'data-number="' . $conversation->number . '"', $html ); + $this->assertStringContainsString( 'data-subject="[WordPress Plugin Directory] Review in Progress: My <Plugin>"', $html ); + $this->assertStringContainsString( 'data-short-subject="๐ My <Plugin>"', $html ); + $this->assertStringNotContainsString( '', $html ); + + $this->assertTrue( (bool) preg_match( '/data-subjects="([^"]*)"/', $html, $matches ) ); + $this->assertSame( + array( + $conversation->id => array( + 'subject' => '[WordPress Plugin Directory] Review in Progress: My ', + 'marked' => '๐ My ', + ), + $rejection->id => array( + 'subject' => 'Re: [WordPress Plugin Directory] Rejection Explanation: Old Plugin', + 'marked' => '๐๐ซ Old Plugin', + ), + ), + json_decode( html_entity_decode( $matches[1] ), true ) + ); + + $this->assertSame( '', $this->subjects( $elsewhere ) ); + } + + /** + * A conversation without a marked subject still gets its title shortened, with nothing for the sidebar. + * + * @return void + */ + public function test_conversation_without_a_marked_subject(): void { + $html = $this->subjects( $this->conversation( 'Question about my plugin' ) ); + + $this->assertStringContainsString( 'data-short-subject=""', $html ); + $this->assertStringContainsString( 'data-subjects="{}"', $html ); + } + + /** + * Lists show a marked subject, with the subject itself hidden after it, on hover, and for copying; other subjects, + * and other mailboxes', as they are. + * + * @return void + */ + public function test_lists_mark_subjects(): void { + $this->assertSame( + '๐๐ก๏ธ My <Plugin>Re: [WordPress Plugin Directory] Security Notice: My <Plugin>', + $this->row( $this->conversation( 'Re: [WordPress Plugin Directory] Security Notice: My ' ) ) + ); + $this->assertSame( 'Question about my plugin', $this->row( $this->conversation( 'Question about my plugin' ) ) ); + $this->assertSame( + '[WordPress Plugin Directory] Notice: My Plugin', + $this->row( $this->conversation( '[WordPress Plugin Directory] Notice: My Plugin', $this->create_mailbox( 'Themes', 'themes@wordpress.test' ) ) ) + ); + } + + /** + * Creates a conversation from the sender. + * + * @param string $subject Subject. + * @param Mailbox|null $mailbox Mailbox; the plugins team's if null. + * @return Conversation + */ + private function conversation( string $subject, ?Mailbox $mailbox = null ): Conversation { + $conversation = $this->create_conversation( $mailbox ?? $this->mailbox, $this->sender ); + $conversation->update( array( 'subject' => $subject ) ); + + return $conversation; + } + + /** + * Renders what the module adds after a conversation's subject. + * + * @param Conversation $conversation Conversation. + * @return string + */ + private function subjects( Conversation $conversation ): string { + ob_start(); + \Eventy::action( 'conversation.after_subject', $conversation, $conversation->mailbox ); + + return trim( (string) ob_get_clean() ); + } + + /** + * Renders a conversation's subject in a list, as core does between its hooks. + * + * @param Conversation $conversation Conversation. + * @return string + */ + private function row( Conversation $conversation ): string { + ob_start(); + \Eventy::action( 'conversations_table.before_subject', $conversation ); + echo e( $conversation->getSubject() ); + \Eventy::action( 'conversations_table.after_subject', $conversation ); + + return (string) ob_get_clean(); + } +} diff --git a/freescout.wordpress.net/Modules/WPOrgPluginReview/tests/OpenOrderTest.php b/freescout.wordpress.net/Modules/WPOrgPluginReview/tests/OpenOrderTest.php new file mode 100644 index 0000000000..21637ba832 --- /dev/null +++ b/freescout.wordpress.net/Modules/WPOrgPluginReview/tests/OpenOrderTest.php @@ -0,0 +1,291 @@ +app->register( WPOrgPluginReviewServiceProvider::class ); + $this->app['router']->getRoutes()->refreshNameLookups(); + + $this->mailbox = $this->create_mailbox( 'Plugins', 'plugins@wordpress.test' ); + $this->reviewer = $this->create_user(); + } + + /** + * Clears the modules' cache, which outlives the test's database. + * + * @return void + */ + protected function tearDown(): void { + \App\Module::clearModulesCache(); + + parent::tearDown(); + } + + /** + * Waits grow with the team's replies, as WAIT_DAYS has them, and with tags. + * + * @return void + */ + public function test_wait_days(): void { + $expected = array( + 0 => 0, + 1 => 1, + 2 => 1, + 3 => 2, + 4 => 2, + 5 => 4, + 6 => 4, + 7 => 5, + 8 => 5, + 9 => 6, + 10 => 6, + 11 => 8, + 40 => 8, + ); + foreach ( $expected as $replies => $days ) { + $this->assertSame( $days, OpenOrder::wait_days( $replies, array() ), $replies . ' replies' ); + } + + $this->assertSame( 5, OpenOrder::wait_days( 1, array( 'Sockpuppeting', 'guidelines' ) ) ); + $this->assertSame( 4, OpenOrder::wait_days( 0, array( 'sockpuppet' ) ) ); + } + + /** + * Oldest first opens the active conversations that waited at least 12 hours, the longest waiting first, up to the + * limit. + * + * @return void + */ + public function test_oldest_first(): void { + $day = $this->conversation( 1, 24 ); + $fresh = $this->conversation( 1, 11 ); + $half_day = $this->conversation( 1, 12 ); + $week = $this->conversation( 9, 168 ); + $pending = $this->conversation( 1, 300, Conversation::STATUS_PENDING ); + + $all = array( $day, $fresh, $half_day, $week, $pending ); + + $this->assertSame( $this->ids( $week, $day, $half_day ), OpenOrder::oldest_first( $all, 25 ) ); + $this->assertSame( $this->ids( $week, $day ), OpenOrder::oldest_first( $all, 2 ) ); + $this->assertNotContains( (int) $fresh->id, OpenOrder::oldest_first( $all, 25 ) ); + } + + /** + * By progress, each conversation waits as long as the team's replies make it, and those that waited longest beyond + * that go first; the first email counts when the team wrote it, and notes don't. + * + * @return void + */ + public function test_progress_based(): void { + $recipe = $this->conversation( 7, 216 ); + $badges = $this->conversation( 5, 148 ); + $table = $this->conversation( 2, 74 ); + $membership = $this->conversation( 11, 240 ); + $colors = $this->conversation( 6, 72 ); + $gallery = $this->conversation( 1, 38 ); + $contact = $this->conversation( 1, 20 ); + $started = $this->conversation( 0, 13, Conversation::STATUS_ACTIVE, true ); + $noted = $this->conversation( 2, 30, Conversation::STATUS_ACTIVE, false, 9 ); + + $all = array( $recipe, $badges, $table, $membership, $colors, $gallery, $contact, $started, $noted ); + + // 96, 52, 50, 48, 14, 13, and 6 hours beyond their waits; the colors wait 4 days yet, and the contact form one. + $this->assertSame( $this->ids( $recipe, $badges, $table, $membership, $gallery, $started, $noted ), OpenOrder::progress_based( $all, 25 ) ); + $this->assertSame( $this->ids( $recipe, $badges ), OpenOrder::progress_based( $all, 2 ) ); + } + + /** + * The team's first email counts as a reply when the team wrote it. + * + * @return void + */ + public function test_progress_based_counts_the_teams_first_email(): void { + $started = $this->conversation( 3, 60 ); + $answered = $this->conversation( 2, 59, Conversation::STATUS_ACTIVE, true ); + + // Three replies wait 2 days, 12 hours beyond; two wait a day, 35 hours beyond. + $this->assertSame( $this->ids( $answered, $started ), OpenOrder::progress_based( array( $started, $answered ), 25 ) ); + } + + /** + * Tags like sockpuppeting add to the wait, with the Tags module. + * + * @return void + */ + public function test_progress_based_waits_longer_for_tags(): void { + $sockpuppets = $this->conversation( 1, 145 ); + $other = $this->conversation( 1, 100 ); + + $tag_id = (int) \DB::table( 'tags' )->insertGetId( array( 'name' => 'sockpuppeting' ) ); + \DB::table( 'conversation_tag' )->insert( + array( + 'conversation_id' => $sockpuppets->id, + 'tag_id' => $tag_id, + ) + ); + + $this->assertSame( $this->ids( $sockpuppets, $other ), OpenOrder::progress_based( array( $sockpuppets, $other ), 25 ) ); + + \App\Module::clearModulesCache(); + \App\Module::setActive( 'tags', true ); + \App\Module::clearModulesCache(); + + // 145 - 120 hours is 25 beyond, and 100 - 24 is 76. + $this->assertSame( $this->ids( $other, $sockpuppets ), OpenOrder::progress_based( array( $sockpuppets, $other ), 25 ) ); + } + + /** + * How many open at a time is 25, unless the agent chose otherwise, from 1 to 100. + * + * @return void + */ + public function test_limit(): void { + $this->assertSame( OpenOrder::DEFAULT_LIMIT, OpenOrder::limit( $this->reviewer ) ); + + OpenOrder::set_limit( $this->reviewer, '40' ); + $this->assertSame( 40, OpenOrder::limit( $this->reviewer ) ); + + OpenOrder::set_limit( $this->reviewer, '500' ); + $this->assertSame( OpenOrder::MAX_LIMIT, OpenOrder::limit( $this->reviewer ) ); + + OpenOrder::set_limit( $this->reviewer, '0' ); + $this->assertSame( 1, OpenOrder::limit( $this->reviewer ) ); + + OpenOrder::set_limit( $this->reviewer, '' ); + $this->assertSame( OpenOrder::DEFAULT_LIMIT, OpenOrder::limit( $this->reviewer ) ); + $this->assertFalse( \Option::get( 'wporgpluginreview.open_limit.' . $this->reviewer->id, false, true, false ) ); + } + + /** + * Reviewers' profiles have the field, which saves with the profile. + * + * @return void + */ + public function test_profile_field(): void { + OpenOrder::set_limit( $this->reviewer, 30 ); + + ob_start(); + \Eventy::action( 'user.edit.before_photo', $this->reviewer ); + $html = (string) ob_get_clean(); + + $this->assertStringContainsString( 'name="wporgpluginreview_open_limit" value="30"', $html ); + + $request = Request::create( '/', 'POST', array( 'wporgpluginreview_open_limit' => '12' ) ); + $this->assertSame( $this->reviewer, \Eventy::filter( 'user.save_profile', $this->reviewer, $request ) ); + $this->assertSame( 12, OpenOrder::limit( $this->reviewer ) ); + } + + /** + * The participating section has the buttons, with the conversations each opens, in order, and how many. + * + * @return void + */ + public function test_page_has_the_buttons(): void { + $day = $this->conversation( 1, 24 ); + $week = $this->conversation( 9, 168 ); + OpenOrder::set_limit( $this->reviewer, 10 ); + + $html = $this->actingAs( $this->reviewer )->get( Worklist::reviews()->url( (int) $this->mailbox->id ) )->getContent(); + + // The week-old one has to wait 6 days for its 9 replies, and the day-old one 1 for its one. + $this->assertStringContainsString( 'data-conversations="' . $week->id . ',' . $day->id . '"', $html ); + $this->assertStringContainsString( 'Open Oldest First', $html ); + $this->assertStringContainsString( 'Open Progress Based', $html ); + $this->assertStringContainsString( 'Up to 10 at a time', $html ); + } + + /** + * Creates an active conversation the reviewer replied to, assigned to nobody, which without the Teams module is + * in their reviews: the team writes first, unless the sender did, and the sender answers every email. + * + * @param int $replies The team's replies. + * @param int $hours Hours since the sender's latest reply. + * @param int $status Status. + * @param bool $sender_first Whether the sender wrote first, so the team's first email is a reply to them. + * @param int $notes Notes the team added too, which don't count. + * @return Conversation + */ + private function conversation( int $replies, int $hours, int $status = Conversation::STATUS_ACTIVE, bool $sender_first = false, int $notes = 0 ): Conversation { + $conversation = $this->create_conversation( $this->mailbox, $this->create_sender() ); + $at = '2026-01-01 10:00:00'; + + if ( $sender_first || ! $replies ) { + $this->create_thread( $conversation, Thread::TYPE_CUSTOMER, 'My plugin.', null, $at ); + } + for ( $n = 0; $n < $replies; $n++ ) { + $this->create_thread( $conversation, Thread::TYPE_MESSAGE, 'Review.', $this->reviewer, $at ); + $this->create_thread( $conversation, Thread::TYPE_CUSTOMER, 'Updated.', null, $at ); + } + for ( $n = 0; $n < $notes; $n++ ) { + $this->create_thread( $conversation, Thread::TYPE_NOTE, 'Note.', $this->reviewer, $at ); + } + + $conversation->status = $status; + $conversation->last_reply_at = Carbon::now()->subHours( $hours ); + $conversation->save(); + + return $conversation; + } + + /** + * Conversations' IDs. + * + * @param Conversation ...$conversations Conversations. + * @return int[] + */ + private function ids( Conversation ...$conversations ): array { + return array_map( + static function ( Conversation $conversation ): int { + return (int) $conversation->id; + }, + $conversations + ); + } +} diff --git a/freescout.wordpress.net/Modules/WPOrgPluginReview/tests/PanelTest.php b/freescout.wordpress.net/Modules/WPOrgPluginReview/tests/PanelTest.php index 469f8dc58f..7573951eda 100644 --- a/freescout.wordpress.net/Modules/WPOrgPluginReview/tests/PanelTest.php +++ b/freescout.wordpress.net/Modules/WPOrgPluginReview/tests/PanelTest.php @@ -76,7 +76,6 @@ public function test_no_panel_without_a_review(): void { * @return void */ public function test_panel_shows_the_latest_review(): void { - $this->conversation->update( array( 'subject' => '[WordPress Plugin Directory] Review in Progress: My ' ) ); $this->review( 'Plugin URI: https://example.org/p๐ด Use wp_enqueue <script> commandsReview ID: R โOWN my-plugin/jane/1Aug26/T2 8Aug26/4.3 (P0TDX42HGN)' ); $html = $this->panel(); @@ -86,8 +85,6 @@ public function test_panel_shows_the_latest_review(): void { $this->assertStringContainsString( 'https://profiles.wordpress.org/jane/', $html ); $this->assertStringContainsString( 'data-flags="UPD OWN"', $html ); $this->assertStringContainsString( 'data-username="jane"', $html ); - $this->assertStringContainsString( 'data-short-subject="R: My <Plugin>"', $html ); - $this->assertStringContainsString( 'wporg-review-title-toggle', $html ); $this->assertStringContainsString( 'data-title="Use wp_enqueue <script> commands"', $html ); $this->assertStringNotContainsString( '
{{ $review['names']['suggested_slug'] }}
{{ $names['suggested_slug'] }}
{{ __( 'How many conversations the Open buttons of My Reviews and My Cases open in new tabs at a time, up to :max.', array( 'max' => $max ) ) }}
{{ $descriptions[ $section ] }}
+ @if ( ! $conversation->isActive() ){{ $conversation->getStatusName() }}@endif + @action('conversations_table.before_subject', $conversation){{ $conversation->getSubject() }}@action('conversations_table.after_subject', $conversation) +
{{ $conversation->preview }}
{{ $list->empty_text() }}
My plugin.
Review.
Updated.
Note.
Review ID: R โOWN my-plugin/jane/1Aug26/T2 8Aug26/4.3 (P0TDX42HGN)