Skip to content

SEC-2843: Add new info. #32

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nchiasson-dgi merged 1 commit into from
May 12, 2026
Merged

SEC-2843: Add new info. #32

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions info.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
---
fallback: http://localhost/islandora/object/%{pid}/datastream/%{dsid}/view?token=%{token}
modern_fallback: ~

@coderabbitai coderabbitai Bot May 11, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Description: Search for references to modern_fallback in the codebase

# Search for modern_fallback usage
rg -n -C3 'modern_fallback' --type yaml --type java --type rb --type py --type js

# Also search with underscore and camelCase variations
rg -n -C3 -i 'modern.?fallback'

Repository: discoverygarden/cantaloupe-image

Length of output: 384

Remove or implement the unused modern_fallback configuration key.

The modern_fallback key defined in info.yaml at line 3 is not referenced anywhere in the codebase. Either remove it from the configuration file or implement the functionality to use it.

🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@info.yaml` at line 3, The info.yaml contains an unused configuration key
modern_fallback; either remove this key from info.yaml or implement support for
it in the configuration loader and types. If you choose to implement, add
modern_fallback to the Config/Info type (e.g., Config or Info interface), update
the config parsing function (e.g., loadConfig, parseInfoYaml or the code that
reads info.yaml) to read and validate modern_fallback, and wire its value into
the code paths that need fallback behavior; otherwise simply delete the
modern_fallback entry from info.yaml to avoid dead configuration.

sitemap:
drupal_d8_default: 'http://drupal%{suffix}'
sites_cache_size: 10

@coderabbitai coderabbitai Bot May 11, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Description: Search for references to sites_cache_size and any validation logic

# Search for sites_cache_size usage
rg -n -C5 'sites_cache_size' --type yaml --type java --type rb --type py --type js

# Search for variations
rg -n -C5 -i 'sites.?cache.?size'

# Look for cache size validation or configuration parsing
rg -n -C5 'cache.*size|size.*cache' --type java --type rb --type py --type js

Repository: discoverygarden/cantaloupe-image

Length of output: 411

🏁 Script executed:

# Check repository structure and main files
git ls-files | head -20

# Look for configuration loading/parsing logic
rg -n "config|yaml|settings" --type-list | head -20
rg -n "yaml\." | head -30

# Check if there's a generic config loader that uses YAML keys
rg -n "get\(|config\[" --type js --type py --type java | head -30

# Look for cache-related code in general
rg -n "cache" -i | grep -v info.yaml | head -40

# Check the info.yaml file structure
cat info.yaml | head -20

Repository: discoverygarden/cantaloupe-image

Length of output: 3026

🏁 Script executed:

# Check how info.yaml is used in the Dockerfile
cat -n Dockerfile | grep -i "info\|yaml"

# Check README for documentation
cat README.md | head -100

# Look for any scripts that might consume info.yaml
fd -type f -name "*.rb" -o -name "*.py" -o -name "*.sh"

# Check if info.yaml is referenced in any comments or configs
rg -n "info\.yaml" 

# Look for any entrypoint or initialization scripts
cat -n Dockerfile | tail -50

Repository: discoverygarden/cantaloupe-image

Length of output: 3365

🏁 Script executed:

# Check if there are any delegate scripts or Ruby config loaders
cat -n info.yaml

# Look for any documentation or comments about info.yaml
rg -n "delegate|wrapper|info\.yaml" -i

# Check actual_cantaloupe.properties to see the pattern
cat -n actual_cantaloupe.properties | head -30

# See if there's a specific delegate script file referenced
rg -n "delegate"

# Look for any configuration schema or documentation
fd -type f -name "*.md" -o -name "*.txt" -o -name "*.rst"

Repository: discoverygarden/cantaloupe-image

Length of output: 3823

Add inline documentation for the cache size configuration.

The sites_cache_size: 10 setting is copied into the container and intended for use by the Cantaloupe delegate script. Add a comment explaining what this setting controls (e.g., which delegate processes use it, whether it refers to site URLs or site entries, whether 10 is the recommended default).

🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@info.yaml` at line 6, Add an inline comment next to the sites_cache_size YAML
key explaining what it controls: state that sites_cache_size configures the
Cantaloupe delegate script's in-memory cache size for site entries (not raw
URLs), specify which delegate process reads it (the Cantaloupe delegate that
resolves site metadata), note that the value is a count of site entries, and
indicate whether 10 is the recommended default or should be tuned for
memory/throughput; update the comment next to the sites_cache_size: 10 line
accordingly.

Loading