feat: cover SOQL Builder UI with a warning message when there is no default org

Author: daphne-sfdc

packages/salesforcedx-vscode-soql/src/editor/soqlEditorInstance.ts

@@ -74,7 +74,8 @@ type MessageType =
   | 'text_soql_changed'
   | 'run_query'
   | 'connection_changed'
-  | 'run_query_done';
+  | 'run_query_done'
+  | 'no_default_org';
 
 export class SOQLEditorInstance {
   public subscriptions: vscode.Disposable[] = [];
@@ -115,6 +116,8 @@ export class SOQLEditorInstance {
     this.subscriptions.push({ dispose: () => Effect.runFork(Fiber.interrupt(messageFiber)) });
 
     const { onConnectionChanged } = this;
+    // eslint-disable-next-line @typescript-eslint/no-this-alias
+    const self = this;
     const connectionFiber = getSoqlRuntime().runFork(
       Effect.gen(function* () {
         const api = yield* (yield* ExtensionProviderService).getServicesApi;
@@ -123,7 +126,9 @@ export class SOQLEditorInstance {
           Stream.tap(org => Effect.sync(() => console.log(`Target org changed to ${org.orgId ?? '<NOT SET>'}`))),
           Stream.map(org => org.orgId),
           Stream.changes,
-          Stream.runForEach(() => onConnectionChanged())
+          Stream.runForEach(orgId =>
+            orgId ? onConnectionChanged() : self.sendMessageToUi('no_default_org')
+          )
         );
       })
     );
@@ -176,8 +181,16 @@ export class SOQLEditorInstance {
 
   private handleMessageEffect = (event: SoqlEditorEvent) => {
     switch (event.type) {
-      case 'ui_activated':
-        return this.updateWebview(this.document).pipe(Effect.withSpan('SOQLEditor.ui_activated'));
+      case 'ui_activated': {
+        const self = this;
+        return Effect.gen(function* () {
+          const isOrgSet = yield* Effect.promise(() => isDefaultOrgSet());
+          if (!isOrgSet) {
+            yield* self.sendMessageToUi('no_default_org');
+          }
+          yield* self.updateWebview(self.document);
+        }).pipe(Effect.withSpan('SOQLEditor.ui_activated'));
+      }
 
       case 'ui_soql_changed': {
         const soql = event.payload;

packages/salesforcedx-vscode-soql/src/soql-builder-ui/index.html

@@ -40,6 +40,7 @@
         --soql-foreground: #080707;
         --soql-white: #ffffff;
         --soql-red: #c23934;
+        --soql-purple: #6a0dad;
         --soql-error-background: #fffacd;
       }
     </style>

packages/salesforcedx-vscode-soql/src/soql-builder-ui/modules/querybuilder/app/app.css

@@ -58,3 +58,16 @@ main {
 .warning-notification__dismiss {
   text-align: right;
 }
+
+.info-notification {
+  max-width: var(--soql-media-max-width);
+}
+
+.info-notification__message {
+  background-color: var(--soql-purple);
+  color: var(--soql-white);
+  font-size: small;
+  padding: 1rem;
+  border-radius: 3px;
+  margin-bottom: 1rem;
+}

packages/salesforcedx-vscode-soql/src/soql-builder-ui/modules/querybuilder/app/app.html

@@ -17,7 +17,17 @@
     </header>
     <article class="querybuilder-body">
       <section class="querybuilder-form">
-        <template if:false={shouldBlockQueryBuilder}>
+        <template if:true={showNoDefaultOrgNotification}>
+          <div class="info-notification">
+            <div class="info-notification__message">
+              <!-- TODO: i18n -->
+              No default org found. Set a default org to use SOQL Builder. Run
+              "SFDX: Create a Default Scratch Org" or "SFDX: Authorize an Org"
+              to set one.
+            </div>
+          </div>
+        </template>
+        <template if:true={showQueryBuilderForm}>
           <querybuilder-from
             onfrom__object_selected={handleObjectChange}
             sobjects={sObjects}
@@ -63,7 +73,7 @@
             class={theme}
           ></querybuilder-limit>
         </template>
-        <template if:true={shouldBlockQueryBuilder}>
+        <template if:true={showBlockedQueryBuilder}>
           <div class="warning-notification">
             <div class="warning-notification__message">
               <template if:true={showUnsupportedNotification}>

packages/salesforcedx-vscode-soql/src/soql-builder-ui/modules/querybuilder/app/app.ts

@@ -55,6 +55,16 @@ export default class App extends LightningElement {
   public get showSyntaxErrorNotification(): boolean {
     return this.hasUnrecoverableError;
   }
+  public get showNoDefaultOrgNotification(): boolean {
+    return this.hasNoDefaultOrg;
+  }
+  public get showBlockedQueryBuilder(): boolean {
+    return !this.hasNoDefaultOrg && this.shouldBlockQueryBuilder;
+  }
+  public get showQueryBuilderForm(): boolean {
+    return !this.hasNoDefaultOrg && !this.shouldBlockQueryBuilder;
+  }
+  public hasNoDefaultOrg = false;
   public hasUnsupportedMessage = false;
   public hasRecoverableFieldsError = false;
   public hasRecoverableFromError = false;
@@ -95,6 +105,10 @@ export default class App extends LightningElement {
     this.toolingSDK.queryRunState.subscribe(() => {
       this.isQueryRunning = false;
     });
+
+    this.toolingSDK.noDefaultOrg.subscribe((hasNoDefaultOrg: boolean) => {
+      this.hasNoDefaultOrg = hasNoDefaultOrg;
+    });
     this.loadSObjectDefinitions();
     this.modelService.restoreViewState();
   }

packages/salesforcedx-vscode-soql/src/soql-builder-ui/modules/querybuilder/services/message/soqlEditorEvent.ts

@@ -12,7 +12,8 @@ export enum MessageType {
   TEXT_SOQL_CHANGED = 'text_soql_changed',
   RUN_SOQL_QUERY = 'run_query',
   CONNECTION_CHANGED = 'connection_changed',
-  RUN_SOQL_QUERY_DONE = 'run_query_done'
+  RUN_SOQL_QUERY_DONE = 'run_query_done',
+  NO_DEFAULT_ORG = 'no_default_org'
 }
 
 export type SoqlEditorEvent = {

packages/salesforcedx-vscode-soql/src/soql-builder-ui/modules/querybuilder/services/toolingSDK.ts

@@ -19,6 +19,7 @@ export class ToolingSDK {
   public queryRunState: Observable<boolean> = new BehaviorSubject<boolean>(
     false
   );
+  public noDefaultOrg: Observable<boolean> = new BehaviorSubject<boolean>(false);
   private messageService: IMessageService;
   private latestSObjectName?: string;
 
@@ -51,12 +52,17 @@ export class ToolingSDK {
           break;
         }
         case MessageType.CONNECTION_CHANGED: {
+          this.noDefaultOrg.next(false);
           this.loadSObjectDefinitions();
           if (this.latestSObjectName) {
             this.loadSObjectMetatada(this.latestSObjectName);
           }
           break;
         }
+        case MessageType.NO_DEFAULT_ORG: {
+          this.noDefaultOrg.next(true);
+          break;
+        }
         case MessageType.RUN_SOQL_QUERY_DONE: {
           this.queryRunState.next(false);
           break;