#283 Refactor feedback

Author: Polleps

CHANGELOG.md

@@ -16,13 +16,18 @@ This changelog covers all three packages, as they are (for now) updated as a who
 - Add the ability to change the `fetch` function used to fetch resources over http.
 - `store.addResource` is depricated in favor of `store.addResources`.
 - Add `AgentChange` event on store that is fired whenever the stores agent changes.
+- `store.fetchResourceFromServer` now returns the requested resource.
+- Add `postCommit` method to `store` that respects the injected `fetch` function.
 
 #### Breaking Changes:
 
 - `uploadFiles()` has moved to `store.uploadFiles()`.
 - Remove `Agent.fromJSON()`
-- `tryValidURL` and `isValidURL` are now static methods on `Client`.
+- `tryValidURL` and `isValidURL` are now static methods on `Client` and have been renamed to `tryValidSubject` and `isValidSubject`.
 - Rename `store.fetchResource` to `store.fetchResourceFromServer`.
+- Rename `store.handleError` to `store.notifyError`.
+- Rename `agent.checkPublicKey` to `agent.verifyPublicKeyWithServer`.
+- Remove `store.errorHandler` and replace with new `StoreEvents.Error` event.
 
 ## v0.34.10
 

data-browser/package.json

@@ -72,5 +72,5 @@
     "typecheck": "tsc --noEmit"
   },
   "type": "module",
-  "version": "0.35.0"
+  "version": "0.35.0-beta.0"
 }

data-browser/src/App.tsx

@@ -1,27 +1,23 @@
 import React from 'react';
 import { BrowserRouter } from 'react-router-dom';
 import { HelmetProvider } from 'react-helmet-async';
-import { StoreContext, Store, urls, StoreEvents } from '@tomic/react';
+import { StoreContext, Store, urls } from '@tomic/react';
 
 import { GlobalStyle, ThemeWrapper } from './styling';
 import { AppRoutes } from './routes/Routes';
 import { NavWrapper } from './components/Navigation';
 import { MetaSetter } from './components/MetaSetter';
 import { Toaster } from './components/Toaster';
 import { isDev } from './config';
-import { handleError, initBugsnag } from './helpers/handlers';
+import { initBugsnag } from './helpers/loggingHandlers';
 import HotKeysWrapper from './components/HotKeyWrapper';
 import { AppSettingsContextProvider } from './helpers/AppSettings';
 import CrashPage from './views/CrashPage';
-import toast from 'react-hot-toast';
 import { DialogContainer } from './components/Dialog/DialogContainer';
 import { registerHandlers } from './handlers';
 import { ErrorBoundary } from './views/ErrorPage';
 import { NetworkIndicator } from './components/NetworkIndicator';
-import {
-  getAgentFromLocalStorage,
-  saveAgentToLocalStorage,
-} from './helpers/agentStorage';
+import { getAgentFromLocalStorage } from './helpers/agentStorage';
 
 function fixDevUrl(url: string) {
   if (isDev()) {
@@ -31,34 +27,19 @@ function fixDevUrl(url: string) {
   return url;
 }
 
+/**
+ * Defaulting to the current URL's origin will make sense in most non-dev environments.
+ * In dev envs, we want to default to port 9883
+ */
+const serverUrl = fixDevUrl(window.location.origin);
 const initalAgent = getAgentFromLocalStorage();
 
 // Initialize the store
 const store = new Store({
   agent: initalAgent,
+  serverUrl,
 });
 
-store.on(StoreEvents.AgentChanged, saveAgentToLocalStorage);
-
-/**
- * Defaulting to the current URL's origin will make sense in most non-dev environments.
- * In dev envs, we want to default to port 9883
- */
-const currentOrigin = window.location.origin;
-
-store.setServerUrl(fixDevUrl(currentOrigin));
-
-// Show an error when things go wrong
-store.errorHandler = e => {
-  handleError(e);
-
-  if (e.message.length > 100) {
-    e.message = e.message.substring(0, 100) + '...';
-  }
-
-  toast.error(e.message);
-};
-
 declare global {
   interface Window {
     bugsnagApiKey: string;

data-browser/src/components/HotKeyWrapper.tsx

@@ -71,7 +71,7 @@ function HotKeysWrapper({ children }: Props): JSX.Element {
     shortcuts.edit,
     e => {
       e.preventDefault();
-      Client.isValidURL(subject) && navigate(editURL(subject!));
+      Client.isValidSubject(subject) && navigate(editURL(subject!));
     },
     {},
     [subject],
@@ -80,7 +80,7 @@ function HotKeysWrapper({ children }: Props): JSX.Element {
     shortcuts.data,
     e => {
       e.preventDefault();
-      Client.isValidURL(subject) && navigate(dataURL(subject!));
+      Client.isValidSubject(subject) && navigate(dataURL(subject!));
     },
     {},
     [subject],

data-browser/src/components/NewInstanceButton/useCreateAndNavigate.ts

@@ -50,7 +50,7 @@ export function useCreateAndNavigate(klass: string, parent?: string) {
         toast.success(`${title} created`);
         store.notifyResourceManuallyCreated(resource);
       } catch (e) {
-        store.handleError(e);
+        store.notifyError(e);
       }
 
       return resource;

data-browser/src/components/ResourceContextMenu/index.tsx

@@ -50,7 +50,7 @@ function ResourceContextMenu({
     return null;
   }
 
-  if (!Client.isValidURL(subject)) {
+  if (!Client.isValidSubject(subject)) {
     return null;
   }
 

data-browser/src/components/Searchbar.tsx

@@ -41,7 +41,7 @@ export function Searchbar({
     setInput(e.target.value);
 
     try {
-      Client.tryValidURL(e.target.value);
+      Client.tryValidSubject(e.target.value);
       // Replace instead of push to make the back-button behavior better.
       navigate(constructOpenURL(e.target.value), { replace: true });
     } catch (_err) {

data-browser/src/components/forms/ResourceForm.tsx

@@ -137,7 +137,7 @@ export function ResourceForm({
   function handleAddProp() {
     setNewPropErr(undefined);
 
-    if (!Client.isValidURL(newProperty)) {
+    if (!Client.isValidSubject(newProperty)) {
       setNewPropErr(new Error('Invalid URL'));
 
       return;

data-browser/src/handlers/errorHandler.ts

@@ -0,0 +1,14 @@
+import toast from 'react-hot-toast';
+import { handleError } from '../helpers/loggingHandlers';
+
+export const errorHandler = (e: Error) => {
+  handleError(e);
+
+  let message = e.message;
+
+  if (e.message.length > 100) {
+    message = e.message.substring(0, 100) + '...';
+  }
+
+  toast.error(message);
+};

data-browser/src/handlers/index.ts

@@ -1,4 +1,6 @@
 import { Store, StoreEvents } from '@tomic/react';
+import { saveAgentToLocalStorage } from '../helpers/agentStorage';
+import { errorHandler } from './errorHandler';
 import {
   buildSideBarNewResourceHandler,
   buildSideBarRemoveResourceHandler,
@@ -13,4 +15,6 @@ export function registerHandlers(store: Store) {
     StoreEvents.ResourceRemoved,
     buildSideBarRemoveResourceHandler(store),
   );
+  store.on(StoreEvents.Error, errorHandler);
+  store.on(StoreEvents.AgentChanged, saveAgentToLocalStorage);
 }