Improve error message for undownloadable artifacts

This commit adds a message to the already existing error message that
the artifact may be undownloadable and suggests to manually download
the artifact and adds the artifact to Overrides.toml if this is the case.

Author: ph-kev

NEWS.md

@@ -73,10 +73,13 @@ The default cache size for regridded fields in `DataHandler` was reduced from
 128 to 2, reducing the memory footprint. You can pass the `cache_max_size`
 keyword argument to control this value.
 
-#### Error hints
+#### Improved error handling
 
-When using a function that depends on loading another package, the error now tells the user
-which package should be loaded if the package has not been loaded already.
+When using a function that depends on loading another package, the error now
+tells the user which package should be loaded if the package has not been loaded
+already. Furthermore, if there is an error with `@clima_artifact`, the error
+message tells the user that the artifact might be undownloadable and recommends
+downloading it themselves.
 
 v0.1.19
 ------

src/ClimaArtifacts.jl

@@ -124,7 +124,31 @@ macro clima_artifact(name, context = nothing)
             # processes have the artifact string
             if isnothing($(esc(context))) ||
                Base.invokelatest(iamroot, $(esc(context)))
-                artifact_path = Base.invokelatest(
+                try
+                    artifact_path = Base.invokelatest(
+                        JuliaArtifacts._artifact_str,
+                        $(__module__),
+                        $(artifacts_toml),
+                        $(artifact_name),
+                        $(artifact_path_tail),
+                        $(artifact_dict),
+                        $(hash),
+                        $(platform),
+                        LazyArtifacts,
+                    )::String
+                catch e
+                    if e isa ErrorException
+                        msg = "\nThe artifact may also be too large to be downloaded automatically. If this is the case, download the artifact directly and indicate where the artifact lives in Overrides.toml (see ClimaArtifacts documentation for how to do this)."
+                        new_err = ErrorException(e.msg * msg)
+                        rethrow(new_err)
+                    else
+                        rethrow(e)
+                    end
+                end
+            end
+            push!(ACCESSED_ARTIFACTS, artifact_name)
+            try
+                Base.invokelatest(
                     JuliaArtifacts._artifact_str,
                     $(__module__),
                     $(artifacts_toml),
@@ -135,19 +159,15 @@ macro clima_artifact(name, context = nothing)
                     $(platform),
                     LazyArtifacts,
                 )::String
+            catch e
+                if e isa ErrorException
+                    msg = "\nThe artifact may also be too large to be downloaded automatically. If this is the case, download the artifact directly and indicate where the artifact lives in Overrides.toml (see ClimaArtifacts documentation for how to do this)."
+                    new_err = ErrorException(e.msg * msg)
+                    rethrow(new_err)
+                else
+                    rethrow(e)
+                end
             end
-            push!(ACCESSED_ARTIFACTS, artifact_name)
-            Base.invokelatest(
-                JuliaArtifacts._artifact_str,
-                $(__module__),
-                $(artifacts_toml),
-                $(artifact_name),
-                $(artifact_path_tail),
-                $(artifact_dict),
-                $(hash),
-                $(platform),
-                LazyArtifacts,
-            )::String
         end
     else
         # If artifact_name is not a string (e.g., it is a variable), we have to do all the
@@ -184,7 +204,33 @@ macro clima_artifact(name, context = nothing)
             # processes have the artifact string
             if isnothing($(esc(context))) ||
                Base.invokelatest(iamroot, $(esc(context)))
-                artifact_path = Base.invokelatest(
+                try
+                    artifact_path = Base.invokelatest(
+                        JuliaArtifacts._artifact_str,
+                        $(__module__),
+                        $(artifacts_toml),
+                        artifact_name,
+                        artifact_path_tail,
+                        $(artifact_dict),
+                        hash,
+                        platform,
+                        LazyArtifacts,
+                    )::String
+                catch e
+                    if e isa ErrorException
+                        msg = "\nThe artifact may also be too large to be downloaded automatically. If this is the case, download the artifact directly and indicate where the artifact lives in Overrides.toml (see ClimaArtifacts documentation for how to do this)."
+                        new_err = ErrorException(e.msg * msg)
+                        rethrow(new_err)
+                    else
+                        rethrow(e)
+                    end
+                end
+            end
+            push!(ACCESSED_ARTIFACTS, artifact_name)
+            isnothing($(esc(context))) ||
+                Base.invokelatest(barrier, $(esc(context)))
+            try
+                Base.invokelatest(
                     JuliaArtifacts._artifact_str,
                     $(__module__),
                     $(artifacts_toml),
@@ -195,21 +241,15 @@ macro clima_artifact(name, context = nothing)
                     platform,
                     LazyArtifacts,
                 )::String
+            catch e
+                if e isa ErrorException
+                    msg = "\nThe artifact may also be too large to be downloaded automatically. If this is the case, download the artifact directly and indicate where the artifact lives in Overrides.toml (see ClimaArtifacts documentation for how to do this)."
+                    new_err = ErrorException(e.msg * msg)
+                    rethrow(new_err)
+                else
+                    rethrow(e)
+                end
             end
-            push!(ACCESSED_ARTIFACTS, artifact_name)
-            isnothing($(esc(context))) ||
-                Base.invokelatest(barrier, $(esc(context)))
-            Base.invokelatest(
-                JuliaArtifacts._artifact_str,
-                $(__module__),
-                $(artifacts_toml),
-                artifact_name,
-                artifact_path_tail,
-                $(artifact_dict),
-                hash,
-                platform,
-                LazyArtifacts,
-            )::String
         end
     end
 end