[5.x] Enhance query preview when using the pgsql driver (#1486)

* Use the frameworks query grammar formatting when using laravel >= 10.x * Change highlighting based on sql dialect * Fix styleci and add an assertion for setting the driver name * Update Highligter.vue --------- Co-authored-by: Taylor Otwell <[email protected]>
laravel · Jun 17, 2024 · 1394592 · 1394592
1 parent 8e145db
commit 1394592
Show file tree

Hide file tree

Showing 9 changed files with 217 additions and 62 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -22,12 +22,12 @@
         "resolve-url-loader": "^5.0.0",
         "sass": "^1.15.2",
         "sass-loader": "^11.0.1",
-        "sql-formatter": "^3.1.0",
+        "sql-formatter": "^15.3.1",
         "vue": "^2.5.7",
+        "vue-copy-to-clipboard": "^1.0.3",
         "vue-json-pretty": "^1.6.2",
         "vue-loader": "^15.9.6",
         "vue-router": "^3.0.1",
-        "vue-template-compiler": "^2.5.21",
-        "vue-copy-to-clipboard": "^1.0.3"
+        "vue-template-compiler": "^2.5.21"
     }
 }
diff --git a/public/app.js b/public/app.js
diff --git a/public/mix-manifest.json b/public/mix-manifest.json
@@ -1,5 +1,5 @@
 {
-    "/app.js": "/app.js?id=7049e92a398e816f8cd53a915eaea592",
+    "/app.js": "/app.js?id=9a52c14de3847c3cc640ff1845ef3ed0",
     "/app-dark.css": "/app-dark.css?id=1ea407db56c5163ae29311f1f38eb7b9",
     "/app.css": "/app.css?id=de4c978567bfd90b38d186937dee5ccf"
 }
diff --git a/resources/js/app.js b/resources/js/app.js
@@ -42,6 +42,7 @@ Vue.component('index-screen', require('./components/IndexScreen.vue').default);
 Vue.component('preview-screen', require('./components/PreviewScreen.vue').default);
 Vue.component('alert', require('./components/Alert.vue').default);
 Vue.component('copy-clipboard', require('./components/CopyClipboard.vue').default);
+Vue.component('higlighter', require('./components/Highligter.vue').default);
 
 Vue.mixin(Base);
 

diff --git a/resources/js/components/Highligter.vue b/resources/js/components/Highligter.vue
@@ -0,0 +1,68 @@
+<script type="text/ecmascript-6">
+import hljs from 'highlight.js/lib/core';
+import sql from 'highlight.js/lib/languages/sql';
+import pgsql from 'highlight.js/lib/languages/pgsql'
+
+hljs.registerLanguage('sql', sql)
+hljs.registerLanguage('pgsql', pgsql)
+
+function hasValueOrEmptyAttribute(value) {
+    return Boolean(value || value === "");
+}
+
+function escapeHTML(value) {
+    return value
+        .replace(/&/g, '&amp;')
+        .replace(/</g, '&lt;')
+        .replace(/>/g, '&gt;')
+        .replace(/"/g, '&quot;')
+        .replace(/'/g, '&#x27;');
+}
+
+export default {
+    props: ["language", "code", "autodetect"],
+    data: function() {
+        return {
+            detectedLanguage: "",
+            unknownLanguage: false
+        };
+    },
+    computed: {
+        className() {
+            if (this.unknownLanguage) return "";
+
+            return "hljs " + this.detectedLanguage;
+        },
+    
+        highlighted() {
+            if (!this.autoDetect && !hljs.getLanguage(this.language)) {
+                console.warn(`The language "${this.language}" you specified could not be found.`);    
+                this.unknownLanguage = true;
+
+                return escapeHTML(this.code);
+            }
+
+            let result = {};
+    
+            if (this.autoDetect) {
+                result = hljs.highlightAuto(this.code);
+                this.detectedLanguage = result.language;
+            } else {
+                result = hljs.highlight(this.code, { language: this.language, ignoreIllegals: this.ignoreIllegals });
+                this.detectedLanguage = this.language;
+            }
+            return result.value;
+        },
+
+        autoDetect() {
+            return ! this.language || hasValueOrEmptyAttribute(this.autodetect);
+        },
+
+        ignoreIllegals() {
+            return true;
+        }
+    },
+
+    template: `<pre><code :class="className" v-html="highlighted"></code></pre>`
+};
+</script>
diff --git a/resources/js/screens/queries/preview.vue b/resources/js/screens/queries/preview.vue
@@ -1,26 +1,46 @@
 <script type="text/ecmascript-6">
-    import hljs from 'highlight.js/lib/core';
-    import sql from 'highlight.js/lib/languages/sql';
-    import { format } from 'sql-formatter';
-
-    hljs.registerLanguage('sql', sql);
+import { format } from 'sql-formatter';
 
     export default {
         methods: {
-            highlightSQL() {
-                this.$nextTick(() => {
-                    hljs.highlightElement(this.$refs.sqlcode);
-                });
+            formatSql(sql, language) {
+                return format(sql, { language: this.mapLanguage(language)});
+            },
+
+            mapLanguage(language) {
+                if (language === 'sql') {
+                    return language;
+                }
+
+                switch (language) {
+                    case 'pgsql':
+                        return 'postgresql';
+                    case 'mysql':
+                        return 'mysql';
+                    case 'mariadb':
+                        return 'mariadb'
+                    case 'sqlite':
+                        return 'sqlite'
+                    case 'sqlsrv':
+                        return 'transactsql'
+                }
             },
-            formatSql(sql) {
-                return format(sql);
+
+            mapHighlightingLanguage(language) {
+                if (language === 'sql') {
+                    return language;
+                } else if(language === 'sqlsrv') {
+                    return 'tsql';
+                }
+
+                return 'pgsql';
             }
         }
     }
 </script>
 
 <template>
-    <preview-screen title="Query Details" resource="queries" :id="$route.params.id" v-on:ready="highlightSQL()">
+    <preview-screen title="Query Details" resource="queries" :id="$route.params.id">
         <template slot="table-parameters" slot-scope="slotProps">
             <tr>
                 <td class="table-fit text-muted">Connection</td>
@@ -58,8 +78,10 @@
                     </li>
                 </ul>
                 <div class="code-bg p-4 mb-0 text-white">
-                    <copy-clipboard :data="formatSql(slotProps.entry.content.sql)">
-                      <pre class="code-bg text-white" ref="sqlcode">{{ formatSql(slotProps.entry.content.sql) }}</pre>
+                    <copy-clipboard  :data="formatSql(slotProps.entry.content.sql, slotProps?.entry?.content?.driver ?? 'sql')">
+                        <higlighter :code="formatSql(slotProps.entry.content.sql, slotProps.entry.content?.driver ?? 'sql')"
+                                    :language="mapHighlightingLanguage(slotProps.entry.content?.driver ?? 'sql')"
+                                    class="code-bg text-white class" />
                     </copy-clipboard>
                 </div>
             </div>

diff --git a/src/Watchers/QueryWatcher.php b/src/Watchers/QueryWatcher.php
@@ -45,6 +45,7 @@ public function recordQuery(QueryExecuted $event)
                 'file' => $caller['file'],
                 'line' => $caller['line'],
                 'hash' => $this->familyHash($event),
+                'driver' => $event->connection->getDriverName(),
             ])->tags($this->tags($event)));
         }
     }
@@ -90,6 +91,10 @@ protected function formatBindings($event)
      */
     public function replaceBindings($event)
     {
+        if (version_compare(app()->version(), '10.0.0', '>=')) {
+            return $event->connection->getQueryGrammar()->substituteBindingsIntoRawSql($event->sql, $event->bindings);
+        }
+
         $sql = $event->sql;
 
         foreach ($this->formatBindings($event) as $key => $binding) {