Merge pull request #12600 from quarto-dev/feature/deno-2-deps

Feature/deno 2 deps

Author: cscheid

.github/workflows/actions/quarto-dev/action.yml

@@ -8,10 +8,9 @@ runs:
       uses: actions/cache@v4
       with:
         path: ./src/resources/deno_std/cache
-        key: ${{ runner.os }}-deno_std-1-${{ hashFiles('./src/resources/deno_std/deno_std.lock', './package/scripts/deno_std/deno_std.ts') }}
+        key: ${{ runner.os }}-deno_std-2-${{ hashFiles('./src/resources/deno_std/deno_std.lock', './package/scripts/deno_std/deno_std.ts') }}
         restore-keys: |
-          ${{ runner.os }}-deno_std-1-
-          ${{ runner.os }}-deno_std-
+          ${{ runner.os }}-deno_std-2-
 
     - name: Configure Quarto (.sh)
       if: runner.os != 'Windows'

configure.cmd

@@ -69,30 +69,14 @@ echo Configuration done
 
 POPD
 
-if "%CI%" NEQ "true" (
-	echo Revendoring quarto dependencies
-
-  @REM for /F "tokens=2" %%i in ('date /t') do set today=%%i
-	@REM RENAME src\vendor src\vendor-%today%
-	@REM pushd src
-  @REM echo Vendor phase 1
-	@REM %QUARTO_DENO% vendor quarto.ts %QUARTO_ROOT%\tests\test-deps.ts --importmap=import_map.json
-	@REM if ERRORLEVEL NEQ 0 (
-	@REM   popd
-	@REM   echo deno vendor failed (likely because of a download error). Please run the configure script again.
-	@REM 	RMDIR vendor
-	@REM 	RENAME vendor-${today} vendor
-	@REM 	exit 1
-  @REM )
-	@REM popd
-	@REM %QUARTO_DENO% run --unstable --allow-all --importmap=src\import_map.json package\src\common\create-dev-import-map.ts
-)
+REM download typescript dependencies
+CALL package\scripts\vendoring\vendor.cmd
 
 ECHO Downloading Deno Stdlib
 CALL !QUARTO_PACKAGE_PATH!\scripts\deno_std\download.bat
 
-SET QUARTO_DENO_EXTRA_OPTIONS="--reload"
 IF EXIST !QUARTO_BIN_PATH!\quarto.cmd (
+  SET QUARTO_DENO_EXTRA_OPTIONS=--reload
   CALL "!QUARTO_BIN_PATH!\quarto" --version
 )
 

configure.sh

@@ -29,51 +29,58 @@ function download() {
 
 QUARTO_VENDOR_BINARIES=${QUARTO_VENDOR_BINARIES=true}
 
-DENO_BIN=${QUARTO_DENO=$QUARTO_BIN_PATH/tools/$DENO_DIR/deno}
+DENO_BIN=${QUARTO_DENO=$QUARTO_BIN_PATH/tools/$DENO_ARCH_DIR/deno}
 
 if [[ "${QUARTO_VENDOR_BINARIES}" = "true" ]]; then
-  DENO_VERSION_NO_V=$(echo $DENO | sed 's/v//')
-  if [[ (! -f "$DENO_BIN") || $("$DENO_BIN" --version | grep $DENO_VERSION_NO_V) == "" ]]; then
+  DENO_VERSION_NO_V=$(echo "$DENO" | sed 's/v//')
+  if [[ (! -f "$DENO_BIN") || $("$DENO_BIN" --version | grep "$DENO_VERSION_NO_V") == "" ]]; then
     # Ensure directory is there for Deno
     echo "Bootstrapping Deno..."
 
-    rm -rf $QUARTO_DIST_PATH
+    rm -rf "$QUARTO_DIST_PATH"
 
     ## Binary Directory
     mkdir -p "$QUARTO_BIN_PATH/tools"
-    cd $QUARTO_BIN_PATH/tools
+    pushd "$QUARTO_BIN_PATH/tools"
 
     # Download Deno
     for DENOFILE in $DENOFILES; do
       download "$DENOURL/$DENO/$DENOFILE" "$DENOFILE"
-      unzip -o $DENOFILE
-      
-      mkdir -p $DENO_DIR
-      mv deno $DENO_DIR
-      rm $DENOFILE
+      unzip -o "$DENOFILE"
+      mkdir -p "$DENO_ARCH_DIR"
+      mv deno "$DENO_ARCH_DIR"
+      rm "$DENOFILE"
     done
 
     # we create a symlink here so that we need only one quarto-cli.code-workspace file
-    ln -s $DENO_DIR/deno deno
+    ln -s $DENO_ARCH_DIR/deno deno
 
     # If a canary commit is provided, upgrade to that
-    if [ ! -z "$DENO_CANARY_COMMIT" ]; then
+    if [ -n "$DENO_CANARY_COMMIT" ]; then
       echo [Upgrading Deno to Canary]
-      ./deno upgrade --canary --version $DENO_CANARY_COMMIT
+      ./deno upgrade --canary --version "$DENO_CANARY_COMMIT"
     fi
 
     # write deno version file for later use
-    mkdir -p $QUARTO_BIN_PATH/../config
-    echo $DENO > $QUARTO_BIN_PATH/../config/deno-version
+    mkdir -p "$QUARTO_BIN_PATH/../config"
+    echo "$DENO" > "$QUARTO_BIN_PATH/../config/deno-version"
+
+    popd
   fi
-  export DENO_BIN_PATH=$QUARTO_BIN_PATH/tools/$DENO_DIR/deno
+  export DENO_BIN_PATH=$QUARTO_BIN_PATH/tools/$DENO_ARCH_DIR/deno
 else
   if [ -z "$DENO_BIN_PATH" ]; then
     echo "DENO_BIN_PATH is not set. You either need to allow QUARTO_VENDOR_BINARIES or set DENO_BIN_PATH to the path of a deno binary."
     exit 1
   fi
 fi
 
+if [ "$QUARTO_DENO_DIR" == "" ]; then
+  export DENO_DIR=$QUARTO_BIN_PATH/deno_cache
+else
+  export DENO_DIR=$QUARTO_DENO_DIR
+fi
+
 echo "Downloading Deno Stdlib"
 "${QUARTO_PACKAGE_PATH}/scripts/deno_std/download.sh"
 
@@ -82,6 +89,11 @@ pushd "$QUARTO_PACKAGE_PATH/src/"
 # Run the configure command to bootstrap installation
 ./quarto-bld configure --log-level info
 
+popd
+
+# download typescript dependencies
+source package/scripts/vendoring/vendor.sh
+
 # Run the quarto command with 'reload', which will force the import_map dependencies
 # to be reloaded
 if ! quarto_loc="$(type -p quarto)" || [[ -z $quarto_loc ]]; then

dev-docs/add-typescript-dependency.md

@@ -10,4 +10,4 @@ We vendor all external dependencies to avoid downloads during the execution of q
 
 - If the dependency is meant to be exposed to quarto typescript script (through `quarto run`), then add the import to `package/scripts/deno_std/deno_std.ts` as well (notice the slightly different syntax there, and adapt accordingly).
 
-Then, run the `./package/scripts/vendoring/vendor.sh` scripts to update the vendored dependencies. This script will update `src/dev_import_map.json`, as well as files in `src/vendor`, `src/resources/deno_std`, and `src/resources/vendor`. Check those changes in version control.
+Then, rerun `./configure.sh`, which calls the `./package/scripts/vendoring/vendor.sh` scripts to update the deno cache with the downloaded dependencies. 

dev-docs/upgrade-dependencies.md

@@ -10,7 +10,7 @@ Contact Carlos so he uploads the binaries to the S3 bucket.
 
 - In `src/import_map.json`, change the version number of the imports like `https://deno.land/std@0.204.0/archive` to the new version number (e.g. `0.205.0`).
 
-- run `./package/scripts/vendoring/vendor.sh`
+- run `./configure.sh`.
 
 ### Upgrade Deno download link for RHEL build from conda-forge
 

package/scripts/common/quarto

@@ -33,6 +33,8 @@ else
 fi
 QUARTO_SRC_PATH="$QUARTO_ROOT/src"
 DEV_PATH=$QUARTO_SRC_PATH/quarto.ts
+QUARTO_IMPORT_MAP_ARG=--importmap=$QUARTO_SRC_PATH/import_map.json
+
 if [ -f "$DEV_PATH" ]; then
   if [ "$1" == "--version" ] || [ "$1" == "-v" ]; then
     if [ "$QUARTO_FORCE_VERSION" != "" ]; then
@@ -48,9 +50,6 @@ if [ -f "$DEV_PATH" ]; then
     QUARTO_ACTION=run
   fi
 
-  # Local import map
-  QUARTO_IMPORT_MAP_ARG=--importmap=$QUARTO_SRC_PATH/import_map.json
-
   # Turn on type checking for dev version
   if [ -z ${QUARTO_NO_TYPECHECK+x} ]; then
     QUARTO_DENO_OPTIONS=--check
@@ -63,10 +62,12 @@ if [ -f "$DEV_PATH" ]; then
 
   export QUARTO_BIN_PATH=$SCRIPT_PATH
   export QUARTO_SHARE_PATH="${QUARTO_SHARE_PATH=$QUARTO_SRC_PATH/resources/}"
+  export DENO_DIR=$QUARTO_BIN_PATH/deno_cache
+
   if [ -z ${QUARTO_DEBUG+x} ]; then
     export QUARTO_DEBUG=true
   fi
-  # QUARTO_CACHE_OPTIONS="--cached-only"
+  QUARTO_CACHE_OPTIONS="--cached-only"
 
   # Check for deno update
   QUARTO_DIST_CONFIG=$QUARTO_BIN_PATH/../config
@@ -91,7 +92,8 @@ else
   QUARTO_ACTION=run
   QUARTO_TARGET=${SCRIPT_PATH}/quarto.js
   export QUARTO_BIN_PATH=$SCRIPT_PATH
-  QUARTO_CACHE_OPTIONS=""
+  export DENO_DIR=$QUARTO_BIN_PATH/deno_cache
+  QUARTO_CACHE_OPTIONS="--cached-only"
 
   # Turn off type checking for bundled version
   QUARTO_DENO_OPTIONS=--no-check
@@ -108,9 +110,6 @@ else
     fi
   fi
 
-  # release vendored import map
-  QUARTO_IMPORT_MAP_ARG=--importmap=$SCRIPT_PATH/vendor/import_map.json
-
   if [ "$1" == "--version" ] || [ "$1" == "-v" ]; then
     if [ "$QUARTO_FORCE_VERSION" != "" ]; then
       echo $QUARTO_FORCE_VERSION

package/scripts/common/utils.sh

@@ -1,15 +1,15 @@
-# DENOFILES is only required at configure.sh, but DENO_DIR is used in many places
+# DENOFILES is only required at configure.sh, but DENO_ARCH_DIR is used in many places
 
 if [[ $OSTYPE == 'darwin'* ]]; then
   DENOURL=https://github.com/denoland/deno/releases/download
   FULLARCH=$(uname -sm)
 
 
   if [[ $FULLARCH == "Darwin x86_64" ]]; then
-    DENO_DIR=x86_64
+    DENO_ARCH_DIR=x86_64
     DENOFILES="deno-x86_64-apple-darwin.zip"
   elif [[ $FULLARCH == "Darwin arm64" ]]; then
-    DENO_DIR=aarch64
+    DENO_ARCH_DIR=aarch64
     DENOFILES="deno-aarch64-apple-darwin.zip"
   else
     echo "configure script failed: unrecognized architecture " ${FULLARCH}
@@ -21,11 +21,11 @@ else
   if [[ $NIXARCH == "x86_64" ]]; then
     DENOURL=https://github.com/denoland/deno/releases/download
     DENOFILES=deno-x86_64-unknown-linux-gnu.zip
-    DENO_DIR=x86_64
+    DENO_ARCH_DIR=x86_64
   elif [[ $NIXARCH == "aarch64" ]]; then
     DENOURL=https://github.com/denoland/deno/releases/download
     DENOFILES=deno-aarch64-unknown-linux-gnu.zip
-    DENO_DIR=aarch64
+    DENO_ARCH_DIR=aarch64
   else
     echo "configure script failed: unrecognized architecture " ${NIXARCH}
     exit 1

package/scripts/deno_std/download.bat

@@ -6,4 +6,4 @@ if NOT DEFINED QUARTO_DENO (
 )
 
 set DENO_DIR=%~dp0\..\..\..\src\resources\deno_std\cache
-%QUARTO_DENO% cache --unstable-ffi --lock %~dp0\..\..\..\src\resources\deno_std\deno_std.lock %~dp0\deno_std.ts
+%QUARTO_DENO% cache --allow-import --unstable-ffi --lock %~dp0\..\..\..\src\resources\deno_std\deno_std.lock %~dp0\deno_std.ts

package/scripts/deno_std/download.sh

@@ -5,7 +5,7 @@ source "$SCRIPT_PATH/../../../configuration"
 source "$SCRIPT_PATH/../../src/set_package_paths.sh"
 
 if [ -z "$QUARTO_DENO" ]; then
-  export QUARTO_DENO="$QUARTO_DIST_PATH/bin/tools/$DENO_DIR/deno"
+  export QUARTO_DENO="$QUARTO_DIST_PATH/bin/tools/$DENO_ARCH_DIR/deno"
 fi
 
 

package/scripts/vendoring/vendor.cmd

@@ -0,0 +1,36 @@
+@ECHO OFF
+REM You should not need to run this script directly. 
+REM It is sourced by the configure.cmd script.
+SETLOCAL ENABLEDELAYEDEXPANSION
+
+IF "%QUARTO_VENDOR_BINARIES%"=="true" (
+  SET DENO_BIN_PATH=!QUARTO_BIN_PATH!\tools\!DENO_ARCH_DIR!\deno.exe
+) ELSE (
+  IF NOT DEFINED DENO_BIN_PATH (
+    ECHO DENO_BIN_PATH is not set. You either need to allow QUARTO_VENDOR_BINARIES or set DENO_BIN_PATH to the path of a deno binary.
+    EXIT /B 1
+  )
+)
+
+IF NOT DEFINED DENO_DIR (
+  SET DENO_DIR=!QUARTO_BIN_PATH!\deno_cache
+)
+
+ECHO Revendoring quarto dependencies
+
+REM remove deno_cache directory first
+IF EXIST "!DENO_DIR!" (
+  RMDIR /S /Q "!DENO_DIR!"
+)
+
+PUSHD "!QUARTO_SRC_PATH!"
+
+FOR %%E IN (quarto.ts vendor_deps.ts ..\tests\test-deps.ts ..\package\scripts\deno_std\deno_std.ts) DO (
+  CALL !DENO_BIN_PATH! install --allow-all --no-config --entrypoint %%E --importmap="!QUARTO_SRC_PATH!\import_map.json"
+)
+
+REM Return to the original directory
+POPD
+
+
+EXIT /B 0