Address reviewer feedback: change all staging references to sandbox

Co-authored-by: bendichter <[email protected]>

Author: Copilot

docs/conf_extlinks.py

@@ -8,7 +8,7 @@
     "guide-issues": ("https://github.com/NeurodataWithoutBorders/nwb-guide/issues/%s", "%s"),
     "request-format-support": ("https://github.com/catalystneuro/neuroconv/issues/new?assignees=&labels=enhancement%%2Cdata+interfaces&projects=&template=format_request.yml&title=%%5BNew+Format%%5D%%3A+%s", "%s"),
     "path-expansion-guide": ("https://neuroconv.readthedocs.io/en/main/user_guide/expand_path.html%s", "%s"),
-    "dandi-sandbox": ("https://gui-sandbox.dandiarchive.org/%s", "%s"),
+    "dandi-sandbox": ("https://sandbox.dandiarchive.org/%s", "%s"),
     "dandi-archive": ("https://dandiarchive.org/%s", "%s"),
     "conda-install": (
         "https://docs.conda.io/projects/conda/en/latest/user-guide/install/index.html#regular-installation%s",

docs/developer_guide.rst

@@ -246,7 +246,7 @@ Updating Tutorial Screenshots
 Before a release, you'll want to update the tutorial screenshots to reflect the latest changes in the application.
 
 #. To regenerate the dataset, you'll need to change ``regenerateTestData`` in the ``tests/e2e/config.ts`` to ``true`` or delete the test dataset directory ``rm -rf ~/NWB_GUIDE/.test``.
-#. Create a ``.env`` file with the following content: ``DANDI_STAGING_API_KEY={your_dandi_sandbox_api_key}`` where ``{your_dandi_sandbox_api_key}`` is your DANDI sandbox API key from https://gui-sandbox.dandiarchive.org.
+#. Create a ``.env`` file with the following content: ``DANDI_STAGING_API_KEY={your_dandi_sandbox_api_key}`` where ``{your_dandi_sandbox_api_key}`` is your DANDI sandbox API key from https://sandbox.dandiarchive.org.
 #. Run the End-to-End Tests locally using ``npm run test:tutorial``. This will generate new screenshots in the ``docs/assets/tutorials`` directory.
 #. Review the new screenshots to ensure they are accurate.
 #. If the screenshots are accurate, commit them to the repository. Their paths should be consistent across runs—allowing the new versions to show up on the tutorial.

src/electron/frontend/core/components/DandiResults.js

@@ -1,7 +1,7 @@
 import { LitElement, css, html } from "lit";
 
 import { get } from "dandi";
-import { isStaging, getAPIKey } from "../../utils/upload";
+import { isSandbox, getAPIKey } from "../../utils/upload";
 
 export class DandiResults extends LitElement {
     static get styles() {
@@ -38,9 +38,9 @@ export class DandiResults extends LitElement {
 
         const otherElIds = ["embargo_status"];
 
-        const staging = isStaging(this.id);
-        const type = staging ? "staging" : undefined;
-        const api_key = await getAPIKey.call(this, staging);
+        const sandbox = isSandbox(this.id);
+        const type = sandbox ? "staging" : undefined;
+        const api_key = await getAPIKey.call(this, sandbox);
 
         const dandiset = await get(this.id, {
             type,

src/electron/frontend/core/components/pages/guided-mode/options/GuidedUpload.js

@@ -89,7 +89,7 @@ export class GuidedUploadPage extends Page {
             formProps: {
                 validateOnChange: async (name, parent) => {
                     const value = parent[name];
-                    if (name.includes("api_key")) return await validateDANDIApiKey(value, name.includes("staging"));
+                    if (name.includes("api_key")) return await validateDANDIApiKey(value, name.includes("sandbox"));
                 },
             },
         });

src/electron/frontend/core/components/pages/settings/SettingsPage.js

@@ -330,7 +330,7 @@ export class SettingsPage extends Page {
             onUpdate: () => (this.unsavedUpdates = true),
             validateOnChange: async (name, parent) => {
                 const value = parent[name];
-                if (name.includes("api_key")) return await validateDANDIApiKey(value, name.includes("staging"));
+                if (name.includes("api_key")) return await validateDANDIApiKey(value, name.includes("sandbox"));
                 return true;
             },
             onThrow,

src/electron/frontend/core/components/pages/uploads/UploadsPage.js

@@ -34,7 +34,7 @@ import keyIcon from "../../../../assets/icons/key.svg?raw";
 import {
     AWARD_VALIDATION_FAIL_MESSAGE,
     awardNumberValidator,
-    isStaging,
+    isSandbox,
     validate,
     getAPIKey,
 } from "../../../../utils/upload";
@@ -119,14 +119,14 @@ export function createDandiset(results = {}) {
                     throw message;
                 });
 
-                const uploadToMain = form.resolved.archive === "main";
-                const staging = !uploadToMain;
-
-                const api_key = await getAPIKey.call(this, staging);
-
-                const api = new dandi.API({
-                    token: api_key,
-                    type: staging ? "staging" : undefined,
+                const uploadToMain = form.resolved.archive === "main";
+                const sandbox = !uploadToMain;
+
+                const api_key = await getAPIKey.call(this, sandbox);
+
+                const api = new dandi.API({
+                    token: api_key,
+                    type: sandbox ? "staging" : undefined,
                 });
 
                 await api.authorize();
@@ -185,15 +185,15 @@ export async function uploadToDandi(info, type = "project" in info ? "project" :
 
     const dandiset_id = dandiset;
 
-    const staging = isStaging(dandiset_id); // Automatically detect staging IDs
-
-    const api_key = await getAPIKey.call(this, staging);
-
-    const payload = {
-        dandiset_id,
-        ...info.additional_settings,
-        staging,
-        api_key,
+    const sandbox = isSandbox(dandiset_id); // Automatically detect sandbox IDs
+
+    const api_key = await getAPIKey.call(this, sandbox);
+
+    const payload = {
+        dandiset_id,
+        ...info.additional_settings,
+        staging: sandbox,
+        api_key,
     };
 
     if (info.project) payload.project = info.project;
@@ -269,7 +269,7 @@ export class UploadsPage extends Page {
             formProps: {
                 validateOnChange: async (name, parent) => {
                     const value = parent[name];
-                    if (name.includes("api_key")) return await validateDANDIApiKey(value, name.includes("staging"));
+                    if (name.includes("api_key")) return await validateDANDIApiKey(value, name.includes("sandbox"));
                 },
             },
         }));

src/electron/frontend/core/validation/dandi.ts

@@ -3,14 +3,14 @@ const dandiAPITokenRegex = /^[a-f0-9]{40}$/;
 
 import { validateToken } from 'dandi'
 
-export const validateDANDIApiKey = async (apiKey: string, staging = false) => {
+export const validateDANDIApiKey = async (apiKey: string, sandbox = false) => {
     if (apiKey) {
 
         if (!dandiAPITokenRegex.test(apiKey)) return [{ type: "error", message: `Invalid API key format. Must be a 40 character hexadecimal string` }];
 
-        const authFailedError = {type: 'error', message: `Authorization failed. Make sure you're providing an API key for the <a href='https://${staging ? 'gui-sandbox.' : ''}dandiarchive.org' target='_blank'>${staging ? 'sandbox' : 'main'} archive</a>.`}
+        const authFailedError = {type: 'error', message: `Authorization failed. Make sure you're providing an API key for the <a href='https://${sandbox ? 'sandbox.' : ''}dandiarchive.org' target='_blank'>${sandbox ? 'sandbox' : 'main'} archive</a>.`}
 
-        const isValid = validateToken({ token: apiKey, type: staging ? 'staging' : undefined }).catch(e => false)
+        const isValid = validateToken({ token: apiKey, type: sandbox ? 'staging' : undefined }).catch(e => false)
         if (!isValid) return [ authFailedError ]
         return true
     }

src/electron/frontend/utils/upload.ts

@@ -18,7 +18,7 @@ import { NotyfNotification } from "notyf";
 import dandiGlobalSchema from "../../../schemas/json/dandi/global.json";
 import { isNumericString } from "./typecheck";
 
-export const isStaging = (id: string) => parseInt(id) >= 100000;
+export const isSandbox = (id: string) => parseInt(id) >= 100000;
 
 type NotificationType = {
     type: string;
@@ -51,9 +51,9 @@ export async function validate(
                 message: `<b>Invalid ID –</b> Dandiset ID must be 6 digits.`
             }]
 
-            const staging = isStaging(value)
-            const type = staging ? "staging" : undefined;
-            const token = await getAPIKey.call(this, staging);
+            const sandbox = isSandbox(value)
+            const type = sandbox ? "staging" : undefined;
+            const token = await getAPIKey.call(this, sandbox);
 
             const dandiset = await get(value, {
                 type,
@@ -106,14 +106,14 @@ export const AWARD_VALIDATION_FAIL_MESSAGE = 'Award number must be properly spac
 // this:
 export async function getAPIKey(
     this: Page,
-    staging = false
+    sandbox = false
 ) {
 
-    const whichAPIKey = staging ? "development_api_key" : "main_api_key";
+    const whichAPIKey = sandbox ? "sandbox_api_key" : "main_api_key";
     const DANDI = global.data.DANDI;
     let api_key = DANDI?.api_keys?.[whichAPIKey];
 
-    const errors = await validateDANDIApiKey(api_key, staging);
+    const errors = await validateDANDIApiKey(api_key, sandbox);
 
     const isInvalid = Array.isArray(errors) ? errors.length : !errors;
 
@@ -154,7 +154,7 @@ export async function getAPIKey(
                 onClick: async () => {
                     const value = input.value;
                     if (value) {
-                        const errors = await validateDANDIApiKey(input.value, staging);
+                        const errors = await validateDANDIApiKey(input.value, sandbox);
                         if (!errors || !errors.length) {
                             modal.remove();
 

src/schemas/dandi-upload.schema.ts

@@ -2,7 +2,7 @@ import { Dandiset, getMine } from 'dandi'
 
 import { global } from '../electron/frontend/core/progress'
 import upload from './json/dandi/upload.json' assert { type: "json" }
-import { isStaging } from '../electron/frontend/utils/upload'
+import { isSandbox } from '../electron/frontend/utils/upload'
 import { baseUrl, onServerOpen } from '../electron/frontend/core/server/globals'
 import { isStorybook } from '../electron/frontend/core/globals'
 
@@ -54,16 +54,16 @@ export const regenerateDandisets = async () => {
 
 export const updateDandisets = async (main = true) => {
 
-    const staging = !main
+    const sandbox = !main
 
     // Fetch My Dandisets
-    const whichAPIKey = staging ? "development_api_key" : "main_api_key";
+    const whichAPIKey = sandbox ? "sandbox_api_key" : "main_api_key";
     const DANDI = global.data.DANDI;
     let token = DANDI?.api_keys?.[whichAPIKey];
 
     if (!token) return []
 
-    return await getMine({ token, type: staging ? 'staging' : undefined }, { embargoed: true })
+    return await getMine({ token, type: sandbox ? 'staging' : undefined }, { embargoed: true })
         .then((results) => results ? Promise.all(results.map(addDandiset)) : [])
         .catch(() => {
             return []
@@ -85,22 +85,22 @@ export const addDandiset = async (info) => {
     enumSet.add(id)
     idSchema.enum = Array.from(enumSet)
 
-    const staging = isStaging(id)
+    const sandbox = isSandbox(id)
 
     if (!idSchema.enumLabels) idSchema.enumLabels = {}
     if (!idSchema.enumKeywords) idSchema.enumKeywords = {}
     if (!idSchema.enumCategories) idSchema.enumCategories = {}
 
 
-    const token = global.data.DANDI.api_keys[staging ? "development_api_key" : "main_api_key"];
+    const token = global.data.DANDI.api_keys[sandbox ? "sandbox_api_key" : "main_api_key"];
 
-    info = new Dandiset(info, { type: staging ? "staging" : undefined, token })
+    info = new Dandiset(info, { type: sandbox ? "staging" : undefined, token })
 
     const latestVersionInfo = (info.most_recent_published_version ?? info.draft_version)!
     const enumLabels = `${id} — ${latestVersionInfo.name}`
 
     const isDraft = latestVersionInfo.version === 'draft'
-    const enumCategories = (isDraft ? 'Unpublished' : '') + (staging ? `${isDraft ? ` - ` : ''}Staging` : '')
+    const enumCategories = (isDraft ? 'Unpublished' : '') + (sandbox ? `${isDraft ? ` - ` : ''}Sandbox` : '')
 
     const fullInfo = await info.getInfo({ version: latestVersionInfo.version });
 

src/schemas/json/dandi/create.json

@@ -23,10 +23,10 @@
         "archive": {
             "type": "string",
             "enumLabels": {
-                "staging": "Sandbox Server",
+                "sandbox": "Sandbox Server",
                 "main": "Main Archive"
             },
-            "enum": ["main", "staging"],
+            "enum": ["main", "sandbox"],
             "description": "Which DANDI server to upload to. <br><small><b>Note:</b> The Sandbox Server is recommended for developers, or users learning to use DANDI</small>",
             "strict": true
         },