Feat: visual revamp (#156)

* delete debugger

* No need tooltip data as part of interactivity

* Fix coloring

* delete logging

* Fix messaging on interactivity for tooltip data

* Delete unused code

* Navbar and cursors

* Revamp viewer actions

* Hide viewer actions

* not a css master commit

* Toggle projection/orthi

* Remove console log

* Fix saved objects

* Remove console log

* Sort performance logging

* fix view mode cache

* Fix initial isolate issue

* Update README.md (#147)

* Update README.md

* Update README.md

* fix typo on conditions

* capabilities for object ids

* Revert isolating every setDataInput

* Fix selection issues

* Fix tooltip fckp

* Reset filters

* Fix reset filter

* Ghost hidden on filter

* Bring conditional formatting back

* Remove ghost hidden context from color card

* Disable shadow catcher

* Disable camera position persistence for performance reasons

* feat (data): sending version and branding info (#157)

* get version

* adds workspace info

* adds hideBranding

* adds workspace info

---------

Co-authored-by: Oğuzhan Koral <[email protected]>

* Enrich receive info from desktop service

* test

* fix path

* fix path again

* file version

* correct the version with assembly for file version

* sanitize tag

* Use version from receive info

* Fix clipped zoom extend

* Workspace name logo

* Add can hide branding logic

* Fix tooltip for toggle

* Fix capabilities for storing branding

* Tooltips

* Store is ortho in file

* Store camera position and target into file according to selected view

* Fix loading bar reactivity

* Update connector flow

* Fix ghost state

* Store is ghost in file

* Consider ghost value on reset filter

* More

* excludes rawencoding (#159)

* adds null check for personal (#158)

* Progress update and error handling

* Call pre get before

---------

Co-authored-by: Jonathon Broughton <[email protected]>
Co-authored-by: Dogukan Karatas <[email protected]>

Author: 3 people

.github/workflows/build_powerbi.yml

@@ -17,6 +17,11 @@ jobs:
         with:
           fetch-depth: 0
 
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v3
+        with:
+          python-version: "3.10"
+
       - name: Install GitVersion
         uses: gittools/actions/gitversion/[email protected]
         with:
@@ -26,6 +31,10 @@ jobs:
         id: gitversion
         uses: gittools/actions/gitversion/[email protected]
 
+      - name: Set connector version
+        run: |
+          python patch_version.py ${{steps.gitversion.outputs.AssemblySemVer}}
+
       - name: Setup MSBuild
         uses: microsoft/setup-msbuild@v2
 

README.md

@@ -32,7 +32,7 @@ This repo is home to our Power BI connector. The Speckle Server provides all the
 
 # Installation
 
-Speckle connector can be installed directly from [Manager for Speckle](https://speckle.systems/download/). Full instructions for [installation](https://speckle.guide/user/powerbi/installation.html) and [configuration](https://speckle.guide/user/powerbi/configuration.html) can be found on our docs.
+Speckle connector can be installed directly from the [connectors portal](https://app.speckle.systems/connectors/). Full instructions for [installation](https://speckle.guide/user/powerbi/installation.html) and [configuration](https://speckle.guide/user/powerbi/configuration.html) can be found on our docs.
 
 # Using 3D Visual
 

patch_version.py

@@ -0,0 +1,42 @@
+import re
+import sys
+import os
+
+
+def sanitize_version(tag):
+    """Extracts the first three numeric segments from a tag string, because PowerBI is..."""
+    parts = re.findall(r"\d+", tag)
+    return ".".join(parts[:3]) if len(parts) >= 3 else tag
+
+def patch_connector(tag):
+    """Patches the connector version within the data connector file"""
+    sanitized_tag = sanitize_version(tag)
+    pq_file = os.path.join(os.path.dirname(__file__), "src", "powerbi-data-connector", "Speckle.pq")
+
+    with open(pq_file, "r") as file:
+        lines = file.readlines()
+
+        for (index, line) in enumerate(lines):
+            if '[Version = "3.0.0"]' in line:
+                lines[index] = f'[Version = "{sanitized_tag}"]\n'
+                print(f"Patched connector version number in {pq_file}")
+                break
+
+        with open(pq_file, "w") as file:
+            file.writelines(lines)
+
+
+def main():
+    if len(sys.argv) < 2:
+        return
+
+    tag = sys.argv[1]
+    if not re.match(r"([0-9]+)\.([0-9]+)\.([0-9]+)", tag):
+        raise ValueError(f"Invalid tag provided: {tag}")
+
+    print(f"Patching version: {tag}")
+    patch_connector(tag)
+
+
+if __name__ == "__main__":
+    main()

src/powerbi-data-connector/Speckle.pq

@@ -58,12 +58,23 @@ shared Speckle.GetStructuredData = Value.ReplaceType(
     type function (url as Uri.Type) as table
 );
 
+shared Speckle.GetVersion = Value.ReplaceType(
+    Speckle.LoadFunction("GetVersion.pqm"),
+    type function () as text
+);
+
 [DataSource.Kind = "Speckle"]
 shared Speckle.SendToServer = Value.ReplaceType(
     Speckle.LoadFunction("SendToServer.pqm"),
     type function (url as Uri.Type) as table
 );
 
+[DataSource.Kind = "Speckle"]
+shared Speckle.GetWorkspace = Value.ReplaceType(
+    Speckle.LoadFunction("GetWorkspace.pqm"),
+    type function (url as Uri.Type) as record
+);
+
 [DataSource.Kind = "Speckle", Publish="GetByUrl.Publish"]
 shared Speckle.GetByUrl = Value.ReplaceType(
     Speckle.LoadFunction("GetByUrl.pqm"),

src/powerbi-data-connector/Speckle.query.pq

@@ -3,7 +3,7 @@
 // NOTE! for tests, be make sure you put here a model that in private project to make sure all good.
 let
     result = Speckle.GetByUrl(
-        "https://latest.speckle.systems/projects/126cd4b7bb/models/85c44d39c6"
+        "https://app.speckle.systems/projects/b61ab234b0/models/a8166255b5"
     )
 in
     result

src/powerbi-data-connector/speckle/api/GetStructuredData.pqm

@@ -59,16 +59,32 @@
             )
         ),
 
+        // Function to check if a row should be excluded based on speckle type
+        ShouldExcludeRow = (row as record) as logical =>
+            let
+                speckleType = Record.FieldOrDefault(row[data], "speckle_type", "")
+            in
+                speckleType = "Speckle.Core.Models.DataChunk" or 
+                Text.Contains(speckleType, "Objects.Other.RawEncoding"),
+       
         // Filtering logic here 
-        // If, model data contains any DataObject -> fetch only data objects
-        // If there are no data objects in the data -> fetch everything but DataChunks
+        // If model data contains any DataObject -> fetch only data objects (excluding unwanted types)
+        // If there are no data objects in the data -> fetch everything but exclude DataChunks and RawEncoding
         HasDataObjects = Table.RowCount(
-            Table.SelectRows(FinalTable, each Text.Contains(Record.FieldOrDefault([data], "speckle_type", ""), "DataObject"))
+            Table.SelectRows(
+                FinalTable, 
+                each Text.Contains(Record.FieldOrDefault([data], "speckle_type", ""), "DataObject") 
+                     and not ShouldExcludeRow(_)
+            )
         ) > 0,
 
         FilteredTable = if HasDataObjects then
-            Table.SelectRows(FinalTable, each Text.Contains(Record.FieldOrDefault([data], "speckle_type", ""), "DataObject"))
+            Table.SelectRows(
+                FinalTable, 
+                each Text.Contains(Record.FieldOrDefault([data], "speckle_type", ""), "DataObject") 
+                     and not ShouldExcludeRow(_)
+            )
         else
-            Table.SelectRows(FinalTable, each Record.FieldOrDefault([data], "speckle_type", "") <> "Speckle.Core.Models.DataChunk")
+            Table.SelectRows(FinalTable, each not ShouldExcludeRow(_))
     in
         FilteredTable

src/powerbi-data-connector/speckle/api/GetVersion.pqm

@@ -0,0 +1,46 @@
+() as text =>
+    let
+        // read the Speckle.pq file
+        specklePqContent = try 
+            Text.FromBinary(Extension.Contents("Speckle.pq"))
+        otherwise 
+            error "Could not read Speckle.pq file",
+        
+        lines = Text.Split(specklePqContent, "#(lf)"),
+        
+        versionLine = List.First(
+            List.Select(
+                lines, 
+                each Text.Contains(_, "[Version = ")
+            ),
+            null
+        ),
+        
+        version = if versionLine <> null then
+            let
+                // find the start and end positions of the version string
+                startPos = Text.PositionOf(versionLine, """") + 1,
+                tempText = Text.Middle(versionLine, startPos),
+                endPos = Text.PositionOf(tempText, """"),
+                versionText = Text.Middle(tempText, 0, endPos)
+            in
+                versionText
+        else
+            // fallback version if parsing fails
+            "3.0.0",
+        
+        // validate version format
+        isValidVersion = 
+            let 
+                parts = Text.Split(version, "."),
+                isValid = List.Count(parts) = 3 and 
+                         List.AllTrue(List.Transform(parts, each try Number.From(_) >= 0 otherwise false))
+            in 
+                isValid,
+        
+        result = if isValidVersion then 
+            version 
+        else 
+            error "Invalid version format found: " & version
+    in
+        result

src/powerbi-data-connector/speckle/api/GetWorkspace.pqm

@@ -0,0 +1,76 @@
+// function for getting workspace information
+(url as text) as record =>
+    let
+        ApiFetch = Extension.LoadFunction("Api.Fetch.pqm"),
+        Parser = Extension.LoadFunction("Parser.pqm"),
+        
+        // the logic for importing functions from other files
+        Extension.LoadFunction = (fileName as text) =>
+            let
+                binary = Extension.Contents(fileName),
+                asText = Text.FromBinary(binary)
+            in
+                try
+                    Expression.Evaluate(asText, #shared)
+                catch (e) =>
+                    error
+                        [
+                            Reason = "Extension.LoadFunction Failure",
+                            Message.Format = "Loading '#{0}' failed - '#{1}': '#{2}'",
+                            Message.Parameters = {fileName, e[Reason], e[Message]},
+                            Detail = [File = fileName, Error = e]
+                        ],
+        
+        parsedUrl = Parser(url),
+        server = parsedUrl[baseUrl],
+        projectId = parsedUrl[projectId],
+        
+        // query to get workspace ID from project
+        projectQuery = "query Project($projectId: String!) {
+            data:project(id: $projectId) {
+                workspaceId
+            }
+        }",
+        
+        projectVariables = [
+            projectId = projectId
+        ],
+        
+        projectResult = ApiFetch(server, projectQuery, projectVariables),
+        workspaceId = projectResult[data][workspaceId],
+        
+        // check if workspaceId is null (personal project)
+        workspaceInfo = if workspaceId = null then
+            [
+                workspaceId = null,
+                workspaceLogo = null,
+                workspaceName = null,
+                canHideBranding = false
+            ]
+        else
+            // query workspace only if workspaceId exists
+            let
+                workspaceQuery = "query Workspace($workspaceId: String!, $featureName: WorkspaceFeatureName!) {
+                    data:workspace(id: $workspaceId) {
+                        logo
+                        name
+                        hasAccessToFeature(featureName: $featureName)
+                    }
+                }",
+                
+                workspaceVariables = [
+                    workspaceId = workspaceId,
+                    featureName = "hideSpeckleBranding"
+                ],
+                
+                workspaceResult = ApiFetch(server, workspaceQuery, workspaceVariables),
+                workspace = workspaceResult[data]
+            in
+                [
+                    workspaceId = workspaceId,
+                    workspaceLogo = workspace[logo],
+                    workspaceName = workspace[name],
+                    canHideBranding = workspace[hasAccessToFeature]
+                ]
+    in
+        workspaceInfo

src/powerbi-data-connector/speckle/api/SendToServer.pqm

@@ -4,6 +4,9 @@
         GetModel = Extension.LoadFunction("GetModel.pqm"),
         Parser = Extension.LoadFunction("Parser.pqm"),
         GetUser = Extension.LoadFunction("GetUser.pqm"),
+        GetVersion = Extension.LoadFunction("GetVersion.pqm"),
+        GetWorkspace = Extension.LoadFunction("GetWorkspace.pqm"),
+
          // the logic for importing functions from other files
         Extension.LoadFunction = (fileName as text) =>
             let
@@ -20,18 +23,20 @@
                             Message.Parameters = {fileName, e[Reason], e[Message]},
                             Detail = [File = fileName, Error = e]
                         ],
-        
-        // Get model info and parsed URL
+
         modelInfo = GetModel(url),
         parsedUrl = Parser(url),
         userInfo = GetUser(url),
-        
-        // Get API key if available
+
         apiKey = userInfo[Token],
 
-        // Get user email from credentials
         userEmail = userInfo[UserEmail],
-        
+
+        // get version from Speckle.pq - look GetVersion.pqm
+        connectorVersion = GetVersion(),
+
+        workspaceInfo = GetWorkspace(url),
+
         // Prepare request data
         requestData = Json.FromValue([
             Url = url,
@@ -40,7 +45,12 @@
             ProjectId = parsedUrl[projectId],
             ObjectId = modelInfo[rootObjectId],
             SourceApplication = modelInfo[sourceApplication],
-            Token = apiKey 
+            Token = apiKey,
+            Version = connectorVersion,
+            WorkspaceId = workspaceInfo[workspaceId],
+            WorkspaceName = workspaceInfo[workspaceName],
+            WorkspaceLogo = workspaceInfo[workspaceLogo],
+            CanHideBranding = workspaceInfo[canHideBranding]
         ]),
 
         // Send request to local server