Changeset 12584

Timestamp:

05/12/2023 08:05:57 AM (3 years ago)

Author:

amieiro

Message:

Copy the TM to the tab in the right sidebar

• Copy the TM to the tab in the right sidebar.
• Avoid making same request to the OpenAI and DeepL APIs

a few times in the same translation.

File:

• sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-gp-translation-suggestions/js/translation-suggestions.js (modified) (8 diffs)

sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-gp-translation-suggestions/js/translation-suggestions.js

@@ -1 +1 @@
 ( function( $ ){
+        /**
+         * Stores the originalId of the translations for which OpenAI has already been queried,
+         * to avoid making the query another time.
+         *
+         * @type {array}
+         */
+        var OpenAITMSuggestionRequested = [];
+
+        /**
+         * Stores the originalId of the translations for which DeepL has already been queried,
+         * to avoid making the query another time.
+         *
+         * @type {array}
+         */
+        var DeeplTMSuggestionRequested = [];
+
         function fetchSuggestions( $container, apiUrl, originalId, translationId, nonce ) {
                 var xhr = $.ajax( {
@@ -16 +32 @@
                         if ( response.success ) {
                                 $container.append( response.data );
+                                removeNoSuggestionsMessage( $container );
+                                copyTranslationMemoryToSidebarTab();
                         } else {
                                 $container.append( $( '<span/>', { 'text': 'Error while loading suggestions.' } ) );
@@ -30 +48 @@
                 xhr.always( function() {
                         $container.removeClass( 'fetching' );
-                        removeNoSuggestionsMessage( $container );
-                } );
+                } );
+        }
+
+        /**
+         * Copies the translation memory to the sidebar tab and adds the number of items in the TM to the tab.
+         *
+         * @return {void}
+         */
+        function copyTranslationMemoryToSidebarTab(){
+            var divSidebarWithTM = $gp.editor.current.find( '.meta.translation-memory' ).first();
+                var divId = divSidebarWithTM.attr( 'data-row-id' );
+                var TMcontainer = $gp.editor.current.find( '.suggestions__translation-memory' );
+                if ( !TMcontainer.length ) {
+                        return;
+                }
+                if ( !TMcontainer.hasClass( 'initialized' ) ) {
+                        return;
+                }
+
+                var itemsInTM = TMcontainer.find( '.translation-suggestion.with-tooltip.translation' ).length;
+                itemsInTM += TMcontainer.find( '.translation-suggestion.with-tooltip.deepl' ).length;
+                itemsInTM += TMcontainer.find( '.translation-suggestion.with-tooltip.openai' ).length;
+                $( '[data-tab="sidebar-tab-translation-memory-' + divId + '"]' ).html( 'TM&nbsp;(' + itemsInTM + ')' );
+                $( '#sidebar-div-translation-memory-' + divId ).html( TMcontainer.html() );
         }
 
@@ -71 +111 @@
                 }
 
+                if ( !$gp.editor.current.find('translation-suggestion.with-tooltip.translation').first() ) {
+                        return;
+                }
+
                 $container.addClass( 'fetching' );
 
@@ -86 +130 @@
          **/
         function maybeFetchOpenAISuggestions() {
-                maybeFetchExternalSuggestions( gpTranslationSuggestions.get_external_translations.get_openai_translations, window.WPORG_TRANSLATION_MEMORY_OPENAI_API_URL );
+                maybeFetchExternalSuggestions( 'OpenAI', gpTranslationSuggestions.get_external_translations.get_openai_translations, window.WPORG_TRANSLATION_MEMORY_OPENAI_API_URL );
         }
 
@@ -95 +139 @@
          **/
         function maybeFetchDeeplSuggestions() {
-                maybeFetchExternalSuggestions( gpTranslationSuggestions.get_external_translations.get_deepl_translations, window.WPORG_TRANSLATION_MEMORY_DEEPL_API_URL );
+                maybeFetchExternalSuggestions( 'DeepL', gpTranslationSuggestions.get_external_translations.get_deepl_translations, window.WPORG_TRANSLATION_MEMORY_DEEPL_API_URL );
         }
 
@@ -101 +145 @@
          * Gets the suggestions from an external service.
          *
-         * @param getExternalSuggestions
-         * @param apiUrl
-         */
-        function maybeFetchExternalSuggestions( getExternalSuggestions, apiUrl ) {
+         * @param type                                   The type of the external service: OpenAI or DeepL.
+         * @param getExternalSuggestions Whether to get the suggestions from the external service.
+         * @param apiUrl                                 The URL of the API.
+         *
+         * @return {void}
+         */
+        function maybeFetchExternalSuggestions( type, getExternalSuggestions, apiUrl ) {
                 var $container = $gp.editor.current.find( '.suggestions__translation-memory' );
                 if ( !$container.length ) {
@@ -112 +159 @@
                         return;
                 }
-
                 var originalId = $gp.editor.current.original_id;
                 var translationId = $gp.editor.current.translation_id;
                 var nonce = $container.data( 'nonce' );
 
+                if( true === wasRequestMade( type, originalId ) ) {
+                        return;
+                }
+
                 fetchSuggestions( $container, apiUrl, originalId, translationId, nonce );
+        }
+
+        /**
+         * Checks if the request was already made for this originalId and type.
+         *
+         * @param type            The type of the external service: OpenAI or DeepL.
+         * @param originalId  The original ID.
+         *
+         * @returns {boolean} Whether the request was already made.
+         */
+        function wasRequestMade( type, originalId ) {
+                if ('OpenAI' === type) {
+                        if ( originalId in OpenAITMSuggestionRequested ) {
+                                return true;
+                        } else {
+                                OpenAITMSuggestionRequested[originalId] = true;
+                        }
+                }
+                if ('DeepL' === type) {
+                        if ( originalId in DeeplTMSuggestionRequested ) {
+                                return true;
+                        } else {
+                                DeeplTMSuggestionRequested[originalId] = true;
+                        }
+                }
+                return false;
         }